This article explains how to configure the Data Extraction Management settings within Assure, which control the format, frequency, and scope of data extracted via the Assure Customer API (a secure RESTful API used to export Assure records into external applications and business intelligence tools). The Data Extract setup is performed by the Evotix Administrator team on the customer's behalf. Customers can view their current configuration at any time via Settings > System Configuration > System Settings > Data Extract Management. This article covers output format options, extract frequency (daily and hourly), and how modules are added to or removed from the extract. This article is part of the wider Data Extraction API topic area and sits within Assure's System Configuration.
Prerequisites
- The feature has been procured. The Data Extraction API is not enabled by default. Contact your Customer Development Manager (CDM) or Customer Success Manager (CSM) to request access.
- Evotix has enabled the API. The Evotix team must activate the API for your Assure instance before any data extraction requests can be made.
- Data extraction requirements have been defined. You must provide Evotix with your preferred output format (JSON Lines, CSV, or PARQUET) and the Assure modules you wish to include in your extract.
- API Keys have been created. At least one API Key must be generated in Assure under Settings > System Configuration > API Access before making any API requests. Users who create and manage API Keys must have the Manage API Supervisor Privilege.
- Modules are enabled for extraction. The modules you wish to extract must be enabled in Settings > System Configuration > System Settings > Data Extract Management.
- An IT resource or integration tool is available. The final step of configuring requests in your own integration platform is customer-specific and must be supported by your IT team. Evotix cannot provide support for this step.
The correct Assure stack name is known. All API request URLs require your Assure stack name (for example
uk2fromhttps://uk2.sheassure.net/)
Format
- Gzip compressed JSON (default)
- Gzip compressed CSV
- Snappy Compressed Parquet
Frequency
Note: To receive hourly extracts, the request must include the headerx-extract-schedule: hourly. If this header is missing, or if it is set todailyinstead ofhourly, the system returns the daily extract only. Hourly files become available 30 minutes past each hour (for example, 1:30, 2:30). The hourly setting must also be enabled in Assure, or a 404 error will be returned.
Available Extracts (Modules)
All Assure record fields will be included in each data extract. To ensure a standard data structured that is not impacted by configuration changes to caption, the columns fields will show Assure’s default captions, not customer configured captions.
The field mapping button will allow you to download a CSV to support the mapping of Assure default field captions to Customer configured captions. The columns in the CSV file show the Assure Field Captions, and the Data Extract fields so that these can be cross-referenced from the external tool.
The modules that are extracted can also be removed by clicking the ‘Remove’ button on the table.
Configuring iQ template questions for export
Note: iQ template data can be included in your data export. You can define for each question if this should be included in the data export.
To be included in the export, the IQ template question needs a Data Extract field export code to be set. This field is available in the Configure Response option for each iQ questions. This must be set on each IQ question or it will not be included. Please ensure that a standard naming convention is used to make it easy for you to use this data in further analysis.
The value of the ‘data extraction field’ must:
- Be alphanumeric
- Start with a letter (not a number)
- Be 30 characters or less
Related Setup Steps
- Request access - Contact your CDM or CSM to procure the Data Extraction API feature.
- Configure Data Extraction Management - Evotix configures your output format, frequency, and module selection in System Settings.
- Create API Keys - Navigate to Settings > System Configuration > API Access to generate API keys. API key management is only available to users with the Manage API Permission. The functionality is available to all customers immediately but will not return any data until data extraction via API is enabled and set up by Evotix.
Set up your integration tool - As a final step, you set up the data request in your own integration tool. As this is customer-specific, the Evotix team cannot provide support for this step. This step should be supported by your IT team.
AI Metadata
- Product Area: Assure - Data Extraction API, System Configuration, System Settings
- User Role: Evotix Administrator (performs setup); Assure System Administrator (views configuration); IT Administrator, Integration Engineer (consumes extracted data)
- Tags: Data Extraction API, Data Extract Management, System Settings, System Configuration, JSON, CSV, PARQUET, hourly extract, daily extract, module extract, API key, RESTful API, ETL, Business Intelligence, BI
- Version/Region: All Assure versions; all regions (UK, UK2, NA, ANZ)
- Important Synonyms:
- Data Extract API = Customer API = Assure API = Data Extraction API
- Data Extract Management = Data Extraction Management = extract configuration
- Gzip compressed JSON = JSON Lines = JSONLines
- Snappy Compressed Parquet = PARQUET
- CDM = Customer Development Manager
- CSM = Customer Success Manager
- Manage API Permission = Manage API Supervisor Privilege
- Suggested Embedding Keywords: set up data extraction Assure, configure data extract format, hourly data extract Assure, daily data extract Assure, Assure JSON CSV PARQUET extract, Data Extract Management System Settings, add module to data extract, enable module extraction Assure, Assure API extract frequency, Assure data extraction requirements, Evotix data extract setup, API data extraction Assure configuration
- Relevant Modules and Cross-Module Implications: This article is scoped to the Data Extract Management section within System Settings in Assure. The configuration set here controls which Assure modules are included in data extraction and in what format and frequency data is provided. This has cross-module implications across all Assure modules (Incident, Risk, Audit, Environment, Asset, People, Contractor, Project, and Core). Actions are included in the Actions Extract regardless of whether their originating module is enabled for extraction. Approvals are only included in the Approvals Extract for modules that have been enabled for extraction. IQ template data inclusion is controlled separately at the question level via the Data Extract field export code.