Introduction
Upon request Ayin provides customers with an export of their data housed in the CIM platform on a reoccurring schedule. This data is commonly used by customers for reporting, analytics, or archival purposes.
NOTE: For information regarding the latest version of the customer extract and an up to date data dictionary please see: Relational Extract - Release Notes
Schedule
Frequency
Ayin works with customers to determine how often they would like data delivered. This can be as often as once a day. Common schedules include:
- Daily
- Every Sunday
- Every 1st of the month
Data Freshness
CIM Data is extracted for the purposes of creating a customer extract each evening. The transformation process used to validate and prepare the data after it is pulled from the live CIM platform currently takes several hours to complete, therefore availability of the data is from 1am onwards the following day. When setting up a new customer extract feed or modifying an existing one, Ayin works with the customer to determine a schedule that best fits their needs.
Schema and File Format
Ayin currently offers two file formats for customer extracts.
- Pipe delimited text files without headers (.txt)
- This extract also includes a .sql file that can be used to create a database and tables of the current schema, and a .sql file that can be used to ingest the data into those tables.
- SQL Server 2014 Backup file (.bak)
The data within these files follows the same schema. For detailed information regarding the Ayin Customer Extract file schema please visit Customer Extract - Release Notes
For any change to the customer extract schema or file format, Ayin provides a minimum of two weeks advanced notice to customers prior to the change taking effect.
Delivery Mechanism
Customer extracts are transmitted via SFTP. For more information regarding using Ayin SFTP please see: SFTP Data Transfer