View this page in the latest version of Appian. Date and Time Component Share Share via LinkedIn Reddit Email Copy Link Print On This Page Function a!dateTimeField( label, instructions, required, readOnly, disabled, value, validations, saveInto, validationGroup, requiredMessage, labelPosition, helpTooltip, accessibilityText, showWhen ) Displays and allows entry of a single date and time (year, month, day, hour, minute, second). When the field is editable, users can input dates by typing or by picking from a calendar and then select the time from a dropdown. The date and time is shown in the current user's time zone and calendar format. When working with a date (year, month, day), use a date component. To display a time (hour, minute, second), use a time component. To display a read-only date and time using a custom format, use a text component. Parameters Name Keyword Types Description Label label Text Text to display as the field label. Instructions instructions Text Supplemental text about this field. Required required Boolean Determines if a value is required to submit the form. Default: false. Read-only readOnly Boolean Determines if the field should display as not editable. Default: false. Disabled disabled Boolean Determines if the field should display as potentially editable but grayed out. Default: false. Display Value value Date and Time Date and time to display in the field. Validations validations List of Text String Validation errors to display below the field when the value is not null. Save Input To saveInto List of Save One or more variables that are updated with the date and time when the user changes it. Use a!save() to save a modified or alternative value to a variable. Validation Group validationGroup Text When present, the requiredness of the field is only evaluated when a button in the same validation group is pressed. The value for this parameter cannot contain spaces. For example, “validation group” is not a valid value. You need to add an underscore between words: “validation_group”. See the following recipes for more information: Configure Buttons with Conditional Requiredness Validation Groups for Buttons with Multiple Validation Rules' Required Message requiredMessage Text Custom message to display when the field's value is required and not provided. Label Position labelPosition Text Determines where the label appears. Valid values: "ABOVE" (default) Displays the label above the component. "ADJACENT" Displays the label to the left of the component. "COLLAPSED" Hides the label. The label will still be read by screen readers; see accessibility considerations for more information. "JUSTIFIED" Aligns the label alongside the component starting at the edge of the page. Help Tooltip helpTooltip Text Displays a help icon with the specified text as a tooltip. The tooltip displays a maximum of 500 characters. The help icon does not show when the label position is "COLLAPSED". Accessibility Text accessibilityText Text Additional text to be announced by screen readers. Used only for accessibility; produces no visible change. Visibility showWhen Boolean Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default: true. Usage considerations Calendar formatting and keyboard shortcuts The date is shown in the current user's time zone and calendar format. When focused on the calendar, selecting the P key will go to the previous month, the N key will go to next month, the T key will select today's date, and the Delete key will clear the value in the field. Examples Use the interactive editor below to test out your code: Date and time with only a label Date and time with a validation Feature compatibility The table below lists this component's compatibility with various features in Appian. Feature Compatibility Note Portals Compatible Offline Mobile Compatible Sync-Time Custom Record Fields Incompatible Real-Time Custom Record Fields Incompatible Process Reports Incompatible You cannot use this function to configure a process report. Process Events Incompatible You cannot use this function to configure a process event node, such as a start event or timer event. Feedback Was this page helpful? SHARE FEEDBACK Loading...
