Differences

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

--- pub:idocsapi [2022/08/25 19:04] – [Programming API's] kkramer
+++ pub:idocsapi [2023/05/11 13:52] – 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 74: / Line 70: @@
 ----
-===== UTILITIES =====
+====== 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 =====
-<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:**
+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.
-Spooled file: input spool file name \\
+<html><pre>
-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 \\
+                         Convert HTML to CSV (EHTM2CSV)
-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)\\
+ Type choices, press Enter.
-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\\
+ HTML file path . . . . . . . . . > '/home/anguyen/htm2csv/Order.htm'
-Page range: enter the range of pages of input spool file name\\
+ CSV file path  . . . . . . . . . > '/home/anguyen/htm2csv/Order.csv'
+ Charset  . . . . . . . . . . . . > 'UTF-8'
+                                                                         Bottom
+ F3=Exit   F4=Prompt   F5=Refresh   F12=Cancel   F13=How to use this display
+ F24=More keys
+</pre></html>
-**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/ANGUYEN/ANGUYENA) OWNER(OFERRER)
+CSV file path: Enter the path to place the .csv file.\\
+Charset: UTF-8 is default (F4 for options).\\
+[Enter] to execute.
 ----
@@ Line 174: / 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.
+<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>
-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.
+**Parameters:**
-<html><pre>
+Spooled file: input spool file name \\
+Spooled file number: input spool file number \\
+Job name/User Name/ Job Number: job ID of input spool \\
-                         Convert HTML to CSV (EHTM2CSV)
+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) \\
- Type choices, press Enter.
+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\\
- HTML file path . . . . . . . . . > '/home/anguyen/htm2csv/Order.htm'
+Hold new SPLF: Hold the output spool file name\\
+Page range: enter the range of pages of input spool file name\\
- CSV file path  . . . . . . . . . > '/home/anguyen/htm2csv/Order.csv'
+**Example:**
+IFDUPSPLF FILE(INV) SPLNBR(2) JOB(106730/ANGUYEN/ANGUYENA) OWNER(OFERRER)
- Charset  . . . . . . . . . . . . > 'UTF-8'
+----
+===== 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.
-                                                                         Bottom
- F3=Exit   F4=Prompt   F5=Refresh   F12=Cancel   F13=How to use this display
+ Spooled file . . . . . . . . . . > INV           Name
- F24=More keys
+ 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>
-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.\\
+Spooled file: input spool file name \\
-Charset: UTF-8 is default (F4 for options).\\
+Spooled file number: input spool file number \\
-[Enter] to execute.
+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 380: @@
 </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 410: @@
  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>