pub:idocsapi
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
pub:idocsapi [2022/08/25 19:04] – kkramer | pub:idocsapi [2025/03/10 19:15] (current) – [ICOMDBMAP] kkramer | ||
---|---|---|---|
Line 1: | Line 1: | ||
< | < | ||
- | |||
- | |||
- | |||
- | ====== iDocs API's and Utilities ====== | ||
====== Programming API's ====== | ====== Programming API's ====== | ||
Line 75: | Line 71: | ||
---- | ---- | ||
====== UTILITIES ====== | ====== UTILITIES ====== | ||
- | ===== IFDUPSPLF ===== | ||
- | Quick utility to duplicate a SCS spool file and change the owner on the new file. Original | + | ===== EHTM2CSV ===== |
+ | |||
+ | Quick utility | ||
< | < | ||
- | | + | |
- | | + | |
- | Type choices, press Enter. | + | |
- | | + | Type choices, press Enter. |
- | Spooled | + | |
- | Spooled | + | HTML file path . . . . . . . . . > '/ |
- | Job name . . . . . . . . . . . . > ANGUYENA | + | |
- | User Name . . . . . . . . . . > | + | |
- | Job Number | + | |
- | Output Queue . . . . . . . . . . | + | |
- | Library | + | |
- | New SPLF user data . . . . . . . | + | |
- | New SPLF form type . . . . . . . | + | |
- | New SPLF name . . . . . . . . . | + | |
- | New SPLF Owner . . . . . . . . . > OFERRER | + | |
- | Hold new SPLF . . . . . . . . . | + | |
- | Page range: | + | |
- | | + | |
- | | + | |
- | | + | |
- | | + | |
- | | + | |
- | | + | |
+ | | ||
</ | </ | ||
- | **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/ | + | ===== 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. |
+ | < | ||
+ | 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 | ||
+ | | ||
+ | | ||
+ | | ||
+ | |||
+ | |||
+ | |||
+ | | ||
+ | | ||
+ | | ||
+ | |||
+ | </ | ||
- | IFDUPSPLF FILE(INV) SPLNBR(2) JOB(106730/ | + | **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 | ||
---- | ---- | ||
Line 172: | Line 210: | ||
Result on SFTP Server: \\ | Result on SFTP Server: \\ | ||
{{: | {{: | ||
+ | |||
---- | ---- | ||
+ | ===== ICOMDBMAP ===== | ||
- | + | To evoke the merge process of one, two, or three Database Mapped Form Application(s), and aggregate the output | |
- | ===== 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. | + | |
< | < | ||
- | + | | |
- | | + | |
| | ||
Type choices, press Enter. | Type choices, press Enter. | ||
| | ||
- | HTML file path . . . . . . . . . > '/ | + | Main Application |
+ | | ||
+ | Third Application | ||
+ | | ||
| | ||
| | ||
- | CSV file path . . . . . . . . . > '/ | ||
| | ||
- | | ||
- | | ||
| | ||
| | ||
Line 204: | Line 239: | ||
| | ||
| | ||
+ | | ||
</ | </ | ||
- | 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. |
- | Charset: UTF-8 is default (F4 for options).\\ | + | **SECONDAPP** = The second Form Application to be merged. |
- | [Enter] | + | **THIRDAPP** = The Third Form Application |
+ | **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... | ||
+ | | ||
+ | | ||
+ | </ | ||
+ | |||
+ | **NOTE: ** | ||
+ | (iDOCS | ||
+ | * 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. | ||
+ | < | ||
+ | | ||
+ | |||
+ | 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 | ||
+ | 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 ===== | ===== JOINSPLF ===== | ||
Line 333: | Line 454: | ||
| | ||
</ | </ | ||
- | ===== 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/ | ||
- | |||
===== SETPDFPWD ===== | ===== SETPDFPWD ===== | ||
Line 394: | Line 484: | ||
| | ||
</ | </ | ||
- | + | **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. | + | **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: | ||
+ | {{: | ||
- | 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.\\ | //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.\\ | //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. | 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: \\ |
{{: | {{: | ||
+ | {{: | ||
- | NOTE:\\ | + | **NOTE:**\\ |
Need to install IFDJAVA.JAR file as of 08/12/2022 \\ | Need to install IFDJAVA.JAR file as of 08/12/2022 \\ | ||
- | API must be registered for use. | + | The SETPDFPWD |
+ | |||
+ | ===== 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.1661479476.txt.gz · Last modified: 2022/08/25 19:04 by kkramer