Task executable classes on RIA Docs

SQL set

Mon, 01 Jan 0001 00:00:00 +0000

Overview

The SQLSetWorkEntryExecutor class generates and executes SQL statements from template statements specified in the Code-Block. The template statements have placeholders for source-to-target mappings that are substituted at runtime with appropriate values from the mappings.

Use this executable for source to TableSet target mappings where a Java transformer is not required.

Select a Target Level mapping and Target Types table set, and create an appropriate INSERT INTO … SELECT FROM … template statement for this executable class. Any SQL statement can be templatized, including PL/SQL anonymous blocks. For example,

SQL cursor

Mon, 01 Jan 0001 00:00:00 +0000

Overview

The SQLCursorWorkEntryExecutor class generates SELECT SQL statements from template statements specified in the Code-Block. The template statements have placeholders for source-to-target mappings that are substituted at runtime with appropriate values from the mappings.

This executable works like theSQLSetWorkEntryExecutor. The difference is that the SQLCursorWorkEntryExecutor is explicitly intended for source-to-target copy tasks. It processes the rows one by one to invoke Java transformer methods for each row. For example, you can use this executable for source-to-TableCursor target mappings where a Java transformer is required.

Service

Mon, 01 Jan 0001 00:00:00 +0000

Overview

The ServiceWorkEntryExecutor class creates XML requests from the source to target mappings and invokes EPM services to add, update, or delete the target data. For more information on how to map these actions, see Service Action Mapping.

Select a Target Level mapping and Target Types table set, and create an appropriate SELECT … template statement for this executable class.

Read requests

This executable can issue READ requests without updating the target service data. However, it can log the responses from the service and can be used to test what a service’s XML or JSON would look like. The responses can be logged as run status messages using the ResponseOnlineLogLimit parameter so that they can be viewed online. See Parameters for more information.

Rerunnable service

Mon, 01 Jan 0001 00:00:00 +0000

Overview

The RerunnableServiceWorkEntryExecutor performs the same function as ServiceWorkEntryExecutor, except it handles services that do implicit commits.

Most services perform a complete rollback if an error occurs and allow the tool to restart from that point by re-invoking the service that previously failed. However, there are some exceptions where the service issues commits. If such a case is found, use the rerunnable service and provide an initialization executable, initExec <parameters>, to reset the data before making service calls. This initialization executable can remove any remaining data from previous runs and prepare for resubmission of service requests.

SQL script

Mon, 01 Jan 0001 00:00:00 +0000

Overview

The SQLScriptWorkEntryExecutor class executes the SQL and PL/SQL statements supplied in the Code Blocks of an Executable. This executable also provides a custom SQL executor to run any SQL statement as part of a conversion run.

Select NONE Target Level mapping and no Target Types for this executable class. The statements to execute must be specified in the Code Blocks text field only.

Statements can be logically separated into different code sequences and executed in that order. Multiple statements can also be combined in one code sequence. If combined, each statement must be terminated by a ; . However, for statements using WITH clauses or PL/SQL statements that can include semi-colons, they are terminated by a / on a separate line.

Validation

Mon, 01 Jan 0001 00:00:00 +0000

Overview

The ValidationWorkEntryExecutor class generates and executes SQL statements to check for error conditions in the data. Select Target Level Target and Target Types TableSet and TableCursor for this executable class.

The VALIDATION_TYPE executable parameter defines the validation type. Possible values are the following. For more information, see Default validations.

REQUIRED
FKERROR
LOOKUP
CUSTOM

The validation results are written to the UA_RUN_VALIDATION table and can be viewed through the Report menu.

Shell script

Mon, 01 Jan 0001 00:00:00 +0000

Overview

The ShellScriptWorkEntryExecutor class runs a shell script, allowing actions to be performed at the operating system level from a Task.

Returning a non-zero exit code from the shell script will result in an error.

Java properties

You can specify the permitted scripts to be executed by configuring the following properties in the ria-boot.properties file:

com.ria.dih.core.shell.scriptDir — specifies the default directory for the shell scripts.
com.ria.dih.core.shell.taskDirAllowed — enables you to override the default directory by specifying it in the Task. Set this to false to only allow scripts located in the directory specified in the com.ria.converter.shell.scriptDir property.

If com.ria.dih.core.shell.scriptDir is not specified and com.ria.dih.core.shell.taskDirAllowed is false, no shell scripts may be executed.

Auth

Mon, 01 Jan 0001 00:00:00 +0000

Overview

Th AuthWorkEntryExecutor class is designed to provide a generic authentication mechanism that can be used as needed.

To use, an authentication executable must be defined on a Task. Typically, this task is not directly executed from a chain step. Instead, it is more likely linked to another task that requires authentication, a token, or both. For example, the following service executable has an authTask parameter that points to an instance of an authentication executable.

Batch

Mon, 01 Jan 0001 00:00:00 +0000

Overview

The BatchWorkEntryExecutor class integrates with the OUAF batch framework, allowing you to execute a batch job within a data migration or integration chain. To do this, add a Task linked to the Executable and specify the parameters in the task settings. If the OUAF batch job supports multi-threading, the job can be run using multiple threads.

Parameters

The following parameters can be defined using this executable:

Parameter Description

batchCode Code of the OUAF batch control to submit.

user User ID of the executor of the run.

language Code language to use for the run.

businessDate

Business date in YYYY-MM-DD format.

Default: Current date

Report export

Mon, 01 Jan 0001 00:00:00 +0000

Overview

You can access and manually download reports through the Report menu in the user interface. Alternatively, the ReportExportWorkEntryExecutor class creates and exports one or more reports as part of a server job execution. If needed, the generated reports can also be emailed.

Multiple reports can be exported by one Task by specifying the parameters for each file export in a data block.

Parameters

This executable class accepts the following parameters:

Email

Mon, 01 Jan 0001 00:00:00 +0000

Overview

The EmailWorkEntryExecutor executable can send one or more emails from a Task.

This executable uses the Code Block to define the default message. The default message can contain Internal variables or HTML. If a different default message is specified in a Data Block of a Task, this message is displayed instead of the one specified in the Code Block.

Java properties

The ria-boot.properties file must be configured for the email server. All standard Java mail properties with the mail. format are supported, but they must be prefixed by com.ria. for the runtime server to accept them. For example:

Timed job notifier

Mon, 01 Jan 0001 00:00:00 +0000

Overview

The GroovyTimedExecutor executable contains the Groovy code that will be fired according to the interval setting, and it will check if there are any jobs that went into stalled state since the previous execution and send an email for each of those. The job name and last_start_date are saved in the handledJobs global user variable to prevent resending the same notification for the same job execution.

Groovy code

The following code shows an example of how the executable can be used so that the email/SMTP configuration can be localized to the DIH server. This example sends an email for every job that goes into a CHAIN_STALLED state, which typically means that it encountered an error and needs to be corrected and restarted, but the Groovy code can be modified to handle any condition and send out any notification.

Common executable features

Mon, 01 Jan 0001 00:00:00 +0000

The features described here are applicable to most of the executables.

Internal variables

Most of the executable classes support the following internal variables. These variables are replaced with the appropriate value at runtime.

Internal variable	Description
`{$threadNumber}`	Number of the executing thread.
`{$threadCount}`	Thread count specified in Task.
`{$runId}`	Numeric run id of the current run.
`{$taskId}`	Task id of the current task.
`{$targetId}`	Target ID for which the current statement is being executed.
`{$mappingSeq}`	Target mapping sequence of the current target.
`{$jobName}`	Name of the scheduled job.
`{$runSeq}`	Run sequence of the job.
`{$currentDate}`	Current date in `YYYYMMDD` format.
`{$currentTime}`	Current time in `HHmmss` format, where `HH` is in 24-hour format.
`{$currentDateTime}`	Current date and time in `YYYYMMddHHmmss` format.
`{$currentTimestamp}`	Current time in `YYYYMMddHHmmssSSS` format (where `SSS` is milliseconds).

For example, the {$threadCount} and {$threadNumber} variables are used with the ORA_HASH function to divide the rows to delete into thread buckets.

Kafka inbound

Mon, 01 Jan 0001 00:00:00 +0000

Overview

A task can be set up to connect to a Kafka topic, and continuously consume messages. When a job for this task is submitted, it runs indefinitely until it is manually stopped from the Task Scheduler.

In this setup, the producer class acts as the Kafka consumer, retrieving messages as they become available on the topic. Once a message is consumed, the producer places it in a Hazelcast distributed queue for processing by any available DIH consumer thread.

Handle response

Mon, 01 Jan 0001 00:00:00 +0000

Overview

The handleResponse method is an optional Groovy method that can be defined in a task or an executable. It is called automatically after an API request is completed and allows you to process the API response before the task continues.

The method receives a single ServiceAPIResult parameter, which contains the response returned by the API, including the response data and status information.

You can use handleResponse to: