Control File Keywords List

The following table lists the control file keywords.

Keyword	Description	Value
#ACCUROUTE_BATCH	This keyword allows the control file to specify that the attachments are to be treated as batch processing by the Embedded Directive Manager. It works with Upland AccuRoute servers and can be used with Filescan and XeroxScan connectors. Guidelines: This property should be used to indicate the document contains one or more routing sheets, and that the job should be split at each routing sheet and treated as a number of separate jobs. Example: #ACCUROUTE_BATCH TRUE	TRUE\|FALSE TRUE to indicate the job is a batch. FALSE to indicate the job is not a batch.
#ACCUROUTE_BATCH_COUNT	This keyword allows the control file to specify the number of expected jobs to be found in the ACCUROUTE_BATCH. If this value is not specified, the Embedded Directive Manager assumes it found all the separate jobs in the batch correctly. It works with Upland AccuRoute servers and can be used with Filescan and XeroxScan connectors Guidelines: This property should be used if ACCUROUTE_BATCH is TRUE, and the submitter knows the exact count of Routing Sheets. This can help decrease the chance that a batch job is separated incorrectly (for example, the submitter does not realize there is a missing routing sheet). This property can be used in a virtual control file, but as the batch count will change with every submission, it would require editing the virtual control file every time a new batch is submitted. An alternative would be to set up multiple scan folders that correspond to the batch count and put a virtual control file in each folder. For example, a folder named 1Batch could contain a virtual control file using the property #ACCUROUTE_BATCH_COUNT_1, while a folder named 2Batch could contain a virtual control file using the property #ACCUROUTE_BATCH_COUNT_2, etc. Example: #ACCUROUTE_BATCH_COUNT 10	Integer value
#ACCESS_CODE	This keyword indicates the sender's personal access code used to send faxes. It works with Upland AccuRoute and fax servers, and can be used with Filescan and SMTP connectors. Guidelines: The value for this keyword should match the value in a dialing rule on the server. If it does not, the server processes the fax, but the telephone system your company uses might prevent delivery. Example: #ACCESS_CODE 1234	Sender's personal access code.
#APPROVAL	This keyword determines whether a fax requires approval before the server can deliver it. It works with the Upland AccuRoute server, and can be used with Filescan and SMTP connectors. Guidelines: If all the sender's faxes must be approved, then this keyword must be included in the control file with a YES or TRUE value. If approval is optional for the sender, all possible values are valid. If the sender or server has not been configured for approval, the connector ignores this keyword. Example: #APPROVAL YES	TRUE\|FALSE
#ATTACHMENT	This keyword indicates the files that should be sent as part of the document or fax. It works with the Upland AccuRoute server, and can be used with Filescan connectors. Guidelines: This keyword is required in the control file if you are sending a document or fax via the server. You can select any file in a supported file format. Examples: #ATTACHMENT filename.txt #ATTACHMENT \\computer\folder\filename	The file name of a document if the document is copied to the Filescan folder with the control file. Note: The Filescan connector removes the file from the Filescan folder. The path to a document if the document is not copied to the Filescan folder. The path to the document must be a fully qualified file path, such as: \\computer\folder\filename or G:\\folder\filename Note: The Filescan folder might be located on a different computer than the computer where you create the control file. In this instance, the example G:\\folder\filename means that the attachment is located on the G drive of the computer where the Filescan folder is located.
#BILLING_CODE	This keyword indicates the billing code associated with a document or fax. It works with the Upland AccuRoute server, and can be used with Filescan and SMTP connectors. Example: #BILLING_CODE 55512347	Integer value
#COMMENTS	This keyword indicates the comments that should appear on the cover page of the document or fax. It works with theUpland AccuRoute server, and can be used with Filescan and SMTP connectors. Example: #COMMENTS Hi Bill, this is the document I promised to send. Call me anytime with questions. Thanks again for your help.	String value
#COVERPAGE	This keyword indicates the cover page style that should be included with the document or fax. It works with the Upland AccuRouteserver, and can be used with Filescan and SMTP connectors. Guidelines: You can select a different cover page style for each recipient, or select one for all recipients. If you want to use one cover page style for all recipients, position the keyword before indicating any recipients. If you want to use a different cover page style for each recipient, include the keyword after indicating each recipient. For cover page templates with an OMTPL extension, do not include the file extension. For all other template files such as RTF or HTM, include the extension. Examples: #COVERPAGE salescoverpage #COVERPAGE salescover2.rtf	String value Note: All cover page template names are stored on the server.
#DESTINATION	Important!This keyword is required in all control files. If you are creating a control file for an Upland AccuRoute server, use this keyword in conjunction with the #RECIPIENT keyword. This keyword indicates the destination address for a recipient. It works with the server, and can be used with Filescan and SMTP connectors. Guidelines: Use the following formats: #DESTINATION [Destination Type] [Destination Information] Possible destination types include: EMAIL - Include the SMTP-formatted e-mail address of the recipient, such as EMAIL user@company.com FAX - Include the fax number of the recipient, such as FAX 1-603-898-5555 or FAX 16038985555. PRINTER - Include the UNC path to the printer, such as PRINTER \\PrintServer\Printer, or the printer's IP address, such as PRINTER 172.16.4.23. Note: If no destination type is indicated, the Filescan connector interprets the destination as a fax number. Do not use spaces in a destination address. Punctuation marks including hyphens, backslashes, and periods are valid. Examples: #DESTINATION EMAIL ksmith@company.com #DESTINATION FAX 16038985555 #DESTINATION 1-603-898-5555 #DESTINATION FAX 898-5555 #DESTINATION 8985555 #DESTINATION PRINTER \\SALES\PRINTER	Fax number (interger value) or email (string value) of the recipient.
#DESTINATION EMBEDDEDDIRECTIVE <Embedded Directive string>	This keyword indicates an Embedded Directive that resides on the Upland AccuRoute server. It works with the AccuRoute Server, and can be used with Filescan and SMTP connectors. Guidelines: When this keyword is used in a control file for traditional Filescan, the embedded directive provides the server with delivery instructions for a document or fax. When this keyword is used in a control file for virtual mode Filescan, the Embedded Directive provides the server with delivery instructions for all documents and faxes copied to the Filescan folder. (The Filescan connector does not delete the control file from the Filescan folder when virtual mode has been configured.) Do not use the #DESTINATION EMBEDDEDDIRECTIVE keyword with the #DESTINATION keyword. Examples: #DESTINATION EMBEDDEDDIRECTIVE KSNP-XXSYXSER-WDAD-PDXD-BECP-DNHXKATTHBRN	String value
#NOTIFY	This keyword indicated the notification setting for a document or fax. It works with the server, and can be used with Filescan and SMTP connectors. Guidelines: Use the following format when indicating the notification setting: #NOTIFY [notification type] [notification destination type] [destination information] Valid notification types are: ALL - Receive notification for success or failure. ALL+FILE - Receive notification for success or failure, and receive the document or fax with the notification. FAILURE - Receive notification for failure only. FAILURE+FILE - Receive notification for failure and receive the document or fax with the notification. SUCCESS - Receive notification for success only. SUCCESS+FILE - Receive notification for success and receive the document or fax with the notification. Valid notification destination types are: EMAIL - Include the SMTP-formatted e-mail address of the recipient, such as EMAIL user@company.com FAX - Include the fax number of the recipient, such as FAX 1-603-898-5555 or FAX 16038985555. PRINTER - Include the UNC path to the printer, such as PRINTER \\PrintServer\Printer, or the printer's IP address, such as PRINTER 172.16.4.23. Examples: #NOTIFY SUCCESS FAX 123456789 #NOTIFY FAILURE PRINTER \\eng\printer1 #NOTIFY FAILURE+FILE EMAIL smith@def.com #NOTIFYALL PRINTER \\eng\printer1	String value containing notification settings
#OVERRIDE token value	This keyword allows you to specify any valid Filescan token/value pair as an override to an Embedded Directive submission. The Embedded Directive Manager will take these values and override the properties on the resultant jobs specified by the Embedded Directive. It works with Upland AccuRoute and fax servers, and can be used with Filescan and XeroxScan connectors. Guidelines: This keyword is only applied for jobs that are sent to the Embedded Directive Manager for processing as an Embedded Directive submission. The most common use of this keyword is to allow the user to override the previously chosen billing_code or prDeliveredDocumentName in the Embedded Directive for each recipient, that is used by the Embedded Directive Manager. Example: #OVERRIDE BILLING_CODE 123^333^444 This would override the billing code for each job in the Embedded Directive.	The token can be any valid Filescan control token (the value depends on the token chosen).
#prDeliveredDocumentProcessing	This keyword determines whether the server should override the attachment handling instructions specified in the connector rule. Guidelines: This keyword pertains to advanced functionality that can merge or split message attachments before they are queued for delivery by an outbound connector. It is optional. When used, it overrides the attachment handling instructions specified in the connector rule and either merges all message attachments or splits them based on a page count or file size policy. Example: #prDeliveredDocumentProcessing 0 This property is set to 0 so that all message attachments will be merged into a single attachment before the message is passed to the outbound connector for delivery. No additional attachment handling instructions are required for this example.	Value can be: 0 to merge all message attachments 1 to split message attachments based on a page count or file size policy 255 to use the message attachment handling instructions specified in the connector rule (This is the default value when this property is not set.)
#prDeliveredSplitProcessing	This keyword provides instructions on how message attachments should be split. Guidelines: This keyword pertains to advanced functionality that can merge or split message attachments before they are queued for delivery by an outbound connector. It is valid only when used in conjunction with variable prDeliveredDocumentProcessing, and the value of this variable is set to 1. This variable requires prDeliveredSplitArgument variable. Example: #prDeliveredDocumentProcessing 1 #prDeliveredSplitProcessing 1 #prDeliveredSplitArgument 2048 In this example, prDeliveredDocumentProcessing is set to 1 so that all message attachments will be split according to a page count policy or file size policy. prDeliveredSplitProcessing is set to 1, and this specifies that all message attachments will be split according to a file size policy. prDeliveredSplitArgument is set to 2048 so that message attachments will be split into attachments that are no larger than 2048KB (2MB).	0 to split message attachments based on a page count policy 1 to split message attachments based on a file size policy
#prDeliveredSplitArgument	This keyword provides instructions on how message attachments should be split. Guidelines: This keyword pertains to advanced functionality that can merge or split message attachments before they are queued for delivery by an outbound connector. It is valid only when used in conjunction with prDeliveredDocumentProcessing and prDeliveredSplitProcessing. For a page count policy: When the first attachment reaches the number of pages specified, the server creates another attachment and continues processing the pages in the document. Additional attachments are created as specified until all the pages in the document are processed. For example, if 3 is the page count policy, the server would process a 7 page document and generate 3 attachments: the first attachment includes pages 1, 2, and 3, the second attachment includes pages 4, 5, and 6, and the third attachment includes page 7. For a file size policy: When the first attachment reaches the file size specified, the server creates another attachment and continues processing the pages in the document. Additional attachments are created as specified until all the pages in the document are processed. If a single page exceeds the file size specified, the page is processed as a 1 page attachment; the resulting attachment is not compressed and cannot be split to comply with the file size restriction. The file size policy was implemented to prevent large attachments. Omtool does not recommend setting file size policies that are smaller than 2MB. Example: #prDeliveredDocumentProcessing 1 #prDeliveredSplitProcessing 1 #prDeliveredSplitArgument 2048	Integer value The integer value represents a page count when #prDeliveredSplitProcessing is set to 0. The integer value represents file size when #prDeliveredSplitProcessing is set to 1.
#prDeliveredSplitMergeFirst	This keyword provides instructions on how message attachments should be split. Guidelines: This keyword pertains to advanced functionality that can merge or split message attachments before they are queued for delivery by an outbound connector. It is valid only when used in conjunction with prDeliveredDocumentProcessing and prDeliveredSplitProcessing. Example: #prDeliveredDocumentProcessing 1 #prDeliveredSplitProcessing 0 #prDeliveredSplitArgument 10 #prDeliveredSplitMergeFirst 0 In this example, prDeliveredDocumentProcessing is set to 1 so that all message attachments will be split according to a page count policy or file size policy. prDeliveredSplitProcessing is set to 1, and this specifies that all message attachments will be split according to a page count policy. prDeliveredSplitArgument is set to 10 so that message attachments will be split into attachments that are no longer than 10 pages. prDeliveredSplitMergeFirst is set to 0 so that all message attachments will be merged into a single attachment before it is split according to the page count policy.	0 \| 1 Use 0 to merge all message attachments before splitting them according to the specified page count or file size policy (The merge order is based on the order in which the user originally added attachments to the message). Use 1 to split message attachments individually according to the specified page count or file size policy (This is the default value when this property is not set.)
#prDeliveredSplitFilenameTemplate	This keyword identifies the filename template that should be used for all message attachments that are processed using the message attachment handling override. (An override occurs when prDeliveredDocumentProcessing is set to 0 or 1). Guidelines: When the message attachment handling configuration specifies that attachments are to be split based on a page count policy or file size policy, the string must include %INDEX% to label the respective parts of each attachment and %ATTACHMENT_INDEX% to label each attachment. If multiple attachments are merged into a single attachment before it is split, %ATTACHMENT_INDEX% can be omitted. Example: #prDeliveredDocumentProcessing 1 #prDeliveredSplitProcessing 0 #prDeliveredSplitArgument 10 #prDeliveredSplitMergeFirst 0 #prDeliveredSplitFilenameTemplate Doc%ATTACHMENT_INDEX%Part%INDEX%%RECIP_NAME% In this example, prDeliveredDocumentProcessing is set to 1 so that all message attachments will be split according to a page count policy or file size policy. prDeliveredSplitProcessing is set to 1, and this specifies that all message attachments will be split according to a page count policy. prDeliveredSplitArgument is set to 10 so that message attachments will be split into attachments that are no longer than 10 pages. prDeliveredSplitMergeFirst is set to 0 so that all message attachments will be merged into a single attachment before it is split according to the page count policy. prDeliveredSplitFilenameTemplate is set to Doc%ATTACHMENT_INDEX%Part%INDEX%%RECIP_NAME% so that a resulting attachment might look similar to the following: Doc1Part3AnnaBarger.PDF	The following variables have been qualified for use with this variable: %INDEX% (Variable represents the respective parts of an attachment after it has been split. For example, if an attachment is split into 4 parts, the respective parts are identified by the index numbers 1, 2, 3, and 4.) %ATTACHMENT_INDEX% (Variable represents the number of an attachment. Attachments are numbered in the same order they are attached by the user. If the message attachment handling configuration specifies that all attachments should be merged into a single attachment before it is split based on a page count or file size policy, then there is only one merged attachment and its index is 1.) %prRecipientID% SUBJECT% %COMMENT% %RECIP_NAME% %SENDER_NAME% %prDestination% %prOriginator% %SENDER_COMPANY% %SENDER_BUSINESS_FAX_PHONE% %SENDER_BUSINESS_PHONE% %prBillingCode%
#prDocumentStampName	This keyword provides the Document Stamp name you want to apply when used in routing rules or from FileScan. Guidelines: You must include the name of the Document Stamp as it was entered when configured by the Administrator. The name is not case-sensitive. Examples: To create the appearance of a fax on an internal document sent to a printer (not via actual fax), one could mimic the look of the line of text typically at the top of a fax page by using a Document Stamp instead. While Document Stamps do not offer the transparency of a watermark, another example of their use would be to apply the term "DRAFT" or "Confidential" diagonally across a page. You can apply a transparent image, but any variable or text used will appear in full opacity.	Document Stamp name
#PREVIEW_REQUIRED	This keyword indicates that preview of the composed document or fax has been requested. It works with the Upland AccuRoute server, and can be used with Filescan and SMTP connectors. Guidelines: You must include the sender's e-mail address. When a preview of the document or fax is available, the server sends a notification message to the sender's e-mail address. (The notification message contains a link to the preview in the Web Client.) Example:#PREVIEW_REQUIRED YES	YES or Y to request preview.
#prGroupFolderUseSuppliedCredIfAvailable	This keyword provides instructions on whether or not alternate credentials are provided. Example: #SENDER_EMAIL Abc_Co@company.com #DESTINATION UNC ftp://111.222.333.444 #\\prGroupFolderUseSuppliedCredsIfAvailable 1 #\\prUserCredentials\prUserName bsmith #\\prUserCredentials\prPassword b88sm1th #ATTACHMENT C:\Users\raghu\Desktop\ARD2.1.02_StatusReport.doc	0 \| 1 Use 0 to not apply the alternate credentials provided and not deliver the file to FTP. Use 1 to apply the alternate credentials provided and deliver the file to FTP
#PRIORITY	This keyword indicates the priority associated with a document or fax. It works with the Upland AccuRoute server, and can be used with Filescan and SMTP connectors. Guidelines: When the control file does not include this keyword, the document or fax is delivered with normal priority. Example:#PRIORITY LOW	HIGH \| NORMAL \| LOW
#RECIPIENT	This keyword indicates the beginning of a recipient section. It works with the Upland AccuRoute server, and can be used with Filescan and SMTP connectors. Guidelines: This keyword is required in all control files. Example: ;Recipient 1 #RECIPIENT #RECIP_NAME Mary Jones #DESTINATION FAX 16035554545	None
#RECIP_NAME	This keyword indicate the recipient's name. It works with the Upland AccuRoute server, and can be used with Filescan and SMTP connectors. Guidelines: Use this keyword in the recipient section, following the #RECIPIENT variable. Example: #RECIPIENT #RECIP_NAME Harry Jones	String value containing the recipient's name
SECURE_DELIVERY	This keyword indicated whether secure delivery is required for the fax. It works with the Upland AccuRoute server, and can be used with Filescan and SMTP connectors. Guidelines: Secure delivery must be enabled on the server if you want to send a fax with secure delivery. If secure delivery has not been enabled on the server, the Filescan connector ignores the keyword and sends the fax immediately. Example: #SECURE_DELIVERY YES	YES \| TRUE \| No \| FALSE \| Use YES, TRUE to request secure delivery. Use NO, FALSE or do not use the variable if you do not want to request secure delivery.
#SEND_AFTER	This keyword indicates the date and time when the server should attempt to send the fax. It works with the Upland AccuRoute server, and can be used with Filescan and SMTP connectors. Guidelines: Use one of the following formats: MM/DD/YYYY HH:MM:SS[am/pm] For example, 03/26/2002 12:30:00pm Month Day, Year HH:MM:SS[am/pm] For example, March 26, 2002 12:30:00pm HH:MM:SS[am/pm] Mon. Day, Year For example, 12:30:00pm Mar. 26, 2002 Example: #SEND_AFTER 03/26/2002 12:30:00pm	String value with the date and time when the server should attempt to deliver the fax
#SENDER_BUSINESS_ADDRESS	This keyword indicates the sender's business address. It works with the Upland AccuRoute server, and can be used with Filescan and SMTP connectors. Guidelines: If the document or fax requires a cover page, and the cover page template has been configured to display the sender's business address, the sender's business address appears on the cover page. Example:#SENDER_BUSINESS_ADDRESS 14 South St.	String value containing the address
#SENDER_BUSINESS_CITY	This keyword indicates the city associated with the sender's business address. It works with the Upland AccuRoute server, and can be used with Filescan and SMTP connectors. Guidelines: If the document or fax requires a cover page, and the cover page template has been configured to display the city associated with the sender's business address, the city appears on the cover page. Example:#SENDER_BUSINESS_CITY Newton	String value
#SENDER_BUSINESS_FAX_NUMBER	This keyword indicates the city associated with the sender's business fax number. It works with the Upland AccuRoute server, and can be used with Filescan and SMTP connectors. Guidelines: If the document or fax requires a cover page, and the cover page template has been configured to display the sender's business fax number, the fax number appears on the cover page. Example: #SENDER_BUSINESS_FAX_NUMBER 603-555-1234	String value containing the fax number
#SENDER_BUSINESS_STATE	This keyword indicates the state associated with the sender's business address. It works with the server, and can be used with Filescan and SMTP connectors. Guidelines: If the document or fax requires a cover page, and the cover page template has been configured to display the state associated with the sender's business address, the state appears on the cover page. Example:#SENDER_BUSINESS_STATE NH	String value containing the state
#SENDER_BUSINESS_ZIPCODE	This keyword indicates the zip code associated with the sender's business address. It works with the Upland AccuRoute server, and can be used with Filescan and SMTP connectors. Guidelines: If the document or fax requires a cover page, and the cover page template has been configured to display the zip code associated with the sender's business address, the zip code appears on the cover page. Example:#BUSINESS_ZIPCODE 03103	String value containing the zip code
#SENDER_COMPANY	This keyword indicates sender's company name. It works with the Upland AccuRoute server, and can be used with Filescan and SMTP connectors. Guidelines: If the document or fax requires a cover page, and the cover page template has been configured to display the sender's company name, the company name appears on the cover page. Example:#SENDER_COMPANY XYZ Corporation	String value containing the company name
#SENDER_DEPARTMENT	This keyword indicates sender's department name. It works with the Upland AccuRoute server, and can be used with Filescan and SMTP connectors. Guidelines: If the document or fax requires a cover page, and the cover page template has been configured to display the sender's department name, the department name appears on the cover page. Example:#SENDER_DEPARTMENT Marketing	String value containing the department name
#SENDER_DISPLAY_NAME	This keyword indicates sender's display name. It works with the Upland AccuRoute server, and can be used with Filescan and SMTP connectors. Guidelines: If the document or fax requires a cover page, and the cover page template has been configured to display the sender's display name, the display name appears on the cover page. Example:#SENDER_DISPLAY_NAME John Smith	String value containing the display name
#SENDER_EMAIL	This keyword indicates sender's e-mail address. It works with the Upland AccuRoute server, and can be used with Filescan and SMTP connectors. Guidelines: The server uses this email address for notification messages. This keyword is required in all control files. Example:#SENDER_EMAIL janesmith@company.com	String value containing the email address.
#SENDER_NAME	This keyword indicates sender's name. It works with the Upland AccuRoute server, and can be used with Filescan and SMTP connectors. Guidelines: If the document or fax requires a cover page, and the cover page template has been configured to display the sender's name, the name appears on the cover page. Example:#SENDER_NAME John Smith	String value containing the name
#SENDER_WEBADDRESS	This keyword indicates sender's web site address. It works with the Upland AccuRoute server, and can be used with Filescan and SMTP connectors. Guidelines: If the document or fax requires a cover page, and the cover page template has been configured to display the sender's web site address, the web site address appears on the cover page. Example:#SENDER_WEBADDRESS=http://www.xyzcorp.com	Web URL
#SUBJECT	This keyword indicates the subject of the outbound document or fax. It works with the Upland AccuRoute server, and can be used with Filescan and SMTP connectors. Guidelines: If the document or fax requires a cover page, and the cover page template has been configured to display the subject (%SUBJECT%), the subject appears on the cover page. Additionally, if the server generates a notification message pertaining to the document or fax, and the notification template has been configured to display the subject (%ORIGINAL_SUBJECT%), the subject appears in the notification message. Example: #SUBJECT Proposed estimates for contract	String value containing the subject
#USE_MYACCUROUTE	This keyword sets the flag that identifies the job as a My Upland AccuRoute submission. It works with Upland AccuRoute servers and can be used with Filescan and XeroxScan connectors. Guidelines:This value is used to indicate that the job should use the Embedded Directive that is specified in the sender's My Upland AccuRoute configuration, or, if no such Embedded Directive exists, the job should be OCRd to PDF image + text and sent via e-mail back to the originator or destination. When the value is not FALSE, the server looks for the default Embedded Directive. If a default Embedded Directive is not found, the server delivers the document to the destination and applies the final form specified in the routing rules. When the value is TRUE or ORIGINATOR, the server uses the Originator of the submitted job to find the default Embedded Directive. If a default Embedded Directive is not found, the server uses the ORIGINATOR value as the address to deliver the OCR.PDF to. When the value is DESTINATION , the server uses the destination of the submitted job to find the default Embedded Directive. If a default Embedded Directive is not found, the server uses the DESTINATION value as the address to deliver the OCR.PDF to. Examples: #USE_MYACCUROUTE TRUE	TRUE \| FALSE \| ORIGINATOR \|DESTINATION Use TRUE, ORIGINATOR or DESTINATION to indicate that the job is a MyAccuRoute submission. Use FALSE to indicate that the job is not a MyAccuRoute submission. The flag is used by the Embedded Directive Manager.

