Specifications

A specification defines the data to be uploaded or downloaded and the workflow required from a User.

An administrative user can create multiple specifications within a project. Once a specification has been created it needs to be configured.

     Note: Visit Assignments for information on assigning Users to Specifications.

Selecting the Specifications tab within your Project.

ClosedCreating Specifications

Once you have added a project you can use the Specifications tab to define specifications associated with the project.

Selecting the Specifications tab within your Project.

You can add a specification by selecting the The add project button icon, where you will be prompted to add a specification Name, Description, and choose a Media Retention Policy.

Add Specification popout.

Fill out the form and click the Add Spercification button to create a default Specification.

ClosedSpecification Settings

Within the Settings tab the following configuration options are available.

Setting

Description

Key

An auto-generated unique Key based on the project name.

Name

Enter the name for the specification you are defining.

Description

This description will appear for users who have been assigned to the specification.

Timeout Period

How long before an incomplete submission times out and is rejected:

  • 1 Day
  • 1 Week
  • 2 Weeks
  • 1 Month
  • 6 Months
  • 1 Year

Auto Close Period

How long before a finished submission closes automatically. This has the same options as Timeout Period.

Media Retention Policy

The media retention policy defines how long any uploaded data will remain on the system, from the following options:

  • Never retain
  • Retain for period
  • Retain forever

Media Retention Period

How long media is retained for if the Media Retention Policy is set to Retain for period. This has the same options as Timeout Period.

Active?

Set to mark the specification as active to allow interaction.

Allow unmapped source data?

Select this option to allow suppliers to submit unmapped data.

Allow unmapped target data?

Select this option to allow users to submit unmapped target data.

     Note: Allowing unmapped data can lead to submission failures during data processing.

Show unmapped target data warning?

If Allow unmapped target data? is checked then this can be toggled to add a warning for unmapped target data.
Example Specification Settings

ClosedConfiguration

Within the Configuration tab you can select which session template you would like to use, and configure conformance modes.

Selecting the Edit icon in the Session Template field will allow you to choose a template to use and, once this has been selected, the relevant data stores will be available to configure.

The Configuration tab with the Session Template field annotated.

Navigate the file structure and choose the required template and click Confirm.

Session Template popout.

The task list will be populated by the template, where you can then configure Pass Thresholds and task options.

ClosedConformance Mode

The conformance mode can be changed by selecting one of the three options form the drop down menu:

  • All Check Rules Tasks - Only Check Rules Tasks will be used for verification.
  • All Tasks - Both Rules and Actions Maps will be used for verification.
  • Selected Tasks - Only the selected Tasks will be used for verification.

ClosedData Stores

From here, you can decide whether to allow the upload and download of input/output data, and enable/disable schema mapping.

A Project's configuration screen showing the data stores with inputs and outputs.

The Upload Mode can be set so that submissions don't require data to be uploaded before running. This will use the data that was set in the 1Integrate configuration for the submission.

Upload options for a Data Store.
  • Not Supported - Data cannot be uploaded.
  • Optional - Data isn't necessary but can be uploaded if needed.
  • Required - A file must be uploaded.

The Schema Mapping can be set to enable or disable the automatic or manual schema mapping.

Schema Mapping options for a Data Store.
  • Automatic - Editable - The schema is automatically mapped but allows Suppliers to edit the schema.
  • Automatic - The schema is automatically mapped.
  • None - This disables automatic schema mapping.

The Download Modified Input Mode and Download Mode can be set to enable or disable the ability to download data..

Download options for Modified Input Data or Output Data.
  • Downloadable - The Modified Input/Output data can be downloaded.
  • Not Supported - Data cannot be downloaded.

ClosedTasks

This tab displays a breakdown of all tasks associated with your selected template.

Project Configuration showing the list of tasks that a submission would perform in the processing phase.

If Selected Tasks Only is the chosen Conformance Mode, you can choose which Tasks will be used to confirm success or failure by selecting the Record conformance statistics check boxes.

Example configuration containing all the tasks with task options.

Task

Task Option

Description

Validate Schema

Record conformance results

 

 

Enabling this allows the collection of conformance statistics and the setting of Pass Thresholds.

 

 

Check Rules

Apply Action Map

Pause

Require all previous tasks to pass

When this is enabled the submission will be automatically rejected if any previous tasks do not meet the pass threshold.

ClosedPass Thresholds

If you have Pause tasks defined in your 1Integrate Session, you have the option to enforce pass thresholds with the Require all previous tasks to pass option. For more information about 1Integrate Sessions, please refer to the 1Integrate documentation.

Defining a Pass Threshold (%) on a task will determine the percentage of feature conformance required in order to continue a submission. The Pass Threshold (%) defaults to 100.00% and can only be edited on Tasks with the Record conformance results option enabled.

     Note: You can set a Pass Threshold (%) for submissions that do not have pause tasks. This will not halt the submission process but will give a warning to the user and show the percentage of conformation.

ClosedDeleting Specifications

To delete a specification select Delete Specification from the Specification Settings tab.

     Note: Deleting Specifications cannot be undone and can only be deleted by Administrators with the receiver permission.

The bottom of the Specification Settings page with the Manage Specification Panel annotated.

To confirm deletion enter the Specification Key to remove the Specifications and all its associated Assignments, and Submissions.

Delete Specification popout requiring the Specification Key to confirm deletion.

ClosedMetadata sent to 1Integrate

1Data Gateway sends its attributes as session parameters to 1Integrate when a submission is started.

1Data Gateway Attribute

Session Parameter

Example

User Key

1dg_user_key

{guid}

User Email

1dg_user_email

example.user@1spatial.com

Supplier Key

1dg_supplier_key

1S

Supplier Name

1dg_supplier_name

1Spatial

Project Key

1dg_project_key

MP

Project Name

1dg_project_name

My Project

Specification Key

1dg_specification_key

MP-SPEC-1

Specification Name

1dg_specification_name

My Specification

Assignment Key

1dg_assignment_key

MP-ASSN-1

Assignment Reference

1dg_assignment_reference

1 Spatial

Submission Key

1dg_submission_reference

{guid}

Input Files

1dg_input_files

 
{  "/Folder/Datastore A": {
    "filename": "FileA.zip",
    "size": 3126345
  },
  "/Folder/Datastore B": {
    "filename": "FileB.zip",
    "size": 87655
  }
}
FAQs
Where do I enable schema mapping for a user?

In a previous version of 1Data Gateway, Schema Mapping was enabled via the Specification settings of a project. This is now enabled on the Project's Configuration page by changing the Schema Mapping setting. For more details see Data Stores under Configuration on the Specifications page.