Available attributes for custom prompts
In the clock.xml file, prompts are generically configured with a name/value pair concept. This table lists the different attributes with a description, possible values, data type and whether or not it is required.
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 | Required? |
|---|---|---|---|---|
| acceptSwipe |
Specifies whether to accept or reject the triggering swipe. |
Boolean | True, False | Yes |
| cancel | Specifies whether to allow the user to cancel a transaction by using the key pad button of ESC | Boolean | True, False | No |
| code | A generic attribute that you can use 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. | String | Short text | Yes - if using with prompt id attribute. Optional - if used with the trigger attribute. |
| 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 | String | Short text | Yes - if using with prompt id attribute. Optional - if used with the trigger attribute. |
| imageName | When the type is set to options, you can additionally specify what image to use for the function key displaying the options configured. This currently only applies to the 9000 series clock where each function key has an associated image/icon. The image must be available in the clock resource installation folder on the clock: /opt/infor/clock/resources) | image | PNG format image. | No |
| 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 | No |
| messageDisplaySeconds | Specifies how long a message is displayed in seconds to the user | Time | Numeric value in seconds. | No |
| 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. | String | Any text | Yes |
| 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="5" and No set to order="6" then Yes will be associated to the F5 key and No
with the F6 key, both on the right side of the screen. |
Number | 9000 Seriesclock: 1 to 8 | Yes |
| 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. | String (no spaces) | Short text | Yes |
| 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 | No |
| timeout seconds | Specifies how long a prompt is displayed to the user in seconds before it times out. | Time | Numeric value in seconds. | Yes |
| 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 | No | |
| value | Allows you to capture a response and optionally use it to configure additional prompts based on the value. | number, text | No |