VertiGIS Studio Workflow SDK

This SDK makes it easy to create custom activity packs for VertiGIS Studio Workflow.

Requirements

• The latest LTS version of Node.js
• A code editor of your choice. We recommend Visual Studio Code
• A viewer using VertiGIS Studio Workflow 5.31 or later (VertiGIS Product Installer Downloads)
  • VertiGIS Studio Web 5.22 or later
  • Workflow 5.31 widget for ArcGIS Experience Builder or later

Creating a new project

To create a project called activity-pack run this command:

npx @vertigis/workflow-sdk@latest create activity-pack

This will bootstrap a new project in the specified directory to quickly get you up and running 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. By default, Your activity pack will be available at https://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 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.

Command Line Arguments

The start script supports the following optional arguments that are passed along to webpack-dev-server.

• --allowed-hosts - Default is all. [docs]
• --host - Default is localhost. [docs]
• --port - Default is 5000. [docs]
• --type - Server type. Default is https. [docs]
• --key - Provide a private key in PEM format. [docs]
• --cert - Provide a certificate chain in PEM format. [docs]
• --ca - Override the trusted CA certificates. [docs]

NOTE: It is important to add -- before the list of parameters.

Example:

npm start -- --host 0.0.0.0 --allowed-hosts auto

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.

Upgrading

To update a previously created project to the latest version of the Workflow SDK, navigate to the root directory of that project and run

npx @vertigis/workflow-sdk@latest upgrade

Documentation

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

Contributing

See CONTRIBUTING.md for contributing guidelines.