Workload Job Definitions¶
This page explains the different types of Workload Job Definitions and their purpose.
What Does a Workload Job Definition Consist Of?
A Workload Job Definition consists of Data Sources and Argo Workflows (referred to as Actions). It can be scheduled or manually triggered to create a Workload Run, depending on the requirement. During execution, the Data Sources included in a Workload Job Definition are first loaded into the Data Lake. Once the Data load is completed, the associated Data Pipeline is triggered. After the Workload Run is completed, the corresponding Workload Run details are updated and made available for monitoring and further actions.
Read more about triggering a Workload Job Definition for a Run.
Read more about Workload Runs.
Types of Workload Job Definitions
There are two types of Workload Job Definitions:
| System‑Defined Workload Job Definitions | Custom Workload Job Definitions |
|---|---|
| - Created by IFS product developers. - Consist of Data Sources and Actions. - Limited editability and cannot be deleted. | - Can be created by users who are granted the appropriate permission sets (to create Custom Workload Job Definitions, the self-hosted environment setup must be completed). - Consist of Data Sources only. - Can be modified and deleted. |
System-Defined Workload Job Definitions¶
System‑defined Workload Job Definitions are available upon installation. These are created by IFS product developers, have limited editing capabilities, and 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.
Read more about the available System-defined Workload Job Definitions:
- System-defined Workload Job Definitions for CDC
- System-defined Workload Job Definitions: Example Use cases from Sustainability Management
Note
System-defined Workload Job Definitions are visible only when the corresponding module is active in the installation. Workload Job Definitions belonging to modules that are not active are not displayed.
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.
Custom Workload Job Definitions¶
Workload Job Definition can be used to load a set of Data Sources (without necessarily triggering a Workflow). For custom Workload Job Definitions, the self-hosted environment setup should be completed.
Read more about setting up the self-hosted environment.
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.
Custom Workload Job Definitions can be created manually via the Workload Job Definitions page or through the Create Packaged Workload Job Definition assistant.
Prerequisites¶
Read more about prerequisites for the Workflows and Workload Job Definitions.