5 Export/Import Schedule Configuration

This chapter explains the export/import schedule configuration feature of POM.

Overview

POM provides a feature, in the user interface, to export and import schedule configuration data such as data retention limits, throttle limits, enable/disable flags, schedule times, and so on.

This feature can be used in two ways:

1. Data exported on a specific environment can be imported back on a different environment without any modifications. This is a typical use case where the batch schedule on a certain environment, such as Stage, is set up and fine-tuned according to a customer's requirements. This includes specifying which jobs should or shouldn't run. It also includes specifying the times certain cycles or flows will start. Once the schedule is configured and fine-tuned (on Stage, for example) the export/import feature can be used to export the configurations from Stage and import them back into production.

   
   

   Note: The user has the option to export to a spreadsheet or a JSON file. In this first use case, it is recommended the user exports to a JSON file then imports it back into the other environment.

   
   

2. Data can be altered in the exported spreadsheet then imported back into the same environment. This is useful at provisioning time where an environment is first set up with the default batch schedule configuration. A user would then export the default configuration, then modify that configuration on the spreadsheet to conform to the customer's needs. The spreadsheet is then imported back into the same environment, applying the desired configurations.

   
   

   Note: When importing the spreadsheet on the Batch Administration screen, the user will have the option of importing job-related configuration or scheduler-related configuration (run times) or both. Refer to the "Batch Administration" section in the POM User Guide for more details.

   
   

This chapter describes each tab in the exported spreadsheet, along with the data on each sheet. It also indicates which fields can be modified.

Schedule Info Tab

This is an informational only tab. No fields are modifiable on it.

Table 5-1 Schedule Info

Field	Description	Modifiable?
Name	Schedule or application name.	No
Version	Schedule version.	No
Installation Date	Date the schedule was uploaded into POM.	No
Customer Name	This is used on notifications to identify which customer a notification is for.	No
Environment Name	This is used on notifications to identify which customer's environment a notification is for.	No

Schedule Configuration Tab

This tab contains schedule level settings.

Table 5-2 Schedule Configuration

Field	Description	Modifiable?
First Run Business Date	Date when batch was run for the first time. See subsection "Business Date Explained" in the "System Configuration" section of the POM User Guide.	No
Data Retention Days	Number of days historic data is to be retained in POM.	Yes - Recommended value is 30 days.
Long Run Average Multiplier	Number which is multiplied by a job's average run time or Threshold Runtime (if provided) to determine the threshold which, when exceeded, the job is deemed long running.	Yes - Usually a number between one and three.
External Dependencies	Indicates whether POM will respect external dependencies or not. They are usually dependencies on customers' internal processes.	Yes - Valid values are Y or N.
Inter-schedule Dependencies	Indicates whether POM will respect external dependencies or not. Those are dependencies on other schedules.	Yes - Valid values are Y or N.
Callback mode	This is also known as External Status Update Mode. Depending on the value, the customer's system is notified of success or failure of any job in the entire schedule. The value set here is overridden by this same setting for any individual job defined on the other job-specific tabs.	Yes - Valid values are ALL, FAILED or NONE. When value is NONE, no callback is made. When value is ALL, callback is made on either success or failure. When value is FAILED, callback is made only on failure

Throttling Tab

At this time, this tab should only be used to set throttle limits at the application level. Throttling is a technique used to limit the number of jobs that can run concurrently for a specific application. Throttling limits are set so a server's resources are not overwhelmed by too many concurrently running jobs.

Note: Previously, throttle limits could be set at the application level and/or at the module level. Now they can only be set at the application level.

Also note that this tab was intended to provide the capability to enable/disable whole applications or modules. This is not functioning at this time. In order to achieve this objective, filter on application on the Nightly Jobs Configuration, Recurring Jobs Configuration or Adhoc Jobs Configuration, then change all enabled flags to 'Y' or 'N' as desired. For enabling/disabling whole modules, this has to be done on the Batch Administration screen at this time.

Table 5-3 Throttling Configuration

