HCL Workload Automation, Version 9.4

Events matching criteria

Table 1 lists the HCL Workload Automation fields corresponding to the fields in the IDoc record that you want to search. During monitoring, each IDoc matching the search criteria generates an event that is sent to HCL Workload Automation.
Table 1. HCL Workload Automation fields used to define event rules based on IDocs
Composer property Console property IDoc field
SAPClient SAP client MANDT
SAPIDocStatus Status STATUS
SAPDirectionIDocTransmission Direction DIRECT
SAPReceiverPort Receiver port RCVPOR
SAPReceiverPartnerFunction Receiver partner function RCVPFC
SAPReceiverPartnerType Receiver partner type RCVPRT
SAPReceiverPartnerNumber Receiver partner number RCVPRN
SAPSenderPort Sender port SNDPOR
SAPSenderPartnerType Sender partner type SNDPRT
SAPSenderPartnerFunction Sender partner function SNDPFC
SAPSenderPartnerNumber Sender partner number SNDPRN
SAPLogicalMessageType Logical message type MESTYP
SAPNameOfBasicType Name of basic type IDOCTP
SAPLogicalMessageCode Logical message code MESCOD
SAPLogicalMessageFunction Logical message function MESFCT
SAPTestFlag Test flag TEST
SAPOutputMode Output mode OUTMOD
Optionally, you can define also correlation rules by using the fields listed in Table 2. Date and time values are specified in GMT time zone.
Table 2. HCL Workload Automation fields used to define correlation rules for IDoc events
Composer property Console property IDoc field
SAPIDocNumber IDoc number DOCNUM
SAPReleaseForIDoc IDoc SAP release DOCREL
SAPIDocType IDoc type DOCTYP
SAPReceiverAddress Receiver SADR address RCVSAD
SAPReceiverSADRClient Receiver SADR client RCVSMN
SAPFlagForInternationalReceiverAddress Receiver SADR flag RCVSNA
SAPReceiverCommunicationType Receiver SADR communication type RCVSCA
SAPDefaultFlagForReceiverAddress Receiver SADR default flag RCVSDF
SAPReceiverAddressSequentialNumber Receiver SADR sequential number RCVSLF
SAPReceiverLogicalAddress Receiver logical address RCVLAD
SAPEDIStandard EDI Standard STD
SAPEDIStandardVersion EDI standard version STDVRS
SAPEDIMessageType EDI message type STDMES
SAPSenderAddress Sender SADR address SNDSAD
SAPSenderSADRClient Sender SADR client SNDSMN
SAPFlagForInternationalSenderAddress Sender SADR flag SNDSNA
SAPSenderCommunicationType Sender SADR communication type SNDSCA
SAPDefaultFlagForSenderAddress Sender SADR default flag SNDSDF
SAPSenderAddressSequentialNumber Sender SADR sequential number SNDSLF
SAPSenderLogicalAddress Sender logical address SNDLAD
SAPReferenceToInterchangeFile Interchange file reference REFINT
SAPReferenceToMessageGroup Message group reference REFGRP
SAPReferenceToMessage Message reference REFMES
SAPEDIArchiveKey EDI archive key ARCKEY
SAPIDocCreationDate IDoc creation date CREDAT
SAPIDocCreationTime IDoc creation time CRETIM
SAPExtension Extension CIMTYP
SAPEDIALESerializationField EDI/ALE Serialization field SERIAL
SAPOverridingInInboundProcessing Overriding in inbound processing EXPRSS
SAPIDocChangeDate IDoc last update date UPDDAT
SAPIDocChangeTime IDoc last update time UPDTIM

Based on the defined rule, the r3evmon process of HCL Workload Automation monitors the events related to IDoc records according to a polling rate. To customize this polling rate, use the evmon_interval option; for details, see Defining the common options.

Table 3 lists the values that you can specify as attribute filter name when defining the event condition.
Table 3. Parameters of IDOCEventGenerated event type
Property name Description Type Filtering allowed Required Multiple values allowed Wildcard allowed Length (min-max)
SAPClient SAP client number numeric (0-9)   1 3
SAPIDocStatus IDoc status information

For a list of allowed values, refer to Table 4 and Table 5.

numeric   1 2
SAPDirectionIDocTransmission IDoc direction numeric

Value can be 1 (outbound) or 2 (inbound).

    1 1
