Elements XS Activities

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

Usage

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

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

Use the Elements XS activities in a workflow

1. Establish a connection to the Elements XS service
   1. To connect to the Elements XS service as an application:
      1. Add the Authenticate App activity to a workflow
      2. Set the URL input to the root URL of your Elements XS server. For example, https://salesapi.novotx.com.
      3. Set the AppName, CompanyAccount and Secret inputs
   2. To connect to the Elements XS service as a user:
      1. Add the Authenticate User activity to a workflow
      2. Set the URL input to the root URL of your Elements XS server. For example, https://salesapi.novotx.com.
      3. Set the Username and Password inputs
   • IMPORTANT: secrets 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 Elements XS service
   1. Add one of the other Elements XS activities to the workflow. For example, Get Work Item.
   2. Set the Service input of the activity to be the output of the Authenticate App|User activity
      • Typically this would use an expression like =$xsService1.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 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. 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 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