Field	Description	Modifiable? - Possible values
Application	Application code.	No
Module	Module name.	No
Job Admin	Job Admin is the component usually running on the same server as the application and which executes that application's batch jobs.	No
Throttle Limit	The max number of jobs that can run concurrently for the specified application.	Yes - A number that is greater than zero.
Enabled	This flag currently does not enable or disable jobs belonging to an application/module. See the second note at the top of this section for more information.	Yes - Valid values are Y or N.

Nightly Jobs Configuration Tab

This tab contains all Nightly cycle's jobs along with their configuration.

Table 5-4 Nightly Jobs Configuration

Field	Description	Modifiable? - Possible values
Job	Job name.	No
Process	Process name to which the job belongs; a process can contain multiple jobs.	No
Cycle	This is a fixed value for this tab of 'Nightly'.	No
Application	Application name to which this process-job belongs.	No
Initial Parameter	The initial parameter this job was set up with when the base schedule was first loaded into POM.	Yes - Can contain blank or any space-separated list of parameters.
Parameter Change	Flag indicating whether the parameter can be changed after the initial load. If it can, then the new value must be loaded in the next field: Active Parameter.	Yes - Valid values are Y or N.
Active Parameter	Parameter which overrides the Initial Parameter when Parameter Change is 'Y'.	Yes - Can contain blank or any space-separated list of parameters.
Skip on error	Flag indicating whether this job can be skipped when it fails.	Yes - Valid values are Y or N.
Callback mode	This is also known as External Status Update Mode. Depending on the value, the customer's system is notified of success or failure of this specific job by calling a predefined customer endpoint. The value set here overrides that of this same setting on the Schedule Configuration tab.	Yes - Valid values are ALL, FAILED or NONE. When value is NONE, no callback is made. When value is ALL, callback is made on either success or failure. When value is FAILED, callback is made only on failure
Day of week	Contains the day(s) of the week on which this specific Job will run. POM automatically skips these Jobs on remaining days. If this field is left blank, the job will run on every day of the week	Yes - Valid values are blank or any number of comma separated days of the week (for example: SUNDAY,MONDAY,TUESDAY, WEDNESDAY,THURSDAY, FRIDAY,SATURDAY)
Threshold Runtime	Estimated runtime in seconds for this specific job. This is an optional field which, when entered, will be used to multiply by the Long Run Average Multiplier defined on the Schedule Configuration tab. When the resulting number is exceeded, the job is deemed long running. If this field is blank, then the job's average run time is used instead to multiply by the Long Run Average Multiplier.	Yes - Valid values are blank or an integer number of seconds.
Enabled	Flag indicating if this job is enabled or disabled	Yes - Valid values are Y or N.

Recurring Jobs Configuration Tab

This tab contains the list of Recurring cycle/Process/Job along with their configuration.

Table 5-5 Recurring Jobs Configuration

Field	Description	Modifiable? - Possible values
Job	Job Name	No
Process	Process name to which the job belongs; a process can contain multiple jobs.	No
Cycle	Name of the hourly/recurring cycle this job belongs to.	No
Application	Application name to which this process-job belongs.	No
Initial Parameter	The initial parameter this job was set up with when the base schedule was first loaded into POM.	Yes - Can contain blank or any space-separated list of parameters.
Parameter Change	Flag indicating whether the parameter can be changed after the initial load. If it can, then the new value must be loaded in the next field: Active Parameter.	Yes - Valid values are Y or N.
Active Parameter	Parameter which overrides the Initial Parameter when Parameter Change is 'Y'.	Yes - Can contain blank or any space separated list of parameters.
Skip on error	Flag indicating whether this job can be skipped when it fails.	Yes - Valid values are Y or N.
Callback mode	This is also known as External Status Update Mode. Depending on the value, customer's system is notified of success or failure of this specific job by calling a predefined customer endpoint. The value set here overrides that of this same setting on the Schedule Configuration tab.	Yes - Valid values are ALL, FAILED or NONE. When value is NONE, no callback is made. When value is ALL, callback is made on either success or failure. When value is FAILED, callback is made only on failure
Day of week	Contains the day(s) of the week on which this specific Job will run. POM automatically skips these Jobs on the remaining days. If this field is left blank, the job will run on every day of the week	Yes - Valid values are blank or any number of comma-separated days of the week (for example: SUNDAY,MONDAY,TUESDAY, WEDNESDAY,THURSDAY, FRIDAY,SATURDAY)
Threshold Runtime	Estimated runtime in seconds for this specific job. This is an optional field which, when entered, will be used to multiply by the Long Run Average Multiplier defined on the Schedule Configuration tab. When the resulting number is exceeded, the job is deemed long running. If this field is blank, then the job's calculated average run time is used instead to multiply by the Long Run Average Multiplier.	Yes - Valid values are blank or an integer number of seconds.
Enabled	Flag indicating whether this job is enabled or disabled.	Yes - Valid values are Y or N.

Flows Configuration Tab

This tab contains a flow/cycle matrix. It contains a row for each flow and all recurring cycles as columns. An intersection of 'Y' means the given flow is defined to run as part of the given recurring cycle. It is recommended that all recurring cycles are enabled but not necessarily scheduled for running. See the Scheduling Flows Tab for further clarification.

Table 5-6 Flows Configuration

Field	Description	Modifiable?
Flow	Flow name.	No
Recurring cycle 1	A 'Y' or 'N' value indicating whether the given flow is run as part of recurring cycle 1. A value of N does not disable jobs belonging to the flow/cycle intersection. Those jobs need to be manually disabled on the Batch Administration screen.	Yes - Valid values are Y or N.
Recurring cycle 2	A 'Y' or 'N' value indicating whether the given flow is run as part of recurring cycle 2. A value of N does not disable jobs belonging to the flow/cycle intersection. Those jobs need to be manually disabled on the Batch Administration screen.	Yes - Valid values are Y or N.
Recurring cycle n	A 'Y' or 'N' value indicating whether the given flow is run as part of recurring cycle n. A value of N does not disable jobs belonging to the flow/cycle intersection. Those jobs need to be manually disabled on the Batch Administration screen.	Yes - Valid values are Y or N.

Adhoc Jobs Configuration Tab

This tab contains the list of ad hoc jobs (also known as standalone) along with their configuration.

Table 5-7 Adhoc Jobs Configuration

Field	Description	Modifiable? - Possible values
Job	Job name.	No
Process	Process name to which the job belongs; a process can contain multiple jobs.	No
Cycle	This is a fixed value for this tab of 'Adhoc'.	No
Application	Application name to which this process-job belongs.	No
Initial Parameter	The initial parameter this job was set up with when the base schedule was first loaded into POM.	Yes - Can contain blank or any space-separated list of parameters.
Parameter Change	Flag indicating whether the parameter can be changed after the initial load. If it can, then the new value must be loaded in the next field: Active Parameter.	Yes - Valid values are Y or N.
Active Parameter	Parameter which overrides the Initial Parameter when Parameter Change is 'Y'.	Yes - Can contain blank or any space separated list of parameters.
Skip on error	Flag indicating whether this job can be skipped when it fails.	Yes - Valid values are Y or N.
Callback mode	This is also known as External Status Update Mode. Depending on the value, the customer's system is notified of the success or failure of this specific job by calling a predefined customer endpoint. The value set here overrides that of this same setting on the Schedule Configuration tab.	Yes - Valid values are ALL, FAILED or NONE. When value is NONE, no callback is made. When value is ALL, callback is made on either success or failure. When value is FAILED, callback is made only on failure
Day of week	Contains the day(s) of the week on which this specific Job will run. POM automatically skips these Jobs on remaining days. If this field is left blank, the job will run on every day of the week	Yes - Valid values are blank or any number of comma separated days of the week (for example: SUNDAY,MONDAY,TUESDAY, WEDNESDAY,THURSDAY, FRIDAY,SATURDAY)
Threshold Runtime	Estimated runtime in seconds for this specific job. This is an optional field which, when entered, will be used to multiply by the Long Run Average Multiplier defined on the Schedule Configuration tab. When the resulting number is exceeded, the job is deemed long running. If this field is blank, then the job's calculated average run time is used instead to multiply by the Long Run Average Multiplier.	Yes - Valid values are blank or an integer number of seconds.
Enabled	Flag indicating whether this job is enabled or disabled.	Yes - Valid values are Y or N.

Job Dependencies Tab

This tab contains the definitions of all intra-schedule dependencies (or job dependencies within the same schedule) for all cycles (Nightly, Recurring and Adhoc). External, inter-schedule dependencies and execution links are defined on the Job External Associations tab.

Only the Enabled flag can be changed on this tab. Caution should be exercised when disabling a dependency, as in certain situations this can cause a job to run before data is processed by the predecessor job. This can therefore cause data corruption.

Table 5-8 Job Dependencies

Field	Description	Modifiable? - Possible values
Job	Job name.	No
Process	Process name to which the job belongs.	No
Cycle	Nightly, Adhoc or specific recurring/hourly cycle.	No
Predecessor Process	Process name to which the predecessor job belongs.	No
Predecessor Job	Job which must complete before the job defined on the current row can run.	No
Enabled	Flag indicating whether this dependency is enabled or disabled.	Yes - Valid values are Y or N.

Job External Associations Tab

This tab contains the definitions of External dependencies, inter-schedule dependencies and execution links, so all dependencies other than the intra-schedule dependencies described in the previous section.

Note: New external associations can be added in this tab.

External dependencies are usually those defined for customer processes. These are associated with a POM endpoint that the customer calls to satisfy the dependency.

Inter-schedule dependencies are those associated with another schedule. For instance, a Retail Insight job can be made to wait for a Merchandising job to complete.

An Execution link is a special dependency that sets up an application's schedule to be invoked based on a completion of a job in another application's schedule. For instance, the Retail Insight schedule can be set up to be invoked when job A completes in the Merchandising schedule.

Table 5-9 Job External Associations

Field	Description	Modifiable? - Possible values
Job	Job name.	Yes - Needs to be a valid job name already defined on the nightly schedule.
Process	Process name to which the job belongs.	Yes - Needs to be a valid process name already defined in the nightly schedule.
Cycle	Cycle name.	Yes - This can only be Nightly.
Association Type	Type of dependency.	Yes - Valid values are Internal for Inter-Schedule, External and EXEC_LINK
External Schedule	Name of the schedule containing the inter-schedule dependency or execution link.	Yes - This must be an existing valid schedule defined in the same instance of POM. This is only required for inter-schedule dependencies and execution links.
External Job	Name of external job.	Yes - In the case of an external dependency, this is the name that will be included in the payload of an endpoint called by the external system, such as the customer's. In the case of inter-schedule dependencies and execution links, this is a valid job name defined in the dependent schedule.
External Process	Process name to which the external job belongs.	Yes - This is required for inter-schedule dependencies and execution links. It's the process name associated with the external job.
Enabled	Flag indicating whether this dependency is enabled or disabled.	Yes - Valid values are Y or N.

Scheduling Flows Tab

This tab and the next contain configurations for scheduling flows or processes to run at specified times.

This Scheduling Flows tab contains the definitions of scheduled run times for the Nightly and recurring flows.

It simply contains one row for the Nightly flow stating the time when the Nightly processes will start every day.

The rest of the tab contains rows for each recurring flow, with columns for each of the hourly cycles making up the flow. For each cell at the intersection of Flow and hourly cycle, the time is entered for when the cycle is to start running. At present, there is a maximum of 24 hourly cycles that can be defined which, when spaced equally, would run one hour apart. Times are optional, so a blank cell indicates that the cycle will not be scheduled to run.

Note: Although there is no validation that cross-references the presence of a time in a cell with the enabling of the cycle on the Flows Configuration tab, ideally these would match up. This means that, if you enter a time for running an hourly cycle, the same intersection on the Flows Configuration tab should be 'Y'. However, it is conceivable to enable the cycle on the Flows Configuration tab but not schedule it, leaving the option open to schedule it as needed. In fact, this is the recommended practice: Enable all hourly cycles and only schedule a few as needed, but have the option to run more to catch up when necessary.

The timezone region ID entered in cell B is used for all times entered for all subsequent cycles on a given row. It is possible to specify a different timezone for select time cells (for example, 5:00 America/Chicago).

