Integration Studio

Dayforce Release Notes version 2024.2.1

Version
R2024.2.1
ft:lastEdition
2025-01-14

ISTUDIO-1936

Added the ability to open the Integration Log screen from the notification that is sent when an integration fails. The alert notification contains a link to Integration Studio > View Log. You must be logged in and have access to the Integration Dashboard role feature to go directly to the Integration Log screen. 

ISTUDIO-6074

Added the ability to rerun an adhoc integration for specific employees. This feature is only available for integrations that are configured to use an HR Bulk API or an AMF API as the source. In addition, this feature is not available for scheduled integrations.

To support this update, the Employee XRefCode field was added to the Run <IntegrationName> dialog box. If needed, you can add more than one employee XRefCode into the Employee XRefCode field by separating them with a comma.

Important: You can't run an integration that uses an HR Bulk API as source and that contains employees in pay groups that your user role doesn't have access to.

ISTUDIO-6075

Updated Integration Studio so that the Auto-generate File Name switch is shown in the Define the transmission details of this integration step, regardless of the output type you select.

To use this feature, your integration must be configured to use the Transmit to SFTP Server or the Transmit to Dayforce SFTP transmission method.

Previously, this feature was only available for outbound connectors that were configured to use JSON as the output type.

ISTUDIO-8668

Updated the Filter for <FieldName> screen in Integration Studio so that you can configure a Choose Record filter on a criteria field for an object or an array parent field.

In addition, you can select a source field in an array when you select Dayforce Field from the Comparison Value drop-down list. You can also configure a Choose Record filter on the comparison value for an object or an array parent field.

ISTUDIO-9298

Updated the Build My Own (Inbound File) connector so that you can split the source data when your integration is configured to use the CSV File in Dayforce Import SFTP source type.

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 batch.

ISTUDIO-9543, ISTUDIO-9641, ISTUDIO-10476, ISTUDIO-10853

Updated the mapping step in Integration Studio so that you can:

  • Configure grouping on the root field when it is an array.
  • Configure more complex keys.
  • Define multiple grouping keys and totals as immediate child fields to a grouped parent or as child fields to an object parent nested inside a grouped parent field.  

Previously, there wasn’t a visual indicator to differentiate keys and totals, and totals were assumed to exist under object parents.

With these updates, you can configure any number of keys using any of the existing sources, except for Aggregation, in the mapping step. Previously, you could only configure keys for fields that used Dayforce Field as their source.  

All child fields and child fields of object parents nested under a grouped parent are defined as a key or a total. When grouping is enabled, all possible keys or totals are considered keys.

Note: A field that is configured to use number as its data type and aggregation as its source is defined as a total in the application and this is represented by a sigma icon. Aggregations cannot be changed to a Key.

To change a field that is defined as a key to a total, click the action icon beside the field name and then click Mark as Total. Similarly, click Mark as Key to change a field that is defined as a total to a key. 

When there are multiple fields that you want to define as a total, you can click the action icon beside the shared parent field and then Mark all child fields as Total to define everything as a total. The Mark all child fields as Total option is only available for object parents when all child fields are configured to use Number as the data type and transformation, conditional mapping, or expression as the source.

ISTUDIO-9559

Added the ability to output an empty string for integrations that are configured to use JSON as the output type.

To support this update, the [EMPTY_STRING] token was added as an option in the Source Details drop-down list for fields that are configured to use String as the data type and Token as the source.

ISTUDIO-9613

Updated the Return Portion of Delimited String transformation to enable users to pull and concatenate multiple values or ranges from a delimited string.

With this update, you can pull values using:

  • Specific indices, such as “1, 5, 7”
  • A range, such as “-4 - -1” or “3-6”
  • A combination of an index and a range, such as “1, 4-6” 

ISTUDIO-9659

Updated the Define the parameters of this integration step in Integration Studio so that you can configure relative dated plans and relative dated blackout periods. This update affects integrations that are based on any of the following benefits APIs:

  • BenefitsCarrierFeedOngoingExports 
  • BenefitsCarrierFeedOpenEnrollmentExports 
  • BenefitsCarrierFeedMultiCarrierOngoingExports 
  • BenefitsCarrierFeedMultiCarrierOpenEnrollmentExports

To support his update, the isPlanYearDateTypeRelative switch and the isBlackoutPeriodStartDateTypeRelative switch were added to the Source section. By default, these switches are set to fixed when you don't provide a value.

