Integration Studio

Dayforce Release Notes version 2024.2.0

Version
R2024.2.0
Release Date
8/13/2024
Integration Studio
ID Description
ISTUDIO-4819

Added the ability to customize the format of string data such as postal codes and phone numbers so that the data is formatted to meet your target vendor requirements.

To support this update, the Custom Format field was added to the Add Element dialog box that opens when you click Add in the mapping step. The Custom Format field is only shown when you select String in the Data Type drop-down list.

You must use the hash tag symbol (#) in the Custom Format field to represent the source value and any required special characters, such as parenthesis and whitespace to define the format. The following is an example of how you format a 10-digit phone number using hash tags as place holders:

  • Phone Number: (###) ###-####

Note: If the input length does not match the number of placeholder characters you defined, the string is not formatted.

ISTUDIO-5641

Updated Integration Dashboard so that you can easily identify which import background job was initiated. To support this update, the Name column on the Integration Dashboard home page and on the Integration Log screen are now updated to show the file name when available.

ISTUDIO-6465

Updated Integration Studio so that you can easily transfer data from SAP SuccessFactors without the need to build the integration from scratch.

To support this update, the Dayforce People Connector for SAP SuccessFactors connector was added to the list of available connectors in the Create a New Integration From a Connector screen.

To use this connector, your instance of Dayforce must be configured to use Dayforce People Connector for SAP SuccessFactors. For more information, see the Integration Studio: Dayforce People Connector for SAP SuccessFactors Client Guide.

ISTUDIO-7478

ISTUDIO-7795

Added the Build My Own (Inbound File to Dayforce) connector to Integration Studio so that you can use a file as source data in your integration.

To support this update, JSON File in Dayforce Import SFTP and XML File in Dayforce Import SFTP were added to the options in the Source Type drop-down list.

When you import a valid XML or XSD file, you can click the Review Source Schema button to edit the source schema, if needed. You can also select an array from the Main Data Array drop-down list that contains the high-level data records that you want to map.

ISTUDIO-7516

ISTUDIO-8917

ISTUDIO-9628

Updated tooltips in Integration Studio to improve usability and to reduce user confusion.

ISTUDIO-7587

ISTUDIO-9348

Added the ability to manage all tokens in Integration Studio in a single screen.

To support this update, you can now manage all tokens in the Manage Integration Tokens screen that opens when you click Manage Tokens in the mapping step. In this screen, you can manage the [INTEGRATION_RUN_COUNT] token in the Configurable Tokens section and all other system tokens in the Static Tokens section.

In addition, the View and Reset Mapping Token section in the Define the parameters of this integration step is now removed from the application.

ISTUDIO-7700

Updated Integration Studio so that you can filter connectors by tags. To support this update, a Filters button was added to the right-side of the Create a New Integration From a Connector screen that opens when you click Create Integration from the Integration Studio homepage.

The following filter options are shown in the All Filters sidebar that opens when you click Filters:

  • Data Flow: Select the Inbound or the Outbound option from this drop-down list.
  • Function: Select the Benefits, HR, or the Payroll option from this drop-down list. You can also select the Select All option to select the Benefits, HR, and the Payroll options.
  • Vendor: Select the vendor you want from the list of vendors in this drop-down list. You can also select the Select All option to select all the vendors listed.

Note: Filters applied in the All Filters sidebar are not preserved when you go to a different screen in the Integration Studio feature.

ISTUDIO-7702

Updated all outbound connectors in Integration Studio so that when you configure an integration to use report sourced data, hidden parameters in the report are not shown in the application.

ISTUDIO-7779

Updated the following connectors in Integration Studio so that you can specify the format of the Date/Time field in the Review Source Schema screen:

  • Build My Own (Inbound API to Dayforce)
  • Build My Own (Inbound File to Dayforce)

To support this update, the Data Format drop-down list is now shown in the Add element dialog box when you select Date/Time from the Data Type drop-down list. The Data Format drop-down list is a required field and contains the same options that are available in the mapping step.

In addition, the Custom Format field is now shown in the Add Element dialog box when you select Custom from the Data Format drop-down list. The Custom Format field is a required field.

ISTUDIO-7884

Added the ability to select a dynamic date for source API parameters and for report filters in outbound connectors that are configured to use a Dayforce report as source data.

To support this update, the following dynamic date options are now available for date parameters in the Report Filters section in the Define the parameters of this integration step:

Note: If you previously hard-coded the Date parameter in your integration, Integration Studio retains that value. By default, the User Defined Date option is selected in the Date drop-down list and the value is shown in the adjacent field.

  • Current date and time
  • Last date and time this integration ran
  • Start of today
  • End of today
  • Start of current month
  • End of current month
  • Start of previous month
  • End of previous month
  • Start of current year
  • End of current year
  • Start of next year
  • End of next year
  • User Defined Date
ISTUDIO-7944

Updated all inbound connectors in Integration Studio so that you can split large XML or JSON source data files into manageable segments.

To support this update, you can now enter a value into the Batch Size field in the Define the parameters of this integration step to define the size of each segment.

ISTUDIO-8038

ISTUDIO-9014

Added the ability to group fields in the mapping step so that you can apply context to data obtained from a flat data source such as a Dayforce Report or change the context of data, such as reporting HR data by Work Location, and then by Employee. With this update, you can group fields so that information pertaining to a particular employee is grouped together in the XML output file.

To support this update, the Group Fields by Key toggle is now shown in the Add Element dialog box when you configure an array parent and then add at least one child field under it. When you enable the Group Fields by Key toggle, the Grouping Key drop-down list is shown. You must select a child field from the list of child fields listed in the Grouping Key drop-down list.

In addition, the Include Grouping Key in Output toggle is also shown when the Group Fields by Key toggle is shown.

ISTUDIO-8074

Updated the Create a New Integration From a Connector screen in Integration Studio so that you can easily locate the connector template that you need.

To support this update, a new drop-down field was added beside the Search field in the Create a New Integration From a Connector screen. You can select Build My Own Connectors or Prebuilt Connectors from this drop-down field to narrow your search results. By default, Build My Own Connectors is selected.

ISTUDIO-8088

Updated the Integration Log screen that opens when you click View Log in Integrations > Integration Dashboard or in Integrations > Integration Studio so that the logs are listed from newest to oldest.

ISTUDIO-8175

Updated Integration Studio so that you know when a new version of a connector is available for your saved integration.

To support this update, an Update tag is now shown beside an integration record on the Integration Studio home page when a new version of a prebuilt connector is available. To update the connector, click the action icon beside the integration and then Update Connector.

In the Update Connector Version dialog box that opens, read the text and then click Proceed. A note is shown on the top of the Create Integration Home screen to indicate that the connector is updated to the latest version and that any modifications you made to the connector are retained. You must click Save to confirm your changes.

Important: It is strongly advised that you update your connector in a test environment first so that you can validate your changes.

ISTUDIO-8322

Updated Integration Dashboard so that you can filter integrations by connectors or background job types.

To support this update, the Connector drop-down list was added to the All Filters dialog box that opens in the following areas in Integration Dashboard:

  • When you click Filters on the Integration Dashboard home page.
  • When you click Filters in the Integration Log screen that opens when you click View Log on the Integration Dashboard home page.
ISTUDIO-8425

Added the ability to send null values when you are configuring integrations that use the following connectors:

  • Build My Own Inbound and Outbound Connectors
  • Event Driven HR Changes (Outbound from Dayforce)

To support this update, Omit was added as an option in the RESULT and ELSE drop-down lists in the Edit Conditional Mappings for <FieldName> screen that opens when you click Edit beside a field that is configured to use Conditional Mapping as its source.

ISTUDIO-8479

Added the ability to return a single value in a delimited string with multiple values in Integration Studio. For example, the Org Unit Ledger Code is usually composed of various data elements that are delimited by an underscore. The Ledger Code might consist of the Region reference code, the sector of the business, and the Site reference code: USA_Marketing_NYC.

To support this update, the Configure New Return Portion of Delimited String option was added to the Transformation drop-down list in the Edit Data Transformation Details for <FieldName> screen. The following fields are shown when you select the new Configure New Return Portion of Delimited String option:

  • Delimiter field
  • Occurrence field
  • Validate Delimiter Exists in Text Field checkbox

Note: You cannot configure a new transformation for fields that use the Number, Date/Time, or Boolean data types.

ISTUDIO-8480

Updated Integration Studio so that you can configure a user-defined field to use the current year and the configured month and date, instead of static the date. This feature is particularly useful when you want a field to use the same date and month year-over-year.

Previously, you had to manually update the user-defined field or write an expression to return the same date for each subsequent year.

To support this update, the Default to Current Year toggle was added to the date selector that is shown when you select a date for a field that is configured to use Date/Time as the data type and User Defined Field as the source.

When the Default to Current Year toggle is enabled, the date uses the current year instead of the selected year and the application only shows the date and month.

Note: This functionality does not apply to the Effective From and the Effective To fields in the Name this integration step and in the Choose when this integration will run step.

ISTUDIO-8490

ISTUDIO-8868

ISTUDIO-8869

Updated Integration Studio so that you can only access pay groups that are assigned to your user role when you configure and run integrations.

ISTUDIO-8492

Updated Integration Studio and Integration Dashboard so that users who do not have the System Admin > System Admin > Background Jobs sub-feature in the Features tab in System Admin > Roles configured for their user role can still perform the following actions:

  • Run integrations.
  • View the View Job Information dialog box that opens when you click the status of an integration.
ISTUDIO-8563

Updated the View Job Information dialog box in Integration Studio and in Integration Dashboard so that the Error Log tab is the first tab shown for integrations that complete with errors.

ISTUDIO-8575

ISTUDIO-9056

ISTUDIO-9169

Updated the Define the source details of this integration step in Integration Studio so that you can configure inbound connectors to use a Character-Separated Value file as source data.

To support this update, CSV File in Dayforce Import SFTP was added as an option in the Source Type drop-down list.

The following fields are shown in the Define the source details of the integration step when you set CSV File in Dayforce Import SFTP as the source type:

  • Delimiter drop-down list
  • Custom Delimiter field
  • Note: This field is shown when you select Custom in the Delimiter drop-down list.
  • End of Line drop-down list.
  • Source File has Headers toggle
ISTUDIO-8583

Updated Integration Dashboard so that you can view the number of recent integrations and Dayforce background jobs performed within a specific time period.

To support this update, an Active Integrations Key Performance indicator (KPI) card was added to the Integration Dashboard home page. By default, the Active Integrations (KPI) card shows the number of active integrations within the last 7 days (including the current date) in your local time zone. You can click the down arrow beside Last 7 Days to change the time period to the last 30 Days, if needed.

The number shown on the Active Integrations (KPI) card is not updated in real-time.

ISTUDIO-8594

ISTUDIO-8841

ISTUDIO-9375

Added 19 new benefits connectors to Integration Studio. To see the new connectors, the Benefits sub-feature must be configured for your user role in the Features tab in System Admin > Roles.

ISTUDIO-8597

Added the ability to view the character padding used in a field for integrations that are configured to use the Segmented Character-Separated Values/Delimited Text File output type. With this update, you can now easily identify the character padding used in a field.

To support this update, the Padding Character field in the Add Element dialog box is now a drop-down list that contains the following options:

  • Zero
  • Space
  • Custom

In addition, the Custom Padding Character field is now only shown when you select Custom from the Padding Character drop-down list.

ISTUDIO-8624

Updated Integration Studio so that you can enter diacritical marks supported by UTF-8 in the File Name field in your integration.

ISTUDIO-8745

Added the ability to configure a New Count Records transformation as the Criteria Field, Comparison Value, Result, or Else clause in Conditional Mapping. When used as the Result or Else clause, the New Count Records transformation is only available for numeric fields, for which a numeric result is expected. For information about conditional mapping and transformations, see the Dayforce Integration Studio Administrator Guide.

ISTUDIO-8752

Updated all connectors in Integration Studio so that when you hover your cursor over a field, the text contained in the field is shown in a pop-up message. This feature is particularly useful when you can't view all the text in a field and when you want to confirm that the field contains the correct information.

ISTUDIO-8861

Updated the Define the source details of this integration step in the Build My Own (Inbound API to Dayforce) connector and the Define the transmission details of this integration step in all outbound connectors, so that content type cannot be entered as a user-defined header key in the Headers section.

To support this update, an error message is now shown in the application when you enter content-type into the Key field.

You can set a content type for your integration in all outbound connectors that are configured to use the Send as API Request transmission method. This is achieved by selecting a content type from the Content-Type drop-down list in the Set Content Type section.

ISTUDIO-8863

Added the Dayforce Partner Exchange banner on the Integration Studio home page to provide you with additional information about the options available for partners and integrations.

ISTUDIO-8912

Updated the Parameter Details drop-down list in the Edit Expression for <FieldName> screen so that you can use the up and down keys on your keyboard to scroll through the available options.

ISTUDIO-8914

Added the ability to run an integration in test mode so that you can review and verify the files produced by Integration Studio.

To support this update, the Enable Test Mode toggle button was added to the Define the transmission of this integration step for all inbound connectors that are configured to use the Transmit to Dayforce Import SFTP transmission method.

When you run your integration in test mode, the generated file is placed in the appropriate import folder. However, the corresponding import is not automatically triggered. You must change the file name extension to .ready to trigger the import. In addition, you cannot view the triggered import job on the Integration Log screen.

ISTUDIO-8925

Added a tooltip in the Build My Own (Inbound File to Dayforce) connector to provide you with information about how to drop a source file into the Dayforce Import SFTP correctly.

To support this update, the tooltip was added under the Source Type drop-down list in the Define the source details of this integration step.

ISTUDIO-8926

Updated Integration Dashboard so that you can view the total amount of data used for integration runs that resulted in either a completed or partially completed status within a specific time period.

To support this update, a Data Usage key performance indicator (KPI) card was added to the Integration Dashboard home page. By default, the Data Usage KPI card shows the total data usage within the last 7 days (including the current date) in your local time zone. You can click the down arrow beside Last 7 Days to change the time period to the last 30 Days, if needed.

Note: The usage information shown on the Data Usage KPI card is measured in megabytes and is not updated in real-time. In addition, the value shown does not include data usage that was consumed outside of the Integration Studio feature such as, data consumed while using Dayforce HCM Anywhere API calls or running Dayforce import or export background jobs.

ISTUDIO-8939

Updated the mapping step in Integration Studio so that you can configure sum transformations from the Edit Conditional Mappings for <FieldName> screen that opens when you click Edit beside an element that is configured to use Number as the data type and Conditional Mapping as the source.

To support this update, you can now save a Sum transformation when you select Transformation from any of the following fields:

  • Criteria Field drop-down list
  • Comparison Value drop-down list
  • RESULT drop-down list
  • ELSE drop-down list

Note: You still cannot select Configure New Sum Values in the Transformation drop-down list when you create custom tokens in the File Name Tokens dialog box or in the API URL Tokens dialog box that opens when you click View Tokens in the Define the transmission details of the integration step.

ISTUDIO-8949

Updated Integration Dashboard so that you can view a summary of the average run-time for Dayforce Background Jobs and integration runs that completed successfully within a specific time period.

To support this update, a Run Time Average key performance indicator (KPI) card was added to the Integration Dashboard home page. By default, the Run Time Average KPI card shows the average run-time within the last 7 days (including the current date) in your local time zone. You can click the down arrow beside Last 7 Days to change the time period to the last 30 Days, if needed.

Note: The run-time shown on the Run Time Average KPI card is presented in minutes and doesn’t update in real-time.

ISTUDIO-8950

ISTUDIO-9259

Updated Integration Dashboard so that you can view a summary of the number of Dayforce background jobs and integration runs that obtained either an error or a partially completed status within a specified time period.

To support this update, an Errors Key Performance indicator (KPI) card was added to the Integration Dashboard home page. By default, the Errors (KPI) card shows the number of errors encountered within the last seven days (including the current date) in your local time zone. You can click the down arrow beside Last 7 Days to change the time period to Last 30 days, if needed.

Note: The number shown on the Errors (KPI) card is not updated in real-time.

In addition, you can view the Integration Log screen when you click the action icon on the right side of the Errors KPI card and then View Errors. From this screen, you can view information about all data transmitted into and out of Dayforce, which includes integrations configured in Integration Studio and Dayforce background jobs that are linked to an import or export definition.

ISTUDIO-8951

Updated Integration Dashboard so that you can view any increase or decrease in the metrics measured between the current period selected and the previous one.

To support this update, comparison information is shown on each key performance indicator (KPI) card on the Integration Dashboard home page.

ISTUDIO-8975

Updated Integration Studio so that you can configure transformations, aggregations, conditional mapping, mapping and expressions under a grouped parent and filters on a grouped parent.

ISTUDIO-9253

Updated Integration Studio and Integration Dashboard so that you can view the Integration Log screen when your integration is in progress.

To support this update, the In Progress option was added to Status drop-down list in the All Filters side-out panel that is shown when you click Filters on the Integration Log screen.

ISTUDIO-9295

ISTUDIO-9697

Added the ability to view and create integrations from approved predefined connectors so that you no longer need to contact the Integration Solutions Support team to gain access to the connectors you want.

To support this update, the Build My Own (Inbound File to Dayforce) connector was added to the list of available connectors in Integration Studio.

In addition, the following connectors are now available under Integrations > Integration Studio > Connectors in the Features tab in System Admin > Roles:

  • Dayforce Payroll Interface
  • Oracle
  • Workday

For more information about the Benefits connectors available in Integration Studio see Benefit Connectors in the Dayforce Integration Studio Administrator Guide.

ISTUDIO-9297

Added the ability to drag and drop fields in the Review Source Schema screen for inbound connectors. With this update, you can easily rearrange fields so that they are in your preferred order.

Note: You cannot drag and drop fields between different parent fields when your integration is configured to use JSON or XML as the source type.

ISTUDIO-9309

Updated the Integration Log screen in Integration Studio and in Integration Dashboard so that you can download enriched source data when your integration is mapped to enriched fields. This update applies to integrations that use the Event Driven HR Changes (Outbound from Dayforce) connector.

To support this update, Download Enriched Source Data was added to the list of options that is shown when you click the vertical ellipsis beside an integration in the Integration Log screen.

To view the Download enriched Source Data option in the application, the Integrations > Integration Studio > Download Source and Destination Data sub-feature in the Features tab in System Admin > Roles must be configured for your user role and your integration must have an enriched data file that is uploaded to storage.

ISTUDIO-9310

Updated the Define the source details of this integration step in the Build My Own (Inbound File to Dayforce) connector so that you can import a sample CSV file that contains duplicate header names when you use a CSV file as the source.

To support this update, a number is now appended to the second instance of a duplicated field name. For example, if the source file contains two fields that are named "StartDate", the second instance of the field name is renamed to "StartDate1" in the source schema.

ISTUDIO-9340

Updated the MASTER TEMPLATE 834 Layout (Outbound) connector so that it can be used to create an integration for any vendor that does not currently have its own predefined connector in Integration Studio.

To support this update, you can now edit the Destination Vendor field in the Name this integration step. Previously, Test was used as the default value for this field, and it could not be modified.

Note: The Destination Vendor field is still a read-only field for the other Benefits connector templates.

ISTUDIO-9368

Updated Integration Studio so that you know when your split outbound integration encounters item-level errors in one or more child integrations during an import.

To support this update, the child and the parent integration is now shown as Partially Completed on the Integration Studio home page, the Integration Dashboard home page, and on the View Integration Logs screen.

In addition, you can filter for partially completed integrations in the All Filters slide-out panel that is shown when you click Filters on the Integration Log screen. To filter for partially completed integrations, select the Partially Completed checkbox in the Status drop-down list.

ISTUDIO-9374

Updated Integration Studio so that when you run an inbound integration in test mode, the value for the Last Successful Run Time token isn't changed.

ISTUDIO-9624

Updated Integration Studio so that background Jobs that complete with item-level errors are assigned the Partially Completed status in the application.

ISTUDIO-9714

Updated the Add Element dialog box in the Build my Own (Inbound API to Dayforce)and the Build my Own (Inbound File to Dayforce) connectors. With this update, you can specify a data type field in the Review Source Schema screen as either a decimal or as an integer.

To support this update, Decimal was added to the list of available options in the Data Type drop-down list. In addition, the Number option that was previously available in the Data Type drop-down list is now shown in the drop-down list as the Integer option.

ISTUDIO-9851

Updated Integration Studio so that when you configure sum values or counting records using transformation as the source for a field, associated filters are reset. This occurs when you change the value of the selected Dayforce Field or Dayforce Array drop-down list in the Edit Data Transformation Details for <FieldName> screen.