|
Note: This is the documentation for a new and improved bpi.form.phantom.menu utility offering the following new features:
The upgrade is free to maintenance paying customers. If you are looking for documentatation on the older (pre version 4.1) menu, it is archived here: bpi.form.phantom.menu (pre version 4.1) |
bpi.form.phantom.menu
The bpi.form.phantom.menu utility lives in the BPIFORMS account. It can be invoked at TCL by typing bpi.form.phantom.menu.
Calling Syntax:
| bpi.form.phantom.menu {switches} |
Where {switches may contain}
| Switch | Purpose |
| -A# | To pass the auto-refresh param where # represents an integer from 0 to 9 indicating the number of seconds of delay between each refresh. Zero indicates no automatic refresh (the R refresh key can be used). |
| -T# | To toggle the line display where # represents and integer (0 or 1) indicating 0=normal view, 1 = queue directory view. |
Screen Shot of bpi.form.phantom.menu (normal view)
Screen Shot of bpi.form.phantom.menu (toggle to directory view with T key)
Note that the columns Account, OO_Server, Rmt_user, and Deft_pt have been replaced with the columb Queue Directory
Help Screen
A help screen can be invoked by typing h. You may navigate up and down using the appropriate keys then press spacebar to select one or more threads. The most common action will be ‘s’ to start a phantom and ‘k’ to kill a phantom. Additional functions are available and will be described below.
The numbered lines in the menu above are populated from records found in the BPI.FORM.PHANTOM.CONTROL file/directory that lives in your Blue Prairie Forms account (this is usually called BPIFORMS). You can modify existing BPI.FORM.PHANTOM.CONTROL records via the menu above by chosing v)iew then e)dit or you can edit them directly in the directory using your preferred text editor. To create new phantom threads, you will create a new record in BPI.FORM.PHANTOM.CONTROL by either copying and modifying an existing record or creating a new one from scratch.
Explanation
The example above has three phantom threads defined. As a phantom is started, its pid will appear in the pid column. This is the indication that the phantom is running. To get help for the menu, press h.
Navigation
| Key | Action |
| up arrow or U | will move the selection line up (note, up/down arrows are not mapped for all terminal types) |
| down arrow or D | will move the selection line down |
| +/- | Page up (-) or down (+) |
| spacebar | will select the highlighted line causing a > character to appear to the left |
| * | will select all or deselect all lines (even those not on page) |
Actions
| Key | Action |
| # | Numeric 0-9 indicating seconds of delay before page, pids, and count are auto-refreshed with new info. Zero turns off auto-refresh. A countdown timer will be shown when in auto-refresh mode. If auto-refresh is turned off, you may use R to manually refresh. You can pass the auto-refresh param (0-9) using the -A command line switch when calling bpi.form.phantom.menu. |
| C | Clear the queue for selected phantoms. |
| K | Will kill the selected phantom(s) by writing a record to a file that the phantom monitors (a signal) |
| L | show the log files for the selected phantoms. |
| P | Ping the OpenOffice server for selected phantoms (to see if it is alive.) |
| R | Refresh the page, update pids and counts (see # for auto-refresh) |
| S | will start the selected phantom(s) |
| T | Toggle the line display so that instead of columns Acct, OO_Server, Rmt_user, Deflt_Pt being displayed, instead the path to the queue directory for this line will be display. You can pass the Toggle param (0-9) using the -T command line switch when calling bpi.form.phantom.menu. e.g. -T0 for normal, or -T1 for directory view. |
| P | Ping the OpenOffice server for selected phantoms (to see if it is alive.) |
| < | Will send the test .odt document named in the thread’s BPI.FORM.PHANTOM.CONTROL record to the threads queue directory. If the phantom is running and all is well, the test document will be rendered on the OpenOffice server. If not, more in-depth diagnostics may be required. |
Administrative Actions
The following actions are shown in the help file and on the menu but will only function if the user id you have used to login is a member of the bpiformadm unix group. Normal users are not normally members of this administrators group. In addition, a param file controls which of these administrative actions are available and optionally, whether a password will be required to access the function.
| Key | Action |
| $ | Will ssh connect you to the OpenOffice server as the user defined for the selected phantom. Once connected, you are now logged into the OpenOffice server as that user. You can use any command for which you are privileged. Type exit at the shell prompt to close the connection and to be returned to the MultiValue host (the menu). |
| L | Will show the log being generated by the phantom. The level of detail written to a phantom’s log is determine by the ‘switches’ param in the BPI.FORM.PHANTOM.CONTROL record for a phantom. The -v switch controls level of verbosity. The number following the -v indicates the level of verbosity. The higher the number, the more verbose the detail in the log. (not currently supported in D3) |
| C | Clear the queue. This will remove all queued documents |
| P | Ping the OpenOffice server for selected phantoms (to see if it is alive.) |
| V | View and edit the phantom control record. Options for vi and your default editor (ED, JED, etc) are provided. |
| < | Will send the test .odt document named in the thread’s BPI.FORM.PHANTOM.CONTROL record to the threads queue directory. If the phantom is running and all is well, the test document will be rendered on the OpenOffice server. If not, more in-depth diagnostics may be required. |
| ? | List OpenOffice processes running on the OpenOffice server for the user associated with this phantom thread. |
| B | This will search the OpenOffice server looking for open office (soffice) processes owned by the users associated with selected phantoms and will attempt to kill -15 these processes on the OpenOffice server. This effectively, cleans up orphaned or hung OO processes. If you need to get more harsh, you can use the $ command and ssh to the server to investigate and kill processes as needed. |
Configuring the menus via the ini file
The menus may be configured using the parameters file. The menu param file is stored at BPIFORMS/bpi_forms/ini/bpi.form.phantom.menu.ini.
Here is an example where all functions are enabled with passwords for each function
menuLog=enabledmenuLogPassword=bluepincmenuSsh=enabledmenuSshPassword=bluepincmenuPs=EnabledmenuPsPassword=menuBump=enabledmenuBumpPassword=bluepincmenuView=enabledmenuViewPassword=menuEdit=enabledmenuEditPassword=bluepinc