Keyword

Description

Value

#ACCUROUTE_BATCH

This keyword allows the control file to specify that the attachments are to be treated as batch processing by the Embedded Directive Manager. It works with Upland AccuRoute servers and can be used with Filescan and XeroxScan connectors.

Guidelines: This property should be used to indicate the document contains one or more routing sheets, and that the job should be split at each routing sheet and treated as a number of separate jobs.

Example:

#ACCUROUTE_BATCH TRUE

TRUE|FALSE

TRUE to indicate the job is a batch.

FALSE to indicate the job is not a batch.

#ACCUROUTE_BATCH_COUNT

This keyword allows the control file to specify the number of expected jobs to be found in the ACCUROUTE_BATCH. If this value is not specified, the Embedded Directive Manager assumes it found all the separate jobs in the batch correctly. It works with Upland AccuRoute servers and can be used with Filescan and XeroxScan connectors

Guidelines: This property should be used if ACCUROUTE_BATCH is TRUE, and the submitter knows the exact count of Routing Sheets. This can help decrease the chance that a batch job is separated incorrectly (for example, the submitter does not realize there is a missing routing sheet).

This property can be used in a virtual control file, but as the batch count will change with every submission, it would require editing the virtual control file every time a new batch is submitted. An alternative would be to set up multiple scan folders that correspond to the batch count and put a virtual control file in each folder. For example, a folder named 1Batch could contain a virtual control file using the property #ACCUROUTE_BATCH_COUNT_1, while a folder named 2Batch could contain a virtual control file using the property #ACCUROUTE_BATCH_COUNT_2, etc.

