pub:idocsapi
Differences
This shows you the differences between two versions of the page.
Next revision | Previous revision | ||
pub:idocsapi [2018/05/24 16:06] – external edit 127.0.0.1 | pub:idocsapi [2023/07/25 13:08] (current) – [ESENDFILE] kkramer | ||
---|---|---|---|
Line 1: | Line 1: | ||
< | < | ||
- | + | ====== Programming API' | |
- | + | ||
- | ====== | + | |
iDocs has various methods to automatically print forms that are deposited in output queues. | iDocs has various methods to automatically print forms that are deposited in output queues. | ||
Line 73: | Line 70: | ||
---- | ---- | ||
+ | ====== UTILITIES ====== | ||
+ | |||
+ | ===== EHTM2CSV ===== | ||
+ | |||
+ | Quick utility //(added 6.99 1/ | ||
+ | |||
+ | < | ||
+ | |||
+ | | ||
+ | | ||
+ | Type choices, press Enter. | ||
+ | | ||
+ | HTML file path . . . . . . . . . > '/ | ||
+ | | ||
+ | | ||
+ | CSV file path . . . . . . . . . > '/ | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | </ | ||
+ | |||
+ | 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. | ||
+ | |||
+ | ---- | ||
+ | |||
+ | ===== ESENDFILE ===== | ||
+ | |||
+ | A new command ESENDFILE is introduced in iDocs 8.00 to send a DB2 file from AS/400 server to a remote AS400 server. | ||
+ | < | ||
+ | Send DB2 file to remote server (ESENDFILE) | ||
+ | | ||
+ | Type choices, press Enter. | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | iDocs lib name on remote servr | ||
+ | DB2 file on source system | ||
+ | | ||
+ | DB2 file on remote system | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | </ | ||
+ | |||
+ | **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 | ||
+ | Restore file on remote server | ||
+ | |||
+ | |||
+ | 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 | ||
+ | |||
+ | ---- | ||
+ | ===== ESNDFILE ===== | ||
+ | |||
+ | A new command ESNDFILE is introduced in iDocs 6.97 to send a file or folder from the IBM i to a SFTP server using Password authentication. | ||
+ | < | ||
+ | Send IFS File to SFTP server (ESNDFILE) | ||
+ | | ||
+ | Type choices, press Enter. | ||
+ | | ||
+ | SFTP server | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | Port . . . . . . . . . . . . . . | ||
+ | IFS Local Path . . . . . . . . . '/ | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | </ | ||
+ | |||
+ | SFTP supports 2 methods of authentication: | ||
+ | |||
+ | * SSH Key authentication | ||
+ | * Password authentication | ||
+ | Our [[start# | ||
+ | |||
+ | ESNDFILE sends file using Password authentication: | ||
+ | |||
+ | **Parameters: | ||
+ | SFTP server \\ | ||
+ | Authentication User ID \\ | ||
+ | Job name/User Name/ Job Number: job ID of input spool \\ | ||
+ | Authentication Password \\ | ||
+ | Port number \\ | ||
+ | IFS local path \\ | ||
+ | Remote folder \\ | ||
+ | Overwrite (Y/N) \\ | ||
+ | |||
+ | |||
+ | Result on SFTP Server: \\ | ||
+ | {{: | ||
+ | |||
+ | ---- | ||
+ | ===== ICOMDBMAP ===== | ||
+ | |||
+ | To evoke the merge process of one, two, or three Database Mapped Form Application(s), | ||
+ | < | ||
+ | | ||
+ | | ||
+ | Type choices, press Enter. | ||
+ | | ||
+ | Main Application . . . . . . . . | ||
+ | | ||
+ | Third Application | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | </ | ||
+ | |||
+ | **Parameters: | ||
+ | |||
+ | **MAINAPP** = The first Form Application to be merged. | ||
+ | **SECONDAPP** = The second Form Application to be merged. | ||
+ | **THIRDAPP** = The Third Form Application to be merged. | ||
+ | **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: | ||
+ | < | ||
+ | | ||
+ | | ||
+ | Type choices, press Enter. | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | Job name . . . . . . . . . . . . | ||
+ | Job description | ||
+ | | ||
+ | Job queue . . . . . . . . . . . | ||
+ | | ||
+ | Job priority (on JOBQ) . . . . . | ||
+ | | ||
+ | Print device . . . . . . . . . . | ||
+ | | ||
+ | More... | ||
+ | | ||
+ | | ||
+ | </ | ||
+ | |||
+ | ---- | ||
+ | |||
+ | ===== 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. | ||
+ | < | ||
+ | | ||
+ | |||
+ | Type choices, press Enter. | ||
+ | |||
+ | | ||
+ | | ||
+ | Job name . . . . . . . . . . . . > ANGUYENA | ||
+ | User Name . . . . . . . . . . > | ||
+ | Job Number . . . . . . . . . . > | ||
+ | | ||
+ | | ||
+ | New SPLF user data . . . . . . . | ||
+ | New SPLF form type . . . . . . . | ||
+ | New SPLF name . . . . . . . . . | ||
+ | New SPLF Owner . . . . . . . . . > OFERRER | ||
+ | Hold new SPLF . . . . . . . . . | ||
+ | Page range: | ||
+ | | ||
+ | | ||
+ | |||
+ | | ||
+ | | ||
+ | | ||
+ | </ | ||
+ | |||
+ | **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/ | ||
+ | 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/ | ||
+ | |||
+ | ---- | ||
+ | |||
+ | ===== JOINSPLF ===== | ||
+ | |||
+ | Quick utility //(added 6.97 7/ | ||
+ | Here is how it works: \\ | ||
+ | - Give the new spool file a name in the ' | ||
+ | - Assign the out queue to insert the newly combined spool file with the ' | ||
+ | - Then add the spool file information for the spool files that will be combined. | ||
+ | - Once evoked, the command will stitch together the spool files and write the new spool file to the destination out queue. | ||
+ | |||
+ | < | ||
+ | Join multiple spool files (JOINSPLF) | ||
+ | | ||
+ | Type choices, press Enter. | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | Spool file name . . . . . . . > R43500 | ||
+ | Spool file number | ||
+ | Job name . . . . . . . . . . . > OFDEMOADD | ||
+ | Job user . . . . . . . . . . > | ||
+ | Job number . . . . . . . . . > | ||
+ | + for more values | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | </ | ||
+ | < | ||
+ | Specify More Values for Parameter SPLF | ||
+ | | ||
+ | Type choices, press Enter. | ||
+ | | ||
+ | | ||
+ | Spool file name . . . . . . . > R43500 | ||
+ | Spool file number | ||
+ | Job name . . . . . . . . . . . > OFDEMOADD | ||
+ | Job user . . . . . . . . . . > | ||
+ | Job number . . . . . . . . . > | ||
+ | | ||
+ | Spool file name . . . . . . . | ||
+ | Spool file number | ||
+ | Job name . . . . . . . . . . . | ||
+ | Job user . . . . . . . . . . | ||
+ | Job number . . . . . . . . . | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | More... | ||
+ | | ||
+ | | ||
+ | |||
+ | </ | ||
+ | ===== PDFCOMBINE ===== | ||
+ | |||
+ | Quick utility //(added 6.99 2/ | ||
+ | * Down-level users can obtain this feature by downloading the following savefile: [[ftp:// | ||
+ | After uploading, see a save file PDFCOMBINE.SAVF and ifdjava.jar: | ||
+ | * Put PDFCOMBINE.SAVF into QGPL and restore it, they will see a *CMD object and a *PGM object with same name PDFCOMBINE | ||
+ | * Put ifdjava.jar into / | ||
+ | \\ | ||
+ | **(EXHIBIT A)** | ||
+ | < | ||
+ | |||
+ | | ||
+ | | ||
+ | Type choices, press Enter. | ||
+ | | ||
+ | Input PDF files/ | ||
+ | | ||
+ | > '/ | ||
+ | | ||
+ | > '/ | ||
+ | | ||
+ | > '/ | ||
+ | | ||
+ | + for more values > '/ | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | </ | ||
+ | **(EXHIBIT B)** | ||
+ | < | ||
+ | | ||
+ | | ||
+ | Type choices, press Enter. | ||
+ | | ||
+ | Input PDF files/ | ||
+ | | ||
+ | + for more values | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | </ | ||
+ | ===== SETPDFPWD ===== | ||
+ | |||
+ | Quick utility //(added 6.99 8/ | ||
+ | |||
+ | Type SETPDFPWD and prompt with F4 to view parameters: | ||
+ | < | ||
+ | Set PDF password (SETPDFPWD) | ||
+ | | ||
+ | Type choices, press Enter. | ||
+ | | ||
+ | Path to PDF file . . . . . . . . | ||
+ | | ||
+ | | ||
+ | | ||
+ | User Password | ||
+ | | ||
+ | | ||
+ | Owner Password . . . . . . . . . | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | </ | ||
+ | **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. | ||
+ | **' | ||
+ | **' | ||
+ | |||
+ | **How the command works:**\\ | ||
+ | {{: | ||
+ | |||
+ | //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.\\ | ||
+ | Example Table: \\ | ||
+ | {{: | ||
+ | {{: | ||
+ | |||
+ | **NOTE:**\\ | ||
+ | Need to install IFDJAVA.JAR file as of 08/12/2022 \\ | ||
+ | The SETPDFPWD API must be registered for use. | ||
+ | |||
+ | ===== SPLCOMBINE ===== | ||
+ | |||
+ | Quick utility //(added 6.99 3/ | ||
+ | < | ||
+ | | ||
+ | | ||
+ | Type choices, press Enter. | ||
+ | | ||
+ | | ||
+ | | ||
+ | To Output Queue . . . . . . . . | ||
+ | | ||
+ | To SPLF user data . . . . . . . | ||
+ | To SPLF form type . . . . . . . | ||
+ | To SPLF name . . . . . . . . . . | ||
+ | To SPLF Owner . . . . . . . . . | ||
+ | Hold new SPLF . . . . . . . . . | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | </ | ||
+ | |||
+ | **Source output queue:** all SCS/ | ||
+ | |||
+ | |||
+ | |||
< | < | ||
pub/idocsapi.1527203199.txt.gz · Last modified: 2022/06/25 17:02 (external edit)