Note: If the timezone region ID is null in the database, UTC is exported as the default into cell B of this tab.

Table 5-10 Scheduling Flows

Field	Description	Modifiable? - Possible values
Flow	Flow name.	No
Timezone Region ID	Timezone corresponding to the time entered in the subsequent cell(s). Timezone region ID is required, rather than a UTC offset (such as "UTC-06:00"). This is to accommodate Daylight Saving Time.	Yes - Valid timezone region IDs such as US/Eastern can be found as TZ database name at https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
Nightly	Only fill this cell if Flow is Nightly. Enter the time for starting the Nightly cycle.	Yes - Enter a valid military time format such as 6:00 (6am) or 22:00 (10pm).
Recurring cycle 1	Enter a time in this cell to schedule recurring cycle 1 to run at that time. Leave blank to forego scheduling recurring cycle 1. It is possible to not schedule the cycle by default but elect to run it manually if needed.	Yes - Enter a valid military time format such as 6:00 (6am) or 22:00 (10pm). Conflict with the Nightly batch flow should be avoided as POM will skip running a recurring cycle if its start time is elapsed while Nightly is running.
Recurring cycle 2	Enter a time in this cell to schedule recurring cycle 2 for running at that time. Leave blank to forego scheduling recurring cycle 2. It is possible to not schedule the cycle by default but elect to run it manually if needed.	Yes - Enter a valid military time format such as 6:00 (6am) or 22:00 (10pm). Conflict with the Nightly batch flow should be avoided as POM will skip running a recurring cycle if its start time is elapsed while Nightly is running.
Recurring cycle n	Enter a time in this cell to schedule recurring cycle 1n for running at that time. Leave blank to forego scheduling recurring cycle n. It is possible to not schedule the cycle by default but elect to run it manually if needed.	Yes - Enter a valid military time format such as 6:00 (6am) or 22:00 (10pm). Conflict with the Nightly batch flow should be avoided as POM will skip running a recurring cycle if its start time is elapsed while Nightly is running.

Scheduling Adhoc Tab

This tab contains the definitions of scheduled run times for the ad hoc processes.

Table 5-11 Scheduling Adhoc

Field	Description	Modifiable? - Possible values
Process	Adhoc process name.	No
Description	Description of reason for running this Adhoc process at the specified time.	Yes - Optionally describe the purpose for scheduling the Adhoc process at the specified time
Frequency	Frequency in minutes at which this Adhoc process is to be run.	Yes - Valid values are Daily meaning run this process once at the specified time, or EVERY:x, where x is number of minutes. For example EVERY:120 means run this process every two hours.
Limit Occurrences	Relevant only when frequency of EVERY:x is used. If a Limit Occurrences value is entered, the process will run a maximum of times equal to the specified limit.	Yes - A positive integer. For example: Frequency of EVERY:120 with a Limit Occurrences of 4 means the process will run every two hours a maximum of four times
Prevent start during nightly	A flag which, when set to Y, indicates that this process is not to be started when the Nightly process is running. If the Scheduler tries to start a run while Nightly is running, the execution's status is set to Error with an Info message of "Nightly started running so can't run the process."	Yes - Valid values are Y or N.
Schedule Time	Entering a time in this field causes the process to be scheduled at that time in case of a DAILY frequency or to start the first run at that time in case of an EVERY:x frequency. Leaving this field blank causes the process to run immediately or the first run to start immediately when the scheduler day starts. If a specific time is entered in this field but the scheduler day starts after that time, the process will be scheduled for the next day at that time.	Yes - Enter a valid military time format such as 6:00 (6am) or 22:00 (10pm).
Enabled	Flag indicating if this process is to be scheduled.	Yes - Valid values are Y or N.
Timezone Region ID	Timezone corresponding to the time entered in the subsequent cell(s). Timezone region ID is required rather than a UTC offset such as UTC-06:00. This is to accommodate Daylight Saving Time.	Yes - Valid timezone region IDs such as US/Eastern can be found as TZ database name at https://en.wikipedia.org/wiki/List_of_tz_database_time_zones