Example:

#ACCUROUTE_BATCH_COUNT 10

Integer value

#ACCESS_CODE

This keyword indicates the sender's personal access code used to send faxes. It works with Upland AccuRoute and fax servers, and can be used with Filescan and SMTP connectors.

Guidelines: The value for this keyword should match the value in a dialing rule on the server. If it does not, the server processes the fax, but the telephone system your company uses might prevent delivery.

Example:

#ACCESS_CODE 1234

Sender's personal access code.

#APPROVAL

This keyword determines whether a fax requires approval before the server can deliver it. It works with the Upland AccuRoute server, and can be used with Filescan and SMTP connectors.

Guidelines: If all the sender's faxes must be approved, then this keyword must be included in the control file with a YES or TRUE value. If approval is optional for the sender, all possible values are valid. If the sender or server has not been configured for approval, the connector ignores this keyword.

Example:

#APPROVAL YES

TRUE|FALSE

#ATTACHMENT

This keyword indicates the files that should be sent as part of the document or fax. It works with the Upland AccuRoute server, and can be used with Filescan connectors.

Guidelines: This keyword is required in the control file if you are sending a document or fax via the server. You can select any file in a supported file format.

Examples:

#ATTACHMENT filename.txt
#ATTACHMENT \\computer\folder\filename

