SAP JCo Uploader Agent Configuration(4.3)

Owned by Jenni Wallin
Last updated: Nov 25, 2024 by Peter Martinsson
4 min read

Configuration

You open the SAP JCo Uploader agent configuration dialog from a workflow configuration. To open the SAP JCo Uploader collection agent configuration, click  Build → New Configuration. Select Workflow from the Configurations dialog. When prompted to Select workflow type, select Batch. Click Add agent and select SAP JCo Uploader from the Forwarding tab of the Agent Selection dialog.

Jco_batch _agent_ configuration.png
The SAP JCo Uploader agent configuration

Setting

Description

Setting

Description

Connection Details

Username

The username for the remote database to connect to for state handling

Password

The password for the remote database to connect to for state handling

Host

The IP address of the SAP System.

Database

Select the relevant database profile to connect to a remote database for state handling

Enable Load Balancing

Select this check box to enable load balancing for SAP JCo.

System ID

The 3 character code for the SAP System

Message Server Host

The hostname/IP of the SAP Message Server

Message Server Port

The port of the SAP Message Server

Group Name

The group name associated with the SAP System

Advanced

SAP System Number

The SAP System number

SAP Client Number

The SAP Client number

Table Parameter Name

The name of the table in the SAP System to which the records are to be uploaded

Two Phase Commit

Select this check box if you want records to be committed in two phases.

Session Timeout (minutes)

This field determines the session timeout in minutes. This option is only available if you 
select the Two Phase Commit option. The default value is 10.

Performance

Commit Size

The number of records to be inserted for each commit

Enable Connection Pool

Select this checkbox to use a connection pool to communicate with the SAP JCo Uploader.

Max Idle Connections

The maximum number of idle connections kept open by the destination. A value of 0 means there is no connection pooling. The default value is 2.

Max Active Connection

The maximum number of active connections that can be created for a destination simultaneously. The default value is 10.

No of Threads

The number of threads simultaneously uploading into the SAP System. The minimum value is 1. The default value is 2.

Max Queue Size

This field limits the maximum number of records waiting to be processed in the queue. This prevents an out of memory error from occurring if the SAP System is too slow to consume the records. The default value is 6000.

Route Error Handling

Enable Route Error Handling

Select this checkbox to route the record UDR to an error route if it contains an invalid value. If this checkbox is not selected and the record UDR contains an invalid value the workflow will be aborted.

Agent Transaction Behaviour

The SAP JCo Uploader agent performs some extra maneuvers to ensure that records, for a particular file, that are already committed to the SAP System are skipped if the workflow aborts before the batch is completed successfully.

  1. Records are committed in sub batches. For further information, see the Commit Size setting in the table described under Connection Tab.

  2. For every successful commit, an entry is inserted into the database, consisting of the WF_NAME, FILENAME, START_POSITION and END_POSITION of the sub batches.

  3. If the file is successfully processed, at workflow commit, the agent removes all entries inserted into the database for the current file.

If the workflow aborts before the file is successfully processed, on the next re-run, the agent performs a database lookup, and gets the list of records that are already processed. Record numbers that are found in the database are skipped.
For information about the general Usage Engine transaction behavior, see Workflow Monitor (4.3).

Emits

This agent does not emit anything.

Retrieves

Command

Description

Command

Description

Consume

As this agents's action depends on the data of the HeaderUDR, nothing is done in BeginBatch.

Processing begins when the HeaderUDR is received.

This initial consume instance is only when the agent receives the HeaderUDR. The agent gets the RemoteFunction from the SAP System based on the name in the HeaderUDR. This RemoteFunction is used to insert records into the SAP System.

When every RemoteFunction is committed, an entry of stateInfo is inserted into the database.

Commit

Removes all stateInfo data for the file from the database.

Input/Output

Input/Output defined here represents the type of data an agent expects and delivers.

Input

The SAP JCo Uploader agent consumes the following UDRs of the SAP_JCO type:

HeaderUDR

RecordUDR

Output

This agent does not have any output unless the Enable Route Error Handling checkbox is selected, in which case the output is UDRs of type RecordUDR.

Meta Information Model

Publishes

MIM Parameter

Description

MIM Parameter

Description

Average Response Time (long)

The average response time (in milliseconds) for each execution and commit.

No of Executions (long)

The total number of executions towards the SAP System.

Accesses

Agent Message Events

Debug Events

The agent produces the following debug events: 

  • Discard record no <record number> as it has been processed
    Reported when a record is found to have already been processed.