ARS Database Integration

Stored procedures within ARS pull specified data from the Essential database, de-normalize that data, and transfer it into ARS. Once data is pulled into ARS, a variety of report generation tools can be used to report on the information. The Essential-to-ARS integration process is initiated and monitored in Essential. The process can be initiated on-demand and/or scheduled to run at various time intervals. Use the Advanced Report Solution form to run the integration process on-demand for:

• One or more entities

• A particular date range

• All data or just specific data, such as all entity information or just entity identifiers and/or enterprise entity types. A separate section is displayed for each module that is a part of your Essential implementation, along with a section for data common to all modules.

Establish a schedule to update ARS with Essential data at a specific time intervals on the ARS Schedule form. Once a schedule has been established, the job it represents can be run on-demand at any time. The ARS Supervisor Console is available for integration administration and can be used with the Job Log to review run statuses and error conditions for scheduled integration jobs that fail, so the appropriate corrections can be made.

Whether the integration process is run on-demand or according to a schedule, the amount of time to complete the integration process depends on several factors:

• Production environment (Server speed, memory, etc.)

• Amount of data

• Number of modules for which integration is being performed

• Data density

Note:  In the Air module, the Generate Calculation Details Log option on the Calculate Emissions form must be selected to populate intermediate calculation values (i.e., the value for each equation variable and equation expression) in the calculation results table (WH_EMIS_CALC_VALUE).

For instruction on ARS database integration, click the following links or use the scroll bar to scan the page.

On-Demand Integration

Use the Advanced Report Solution form to run the Essential-to-ARS database integration process on-demand for:

• One or more entities

• A particular date range

• All data or specific data, such as all entity information or just entity identifiers and/or enterprise entity types. A separate section is displayed for each module that is a part of your Essential implementation, along with a section for data common to all modules.

Note:  To help prevent duplicates or bad data, Emissions data is aggregated by calendar month based on the start and end dates entered. For example, if the start date is 8/15/2014 and the end date is 9/14/2014, all emissions data for the full month of August and September will be included in the integration process. An informational message is displayed when applicable. Emissions data applies to the Air and FEMS modules.

To initiate the on-demand integration process

Tip:  Existing scheduled integration jobs can also be run on demand. Refer to Scheduling Integration Jobs for additional information.

1. Click Tools > ARS > ARS-On Demand in the Navigation Tree to open the Advanced Reporting Solution form.

2. Click the All Entities check box or select an Enterprise Entity from the list. When selecting a specific entity, click the Include child data check box to add data from the entity's children.

3. Enter a date range for the data being collected in the Start Date and End Date fields. Calendar buttons are available to select the dates.

4. Use the following guidelines to specify the data to be integrated:

1. • Expand the appropriate section and click the check box for the specific data to include in the integration process.

   • Use one of the All buttons to select all of the options for a data type represented by the button label. For example, click All Enterprise Entity Info in the Common section to select the entity-related options at one time (Enterprise Entity, Entity Types, and Entity Identifiers).

   • Click the All Integration button in the Process Selection section to select all options in all sections.

   • Use the Clear All button in the Process Selection section to remove all selections made in all sections.

5. Click the On Demand button in the Process Selection section.
   
   When the Emissions option has been selected, an informational message is displayed as a reminder that emissions data is aggregated by calendar month. Click OK to continue. Emissions data applies to the Air and FEMS modules.

6. Review the status of the run in the Process Selection section.

Scheduling Integration Jobs

Use the ARS Schedule form to establish a schedule that specifies when the integration process runs for an entity. A schedule can be set up to collect and integrate data from all modules or a specific module. The particular hour and minute can be defined as well as the start and stop dates for the schedule.

Enter a number in the Month Value field that represents the number of previous months' data to include in the integration process, e.g., 1 to integrate the previous month's data, 2 to integrate the previous two months of data, etc. Zero (0) is a valid entry.

Email messages that provide integration process run results are sent to the specified owner of the scheduled job. Enter the owner's email address or select the owner from the list of contacts. The email address on the contact and personnel record will be used when a selection is made. A group email address can also be specified. Enter an email address for the group or select the group from the list of contact and personnel teams. The email address entered on the Contact and Personnel Teams form for the group will be used when a selection is made.

