NAS Sync Tool Manifest

Begin with the following manifest template, the relevant sections indicated with [brackets] should be replaced with the relevant terms. See guidance below for details on how to fill out each block.

schema_version: 1.0
manifest:

  organisation:
    name: [ORGANISATION NAME]
    
  project:
    name: [PROJECT NAME]
    
  users:
    - name: [USER EMAIL]
      permissions: [PERMISSION]
    - name: [USER EMAIL]
      permissions: [PERMISSION]
    
  site:
    name: [SITE NAME]
    geometry:
      type: Point
      coordinates:
        - [LATITUDE]
        - [LONGITUDE]

  assets:
    - name:  [ASSET NAME]
      geometry:
        type: Point
        coordinates:
           - [LATITUDE]
           - [LONGITUDE]
    - name:  [ASSET NAME]
      geometry:
        type: Point
        coordinates:
           - [LATITUDE]
           - [LONGITUDE]
        
  artifacts:
    sync: [YES OR NO]

Guidance

General Information

• The manifest is in a format called YAML, and it must valid YAML for the tool to parse it correctly. Please verify that the manifest you have created is valid using this tool.  
• The NAS Sync Tool will attempt to find entities in the platform referenced by name. This means that as long as the name doesn't change, you can change the other properties in the manifest, and the platform entities will be updated on the next synchronisation. If you change the name of an entity, then a new entity will be created in the platform alongside the original, and the original must be manually deleted.

Organisation

• This must already exist. The NAS Sync tool is unable to create organisations and admin groups for security reasons.
• The spelling of the organisation will need to match the existing organisation in the platform.
• You can get the existing organisation name by contacting platform support.

Project

• Specify the name of the project, it will be created if it does not exist.
• The project will be owned by the organisation specified in the manifest.

Users

• This block expects a list of users, each must be provided with an email and permission group.
• The user will be created if they do not exist.
• The permissions must be one of read_write or read_only.

Site

• Specify the name of the site, it will be created if it does not exist.
• The site will be owned by the organisation specified in the manifest.
• The geometry is provided in GeoJSON format.
• Current we only support Point geometry.

Asset

• Specify the name of the asset, it will be created if it does not exist.
• The asset will belong to the site specified in the manifest.
• The geometry is provided in GeoJSON format.
• Current we only support Point geometry.

Artifacts

• If sync is set to yes then local files in the folder will be synchronised with the platform. If this is no then they won't, but the other entities specified in the manifest (project, assets, users, etc) will still be created.