Next, we can configure the Data Export expression file to tailor your integration.
An expression file in SnapLogic is a configuration file that can be used to house custom variables and values which are referenced by settings in the pipelines. In this case, we provide a template file that is designed to work specifically with the Identity Cloud Data Export.
We’ll complete this configuration in three main steps:
In the SnapLogic Manager tab:
Example:
{
"identityCloudAccount": "My Akamai account",
"targetSaveLocationAccount": "My receiver account (SFTP or S3)",
"notificationEmails": "email1@example.com, email2@example.com",
"entitiesToExport": [
{
"entityType": "user",
"attributes": "[\"uuid\", \"givenName\", \"familyName\", \"email\"]",
"filter": "status='Active'",
"exportFilePrefix": "optional_prefix",
"exportFormat": "csv",
"targetSaveLocation": "s3:///bucket@s3.us-west-2.amazonaws.com/dir/"
},
{ ANOTHER ENTITY TYPE }
]
}
Key | Value Instructions |
---|---|
identityCloudAccount |
The Label/Name for the Akamai account you created in SnapLogic. |
targetSaveLocationAccount |
The Label/Name for the sFTP or S3 account you created in SnapLogic. |
notificationEmails |
A comma-separated list of email addresses to receive error notifications. An error notification email will be sent if there is a failure in the pipeline when the integration is executed. The email contains error details including what needs to be fixed. |
entitiesToExport |
An array of objects, one for each Identity Cloud entity type to export from. If only exporting from one entity type, this will be an array containing one object. |
entitiesToExport :entityType |
The name of the Identity Cloud entity type to export from (e.g. user ). |
entitiesToExport :attributes |
An array of Identity Cloud schema attributes to export. This defines the data that will be exported for each user record. NOTES:
|
entitiesToExport :filter |
OPTIONAL filter which narrows down the exported user records to only those matching the given expression. This filter is based on values stored in the Identity Cloud user record. The example code above has the following filter: "filter": "status='Active'" . This means the integration will only export records where a schema attribute called status has been set to Active . Records with any other status value, including null , will not be exported.If no filter is needed, leave this value blank ( "" ).This filter uses the same syntax as the /entity.find filter. For more information, see /entity.find. |
entitiesToExport :exportFilePrefix |
OPTIONAL file name prefix. The naming convention of the export file is entityType_dateTimeStamp.ext (e.g. user_20200918T071048.csv or user_20200918T071048.json ). If you need an additional identifier in the file name, the prefix you set here will change the file name to prefix_entityType_dateTimeStamp.ext.The example code above has the following prefix: "exportFilePrefix": "optional_prefix" . This will result in the following file name, for example: optional_prefix_user_20200918T071048.csv .To keep the standard file name, leave this value blank ( "" ).You do not need to add an underscore after the prefix value - it is added automatically. |
entitiesToExport :exportFormat |
The format of the export file. Options are:
If this is left blank or misconfigured, the file format will default to csv. |
entitiesToExport :targetSaveLocation |
Location within receiver account to send the export files. Note that this allows for a different directory per entity type, if desired. sFTP Format: sftp://ipserver-address-or-ip/dir/
Make sure to include the slash ( If you specify a directory in the path that does not exist in the receiver location, it will be created there the first time the data export is executed. |
DO NOT RENAME THE FILE! The expression file you upload to your project folder must be named DataExport.expr - Any other file name will not be recognized by the Data Export pattern. If you will be running multiple instances of the Data Export integration, plan to save each different DataExport.expr file to a different folder on your computer to keep them organized and prevent overwriting.
Once you’ve configured and saved your expression file locally, you can upload it to your project folder. In the Manager tab:
You can view the content of the file you uploaded in SnapLogic by hovering over the file name, clicking the little arrow next to it, and selecting View.
Good to know: It is not possible to edit the expression file directly in the SnapLogic interface. In the future when you need to update your expression file, you must:
Your project folder should now contain: