Skip to content

Commit

Permalink
Update all workflow docs links to new H+M pattern (#73)
Browse files Browse the repository at this point in the history
  • Loading branch information
kenlyon authored Oct 9, 2024
1 parent 56bc4c5 commit 9787a9a
Show file tree
Hide file tree
Showing 49 changed files with 81 additions and 81 deletions.
4 changes: 2 additions & 2 deletions blog/2023-03-01-mobile-generic-event-listener.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -243,7 +243,7 @@ Using the `layers.visibility-changed` event, we configure a Workflow as an actio
},
```

By specifying the `context`, we're able to retrieve an input value within a Workflow using the [Get Workflow Inputs](https://docs.vertigisstudio.com/workflow/latest/help/Default.htm#wf5/help/activities/get-workflow-inputs.htm#Get_Workflow_Inputs_Activity) activity.
By specifying the `context`, we're able to retrieve an input value within a Workflow using the [Get Workflow Inputs](https://docs.vertigisstudio.com/workflow/latest/help/get-workflow-inputs.html) activity.

In our Workflow, we would want to run `Get Workflow Inputs` as our first activity to retrieve the input. Once we have the input as an object in our Workflow, we can access the `context` to start working with the input.

Expand Down Expand Up @@ -277,7 +277,7 @@ Using the new [viewer.publish-event](https://developers.vertigisstudio.com/docs/

### Raise Event through Workflow

But what if we want to raise a custom event during execution of a Workflow? Using the [Publish Event](https://docs.vertigisstudio.com/workflow/latest/help/Default.htm#wf5/help/activities/publish-event.htm) activity, it's possible to raise a custom event from anywhere in your Workflow logic. Simply provide the same custom event name to the `Event Name` input in the `Publish Event` activity. Arguments may also be provided. For the above example, that would be:
But what if we want to raise a custom event during execution of a Workflow? Using the [Publish Event](https://docs.vertigisstudio.com/workflow/latest/help/publish-event.html) activity, it's possible to raise a custom event from anywhere in your Workflow logic. Simply provide the same custom event name to the `Event Name` input in the `Publish Event` activity. Arguments may also be provided. For the above example, that would be:

```json
custom.raised-event
Expand Down
2 changes: 1 addition & 1 deletion docs/mobile/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Before investing in developing workflows or custom code, see if your use case ca

### VertiGIS Studio Workflow

