https://github.com/vertigis/workflow-activities-json-schema

Activities for evaluating JSON against a schema in VertiGIS Studio Workflow
https://github.com/vertigis/workflow-activities-json-schema

Last synced: 4 months ago
JSON representation

Activities for evaluating JSON against a schema in VertiGIS Studio Workflow

• Host: GitHub
• URL: https://github.com/vertigis/workflow-activities-json-schema
• Owner: vertigis
• License: mit
• Created: 2023-07-24T23:02:49.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-11-20T21:56:11.000Z (over 1 year ago)
• Last Synced: 2025-09-26T13:19:15.375Z (9 months ago)
• Language: TypeScript
• Homepage:
• Size: 2.97 MB
• Stars: 3
• Watchers: 5
• Forks: 1
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# JSON Schema Activities

[![CI/CD](https://github.com/vertigis/workflow-activities-json-schema/workflows/CI/CD/badge.svg)](https://github.com/vertigis/workflow-activities-json-schema/actions)

[![npm](https://img.shields.io/npm/v/@vertigis/workflow-activities-json-schema)](https://www.npmjs.com/package/@vertigis/workflow-activities-json-schema)

This project contains activities to validate JSON data against a provided JSON schema in a [VertiGIS Studio Workflow](https://www.vertigisstudio.com/products/vertigis-studio-workflow/).

This project uses [Ajv JSON schema validator](https://github.com/ajv-validator/ajv#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](https://apps.vertigisstudio.com/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

1. Go to **My Content**

1. 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`

1. Reload [VertiGIS Studio Workflow Designer](https://apps.vertigisstudio.com/workflow/designer/)

1. 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](https://github.com/vertigis/vertigis-workflow-sdk). Before you can use your activity pack in the [VertiGIS Studio Workflow Designer](https://apps.vertigisstudio.com/workflow/designer/), you will need to [register the activity pack](https://developers.vertigisstudio.com/docs/workflow/sdk-web-overview#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](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`](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](https://developers.vertigisstudio.com/docs/workflow/sdk-web-overview/#configuring-a-https-certificate) section on the [VertiGIS Studio Developer Center](https://developers.vertigisstudio.com/docs/workflow/overview/).

### `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](https://developers.vertigisstudio.com/docs/workflow/sdk-web-overview/#deployment) in the [VertiGIS Studio Developer Center](https://developers.vertigisstudio.com/docs/workflow/overview/) for more information.

## Documentation

Find [further documentation on the SDK](https://developers.vertigisstudio.com/docs/workflow/sdk-web-overview/) on the [VertiGIS Studio Developer Center](https://developers.vertigisstudio.com/docs/workflow/overview/)