Please enable JavaScript to view this site.

CopiaFacts Reference Manual

P_ASSERTED_ID[CV >C] This variable will report the value of the SIP P-Asserted-Identity header(see rfc 3325)if present in an incoming XCAPI, BladeWare, or Copia VoIP Port call.  It can also be set for an outbound call to be used in this SIP header for BladeWare and XCAPI. For XCAPI, a FORCE_ASSERTED "tweak" name in the XCAPI configuration for the controller should be set to a value of 1; if a value of 2 is set then this variable will be ignored and the P-Asserted-Identity header will be set to the same value as the calling number.
PAGES[SRO] At request time, contains the total number of pages in the documents so far selected. The document count is in @REQUESTS.  See also Fax Page Counters.
PAUSE_TIME[SW] This variable controls pausing thechannelfor a short time. A value (seconds or milliseconds depending on the TIME_MS variable setting) may be assigned, and will cause a delay after the current infobox has been completely processed.
PDF_Variables starting PDF_ are used internally in COPIAFACTS and GCSINGLE for signing and encryption. Avoid defining your own variable names starting PDF_. Those currently in use are  PDF_CONTACT, PDF_KEYFILE, PDF_LOCATION, PDF_OPEN_PASSWORD, PDF_OWNER_PASSWORD, PDF_PERMISSIONS, PDF_REASON, PDF_SIGNBOUNDS, PDF_SIGNFIELD, PDF_SIGNPIC, PDF_STRENGTH.
PDF_THUMBS_FONT[CV >G] When a TIF is converted to a page or pages of PDF thumbnail images using KEEP_FAX, this variable may containTimesorCourierto select the font in the header boxes.  The default is Arial/Helvetica.
PDF_THUMBS_HEADER[CV >G] When a TIF is converted to a page or pages of PDF thumbnail images using KEEP_FAX, the HTML content of this variable is placed in the header box at the top of each page. The variable is double-expanded: @variable names in the text of this variable are also expanded. See the PDF Customization topic for HTML syntax.
PDFLIBRE[CV >G] Set this FS-file variable to a non-empty value to supplement $convert_types (normally set from FFEXTERN) for special 'at run time' conversion of PDF documents. This causes PDF documents to be standardized and converted by loading in, and exporting from, LibreOffice (which is required to be installed when using this option). This variable does not affect conversions in the Document Converter.
Only try using this option when you have encountered small documents to be converted which were created by certain rare PDF-creation tools, which PDFIUM and/or the CopiaFacts original renderer cannot convert correctly.
PFC[SRO]  Expands to the name of the Program Files\Copia folder (without trailing backslash).  On 64-bit systems, this expands to the Copia folder under Program Files (x86).
PFD[SRO]  Expands to the first two characters (drive letter and colon) of the name of the Program Files\Copia folder (without trailing backslash).  On 64-bit systems, this uses the Copia folder under Program Files (x86).  This may be useful in batch files.
PHONE_ACCOUNT[SWS] This variable can be set to up to two telephone account codes. The values must be separated by white-space separated if more than one, and can start with one or more space characters to provide only a suffix. These values are substituted for @ sign(s) in a telephone dial string. This variable overrides both of the value(s) given on the $phone_account command. The expansion of any @ signs in the value is suppressed.
PHONE_MIN,PHONE_MAX[SRW] These variables can be set with the phone number minimum and maximum length. Values from 1 to the maximum phone number length accepted by the fax board or voice board dialer are valid.
PLAYLENGTH[SRO] Contains the approximate total length of the last voice message file which was played. The value is in seconds unless the TIME_MS system variable has been enabled, in which case it is in milliseconds.
PLAYSTART[SW] Used to set an approximate start position in the next voice message to be played. The value specified is discarded after the play operation, even if the message is skipped because of user key-ahead. Negative values are treated as zero and cause the file to be played from the start. Values greater than the file size cause the message to be skipped. The value is in seconds unless the TIME_MS system variable has been enabled, in which case it is in milliseconds.
PLAYSTOP[SRO] Contains the approximate position in the file at which the playing of the last voice message file finished or was interrupted. When the file was not started from the beginning this value is not the same as the number of seconds for which the file was actually played. If the message was not interrupted, the value will equal PLAYLENGTH. If the message was skipped, the value will equal that which was originally set in PLAYSTART, or will be zero if PLAYSTART was not used. The value is in seconds unless the TIME_MS system variable has been enabled, in which case it is in milliseconds.
POLLING[SRW] Contains values 0, 1 or 2 to indicate no polling, always expect polling, and automatic poll detection respectively. You can use this variable either to determine the mode currently in effect, or to set the mode. Setting a value other than 0, 1 or 2 reverts to the default mode for the channel defined in the configuration file.
POST_DELAY[SW] A positive value in minutes can be assigned to this variable during infobox or infoboxall post-processing, which will then cause the item to be set for retry after the specified delay time. The value is ignored if the FS file is already set for retry. Currently, this variable cannot be used (and is ignored) in conjunction with Job Administration, because the 'successful' count in the job summary file will have already been updated, and a retry will cause double-counting and totals would no longer add up correctly.
POSTPROC_FAIL[SW] A non-empty value assigned to this variable in an infobox or infoboxall post-process will cause the FS to be failed, even if already set for either success or retry. The outcome code 82 will be used for this failure. We strongly recommend not using this variable in conjunction with Job Administration, because at the time it is processed the 'successful' count in the job summary file will have already been updated, so the SENT and FAIL sub-totals will be incorrect.
PPT_COLORTYPE[CV >V] Set this value to 1 to force PowerPoint output to color mode, which will change the 'corrections' which PowerPoint may apply when printing to a monochrome fax.  This variable must be present in the FS file.  If no FS file is present (e.g. when running CVSINGLE alone), CVSINGLE will also look in the Windows environment for this variable.
PR_BOX_OFFSET[CV C> >G] Used to communicate fax header line positioning from the CopiaFacts engine to graphical cover processing.
PR_...[SRO] These 'post-receive' variables contain data about the fax received and can be used in 'INFOBOX' post-receive processing.  Note that the variables involving a filename will be empty if no received fax file is present (or if it has been moved from the location into which it was received). Do not use variable names starting PR_ as user variables, and avoid assigning new values to the variables shown below. See also the variables for the BladeWare interface FOIP_FROM, and FOIP_URI_FROM.
PR_ANI[SRO] The ANI of the incoming fax call
PR_FAXCSID[SRO] The CSID (answerback) of the remote fax machine.
PR_FAXFILE[SRO] The filename part of the received fax file (e.g. 00012345.TIF).
PR_FAXFORMAT[SRO] The image type of the received fax, currently either 59 (TIF) or 93 (IPK containing color JPEG).
PR_FAXNSF[SRO] The NSF data from the remote fax machine.
PR_FAXPAGES[SRO] The number of pages received. See also Fax Page Counters.
PR_FAXPATH[SRO] The full pathname of the received fax file.
PR_FAXPDF[SRO] The same value as in PR_FAXFILE, but with extension changed to PDF. This can be used in a name= clause in the content-type of an $email_attach command, so that the e-mail recipient sees a file which has the same name as the original MCF and TIF in a fax-to-email application. See also the $type fsfile examples.
PR_FAXSTAT[SRO] The fax error code (or 0 for successfully received fax).
PR_FAXTIME[SRO] The time taken to receive the fax, in seconds.
PR_OUTCOME[SRO] The description associated with the fax error code.  This variable is also placed in the MCF file.
PR_MAILBOX[SRO] The fax mailbox number (without leading zeros) of the mailbox that received the fax. To obtain a number with leading zeros, use $set_var ZBOX @PR_MAILBOX 0 8
PR_MCFNUM[SRO] The MCF number allocated to the incoming fax transaction. The value will be 0 if no receive operation has taken place, but may be non-zero even if the transaction is incomplete and no fax file has been saved.
PRV_[CV] These variables are used in Copia Standard Scripts for Post-Receive,
PREPARE_FAX[CV >C] Assign a value of 1, 2, or 3 to this variable to control whether the preparation of a fax transmission is done before dialing (1), after dialing, while waiting for a connect (2), or after the connection has been made (3). The variable only affects Dialogic Diva board transmissions, for which the default value is 2. The 'preparation' operation includes Graphical Customization tasks, conversion of resolution, checking and building the transmission list, and copying files to a local folder if Fax Local Copy is enabled in COPIAFACTS options.
PREPROC_DELAY[CV >C] A positive value in seconds can be assigned to this variable in an infobox preprocess, which will cause the item to be set for retry after the specified delay time.  The retry channelgroup and retry TOSEND specification is not used for this retry, and no attempt record is created.  You should set a variable in your pre-process infobox sequence to count or record the fact that a retry will be performed, or take some other precautions to avoid continuously pushing forward the FS scheduled date/time.
PREPROC_HOURSThe number of hours after which an FS is considered 'stuck' in the PREPROC folder, for the purpose of trigger notifications.
PREVIEW_FAX[CV L> >C] This variable is reserved for use by the CopiaFacts Client software.
PREVIEW_FOLDER[CV L> >C] This variable is reserved for use by the CopiaFacts Client software.
PREVIEW_FORMAT[CV >C] Assign a value containing one or more of the keywords PDFV, PDF, A4, PNG, JPG or GIF to create a job preview in the corresponding format (one page per file) in addition to the TIF format. The A4 keyword sets the document size for PDF format (default US letter). The PDFV format (US letter or A4) sets the PDF height to match the TIF height.
PREVIEW_TYPE[SRO]  This variable contains the type of 'preview' processing (or non-transmitted fax processing) that has been performed.  Possible values are KEEP for the archive document created after an actual fax; CLIENT for the preview initiated by the CopiaFacts Client software using PREVIEW_FAX, and JOB for Job Administration previews.  The variable is empty if no such processing has been done.
PRINTNOBOX[SW] Assigning a non-empty value to this variable will cause the information box printed at the top of the page in a PRINTHISFILE operation to be suppressed. The effect lasts for all later printing in the same call, or until an empty value is assigned to the variable. The suppression of the information box only affects print operations to a printer named in USETHISPRINTER; printing to the default printer always includes the box.
PRINTTHISFILE[SW] Assigning a pathname to this system variable causes the fax file to be printed on the default printer, or, if set, the printer specified by USETHISPRINTER. Only faxable TIF, JT-Fax format files and PDF files can be printed. Assigning the name of an FS file or MCF file will print the associated fax file(s). This feature uses the CF9PRINT.DLL file, which must be available.  After printing the file, DLL_RETURN will contain the number of pages printed.  A failure to print raises a run-time error 6011 and the page count will be 0.  For printing PDF files, only one CopiaFacts channelcan print at a time: if you configure multiple channels to print, for example in worker-box operations, CF9PRINT will process one at a time.
PROBLEM_DONE[SRW] This variable contains a value '1' if the PROBLEM_CALL state has been visited in the current call after failure to detect an IVR response. You can also assign a value of 0 or 1 to this variable to override its value. This variable can be used to avoid looping when your IVR logic makes further attempts to obtain a response after problem call state has been visited.  You can also set the variable to 1 before asking for an IVR response, to suppress the problem_call message completely.  In this case the actions specified by $repeat_msg are still followed.
PROOF_LOOKUP[CV>J] Assigning a non-empty value to this variable in a job properties file will cause launch-time do-not-send, whitelist and action lookups to be performed for proof and preview operations.  Normally the look-up is skipped for a proof or preview.