The file name of a document if the document is copied to the Filescan folder with the control file.

Note: The Filescan connector removes the file from the Filescan folder.

The path to a document if the document is not copied to the Filescan folder. The path to the document must be a fully qualified file path, such as: \\computer\folder\filename or G:\\folder\filename

Note: The Filescan folder might be located on a different computer than the computer where you create the control file. In this instance, the example G:\\folder\filename means that the attachment is located on the G drive of the computer where the Filescan folder is located.

#BILLING_CODE

This keyword indicates the billing code associated with a document or fax. It works with the Upland AccuRoute server, and can be used with Filescan and SMTP connectors.

Example:

#BILLING_CODE 55512347

Integer value

#COMMENTS

This keyword indicates the comments that should appear on the cover page of the document or fax. It works with theUpland AccuRoute server, and can be used with Filescan and SMTP connectors.

Example:

#COMMENTS Hi Bill, this is the document I promised to send. Call me anytime with questions. Thanks again for your help.

String value

#COVERPAGE

This keyword indicates the cover page style that should be included with the document or fax. It works with the Upland AccuRouteserver, and can be used with Filescan and SMTP connectors.

Guidelines: You can select a different cover page style for each recipient, or select one for all recipients. If you want to use one cover page style for all recipients, position the keyword before indicating any recipients. If you want to use a different cover page style for each recipient, include the keyword after indicating each recipient.