SAPReceiverPort Receiver port. SAP system, EDI subsystem string       1 10
SAPReceiverPartnerFunction Partner function of receiver string       1 2
SAPReceiverPartnerType Partner type of receiver string       1 2
SAPReceiverPartnerNumber Partner number of receiver string       1 10
SAPSenderPort Sender port. SAP system, EDI subsystem string       1 10
SAPSenderPartnerType Partner type of sender string       1 2
SAPSenderPartnerFunction Partner function of sender string       1 2
SAPSenderPartnerNumber Partner number of sender string       1 10
SAPLogicalMessageType Logical message type string     1 30
SAPNameOfBasicType Name of basic type string     1 30
SAPLogicalMessageCode Logical message code string       1 3
SAPLogicalMessageFunction Logical message function string       1 3
SAPTestFlag Test flag string       1 1
SAPOutputMode Output Mode string

Value can be 2 (immediate sending) or 4 (collected sending).

      1 1
Table 4 lists the standard outbound IDoc statuses and Table 5 lists the standard inbound IDoc statuses. Optionally, you can activate a check to prevent event rule definitions with inconsistent IDoc status list and direction. If you activate the check and specify inconsistent values when defining a rule (for example, 02 as status and 2 as direction), you receive an error message and you cannot save the rule definition. To activate the check, perform the following steps:
  1. In the TWS_home/eventPlugIn directory, create the SapMonitorPlugIn.properties file.
  2. Edit SapMonitorPlugIn.properties to set the following configuration property:
    TWSPlugIn.event.idoc.consistency.check = true
  3. From conman, stop and restart the event processing server by using, respectively, the stopeventprocessor and starteventprocessor commands.
The default value is false.
To have predictable event action results, when defining event rules consider using only non-transitory statuses that allow user checks.
Table 4. Standard outbound IDoc statuses
Status Description
01 IDoc generated
02 Error passing data to port
03 Data passed to port
04 Error within control information of EDI subsystem
05 Error during translation
06 Translation
07 Error during syntax check
08 Syntax check
09 Error during interchange
10 Interchange handling
11 Error during dispatch
12 Dispatch OK
13 Retransmission OK
14 Interchange acknowledgement positive
15 Interchange acknowledgement negative
16 Functional acknowledgement positive
17 Functional acknowledgement negative
18 Triggering EDI subsystem OK
19 Data transfer for test OK
20 Error triggering EDI subsystem
22 Dispatch OK, acknowledgement still due
23 Error during retransmission
24 Control information of EDI subsystem OK
25 Processing despite syntax error
26 Error during syntax check of IDoc
27 Error in dispatch level (ALE service)
29 Error in ALE service
30 IDoc ready for dispatch (ALE service)
31 Error no further processing
32 IDoc was edited
33 Original of an IDoc which was edited
34 Error in control record of IDoc
36 Electronic signature not performed (timeout)
37 IDoc added incorrectly
38 IDoc archived
39 IDoc is in the target system (ALE service)
40 Application document not created in target system
41 Application document created in target system
42 IDoc was created by test transaction
Table 5. Standard inbound IDoc statuses
Status Description
50 IDoc added
51 Application document not posted
52 Application document not fully posted
53 Application document posted
54 Error during formal application check
55 Formal application check OK
56 IDoc with errors added
57 Error during application check
58 IDoc copy from R/2 connection
60 Error during syntax check of IDoc
61 Processing despite syntax error
62 IDoc passed to application
63 Error passing IDoc to application
64 IDoc ready to be transferred to application
65 Error in ALE service
66 IDoc is waiting for predecessor IDoc (serialization)
68 Error - no further processing
69 IDoc was edited
70 Original of an IDoc which was edited
71 IDoc reloaded from archive
73 IDoc archived
74 IDoc was created by test transaction
For example, you define a rule with the following attributes:
A dynamic agent named SAPCPU
SAP client number
IDoc status list
IDoc direction
2 (inbound)
After saving the rule according to these settings, when the rule becomes active a file named SAPCPU_r3evmon.cfg is created on SAPCPU. It contains the following !IDOC keyword:
!IDOC 0003001000556,600001200000000000000000000000000000000000000000000000000000000

IDoc monitoring is automatically started. When the event condition is verified, the action defined in the rule is triggered

For an explanation of the !IDOC keyword format, refer to Table 1.