PromptSet Time/Date Elements

Time/Date prompts allow you to select time and/or date.

Field Description
Type

Allows you to select from the following: 

  • Date: The default data reference is UC_DATATYPE_DATE. The settings you select Calendar, Calendar Event , and Output format fields determine the date specifications.
  • Date and Time: The default data reference is UC_DATATYPE_TIMESTAMP. The settings you select Calendar, Calendar Event , and Output format fields determine the date and time specifications.
  • Time: The default data reference is UC_DATATYPE_TIME.
Data Reference

A Variable object that along with rest of the prompt fields specifies the prompt's allowable values.

Reference values from the Variable object specified as the data reference retrieves either: 

  • For static variables: The first value column
  • For dynamic variables: The RESULT column

Do not edit data reference variable objects when executing objects with PromptSets or while those objects are starting. At this time, the prompt interface has already been generated and editing variable objects will cause problems.

If the values specified for a PromptSet element do not comply with the reference values, the prompt cannot be sent after object activation. More information is provided in the topic PromptSet Activation.

If you use dynamic variables (except for the source "Filelist") as the data reference: The number of entries that is returned by dynamic Variable objects is limited by the setting in the SQLVAR_MAX_ROWS variable UC_SYSTEM_SETTINGS (default value 200 lines).

Label

The descriptive text that will be the label for the prompt.

Variable Name

The name of the PromptSet variable that executable objects will create each time they run this prompt. A PromptSet variable is a form of a Script Variable that is defined in prompt and used in the executable object's Process Pages. PromptSet variables can be used similarly to Object variables. They can be modified, inherited etc. PromptSet variable names are written in uppercase and specified with a leading & and a closing #. When you add a prompt to the PromptSet, the PromptSet variable is given a default name, which you can change.

When the data reference is an EXEC Variables type variable, the name of the PromptSet variable must match the script variable set as the parameter name in the EXEC variable object.

Default Value

The default prompt value. You specify the default prompt value by picking an option from the radio button list and entering a value in the field below it. There are two options: 

  • Set Manually: This field allows text and variables.
  • Set by Variable: This field allows text and variables. It includes a button on the right side of the field. You can use it to insert variables using the Insert Variables dialog.

Date and time elements cannot be stored if they do not include default values. If the current time/date should always be displayed as default values when the prompt opens, use the predefined variables &$PHYS_DATE_format# and &$PHYS_TIME_format# for this purpose.

Please take into account that the only date format that is supported when you use variables for default values is YYYY-MM-DD.

You can save the PromptSet even if it includes prompts with default values that do not use the data references' data or adhere to the limitations specified in the prompts' settings. The resulting error will only occur when the attempt is made to save the object where the PromptSet is assigned.

The prompt value can be overridden in multiple places. The order of precedence of the prompt value used for activation is:

  1. The default value (if one is set here).
  2. The prompt on the Prompt Sets page under Variables & Prompts in an executable object's definition overrides the default value.
  3. An override of the activation of the instance of a Workflow or other executable object when it is run:
    • Manually with an Execute command.
    • Via a Schedule object.
    • Via a ACTIVATE_UC_OBJECTscript element with the parameter PASS_VALUES using :PUT_READ_BUFFER, :PUT_PROMPT_BUFFER.
    • Note that the read buffer variable requires the same name as the PromptSet variable (Properties - Variable name). A Request dialog for prompts is not displayed for tasks that are activated through Workflow, Schedule, or Script objects.

Tooltip Additional information about the element that is displayed as a tooltip.
Set Focus

Puts this prompt into focus when the PromptSet is viewed. If this option set for multiple prompts, the focus is set to the last prompt with this option selected.

Read-only Users cannot change the default value of the prompt.

Calendar

Calendar Event

Used to determine the date to select from.

Output format

Available formats for Date types:

  • DD-MON-YYYY
  • DD-MON-RR
  • MM-DD-YYYY
  • YYYYMMDD
  • MMDDRR
  • DDMMRR
  • MM-DD-RR
  • MM/DD/RR
  • YYMMDD
  • YY.MM.DD
  • YY-MM-DD
  • YYYYMMDD
  • YYYY.MM.DD
  • YYYY-MM-DD
  • DDMMYY
  • DD.MM.YY
  • DD-MM-YY
  • DDMMYYYY
  • DD.MM.YYYY
  • DD-MM-YYYY
  • MMDDYY
  • MMDDYYYY
  • MM/DD/YY
  • MM/DD/YYYY

Available formats for Date and Time types: 

  • YYYYMMDDHH24MISS
  • YYYY-MM-DD HH:MM:SS
Minimum
Maximum

Limits the allowed value range for the element.

Minimum, maximum: String that defines the minimum and/or maximum value.

These limitations are already checked when you store the object to which the PromptSet object has been assigned. Therefore, you cannot store objects whose PromptSet values (Variables & Prompts tab) are invalid because of the PromptSet properties.

Custom Field

This is an additional field in which you can enter any text of your choice.

It does not affect the functionality of the PromptSet element.

The image below shows a PromptSet which has been assigned to a Job object and has been executed. It includes: