Differences

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

--- pub:iviewapis [2018/09/06 13:36] – kkramer
+++ pub:iviewapis [2022/06/25 17:02] (current) – external edit 127.0.0.1
@@ Line 254: / Line 254: @@
 </pre></html>
 ===== IVWLOADURL =====
-Load iView front-end search page to search on certain index field
+Load iView front-end search page to search on certain index field. Provides ability to call an archived PDF document on iView from IBM i green screen.
 <html><pre>
                                   (IVWLOADURL)
@@ Line 260: / Line 261: @@
  Type choices, press Enter.
- Host Name  . . . . . . . . . . .   '127.0.0.1'
+ Host Name  . . . . . . . . . . . > '127.0.0.1'
  Port . . . . . . . . . . . . . .   '8080'        Character value
  iView URL  . . . . . . . . . . .   'iview'
- iView Archive  . . . . . . . . .                 Character value
+ iView Archive  . . . . . . . . . >  DHINVOICE     Character value
- Index Field  . . . . . . . . . .                 Character value
+ Index Field  . . . . . . . . . . >  INDEX03       Character value
- Search Term  . . . . . . . . . .
+ Search Term  . . . . . . . . . . >  1802021343
+ Authenticate . . . . . . . . . . >  N
@@ Line 280: / Line 283: @@
  F24=More keys
 </pre></html>
+**Parameters **
+**Host Name:** Your IBMi’s IP address ‘168.xx.x.xx’\\
+**Port:** Port number used with iView frontend ie. ‘8080’ \\
+**iView URL:** URL used with iView frontend.  i.e. ‘iview’ \\
+**iView Archive:** iView archive name \\
+**Index Field:** iView index name i.e. ‘INDEX03’ \\
+**Search Term:** Index search value to query archive \\
+**Authenticate:** 'Y' Requires user to authenticate with the iView front end before continuing to open the location of the PDF. or 'N' Does not require the user to authenticate with iView front end and opens up PDF on browser. \\
+===== VIEWIFSPDF =====
+This command enables a call for PDF files from iView using the API command from your IBM i green screen (backend) without having the user sign-in to iView via the frontend of iView.
+<html><pre>
+                                  (VIEWIFSPDF)
+ Type choices, press Enter.
+ Host Name  . . . . . . . . . . . > '127.16.1.54'
+ Port . . . . . . . . . . . . . .   '8080'        Character value
+ iView URL  . . . . . . . . . . .   'iview'
+ iView Archive  . . . . . . . . .                 Character value
+ PDF File Name. . . . . . . . . . > '/home/anguyen/test.pdf'
+                                                                         Bottom
+ F3=Exit   F4=Prompt   F5=Refresh   F12=Cancel   F13=How to use this display
+ F24=More keys
+</pre></html>
+**Note:** to make use of this API, you must first check 'Allow to public access server resource' in the iView frontend Administration Settings. Navigate to Administration/Settings menu to check the box.
  ===== INSIMG2PDF (V8.45) =====
 The command INSIMG2PDF is introduced to insert an image (type .PNG, JPG, JPEG, BMP) into PDF at a certain page and position.
@@ Line 314: / Line 356: @@
    * **Resize by Percentage**: resize the image before insert. By default, the value is 100 which means the image is not resized (keep the original size)
+ =====  IVWPDFIDX (V8.45) =====
+The command IVWPDFIDX is introduced to import metadata index fields from a PDF.
+<html><pre>
+                      Import metadata from PDF (IVWPDFIDX)
+ Type choices, press Enter.
+ iView archive name . . . . . . .   PDFIDX        Character value
+ IFS path to PDF file . . . . . .   '/home/anguyen/test.pdf'
+ Start Page . . . . . . . . . . .   1             Number, *END
+ End Page . . . . . . . . . . . .   10            Number
+ Output dir for bursting files  .   '/home/anguyen/ivwpdfidx'
+                                                                         Bottom
+ F3=Exit   F4=Prompt   F5=Refresh   F12=Cancel   F13=How to use this display
+ F24=More keys
+</pre></html>
+   * **iView archive name:** input the iView archive name which contains definition of index. Because this tool extract data from PDF file, so the index position should be text position in PDF file
+   * **IFS path to PDF file:** the PDF name where user wants to extract data
+   * **Start Page and End Page:** specify the PDF page ranges
+   * **Output dir for bursting files:** specify an IFS path to be used when bursting the file (which is configured in iView archive definition)
+NOTE: This tool should be deployed with IFDJAVA.JAR and it’s independent with iView version. It can run on both Java 1.6, 1.7 or 1.8. \\
+The data will be imported into metadata file specified in parameter iView archive name.
 ----
 <html>&#091;</html>[[start#iview | Up To Index ]]<html>&#093;</html>