Cityworks Activities

This project contains activities for interacting with the Cityworks REST API in a VertiGIS Studio Workflow.

This project uses version 15.8.3 of the Cityworks TypeScript SDK. To use this activity pack you must have a license to use the Cityworks REST API.

Usage

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

Register the Cityworks 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/workflow-activities-cityworks@1/activitypack.json for the latest revision of a specific major version
     • Use https://unpkg.com/@vertigis/workflow-activities-cityworks/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 Cityworks activities will now appear in the activity toolbox in various Cityworks categories

Use the Cityworks activities in a workflow

1. Establish a connection to the Cityworks service
   1. Add the Create Cityworks API Service activity to a workflow
   2. Set the URL input to the root URL of your Cityworks server. For example, https://cloud01.cityworks.com/<organization>.
   3. If you have an existing Cityworks access token, assign it to the Token input
   4. If you have a username and password, assign them to the Username and Password inputs
   • IMPORTANT: tokens and passwords are credentials that should not be hard coded into workflows. These values should be acquired by the workflow at runtime from the end user or from another secure system.
2. Use the Cityworks service
   1. Add one of the other Cityworks activities to the workflow. For example, Get Service Requests.
   2. Set the Service input of the activity to be the output of the Create Cityworks API Service activity
      • Typically this would use an expression like =$cwApi.service
   3. Supply any additional inputs to the activity
   4. Supply the result output of the activity to the inputs of other activities in the workflow
3. Run the workflow

Development

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

Available Scripts

Inside this 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 lint

Runs linter to perform static analysis.

npm run test

Runs all unit tests.

npm run test -- --coverage

Runs all unit tests with coverage.

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

Contributing

See CONTRIBUTING.md for contributing guidelines.