bpi.form.phantom.sub()

bpi.form.phantom.sub

This is the main service library used by bpi.form.phantom.menu and bpi.form.phantom.  It is not normally called from end-user applications but the syntax of the subroutine call is provide here for reference.  Note: Blue Prairie reserves the right to change this routine at any time without advance notice and does not guarantee compatibility in future releases.  Use at your own risk.

Subroutine Syntax

CALL bpi.form.phantom.sub( action, param, control, MAT queuehandle, verbose, status, message)

Parameters

Param

Direction

Description

action

passed

0 = get list of phantoms (a.getlist)

1 = start a phantom (a.start)

2 = kill a phantom (a.kill)

3 = ping a phantom (a.ping)

4 = test a phantom (a.test)

5 = count documents in queue (a.count)

6 = get phantom’d pid (a.getpid)

7 = get OpenOffice status (a.getoostatus)

8 = get printer status (a.getprinterstatus)

9 = ssh to OpenOffice server (a.ssh)

10 = tail phantom log (a.taillog)

11 = clear phantom queue (a.clearqueue)

12 = list OpenOffice processes (a.listooprocesses)

13 = bump (kill) OpenOffice processes for this user (a.bumpooprocesses)

14 = send local testpage (a.localtestpage)

param

passed

Data (varies depending on action) required to perform the action

control

passed

the control array where phantom information is kept

queuehandle

passed

A dimensioned array parallel to control containing handles opened queue directories

verbose

passed

level of verbosity

status

returned

status of requested action (mode)