@vertigis/workflow-form-elements-web v3.0.0

This project contains VertiGIS Studio Workflow form elements for use in VertiGIS Studio Web.

VertiGIS Studio Web is built using React components from the @vertigis/web package. Those components are internally built using React components from the @mui/material package.

This activity pack wraps specific React components from @vertigis/web and exposes them as workflow form elements that can be included in workflows via Custom Form Elements.

The following React components/form elements are supported:

• Alert
• Avatar
• Button
• CheckboxList
• Chip
• CircularProgress
• DynamicIcon
• EditableTable
• IconButton
• LinearProgress
• Link
• List
• Pagination
• Slider
• Switch
• Tabs
• Table
• ToggleButton
• Typography

Requirements

VertiGIS Studio Versions

These form elements are designed to work with VertiGIS Studio Web versions 5.28 and above.

Usage

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

Register the Web Form Elements 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/workflow-form-elements-web@1.0.0/activitypack.json for a specific version
     • Use https://unpkg.com/@vertigis/workflow-form-elements-web@1/activitypack.json for the latest revision of a specific major version
     • Use https://unpkg.com/@vertigis/workflow-form-elements-web/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

Use the Web Form Elements in a workflow

1. Add a Display Form activity to the workflow
2. Add a Custom form element to the form
3. Set the Custom Type property of the form element to be the desired form element type
   • For example, Link
4. Expand the Events section of the form element properties
5. Add a load event
6. Add a Set Form Element Property activity to the subworkflow
7. Set the Property Name input of the activity to be the name of the property you wish to set
   • For example, href
8. Set the Property Value input of the activity to be the name of the property you wish to set
   • For example, https://placekitten.com/g/200/300
9. Repeat steps 6 - 8 for each property you wish to set
   • See the source code of the form element for the available properties and their usage

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