Available attributes for custom prompts
This table lists the different attributes that are available for prompts in the clock.xml file.
Note: The conf/clock.xsd file is also useful for advanced users as it definitively outlines the possible attributes and elements that you can have in the clock.xml file. It is strongly recommended that this file is not modified as it may lead to unexpected issues.
| Attribute (case-sensitive) | Description | Datatype | Possible values |
|---|---|---|---|
| acceptSwipe | Specifies whether to accept or reject the triggering swipe.
Required. |
Boolean | True, False |
| cancel | Specifies whether to allow the user to cancel a transaction by using the key pad button of ESC | Boolean | True, False |
| code | A generic attribute that allows you to capture the code that describes the purpose of the prompt in the extra data field of the swipe record. This is displayed in the extra data field of the swipe on the time sheet.
Required if using with prompt id attribute. Optional if used with the trigger attribute. |
String | Short text |
| data | This attribute captures the response of the code attribute so that it can be persisted to the time sheet. The response can be used to define business rules
Required if using with prompt id attribute. Optional if used with the trigger attribute. |
String | Short text |
| enableCardReader | Indicates whether the card reader can be used to respond to the prompt. | Boolean | True, False |
| enableKeyPad | Indicates whether the keypad can be used to respond to the prompt. If both enableCardReader and enableKeyPad are set to false, then the user must use an external keyboard. | Boolean | True, False |
| message | Allows you to specify the prompt or feedback displayed to the user under different conditions. For example, if a swipe is rejected when a user cancels a transaction the message, "You were not clocked in." is displayed. | String | Any text |
| messageDisplaySeconds | Specifies how long a message is displayed in seconds to the user | Time | Numeric value in seconds. |
| option id | For prompts that use the "options" type, this attribute allows you to specify each option available to the user. For example, a prompt that is expecting a 'Yes' or 'No' response, would specify two option id values.
Required. |
String | Any text |
| order | For prompts that use the "options" type, this attribute specifies in what order the options are displayed to the user. For example, if Yes is set to order="1" and No set to order="2" then Yes will be associated to the F1 key and No with the F2 key, both on the bottom of the screen.
Required. |
Number | 8000 Series clock: 1 to 4. |
| prompt id | Specifies the name of the prompt. This value is also used in the clock.properties file to specify the localized text of the prompt.
Required. |
String (no spaces) | Short text |
| swipeRejectedReason | Specifies the rejected message captured in the rejected journal if the transaction is canceled by the user or if it times out. | String | Any text |
| timeout seconds | Specifies how long a prompt is displayed to the user in seconds before it times out.
Required. |
Time | Numeric value in seconds. |
| trigger punch | Specifies what swipe triggers a prompt. | String | In, Out, Department, Job, Time Code, Project or Docket. |
| type | Specifies the response type for the prompt. For example, numeric, text or options. | number, text or options | |
| value | Allows you to capture a response and optionally use it to configure additional prompts based on the value. | number, text |