https://github.com/vertigis/vertigis-workflow-sdk
The SDK for VertiGIS Studio Workflow
https://github.com/vertigis/vertigis-workflow-sdk
arcgis geocortex vertigis workflow
Last synced: 4 months ago
JSON representation
The SDK for VertiGIS Studio Workflow
- Host: GitHub
- URL: https://github.com/vertigis/vertigis-workflow-sdk
- Owner: vertigis
- License: mit
- Created: 2020-10-09T18:30:20.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2026-01-20T20:07:31.000Z (5 months ago)
- Last Synced: 2026-01-21T02:35:55.779Z (5 months ago)
- Topics: arcgis, geocortex, vertigis, workflow
- Language: JavaScript
- Homepage: https://developers.vertigisstudio.com/docs/workflow/sdk-web-overview
- Size: 243 KB
- Stars: 3
- Watchers: 5
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# VertiGIS Studio Workflow SDK
[](https://www.npmjs.com/package/@vertigis/workflow-sdk)
This SDK makes it easy to create custom activity packs for [VertiGIS Studio Workflow](https://www.vertigisstudio.com/products/vertigis-studio-workflow/).
## Requirements
- The latest LTS version of [Node.js](https://nodejs.org/en/download/)
- A code editor of your choice. We recommend [Visual Studio Code](https://code.visualstudio.com/)
- A viewer using VertiGIS Studio Workflow 5.31 or later ([VertiGIS Product Installer Downloads](https://apps.vertigisstudio.com/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:
```sh
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](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. By default, Your activity pack will be available at [https://localhost:5000/main.js](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](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/).
#### Command Line Arguments
The `start` script supports the following optional arguments that are passed along to [webpack-dev-server](https://github.com/webpack/webpack-dev-server/tree/main?tab=readme-ov-file).
- `--allowed-hosts` - Default is `all`. [[docs](https://github.com/webpack/webpack-dev-server/blob/main/DOCUMENTATION-v4.md#devserverallowedhosts)]
- `--host` - Default is `localhost`. [[docs](https://github.com/webpack/webpack-dev-server/blob/main/DOCUMENTATION-v4.md#devserverhost)]
- `--port` - Default is `5000`. [[docs](https://github.com/webpack/webpack-dev-server/blob/main/DOCUMENTATION-v4.md#devserverport)]
- `--type` - Server type. Default is `https`. [[docs](https://github.com/webpack/webpack-dev-server/blob/main/DOCUMENTATION-v4.md#devserverserver)]
- `--key` - Provide a private key in PEM format. [[docs](https://developers.vertigisstudio.com/docs/workflow/sdk-web-overview/#configuring-a-https-certificate)]
- `--cert` - Provide a certificate chain in PEM format. [[docs](https://developers.vertigisstudio.com/docs/workflow/sdk-web-overview/#configuring-a-https-certificate)]
- `--ca` - Override the trusted CA certificates. [[docs](https://developers.vertigisstudio.com/docs/workflow/sdk-web-overview/#configuring-a-https-certificate)]
NOTE: It is important to add `--` before the list of parameters.
Example:
```sh
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](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.
## 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
```sh
npx @vertigis/workflow-sdk@latest upgrade
```
## 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/).
## Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md) for contributing guidelines.