sc-import-json

1 Purpose

This document is a user guide for the Formbird sc-import-json component version 5.1.

sc-import-json places field on a form allowing the user to select a json file and save the documents within the file as documents in the database.

The import json file field on the form provides:

• A button to browse and select a json file for importing.
• An area to drag and drop a json file for importing.
• A Results table to display each document within the selected json file and their import status (e.g. "Awaiting Save").
• A "CLEAR" button to clear the Results table and cancel the import process.
• A "SAVE" button to save the documents within the json file as documents in the database by using a pre-defined template.
• Counters for "Records Read", "Documents Created" and "Errors".

The sc-import-json definition provides fields for setting the properties of the sc-import-json field and is fully described below.

2 Definition

sc-import-json is defined by a set of name/value pair fields consisting of:

• Required system fields
• Required customizable fields
• Optional customizable fields

Note:

1. Default values for fields described in the tables below are shown in bold text.

2.1 Required System Fields

2.2 Required Customizable Fields

2.3 Optional Customizable Fields

3 Typical Definition

Below is a typical sc-import-json definition, defined with its required fields plus any optional field whose value is typically other than its default value.

        {
            "componentName": "sc-import-json",
            "name": "testScImportJson",
            "columns": [
                "documentId",
                "date_stamp",
                "zone_id",
                "zone_name",
                "operational_state",
                "wat_category",
                "zoneGeo"
            ],
            "labels": [
                "Document ID",
                "Date Stamp",
                "Zone ID",
                "Zone Name",
                "Operational State",
                "Water Category",
                "Zone Geometry"
            ],
            "label": "Test sc-import-json",
            "fullWidth": true,
            "templateId": "44524840-55dc-11e9-be36-2f29df521630",
            "disableSave": true
        }

One or more of the optional fields shown below can be included in the above definition should a value other than their default value be required.

    "directImporting":true,
    "disableSaving":true,
    "documentIdMatch":"replace",
    "documentIdNoMatch":"error",
    "enabled":false,
    "visible":false

4 Examples

Example 1

sc-import-json defined with the typically needed fields.

        {
            "componentName": "sc-import-json",
            "name": "testScImportJson",
            "columns": [
                "documentId",
                "date_stamp",
                "zone_id",
                "zone_name",
                "operational_state",
                "wat_category",
                "zoneGeo"
            ],
            "labels": [
                "Document ID",
                "Date Stamp",
                "Zone ID",
                "Zone Name",
                "Operational State",
                "Water Category",
                "Zone Geometry"
            ],
            "label": "Test sc-import-json",
            "fullWidth": true,
            "templateId": "44524840-55dc-11e9-be36-2f29df521630",
            "disableSave": true
        }

Resulting field on the form:

Below is a sample json file that could be imported using the above sc-import-json field:

The above json file contains 3 documents each having the following 7 fields:

• "documentId": The value of this field:
• Will display in the Results table "Document ID" column.

• Will be saved in the template's "documentId" field.

• "date_stamp": The value of this field:

  • Will display in the Results table "Date Stamp" column.
  • Will be saved in the template's "date_stamp" field.

• "zone_id": The value of this field:

  • Will display in the Results table "Zone ID" column.
  • Will be saved in the template's "zone_id" field.

• "zone_name": The value of this field:

  • Will display in the Results table "Zone Name" column.
  • Will be saved in the template's "zone_name" field.

• "operational_state": The value of this field:

  • Will display in the Results table "Operational State" column.
  • Will be saved in the template's "operational_state" field.

• "wat_category": The value of this field:

  • Will display in the Results table "Water Category" column.
  • Will be saved in the template's "wat_category" field.

• "zoneGeo": The value of this field:

  • Will display in the Results table "Zone Geometry" column.
  • Will be saved in the template's "zoneGeo" field.
  • Defines the geometry of a polygon allowing it to be displayed on a map.

Resulting field on the form after selecting the above json file:

Clicking the "CLEAR" button will clear the Results table and cancel the import process.

Clicking the "SAVE" button will save the selected json file to the database such that one document is created and saved for each document within the json file.

Resulting field on the form after clicking the "SAVE" button:

To open a created document, click its hyperlink in the Result column.

Clicking the 1st hyperlink in the Results table opens the document created for the 1st document within the json file:

Notes:

1. The above document was created and is being displayed using the predefined template whose documentId is the templateId field value in the sc-import-json definition.
2. The fields of the above document were saved in the database as:

    "documentId": "6f839c80-5a5f-11e9-991a-1faf1584063b",
    "date_stamp": "2018-08-20T02:35:00.000Z",
    "zone_id": "1",
    "zone_name": "Hansen Reserve",
    "operational_state": "ACTIVE",
    "wat_category": "POTABLE",
    "zoneGeo": {
        "type": "FeatureCollection",
        "features": [
            {
                "type": "Feature",
                "geometry": {
                    "type": "Polygon",
                    "coordinates": [
                        [
                            [
                                144.87159004211424,
                                -37.8016954692588
                            ],
                            [
                                144.87596740722654,
                                -37.80223801120207
                            ],
                            [
                                144.87545242309568,
                                -37.80474721584969
                            ],
                            [
                                144.87442245483396,
                                -37.80461158534551
                            ],
                            [
                                144.87429370880125,
                                -37.80600178620508
                            ],
                            [
                                144.87086048126218,
                                -37.80562880805537
                            ],
                            [
                                144.87159004211424,
                                -37.8016954692588
                            ]
                        ]
                    ]
                },
                "properties": {}
            }
        ]
    }

1. The fields in the database document have the same name as the corresponding fields in the json file.
2. The order of the fields in the database document matches the order of the fields in the sc-import-json definition columns array.
3. If the predefined template used to create the above document did not have a field name exactly matching a field name in the imported json file, the document would still be created but the field would not display on the form until the predefined template was updated with a matching field name.