Dimensions Integration Setup Fields

Kronos Integrations

The following tables list the fields that need to be configured in this application to support an integration with Dimensions. Integration settings are located in Setup > System > Import Manager > Integrations Type > Workforce Dimensions.

--- Very Important READ ME ---
DST offsets must be enabled in Setup > System > System Information> Apply DST Offsets when using Dimensions. Workforce Dimensions to Workforce Ready integration requires outbound port 443 to be open from this application to reach the solution. https://community.kronos.com/s/article/What-Port-Must-Be-Open-For-Workforce-TeleStaff-to-Workforce-Ready-Integration

--- Very Important READ ME ---

DST offsets must be enabled in Setup > System > System Information> Apply DST Offsets when using Dimensions.
Workforce Dimensions to Workforce Ready integration requires outbound port 443 to be open from this application to reach the solution.

https://community.kronos.com/s/article/What-Port-Must-Be-Open-For-Workforce-TeleStaff-to-Workforce-Ready-Integration

Integration Settings

Sources: Solution Consultant (SC), Cloud Operations (CO), Integration Consultant (IC), Customer (C), Developer Portal (DP)

Field Name	Description
Account Username	The Dimensions licensed user account that will be used for Accrual API calls. This user must have access to all of the users in this application which includes the Setup area, Timekeeping, and Scheduling.
Account Password	The password credentials of the Account Username used for authenticating with the Workforce web service.
Dimensions API Key	Workforce Dimensions REST API/App Key used for invoking REST APIs. Allows this application’s tenant to make API calls against their Dimensions tenant.
Vanity URL	The vanity URL for Workforce Dimensions. The URL of the web service endpoint as provided by your Workforce vendor.
Client ID	Workforce Dimensions Client ID of Tenant used for invoking REST APIs. Used to obtain an OAuth token from Dimensions.
Client Secret Key	Workforce Dimensions Client Secret Key of Tenant used for invoking REST APIs. Used to obtain an OAuth token from Dimensions.

Schedule Integration

Field Name	Description
Schedule Batch Integration ID	The Batch Schedule Integration Identifier. Used to identify which instance of an integration to execute when running an API Based Integration. Text field change to field with selectable options in application version 7.1.14+, 7.2.5+, and 7.3.1+.
Schedule Integration ID	The Low Latency Schedule Integration Identifier. Used to identify which instance of an integration to execute when running an API Based Integration.Text field change to field with selectable options in application version 7.1.14+, 7.2.5+, and 7.3.1+.
No Pay Segment Tag	The Segment Tag which maps to no pay work rule. Used as a visual indicator for segments that should not be paid as a result of a merge.
Associate Shift Segments to Calendar Date	Select to align the start date of the shift When selected, start date of the shift is aligned to calendar date. A No Payment Segment Tag is required when Associate Shift Segments to Calendar Date is checked.
Merge Adjacent Working Periods	Select to merge adjacent working shifts into a single shift. Used to merge multiple consecutive/adjacent work codes into a single shift with multiple segments. Note: Does not include nonworking work codes configured with Send as Segment with Tag, or a working/regular duty work code configured with Send as Pay Code Edit.
Import Pay Rule to Employee Category	Import Pay Rules from Workforce Dimension to Employee Category. This works with task type: Dimensions Pay Rule Import to Employee Category.
Recipient Email	Notifies recipients in case of a failure during schedule integration. Message delivered when process moves to Failed status. Email distribution only. Use a comma to separate multiple emails. `SUBJECT (a) SCHEDULE SYNC FAILED (b) SCHEDULE SYNC FAILED (<ENVIRONMENT>) BODY: EVENT ID: <process #> MESSAGES: <execution summary>`

Request Failure Overrides

The Request Failure Overrides area is used to define the severity level of the following Dimensions-backed static issues when Dimensions is not available or can not provide a response.¹

Schedule locked and cannot be synchronized.
Exceeded accrued hours for this work status.

The static issues in this area rely on a result from Dimensions. Configuring severity levels in this area allows users of this application to proceed with the staffing flow without interruption if downtime occurs in Dimensions. The default severity value is Illegal. A blank value means, do not override and use the configured static issue response in Setup Codes > Static Issues. There is no static issue check when severity level is set to ignore.

Application Behavior: When severity levels for the same static issues defer, this application will apply the least restrictive severity level.

For example, suppose static issue: Schedule locked and cannot be synchronized is set to Deny Level One in the Import Manager Integrations area, and the same issue is set to Warning at the work code level in the Static Issues page, in case of a non response from Dimensions, when the user adds the work code the severity level incurred during a period of downtime will be Warning because Warning is less severe (less restrictive) than Deny Level one. Moreover, suppose the severity level is set to Ignore at the work code level, and set to blank in the integration area, the result will be Ignore.

Active Time Window

Field Name	Description
Extra Days Beyond Period	Positive value to get extra days schedule beyond the original range. Used to control how many days to look at when merging shifts.
Active Time Window From	Defines start of date span for including schedules in Batch Import. Default is 15 days. Max range is 39 days.²
Active Time Window Through	Defines end of date span for including schedules in Batch Import. Default is 2 days. Max range is 14 days.

Cost center Mapping

Field Name	Description
Cost Center Type	Field in this application used to pass Cost Centers during integration. Typically, the Account field -except when using Blueprints. Options: Account Job Account

Dimensions (Boomi Extensions)

The following table lists the fields that need to be configured in Dimensions (Boomi Extensions) to support integration with Dimensions.

