Differences

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

--- pub:idocsapi [2022/08/25 19:04] – kkramer
+++ pub:idocsapi [2025/03/10 19:15] (current) – [ICOMDBMAP] kkramer
@@ Line 1: / Line 1: @@
 <html>&#091;</html>[[start#idocs | Up to Main Menu ]]<html>&#093;</html>
-====== iDocs API's and Utilities ======
 ====== Programming API's ======
@@ Line 75: / Line 71: @@
 ----
 ====== UTILITIES ======
-===== IFDUPSPLF =====
-Quick utility to duplicate a SCS spool file and change the owner on the new file. Original and new owner must both reside in the System Directory. This command was named DUPSPLF initially but changed to IFDUPSPLF in version 6.83 to ensure that it’s unique on all customer systems.
+===== EHTM2CSV =====
+Quick utility //(added 6.99 1/11/2022)// to convert HTML files into CSV file format. EHTM2CSV program and command; includes an updated IFDJAVA.JAR file.
 <html><pre>
-                   Duplicate iSeries Spooled File (IFDUPSPLF)
+                         Convert HTML to CSV (EHTM2CSV)
- Type choices, press Enter.
+ Type choices, press Enter.
- Spooled file . . . . . . . . . . > INV           Name
- Spooled file number  . . . . . . > 2             1-999999, *ONLY, *LAST
+ HTML file path . . . . . . . . . > '/home/anguyen/htm2csv/Order.htm'
- Job name . . . . . . . . . . . . > ANGUYENA      Name, *, *ALL
-   User Name  . . . . . . . . . . >   ANGUYEN     Name
-   Job Number . . . . . . . . . . >   106730      000000-999999
+ CSV file path  . . . . . . . . . > '/home/anguyen/htm2csv/Order.csv'
- Output Queue . . . . . . . . . .   QPRINT        Name
-   Library  . . . . . . . . . . .     *LIBL       Name, *LIBL
- New SPLF user data . . . . . . .   *SAME         Character value, *SAME
+ Charset  . . . . . . . . . . . . > 'UTF-8'
- New SPLF form type . . . . . . .   *SAME         Character value, *SAME
- New SPLF name  . . . . . . . . .   *SAME         Name, *SAME
- New SPLF Owner . . . . . . . . . > OFERRER       Name, *SAME
- Hold new SPLF  . . . . . . . . .   *NO           *YES, *NO
- Page range:
-   Starting page  . . . . . . . .   1             Number
-   Ending page  . . . . . . . . .   *END          Number, *END
-                                                                         Bottom
- F3=Exit   F4=Prompt   F5=Refresh   F12=Cancel   F13=How to use this display
+                                                                         Bottom
- F24=More keys
+ F3=Exit   F4=Prompt   F5=Refresh   F12=Cancel   F13=How to use this display
+ F24=More keys
 </pre></html>
