@vertigis/workflow-activities-json-schema

JSON Schema Activities

This project contains activities to validate JSON data against a provided JSON schema in a VertiGIS Studio Workflow.

This project uses Ajv JSON schema validator.

Requirements

VertiGIS Studio Workflow Versions

The JSON Schema activities are designed to work with VertiGIS Studio Workflow versions 5.33 and above.

Usage

To use the JSON Schema activities in VertiGIS Studio Workflow Designer you need to register an activity pack and then add the activities to a workflow.

Register the JSON Schema activity pack

1. Sign in to ArcGIS Online or Portal for ArcGIS
2. Go to My Content
3. Select Add Item > An application
   • Type: Web Mapping
   • Purpose: Ready To Use
   • API: JavaScript
   • URL: The URL to this activity pack manifest
     • Use https://unpkg.com/@vertigis/workflow-activities-json-schema@1.0.0/activitypack.json for a specific version
     • Use https://unpkg.com/@vertigis/workflow-activities-json-schema@1/activitypack.json for the latest revision of a specific major version
     • Use https://unpkg.com/@vertigis/workflow-activities-json-schema/activitypack.json for the latest version (not recommended for production use)
     • Use https://localhost:5000/activitypack.json for a local development version
   • Title: Your desired title
   • Tags: Must include geocortex-workflow-activity-pack
4. Reload VertiGIS Studio Workflow Designer
5. The JSON Schema activities will now appear in the activity toolbox in a JSON Schema category

Development

This project was bootstrapped with the VertiGIS Studio Workflow SDK. Before you can use your activity pack in the VertiGIS Studio Workflow Designer, you will need to register the activity pack.

Available Scripts

Inside the newly created project, you can run some built-in commands:

npm run generate

Interactively generate a new activity or form element.

npm start

Runs the project in development mode. Your activity pack will be available at http://localhost:5000/main.js. The HTTPS certificate of the development server is a self-signed certificate that web browsers will warn about. To work around this open https://localhost:5000/main.js in a web browser and allow the invalid certificate as an exception. For creating a locally-trusted HTTPS certificate see the Configuring a HTTPS Certificate section on the VertiGIS Studio Developer Center.

npm run build

Builds the activity pack for production to the build folder. It optimizes the build for the best performance.

Your custom activity pack is now ready to be deployed!

See the section about deployment in the VertiGIS Studio Developer Center for more information.

Documentation

Find further documentation on the SDK on the VertiGIS Studio Developer Center