Manage an On-Premises Installation

This topic discusses changes that you can make to an existing on-premises installation. If you have not yet installed VertiGIS Studio Workflow and configured the post-installation settings, follow the instructions in Install VertiGIS Studio Workflow on Premises

Managing an on-premises installation may require periodically updating the software or changing the post-installation configuration:

See also...

Move Workflows from One Portal to Another

Update On-Premises Workflow

VertiGIS periodically releases updates to on-premises Workflow that include new features and other improvements to the software. To update Workflow, run the new installer.

To update an on-premises installation of VertiGIS Studio Workflow:

  1. Download the installer.

  2. Run the installer.

    The installer detects your existing installation and prompts you to update.

  3. Click Update.

  4. When the update completes, click Finish.

    The Post-Installation Configuration launches.

  5. Click through the Post Installer to upgrade any dependencies.

    You should click through the Post Installer even if there are no changes to be made.

Manage the Post-Installation Configuration

Managing an on-premises Workflow installation may require changing the post-installation configuration:

Open the Post Installer

To open the VertiGIS Studio Workflow Post Installer:

  1. In the Windows Start menu, start to type VertiGIS Studio Workflow.

    The Start menu will show the Post Installer application.

  2. Click VertiGIS Studio Workflow Post Installer.

Activate Additional Licenses

To activate additional licenses that you have purchased:

  1. Open the Post Installer and click Licensing in the sidebar.

  2. Follow the steps for one of the following options:

    • Activate Online: To activate VertiGIS Studio Workflow online, you must have a VertiGIS Studio account.

      1. Click Activate Online.

      2. Sign in to your VertiGIS Studio account.

        Activation will complete automatically.

      or

    • Activate Offline: To activate VertiGIS Studio Workflow offline,

      1. Contact Customer Service at customerservice-ca@vertigis.com to request an activation key.

        While you wait for your key, you can use the trial license, as long as it has not expired.

      2. When you receive the key:

        1. Open the Post Installer.

        2. Click Licensing to open the Licensing panel.

        3. Paste the key into the Offline Activation Key box.

        4. Click Activate.

        5. Click Close to close the Post Installer.

  3. Click OK to close the License Status dialog box.

  4. Close the Post Installer when you are finished.

Move the Data Directory

We recommend that you choose a permanent location for the data directory one time only, immediately after you install VertiGIS Studio Workflow.

The following procedure ensures you do not lose access to your existing workflows if you change the data directory's location. Some possible locations for the data directory are given here.

To move the data directory after you have used VertiGIS Studio Workflow:

  1. Stop the application pool to take Workflow Server offline.

    This prevents data changes while you move the data directory.

  2. Copy the data directory to the new location.

  3. Give the application pool identity write permission in IIS.

    The default identity is IIS AppPool\VertiGISStudioWorkflow.

  4. In the Post Installer, change the data directory to the new location.

  5. Close the Post Installer.

  6. Restart the application pool.

  7. Delete the old data directory.

Change the IIS Deployment

You can change the location where VertiGIS Studio Workflow is deployed.

  1. Open the Post Installer and click IIS Settings in the sidebar.

  2. To use a different website, select the website from the Website drop-down list.

  3. To use a different virtual directory, type the path in the Virtual Directory box.

  4. Click Portal in the sidebar.

  5. Update the Redirect URL to reflect the new IIS deployment.

    You may have to update the redirect URI of the Application item in Portal for ArcGIS as well.

  6. Click Close to close the Post Installer when you are finished.

Change the ArcGIS Registration

You can change how VertiGIS Studio Workflow is registered with ArcGIS.

  1. Open the Post Installer and click Portal in the sidebar.

  2. If you are changing to a different portal type, select the type of portal you use from the Portal Type drop-down list—ArcGIS Online or Portal for ArcGIS.

  3. If you changed the Portal Type, follow the instructions for the Portal Type you selected:

    • ArcGIS Online: In the Organization box, enter your ArcGIS organization name, for example myorganization, or the URL of your ArcGIS Online portal, for example, https://myorganization.maps.arcgis.com.

    • Portal for ArcGIS: In the Portal URL box, enter the URL for your portal, for example, https://portal.domain1.com/arcgis/.

  4. In the Redirect URL area:

    1. Make sure https:// is selected.

    2. Select the host name of your Workflow server from the drop-down list.

      Alternatively, type or paste the host name.

    3. Click Copy to copy the redirect URL to your clipboard for use in a later step.

    The virtual path is entered automatically based on the IIS Settings.

  5. Follow the instructions that apply to you:

    Register VertiGIS Studio Workflow Using an Existing ArcGIS Item

    1. Click Launch to open the portal in your browser.

    2. View the item's details.

    3. On the Settings tab, scroll down to the App Registration area and click Update.

    4. Paste the copied redirect URL into the Redirect URI box, and then click Add.

      The URL is added to the list of permitted redirect URLs.

    5. Click Update.

    6. Copy the App ID from the App Registration area to the clipboard.

    7. On the Overview tab, edit Tags and add one or more tags for VertiGIS Studio Workflow.

    8. Return to the Post Installer to enter the app ID.

    Register VertiGIS Studio Workflow Using a New ArcGIS Item

    There are two steps:

    Step 1: Create the item

    1. Sign in to your portal and open the Content page.

    2. In My Content, click Add Item and select An application.

    3. Configure the application using the following settings, and then click Add Item.

      • Type: Web Mapping

      • Purpose: Ready to Use

      • API: JavaScript

      • URL: Paste the redirect URL that you copied in the previous step.

        For example: https://apps.domain2.com/vertigisstudio/Workflow/designer

      • Title: For example: VertiGIS Studio Workflow

      • Tags: For example: VertiGIS Studio and Workflow

        You may want to add additional tags used by your organization.

      A new application is added to the portal.

    Step 2: Use the item to register VertiGIS Studio Workflow with the portal

    1. On the Settings tab, scroll down to the App Registration area.

    2. Click Register beside App Registration.

    3. Paste the copied redirect URL into the Redirect URI box, and then click Add.

      The URL is added to the list of permitted redirect URLs.

    4. Click Register to complete the application registration.

    5. Copy the app ID to the clipboard.

  6. Enter the App ID: In the Post Installer, paste the app ID into the App ID box.

  7. Click Test to test the application registration.

    The Post Installer will either show a success message or prompt you to fix any errors.

    If Portal for ArcGIS is secured using Windows Integrated Security and anonymous access to the portal is disabled in IIS, the Post Installer will present a warning that says: "The portal application registration is valid—however the specified portal requires authentication". You must install the VertiGIS Studio Web Adaptor Extensions to allow VertiGIS Studio Workflow to communicate with Portal for ArcGIS.

  8. Close the Post Installer when you are finished.

Manage the Service Account

The first time you run the Post Installer, it creates a local user account called IIS AppPool\VertiGISStudioWorkflow that VertiGIS Studio Workflow uses in its back-end operations. This account is required for running workflows.

You can modify the account in IIS, in case you need to:

The account can be a local user or a domain user, but not a machine account.