Differences

This shows you the differences between two versions of the page.

--- pub:workwithmergeengine [2020/04/21 18:26] – [Aggregation options] kkramer
+++ pub:workwithmergeengine [2020/04/22 10:03] – [Aggregation options] kkramer
@@ Line 288: / Line 288: @@
 </pre></html>
- In the Aggregate Setting screen shown above, the user can either specify a custom program (IDOCS 6.95) to handle the business logic of Aggregation or define “Sweep the outputs when”. The custom program will override the definition in “Sweep the outputs when”.
+ In the Aggregate Setting screen shown above, the user can either specify a custom program (IDOCS 6.95) to handle the business logic of Aggregation __or__ define “Sweep the outputs when”. The custom program will override the definition in “Sweep the outputs when”.
-**F13** will assist the user in creating a CL program along with the parameters that the iDocs engine will utilize when calling the the custom program.
+**F13** will assist the user in creating a program along with the parameters that the iDocs engine will utilize when calling the the custom program. A sample CL program is shown below.
+<html><pre>
+/*¹iDocs sample user program for Aggregate engine·                             +
+  ¹Once this program is specified in iDocs aggregate engine,                   +
+  ¹iDocs will call it to check if the aggregate criteria is matched or not,    +
+  ¹if TRUE then &RETURN is 'Y' else &RETURN is blank.                          +
+  ¹                                                                            +
+  ¹Input parameters:                                                           +
+  ¹  - &SPLNAME : SCS spool file name which is being processed by iDocs engine +
+  ¹  - &SPLNBR  : SCS spool file number                                        +
+  ¹  - &JOBNAM  : SCS spool file job name                                      +
+  ¹  - &JOBUSR  : SCS spool file job user                                      +
+  ¹  - &JOBNBR  : SCS spool file job number                                    +
+  ¹                                                                            +
+  ¹Output parameters:                                                          +
+  ¹  - &RETURN  : If this parameter is Y then iDocs will complete the group    +
+ ¹                and aggregate all PCLs in group into 1 PCL                   +
+*/
+             PGM        PARM(&SPLNAME &SPLNBR &JOBNAME &JOBUSER +
+                          &JOBNBR &RETURN)
+             DCL        VAR(&SPLNAME) TYPE(*CHAR) LEN(10)
+             DCL        VAR(&SPLNBR) TYPE(*DEC) LEN(6 0)
+             DCL        VAR(&JOBNAME) TYPE(*CHAR) LEN(10)
+             DCL        VAR(&JOBUSER) TYPE(*CHAR) LEN(10)
+             DCL        VAR(&JOBNBR) TYPE(*CHAR) LEN(6)
+             DCL        VAR(&RETURN) TYPE(*CHAR) LEN(1)
+/*¹If &RETURN is 'Y' then it's end of the spool files group, +
+¹  and iDocs will aggregate the PCL files into 1 PCL·*/
+             ENDPGM
+</pre></html>
 ===== Daisy Chaining Engines  =====