Workplace Connectors Technical Documentation
Table of Contents
- Introduction
- Badging Vendor Spoke
- Data Source Configuration
- Data Transformation (Optional)
- Scheduled Imports
- Configuration
- Connector Configuration
- Provider Configurations
- Analytics
Introduction
Workplace Connector is an application that allows you to configure spokes to receive employee building badging data from vendors and store it in an employee attendance table. This documentation provides a comprehensive guide on configuring the spoke.
Badging Vendor Spoke
The Badging Vendor Spoke is designed to handle badging data from a specific vendor. It utilizes a Badging Data table as the source for retrieving the data and allows for importing CSV data files through the SFTP method. A scheduled import set is used to transform the file and populate the Badging Data table.
Note:
“Use of the mentioned protocols and spokes may consume Integration Hub transactions that may require purchase of Integration Hub or Automation Engine Subscription at an additional fee. Please consult your Account Team for more information.”
Data Source Configuration
To set up the data source for the Badging Vendor Spoke, follow these steps:
- Navigate to All -> System Import sets -> Data Sources.
- Click on the Create New button to open the data source form.
- Fill in the following details:
- Name: Provide a name for the data source.
- Import Set table label: Enter the label for the table (e.g., Badging Data).
- Import Set table name: Specify the name for the table (e.g., badging_data).
- Type: Select the connection type from the source to the Badging Data table (e.g., File).
- File retrieval method: Choose the appropriate method from the dropdown (e.g., SFTP or FTP or attachment).
- Format: Specify the format of the data (e.g., CSV).
Data Transformation (Optional)
If data manipulation is required before entering it into the Badging Data table, you can create a staging table and a transform to facilitate the process. This allows for any necessary data cleansing or formatting.
Scheduled Imports
To schedule the import job and retrieve data from the source periodically, follow these steps:
- Go to All -> Scheduled Import Sets -> Scheduled Imports.
- Click on Create New to open the form for creating a scheduled import job.
- Configure the scheduled import job according to your requirements, including the frequency of execution and mapping to the data source.
- Specify the source data table and the destination table (Badging Data table).
- Set the desired import frequency for the scheduled job.
Configuration
Connector Configuration
To configure a new spoke connector and define how the data should be processed, follow these steps:
- Install Plugin Workplace Connectors scope sn_wsd_wc
- The user should have sn_wsd_wc.admin role to be able to do configuration.
- Navigate to All -> Workplace Connectors -> Connector Configuration.
- Click on Create New to open the new form.
- Fill in the following details:
- Target Table: Specify the table where the connector will store the data, such as the Employee Attendance table.
- Type: Define the type of data the connector will process, for example, badging data or occupancy data.
- Extension Point Definition: Select the extension point that defines the implementation for processing data from the provider. This will be just an interface. Each provider must have a separate implementation. For example, the interface looks like the below image.
And its implementation will look like the below image:
Provider Configurations
To register details for a new vendor/provider, use the following steps:
- Go to All -> Workplace Connector -> Provider Configurations.
- Click on Create New to open the provider configuration form.
- Provide the following details and select the vendor app scope:
- Import from the table: Check this box if you want the scheduled job to fetch data from the provider table. Leave it unchecked if the provider directly dumps data into the target table, such as the Employee Attendance table. If this is checked source table and run frequency fields will also be visible.
- Name: Assign a meaningful name to the provider configuration.
- Source Table: Specify the table from which you want to read data for further analytics, belonging to the provider.
- Connector Configuration: Select the connector configuration created in the previous step.
- Run Frequency: Set the frequency at which the scheduled job will run to fetch data.
- Provider Execution table sn_wsd_wc_provider_execution will have the last query time of the provider configuration. Every time the scheduled job “Process Provider data record” will run this table will have an entry for the last query time.
- Process provider data record will pick the records from the badging data table and populate the Employee Attendance table based on the run frequency selected in the previous step in the Provider Configuration table.
Analytics
Workplace Connector provides powerful analytics capabilities to analyze employee attendance data. To make use of the analytics features, please ensure the following data prerequisites are met:
Plugin
Workplace Central scope sn_wsd_central
Data Prerequisites
- Users should have an employee profile created.
- Users should have a workplace location assigned to their user profile.
Data Flow
- Process Provider Data Record: The scheduled job "Process Provider Data Record" runs every 5 minutes, fetching data and populating the Employee Attendance table within the connector.
- WSDHeadCount Daily Job: The scheduled job "WSDHeadCount Daily Job" runs once every night. It retrieves data from the Employee Attendance table and populates the Attendance Analytics table.
Viewing Attendance Analytics Reports
Once the data has been processed and populated into the Attendance Analytics table, users with the following roles can access the attendance analytics reports:
- sn_wsd_central.workplace_analytics_user
- sn_wsd_wc.manager
- sn_wsd_wc.user
To view the attendance analytics reports, navigate to All -> Workplace Central -> Occupancy Dashboard.
