Install VertiGIS Studio Reporting on Premises

The instructions given below step you through the installation of VertiGIS Studio Reporting, including component installation, post-installation configuration, and registering the application with ArcGIS. When you have completed these steps, you will have a working installation of VertiGIS Studio Reporting.

Before you begin, download a copy of the installation package.

For information about system requirements, see Requirements for On-Premises Reporting.

Main Steps to Install VertiGIS Studio Reporting

The main steps to install VertiGIS Studio Reporting on premises are as follows:

  1. Install VertiGIS Studio Reporting.

  2. Configure post-installation settings.

Install VertiGIS Studio Reporting

To install VertiGIS Studio Reporting:

  1. Run the VertiGIS Studio Reporting installer.

  2. Click Next.

    The End-User License Agreement panel opens.

  3. Read the license agreement.

    To print a copy of the agreement for your records, click Print.

  4. If you agree to the terms of the license agreement and supporting documents, select the I accept the terms in the License Agreement checkbox, and then click Next.

    The Destination Folder panel opens.

  5. Select a location to install VertiGIS Studio Reporting, and then click Next.

    By default, VertiGIS Studio Reporting is installed in C:\Program Files\VertiGIS\VertiGIS Studio Reporting\.

    The Ready to Install panel opens.

  6. Click Install and wait for the installation to complete.

    The Completed panel opens.

  7. Make sure the Launch VertiGIS Studio Reporting Post Installer checkbox is selected and click Finish.

    VertiGIS Studio Reporting Post Installer

  8. Follow the steps in Configure Post-Installation Settings.

Configure Post-Installation Settings

The VertiGIS Studio Reporting Post Installer is used to configure on-premises deployments of VertiGIS Studio Reporting. You must configure the post-installation settings before you can run your on-premises installation of VertiGIS Studio Reporting.

The Post Installer creates a local user called GeocortexReporting that is required to run reports. You can change to a different local user or to a domain user. For information, see Manage the Service Account.

By default, when you install VertiGIS Studio Reporting on premises, the Post Installer opens after the installer completes. This allows you to do the required post-installation configuration right away. You can run the Post Installer at any time later to modify your configuration. See Manage an On-Premises Installation.

The Post Installer allows you to do the following:

To configure post-installation settings:

The first time you run the Post Installer after installing VertiGIS Studio Reporting, you must visit every panel in order and click Next to apply the panel's settings. If you navigate away from a panel by clicking a link in the sidebar, the configuration for that panel will not be applied, not even the default configuration.

Licensing

VertiGIS Studio Reporting is licensed software. Use the Licensing panel to activate the product.

  1. Open the Licensing panel.

    Licensing panel

  2. When prompted for a license key, you have two options:

    • Activate Offline: Contact Customer Service for an activation key.

    • Activate Online: Sign in to your ArcGIS Online organization associated with your VertiGIS Studio Reporting license. If your organization already has a license, activation completes automatically. If your organization does not have a license, you are asked if you would like to submit a request for a trial license.

      • VertiGIS Studio Reporting comes with a 60-day trial license. To continue using VertiGIS Studio Reporting after the trial period, the product must be activated with a valid license.

    3. After the product key is activated, the status changes to show that the product is Licensed and the SKUs for this product display.

Data

The Data panel allows you to specify the folder for storing files related to your VertiGIS Studio Reporting installation, such as configuration files and reports. This allows you to organize your files on a different drive or network location, to suit your environment.

The default data directory is C:\ProgramData\Geocortex\Reporting. Some possible custom locations are as follows:

If you use a custom location, you must give the application pool identity write permission. The default identity is IIS AppPool\VertiGISStudioReporting.

If you choose a location on another machine, you will have to change the application pool identity that VertiGIS Studio Reporting uses to one that can access both the Reporting server and data server, like a service account on your domain.

To move the data directory after you have used VertiGIS Studio Reporting, follow these steps to ensure you don't lose access to your existing reports:

  1. Stop the application pool to take the Reporting service offline.

    This prevents data changes while you move the data directory.

  2. Copy the data directory to the new location.

  3. Ensure the application pool identity has write permissions to the new location.

    The default identity is IIS AppPool\VertiGISStudioReporting.

  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.

  1. Open the Data panel.

    Data panel

  2. Enter the path to the data directory. Alternatively, if the data directory is on the same machine as VertiGIS Studio Reporting, click Browse to browse to the data directory.

    Remember to give the application pool identity write permission to the new location.

