Activity Settings

Prerequisites

There are no prerequisites for updating activity settings.

Example

In this example, we retrieve a list of all activity settings and then update a particular activity setting.

Retrieve all activity settings

Call the Retrieve All Activity Settings GET /v1/work/settings operation to retrieve a list of all available activity settings. The response returned will resemble the example below.

[
    {
        "id": 15,
        "internalName": "WFA_RESULT_PAGE_TIMEOUT",
        "name": "Activity Form Entry - Result Page Timeout in seconds",
        "integerValue": 5,
        "displayContent": "5",
        "version": 1
    },
    {
        "id": 2,
        "internalName": "validator.createdDateTime.ValidationLimitInMinutes",
        "name": "CreatedDateTime validation limit for old punches in minutes",
        "integerValue": 10080,
        "displayContent": "10080",
        "version": 1
    },
    {
        "id": 19,
        "internalName": "com.kronos.wfa.durationInFormAsKTimeDuration",
        "name": "Duration step in form accepts standard duration values",
        "booleanValue": false,
        "displayContent": "no",
        "version": 1
    },
    {
        "id": 1,
        "internalName": "validator.effectiveTimeStamp.ValidationLimitInMinutes",
        "name": "EffectiveTimeStamp processing limit in minutes",
        "integerValue": 20160,
        "displayContent": "20160",
        "version": 1
    }
]

Activity setting descriptions

The following Activity setting descriptions are listed according to their name property.

Activity setting	Description
Activity Form Entry - Result Page Timeout in seconds	This setting specifies how long, in seconds, that a result message displays after users submit a form from a client machine or data collection device.
createdDateTime validation limit for old punches in minutes	The number of minutes that a device can be offline before it must check the date and time of all forms when it comes back online. The default is 7 days (10080 minutes). This setting prevents forms that were entered while the device was offline from being duplicated when the device comes back online.
Duration step in form accepts standard duration values	A Boolean indicator of whether or not users can enter whole number durations in forms without a decimal point. For example, if this setting is enabled (true), users can enter a duration of 8 hours as 8. If the setting is disabled, users must enter 8 hours as 8.0.
effective TimeStamp processing limit in minutes	The number of minutes, in the past, that a supervisor can go back to submit a punch with an effective date and time. The default is 14 days (20160 minutes).
enable {variable} field in the activity editor {variable} can be: actual completed date actual start date completed percentage completion status held status moved quantity received quantity required quantity	These are Boolean indicators of whether or not informational fields on the Status tab of the Activity Setup Editor can be edited. Note: These fields are automatically populated with data submitted on a form. If data is edited on the Status tab, it does not show in an audit log.
Enforce Result Code for manual entry of result values	A Boolean indicator of whether or not to enforce the Result Code when result values are manually entered.
Reduce activity actual time by overlapping auto-generated meal breaks	A Boolean indicator of whether or not to allow automatically generated meal breaks to overlap, thereby reducing activity actual time.
Validate Block Future-Dated Allocation through Web Form and XML API	This setting determines and validates whether or not you can allocate future dated activity allocations.

Update an activity setting

You can change an activity setting by updating either integerValue or booleanValue as appropriate.

Example `integerValue` request

To update an activity setting with an integerValue, call the Update Activity Setting by ID PUT /v1/work/settings/15 operation with the following request payload.

{
  "id": 15,
  "internalName": "WFA_RESULT_PAGE_TIMEOUT",
  "name": "Activity Form Entry - Result Page Timeout in seconds",
  "integerValue": 10,
  "version": 1
}

Example `integerValue` response

{
    "id": 15,
    "internalName": "WFA_RESULT_PAGE_TIMEOUT",
    "name": "Activity Form Entry - Result Page Timeout in seconds",
    "integerValue": 10,
    "displayContent": "10",
    "version": 2
}

Note that the version is automatically incremented to 2. To successfully update this activity setting again, you must pass version 2 in the request body.

Example `booleanValue` request

To update an activity setting with a booleanValue, call the Update Activity Setting by ID PUT /v1/work/settings/19 operation with the following request payload.

{
  "id": 19,
  "internalName": "com.kronos.wfa.durationInFormAsKTimeDuration",
  "name": "Duration step in form accepts standard duration values",
  "booleanValue": true,
  "version": 1
}

Example `booleanValue` response

{
    "id": 19,
    "internalName": "com.kronos.wfa.durationInFormAsKTimeDuration",
    "name": "Duration step in form accepts standard duration values",
    "booleanValue": true,
    "displayContent": "yes",
    "version": 2
}