Differences

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

--- pub:ifdcinstructions [2018/03/19 14:38] – ken
+++ pub:ifdcinstructions [2018/03/19 18:45] – ken
@@ Line 4: / Line 4: @@
 The ESNDDTAQ API command is used to send PDF file path to data queue which is being listened to by client programs. The command has the parameters as below:
+{{:pub:ifdc:ifdc001.jpg?600|}}
-<html><pre>
-                    Send data to keyed data queue (ESNDDTAQ)
- Type choices, press Enter.
- Key value  . . . . . . . . . . .
- Data value . . . . . . . . . . .
- Data Queue . . . . . . . . . . .   IFDCLIENT     Name
-   Library  . . . . . . . . . . .     QGPL        Name, *CURLIB, *LIBL
-</pre></html>
@@ Line 34: / Line 15: @@
 ESNDDTAQ KEY(USER01) DATA(‘/home/user/myfile.pdf’) DATAQ(QGPL/IFDCLIENT)
-The client program is a .JAR file developed in Java language to connect to iSeries and monitor a data queue by a unique key for PDF file. Once the data in data queue is found, client program will download the PDF file to temporary folder in Windows and invoke PDF reader (configured in parameter) to show PDF file on Window machine
+The client program is a .JAR file developed in Java language to connect to iSeries and monitor a data queue by a unique key for PDF file. Once the data in data queue is found, client program will download the PDF file to temporary folder in Windows and invoke the PDF reader (configured in parameter) to show PDF file on the Window machine.
 The compressed file contains 2 files:
   * **IFDCLIENT.JAR**: the JAR file that will be monitoring data queue on iSeries for PDF file
   * **IFDCLIENT.BAT**: contains the MS-DOS batch commands to invoke IFDCLIENT.JAR program.
+The program can be started in __2 modes__: with and without user interface (UI).
+  * **In UI mode**: a logon dialog will be prompting to input the IBM i credential and other configuration.
+  * **In non-UI mode**: user can call the program and pass the input parameters.
+==== UI mode ====
+User can execute file ifdclient.bat, at the first time when program is executed, a dialog is shown as below:
+{{:pub:ifdc:ifdc002.jpg?600|}} \\
+Notice that the black screen behind the logon screen, it searched for an existing PDF reader in your computer. User can also modify it and more parameter by clicking to button **Settings**. \\
+{{:pub:ifdc:ifdc003.jpg?600|}}
+When user clicks OK, a folder named IFDClient is created into C:\Program Files (x86)\inFORM Decisions\IFDClient (or your Program Files folder), and this folder contains 2 files:
+  * **ifdclient.cfg**: save the program’s configuration
+  * **log.txt**: save the logging messages
+==== Non-UI mode ====
 IFDCLIENT.JAR is started with the following parameters:
-  * **print**: print the parameters
+  * **print**: Optional. Print the parameters
-  * **help**: print the parameters
+  * **help**: Optional. Print the parameters
-  * **server**: Mandatory. IP address of host name of iSeries
+  * **server**: __Mandatory__. IP address of host name of iSeries
-  * **logonuser**: Mandatory. the iSeries user ID that is used to connect to server
+  * **logonuser**: __Mandatory__. The iSeries user ID that is used to connect to server
-  * **logonpassword**: Mandatory. iSeries password of user ID in parameter logonuser
+  * **logonpassword**: __Mandatory__. iSeries password of user ID in parameter logonuser
-  * **dataqueue**: Optional. qualified name of data queue that JAR program will monitor. The format of data queue name is <10 characters of data queue name><10 characters of data queue library name>, for example: ‘IFDCLIENT QGPL’. If this parameter is ignored, the data queue IFDCLIENT in QGPL is used.
+  * **dataqueue**: Optional. Qualified name of data queue that JAR program will monitor. The format of data queue name is <10 characters of data queue name><10 characters of data queue library name>, for example: ‘IFDCLIENT QGPL’. If this parameter is ignored, the data queue IFDCLIENT in QGPL is used.
   * **user**: Optional. The key that JAR program is used to fetch data from data queue. If this parameter is ignored, the current user ID of Window machine is used.
   * **multifiles**: yes or no. Optional. Default value is yes. If it’s yes, then the PDF reader will open next PDF in data queue entry after the PDF file being opened is closed. If it’s no then the PDF reader continues to open the PDF files those are pushed into data queue.
@@ Line 52: / Line 56: @@
   * **pdfreadername**: Optional. Contains the PDF reader name. If this parameter is ignored, AcroRd32.exe is used.
-The parameters can be passed to JAR program in 2 ways:
+Pass them as parameters into **java** command, for example:
-  * Pass them into java command, for example:
+<html><pre>
-C:\>java -jar ifdclient.jar -server 172.16.1.54 -logonuser my_user -logonpassword my_password -user USER01
+  C:\>java -jar ifdclient.jar -server 172.16.1.54 -logonuser my_user -logonpassword my_password -user USER01
-  * Put them a separate file named ifdclient.properties as an example below (all parameters must be having prefix with ifdclient.):
+</pre></html>
-{{ :pub:ifd_client_1.jpg?600 |}}
-When file .properties is used, the command to start .JAR program is as below:\\
-C:>java -jar ifdclient.jar
-**Notes:**
+**Notes:**\\
 Please remember that if the .JAR program is setup as a Window service then when PDF is sent from server, the PDF reader may open it into session 0 which is invisible to current logon user of Window.