IIS Settings

The IIS Settings panel allows you to manage how VertiGIS Studio Reporting is deployed in IIS.

  1. Open the IIS Settings panel.

    IIS Settings panel

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

    By default, VertiGIS Studio Reporting is deployed to IIS's Default Web Site.

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

    By default, VertiGIS Studio Reporting uses /vertigisstudio/reporting as the virtual directory.

Portal

In order to save and share reports, VertiGIS Studio Reporting must be registered with an ArcGIS portal, either your Portal for ArcGIS installation or ArcGIS Online. To register with a portal, you:

  1. Create an Application item and register the item to create an app ID and secret.

  2. You then configure the app ID in the Post Installer.

Follow this procedure to create and register a new application on your portal using OAuth 2.0 credentials.

Esri periodically updates the user interface for ArcGIS Online/Portal. The following steps are accurate as of this writing. Be aware that older versions of your Esri portal could be different.

To create an application in Portal:

  1. Sign in to your organization's Esri portal.
    • If your organization uses ArcGIS Online, the URL should look similar to this:

    https://MyCompany.maps.arcgis.com
    Note that this URL uses arcgis.com as its domain.

    • If your organization uses Portal for ArcGIS, the URL may look something like this:

    https://MyCompany.com/arcgis

    Note that this URL uses MyCompany.com as its domain.

  2. In the Content tab, click New Item > Developer Credentials to open the Create Developer Credentials window.

  3. Select OAuth 2.0 credentials and click Next.

  4. Add a Redirect URL (for example, https://myServer.myDomain.com/VertiGIS/Studio/Reporting/sign-in-handoff.html) and click Next.


  5. Select the privileges for your application and click Next.

  6. Review your selected privileges. Click Skip to continue without any restrictions.

  7. Add a title for your application and click Next. The title should help identify the application and its purpose so it is easy to find at a later date.


  8. Review your application settings and click Create.

    The application has been created and registered. You can copy the Client ID (App ID) from this page to configure your AppID in the Post Installer.

In different versions of Esri software, the terms App ID and Client ID, as well as App Secret and Client Secret, are used interchangeably.

You can leave the portal open in the browser so that you can copy and paste the Client ID, Client Secret, and the URL when you need them.

 

To configure your AppID in the Post Installer:

  1. Navigate to the Portal tab of the Post Installer .

  2. Select the Portal Type you are using.

  3. In the Organization field, do one of the following:
    •Portal for ArcGIS: Enter the URL to your portal instance (for example, https://host.domain.com/arcgis/).
    •ArcGIS Online: Enter your organization name (for example MyOrganization) or the URL of your ArcGIS Online portal (for example, https://myorganization.maps.arcgis.com).

  4. Paste the App ID (from the app you created in your portal) into the App ID field.

  5. In the Redirect URL section, select HTTPS and copy and paste the Redirect URL from the app you created in your Esri portal.


  6. Click Test to test the registration of your application.
    The Post Installer tests your registration and either shows a success message or prompts 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 Reporting to communicate with Portal for ArcGIS.

  7. Click Next.

  8. In the Summary tab, you can launch VertiGIS Studio Reporting or copy the Designer URL to the clipboard.

Summary

The Summary panel shows Report Designer's URL for you to distribute to report authors in your organization. The Summary panel also provides a link to launch Report Designer.

  1. Click Launch Report Designer or copy the URL under Designer URL for distribution to your team.

    Before other members of your organization can access Report Designer, you must share the application item that was created with your organization within your portal. For information, see Allow Authors to Modify Reports.

    Summary panel

  2. Click Close to exit the Post Installer.

    You have now completed the post-installation configuration and deployment of VertiGIS Studio Reporting.

Configuration Options

Configure a Geometry Server

Once VertiGIS Studio Reporting is installed, you can specify a geometry service URL by configuring the web.config file.

To add a geometry server to your installation:

  1. Open the web.config file.

    Use the following file path as a guide to locate your own web.config file: 

    C:\Program Files\VertiGIS\VertiGIS Studio Reporting\Deployment

  2. Within the <appSettings> tag, enter a new line, using the following as a guide: 

    <add key="app:geometryServiceUrl" value="<your geometry service url>"/>