Skip to main content

Key Concepts

Have you explored the VertiGIS Studio Report Designer?

The VertiGIS Studio Report Designer has an extensive suite of tools for laying out reports, specifying the data that you want to include, and presenting the data using charts, tables, and other configurable elements.

Reports​

A report is a formatted presentation of a particular type of information. VertiGIS Studio Reporting specializes in presenting data and images related to web maps.

Reports are designed by report authors (administrators) using a web-based tool called VertiGIS Studio Report Designer. They are saved to the VertiGIS Studio Reporting service, along with an item in the content area of the author's ArcGIS account. To allow users to run a report, the author shares the ArcGIS item with them. End users use the reports designed by the author to create on-demand, print-ready reports about maps and their features.

End users run reports from web applications that the author has configured to host the reports (host applications). Alternatively, a report can be run using the VertiGIS Studio Reporting REST API. The output report is a PDF.

VertiGIS Studio Report Designer​

VertiGIS Studio Report Designer provides an extensive suite of tools for laying out reports, specifying the data that you want to include, and presenting the data using charts, tables, and a wide variety of other configurable elements. Organizations can sign into the cloud-hosted report designer, or they can host it themselves on their own web server. They can then author as many report templates as their application requirements demand and save them into ArcGIS Online or Portal for ArcGIS as items. Sharing reports with end users allows them to create on-demand, print-ready PDF reports about maps and features, using data from the user's current session.

Report Designer has a built-in preview environment for running reports. Using the preview is the quickest way to test a report while you are designing it.

VertiGIS Studio Reporting Service​

The VertiGIS Studio Reporting REST API can be used to asynchronously run a report, watch for report completion and download the completed report as a PDF.

note

Prior to running a report, you must create a new report template using VertiGIS Studio Report Designer.

The basic steps for running a report are:

  1. Obtain a run token from the /auth/token/run endpoint.

    • Only required if the report is secured or accesses secured content

  2. Run the report with a request to /job/run.

    • The request body requires a template object which consists of a portalUrl and itemid. An optional array of parameters may also be passed to the report.
    {
        "template": {
            "itemid": "5a810f3ac13454d6bfd2ac22ed0cc4b7",
            "portalUrl": "https://arcgis.com"
        },
        "parameters": [
            {
                "name": "Title",
                "containsMultipleValues": false,
                "value": "This is a title"
            },
            {
                "name": "featureIds",
                "containsMultipleValues": true,
                "values": [1, 2, 3]
            }
        ]
    }
    • Optional: Include an Authorization header with the token acquired in step 1
    Authorization: Bearer eyJhbGciOiJzI1123sImtpZCI6IiMTc2NDQ5Y2ZkMTQwNTJiNlODA1YTlhMzV...

  3. Use the ticket received in response to the run request to watch for completion of the report via a websocket or polling strategy at /job/artifacts.

  4. Use the ticket from the run request and the tag from the artifacts request (step 3) to download the completed report from /job/result.