With an outbound mode Code-Free Flat File Connector, EmpowerID can export data as file dumps. External systems then can process the exported files with any custom logic. This connector can identify and export Person & Account attribute changes in the EmpowerID system. You can additionally configure flags to determine if a record was modified, deleted, or added in EmpowerID. External systems can then import these file dumps with their processing logic. Follow the steps below to configure an account store for outbound flat file connector,
Creating a Code-Free Flat File Connector account store will create a corresponding SetGroup or Query Based Collection. The naming convention for the set group is adding _SetGroup to the end of the identifier of Account Store. e.g., If you create an account store named HROutboundFileConnector corresponding setgroup will be called HROutboundFileConnector_SetGroup. Click on Query Based Collections to know more about it.
It would be best to Create Data Model Mapping File for the connector before following this doc. Data Model mapping file maps the EmpowerID object attributes to the columns of the delimited file. In simple words, it specifies what data to export from EmpowerID to which column of the flat file.
The file export path of the outbound flat file is stored in the column FileFullExportPath of the corresponding SetGroup Record.
Navigate to Admin → Application and Directories → Account Stores and Systems
Click on Create Universal Flat File Connector Account Store. You will see the Create page for the Flat File Account store.
Enter basic details for the resource system and Click on Submit.
Sync Direction- Choose the Outbound Synchronization mode of data
Name- Provide an Identifier for the account store.
Display Name- Please provide a descriptive & friendly name for the account store. The value provided for the display name appears in the UI.
After submitting the basic details, you can enter the configuration setting for the resource system.
Number of Export Files: Specify the number of files to create by the inventory job while exporting data from EmpowerID. If you have huge amounts of data to export, you might consider creating multiple files.
Data Model Mapping File Path: Provide the full path pointing to the Data Model Mapping File. For SaaS implementation, the path is a local path in the Cloud Gateway Server or a network path accessible from the could gateway server. Data Model mapping file maps the EmpowerID object attributes to the columns of the delimited file. In simple words, it specifies what data to export from EmpowerID to which column of the flat file.
Is Remote (Requires Cloud Gateway): Please select the checkbox If your EID instance is a SaSS tenant.
Choosing Select if Full File Export is Required checkbox will export all identity data into flat files. Additional fields for settings will appear,
Delimiter For Full Export File: Specify the single character delimiter for export files. For e.g ", "comma for a CSV file.
Processing Action Column Name For Full File: Provide the column's Name in export files that flag the nature of change in the row. This column in flat-file will consist of the value specified subsequently in action for full export.
Action For Full Export: Value to set for the action for the full export file.
Full Export File Time Stamp: This field contains the timestamp naming convention for the full export file. Providing a value will add a timestamp to the end of the filename of exported flat files.
Choosing Select if Delta File Export is Required is for differential export that only dumps records that have attribute changes since the last export was successful. Please configure the following settings for the delta files export.
Delimiter For Delta Export File: Specify the delimiter for export files. Use single character value for e.g ‘,' , '|'.
Processing Action Column Name For Delta File: Provide the column's Name to include in export files that will record the flag indicating the nature of change in the row. The given column will have values specified on subsequent input fields for add, update and delete.
Action For Differential Export Add: Provide a single character value to flag a record as added. This value is set in the processing action column If a record is added to EID after the last export.
Action For Differential Export Update: Specify the single character that will identify a row as updated. This value is set in the processing action column of the exported file if the record was modified after the last export.
Action For Differential Export Delete: Specify the single character to set in the processing action column if that record was deleted in EID after the last export.
Delta Export File Time Stamp: This field contains the timestamp naming convention for the delta export file. All files exported will append a timestamp with the provided naming convention.
Click on Submit to save the resource system settings.
If you have selected Is Remote in the previous screen of Resource System settings, a list will appear to choose the Cloud Gateway Servers configured for your SaaS tenant. Select the gateway servers and click on submit.
After successfully creating the resource system, you will see a message Request complete!.
Please follow the steps in the section below Create Outbound Job to create the Job. The export won't happen unless you create the Job.
You will have to restart IIS & the service pools of EmpowerID so that the account store can obtain the configuration information.
To restart the EmpowerID in a cloud instance, you can do the following.
Navigate to IT Shop-> Workflows
Click on Recycle Service Environment
If you have EmpowerID deployed On-premise, we will have to follow the standard windows procedure to restart the service and IIS.
Execute the command iisreset from the command prompt to restart your IIS.
Open Services. Click Start, click Run, and then type services.msc.
Right Click on the following services and click on Restart service
EmpowerID Web Role Service
EmpowerID Worker Role Service
Create Outbound Job
Navigate to Admin → Applications and Directories → Account Store and Systems page.
Search for the Universal Flat File Connector Account Store you just created. And click on it to open the detail view.
Please scroll to the Additional Jobs per System accordion pane and click it.
Click on the ➕ icon to open a form to add the Job.
Enter the details for Job.
Job Name: Provide the Name of the Job. You will have to provide the Name following the naming convention of mode-export type, e.g., Outbound-full.
Resource System: Choose the resource system or account store you created earlier.
Job Description: Describe the Job as per the convention, Name of the account store mode-export, e.g., OutboundHRFileConnector Outbound-full
Is Enabled: Select true to enable the Job.
Interval: Choose the interval mode and provide the value for the interval.
Click on the Save button to create the Job. If you have both full and delta export modes, you will have to create jobs for each export type.