SIP Data Importer FAQs
This page describes the process for import new SIP or updating existing records.
Overview
The data set for inserting or updating indicator records is is communicated via the REST API - see Neelix REST API overview
The general task at hands it to send array of "indicator" records as per SIP Import documentation (see below).
Reference implementation:
- AppScript Library that utilizes REST API for making GET and POST actions
- Googlesheet that supports following actions
- GET RAG Status configurations
- GET Indicators records with core attributes
- GET Indicators With Assessed Status
- POST Status Update
- Bulk Import (Insert new or Update existing)
SIP Import Documentation
See /sip/import POST action and description of "Indicator" schema attributes documented here.
Example record in the array:
| Attribute | Requirement | Example Value |
|---|---|---|
| migration_comment | Optional | Migrated from Excel |
| api_action | Mandatory | insert |
| sip_type | Mandatory | goal |
| sip_indicator_type | Mandatory | indicator |
| id | Mandatory | source_goal_1 |
| parent_id | Optional | |
| consortium_id | Mandatory | 2c1e6cd8-c54b-4846-af76-3ebe94fd7772 |
| lang | Mandatory | en |
| name | Mandatory | Top level objective |
| title | Optional | |
| rag_method | Mandatory | calculate |
| rag_default_algorithm | Optional | |
| rag_weight | Optional | |
| cadence_days | Optional | |
| is_highest_order_objective | Optional | |
| target_date | Optional | |
| objective_description | Optional | |
| lat | Optional | |
| lng | Optional |
API REPORT
The import service returns are report object with following information:
- countInserted - count of records inserted
- countUpdated - count of records updated
- message - summary message of possible issues
- migrationResult - array with the mapping between source_id and new_id