ArcGIS Help 10.2 - Exercise 3: Setting up the Reviewer service (Production Mapping)

Complexity: Beginner Data Requirement: ArcGIS Tutorial Data for Desktop Data Path: C:\ArcGIS\ArcTutor\DataReviewer Goal: To configure the Data Reviewer service and view batch job results

The Data Reviewer service is a Windows service that can be scheduled to run Reviewer batch jobs. Similar to running a batch job using the Reviewer Batch Validate tool, the Reviewer service validates and runs batch jobs and writes the results to the Reviewer table in a specified Reviewer session. Batch jobs can be scheduled to run once at a specific date and time or to run repeatedly at regular intervals.

Exercise 3a: Installing the Reviewer service

The Data Reviewer service can be installed after the ArcGIS Data Reviewer for Desktop software is installed. The postinstallation wizard guides you through the process of installing and configuring the Data Reviewer service.

Note:

Running the Data Reviewer service postinstallation requires that you have administrative permissions.

Steps:

In Windows, click Start > All Programs > ArcGIS > ArcGIS Data Reviewer for Desktop > DRD Service Post Installation <release>.
Note:
If you are running Windows 7, the postinstallation must be run by an administrator. To do this, right-click DRD Service Post Installation <release> and click Run as administrator.
The Welcome To Reviewer Service Post Installation dialog box appears.
Click Next.
The Reviewer Service Folder dialog box appears.
Click the Browse For Folder Location button next to the Select Folder text box.
The Browse For Folder dialog box appears.
Navigate to the Reviewer directory where you have copied the tutorial data on the local machine.
Click OK.
The path to the directory appears in the Select Folder text box.
Click Next.
The Install Options dialog box appears.
Check the Launch Service Controller after Post Installation is complete check box.
Click Next.
The Reviewer Service Post Install Summary dialog box appears.
Click Install.
Once the installation is complete, the Post Installation Complete dialog box appears. Ensure that all the items in the Results dialog box were successful.
Click Finished.

The installation process is complete, and the Data Reviewer Service Controller icon appears in the system tray.

Three new subdirectories, named config, jobs, and logs, are created in the Reviewer Service folder.

Exercise 3b: Setting up files for the service

Before configuring the service, you need to ensure that the Reviewer session you want to write the results to exists and that the batch job is referencing the data you want to validate.

Steps:

Start ArcMap if it is not already open.
Click the Reviewer Session Manager button on the Data Reviewer toolbar.

The Reviewer Session Manager dialog box appears.
Make sure that Reviewer.gdb is set as the Reviewer workspace.
The Reviewer.gdb is located in the Reviewer directory where the sample data has been copied.
Click New next to the ID drop-down list.
Type Exercise 3 in the Name text box.
Click Close.
The Reviewer Session Manager dialog box closes, and the Reviewer tools use the current session when writing to the Reviewer table.

Note:

If you have completed Exercise 2, you may close ArcMap and proceed to Exercise 3c: Creating a new service job. If not, please complete Exercises 2a–2c before proceeding with Exercise 3c.

Exercise 3c: Creating a new service job

The first step in configuring the Reviewer service to run automatically is to create a new service job. The service job allows you to specify the batch jobs to run and the Reviewer workspace where session errors will be written to.

Steps:

If the Data Reviewer Service Controller icon does not appear in the system tray, click Start > All Programs > ArcGIS > ArcGIS Data Reviewer for Desktop > DRD Service Controller <release>.
The Data Reviewer Service Controller icon appears in the system tray.
Right-click the Data Reviewer Service Controller icon and click Configure Service Jobs.
If the Unable to Read Service Configuration message appears, click OK to close it.
The Configure New Service Job dialog box appears.
Click the ellipsis (...) next to the Workspace text box.
The Select a workspace containing sessions dialog box appears.
Navigate to the Reviewer.gdb file and click Add.
The Reviewer.gdb file is in the Reviewer directory where you copied the sample data.
The Session drop-down list is populated with a list of sessions from the Reviewer workspace.
Click the Session drop-down arrow and choose Exercise 3.
Click Add From File in the Batch Jobs area of the Configure New Service Job dialog box.
The Select a Batch Job dialog box appears.
Navigate to the batch job created in Exercise 2 and click Open.
The Batch Jobs area is populated with checks in the batch job.

The next step in configuring the service is choosing when you want the service to run. A Reviewer service job can be scheduled to run at a specific interval or only once at a specified time. The service job can be run daily, weekly, or monthly based on the starting date and time you choose.

At the end of this section, you will save the service job configuration.

Click the Schedule tab on the Configure New Service Job dialog box.
If necessary, choose the Set Start Time to Now option in the Start Date & Time area.
Ensure that the Set Interval check box is checked.
Choose the Other Interval option in the Execution area.
Click the Other Interval drop-down arrow and choose Weekly.
By setting these parameters for the schedule, the batch job will validate the data as soon as the service is started and will continue to validate the data every week after that.
Click File > Save.
The Save Service Job dialog box appears.
Navigate to the Jobs directory in the Reviewer Service folder ($\Reviewer\jobs).
Type a value in the File Name text box such as ServiceJob.
Click Save.
Click the Close button in the upper-right corner of the Configure Service Jobs dialog box.
The Configure Service Jobs dialog box closes.