When the isPlanYearDateTypeRelative or the isBlackoutPeriodStartDateTypeRelative switches are set to fixed, the planStartDate, PlanEndDate, and blackoutPeriodStartDate fields are sent to the Benefits API using MM/DD/YYYY format and when the plan type is relative, the MM/DD/1900 format is used.

ISTUDIO-9693, ISTUDIO-10857

Added additional unit of time options to the Integration Configuration screen that you can use to calculate the time difference between two dates.

To support this update, the following options were added to the Unit of Time drop-down list:

  • Year
  • Month
  • Hour
  • Minute
  • Second

This feature is available for integrations where the Calculate Duration of Time Between Start Date and End Date transformation is configured.

In addition, you can set the format of the resulting Integration Description Language (IDL) expression to return years and months of service for fields where the data type is set to string.

You must use syntax like Javascript to create a string that includes variables. To include an expression’s result in a string, use the sequence ${EXPRESSION} within that string where EXPRESSION is replaced by your code.

ISTUDIO-9790

Updated the Run Time Average key performance indicator (KPI) in Integration Dashboard so that the run time is shown in seconds, minutes, and hours.

ISTUDIO-9814

Removed the following tokens in Integration Studio:

  • [TOTAL_EMPLOYEE_COUNT]
  • [TOTAL_DEPENDENT_COUNT]
  • [TOTAL_EMPLOYEE_AND_DEPENDENT_COUNT]
  • [SEGMENT_COUNT_START]
  • [SEGMENT_COUNT]

These tokens were removed from Integration Studio because you can configure employee record counts, dependent record counts, and segment record counts using the Aggregation source.

ISTUDIO-9911

Updated the mapping step in Integration Studio so that you can define the default value for SUM and COUNT transformations.

To support this update, the Default Value field was added to the Integration Configuration screen where you can enter a value into the Default Value field, if needed. By default, this field is set to 0.

This feature is particularly useful in situations when the source array that is being evaluated is missing from the source data.

ISTUDIO-9913, ISTUDIO-9917

Added the following 834 benefits connector templates to Integration Studio:

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

  • Maxor Plus 834 Layout (Outbound)
  • Medical Mutual of Ohio 834 Layout (Outbound)
  • Meritain 834 Layout (Outbound)
  • Moda Health 834 Layout (Outbound)
  • Optum 834 Layout (Outbound)
  • Premera 834 Layout (Outbound)
  • Quartz 834 Layout (Outbound)
  • SunLife Assurant 834 Layout (Outbound)
  • SunLife COMPASS_H2 834 Layout (Outbound)
  • UHC Oxford 834 Layout (Outbound)
  • Wellmark BCBS 834 Layout (Outbound)
  • BCBS of Alabama 834 Layout (Outbound)
  • Davis Vision 834 Layout (Outbound)
  • Delta Dental of Arizona 834 Layout (Outbound)
  • Delta Dental of Iowa 834 Layout (Outbound)
  • Delta Dental of KY 834 Layout (Outbound)
  • Delta Dental of New Jersey 834 Layout (Outbound)
  • Hawaii Dental Services 834 Layout (Outbound)
  • HealthNow NY (BCBS of Western NY) 834 Layout (Outbound)
  • HealthPartners 834 Layout (Outbound)
  • MetLife 834 Layout (Outbound)
  • NVA Vision 834 Layout (Outbound)
  • RX Benefits 834 Layout (Outbound)
  • Teladoc 834 Layout (Outbound)
  • Willamette Dental Group 834 Layout (Outbound)

ISTUDIO-9921

Updated the Effective To field everywhere in the application where you can define an effective and date so that the time field is only shown when you select a date.

ISTUDIO-9938

Updated the Integration Log screen in Integration Dashboard so that the file name is shown in the Name column for import background jobs. With this update, you can easily identify what file a log entry belongs to.

ISTUDIO-10003

Updated Integration Studio so that you can easily transfer data from Workday to Dayforce without the need to create the integration yourself.

To support this update, the Dayforce Payroll Elections Connector for Workday prebuilt connector was added to the list of prebuilt connectors shown on the Create a New Integration From a Connector screen when you select Prebuilt Connectors from the connector type drop-down list.

To view the Dayforce Payroll Elections Connector for Workday prebuilt connector in Integration Studio, the Workday role feature under Integrations > Integration Studio > Connectors in the Features tab in System Admin > roles must be configured for your user role.

ISTUDIO-10024

