Publishing the Generate Report tool to a service

To generate reports using Roadway Reporter, you must first publish the Generate Report tool as a geoprocessing service. To publish as a geoprocessing service, you must author a geoprocessing task using the Generate Report geoprocessing tool. Follow the instructions listed to deploy the Generate Report geoprocessing tool. For more information about geoprocessing services, see What is a geoprocessing service?

Note:

The Generate Report tool is part of the Roadway Reporter installation. Therefore, if ArcGIS for Desktop and Roadway Reporter Web server are present on separate machines, you need to copy the entire Tools folder from the Roadway Reporter machine to the ArcGIS for Desktop machine to publish the tool.

1. In ArcCatalog, create a folder connection to the Roadway Reporter tools folder.

   The Tools folder is located in the Roadway Reporter web folder, which can be found in <Installation location>\ArcGIS\EsriRoadsandHighways\Server\10.3\Web\RoadwayReporter.

2. Open the *.mxd file that you created in step 2 of the deployment.

   See Deployment for Roadway Reporter. This map contains all the Network, events, and intersection layers that you need for reporting.

3. Double-click the Generate Report tool.

   

4. Click the Browse button next to LRS Workspace and browse to the workspace.

   The enterprise geodatabase file contains the reporting data.

   

   Running the Generate Report tool

5. Click the Network Layer drop-down arrow and choose at least one network layer in the ALRS for which you plan to create a report.
6. Click the Event Layers drop-down arrow and choose at least one event layer in the ALRS for which you plan to create a report.
7. Specify the output format.

   By default, the output will be saved as a PDF. The other option is CSV format. This configuration can be changed once the service is deployed to Roadway Reporter.

8. Specify the name and location of the output file.

   The name assigned to the output will be the default name of the report generated through the Roadway Reporter web app.

9. Click OK.
10. Browse to the geoprocessing Results window to publish the service once you have successfully run the Generate Report geoprocessing tool.
11. Right-click the results for Generate Report and click Share As > Geoprocessing Service.

    

    For more information about publishing a geoprocessing service, see A quick tour of publishing a geoprocessing service.

12. Click the Parameters pane.
13. Under Properties, set the Message Level to Info.

    This ensures that all tool warnings and errors are returned.

    

14. Click the Pooling pane.
15. Specify the number of instances per machine to optimize performance.

    

    • Minimum number of instances per machine—Minimum number of simultaneous active users allowed.
    • Maximum number of instances per machine—Maximum number of simultaneous active users allowed.
16. Specify the Generate Report timeout service values to keep your service working and available.
    • The maximum time a client can use a service—Specifies usage time, which is the amount of time between when a client receives a reference to a service and when it releases it. By default, this value is set to 600 seconds (10 minutes).
    • The maximum time a client will wait to get a service—Specifies the wait time, which is the amount of time it takes between a client requesting a service and receiving a service before timeout. By default, this value is set to 60 seconds (1 minute).
    • The maximum time an idle instance can be kept running—Specifies the amount of time the service will continue to run on the server until the running service timeout. By default, this value is set to 1800 seconds (30 minutes).

      Note:

      This value should be set to the amount of time required to generate your largest report. If the amount of time it takes to generate the report exceeds this value, the Generate Report service will timeout before the report is generated.

17. Click Analyze to view any errors or messages.
    • The following warning is returned: Data source used by Script Generate Report is not registered with the server and will be copied to the server. Ignore this Generate Report script warning.
    • Fix any other errors or warnings.

18. Click Publish.

    The Copying Data to Server dialog box appears.

    

19. Click OK.

    The Generate Report script is copied to the server.

    The Generate Report geoprocessing service is published to ArcGIS for Server.

External Events

In case you have external events present in the *.mxd file, then use the following steps in addition to step 2 above:

1. Note down the name of the external event from the Table Of Contents (TOC) in the mxd.
2. Remove the external event from the TOC.
3. Add the external event table to the mxd from its original location.
4. Make sure that the external event table is named exactly same as the one you noted down in step 1.
5. Follow the same procedure for all the external events present in the mxd.
6. Save the mxd with a different name.