For cover page templates with an OMTPL extension, do not include the file extension. For all other template files such as RTF or HTM, include the extension.

Examples:

#COVERPAGE salescoverpage
#COVERPAGE salescover2.rtf

String value

Note: All cover page template names are stored on the server.

#DESTINATION

Important!This keyword is required in all control files. If you are creating a control file for an Upland AccuRoute server, use this keyword in conjunction with the #RECIPIENT keyword.

This keyword indicates the destination address for a recipient. It works with the server, and can be used with Filescan and SMTP connectors.

Guidelines: Use the following formats:

#DESTINATION [Destination Type] [Destination Information]

Possible destination types include:

EMAIL - Include the SMTP-formatted e-mail address of the recipient, such as EMAIL user@company.com
FAX - Include the fax number of the recipient, such as FAX 1-603-898-5555 or FAX 16038985555.
PRINTER - Include the UNC path to the printer, such as PRINTER \\PrintServer\Printer, or the printer's IP address, such as PRINTER 172.16.4.23.

Note: If no destination type is indicated, the Filescan connector interprets the destination as a fax number. Do not use spaces in a destination address. Punctuation marks including hyphens, backslashes, and periods are valid.

Examples:

#DESTINATION EMAIL ksmith@company.com
#DESTINATION FAX 16038985555
#DESTINATION 1-603-898-5555
#DESTINATION FAX 898-5555
#DESTINATION 8985555
#DESTINATION PRINTER \\SALES\PRINTER

Fax number (interger value) or email (string value) of the recipient.

#DESTINATION EMBEDDEDDIRECTIVE <Embedded Directive string>

This keyword indicates an Embedded Directive that resides on the Upland AccuRoute server. It works with the AccuRoute Server, and can be used with Filescan and SMTP connectors.

Guidelines: When this keyword is used in a control file for traditional Filescan, the embedded directive provides the server with delivery instructions for a document or fax. When this keyword is used in a control file for virtual mode Filescan, the Embedded Directive provides the server with delivery instructions for all documents and faxes copied to the Filescan folder. (The Filescan connector does not delete the control file from the Filescan folder when virtual mode has been configured.)

Do not use the #DESTINATION EMBEDDEDDIRECTIVE keyword with the #DESTINATION keyword.

Examples:

#DESTINATION EMBEDDEDDIRECTIVE KSNP-XXSYXSER-WDAD-PDXD-BECP-DNHXKATTHBRN

String value

#NOTIFY

This keyword indicated the notification setting for a document or fax. It works with the server, and can be used with Filescan and SMTP connectors.

Guidelines: Use the following format when indicating the notification setting:

#NOTIFY [notification type] [notification destination type] [destination information]

Valid notification types are:

ALL - Receive notification for success or failure.
ALL+FILE - Receive notification for success or failure, and receive the document or fax with the notification.
FAILURE - Receive notification for failure only.
FAILURE+FILE - Receive notification for failure and receive the document or fax with the notification.
SUCCESS - Receive notification for success only.
SUCCESS+FILE - Receive notification for success and receive the document or fax with the notification.

Valid notification destination types are:

EMAIL - Include the SMTP-formatted e-mail address of the recipient, such as EMAIL user@company.com
FAX - Include the fax number of the recipient, such as FAX 1-603-898-5555 or FAX 16038985555.
PRINTER - Include the UNC path to the printer, such as PRINTER \\PrintServer\Printer, or the printer's IP address, such as PRINTER 172.16.4.23.

Examples:

#NOTIFY SUCCESS FAX 123456789
#NOTIFY FAILURE PRINTER \\eng\printer1
#NOTIFY FAILURE+FILE EMAIL smith@def.com
#NOTIFYALL PRINTER \\eng\printer1

String value containing notification settings

#OVERRIDE token value

This keyword allows you to specify any valid Filescan token/value pair as an override to an Embedded Directive submission. The Embedded Directive Manager will take these values and override the properties on the resultant jobs specified by the Embedded Directive. It works with Upland AccuRoute and fax servers, and can be used with Filescan and XeroxScan connectors.

Guidelines: This keyword is only applied for jobs that are sent to the Embedded Directive Manager for processing as an Embedded Directive submission. The most common use of this keyword is to allow the user to override the previously chosen billing_code or prDeliveredDocumentName in the Embedded Directive for each recipient, that is used by the Embedded Directive Manager.

Example:

#OVERRIDE BILLING_CODE 123^333^444 This would override the billing code for each job in the Embedded Directive.

The token can be any valid Filescan control token (the value depends on the token chosen).

#prDeliveredDocumentProcessing

This keyword determines whether the server should override the attachment handling instructions specified in the connector rule.

Guidelines: This keyword pertains to advanced functionality that can merge or split message attachments before they are queued for delivery by an outbound connector. It is optional. When used, it overrides the attachment handling instructions specified in the connector rule and either merges all message attachments or splits them based on a page count or file size policy.

Example:

#prDeliveredDocumentProcessing 0

This property is set to 0 so that all message attachments will be merged into a single attachment before the message is passed to the outbound connector for delivery. No additional attachment handling instructions are required for this example.

Value can be:

0 to merge all message attachments
1 to split message attachments based on a page count or file size policy
255 to use the message attachment handling instructions specified in the connector rule (This is the default value when this property is not set.)

#prDeliveredSplitProcessing

This keyword provides instructions on how message attachments should be split.

Guidelines: This keyword pertains to advanced functionality that can merge or split message attachments before they are queued for delivery by an outbound connector. It is valid only when used in conjunction with variable prDeliveredDocumentProcessing, and the value of this variable is set to 1.

This variable requires prDeliveredSplitArgument variable.

Example:

#prDeliveredDocumentProcessing 1
#prDeliveredSplitProcessing 1
#prDeliveredSplitArgument 2048

0 to split message attachments based on a page count policy
1 to split message attachments based on a file size policy

#prDeliveredSplitArgument

This keyword provides instructions on how message attachments should be split.

Guidelines: This keyword pertains to advanced functionality that can merge or split message attachments before they are queued for delivery by an outbound connector. It is valid only when used in conjunction with prDeliveredDocumentProcessing and prDeliveredSplitProcessing.

For a page count policy: When the first attachment reaches the number of pages specified, the server creates another attachment and continues processing the pages in the document. Additional attachments are created as specified until all the pages in the document are processed. For example, if 3 is the page count policy, the server would process a 7 page document and generate 3 attachments: the first attachment includes pages 1, 2, and 3, the second attachment includes pages 4, 5, and 6, and the third attachment includes page 7.
For a file size policy: When the first attachment reaches the file size specified, the server creates another attachment and continues processing the pages in the document. Additional attachments are created as specified until all the pages in the document are processed. If a single page exceeds the file size specified, the page is processed as a 1 page attachment; the resulting attachment is not compressed and cannot be split to comply with the file size restriction. The file size policy was implemented to prevent large attachments. Omtool does not recommend setting file size policies that are smaller than 2MB.

Example:

#prDeliveredDocumentProcessing 1
#prDeliveredSplitProcessing 1
#prDeliveredSplitArgument 2048

Integer value

The integer value represents a page count when #prDeliveredSplitProcessing is set to 0.

The integer value represents file size when #prDeliveredSplitProcessing is set to 1.

#prDeliveredSplitMergeFirst

This keyword provides instructions on how message attachments should be split.

Guidelines: This keyword pertains to advanced functionality that can merge or split message attachments before they are queued for delivery by an outbound connector. It is valid only when used in conjunction with prDeliveredDocumentProcessing and prDeliveredSplitProcessing.

Example:

#prDeliveredDocumentProcessing 1
#prDeliveredSplitProcessing 0
#prDeliveredSplitArgument 10
#prDeliveredSplitMergeFirst 0

