When you first go to Integration Studio and no integrations have been configured, the Create Integration button is shown at the center of the page. If any integrations have been configured, they are shown in a list, and you can create a new integration by clicking Create Integration.
You can choose to create an integration using any of the following Build My Own connectors from the Create a New Integration from a Connector screen:
- Build My Own (Outbound)connector
- Build My Own (Inbound File)connector
- Build My Own (Inbound GET API)connector
- Build My Own (Inbound POST API) connector
The Build My Own (Outbound) connector offers the ability to build an outbound integration from scratch. Start with a Build My Own Connector if none of the predefined connectors meet your needs, or if you want the ability to customize more than the existing predefined connectors allow.
To configure a Build My Own (Outbound)) integration:
- Go to Integrations > Integration Studio.
- Click Create Integration.
- Locate and select the Build My Own (Outbound) connector.
- Configure the integration by expanding each of the following steps in the connector:
- Step 1. Name this integration.
- Step 2. Define the parameters of this integration.
- Step 3. Map fields from Dayforce to <Vendor>.
- Step 4. Define the transmission details of this integration.
- Step 5. Choose when this integration will run.
- When you have completed all of the configuration steps, click Save. Integration Studio validates your configuration.
The Build My Own (Inbound GET API) connector offers the ability to use APIs to retrieve information from external systems so that it can be used in Dayforce. This connector also allows you to view the source profile of an integration so that you can verify that the incoming source schema is correct and can be used in Step 5. Map fields from <Vendor> to Dayforce.
To configure a Build My Own (Inbound GET API) integration:
- Go to Integrations > Integration Studio.
- Click Create Integration.
- Locate and select the Build My Own (Inbound GET API) connector.
- Configure the integration by completing each of the following steps in the connector:
- Step 1. Name this integration.
- Step 2. Define the source details of this integration.
- Step 3. Define the parameters of this integration.
- Step 4. Define the transmission details of this integration.
- Step 5. Map fields from <Vendor> to Dayforce.
- Step 6. Choose when this integration will run.
- When you have completed all of the configuration steps, click Save. Integration Studio validates your configuration.
The Build My Own (Inbound File) connector offers the ability to use a file as source data in your integration.
To configure a Build My Own (Inbound File) integration:
- Go to Integrations > Integration Studio.
- Click Create Integration.
- Locate and select the Build My Own (Inbound File) connector.
- Configure the integration by completing each of the following steps in the connector:
- Step 1. Name this integration.
- Step 2. Define the source details of this integration.
- Step 3. Define the parameters of this integration.
- Step 4. Define the transmission details of this integration.
- Step 5. Map fields from <Vendor> to Dayforce.
- When you have completed all of the configuration steps, click Save. Integration Studio validates your configuration.
The Build My Own (Inbound POST API) connector offers the ability to use Dayforce APIs to retrieve information so that it can be used in Dayforce.
To configure a Build My Own (Inbound POST API) integration:
- Go to Integrations > Integration Studio.
- Click Create Integration.
- Locate and select the Build My Own (Inbound POST API) connector.
- Configure the integration by completing each of the following steps in the connector:
- Step 1. Name this integration
- Step 2. Define the source details of this integration
- Step 3. Define the parameters of this integration
- Step 4. Define the transmission details of this integration
- Step 5. Map fields from <Vendor> to Dayforce
- When you have completed all of the configuration steps, click Save. Integration Studio validates your configuration.
To view the structure of your source file, you can click Review Source Schema in the Define the source details of this integration step for inbound connectors and in the Define the parameters of this integration step for outbound connectors. Similar to the destination structure, arrays are marked and the parent-child structure can be expanded and collapsed as needed.
Important: You can also change the parent field of a child field, if needed. This can be done by selecting the appropriate parent field from the Parent drop-down list that is shown in the Edit <Field Name> Element dialog box. This dialog box opens on the Review Source Schema screen when you click the Action icon that is shown as a vertical ellipsis to the right of a child field, and then Edit.
In the Edit <Field Name> Element dialog box, the Type field is a read-only input field that cannot be modified. In the Parent drop-down list, select a parent field that is on the same level or above the original parent field in the hierarchical list of fields that is shown on the Review Source Schema screen. In addition, the parent field you select must also have at least one child field beneath it.
Integration Studio doesn’t have a problems section. Dayforce shows warnings and error messages below the affected field when you click somewhere on the screen or when you use the Tab key to move to another field.
If Integration Studio detects potential warnings when you are saving an integration, the orange save notification reads “Successfully saved with warnings!” When it detects potential errors, the red save notification reads “Not saved - please review errors above!”
After you have created an integration, you can see it in the Available Integration Configurations screen with any other integrations that you have created. You can also edit, copy, run, delete, export, or view a log of the history of the integration by clicking the action button (three vertical dots) to the far right of the integration.