Chapter 2: Developing ODL Applications

Building ODL delivery AIMs

ODL delivery AIMs must define the following functions:

servayt() – provides a response to the SFM when it checks to see if the AIM is active, and identifies the transaction last processed using the lastID file.

For example:
```
int servayt(int [in, flavor] flavor, string [out] *pSerial, int [in]
     sfmFlavor)
```

servproc() – used by the SFM to send a transaction to the delivery AIM.

For example:

int servproc(int [in, flavor] flavor, string [in, out] *pSerial, string

     [in] src, blob [in] dataBuf, string [in] tranid, string [out]

     *errTxt, string [in] fkey, int [in] opts, char [in] priority, int

     [in] sfmFlavor)

In addition, an ODL delivery AIM must provide the return values listed in Table 2-1.

**Table 2-3: Delivery AIM function return values**
Return Value	Description
-1	Do not use a return value of -1, which is reserved by e-Biz Impact.
1+	A return value of 1 or greater indicates a successful DFC service function.
0, less than 0 (except for the reserved value of -1)	A return value of 0 or less than 0 indicates a DFC service function failure. The transaction for that destination remains in a PENDING status and the SFM goes into retry mode to dispatch the transaction again.
-998	Used by servproc() to tell the SFM to skip processing of the current transaction for a particular destination. The transaction is marked as SKIPPED for the destination and is moved to the completed log after the entire transaction is processed.
-999	Used by servproc() to tell the SFM to skip processing of the current transaction for a particular destination. The transaction is marked as CANCELLED for the destination and the entire transaction remains in the PENDING log.

You may want to have a delivery AIM cancel or skip a transaction if it finds an error that transaction production could not catch, such as assigning a duplicate part number. The transaction cannot be processed due to the error, but the delivery AIM that caught the error can continue to receive and process other transactions.

When a delivery AIM cancels or skips a transaction, the SFM marks the transaction for that destination as CANCELLED or SKIPPED. You can repair the suspended transaction using the Global Console. See Monitoring e-Biz Impact for detailed information about monitoring and log file maintenance.

View this book as PDF