Using the Integration Hub

System Administrators have access to Integration Hub, Activity, Manage external mappings, Manage channel properties and Channel Settings. This is the user interface to your particular suite connector. A suite connector is a set of channels, integrations, and/or API configurations.

Activity

1. Navigate from the Home page to Settings and then Integration Hub.

1. Review the fields found on the Activity page.
   Note: the naming of the channels may be different depending on your setup

• Name: name of the integration channel.
• Status: status of integration channel.
• Lock: indicates if the integration channel is locked or unlocked.
• Unlock: unlock channel if locked (lock icon) and access to channel settings (wrench icon).
• Activity: detailed log of recent integration runs.
• Action: allows users to manually initiate the integration.

1. Click the Activity button for the respective integration channel to view a detailed log of the recent integration runs.

• Status: Provides the integration run outcome details such as Running, Succeeded, or Failed.
• Identifier: Globally Unique Identifiers for system reference.
• Start Time (UTC): Start date time in Coordinated Universal Time.
• Duration: The time duration for the integration run in HH:MM:SS.
• Results: The count of the records processed in the run, the count of the records processed successfully, and the count of records that encountered errors.
• More information: View the run summary.

1. Click the More information icon to view the Results for Run.

• Total Records: The total count of the records processed in the run.
• Error: The count of records that encountered errors.
• Success: The count of records processed successfully.
• Summary: View the success and error messages at the record level.
• Run Details: Step-by-step details for the run execution.
• Reference ID: The record identifier for the corresponding success or error message; usually identifies the employee.
• Message: Brief description of the outcome for the processed record.

1. Click the Run Details button to view the Details of the run

   

   • Action: name of specific integration action
   • Status: indicates status (“Succeeded” or “Failed”) of the respective integration Action
   • Start Time (UTC): Timestamp for the initiation of the respective integration Action
   • Duration: length of time the respective integration Action took to complete
   • Results: usually blank
   • Details: provides detailed JSON of the input call (what as ‘asked’ from Dayforce) and the output (what Dayforce passed to SPro in response) call 
2. Click the Details icon to view the Details of the action

   

3. Use the crumb bar to return to the Activity page.

Manage external mappings

1. Click the stacked window Icon in the upper right corner to Manage external mappings.

• External endpoint: Refers to the external system SchedulePro is receiving data from or sending to.
• Entity data type: Refers to the mapping table name that maps a SchedulePro field value the external system field.
• Last Updated: The last date edits were made to the mapping table.
• Action: click the information icon to view the detailed Field mappings.

1. Use the crumb bar to return to the Activity page.

Manage channel properties

1. Click the gear Icon to Manage channel properties.

• Channel name: Name of the configuration section. Global indicates that it is applicable to the SchedulePro instance.
• Version: Internal use only.
• Property Count: The count of configurable fields in the channel.
• Action: click the information icon to view the Channel properties.

• Property name: Field name.
• Property value: Current value of the field that can be edited by clicking the pencil icon.

1. Use the crumb bar to return to the Activity page.

Channel Settings

1. Click the wrench icon to view the Channel Settings.

• Base settings: Settings related to the integration channel such as the name, import or export, hidden from the UI, etc.
• Service trigger: Details on the web service including if it is currently enabled or disabled.
• Actions: Details on various toggles and actions used to configure the behavior of the integration.
• Service connection: Details on various parameters used for connecting to SchedulePro.
• Notification settings: List of email addresses setup to receive notification emails when the integration runs.

1. To add email addresses to the integration report distribution list, click on the pencil icon on the Base Settings of the Channel Settings.
2. Scroll down to the bottom of the json file and add any emails you need inside the notification settings section, either under the emailRecipients or the additionalEmailRecipientsOnFailure

   

   Note: do not remove any of the @shiftboard.com email addresses listed there.