User Tools

Site Tools


pub:iviewapis

[ Up To Index ]

iView API's

PRTPDF2Q

Purpose: Use the PRTPDF2Q command to print PDF files from a directory on the IFS of your IBMi. The command will convert the PDF into a spool file which is sent to an out queue for printing. The output out queue needs to have a writer attached to the out queue to print the output spool file. The printer used to print the file needs to be able to print PDF directly at the printer. Check your printer specifications to find out if your printer is PDF printing capable. Use the command in a CL, a program, or interactive.

Requirements: Specific iView IVIEWWEB Licensing required; iView version 7.00 or above.

To Use: Type PRTPDF2Q on the command line and select F4 to Prompt OR Call command and fill in the attribute values in your CL or program.

Available parameters:

  • IFS PDF File to print: Enter the directory path and name of the PDF file to send to the out queue to print
  • Output Queue: Name of the out queue which has a writer attached to print the PDF
  • Library: The library name of the out queue you are going to use
  • Spool File Name: You can use the default name (FMGSPPDF) or use your own specific name for the spool file name that outputs to the output queue
  • Form Type: You use the default type (*STD) or assign a different type
  • Hold spool file: You can use the default spool file status of (*NO) or you can change to (*YES) to hold the output spool file in the output queue

                       Print PDF file to Queue (PRTPDF2Q)                       
                                                                                
 Type choices, press Enter.                                                     
                                                                                
 IFS PDF File to print  . . . . .                                               
                                                                                
                                                                                
                                                                                
 Output Queue . . . . . . . . . .   QPRINT        Name                          
   Library  . . . . . . . . . . .     *LIBL       Name, *LIBL, *CURLIB          
 Spool File name  . . . . . . . .   FMGSPPDF      Character value               
 Form Type  . . . . . . . . . . .   *STD          Character value               
 Hold spool file  . . . . . . . .   *NO           *YES, *NO, *YES, *NO          
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                         Bottom 
 F3=Exit   F4=Prompt   F5=Refresh   F12=Cancel   F13=How to use this display    
 F24=More keys                                                                  

STRIVMONAR

Purpose: Command STRIVMONAR is prompted for user to define how they want to get notification when metadata file is inserted/updated or/and removed

Requirements: iView V8.45 or above.

To Use: Type STRIVMONAR on the command line and select F4 to Prompt OR Call command and fill in the attribute values in your CL or program.

Available parameters:

  • iView archive name: Enter the archive name
  • Event Type: Single Values *NONE *ALL; Other Values *INSERT *UPDATE *DELETE
  • Message text (*INDEXxx): Text you are going to use
  • To User Profile: User Profile
  • Message type: *INFO
  • To Data Queue/Library: Data Queue/Library
  • To Email Address: Enter the eemail address
  • Mail Subject (*INDEXxx): Subject
  • iMail Job Queue/Library: The Job Queue and library name you are going to use
  • iMail Library Name: The library name of the out queue you are going to use

                    Monitor archive data changes (STRIVMONAR)                   
                                                                                
 Type choices, press Enter.                                                     
                                                                                
 iView archive name . . . . . . .                 Name                          
 Event Type . . . . . . . . . . .                 *NONE, *ALL, *INSERT...       
                + for more values                                               
 Message text (*INDEXxx)  . . . .                                               
                                                                                
                                                                                
                                                                                
 To User Profile  . . . . . . . .                 Name                          
                + for more values                                               
 Message type . . . . . . . . . .   *INFO         *INFO                         
 To Data Queue  . . . . . . . . .                 Name                          
   Library  . . . . . . . . . . .     *CURLIB     Name, *CURLIB, *LIBL          
 To Email Address (*INDEXxx)  . .                                               
                                                                                
                + for more values                                               
                                                                                
                                                                        More... 
 F3=Exit   F4=Prompt   F5=Refresh   F12=Cancel   F13=How to use this display    
 F24=More keys                                                                  
                    Monitor archive data changes (STRIVMONAR)                   
                                                                                
 Type choices, press Enter.                                                     
                                                                                
 Mail Subject (*INDEXxx)  . . . .                                               
                                                                                
                                                                                
 iMail Job Queue  . . . . . . . .   FMGJOBQ       Name                          
   Library  . . . . . . . . . . .     *LIBL       Character value, *LIBL        
 iMail Library Name . . . . . . .   FMG           Character value               
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                         Bottom 
 F3=Exit   F4=Prompt   F5=Refresh   F12=Cancel   F13=How to use this display    
 F24=More keys                                                                  

ENDIVMONAR

Command ENDIVMONAR stops monitoring a metadata file, or user can iView archive maintenance screen, press F8=Metadata Monitor to open Monitor edit screen, and change Event Type to *NONE

                  
                    Stop to monitor data changes (ENDIVMONAR) 
                  
                                                                                
 Type choices, press Enter.                                                     
                                                                                
 iView archive name . . . . . . .                 Name                          
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                         Bottom 
 F3=Exit   F4=Prompt   F5=Refresh   F12=Cancel   F13=How to use this display    
 F24=More keys 

STRTOMCAT

Start Tomcat server

 
                            Start Tomcat (STRTOMCAT)                            
                                                                                
 Type choices, press Enter.                                                     
                                                                                
 Job Queue  . . . . . . . . . . .   *JOBD         Character value               
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                         Bottom 
 F3=Exit   F4=Prompt   F5=Refresh   F12=Cancel   F13=How to use this display 

ENDTOMCAT

End Tomcat server

 
                             End Tomcat (ENDTOMCAT)                             
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
 F3=Exit   F5=Refresh   F12=Cancel   F13=How to use this display   F24=More keys
                                                                                
 No parameters to show; press Enter to run, F3 to exit.                         

STRIVWSRV:

Start iView engine

 
                         Start iView Server (STRIVWSRV)                         
                                                                                
 Type choices, press Enter.                                                     
                                                                                
 iView Server Name  . . . . . . .                 Value, or F4 for list         
 User . . . . . . . . . . . . . .   *CURRENT      Name, IVIEW, *CURRENT         
 Job queue  . . . . . . . . . . .   *JOBD         Name, *JOBD                   
 Save job log . . . . . . . . . .   *NO           *YES, *NO                     
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                         Bottom 
 F3=Exit   F4=Prompt   F5=Refresh   F12=Cancel   F13=How to use this display    
 F24=More keys                                                                  

ENDIVWSRV

End iView engine

 
                          Stop iView Server (ENDIVWSRV)                         
                                                                                
 Type choices, press Enter.                                                     
                                                                                
 iView Server Name  . . . . . . .                 Value, or F4 for list         
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                         Bottom 
 F3=Exit   F4=Prompt   F5=Refresh   F12=Cancel   F13=How to use this display    
 F24=More keys                                                                  

IVWLOADURL

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.

                                  (IVWLOADURL)                                  
                                                                                
 Type choices, press Enter.                                                     
                                                                                
 Host Name  . . . . . . . . . . . > '127.0.0.1'                                 
 Port . . . . . . . . . . . . . .   '8080'        Character value               
 iView URL  . . . . . . . . . . .   'iview'                                     
 iView Archive  . . . . . . . . . >  DHINVOICE     Character value               
 Index Field  . . . . . . . . . . >  INDEX03       Character value               
 Search Term  . . . . . . . . . . >  1802021343

 Authenticate . . . . . . . . . . >  N                                           
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                                
                                                                         Bottom 
 F3=Exit   F4=Prompt   F5=Refresh   F12=Cancel   F13=How to use this display    
 F24=More keys                                                                  

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.

                                  (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                                                                  

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.

                        Insert image to PDF (INSIMG2PDF)                        
                                                                                
 Type choices, press Enter.                                                     
                                                                                
 IFS Image File . . . . . . . . .                                               
                                                                                
                                                                                
                                                                                
 Path of PDF File . . . . . . . .                                               
                                                                                
                                                                                
                                                                                
 Horizontal Position  . . . . . .                 0-9999                        
 Vertical Position  . . . . . . .                 0-9999                        
 Page number  . . . . . . . . . .   1             Number                        
 Resize by Percentage . . . . . .   100           1-100                         
                                                                                
                                                                                
                                                                                
                                                                                
                                                                         Bottom 
 F3=Exit   F4=Prompt   F5=Refresh   F12=Cancel   F13=How to use this display    
 F24=More keys                                                                  

  • IFS Image File: the full path of image file in IFS
  • Path of PDF File: the PDF file you want to insert the image
  • Horizontal Position: the x position (in pixel) from the left bottom of image to right of PDF page
  • Vertical Position: the y position (in pixel) from the left bottom to top of PDF page
  • Page number: indicate the PDF page number that image is inserted
  • 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.

                      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                                                                 

  • 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.


[ Up To Index ]

pub/iviewapis.txt · Last modified: 2022/06/25 17:02 by 127.0.0.1