Skip to content

Create Workload Job Definitions

This page provides details about how a Workload Job Definition can be created and managed.

Creating a Workload Job Definition

Workload Job Definitions can be system-defined or User-created (custom) through IFS Cloud Web.

System-Defined Workload Job Definitions

System-defined Workload Job Definitions are available during the installation. These Workload Job Definitions have limited editing options and they cannot be deleted. For a Workload Job Admin user, the modification that can be done is to Enable or Disable the Workload Job Definition's Active status.

A system-defined Workload Job Definition is indicated by the System Defined flag.

The Workload Job Definition's details view (Workload Job Definition page) includes below sections:

  • Workload - Provides a summary of the defined Workload Job Definition.
  • Data Sources - Indicates the Data Sources that are available in the Workload Job Definition.
  • Actions- Indicates the Workflow(s) available in the Workload Job Definition.
  • Workload Runs- After a Workload Run is created, this section indicates details and status related to the respective Run, as well as all completed Runs.

Workload Job Definition - Actions

Data Properties:

Property Description
Type Specifies the Workload Action type in a Workload Job Definition.
Name The identifier of the specific Workflow.
Description Workflow description.
Last Run Specifies the end time of the Workflow Run.
Status Transitioned status of a Workflow during each Workload Action Run.

User-created (custom) Workload Job Definition:

A user who is granted the appropriate permission sets can create a Workload Job Definition via the Workload Job Definitions page. For this activity, WLJOB_ADMIN and DATSVC_ADMINISTRATOR permissions need to be granted to the user. Granting DATSVC_ADMINISTRATOR is beneficial for the user to create or edit Parquet Data Sources when necessary.

The below steps can be followed to create a Workload Job Definition.

  1. Navigate to the Workload Job Definitions page from the navigator.

  2. Use the + (New) option to create a new Workload Job Definition.

    • Enter a meaningful Workload Name and a Description accordingly.

    • The Active flag is set to Yes by default. It can be set to No if required from the dropdown.

    • Save the new Workload Job Definition.

    • Last Run Status, Last Run Time and System Defined flag will be set accordingly (Last Run Status value will be set to New and the Last Run time will have no value till the Workload Job Definition is triggered for a Run and the execution is completed).

Data Properties:

Property Description
Workload Name Name of the Workload Job Definition.
Description Description of the Workload Job Definition.
Active Specifies whether the Workload Job Definition is enabled or disabled. This flag is set to Yes by default. If the flag is set to False, then the schedule will not trigger a refresh.
Last Run Status The latest execution status of the Workload Job Definition. If the Workload Job Definition is new, the status is indicated as New, else the status is indicated based on the Workload Run.
Last Run Time Workload Job Definition's Last Run time which is updated by the scheduler once the execution is completed.
System Defined Indicates whether the Workload Job Definition is IFS Delivered or user-created based on the flag status.
  • Available functions in the Workload Job Definitions page can be viewed upon a Workload Job Definition entry selection.

Available functions :

Property Description
Details Navigate to the Workload Job Definition page. This page includes all the details regarding the defined Workload Job Definition.
Schedule Schedule Refresh Intervals for the given Workload Job Definition.
Trigger Now Explicitly Trigger a Workload Job Definition for a Run (Trigger and Load / Trigger Only). If the Active flag status of the Workload Job Definition is set to No, this option is disabled.
View Runs Navigate to the Workload Runs page to view detailed information regarding the respective Workload Job Definition's Run(s).
View Logs Navigate to the Workload Log page to view detailed logs.

3.Use the Details option from the Workload Job Definitions to navigate to the Workload Job Definition page. The below sections are available on this page.

  • Workload - Provides a summary of the defined Workload Job Definition.

  • Data Sources - Indicates the Parquet Data Sources that are available in the Workload Job Definition.

  • Actions - Indicates the Workflow(s) available in the Workload Job Definition.

Note

Note that for this release, Actions cannot be added manually during a Workload Job Definition creation process.

  • Workload Runs - After a Workload Run is created and completed, this section indicates details about each Run.

4.Add Data Sources into the Workload Job Definition.

The Data Source will be displayed in the Data section along with its Last Refreshed time and the Last Load Status (based on the refresh history). Also, multiple Data Sources can be added by selecting the + (New) option.