In this example, prDeliveredDocumentProcessing is set to 1 so that all message attachments will be split according to a page count policy or file size policy. prDeliveredSplitProcessing is set to 1, and this specifies that all message attachments will be split according to a page count policy. prDeliveredSplitArgument is set to 10 so that message attachments will be split into attachments that are no longer than 10 pages. prDeliveredSplitMergeFirst is set to 0 so that all message attachments will be merged into a single attachment before it is split according to the page count policy.

0 | 1

Use 0 to merge all message attachments before splitting them according to the specified page count or file size policy (The merge order is based on the order in which the user originally added attachments to the message).

Use 1 to split message attachments individually according to the specified page count or file size policy (This is the default value when this property is not set.)

#prDeliveredSplitFilenameTemplate

This keyword identifies the filename template that should be used for all message attachments that are processed using the message attachment handling override. (An override occurs when prDeliveredDocumentProcessing is set to 0 or 1).

Guidelines: When the message attachment handling configuration specifies that attachments are to be split based on a page count policy or file size policy, the string must include %INDEX% to label the respective parts of each attachment and %ATTACHMENT_INDEX% to label each attachment. If multiple attachments are merged into a single attachment before it is split, %ATTACHMENT_INDEX% can be omitted.

Example:

#prDeliveredDocumentProcessing 1
#prDeliveredSplitProcessing 0
#prDeliveredSplitArgument 10
#prDeliveredSplitMergeFirst 0
#prDeliveredSplitFilenameTemplate Doc%ATTACHMENT_INDEX%Part%INDEX%%RECIP_NAME%

The following variables have been qualified for use with this variable:

%INDEX% (Variable represents the respective parts of an attachment after it has been split. For example, if an attachment is split into 4 parts, the respective parts are identified by the index numbers 1, 2, 3, and 4.)
%ATTACHMENT_INDEX% (Variable represents the number of an attachment. Attachments are numbered in the same order they are attached by the user. If the message attachment handling configuration specifies that all attachments should be merged into a single attachment before it is split based on a page count or file size policy, then there is only one merged attachment and its index is 1.)
%prRecipientID%
SUBJECT%
%COMMENT%
%RECIP_NAME%
%SENDER_NAME%
%prDestination%
%prOriginator%
%SENDER_COMPANY%
%SENDER_BUSINESS_FAX_PHONE%
%SENDER_BUSINESS_PHONE%
%prBillingCode%

#prDocumentStampName

This keyword provides the Document Stamp name you want to apply when used in routing rules or from FileScan.

Guidelines: You must include the name of the Document Stamp as it was entered when configured by the Administrator. The name is not case-sensitive.

Examples: To create the appearance of a fax on an internal document sent to a printer (not via actual fax), one could mimic the look of the line of text typically at the top of a fax page by using a Document Stamp instead.

While Document Stamps do not offer the transparency of a watermark, another example of their use would be to apply the term "DRAFT" or "Confidential" diagonally across a page. You can apply a transparent image, but any variable or text used will appear in full opacity.

Document Stamp name

#PREVIEW_REQUIRED

This keyword indicates that preview of the composed document or fax has been requested. It works with the Upland AccuRoute server, and can be used with Filescan and SMTP connectors.

Guidelines: You must include the sender's e-mail address. When a preview of the document or fax is available, the server sends a notification message to the sender's e-mail address. (The notification message contains a link to the preview in the Web Client.)

Example:#PREVIEW_REQUIRED YES

YES or Y to request preview.

#prGroupFolderUseSuppliedCredIfAvailable

This keyword provides instructions on whether or not alternate credentials are provided.

Example:

#SENDER_EMAIL Abc_Co@company.com
#DESTINATION UNC ftp://111.222.333.444
#\\prGroupFolderUseSuppliedCredsIfAvailable 1
#\\prUserCredentials\prUserName bsmith
#\\prUserCredentials\prPassword b88sm1th
#ATTACHMENT C:\Users\raghu\Desktop\ARD2.1.02_StatusReport.doc

0 | 1

Use 0 to not apply the alternate credentials provided and not deliver the file to FTP.

Use 1 to apply the alternate credentials provided and deliver the file to FTP

#PRIORITY

This keyword indicates the priority associated with a document or fax. It works with the Upland AccuRoute server, and can be used with Filescan and SMTP connectors.

Guidelines: When the control file does not include this keyword, the document or fax is delivered with normal priority.

Example:#PRIORITY LOW

HIGH | NORMAL | LOW

#RECIPIENT

This keyword indicates the beginning of a recipient section. It works with the Upland AccuRoute server, and can be used with Filescan and SMTP connectors.

Guidelines: This keyword is required in all control files.

Example:

;Recipient 1
#RECIPIENT
#RECIP_NAME Mary Jones
#DESTINATION FAX 16035554545

None

#RECIP_NAME

This keyword indicate the recipient's name. It works with the Upland AccuRoute server, and can be used with Filescan and SMTP connectors.

Guidelines: Use this keyword in the recipient section, following the #RECIPIENT variable.

Example:

#RECIPIENT
#RECIP_NAME Harry Jones

String value containing the recipient's name

SECURE_DELIVERY

This keyword indicated whether secure delivery is required for the fax. It works with the Upland AccuRoute server, and can be used with Filescan and SMTP connectors.

Guidelines: Secure delivery must be enabled on the server if you want to send a fax with secure delivery. If secure delivery has not been enabled on the server, the Filescan connector ignores the keyword and sends the fax immediately.

Example: #SECURE_DELIVERY YES

YES | TRUE | No | FALSE |

Use YES, TRUE to request secure delivery. Use NO, FALSE or do not use the variable if you do not want to request secure delivery.

#SEND_AFTER

This keyword indicates the date and time when the server should attempt to send the fax. It works with the Upland AccuRoute server, and can be used with Filescan and SMTP connectors.

Guidelines: Use one of the following formats:

MM/DD/YYYY HH:MM:SS[am/pm]
For example, 03/26/2002 12:30:00pm
Month Day, Year HH:MM:SS[am/pm]
For example, March 26, 2002 12:30:00pm
HH:MM:SS[am/pm] Mon. Day, Year
For example, 12:30:00pm Mar. 26, 2002

