pub:idocsapi
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionLast revisionBoth sides next revision | ||
pub:idocsapi [2021/01/25 12:00] – [ESNDFILE] kkramer | pub:idocsapi [2023/07/25 12:56] – [ESENDFILE] kkramer | ||
---|---|---|---|
Line 1: | Line 1: | ||
< | < | ||
- | + | ====== Programming API's ====== | |
- | + | ||
- | ====== | + | |
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 ===== | ===== IFDUPSPLF ===== | ||
Line 120: | Line 326: | ||
---- | ---- | ||
- | ===== 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. | + | ===== JOINSPLF ===== |
+ | |||
+ | Quick utility // | ||
+ | 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. | ||
< | < | ||
- | Send IFS File to SFTP server | + | Join multiple spool files (JOINSPLF) |
| | ||
Type choices, press Enter. | Type choices, press Enter. | ||
| | ||
- | SFTP server | + | Output Spool Name . . . . . . . > JOINTEST01 |
+ | | ||
+ | | ||
+ | | ||
+ | Spool file name . . . . . . . > R43500 | ||
+ | Spool file number | ||
+ | Job name . . . . . . . . . . . > OFDEMOADD | ||
+ | Job user . . . . . . . . . . > | ||
+ | Job number . . . . . . . . . > | ||
+ | + for more values | ||
| | ||
- | | ||
| | ||
- | | ||
| | ||
- | Port . . . . . . . . . . . . . . | ||
- | IFS Local Path . . . . . . . . . '/ | ||
| | ||
| | ||
| | ||
- | Remote folder | + | |
+ | | ||
+ | | ||
+ | </ | ||
+ | < | ||
+ | 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 ===== | ||
- | SFTP supports 2 methods of authentication: | + | Quick utility //(added 6.99 8/ |
- | * SSH Key authentication | + | Type SETPDFPWD and prompt with F4 to view parameters: |
- | | + | < |
- | Our IBIRDGE utility sends file using SSH Key and sends as a PDF file only | + | Set PDF password (SETPDFPWD) |
+ | |||
+ | Type choices, press Enter. | ||
+ | |||
+ | Path to PDF file . . . . . . . . | ||
+ | |||
+ | |||
+ | |||
+ | User 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. | ||
+ | **' | ||
+ | **' | ||
- | ESNDFILE sends file using Password authentication: the server | + | **How the command works:**\\ |
+ | {{: | ||
+ | |||
+ | //User Password// will restrict | ||
+ | //Owner Password// will restrict | ||
+ | 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/ | ||
- | **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: \\ | ||
- | {{: | ||
- | ---- | ||
< | < | ||
pub/idocsapi.txt · Last modified: 2023/07/25 13:08 by kkramer