The Data Sources section provides additional functions that enable navigation to the Workload Log and Parquet Data Source Details view.

Data Properties:

Property Description
Data Source Name of the Parquet Data Source that is included in the relevant Workload Job Definition.
Last Refreshed Specifies the Last Refreshed time of the Parquet Data Source.
Last Load Status Specifies the value based on the transitions during the Parquet Data Source loading process.
Read more about Data Source status.

Run a Workload Job Definition

Two options can be used to trigger a Workload Job Definition for a Run.

  1. Schedule
  2. Trigger Now

1. Use the Schedule option to schedule a Workload Job Definition.

A Refresh schedule can be defined based on the requirement to refresh a Workload Job Definition. This allows the addition of a Time Plan and a frequency, which will be set as the refresh schedule of the Workload Job Definition. Time is based on UTC, therefore the converted time value is required.

The Schedule option is available on the Workload Job Definitions page and on the Workload Job Definition page.

  • The Time Plan (UTC) and Refresh Frequency can be set by selecting the '+' icon. It creates a new entry that enables selecting Hours /Minutes from the drop-down.

  • Refresh frequency can be changed by selecting a value from the drop-down. Provided frequencies are Daily and Weekly.

If the Refresh Frequency is selected as Weekly, the day/days can be selected accordingly.

  • Once the time is selected, click Done to add the new entry and click Save.
  • When defining a new Refresh Interval, by default the schedule will indicate that it is Active. This can be toggled off when required. Toggling off will make the respective refresh schedule inactive, therefore a Run will not be triggered.

Once saved, the Workload Job Definition will Run based on the schedule.

  • To view defined schedule details, to change or remove a defined Refresh schedule, use the Schedule option to view existing schedule(s) available for the Workload Job Definition. The Edit or Delete option within the assistant can be used against the schedule based on the requirement. The Edit option will enable the editing of all the available fields.

Multiple refresh interval Time Plans can be added for a single Workload Job Definition.

2. Use the Trigger Now option

This option can be used to explicitly trigger a Workload Job Definition for a Run.

Upon the selection of Trigger Now, a prompt is displayed with the below options. Select the required option accordingly and proceed with the Explicit trigger of the Workload Job Definition.

  • Trigger and Load - Provides the option to trigger the Workload Job Definition for a Run and load all associated Data Sources disregarding the Max Age.
  • Trigger Only - Provides the option to trigger the Workload Job Definition for a Run while only loading the Data Sources that need to be loaded.
  • Cancel - Provides the option to Cancel the explicit trigger.

Note

The Trigger Now option will not be available when a Workload Job Definition is already triggered for the Run.

Status of a Workload Job Definition

A Workload Job Definition's status is updated based on the execution.

Read more about the status transition of a Workload Job Definition.

View Workload Run

After each Workload Run, detailed information about each Run can be viewed via the Workload Run page.

Read more about Workload Run.

View Workload Log

After each Workload Run, detailed information regarding the Workload Job Definition's execution can be viewed via the Workload Log page.

Read more about Workload Log.

Managing a Workload Job Definition

A Workload Job Definition can be managed in below ways.

  1. Editing a created Workload Job Definition
  2. Modifying Data Sources within a Workload Job Definition
  3. Deleting a Workload Job Definition

To manage a Workload Job Definition, WLJOB_ADMIN, and DATSVC_ADMINISTRATOR permissions need to be selectively granted to the user.

1. Edit a Workload Job Definition

A Workload Job Definition can be edited from the Workload Job Definitions page and from the Workload Job Definition page by selecting the Edit icon.

This enables modifying the Workload Name, Description, and Active status.

2. Modifying Data Sources

The Data Sources section of the Workload Job Definition provides the capability to add more Data Sources or delete existing Data Sources as required.

  • Add Data Sources - From the Workload Job Definition page Data Sources section, the + (new) option can be used to add more Data Sources.
  • Delete Data Sources - From the Workload Job Definition page Data Sources section, the Delete option can be used to remove existing Data Sources.

3. Deleting a Workload Job Definition

A Workload Job Definition can be Deleted by using the Delete icon available on the Workload Job Definitions page and the Workload Job Definition page.

Sample Use case

Read more about the ESG Workload Job Definition use cases.