Understand Enterprise Scheduler Service (ESS) Jobs

You can use Enterprise Scheduler Service (ESS) jobs to enable and schedule critical tasks.

What's an ESS Job?

Using enterprise scheduler service jobs, you can accomplish certain tasks. Use the following table to configure the parameters for enabling and scheduling these jobs.

Note:

Remember, a user with the ORA_ZBS_SALES_ADMINISTRATOR_JOB role can trigger the ESS jobs. When you don't use appropriate values or formats, the job fails. Check the log files for the error details.

You can run specific jobs for a select set of accounts, routes, and associated data by setting the Segment ID value. Jobs that support execution by segment include segment ID as a parameter in the following table. Segment commonly represents a business division or a sales market. Managing your data by segments can bring a lot of operational efficiency.

Note:

Don't use special characters in the segment value.

ESS Job Name	Job Description	Parameters Applicable
Prepare Consumer Goods Appointment Download Document	Prepares data containing details to service appointments for each route. This job consolidates appointments beginning from the time mentioned in parameter start time up to the duration mentioned in parameter duration window in hours.	Start Time: Indicates the planned time for setting the consolidation of the appointments with the preferred time format of YYYY-MM-DD. The start time is automatically set to the current time if not provided. Note: The start time must be provided in GMT. Duration Window in Hours: Indicates the period from the start time, for which the appointments are consolidated. The default is 24 hours. History Window in Months: Indicates the number of months, from the start time from which appointment-related historical data is downloaded. The default is three months. Processing Group: Indicates the name of the processing group which the route belongs to. Route Number: Indicates the route number for which the appointment data is being downloaded. Days to Keep: Indicates the number of days for which the upload and download documents are retained. Diagnostic Mode: Indicates if diagnostic mode is enabled or disabled. Enabling the diagnostic mode helps in collecting log and debugging as well. Maximum Sub Processes per Process: Indicates the maximum number of sub processes to be initiated to complete processing. Segment ID: Indicates the segment for which the data containing details to service appointments for each route must be prepared.
Prepare Consumer Goods Route Download Document	Prepares the mobile download data of route inventories for each route.	Processing Group: Indicates the name of the processing group which the route belongs to. Route Number: Indicates the route number for which the appointment data is being downloaded. Days to Keep: Indicates the number of days for which the upload and download documents are retained. Diagnostic Mode: Indicates if diagnostic mode is enabled or disabled. Enabling the diagnostic mode helps in collecting log and debugging as well. Maximum Sub Processes per Process: Indicates the maximum number of sub processes to be initiated to complete processing. Segment ID: Indicates the segment for which the mobile download data of route inventories for each route must be prepared.
Process Consumer Goods Route Upload and Prepare Upload Results Document	Processes the mobile upload data for each route and coverts it to the database records including order, route inventory transactions and payments.	Processing Group: Indicates the name of the processing group which the route belongs to. Route Number: Indicates the route number for which the appointment data is being downloaded.
Resolve Consumer Goods Order Status	Updates the status fields of order rollup and order line rollup. This happens after processing order requests from the mobile application and order request statuses from the order management application.
Purge Consumer Goods Direct Store Delivery Documents	Deletes the mobile upload and download data older than the time period specified in the parameter days to keep.	Processing Group: Indicates the name of the processing group which the route belongs to. Route Number: Indicates the route number for which the appointment data is being downloaded. Days to Keep: Indicates the number of days for which the upload and download documents are retained.
Generate Consumer Goods Shopping Cart Templates	Enables you to create or update shopping cart templates for each account.	Diagnostic Mode: Indicates if diagnostic mode is enabled or disabled. Enabling the diagnostic mode helps in collecting log and debugging as well. Maximum Sub Processes per Process: Indicates the maximum number of sub processes to be initiated to complete processing. Segment ID: Indicates the segment for which account shopping cart templates should be generated.
Create and Update Consumer Goods Order Rollup Records	Creates and updates the order rollup records from order requests created using the mobile application.	Diagnostic Mode: Indicates if diagnostic mode is enabled or disabled. Enabling the diagnostic mode helps in collecting log and debugging as well. Maximum Sub Processes per Process: Indicates the maximum number of sub processes to be initiated to complete processing.
Migrate Consumer Goods Data	Migrates corresponding consumer goods data based on the migration type specified.	Migration Type: Indicates the type of migration that must be initiated for the job.
Calculate Consumer Goods Promotion Cumulative Usage	Enables the calculation of consumer goods promotion cumulative usage	Diagnostic Mode: Indicates if diagnostic mode is enabled or disabled. Enabling the diagnostic mode helps in collecting log and debugging as well. Segment ID: Indicates the segment for which cumulative promotion usage should be calculated.
Prepare Consumer Goods Priority portfolio Attainment Calculation	Prepares the base data for priority portfolio attainment calculation.	Account Name: Indicates the name of the account for which the job must be run. Priority Portfolio Name: Indicates the name of the account for which the job must be run. Diagnostic Mode: Indicates if diagnostic mode is enabled or disabled. Enabling the diagnostic mode helps in collecting log and debugging as well. Maximum Sub Processes per Process: Indicates the maximum number of sub processes to be initiated to complete processing.
Inventory Audit History (AcoBulkProcessing)	Provides a snapshot of all inventories associated with an account and populates the data in audit history with account inventory values.	Attribute1 (Job Name): GenerateInventoryAudit Indicates the name of the job to be executed. Attribute2 (Diagnostic Mode): Indicates if diagnostic mode is enabled or disabled. Enabling the diagnostic mode helps in collecting log and debugging as well. Run the job with this value N Attribute3 (History Window in Days): Indicates the number of days for collecting the inventory data. The default value is last 24 hours. Attribute4 (Processing Group): Indicates the name of the processing group which the route belongs to. Segment ID: Indicates the segment for which the data in audit history with account inventory values should be populated.
Generate Compliance History	Provides the benefit settlement associated with the contract. Ensure you run this job after generating the compliance history and allocating the funds.	Maximum Sub Processes per Process: Indicates the maximum number of sub processes to be initiated to complete processing. Diagnostic Mode: Indicates if diagnostic mode is enabled or disabled. Enabling the diagnostic mode helps in collecting log and debugging as well. Run the job with this value N Segment ID: Indicates the segment for which contract benefit settlements should be generated.
Generate Benefit Settlement	Provides the benefit settlement associated with the contract. Ensure you run this job after generating the compliance history and allocating the funds.	Maximum Sub Processes per Process: Indicates the maximum number of sub processes to be initiated to complete processing. Diagnostic Mode: Indicates if diagnostic mode is enabled or disabled. Enabling the diagnostic mode helps in collecting log and debugging as well. Run the job with this value N When compliance history is successful, the contract generates condition compliance history and benefit compliance history. Segment ID: Indicates the segment for which contract benefit settlements should be generated.
Generate Consumer Goods Appointment Download Document	Run the jobs every time before running Generate Consumer Goods Appointment Download Document Purge Consumer Goods Direct Store Delivery Documents	The Job generates statistics that quantify the data distribution and storage characteristics of tables, columns, indexes, and partitions. The cost-based optimization approach uses these statistics to calculate the selectivity of predicates and to estimate the cost of each execution plan. This helps in improvising performance of Generate Consumer Goods Appointment Download Document ESS Job. Days to keep: GATHERSTATS Route Number: AppointmentDownloadAllTablesForce
PopulateStoreVisitTask (AcoBulkProcessing)	Schedules store visit task to all appointments in a specified window	Attribute1 PopulateStoreVisitTask Indicates the name of the job to be executed. Attribute2 (Diagnostic Mode) Indicates if diagnostic mode is enabled or disabled. Enabling the diagnostic mode helps in collecting log and debugging as well. Run the job with this value N Attribute5 (UseRelativeTime) If this is set to Y, the following relative time parameters are used. In case of N, the existing absolute time parameters are used. Attribute3 (StartDate) , If Attribute5 is N, this field indicates the start date for which appointments are considered or Relative Start Offset in Days If Attribute5 is Y. This field indicates the start day of the publish store visit task expressed as a number of days from the execution of the scheduled run. Attribute4 (End date), If Attribute5 is 'N'. This field Indicates the end date up to which appointments are considered or Relative Start Time. If Attribute5 is Y, this field indicates Time of Day and Time Zone for the run in the HH:MM +00:00 format where +/- 00:00 is standard time zone offset and HH is 24-hour clock as per ISO times. Attribute6 (Relative Duration in Days) indicates the duration of the period to cover expressed as a number of days from the start day. This field is valid only if Attribute5 is Y. Segment ID: Indicates the segment for which store visit task to all appointments in a specified window should be populated.