[**VertiGIS Studio Workflow**](https://docs.vertigisstudio.com/workflow/) is a powerful tool that comes bundled with VertiGIS Studio Mobile which can create custom behavior and UI without custom code development. Many behaviors in VertiGIS Studio Mobile can be [replaced by a workflow](tutorial-change-default-map-click-behavior.mdx) that runs entirely custom logic. VertiGIS Studio Workflow can even [display complex customized forms](https://docs.vertigisstudio.com/workflow/latest/help/Default.htm#wf5/help/forms.htm).
[**VertiGIS Studio Workflow**](https://docs.vertigisstudio.com/workflow/) is a powerful tool that comes bundled with VertiGIS Studio Mobile which can create custom behavior and UI without custom code development. Many behaviors in VertiGIS Studio Mobile can be [replaced by a workflow](tutorial-change-default-map-click-behavior.mdx) that runs entirely custom logic. VertiGIS Studio Workflow can even [display complex customized forms](https://docs.vertigisstudio.com/workflow/latest/help/forms.html).

### Custom Workflow Activities and Form Elements

Expand Down
2 changes: 1 addition & 1 deletion docs/mobile/sdk-components-reference.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

:::tip
Did you know VertiGIS Studio Workflow allows you to [create custom forms](https://docs.vertigisstudio.com/workflow/latest/help/Default.htm#wf5/help/forms.htm#Overview_of_Forms%3FTocPath%3DForms%7COverview%2520of%2520Forms%7C_____0) you can present to an end user?
Did you know VertiGIS Studio Workflow allows you to [create custom forms](https://docs.vertigisstudio.com/workflow/latest/help/forms.html) you can present to an end user?
:::

Implementing a custom component in VertiGIS Studio Mobile gives you the highest degree of flexibility with what you can do. Components can display custom, dynamic UI, register operation implementations, store persistent data, and more. They are also one of the most complex ways of customizing your mobile app, so it might be worthwhile to review simpler options like [Commands and Operations](configuration-commands-operations.mdx) or [Workflow](tutorial-change-default-map-click-behavior.mdx) first.
Expand Down
2 changes: 1 addition & 1 deletion docs/mobile/sdk-overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Services provide the shared infrastructure and core logic that power app behavio

### Commands and Operations

Commands and operations provide a framework for executing application wide behavior. Services and components can both run and implement commands and operations, allowing for interaction and consistent behavior without tight coupling. Commands and operations can also be run [in the app config](tutorial-configure-button-click.mdx) and by [Workflows](https://docs.vertigisstudio.com/workflow/latest/help/Default.htm#wf5/help/activities/run-command.htm). This can allow you to [customize the behavior of built-in components](tutorial-change-default-behavior.mdx).
Commands and operations provide a framework for executing application wide behavior. Services and components can both run and implement commands and operations, allowing for interaction and consistent behavior without tight coupling. Commands and operations can also be run [in the app config](tutorial-configure-button-click.mdx) and by [Workflows](https://docs.vertigisstudio.com/workflow/latest/help/run-command.html). This can allow you to [customize the behavior of built-in components](tutorial-change-default-behavior.mdx).

## Application Interactions

Expand Down
2 changes: 1 addition & 1 deletion docs/mobile/snippets/tweak-layout-config.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
:::tip
If you just need to make a small change to the layout and app config of an existing application, you can [download the config and layout files for the application](https://docs.vertigisstudio.com/mobileviewer/latest/admin-help/Default.htm#gmv/designer/configuration-Options.htm#Download-app-config%3FTocPath%3DConfiguration%7CConfiguration%2520Options%7C_____3), tweak them, and then re-upload them.
If you just need to make a small change to the layout and app config of an existing application, you can [download the config and layout files for the application](https://docs.vertigisstudio.com/mobileviewer/latest/admin-help/Default.htm#gmv/designer/configuration-Options.htm#Download-app-config), tweak them, and then re-upload them.
:::
8 changes: 4 additions & 4 deletions docs/mobile/tutorial-change-default-map-click-behavior.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import RelevantWorkflowSamples from "./snippets/relevant-workflow-samples.mdx";
VertiGIS Studio Mobile comes with default behavior that runs on a map click. The default behavior will identify and display details for results in the nearby area. But what if you want to replace the functionality with your own behavior? This can be accomplished by leveraging [VertiGIS Studio Workflow](https://apps.vertigisstudio.com/workflow/designer/) and editing the [app config](configuration-app-config-getting-started.mdx).

:::note
It's actually possible to configure the Map's `onClick` event in [VertiGIS Studio Mobile Designer](https://apps.vertigisstudio.com/mobile/designer/), by setting a workflow as the action for the [Maps click event](https://docs.vertigisstudio.com/webviewer/latest/admin-help/Default.htm#gwv/component-settings.htm%3FTocPath%3DConfiguration%7CComponent%2520Settings%7C_____0). However, the point of this tutorial is to demonstrate the concept of configuring actions using the app config.
It's actually possible to configure the Map's `onClick` event in [VertiGIS Studio Mobile Designer](https://apps.vertigisstudio.com/mobile/designer/), by setting a workflow as the action for the [Maps click event](https://docs.vertigisstudio.com/webviewer/latest/admin-help/Default.htm#gwv/component-settings.htm). However, the point of this tutorial is to demonstrate the concept of configuring actions using the app config.
:::

## What you're Building
Expand Down Expand Up @@ -231,7 +231,7 @@ First, we are going to replace the command chain with a `workflow.run` command t
alt="Map Click Workflow with Alert"
/>

7. Open up your workflow in the VertiGIS Studio Workflow Designer again. The default behavior we just overrode can be recreated with the use of [RunCommand](https://docs.vertigisstudio.com/workflow/latest/help/Default.htm#wf5/help/activities/run-command.htm%3FTocPath%3DActivities%7CActivity%2520Reference%7C_____169) and [RunOperation](https://docs.vertigisstudio.com/workflow/latest/help/Default.htm#wf5/help/activities/run-operation.htm%3FTocPath%3DActivities%7CActivity%2520Reference%7C_____173) activities. `tasks.identify` is an operation, so it needs a RunOperation activity, and `highlights.pulse` and `results.display` are commands, so they need RunCommand Activities. Chain these three activities together, passing the [workflow context](https://docs.vertigisstudio.com/webviewer/latest/admin-help/Default.htm#gwv/add-a-workflow-to-an-app.htm#use-the-menu-context-as-a-workflow-input%3FTocPath%3DConfiguration%7CAdd%2520a%2520Workflow%2520to%2520an%2520App%7C_____4) to `tasks.identify` and then passing the output of that operation to `highlights.pulse`, and `results.display`.
7. Open up your workflow in the VertiGIS Studio Workflow Designer again. The default behavior we just overrode can be recreated with the use of [RunCommand](https://docs.vertigisstudio.com/workflow/latest/help/run-command.html) and [RunOperation](https://docs.vertigisstudio.com/workflow/latest/help/run-operation.html) activities. `tasks.identify` is an operation, so it needs a RunOperation activity, and `highlights.pulse` and `results.display` are commands, so they need RunCommand Activities. Chain these three activities together, passing the [workflow context](https://docs.vertigisstudio.com/webviewer/latest/admin-help/Default.htm#gwv/add-a-workflow-to-an-app.htm#use-the-menu-context-as-a-workflow-input) to `tasks.identify` and then passing the output of that operation to `highlights.pulse`, and `results.display`.

:::note

Expand All @@ -248,7 +248,7 @@ First, we are going to replace the command chain with a `workflow.run` command t
</a>{" "}
and then{" "}
<a
href="https://docs.vertigisstudio.com/workflow/latest/help/Default.htm#wf5/help/import-export-workflows.htm"
href="https://docs.vertigisstudio.com/workflow/latest/help/import-export-workflows.html"
target="_blank"
>
import it into the VertiGIS Studio Workflow Designer.
Expand Down Expand Up @@ -284,7 +284,7 @@ At this point, you can choose to extend the map click behavior with VertiGIS Stu
</a>{" "}
and then{" "}
<a
href="https://docs.vertigisstudio.com/workflow/latest/help/Default.htm#wf5/help/import-export-workflows.htm"
href="https://docs.vertigisstudio.com/workflow/latest/help/import-export-workflows.html"
target="_blank"
>
import it into the VertiGIS Studio Workflow Designer.
Expand Down
2 changes: 1 addition & 1 deletion docs/mobile/tutorial-customize-application-theme.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import PrereqsLayoutConfigSnippet from "./snippets/prereqs-layout-config-editing
VertiGIS Studio Mobile's appearance is built around two concepts: theme and [layout](configuration-layout-getting-started.mdx). The theme controls the color scheme of the app, while the layout controls the organization of content.

:::note
The theme can be partially configured by using the [VertiGIS Studio Mobile Designer](https://docs.vertigisstudio.com/webviewer/latest/admin-help/Default.htm#gwv/component-settings.htm#branding-settings%3FTocPath%3DConfiguration%7CComponent%2520Settings%7C_____4).
The theme can be partially configured by using the [VertiGIS Studio Mobile Designer](https://docs.vertigisstudio.com/webviewer/latest/admin-help/Default.htm#gwv/component-settings.htm#branding-settings).
:::

## Prerequisites
Expand Down
2 changes: 1 addition & 1 deletion docs/mobile/tutorial-display-custom-form.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,6 @@ VertiGIS Studio Mobile comes with bundled with [VertiGIS Studio Workflow](https:
<UseCaseCard
title="Build a Custom Form"
description="Learn how to build a custom form with VertiGIS Studio Workflow"
link="https://docs.vertigisstudio.com/workflow/latest/help/Default.htm#wf5/help/forms.htm"
link="https://docs.vertigisstudio.com/workflow/latest/help/forms.html"
/>
</UseCaseContainer>
2 changes: 1 addition & 1 deletion docs/mobile/tutorial-implement-component-with-ui.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import UseCaseCard from "../../src/components/UseCaseCard";
import UseCaseContainer from "../../src/components/UseCaseContainer";

:::tip
Did you know VertiGIS Studio Workflow allows you to [create custom forms](https://docs.vertigisstudio.com/workflow/latest/help/Default.htm#wf5/help/forms.htm#Overview_of_Forms%3FTocPath%3DForms%7COverview%2520of%2520Forms%7C_____0) you can present to an end user?
Did you know VertiGIS Studio Workflow allows you to [create custom forms](https://docs.vertigisstudio.com/workflow/latest/help/forms.html) you can present to an end user?
:::

Implementing a custom component in VertiGIS Studio Mobile gives you the highest degree of flexibility with what you can do. [Components](sdk-components-overview.mdx) can display custom, dynamic UI, register operation implementations, store persistent data, and more. They are also one of the most complex ways of customizing your VertiGIS Studio Mobile app, so it might be worthwhile to review simpler options like [Commands and Operations](configuration-commands-operations.mdx) or [Workflow](tutorial-display-custom-form.mdx) first.
Expand Down
2 changes: 1 addition & 1 deletion docs/mobile/tutorial-implement-custom-activity.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import UseCaseCard from "../../src/components/UseCaseCard";
import UseCaseContainer from "../../src/components/UseCaseContainer";
import RelevantWorkflowSamples from "./snippets/relevant-workflow-samples.mdx";

VertiGIS Studio Mobile comes with bundled with [VertiGIS Studio Workflow](https://www.vertigisstudio.com/products/vertigis-studio-workflow/). VertiGIS Studio Workflow includes a [large suite of activities](https://docs.vertigisstudio.com/workflow/latest/help/Default.htm#wf5/help/activity-reference.htm%3FTocPath%3DActivities%7CActivity%2520Reference%7C_____0) to help you solve your business case. However, if VertiGIS Studio Workflow is missing functionality you need, you can implement a custom activity with the VertiGIS Studio Workflow SDK.
VertiGIS Studio Mobile comes with bundled with [VertiGIS Studio Workflow](https://www.vertigisstudio.com/products/vertigis-studio-workflow/). VertiGIS Studio Workflow includes a [large suite of activities](https://docs.vertigisstudio.com/workflow/latest/help/activity-reference.html) to help you solve your business case. However, if VertiGIS Studio Workflow is missing functionality you need, you can implement a custom activity with the VertiGIS Studio Workflow SDK.

## Relevant SDK Samples

Expand Down
2 changes: 1 addition & 1 deletion docs/mobile/tutorial-implement-custom-form-elements.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import UseCaseCard from "../../src/components/UseCaseCard";
import UseCaseContainer from "../../src/components/UseCaseContainer";
import RelevantWorkflowSamples from "./snippets/relevant-workflow-samples.mdx";

VertiGIS Studio Mobile comes with bundled with [VertiGIS Studio Workflow](https://www.vertigisstudio.com/products/vertigis-studio-workflow/). VertiGIS Studio Workflow includes a [large suite of form elements](https://docs.vertigisstudio.com/workflow/latest/help/Default.htm#wf5/help/form-elements/auto-complete.htm%3FTocPath%3DForms%7CForm%2520Element%2520Reference%7C_____0) to help you [create custom forms](tutorial-display-custom-form.mdx) to solve your business case. However, if VertiGIS Studio Workflow is missing a form element you need, you can implement a custom form element with the VertiGIS Studio Workflow SDK.
VertiGIS Studio Mobile comes with bundled with [VertiGIS Studio Workflow](https://www.vertigisstudio.com/products/vertigis-studio-workflow/). VertiGIS Studio Workflow includes a [large suite of form elements](https://docs.vertigisstudio.com/workflow/latest/help/auto-complete.html) to help you [create custom forms](tutorial-display-custom-form.mdx) to solve your business case. However, if VertiGIS Studio Workflow is missing a form element you need, you can implement a custom form element with the VertiGIS Studio Workflow SDK.

## Relevant SDK Samples

Expand Down
2 changes: 1 addition & 1 deletion docs/mobile/tutorial-run-workflow-app-config.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ The next step is going to be replacing the `ui.display-notification` command wit
</a>{" "}
that displays an alert and then{" "}
<a
href="https://docs.vertigisstudio.com/workflow/latest/help/Default.htm#wf5/help/import-export-workflows.htm"
href="https://docs.vertigisstudio.com/workflow/latest/help/import-export-workflows.html"
target="_blank"
>
import it into the VertiGIS Studio Workflow Designer.
Expand Down
2 changes: 1 addition & 1 deletion docs/web/configuration-theme.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ VertiGIS Studio Web's appearance is built around two concepts: theme and [layout

### Seeding a New Theme from an Existing Theme

Two predefined themes are included with VertiGIS Studio Web, `light` and `dark`. You can select a predefined theme and accent color with [VertiGIS Studio Web Designer](https://docs.vertigisstudio.com/webviewer/latest/admin-help/Default.htm#gwv/component-settings.htm#branding-settings%3FTocPath%3DConfiguration%7CComponent%2520Settings%7C_____4).
Two predefined themes are included with VertiGIS Studio Web, `light` and `dark`. You can select a predefined theme and accent color with [VertiGIS Studio Web Designer](https://docs.vertigisstudio.com/webviewer/latest/admin-help/Default.htm#gwv/component-settings.htm#branding-settings).

The `branding` service is responsible for the theming of the application. To select a theme and accent color from within the config, you can configure the branding service. The `template` property is used to specify the base theme to seed colors from.

Expand Down
2 changes: 1 addition & 1 deletion docs/web/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Before investing in developing workflows or custom code, see if your use case ca

<!-- TODO - does VertiGIS Studio Workflow come bundled with VertiGIS Studio Web? -->

[**VertiGIS Studio Workflow**](https://docs.vertigisstudio.com/workflow/) is a powerful tool that comes bundled with VertiGIS Studio Web which can create custom behavior and UI without custom code development. Many behaviors in VertiGIS Studio Web can be [replaced by a workflow](tutorial-change-default-map-click-behavior.mdx) that runs entirely custom logic. VertiGIS Studio Workflow can even [display complex customized forms](https://docs.vertigisstudio.com/workflow/latest/help/Default.htm#wf5/help/forms.htm).
[**VertiGIS Studio Workflow**](https://docs.vertigisstudio.com/workflow/) is a powerful tool that comes bundled with VertiGIS Studio Web which can create custom behavior and UI without custom code development. Many behaviors in VertiGIS Studio Web can be [replaced by a workflow](tutorial-change-default-map-click-behavior.mdx) that runs entirely custom logic. VertiGIS Studio Workflow can even [display complex customized forms](https://docs.vertigisstudio.com/workflow/latest/help/forms.html).

### Custom Workflow Activities and Form Elements

Expand Down
2 changes: 1 addition & 1 deletion docs/web/sdk-deployment.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@ Your app is now ready to use your library. If your library registers any custom

### Deploy the app

After you've uploaded your custom library to your application, you can push the application through the configured deployment stages using the [deployment pipeline in the Designer](https://docs.vertigisstudio.com/webviewer/latest/admin-help/Default.htm#gwv/deploy-an-app.htm%3FTocPath%3DApps%7CDeploy%2520an%2520App%7C_____0). Your library code will be copied through the deployment stages, so you can be confident that changes to your library code in the development stage won't affect your production app until you explicitly deploy to the production stage.
After you've uploaded your custom library to your application, you can push the application through the configured deployment stages using the [deployment pipeline in the Designer](https://docs.vertigisstudio.com/webviewer/latest/admin-help/Default.htm#gwv/deploy-an-app.htm). Your library code will be copied through the deployment stages, so you can be confident that changes to your library code in the development stage won't affect your production app until you explicitly deploy to the production stage.
Loading

0 comments on commit 9787a9a

Please sign in to comment.