VertiGIS Data Gateway Workflow Activities

A VertiGIS Studio Workflow Activity Pack that provides activities for interacting with the VertiGIS Data Gateway REST API.

Overview

This activity pack extends VertiGIS Studio Workflow with activities for working with:

• Assignments
• Submissions
• Submission Inputs
• Submission Parameters
• Specification Metadata
• Users

The pack uses OpenAPI-generated TypeScript definitions to provide strongly typed integrations with the VertiGIS Data Gateway API.

Installation

Install project dependencies:

npm install

Development

Start Local Development Server

npm run start

Build

npm run build

Generate Activity Metadata

npm run generate

Lint

npm run lint

Format

npm run prettier

OpenAPI Type Generation

The project uses openapi-typescript to generate API contracts from the VertiGIS Data Gateway OpenAPI specification.

Generate the latest types:

npm run generate:api:remote

Generated file:

src/api/generated/types.ts

Do not manually edit the generated file.

Activity Categories

VertiGIS Data Gateway- Assignments

• Get Assignment
• Get My Assignments

VertiGIS Data Gateway- Submissions

• Create Submission
• Create Data Gateway Service
• Get Submission
• Get Submissions
• Start Submission
• Close Submission
• Cancel Submission
• Patch Submission
• Describe Inputs
• Patch Input Parameters
• Upload Input Submission
• Download Submission Output

VertiGIS Data Gateway- Specifications

• Fetch Specification Fields

VertiGIS Data Gateway- Users

Authentication

Data Gateway Service requires:

| Input | Description | |---------|---------| | baseUrl | Base URL of the VertiGIS Data Gateway environment | | bearerToken | OAuth bearer token |

Design Principles

Shared HTTP Client

All activities use:

DataGatewayClient

to centralize:

• Authentication
• Request construction
• Parameter serialization
• Endpoint management

Generated Types

All API contracts originate from:

src/api/generated/types.ts

Activities should use:

components["schemas"]

and

operations

instead of creating duplicate DTOs.

Example:

type Submission =
    components["schemas"]["SubmissionDetail"];

Contributing

When adding activities:

1. Regenerate OpenAPI types if needed.
2. Use generated contracts from types.ts.
3. Add Workflow metadata:
   • @category
   • @defaultName
   • @description
4. Validate required inputs.
5. Keep business logic inside DataGatewayClient.
6. Keep activities as thin wrappers.

Register the VertiGIS Data Gateway 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/[email protected]/activitypack.json for a specific version
     • Use https://unpkg.com/@vertigis/vertigis-data-gateway-activity-pack@1/activitypack.json for the latest revision of a specific major version
     • Use https://unpkg.com/@vertigis/vertigis-data-gateway-activity-pack/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 State Manager activities will now appear in the activity toolbox in a VertiGIS Data Gateway category