Specify Custom Fields for Screen Display Boxes
$display_box boxcode title [specialcounter]
This command specifies an override for the contents of one of the 18 status boxes on the COPIAFACTS screen display. There are eighteen boxes in the upper section of the display, numbered as shown below. You may customize any of the boxes.
The changed legends are also applied in CFCP, which reflects the status of each COPIAFACTS node. The text settings will be applied for all nodes.
From CopiaFacts version 9, the numeric counts in the boxes are always initialized to zero at the start of each session.
The parameters on this command are used as follows:
| boxcode | the designation of the box to be used, from 0 to 9 or A to H inclusive. The eighteen boxes are numbered as follows: |
0 | 2 | 4 | 6 | 8 | A | C | E | G
- - - - - - - - - - - - - - - - -
1 | 3 | 5 | 7 | 9 | B | D | F | H
| title | the text to describe the content, enclosed in double quotes if it contains embedded blanks. In an even-numbered box, any portion preceding a vertical bar symbol (|) will be placed in the top (column header) box. A colon and space will be appended to the string. |
| specialcounter | one of the keywords below to designate one of the special counters which some users may prefer to the default set of counters. |
To place values in custom fields, you can assign values to system variables DISPLAYn (where n is 0 to 9, A to H). These variables are global and are not reset at the end of each call.
The override text is not shown initially when COPIAFACTS starts up, only when the CopiaFacts engine has been started.
The settings on this command apply to all nodes. If you change these settings COPIAFACTS needs to be restarted in order to enable them.
When setting new titles, bear in mind that the space is limited. When a long title is used in COPIAFACTS you can adjust the column widths, but in CFCP a long title string may be truncated.
Defaults:
There is a default label and value for each numbered field, which can be overridden after setting a new field label. The existing default counters cannot currently be moved to appear in a new field; they can only be replaced.
The default values in each field are as follows:
| 0 | Fax inbound pages |
| 1 | Fax inbound failures |
| 2 | Fax outbound pages |
| 3 | Fax outbound failures |
| 4 | Inbound voice calls |
| 5 | Fax-on-Demand requests |
| 6 | Outbound voice calls |
| 7 | Outbound voice failures |
| 8 | E-Mails sent |
| 9 | E-Mails failed |
| A | SMS sent |
| B | SMS failed |
| C | Average open time |
| D | Max open time |
| E | Active channel count |
| F | Active channel max |
| G | Fax/Voice retries |
| H | E-Mail retries |
Example to display values from a script:
First specify a custom box label, for example to replace field 5 if you do not use fax-on-demand". Specifying a new label blocks the use of the field for the default counter.
$display_box 5 "MyCounter"
Then for example, if you wish to count the number of times you access a database in a custom script, add the following example in your scrip infobox after updating the database:
$set_var MYCOUNT @DISPLAY5 ; get current counter value
$set_var MYCOUNT +1 ; increment it
$set_var DISPLAY5 @MYCOUNT ; display it on counter refresh
CopiaFacts version 9 has added counters for more standard operations. These counters are not automatically displayed, but may be selected to replace the display in one of the existing 18 fields. The first three counters of this type count:
| COUNT_WBDONE | Successfully processed worker-box FS files (after any retries) |
| COUNT_WBFAIL | Worker-box FS which failed to process. |
| COUNT_BADFS | FS files rejected without processing. They will be not be counted as failed fax or e-mail transactions because it may not be possible to identify the type of the FS. This counter principally includes FS files with command syntax errors, but all failures which are not considered capable of being retried without manual changes would be counted here. |
Other special counters may be added to CopiaFacts in future releases.
If you have used this feature and then need to drop back to an earlier CopiaFacts release, you should revert any changes.
Example to display values from a Special Counter:
First specify a custom box label". Specifying a new label blocks the use of the field for the default counter. As the third parameter on this command, specify the keyword of the special counter.
$display_box 4 "Misc|Voice In" ; change heading for third column
$display_box 5 "Bad FS" COUNT_BADFS
$display_box A "Worker|Done" COUNT_WBDONE
$display_box B "Fail" COUNT_WBFAIL
