1.0.2 • Published 8 months ago

@vertigis/workflow-activities-1integrate v1.0.2

Weekly downloads
-
License
MIT
Repository
github
Last release
8 months ago

CI/CD npm

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

1Integrate

1Integrate brings the power of 1Spatial’s patented rules engine to your data, delivering automated validation, cleansing, transformation, and enhancement. It gives you confidence in your data by assessing its quality, ensuring it meets defined specifications and is fit for purpose. Connect, Check and Correct your data, then Repeat those processes when required.

Usage

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

Register the 1Integrate activity pack

  1. Sign in to ArcGIS Online or Portal for ArcGIS
  2. Go to My Content
  3. Select Add Item > An application
  4. Reload VertiGIS Studio Workflow Designer
  5. The 1Integrate activities will now appear in the activity toolbox in a 1Spatial - 1Integrate category

Use the 1Integrate activities in a workflow

  1. Establish a connection to the 1Integrate service
    1. To connect to the 1Integrate service as a user:
      1. Add the Authenticate App activity to a workflow
      2. Set the Base URL input to the root URL of your 1Integrate server. For example, https://acme.1integrate.com/1integrate.
      3. Set the Access Token URL input to the URL of your 1Integrate server's access token endpoint.
      4. 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 1Integrate service
    1. Add one of the other 1Integrate activities to the workflow. For example, Get Rules.
    2. Set the Service input of the activity to be the output of the Authenticate App activity
      • Typically this would use an expression like =$authenticateApp.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 test

Runs all unit tests.

npm run lint

Runs linter to perform static analysis.

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