Schedule Recommendations and Dependencies

The jobs have certain dependencies and scheduling recommendations that must be followed for optimum results:

ESS Job	Dependent Job	Scheduling Recommendation
Enable Consumer Goods Object Extension for the Mobile Application		Sets up the consumer goods solution.
Migrate Consumer Goods Data		Enables the data migration for selected objects from an old release to the current release.
Process Consumer Goods Route Upload and Prepare Upload Results Document		Run this job after the upload XML is posted from all routes to the OSC staging table.
Create and Update Consumer Goods Order Rollup Records	Process Consumer Goods Route Upload and Prepare Upload Results Document	Run this job in the following schedule: Process Consumer Goods Route Upload job Prepare Upload Results Document job Inserts all the mobile orders to the OSC. Create and Update Consumer Goods Order Rollup Records job Displays the orders.
Resolve Consumer Goods Order Status	Process Consumer Goods Route Upload and Prepare Upload Results Document	Run this job in the following schedule: Process Consumer Goods Route Upload job Prepare Upload Results Document job Sends all the mobile orders to the OSC. Resolve Consumer Goods Order Status job ERP syncs the order status to the OSC staging tables. After the order statuses are created in the OSC staging tables, this job must be run.
Generate Consumer Goods Shopping Cart Template	Process Consumer Goods Route Upload and Prepare Upload Results Document Create and Update consumer goods Order Rollup Records	Run this job in the following schedule: Process Consumer Goods Route Upload Prepare Upload Results Document jobs Sends all mobile orders to the OSC. Create and Update Consumer Goods Order Rollup Records job Displays the orders. Generate Consumer Goods Shopping Cart Templates job.
Calculate Consumer Goods Promotion Cumulative Usage	Process Consumer Goods Route Upload and Prepare Upload Results Document Create and Update consumer goods Order Rollup Records. Resolve Consumer Goods Order Status	Run this job in the following schedule: Process Consumer Goods Route Upload Prepare Upload Results Document jobs Sends all mobile orders to the OSC. Create and Update Consumer Goods Order Rollup Records job Displays the orders. Resolve Consumer Goods Order Status job Updates the latest status for all the orders. Calculate Consumer Goods Promotion Cumulative Usage job Synchronizes the counts with orders.
Prepare Consumer Goods Appointment Download Document	Process Consumer Goods Route Upload and Prepare Upload Results Document Create and Update consumer goods Order Rollup Records Resolve Consumer Goods Order Status Generate Consumer Goods Shopping Cart Templates Calculate Consumer Goods Promotion Cumulative Usage	Run this job in the following schedule: Process Consumer Goods Route Upload Prepare Upload Results Document jobs. Sends all mobile orders to the OSC. Create and Update Consumer Goods Order Rollup Records job Displays the orders. Resolve Consumer Goods Order Status job Updates the latest status for all the orders. Generate Consumer Goods Shopping Cart Templates job Generates the latest shopping cart templates. Calculate Consumer Goods Promotion Cumulative Usage job Synchronize the counts with orders. Prepare Consumer Goods Appointment Download Document job.
Prepare Consumer Goods Route Download Document	Process Consumer Goods Route Upload and Prepare Upload Results Document	Run this job in the following schedule: Process Consumer Goods Route Upload Prepare Upload Results Document jobs . This sends the route inventory transactions to the OSC staging tables. Prepare Consumer Goods Route Download Document job
Purge Consumer Goods Direct Store Delivery Documents		Run this job in the following parameters: Run it after in three months with the Days to Keep parameter as 90 so that three months old data is retained. Identify the purge interval if you don't want to retain three months download and upload package data in the application.