Example: #SEND_AFTER 03/26/2002 12:30:00pm

String value with the date and time when the server should attempt to deliver the fax

#SENDER_BUSINESS_ADDRESS

This keyword indicates the sender's business address. It works with the Upland AccuRoute server, and can be used with Filescan and SMTP connectors.

Guidelines: If the document or fax requires a cover page, and the cover page template has been configured to display the sender's business address, the sender's business address appears on the cover page.

Example:#SENDER_BUSINESS_ADDRESS 14 South St.

String value containing the address

#SENDER_BUSINESS_CITY

This keyword indicates the city associated with the sender's business address. It works with the Upland AccuRoute server, and can be used with Filescan and SMTP connectors.

Guidelines: If the document or fax requires a cover page, and the cover page template has been configured to display the city associated with the sender's business address, the city appears on the cover page.

Example:#SENDER_BUSINESS_CITY Newton

String value

#SENDER_BUSINESS_FAX_NUMBER

This keyword indicates the city associated with the sender's business fax number. It works with the Upland AccuRoute server, and can be used with Filescan and SMTP connectors.

Guidelines: If the document or fax requires a cover page, and the cover page template has been configured to display the sender's business fax number, the fax number appears on the cover page.

Example:

#SENDER_BUSINESS_FAX_NUMBER 603-555-1234

String value containing the fax number

#SENDER_BUSINESS_STATE

This keyword indicates the state associated with the sender's business address. It works with the server, and can be used with Filescan and SMTP connectors.

Guidelines: If the document or fax requires a cover page, and the cover page template has been configured to display the state associated with the sender's business address, the state appears on the cover page.

Example:#SENDER_BUSINESS_STATE NH

String value containing the state

#SENDER_BUSINESS_ZIPCODE

This keyword indicates the zip code associated with the sender's business address. It works with the Upland AccuRoute server, and can be used with Filescan and SMTP connectors.

Guidelines: If the document or fax requires a cover page, and the cover page template has been configured to display the zip code associated with the sender's business address, the zip code appears on the cover page.

Example:#BUSINESS_ZIPCODE 03103

String value containing the zip code

#SENDER_COMPANY

This keyword indicates sender's company name. It works with the Upland AccuRoute server, and can be used with Filescan and SMTP connectors.

Guidelines: If the document or fax requires a cover page, and the cover page template has been configured to display the sender's company name, the company name appears on the cover page.

Example:#SENDER_COMPANY XYZ Corporation

String value containing the company name

#SENDER_DEPARTMENT

This keyword indicates sender's department name. It works with the Upland AccuRoute server, and can be used with Filescan and SMTP connectors.

Guidelines: If the document or fax requires a cover page, and the cover page template has been configured to display the sender's department name, the department name appears on the cover page.

Example:#SENDER_DEPARTMENT Marketing

String value containing the department name

#SENDER_DISPLAY_NAME

This keyword indicates sender's display name. It works with the Upland AccuRoute server, and can be used with Filescan and SMTP connectors.

Guidelines: If the document or fax requires a cover page, and the cover page template has been configured to display the sender's display name, the display name appears on the cover page.

Example:#SENDER_DISPLAY_NAME John Smith

String value containing the display name

#SENDER_EMAIL

This keyword indicates sender's e-mail address. It works with the Upland AccuRoute server, and can be used with Filescan and SMTP connectors.

Guidelines: The server uses this email address for notification messages. This keyword is required in all control files.

Example:#SENDER_EMAIL janesmith@company.com

String value containing the email address.

#SENDER_NAME

This keyword indicates sender's name. It works with the Upland AccuRoute server, and can be used with Filescan and SMTP connectors.

Guidelines: If the document or fax requires a cover page, and the cover page template has been configured to display the sender's name, the name appears on the cover page.

Example:#SENDER_NAME John Smith

String value containing the name

#SENDER_WEBADDRESS

This keyword indicates sender's web site address. It works with the Upland AccuRoute server, and can be used with Filescan and SMTP connectors.

Guidelines: If the document or fax requires a cover page, and the cover page template has been configured to display the sender's web site address, the web site address appears on the cover page.

Example:#SENDER_WEBADDRESS=http://www.xyzcorp.com

Web URL

#SUBJECT

This keyword indicates the subject of the outbound document or fax. It works with the Upland AccuRoute server, and can be used with Filescan and SMTP connectors.

Guidelines: If the document or fax requires a cover page, and the cover page template has been configured to display the subject (%SUBJECT%), the subject appears on the cover page. Additionally, if the server generates a notification message pertaining to the document or fax, and the notification template has been configured to display the subject (%ORIGINAL_SUBJECT%), the subject appears in the notification message.

Example:

#SUBJECT Proposed estimates for contract

String value containing the subject

#USE_MYACCUROUTE

This keyword sets the flag that identifies the job as a My Upland AccuRoute submission. It works with Upland AccuRoute servers and can be used with Filescan and XeroxScan connectors.

Guidelines:This value is used to indicate that the job should use the Embedded Directive that is specified in the sender's My Upland AccuRoute configuration, or, if no such Embedded Directive exists, the job should be OCRd to PDF image + text and sent via e-mail back to the originator or destination.

When the value is not FALSE, the server looks for the default Embedded Directive. If a default Embedded Directive is not found, the server delivers the document to the destination and applies the final form specified in the routing rules.
When the value is TRUE or ORIGINATOR, the server uses the Originator of the submitted job to find the default Embedded Directive. If a default Embedded Directive is not found, the server uses the ORIGINATOR value as the address to deliver the OCR.PDF to.
When the value is DESTINATION , the server uses the destination of the submitted job to find the default Embedded Directive. If a default Embedded Directive is not found, the server uses the DESTINATION value as the address to deliver the OCR.PDF to.

Examples:

#USE_MYACCUROUTE TRUE

TRUE | FALSE | ORIGINATOR |DESTINATION

Use TRUE, ORIGINATOR or DESTINATION to indicate that the job is a MyAccuRoute submission. Use FALSE to indicate that the job is not a MyAccuRoute submission. The flag is used by the Embedded Directive Manager.

Control File Keywords List

See also