Updated the Custom Delimiter field in the Define the parameters of this integration step so that you can't use a space as a custom delimiter. With this update, an error message is now shown in the application when you type a space in the Custom Delimiter field.

ISTUDIO-10028

Updated the Choose when this integration will run step in Integration Studio so that you can create a friendly name for your integration that you can also view on the Background Jobs screen in System Admin > Background Jobs.

To support this update, the Auto-Generate Friendly Schedule Name switch and the Friendly Schedule Name field were added to the Schedule Parameters section when you select At a specific time from the Trigger drop-down list. The Friendly Schedule Name field is shown when you turn on the Auto-generate Friendly Name switch, and by default, is prepopulated with a name that is in the following structure:

<ShortName> - <Reference Code> (IntStudio).

ISTUDIO-10044

Updated the Report Filters section in the Define the parameters of this integration step so that you can only select one option from the filter drop-down list when the operator is set to Equal or Not Equal.

This update only affects integrations that are configured to use a report as source data, and it ensures that you don't configure an invalid filter parameter in your integration.

With this update, an error message is now shown in the application when you are working in an existing integration that has multiple selections in the filter drop-down list for the Equal or Not Equal operators.

ISTUDIO-10071

Updated Integration Studio so that you can send data from a vendor API using a POST request and then import that data into Dayforce.

To support this update, the Build My Own (Inbound POST API) connector was added to the list of connectors shown on the Create a New Integration From a Connector screen when the Build My Own Connectors option is selected in the connector type drop-down list.

To view the Build My Own (Inbound POST API) Connector in Integration Studio, the Build My Own/Event Driven role feature under Integrations > Integration Studio > Connectors in the Features tab in System Admin > Roles must be configured for your user role.

ISTUDIO-10189

Updated the connector type drop-down list on the Create a New Integration From a Connector screen so that the connector type you select persists.

ISTUDIO-10241

Added the GET IntegrationStudio/Status/ API to Integration Studio so that you can get the status of an integration run for integrations that were configured using the Build My Own (Inbound POST API) connector template.

ISTUDIO-10272

Added the ability to configure custom header value tokens in the Build My Own (Outbound) connector. With custom tokens, you can send different values based on an employee's pay group without requiring you to create multiple integrations. 

To enable custom API tokens, set the Output Type as JSON in the Define the parameters of this integration step. Select “Send as API Request” for the Transmission Method in the Define the transmission details of this integration step. In the Headers section, click the vertical ellipsis to the right of the entry fields and click View Tokens to open the Custom Header Value Tokens dialog box.

ISTUDIO-10284

Updated Integration Studio to show a warning message when the File Name field in the Define the transmission details of this integration step doesn't contain the {@IntegrationID} token, and a batch size is specified.

When you include the {@IntegrationID} token in the File Name field, each batch file is given a unique name. You can enable the Auto-generated File Name switch to ensure that the batched files are protected from being overwritten. 

ISTUDIO-10354

Updated the grouping functionality for all connectors to include the root parent without requiring the addition of a higher-level parent.

To support this update, grouping can be enabled on any array parent, including the root. At least one child field must be under the array parent. 

ISTUDIO-10402

Updated the mapping step in Integration Studio so that the configuration of local filters and filters on a sum are now handled in the new Local Filters screen. Previously, filters were configured in the Filter for <FieldName> dialog box, which limited the types of filters you could configure.

This update provides you with a unified space to configure all your filters. For example, you can now configure a Choose Record filter for a field on the Local Filters page.

ISTUDIO-10449

Updated the Edit Expression for <FieldName> screen so that an example expression is shown in the expression editor for fields that are configured to use the Number or the Date/Time data types.

ISTUDIO-10517, ISTUDIO-10518

Updated the expression editor in Integration Studio so that auto-complete suggestions are available for conditional statements. For example, if statements now include an else if clause by default and match statements now include two clauses by default. 

In addition, auto-complete suggestions now include the data type for all listed variables.

ISTUDIO-10576

Updated the mapping step in Integration Studio so that the application shows an error message when an expression references a variable or a path that isn't found in the source.

To support this update, the Enable Strict Paths switch was added to the new Mapper Options section in Define the parameters of this integration step. The Enable Strict Paths switch is on for all new connectors, by default.

ISTUDIO-10741

Updated Integration Studio so that you are provided with more information when no connectors are shown in the application.

To support this update, the No Connectors screen is now shown in the application when you attempt to view a connector that your user role doesn’t have access to and when your keyword search or filter doesn’t return any results. In addition, an explanation as to why you cannot view any connectors is also shown.