-**Parameters:**
+Type command EHTM2CSV and prompt with F4\\
+HTML file path: Enter the path to pick up the HTML File.\\
+CSV file path: Enter the path to place the .csv file.\\
+Charset: UTF-8 is default (F4 for options).\\
+[Enter] to execute.
-Spooled file: input spool file name \\
+----
-Spooled file number: input spool file number \\
-Job name/User Name/ Job Number: job ID of input spool \\
-Output Queue/Library: name and library of output queue \\
+===== ESENDFILE =====
-New SPLF user data: enter user data of output spool file (*SAME to retain the same attribute of input spool file) \\
-New SPLF form type: enter form type of output spool file  (*SAME to retain the same attribute of input spool file)\\
-New SPLF name: enter spool file name of output spool file  (*SAME to retain the same attribute of input spool file\\
-Hold new SPLF: Hold the output spool file name\\
-Page range: enter the range of pages of input spool file name\\
-**Example:**
+A new command ESENDFILE is introduced in iDocs 8.00 to send a DB2 file from AS/400 server to a remote AS400 server.
+<html><pre>
+                   Send DB2 file to remote server (ESENDFILE)
+ Type choices, press Enter.
+ Remote hostname  . . . . . . . .   '172.16.1.55'
+ Username . . . . . . . . . . . .   USER
+ Password . . . . . . . . . . . .   password
+ iDocs lib name on remote servr     IDOCS800      Character value
+ DB2 file on source system  . . .   FRMTMULH      Name
+   Library  . . . . . . . . . . .     IDOCS6B     Name, *CURLIB
+ DB2 file on remote system  . . .   TESTCSV1      Name
+   Library  . . . . . . . . . . .     USERLIB     Name, *CURLIB
+ Overwrite file on remote servr     *NO           *YES, *NO, *YES, *NO
+ Restore file on remote server  .   *YES          *YES, *NO, *YES, *NO
+                                                                         Bottom
+ F3=Exit   F4=Prompt   F5=Refresh   F12=Cancel   F13=How to use this display
+ F24=More keys
+</pre></html>
-IFDUPSPLF FILE(INV) SPLNBR(2) JOB(106730/ANGUYEN/ANGUYENA) OWNER(OFERRER)
+**Parameters:** \\
+Remote hostname\\
+User ID \\
+Authentication Password \\
+iDocs lib name on remote server  \\
+DB2 file on source system library \\
+DB2 file on remote system library \\
+Overwrite file on remote server  (*YES/*NO) \\
+Restore file on remote server  (*YES/*NO) \\
+Command ESENDFILE will perform the following steps:
+  * Executes iDocs command CNVDB2XML to convert DB2 to a temporary .xml file on source server
+  * Sends this .xml file to remote server
+  * Calls remote command CNVXML2DB on remote server to restore .xml file to DB2 file. (The command CNVXML2DB is stored on ‘iDocs lib name on remote server’)
+  * User can input the name of DB2 file on remote server.
+  * User can overwrite existing data or append them into remote DB2 file
 ----
@@ Line 172: / Line 210: @@
 Result on SFTP Server: \\
 {{:pub:idocs:esndfile001.png?600|}}
 ----
+===== ICOMDBMAP =====
+To evoke the merge process of one, two, or three Database Mapped Form Application(s), and aggregate the output to a desired out queue or trigger Smart Routing settings. The ICOMDBMAP command can be used interactively or submitted into a job (SEE EXAMPLE BELOW). (Added iDOCS 8.0 05/10/2023)
-===== EHTM2CSV =====
-Quick utility //(added 6.99 1/11/2022)// to convert HTML files into CSV file format. EHTM2CSV program and command; includes an updated IFDJAVA.JAR file.
 <html><pre>
+                   Combine database map-File name (ICOMDBMAP)
-                         Convert HTML to CSV (EHTM2CSV)
  Type choices, press Enter.
- HTML file path . . . . . . . . . > '/home/anguyen/htm2csv/Order.htm'
+ Main Application . . . . . . . .                 Name
+ Second Application . . . . . . .   *NONE         Name *NONE
+ Third Application  . . . . . . .                 NAME *NONE
+ Output Queue . . . . . . . . . .                 Name
- CSV file path  . . . . . . . . . > '/home/anguyen/htm2csv/Order.csv'
- Charset  . . . . . . . . . . . . > 'UTF-8'
@@ Line 204: / Line 239: @@
  F3=Exit   F4=Prompt   F5=Refresh   F12=Cancel   F13=How to use this display
  F24=More keys
 </pre></html>
-Type command EHTM2CSV and prompt with F4\\
+**Parameters:**
-HTML file path: Enter the path to pick up the HTML File.\\
-CSV file path: Enter the path to place the .csv file.\\
+**MAINAPP** = The first Form Application to be merged.  This Form Application will determine the output for all the Form Applications being used if using Smart Routing settings. \\
-Charset: UTF-8 is default (F4 for options).\\
+**SECONDAPP** = The second Form Application to be merged.  If not using a second Form Application, then use *NONE as the value.\\
-[Enter] to execute.
+**THIRDAPP** = The Third Form Application to be merged.  If not using a second Form Application, then use *NONE as the value.\\
+**OUTQ** = This will be the value for the destination of the output into an out queue or the triggering for Smart Routing by using *FORMDEF as the value. \\
+**Example:**
+<html><pre>
+                               Submit Job (SBMJOB)
+ Type choices, press Enter.
+ Command to run . . . . . . . . .   ICOMDBMAP MAINAPP(CYBERLTR) SECONDAPP(*NONE)
+ THIRDAPP(*NONE) OUTQ(*FORMDEF)
+                                                                     ...
+ Job name . . . . . . . . . . . .   ICOMDBTEST    Name, *JOBD
+ Job description  . . . . . . . .   *USRPRF       Name, *USRPRF
+   Library  . . . . . . . . . . .                 Name, *LIBL, *CURLIB
+ Job queue  . . . . . . . . . . .   FMGJOBQ       Name, *JOBD
+   Library  . . . . . . . . . . .                 Name, *LIBL, *CURLIB
+ Job priority (on JOBQ) . . . . .   *JOBD         1-9, *JOBD
+ Output priority (on OUTQ)  . . .   *JOBD         1-9, *JOBD
+ Print device . . . . . . . . . .   *CURRENT      Name, *CURRENT, *USRPRF...
+                                                                        More...
+ F3=Exit   F4=Prompt   F5=Refresh   F10=Additional parameters   F12=Cancel
+ F13=How to use this display        F24=More keys
+ </pre></html>
+**NOTE: **
+(iDOCS 8.0 02/26/2025) With this enhancement you can control the aggregation sequence of merging multiple spool files.
+  * If the newly added IFDSPLDESC Data Area is set to ‘Y’, the aggregation process is identical to the older (pre-V8.0) logic merging multiple spool files in descending order.
+  * If the IFDSPLDESC Data Area is set to blank (default) or ‘N’, the aggregation process will merge the spool files in ascending order.
+----
+===== IFDUPSPLF =====
+Quick utility to duplicate a SCS spool file and change the owner on the new file. Original and new owner must both reside in the System Directory. This command was named DUPSPLF initially but changed to IFDUPSPLF in version 6.83 to ensure that it’s unique on all customer systems.
+<html><pre>
+                   Duplicate iSeries Spooled File (IFDUPSPLF)
+ Type choices, press Enter.
+ Spooled file . . . . . . . . . . > INV           Name
+ Spooled file number  . . . . . . > 2             1-999999, *ONLY, *LAST
+ Job name . . . . . . . . . . . . > ANGUYENA      Name, *, *ALL
+   User Name  . . . . . . . . . . >   ANGUYEN     Name
+   Job Number . . . . . . . . . . >   106730      000000-999999
+ Output Queue . . . . . . . . . .   QPRINT        Name
+   Library  . . . . . . . . . . .     *LIBL       Name, *LIBL
+ New SPLF user data . . . . . . .   *SAME         Character value, *SAME
+ New SPLF form type . . . . . . .   *SAME         Character value, *SAME
+ New SPLF name  . . . . . . . . .   *SAME         Name, *SAME
+ New SPLF Owner . . . . . . . . . > OFERRER       Name, *SAME
+ Hold new SPLF  . . . . . . . . .   *NO           *YES, *NO
+ Page range:
+   Starting page  . . . . . . . .   1             Number
+   Ending page  . . . . . . . . .   *END          Number, *END
+                                                                         Bottom
+ F3=Exit   F4=Prompt   F5=Refresh   F12=Cancel   F13=How to use this display
+ F24=More keys
+</pre></html>
+**Parameters:**
+Spooled file: input spool file name \\
+Spooled file number: input spool file number \\
+Job name/User Name/ Job Number: job ID of input spool \\
+Output Queue/Library: name and library of output queue \\
+New SPLF user data: enter user data of output spool file (*SAME to retain the same attribute of input spool file) \\
+New SPLF form type: enter form type of output spool file  (*SAME to retain the same attribute of input spool file)\\
+New SPLF name: enter spool file name of output spool file  (*SAME to retain the same attribute of input spool file\\
+Hold new SPLF: Hold the output spool file name\\
+Page range: enter the range of pages of input spool file name\\
+**Example:**
+IFDUPSPLF FILE(INV) SPLNBR(2) JOB(106730/ANGUYEN/ANGUYENA) OWNER(OFERRER)
+----
 ===== JOINSPLF =====
@@ Line 333: / Line 454: @@
 </pre></html>
-===== SPLCOMBINE =====
-Quick utility //(added 6.99 3/11/2022)// has been created to combine all *SCS/*AFPDS spool files in an output queue.
-<html><pre>
-                       Combine multiple splfs (SPLCOMBINE)
- Type choices, press Enter.
- Source Output Queue  . . . . . .                 Name
-   Library  . . . . . . . . . . .     *LIBL       Name, *LIBL
- To Output Queue  . . . . . . . .                 Name
-   Library  . . . . . . . . . . .     *LIBL       Name, *LIBL
- To SPLF user data  . . . . . . .                 Character value, *FIRST...
- To SPLF form type  . . . . . . .                 Character value, *STD...
- To SPLF name . . . . . . . . . .   *FIRST        Name, *FIRST, *LAST
- To SPLF Owner  . . . . . . . . .   *CURRENT      Name, *CURRENT, *FIRST
- Hold new SPLF  . . . . . . . . .   *NO           *YES, *NO
-                                                                         Bottom
- F3=Exit   F4=Prompt   F5=Refresh   F12=Cancel   F13=How to use this display
- F24=More keys
-</pre></html>
-**Source output queue:** all SCS/AFPDS in this output queue will be combined into a single spool file and outputted to **'To Output Queue'** with the other spool attributes are specified in **'To' fields**-
 ===== SETPDFPWD =====
@@ Line 394: / Line 484: @@
  F24=More keys
 </pre></html>
+**Parameters:**\\
-**Path to PDF file:** This is the location where the PDF file is located on the IFS.  It is also the location where the PDF file will be placed after being processed.  The PDF file will retain the original file name.
+**Path to PDF file:** This is the location where the PDF file is located on the IFS.  It is also the location where the PDF file will be placed after being processed.  The PDF file will retain the original file name.\\
-**'User Password:'** This parameter will set the User Password.
+**'User Password:'** This parameter will set the User Password.\\
-**'Owner Password:'** This parameter will set the Owner Password.
+**'Owner Password:'** This parameter will set the Owner Password.\\
+**How the command works:**\\
+{{:pub:idocs:setpdfpwd_Password.jpg?600|}}
-How the command works:\\
-See the example table below for the different configuration options and the expected results.\\
 //User Password// will restrict the PDF to be open with the //User Password// value and will restrict the PDF’s security.\\
 //Owner Password// will restrict the PDF to be open with the //Owner Password// value and will NOT restrict the PDF’s security.\\
 When both //User Password// and //Owner Password// are used both options will apply.
+See the example table below for the different configuration options and the expected results.\\
-Results: \\
+Example Table: \\
 {{:pub:idocs:setpdfpwd_results.jpg?600|}}
+{{:pub:idocs:setpdfpwd_Security.jpg?600|}}
-NOTE:\\
+**NOTE:**\\
 Need to install IFDJAVA.JAR file as of 08/12/2022 \\
-API must be registered for use.
+The SETPDFPWD API must be registered for use.
+===== SPLCOMBINE =====
+Quick utility //(added 6.99 3/11/2022)// has been created to combine all *SCS/*AFPDS spool files in an output queue.
+<html><pre>
+                       Combine multiple splfs (SPLCOMBINE)
+ Type choices, press Enter.
+ Source Output Queue  . . . . . .                 Name
+   Library  . . . . . . . . . . .     *LIBL       Name, *LIBL
+ To Output Queue  . . . . . . . .                 Name
+   Library  . . . . . . . . . . .     *LIBL       Name, *LIBL
+ To SPLF user data  . . . . . . .                 Character value, *FIRST...
+ To SPLF form type  . . . . . . .                 Character value, *STD...
+ To SPLF name . . . . . . . . . .   *FIRST        Name, *FIRST, *LAST
+ To SPLF Owner  . . . . . . . . .   *CURRENT      Name, *CURRENT, *FIRST
+ Hold new SPLF  . . . . . . . . .   *NO           *YES, *NO
+                                                                         Bottom
+ F3=Exit   F4=Prompt   F5=Refresh   F12=Cancel   F13=How to use this display
+ F24=More keys
+</pre></html>
+**Source output queue:** all SCS/AFPDS in this output queue will be combined into a single spool file and outputted to **'To Output Queue'** with the other spool attributes are specified in **'To' fields**-
 <html>&#091;</html>[[start#idocs | Up to Main Menu ]]<html>&#093;</html>