Sources: Solution Consultant (SC), Cloud Operations (CO), Integration Consultant (IC), Customer (C), Developer Portal (DP)

Location/Field	Description
Connection Settings - WFTSIntegrationname_APIGatewayServer/URL	Used to specify the Vanity URL for Dimensions followed by /API. EXAMPLE: https://vanityURL/API
Connection Settings - WFTSIntegrationname_WFTSServer/URL	The Vanity URL for this application’s server.
Connection Settings - WFTSIntegrationname_WFTSServer/User	The username for this application used by the integration for making API calls for this application. See the list of Authority permissions in the next section that this user must have granted in Setup > Security... for the administrative integration user to make API calls.
Connection Settings - WFTSIntegrationname_WFTSServer/Password	The password for the username indicated in the previous connection setting. Used by the integration for making API calls.

Dimensions Integration User Authority Permissions

The following user permissions are required for the user specified in the Dimensions Integration extension Connection settings to make API calls for this application. Additional permissions may be required to access other application functions, to review permissions available see the Authority Permission Settings reference topic.

Permission Name	Description
Assignment: Add, Edit	Permits the ability to view, add, or edit assignments details.
Assignment: View	Permits the ability to view assignment details in My Info > Assignment tab. Functionality not available when using Blueprints.
Attachment: View	Permits attachment data to be viewed on the Roster.
Person: Add, Edit Advanced	Grants the ability to add and access all personnel data in the People area. If checked, also check Setup: Person Add, Edit Advanced.
Person: Delete	Grants the ability to delete people. If checked, also check Setup: Person Add, Edit Advanced.
Person: Edit Advanced	Grants the ability to edit all viewable fields in the General tab. See Person View... permissions.
Person: Edit Basic	Grants the ability to edit the following fields in the General tab when viewable: Address, and Others. See Person View... permissions.
Person: Edit Contact methods	Grants the ability to edit Contact Method fields located in the General tab and recommended for base access and above user roles to prevent missed work opportunities.
Person: Edit Employee Category	Displays the Category tab in person. To view, grant Employee Category View.
Person: Log	Grants the ability to add, edit, and remove staffing records located in the Logged tab that may affect staffing rules.
	Best Practice: Do not check Person: Log. This includes Full Access roles. We recommend that you select this permission as needed in Setup, use it, when done, deselect to refuse access. Reason being, the logging tab captures working opportunities that could affect the outcome of rules, meaning - the list and order of candidates when using Fill by Rules.
Person: Manage Certifications	Grants the ability to add, edit, remove certifications in person > Skills & Certifications. Available as of application version 6.7.
Person: Manage Skills	Grants the ability to add, edit, remove skills in person > Skills & Certifications. Available as of application version 6.7.
Person: Manage Wage	Grants the ability to edit the person’s wages in person > Wage available as of application version 7.0. In previous application versions, the wage field was located in person > Profile. Also see Person: View Wage.
Person: Message	Grants the ability to add, edit, and remove messages. Recommended for supervisor and above roles.
Person: Probation	Grants the ability to add, edit, and remove a probationary period. Edit allows a user to shorten or extend a probationary period.
Person: View Address	Grants the ability to view personnel addresses in the People area.
Person: View Certifications	Grants the ability to view certifications in person > Skills & Certifications. Available as of application version 6.7.
Person: View Phone Numbers	Grants the ability to view phone numbers in the People area.
Person: View Skills	Grants the ability to view skills in person > Skills & Certifications. Available as of application version 6.7.
Person: View Wage	Grants the ability to view the person’s wages in person > Wage available in application version 7.0. In previous application versions, the wage field was located in person > Profile and labeled Profile: View Wage in authority permissions.
Profile: Add, Edit	Grants the ability to add and edit Profiles.
Profile: Delete	Grants the ability to delete Profiles.
Profile: Edit	Grants the ability to edit Profiles.
Profile: View Driver's License	Grants the ability to view a person’s driver’s license number in their Profile tab.
Request: Approve or Deny others	Grants the ability to approve or deny other people’s time-off or time-on requests that fall at or below the user’s Organization Authority level. Also, grants full access to Request Notes area within the work code record.
Roster	Grants the ability to access authorized Roster views.
	If unchecked, it renders the following Roster items to be disabled: Contact Log, Edit Record, Fill in Vacancies, Fix, Finalize, Notes, Off Roster, People Filter Assignment, Remove record, Switch, Unit Copy, Unit Deploy.
Scheduling: Planning	Grants the user the ability to apply blueprints on the Planning board. Blueprints can only be applied within the organizational level set on the User’s authority. Functionality available with Blueprints license.
Scheduling: Staffing	Grants the user the ability to staff blueprints. Blueprints can only be staffed within the organizational level set on the User’s authority, and if applicable staff Scheduled Into institutions. Additionally, allows user access to the Scheduling > Scheduling page. Functionality available with Blueprints license.
Setup: Edit Employee Category	Grants the ability to edit the Employee Category field in person > General of this application.
Setup: View Employee Category	Grants access to view only employee category in Setup > General > Employee Category.
Setup: General	Grants full access rights to the Setup General area and required for system configuration purposes.
Setup: Organization	Grants full access rights to the Setup Organization area and required to configure and maintain the organizational structure.
Setup: People, View All, Edit All	Grants full access rights to the Setup People area and required for adding or removing personnel, and overall system configuration of people. To delete an assignment, however, requires Assignment: Remove Authority to be granted as of application version 7.2.