pub:idocsapi
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
pub:idocsapi [2022/08/25 18:50] – [SETPDFPWD] kkramer | pub:idocsapi [2023/05/11 13:52] – 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: | ||
---- | ---- | ||
- | ===== IFDUPSPLF | + | ====== UTILITIES ====== |
- | 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 ===== |
- | < | + | |
- | | + | |
- | + | ||
- | 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: | + | |
- | | + | |
- | | + | |
- | + | ||
- | | + | |
- | F3=Exit F4=Prompt | + | |
- | F24=More keys | + | |
- | </ | + | |
- | **Parameters: | + | Quick utility //(added 6.99 1/ |
- | 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 | + | Type choices, press Enter. |
- | New SPLF name: enter spool file name of output spool file | + | |
- | Hold new SPLF: Hold the output spool file name\\ | + | |
- | Page range: enter the range of pages of input spool file name\\ | + | |
+ | | ||
+ | CSV file path . . . . . . . . . > '/ | ||
+ | |||
+ | |||
+ | | ||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | | ||
+ | | ||
+ | F24=More keys | ||
+ | </ | ||
- | **Example:** | + | Type command EHTM2CSV and prompt with F4\\ |
- | + | HTML file path: Enter the path to pick up the HTML File.\\ | |
- | IFDUPSPLF FILE(INV) SPLNBR(2) JOB(106730/ | + | CSV file path: Enter the path to place the .csv file.\\ |
+ | Charset: UTF-8 is default | ||
+ | [Enter] to execute. | ||
---- | ---- | ||
Line 172: | Line 162: | ||
---- | ---- | ||
+ | ===== IFDUPSPLF ===== | ||
- | ===== EHTM2CSV ===== | + | 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: | ||
+ | | ||
+ | | ||
+ | |||
+ | | ||
+ | F3=Exit F4=Prompt | ||
+ | F24=More keys | ||
+ | </ | ||
- | Quick utility //(added 6.99 1/ | + | **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 | |
- | Type choices, press Enter. | + | New SPLF form type: enter form type of output spool file |
- | + | New SPLF name: enter spool file name of output spool file (*SAME to retain the same attribute of input spool file\\ | |
- | HTML file path . . . . . . . . . > '/ | + | 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/ | |
- | | + | |
- | + | ---- | |
- | + | ||
- | + | ===== 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. | |
- | | + | |
- | | + | Spooled |
- | | + | Spooled |
+ | 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: | ||
+ | Starting page . . . . . . . . | ||
+ | | ||
+ | |||
+ | | ||
+ | | ||
+ | | ||
</ | </ | ||
- | Type command EHTM2CSV | + | **Parameters: |
- | HTML file path: Enter the path to pick up the HTML File.\\ | + | |
- | CSV file path: Enter the path to place the .csv file.\\ | + | Spooled file: input spool file name \\ |
- | Charset: UTF-8 is default | + | Spooled file number: input spool file number \\ |
- | [Enter] to execute. | + | 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 | ||
+ | New SPLF name: enter spool file name of output spool file (*SAME | ||
+ | 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 331: | Line 380: | ||
| | ||
</ | </ | ||
- | ===== 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 392: | Line 410: | ||
| | ||
</ | </ | ||
- | + | **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.txt · Last modified: 2023/07/25 13:08 by kkramer