Exercise 3d: Configuring the service

Multiple service jobs may exist; however, the Reviewer service can only be configured to run one at a time. The service configuration file is used to tell the Reviewer service which service job to run and where to write the log files.

At the end of this section, you will save the service configuration.

Steps:

Right-click the Data Reviewer Service Controller icon and click Configure Service.
If the Unable to Read Service Configuration message appears, click OK to close it.
The Service Configuration dialog box appears.
Check the Make Default Configuration check box.
Click the ellipsis (...) next to the Service Job text box.
The Select a Service Job dialog box appears.
Navigate to the Jobs directory in the Reviewer service folder ($\Reviewer\jobs) and select the service job configuration file you saved in the Setting up an interval for the service section of Exercise 3c.
Click Open.
The path to the service job appears.
Click the ellipsis (...) next to the Engine Log Folder text box.
The Browse For Folder dialog box appears.
Navigate to and select the Logs directory in the Reviewer service folder.
This directory can be found in the $\Reviewer\logs folder.
Click OK.
The path to the Logs directory appears in the Engine Log Folder text box.
Repeat steps 6–8 for the Service Log Folder.
The path to the Logs directory appears in the Service Log Folder text box.
Click File > Save.
The Save Configuration File dialog box appears.
Navigate to the Config directory in the Reviewer Service folder.
Select the revserviceconfig.xml file.
Click Save.
The Save Configuration File message appears.
Click Yes to replace the file.
Click the Close button in the upper-right corner of the Service Configuration dialog box.
The Service Configuration dialog box closes.

Exercise 3e: Starting the service

Now that you have configured the Reviewer service, all you need to do is start the service. Since the service job was set to start now, the Reviewer service will begin validating the data as soon as the service is started.

Steps:

Right-click the Data Reviewer Service Controller icon and click Manage Service.
The Reviewer Service Controller dialog box appears.
Click the Start the Service button .
The status of RevService changes to Running.
A message appears at the bottom of the Reviewer Service Control dialog box indicating the service has started running the batch job.
Click the Close button in the upper-right corner of the Reviewer Service Control dialog box.
The Reviewer Service Control dialog box closes.

Exercise 3f: Viewing results from the service job

It may take the service a few minutes to run the batch job. The batch job includes a number of checks and is being run against data for the entire state of California.

When the service has finished executing the batch job, you can view the results in two ways:

You can look at the log file to determine if there were any configuration issues with the Reviewer service setup, such as checks that could not be run.
You can also look at any errors that were recorded to the Reviewer session.

Steps:

Right-click the Data Reviewer Service Controller icon and click Show Status.
The Status dialog box appears.
When the batch job is finished, which may take a few minutes, a row appears in the Service Job Status File table. This indicates that the service has run once. Additional rows are appended when the service runs again.
Click Show next to the Server Log File text box.
The log file opens.
The Summary Report section provides you with information about how many checks have been run, how many errors have been found, and how long it has taken to execute the batch job.
When you are finished reviewing the log file, close the browser.
Click the Close button in the upper-right corner of the Status dialog box.
The Status dialog box closes.
If necessary, start ArcMap.
Open the Reviewer.mxd file.
The Reviewer.mxd file is located in the Reviewer directory where the sample data has been copied.
Click the Reviewer Session Manager button on the Data Reviewer toolbar.

The Reviewer Session Manager dialog box appears.
Make sure that Reviewer.gdb is set as the Reviewer workspace.
The Reviewer.gdb is located in the Reviewer directory where the sample data has been copied.
Click the ID drop-down arrow and choose Session 3: Exercise 3.
Click Start Session.

The button name changes to End Session.
Click Close.
If the Reviewer Table window is not visible in ArcMap, click the Reviewer Table button on the Data Reviewer toolbar.
The Reviewer Table window appears.
Ensure that the Reviewer table is docked at the bottom of ArcMap and adjust the height so you can see some of the records.
Double-click a record.
The feature associated with the record is selected, and the map extent is zoomed to the extent of the feature.
Scroll the Reviewer table to the right to see the values for the record.
Notice that the ORIGINCHECK, PARAMETERS, REVIEWSTATUS, and NOTES fields are populated with information for the batch job checks that you have configured. The ObjectID of the feature appears in the OBJECTID field, and the name of the feature class appears in the ORIGINTABLE field. Also notice that the session user name appears in the REVIEWTECHNICIAN field.
If you scroll through the list of records, you can see that features have been found using both the Execute SQL and Geometry on Geometry checks.
Tip:
You can also click the ORIGINCHECK field and drag it to the top of the Reviewer table to group records by the check type.
When you are finished reviewing the records, close ArcMap.

In this exercise, you installed and configured the Data Reviewer service and reviewed the batch job results.

6/8/2015