Before you can run your integration, you must provide transmission and security details. This topic describes both general transmission information and transmission methods. Although you choose the transmission method before you specify the file name or use tokens,
General Transmission Information
The following is a list of links to entries in this topic
The File Name field is required when you are transmitting data to DF Link or SFTP.
To easily add tokens, such as {@Timestamp}, to your file name, click the View Tokens button and then the bent arrow next to the desired token to insert it into the file name.
The type of token that is available varies by connector. When using the Event Driven HR Changes (Outbound) connector or the Build My Own (Outbound) connector, you can use system tokens as well as define custom tokens. The custom tokens can represent source data or transformations of source data. To create custom tokens in the View Tokens dialog box, click Add New and select the token source. If required, you can configure a transformation just as you would in Step 3. Map fields from Dayforce to <Vendor>. Once you’ve created the custom token, insert it into the file name using the bent arrow by the token name
The tokens listed in the table below can be added in the File Name Tokens dialog box and in the API URL Tokens dialog box in the Define the parameters of this integration step.
| Token Name | Description |
|---|---|
{@ParentIntegrationId}
|
This token is used in integrations that use batch size. |
{@IntegrationId}
|
This token ensures that batched files are given a unique name to prevent them from overwriting each other. |
You can also create custom tokens in the Define the transmission details of this integration step for all outbound connectors. Custom tokens can be a source field, a transformation, or an expression.
When you select transformation, you can select and configure the appropriate transformation. When you select Expression as the source, you can define parameters as needed and write an expression using Integration Description Language (IDL) for a field. You must complete the configuration of a valid transformation or expression to save your changes, but custom tokens can be edited as needed. After you have saved your changes and you have used the custom token, the resulting value of the transformation or expression is included in the API URL, file name, or header value in accordance with where the token was configured.
Network Configuration Recommendations
To increase the transmission efficiency of the data exchanged between Dayforce and a vendor system, ensure that the following network modifications are made:
Inbound Network Traffic
Integration Studio uses specific static IPs to transmit data using APIs or SFTP. These IPs should be added to the destination network’s firewall settings so that incoming traffic from Dayforce isn’t obstructed. A list of the Dayforce specific IP addresses can be found on the Dayforce Support site, https://support.dayforce.com/.
Outbound Network Traffic
Integration Studio operates through various TCP ports for outbound traffic. To ensure proper functionality, you must use one of the following ports supported by Integration Dashboard when sending data: 22, 222, 443, 722, 827, 990, 2022, 2200, 2222, 705, 4312, 6380, 8022, 8025, 9999, 10022, 11022, 14141, 22222, 5512, 50022, 9030, 6239, 10052, 2143.
Transmission Methods
The following transmission methods available:
- Transmit to Vendor via DF Link
- Transmit to SFTP Server
- Transmit to Dayforce SFTP
- Send as API Request
Transmit to Vendor via DF Link
When you are sending data to third-party vendors or partner payroll engines, the best practice is to route the files through Dayforce Link. Integrations transmitted via this method will show in the Dayforce Link File Tracker.
To use this option, enter your Vendor Recipient ID. This option is available for all output types except JSON.
To get a Recipient ID value for your integration, submit a request through the Dayforce Support site, https://support.dayforce.com/.
This option is typically used when you host your own SFTP server and want the data routed directly to that server.
All integrations, regardless of output type, can be sent to SFTP. When sending to SFTP, there are two sets of parameters to configure:
| Section Name | Associated Setting |
|---|---|
| Connection Parameters |
Credentials to access the SFTP and details regarding where on the SFTP the file will be located Note: Do not include https:// in the SFTP Host. |
| Encryption | PGP Key |
In the Folder field, enter the path of the folder you want export files to be saved in, relative to the landing directory. It is not necessary to start the folder path with a forward slash. Set the path to (.) to send to the landing directory. Leave the path empty to send to root.
This option outputs the data on the Dayforce-hosted Dayforce SFTP server, in the /Export/PlatformOrchestrator/Archive folder.
This option can be used to test, before routing the file to Dayforce Link or to an external SFTP server.
All integrations, regardless of output type, can be sent to Dayforce SFTP. This server is commissioned with your Dayforce environment, so no authentication or credentials are required to be entered.
Transmit to Dayforce Import SFTP
This option is used when you are working with the External Data Source (Outbound) connector to import data from an external system into Dayforce.
You can the Enable Test Mode toggle to run an integration in test mode 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.
This option is only available for JSON output types. Once you select this method of transmission, the application shows the following fields for you to set:
| Field | Description |
|---|---|
| Request Method |
Choose a request method from the drop-down list. The request method that you select specifies the purpose that the export data serves, such as whether it is a complete export, a complete import, or a partial set of corrections or updates. The request methods available are as follows:
|
|
API URL |
Enter the generic payload destination. The headers and query parameters that you define later in this section will be used by Integration Studio to send the export data to a specific API endpoint. More information about using tokens in the API URL is available in Tokens. |
|
Headers |
Headers are key-value pairs that contain metadata which can be sent along with the API request. To encrypt headers with sensitive information, you can click the lock icon on the right end of the Value field. You can switch between the protected view and the normal view until you save the integration. |
|
Query Parameters |
Query parameters, like headers, are key-value pairs that help specify an endpoint for the API request. Unlike headers, query parameters cannot be encrypted. Query parameters can be deleted when they are no longer needed by pressing the blue trash can icon. |
|
Authentication Details |
This field configures an authentication method that is verified when the data reaches the API endpoint. You can select an authentication method from the following options:
Note: You can prevent Dayforce from caching OAuth tokens by clearing the checkbox beside the Integration Studio - Cache external API OAuth tokens property in the General section of the Properties tab in System Admin > Client Properties. When this property is cleared, Integration Studio will request a new token for each request made to the external API. For more information about basic and token-based authentication types, see the Dayforce Developer Network (https://developers.dayforce.com). For more information about other authentication options, see documentation about OAuth and X.509. |
|
Set Content Type |
Use this field to assign either “ |