ISTUDIO-10770

Deprecated the Global Filters Criteria section in the Define the parameters of this integration step In Integration Studio. You can still view and make changes to the Global Filters Criteria section in integrations where global filters were previously configured.

Filtering is now handled in the new Local Filters page on the Integration Configuration screen to create a unified filtering experience. For more information, see ISTUDIO-10402.

ISTUDIO-10819

Updated the Edit Conditional Mappings for <FileName> screen in Integration studio so that you can save your work in stages. With this update, you can save conditional mappings that have blank fields, duplicated criteria, and unconfigured transformations. This feature is particularly helpful when you need to define multiple criteria sets for your integration.

ISTUDIO-10835

Updated the mapping step in Integration Studio so that you can filter for required and unmapped fields.

To support this update, the Show Only Required Fields switch, and the Show Only Unmapped Fields switch were added to the mapping step. These switches are off by default.

Important: The Show Only Required Fields and the Show Only Unmapped Fields switches are not shown in Integration Studio for integrations that were edited entirely in IDL.

ISTUDIO-10839

Updated the following labels in Integration Studio to improve clarity and readability:

  • Updated the Apply LF/CRLF to the last record/segment switch in the Output Format section in the Define the parameters of this integration to Apply End of Line to the last record/segment to improve usability.
  • Capitalized the hour option in the Transformation drop-down list to align with the structure of the other options.
  • The Last date and time this integration ran option in the Delta Date drop-down list was updated to Last date and time this integration ran successfully. This update applies to integrations that are configured to use an HR Bulk API as source data and it also clarifies that this option refers to successful runs only.
  • Corrected a typo in the help text provided for the Enable Strict Paths switch.

ISTUDIO-10841

Added the ability to exclude an entire parent node from an integration run when the nested child fields don't contain any data. This feature is available for all connectors in Integration Studio.

To support this update, the Include Null/Empty Parent in Output switch was added to the Local Filters screen and is enabled by default.

ISTUDIO-10847, ISTUDIO-11463

Added the ability to schedule integrations on custom dates. Open Schedule Parameters in the Choose when this integration will run step and set the Frequency field to Custom. Click Edit Dates to open the Integration Configuration page, where you can add, edit, or delete custom dates. A maximum of 100 custom dates can be scheduled and all dates are shown in your Preferred Time Zone. 

With this update, the custom dates in Create Integration > Integration Configuration now shows your Preferred Time Zone. The name of the applied time zone is shown above the list of custom dates.  

ISTUDIO-10923

Updated the Define the parameters of this integration step in the Build My Own (Outbound) and the Event Driven HR Changes (Outbound) connectors so that you can view the source schema similar to how you can view the destination schema.

To support this update, the Review Source Schema button is shown in the Define the parameters of this integration step when you select an option from the Dayforce API or Event Type drop-down lists. In addition, the path is shown in the Integration Configuration screen that opens when you click Review Source Schema when you hover your cursor over a field name.

ISTUDIO-11132

Updated the names and the descriptions for the following connectors in Integration Studio so that the connectors and their intended use is accurately described:

Previous Connector Names New Connector Names
Build My Own (Inbound File to Dayforce) Build My Own (Inbound File)
Build My Own (Inbound GET API to Dayforce) Build My Own (Inbound GET API)
Build My Own (Inbound POST API to Dayforce) Build My Own (Inbound POST API)
Build My Own (Outbound from Dayforce) Build My Own (Outbound)
Event Driven HR Changes (Outbound from Dayforce) Event Driven HR Changes (Outbound)

ISTUDIO-11139

Updated the Add Element and the Edit <FieldName> Element dialog boxes so that you can use a space as a padding character to the right of a value. This feature is only available for elements that are configured to use Number as the data type and Space as the padding character. In addition, your integration must be configured to use the Fixed Width Text File or the Segmented Fixed Width File output types.

To support this update, Right Padding was added as an option in the Padding Alignment drop-down list.

ISTUDIO-11149

Updated the link to the Dayforce Integration Studio Administrator Guide shown on the Edit Expression for <FieldName> screen so that the link brings you to the Integration Description Language (IDL) reference section of the guide.

ISTUDIO-11564

Updated the mapping step in Integration Studio so that you cannot change an object parent to an array parent or an array parent to an object parent when the parent field you want to change is under a grouped parent.

To support this update, an error message is now shown in the application when you attempt to make any of the changes mentioned.