Tip:  Once a schedule has been established, the job it represents can be run on-demand at any time. See To run a scheduled job on demand for instructions.

To schedule integration jobs

Tip:  There is just one ARS component, ARSScheduleTaskBO, so the Component Name field is automatically populated when the schedule type is selected or the schedule is saved.

1. Click Tools > ARS > ARS-Supervisor Console in the Navigation Tree.
   
   The ARS Supervisor Console browse view is displayed.

2. Click the New button to open the Schedule form.

3. Click the All Entities check box or select an Enterprise Entity from the list. When selecting a specific entity, click the Include child data check box to add data from the entity's children.

4. Enter a number in the Month Value field that represents the number of previous months' data to include in the integration process, e.g., 1 to integrate the previous month's data, 2 to integrate the previous two months of data, etc. Zero (0) is a valid entry.

5. Click the All Modules check box or select a Module Name from the list.
   
   Select the Common option to schedule an integration job for the data elements referenced in the Common section on the Advanced Reporting Solution form used for on-demand jobs that are not scheduled.

6. Enter the email address of the individual who is to receive integration process run result notifications for the schedule in the Owner Email field. Or, click the Select From List check box and select the owner from the list.

7. Enter the email address of the group to receive integration process run result notifications in the Group Email field. Or, click the Select From List check box and select the group from the list.
   
   The Component Status field is displayed below the email-related fields.

8. Enter a name for the schedule in the Schedule Description field.
   
   The schedule description is a link to the ARS Schedule form on the ARS Supervisor Console.

9. Select the Schedule Type from the list.
   
   Based on the schedule type selected, any required scheduling options are automatically displayed.

10. Use the following guidelines to complete the run schedule:

1. • Enter a Start Date and time.

   • Click the No End Date check box or enter an End Date and time.

   • Select all applicable Days of the week for daily-related schedule types.

   • Select a Schedule Time from the list.

   • Enter a numerical value that represents the interval between runs in the Run Every field.

A schedule example for the Hourly type might be on Monday, Tuesday, Wednesday, Thursday, and Friday (Days), at 15 minutes after the hour (Schedule Time), every 8 hours (Run Every), beginning November 1, 2014 at 8:00 a.m (Start Date). The process would run at 8:15 a.m., 4:15 p.m., and 12:15 a.m. Monday through Friday starting November 1.

11. Click the Save button.

12. Repeat steps 2 through 11 to set up another schedule.
    
    Tip:  You can monitor job progress and results using the ARS Supervisor Console and Job Log.

To run a scheduled job on demand

1. Click Tools > ARS > ARS-Supervisor Console in the Navigation Tree.
   
   The ARS Supervisor Console browse view is displayed.

2. Locate the schedule and click the Schedule Description link to open the ARS Schedule form.

3. Review the Component Status field. If the status is Error, click the Reset button; an on-demand job will not run for a schedule with an Error status.

4. Click the  Run on Demand? check box and click Save.

5. Monitor job progress and results using the ARS Supervisor Console and Job Log.

Monitoring Integration Jobs

View the status of the run, when the last run took place, and the date of the next scheduled run, along with schedule details, on the ARS Supervisor Console. Field descriptions are provided below.

The ARS Supervisor Console should be reviewed on a regular basis to validate integration operations. Use the information provided and the Job Log to resolve all error conditions. A Reset button is displayed below the Component Status field on the ARS Schedule form when an Error status applies to a scheduled job run. After error resolution, click this Reset button to change the status to Idle. The next scheduled job, as well as any on-demand jobs, will not run when the status is Error. You can run a scheduled job on demand to validate that all errors have been cleared.

Click Tools > ARS > ARS-Supervisor Console in the Navigation Tree to access the ARS Supervisor Console.

Job Log

An entry is added to the Job Log on the ARS Schedule form for each scheduled ARS integration job request. The start and finish date/time, the run status, and the results are provided for each log entry. Jobs are processed according to a pre-configured priority in a managed, queue-based environment to minimize system contention. Use the Job Log to determine your job's position among all the jobs scheduled to run and to determine the current/final run status. The Refresh link can be used at any time to update the log. For notification purposes, a Loading... message appears during the refresh process.

When a job fails, error details can be found in the Job Log. Promptly review and resolve the error conditions. Entries can be deleted from the Job Log when no longer needed for error resolution on the Purge APE Log form.