Configuring Additional Devices

This topic provides information on additional devices that you can enable to work with Cypress.

Fax Devices

The Cypress Fax Server module enables your DocuVault to receive documents from inbound fax systems and send documents and reports to outbound fax systems. A fax device enables documents to be faxed to and from Cypress, based on your Cypress License Agreement. This topic describes how to configure fax devices to accept inbound faxes, send outbound faxes, or both.

To enable inbound faxing, you must use one of the supported Brooktrout TR series fax boards.

Sending Faxes to a DocuVault

The Cypress Fax Server enables you to fax documents directly to a DocuVault for automated processing and delivery. This feature—which requires that either the Brooktrout TR 114 Series or Brooktrout TR 1034 Series fax board be installed on the Cypress Server—enables faxes to be received over digital or analog lines. See Configuring the Brooktrout TR1034 Fax Board for configuration required for the Brooktrout TR1034 fax board.

Inbound fax information that the DocuVault uses to control processing (e.g., indexing or routing) varies based on your physical telecommunications and the functions enabled in your Cypress License Agreement. Cypress stores the information as page variables that various DocuVault functions can call for process control. This table lists the control information and associated page variables:

Control Information

Description

Page Variable

Called Party

The fax number called by the sending fax system

did

Calling Party

The fax number of the sending system

calling_party

Station ID

A 20-character string configured on the sending fax system

station_id

Sending Faxes from a DocuVault

You can send a fax from a DocuVault to a recipient defined in the Cypress Address Book, or to a specific fax number.

Faxing documents to a Recipient-defined Fax Machine

In a recipient definition, you can include the fax number of the machine at which the recipient can receive faxes. Because a fax machine is associated with a recipient definition, you can send a document to a recipient’s fax, just as you would to a recipient's printer or other output destination. The DocuVault will send a document to a recipient-defined fax machine if the document specifies fax as the required device type, or if Cypress resolves document delivery to a fax machine based on the recipient's device priorities. You can fax a document to a recipient using one of these methods:

Calling the capture driver from Windows applications, DocuSpaces, and Inbox Viewers
Configuring an RDM subreport
Using InLine commands

Faxing to a Specific Fax Number

As many outbound documents need to be faxed outside the enterprise, Cypress allows you to send a document or report to a specific fax number. An end user can specify a fax number using any of these methods:

The Cypress Fax Wizard
Including an InLine command in the document
Configuring an Report Distribution Manager (RDM) subreport

Creating a Fax Device

To create a Cypress.Fax device

1. Open the Administration Tools module, and select the Device tab.
2. Click the New button to create a new device definition.
3. Select the General Tab, if it is not already open.

a. Enter the name of the fax device in the Name input field.
b. Select the device DLL from the Device DLL drop-down list. This table provides a guide to choosing the appropriate device DLL, link DLL, and unit settings:

Fax Board

Device DLL

Link DLL

Unit

Brooktrout TR 114 Series

bt_114

<None>

Channel Number (such as 2)

Brooktrout TR 1034 Series

bt_1034

<None>

Channel Number (such as 2)

Other

fax

tapidata_io

Com Port Number (such as com1)

SR140

bt_SR140

<None>

Channel Number (such as 2)

If the Unit field is left blank, Cypress will automatically connect to the first available fax channel or modem card installed at the server.
4. Choose the link DLL from the Link DLL drop-down list, using the table in step b. as a guide.
5. If required, enter ignore_dialtone in the Dialects input field. This dialect is offered for customers in countries where modems experience difficulty detecting a dial tone and results in instructing the modem not to listen for a dial tone prior to dialing.
6. Enter the fax line in the Unit field, using the table in step 5 as a guide.
7. Select the Fax tab.

8. In the Station ID field, enter a value up to 20 characters long. The value entered here will be used for a variety of purposes by the receiving fax machine. For example, it might log the station ID, display it on the fax machine's LCD panel, print it on the page header, etc.
9. Select an option from the Fax Mode drop-down list. Depending on your license agreement, you can choose Inbound Only, Outbound Only, or Inbound and Outbound.
10. Configure Outbound Fax Settings, if appropriate.
Modem Class. In most cases, ASG recommends that you leave the default setting of <Don't Care>. You can, however, choose Class 1, Class 2, or Class 2.0 from the drop-down list if your modem supports these classes. This feature is selectable only when the device DLL is set to fax. See step b. .
Compression. In most cases, ASG recommends that you leave the default setting of <Don't Care>. You can, however, choose Group 3 (1-D), Group 3 (2-D), or Group 4 from the drop-down list if these modes are supported by the receiving fax machine. This feature is selectable only when the device DLL is set to fax. See step b. .
Resolution. Normal fax output resolution is approximately 100 (horizontal dpi) x 200 (vertical dpi). Fine is approximately 200 x 200 dpi. You also can choose other resolutions, based on your quality requirements (i.e., 200 x 400, 300 x 300 and 400 x 400). The final resolution will be determined based on outbound fax machine settings and capabilities.
Page Header. This information will be printed at the top of each fax page.
Redial. If the fax cannot be sent on the first try, Cypress attempts to resend it based on the values you enter in Count and Interval fields.
The Count value is the number of times Cypress is to redial after the first failed attempt.
The Interval value (in seconds) is the period Cypress is to wait between redialing attempts.
Retry Later. In the fields in this area, you specify the number of times the Redial cycle is to be repeated and at what intervals. This allows you to retry the transmission without continually redialing or having to resend the job in the event that the redial count was reached.
The Count value is the number of times Cypress is to repeat the redial cycle.
The Interval value (in minutes) is the period Cypress is to wait between redial cycles. For example, the sample Fax tab on the previous page is configured to redial three times and repeat the redial cycle three times. In the event of a failure, Cypress would dial a total of 16 times.
Retried Job. By default, job priority is based on timestamp data (i.e., the time the job entered the queue). When failed jobs are retried, they are positioned in the queue based on timestamp and will most likely be retried ahead of other jobs in the queue. In situations in which multiple jobs are being retried (e.g., because a device was busy or a fax number is incorrect) other jobs with more recent timestamps might be prevented from being processed. Selecting the Lower priority check box results in requeuing a failed job relative to the Retry Later Count associated with all other jobs in the queue. Cypress attempts to send all new jobs before retrying any other jobs in the queue.
11. In the Inbound Fax Device drop-down list, choose the Cypress device to which incoming faxes should be sent. For example, you would choose an RDM device if faxes are to be routed based on called party, region text, etc. Choosing <None> queues the fax to the fax server device. This option is useful only if you wish to have faxes held at the server indefinitely, treating the fax device itself as a hold queue.
12. Click the Apply button to save changes.
After the SR140 is configured and operating correctly, Cypress will then be able to send faxes through it. Contact your FoIP provider, Dialogic (formerly Brooktrout), for assistance.

Cypress Fax Number Restriction Mechanism

Cypress has a mechanism that allows you to specify a list of fax numbers that Cypress should not dial. A prime example is 911. The numbers are entered into a simple text file, one number per line, as a continuous string of numeric digits without any punctuation or special characters, such as 12488527025. Any character that is not a numeric digit ends the processing of that line, so comments may be placed after the fax number. The file is stored in the Cypress Server directory as restricted_fax_numbers.txt.

If the file exists, Cypress will read the file into an internal cache and compare the fax number from the JTic against the list. This comparison is done up to the length of the number in the restriction file. For example, if the file lists 911, then any fax number that begins with 911 will be blocked.

Any JTic whose fax number is in the list will be marked as an error, with an appropriate message emitted to the History log.

Example file:

911 // restricts dialing 911

12488527025 // restricts a specific fax number

1586 // restricts any faxes to the 586 area code

Configuring a Device to Deliver Documents to a Specific Fax Machine

To enable users to deliver documents to a specific fax machine number, you must create at least one Cypress fax device and a Cypress capture driver they can use to print documents to the newly created fax device. You can configure the capture driver as either a dynamic or static printer.

Ideally, you also should create a Cypress banner that your users can use as a fax cover sheet. The Fax Wizard’s cover sheet generation feature will print user-entered information on this banner.

To deliver documents to a specific fax number

1. Create a Cypress fax device. See Creating a Fax Device for more information.
2. Create a Cypress capture driver. You can use this device either as a dynamic printer—which enables users to choose the fax device from a list of devices—or a static printer—which you can configure to print directly to the fax device.

See the ASG-Cypress Installation and Upgrade topic for instructions for creating a Cypress capture driver and configuring it as a static or dynamic printer.

3. Optional, but recommended. Create a fax cover sheet.
a. Create a form.
b. Use the Resource Manager to place databoxes on the form. This table shows how each field in the Fax Cover Sheet Info dialog corresponds to a specific databox name in the Resource Manager’s Box Name drop-down list:

Field

Databox Name

Name

Recipient

Identity

Identity

Address

Address

Note to Recipient

Fax Note

You also can add other built-in databoxes to your fax cover sheet (e.g., Sender (Creator) or Creation Time).

c. Create a banner, using the form created in step 3a. For more information on creating banners, see the topic on banners in the ASG-Cypress Advanced Formatting Administrator’s topic.
d. Select the Device tab in the Administration Tools module, and select the fax device you created in step 1. from the tree view. Choose the banner you created in step 3c from the Banner drop-down list on the fax device’s General tab and click Apply to save the change.

Creating a Virtual Fax Server

If you are implementing multiple fax devices, you can create a virtual fax server. Grouping fax devices provides these benefits:

Load balancing: Cypress chooses the first available fax device to send the document.
Ease-of-use: Users can choose a single device rather than selecting from among multiple devices when sending documents to a fax device.
Flexibility: If one fax device is unavailable for any reason, Cypress can send the document to another available fax device.

To create a virtual fax server

1. Create a fax device for each separate modem or fax line. See Creating a Fax Device for more information.
2. Define a device group. See Defining Device Groups for more information.
3. On the device group’s Children tab, add the fax devices you created in step 1. to the Pass On Device(s) list.
4. Click Apply to save your changes.

Creating a RightFAX Device

If you use a RightFAX fax server in your environment, you can continue to use this product without modification, while still enjoying the convenience of submitting faxes through Cypress.

Cypress’s RightFAX feature allows documents to be submitted to Cypress for faxing, either to a recipient or to a specific phone number, but passes the data to the RightFAX fax server for the actual faxing.

To create a RightFAX fax device, you must create a new Cypress device for the RightFAX product within the Administration Tools module. You must configure this device to deliver data to the RightFAX fax server in the appropriate format. Although creating a RightFAX fax device is different than creating a Cypress fax device, the RightFAX device is referenced and deployed in the same way as a Cypress fax device. You can select it from a dynamic printer menu (for faxing to a specific telephone number), select it in RDM, or assign it to a recipient in the Address Book.

To create a RightFAX device in your DocuVault

1. Open the Administration Tools module, and select the Device tab.
2. Select the General tab, if it is not already selected.
3. Click the New button.
4. Enter a name for the RightFAX fax device in the Name field.
5. Optional. Enter a description in the Description field.
6. Enter the IP address of the RightFAX server in the Host field.
7. Enter the name of the RightFAX shared Windows printer in the Unit field.
8. Select RightFAX from the Device DLL drop-down list.
9. Select lpd_o from the Link DLL field.
10. If you have multiple modems available, enter the channel selection dialect in the Dialects field. Use the syntax for dialect:

rfax_chan(<n>)

where <n> is the desired RightFAX channel (or modem number).

For example, this statement would select RightFAX channel 2:

rfax_chan(2)

11. Click the Add button to add the new device definition to the DocuVault. The RightFAX fax device will appear in the device list.
You cannot enter information within the RightFAX fax device's Fax tab. The Fax tab will not be selectable after the RightFAX fax device has been created.

This table indicates how Cypress job ticket (JTIC) information maps to RightFAX functions:

RightFAX Function

Cypress JTIC Information

FROMNAME

The job ticket creator.

NOTE

The JTIC description.

PRIORITY

Derived from the JTIC priority in this way:

LOW if JTIC priority is less than 25.
HIGH if JTIC priority is greater than or equal to 75.
NORMAL for all other priority values.

TOCITYSTATE

Contents of the Address field defined in the recipient’s Banner tab within the Address Book. If you have not defined this recipient in the Address Book, the contents of the Full Address field in the Banner tab is used.

TOCOMPANY

The JTIC identity.

TONAME

Recipient name as defined in the Address Book. If you have not defined this recipient in the Address Book, the string Cypress Recipient is used.

UNIQUEID

The unique hexadecimal job number appended to a code indicating the Cypress capture method. For example:

9E034D LPD
9E034D WNT
9E034D DDI

Creating E-mail Devices

E-mail devices are created much like other Cypress devices, except that they also rely on server information entered in the Parameter dialog’s Email tab within the Administration Tools module.

To create an e-mail device

1. Open the Administration Tools module, and select the Device tab.
2. Select the General tab if it is not already displayed.
3. Click the New button to create a new device definition.
4. Enter the name of the e-mail out device in the Name input field.

As most sites need only one e-mail device, ASG suggests E-mail Out or another name that clearly identifies the device as an e-mail device.

5. Choose the device DLL for the default e-mail attachment format from the Device DLL drop-down list.

The value you specify is the global default for all e-mail attachments processed by this device and will be applied if no attachment format is specified when the document is submitted to Cypress.

PDF is an optional add-on to Cypress and will be displayed for selection only if the PDF Out feature has been licensed.
6. Select email from the Link DLL drop-down list.
7. Enter any dialects in the Dialects input field, if desired. If you selected PDF from the Device DLL list, you might want to include a dialect to control file compression, for example:
compress(none): No compression is performed.
compress(default): Default. Flate compression is performed with combined size and speed goals.
compress(speed): Flate compression is performed with speed as the primary goal.
compress(size): Flate compression is performed with size as the primary goal.
8. Click the Apply button.
9. Select the Email tab on the Parameter dialog on the Administration Tools window.

10. Click the Add button to enter the name or IP address of your SMTP server.
If you have multiple mail servers, you might want to enter additional servers to ensure the best performance. Then, in the event that the target mail server is busy or disabled, Cypress will automatically attempt to connect to the next mail server on the list.
11. Enter the e-mail address of the sender in the Sender Email Address input field. The address you enter will be the default value displayed in the From field in e-mail messages generated by this device, unless the value of that field has been set using an InLine command or the E-mail Out Wizard.
Considering creating a new e-mail address specifically for Cypress e-mail delivery.
12. If you have entered multiple mail servers, you can alter the order in which they are listed by clicking the Move Up and Move Down buttons.

Cypress will use the first server in the list first. If that server fails, Cypress will process the list in the order in which you specify the other servers until it can connect.

13. Click the Apply button to save your changes.

Displaying Fax and E-mail Wizards

You can configure Cypress to automatically display a wizard when a user is printing documents to fax or e-mail devices.

Cypress displays the fax and e-mail wizards when documents are being printed to devices and groups selected from an Cypress dynamic printer. Cypress does not display wizards documents are being printed to static devices and groups.

To implement fax and e-mail wizards in a device group

1. Open the Administration Tools module, and select the Device tab.
2. Select the General tab if it is not already displayed.
3. Enter the name of the group in the Name input field, making sure to include either faxprompt or emailprompt as part of the name.

The faxprompt and emailprompt strings are not case-sensitive. You can add these strings to the beginning, middle, or end of a device group name.

For example, these names would cause Cypress to display a fax wizard:

fax_out_faxprompt
fax_Faxprompt_1
FaxPrompt_2

These names would cause Cypress to display an e-mail wizard:

emailpromptA
email_PDF_emailprompt
CompanyABCemailprompt99
4. Continue to create the Group definition. See Define all top-level groups and sub-groups (if any). for more information.
If you add a device that is not a fax or e-mail device to a device group that you have configured to display a wizard and that device ultimately processes the job, the document will print normally, but Cypress will discard all wizard information.

Creating Disk Out Devices

The Cypress Disk Out feature enables you to configure a device to write output to a file in a specified directory rather than to a printer or fax machine. If you need to create a Disk Out directory on a machine other than the Cypress Server, you can appropriately configure Windows domain security to ensure that the Cypress service can access the remote directory. Jobs processed by Cypress can be written to a disk file in a variety of formats by using the disk_o feature. This topic discusses the disk_o feature, how to implement it, and the replacement parameters you use to specify directory path and file name information.

The disk_o, or Disk Out, feature is a link DLL that you can select when you are creating a Cypress device definition. Any job submitted to a device configured with disk_o as the link DLL value automatically is written to disk. Files can be written in a variety of industry-standard formats (e.g., TIFF, bitmap, PostScript, and PCL) and named based on job ticket data or other disk_o information.

You use the disk_o feature to export Cypress output for use by other applications and business processes. For example, Cypress can generate TIFF files that users can use with imaging systems or PostScript files that can subsequently be converted into PDF format.

Writing files to disk is accomplished by creating a Cypress device within the Administration Tools module (and, optionally, defining the disk_o device as a printer in Windows). This topic provides instructions for defining a disk_o device.

Creating a Disk Out Device

To create a disk out device

1. Open the Administration Tools module. Select the Device tab, and click the New button at the right side of the Administration Tools window.

2. Enter the name of the disk_o device in the Name input field.
3. Optional, but recommended. Enter a description of the device in the Description input field. If you have multiple disk_o devices, consider entering the source application or other information that will help you identify the purpose of this particular disk_o device.
4. Select the device DLL from the Device DLL drop-down list. This is the name of the dynamic link library that contains the procedures for formatting output. Typically, users select pdf, tiff, bmp or other industry-standard output.
5. Select disk_o from the Link DLL drop-down list.
6. In the Unit field, enter the directory path (including file name) to the Disk Out directory. Cypress will look for this directory on the Cypress server.

If you wish to save files to a directory on a remote server, you have these options:

You can specify a UNC path in the Unit field.
You can map a network drive to the remote Disk Out folder and enter the path (including file name) to the mapped drive in the Unit field. Consult your Windows help system for instructions on how to map a network drive, if necessary.
If you are using Windows Server 2008 and user account control (UAC) is enabled, you must right-click each command and run as administrator. Additionally, you might need to respond to an elevation prompt.

To configure a Disk Out directory on a remote server

1. Create a Windows domain user account for Cypress. The Cypress service will run under this account.
2. Stop the Cypress hub service by selecting Start } Programs } Cypress Server } Stop Hub.
3. Specify read, write, and execute permissions for all directories that the Cypress service accesses. You can specify permissions by opening each directory’s Properties dialog, then choosing Read, Write, and Execute in the Permissions section on the Security tab.
4. Set permissions for these directories:
5. All directories within the main Cypress directory (including the Cypress directory)
6. The Cypress log file directory
7. Any FT In directories on the Cypress Server
8. Any Disk Out (i.e., disk_o) directories on the Cypress Server
9. Change the account under which the Cypress hub service runs to the account that you created in step 1.
10. From the system Control Panel (Start } Administration Tools } Control Panel), open the Services utility.
11. Right-click the Cypress service entry, and select Properties on the pop-up menu.
12. Select the Log On tab on the Properties dialog, and click the This account option button, as shown in this example:

13. Click the Browse button, and select the user account you created in step 1.
14. Click OK, and close the Services utility.
15. Start the Cypress hub service by selecting Start } Programs } Cypress Server } Start Hub.
16. From the system on which you want to save Disk Out print data, create a shared folder to use as a remote Disk Out directory.
17. Open the Properties dialog of the shared folder you just created.
18. Select the Sharing tab in the Properties dialog. Set the Name field to the user account you created in step 1, and set the read, write, and execute permissions.
19. Select the Security tab in the Properties dialog. Set the Name field to the user account you created in step 1, and set the read, write, and execute permissions.
20. Open the Cypress Administration Tools module to create the Disk Out device, if you have not already created it. For instructions on creating a Disk Out device, see Creating Disk Out Devices.
21. In the Unit field, enter the network path to the shared folder you created in step 11, as shown in this example:

22. Click the Apply button on the right side of the Administration Tools window to save your changes.

Using Replacement Parameters

You can use replacement parameters in place of any directory name or the file name. Replacement parameters, entered in the Unit input field within a device definition (see step 6. ), are parameters that are replaced with the values they represent when the file is written to disk.

For example, the replacement parameter %job_desc% causes Cypress to extract and use the value associated with the job ticket’s description as part of the directory path (e.g., “Microsoft Word - NRC_Apps.doc”).

When creating strings to specify directory and file name information, you can use replacement parameters for as many—or as few—directory path attributes as you wish.

When creating a directory or file name using multiple replacement parameters, consider improving file name readability by entering an underscore character (_) between parameters.

Examples

Explicitly defining the drive and directory, then using a replacement parameter to specify the file name:

Unit string: C:\temp\%job_creator%
Result: C:\temp\bjones

Explicitly defining the drive, then using replacement parameters to specify the directory and file name:

Unit string: C:\%dev_name%\%job_creator%
Result: C:\NRC Apps\bjones

Explicitly defining a file extension:

Unit string: C:\%dev_name%\%job_creator%.tif
Result: C:\NRC Apps\bjones.tif

Combining multiple replacement parameters to specify the directory and/or file name:

Unit string: C:\%dev_name%\%job_creator%_%job_desc%
Result: C:\NRC Apps\bjones_ Microsoft Word - NRC Apps.doc

Explicitly defining the drive, directory, and file name, without using any replacement parameters:

Unit string: C:\NRC Apps\bjones
Result: C:\NRC Apps\bjones

There are three types of replacement parameters:

Job ticket replacement parameters
Sequence replacement parameters
The variable replacement parameter

Job Ticket Replacement Parameters

You use job ticket replacement parameters to extract information from the Cypress job ticket (JTIC). JTIC information such as “job description” can thus be used as part of the directory path or file name, as appropriate

This table lists job ticket replacement parameters:.

Replacement Parameter

Extracted Information

Description

Example

dev_name

Device name

The name of the device to which the job was submitted.

NRC Apps

job_addr

Job address

The data in a recipient’s Address field on the Banner tab in the Address Book.

Mail Stop 016

job_creator

Job creator

The job creator information from the JTIC.

bjones

job_desc

Job description

The job description information from the JTIC.

Microsoft Word - NRC Apps.doc

job_ex_dest

Job external destination reference

The external destination reference from the JTIC. The external destination reference is the name of the printer to which the sending system submitted the print file.

This value might not reflect the device to which the job is ultimately queued. For example, an InLine command could be used to redirect a print file, or you might implement a single “printer” that results in delivering documents to each recipient’s preferred device, etc.

This parameter is supported only for jobs submitted to Cypress via DDI.

Color Printer 1

job_ex_group

Job external group reference

The SAP report group value from the JTIC.

This parameter is supported only for SAP jobs submitted to Cypress via DDI.

Administrator

job_ex_id

Job external ID reference

The job ID assigned to the job by the sending system. This parameter is supported only for jobs submitted to Cypress via DDI.

For SAP jobs, the value of the SID DDI attribute is used.
For Oracle jobs, the value of the Oracle user ID is used (note that you will need to extract the Oracle user ID from the value returned by the TTL [Oracle title] attribute).
For generic jobs, the value of the XID DDI attribute is used.

admin

job_identity

Job identity

The data in a recipient’s Identity field on the Banner tab in the Address Book.

Development

job_recipient

Job recipient

The data in a recipient’s Recipient field on the Banner tab in the Address Book.

Masters, Dennis

yyyymmdd

The current date

Inserts the current date in Year, Month, and Day format

20190805

Sequence Replacement Parameters

You use sequence replacement parameters to create unique names for files written by disk_o devices so that files are not inadvertently overwritten.

Using a sequence replacement parameter results in extracting a 10-digit value from a Cypress-maintained counter. Each time a file is written by a disk_o device, the 10-digit value is automatically incremented by one (e.g., 0000000023, 0000000024). This guarantees that files generated by a disk_o device are not overwritten as they are being written to disk.

Cypress-maintained counters cannot be manually cleared and can be reset only by the counter rolling over from 9999999999 to 0000000001.

There are two types of counters maintained by Cypress: a global counter that increments each time a file is written by any disk_o device and a counter that increments each time a file is written by a specific disk_o device. A simple way to think of this is that Cypress maintains one counter for everything and separate counters for each disk_o device.

This table lists the sequence replacement parameters:

Replacement Parameter

Extracted Information

Description

Example

next_dev_seq

Device sequence number

A unique 10-digit number from the device’s disk_o counter. This parameter guarantees a unique file name only for files written by a particular disk_o device.

0000000152

0000000153

0000000154

next_dv_seq

DocuVault sequence number

A unique 10-digit number from the DocuVault’s disk_o counter. This parameter guarantees a unique file name for any file written by any disk_o device.

0000000023

0000000024

0000000025

If you are using next_dev_seq to sequence file names, a counter is created for that disk_o device and cannot be deleted even if the disk_o device is deleted. This ensures file name uniqueness in the event a device is added with an identical name to a previously deleted device.

The Variable Replacement Parameter

You use the variable replacement parameter to extract the value associated with a var InLine command within a document. The var InLine command is used to embed—but not to print—information within a document to control document processing.

For example, consider an application that generates invoices for hundreds of customers. Each invoice includes the var InLine command to declare a variable name (cust_num) and an associated value (e.g., 95-0987) for every unique customer. You could use replacement parameters to include the customer number in the file path. For example, assume that you set the Unit field to this string:

C:\%dev_name%\%var.cust_num%

The disk_o device would save its output to paths like these:

C:\Invoices\95-09879
C:\Invoices\95-09880
C:\Invoices\95-09890
C:\Invoices\95-09899
The Environment Variable Replacement Parameter

The environment variable replacement parameter allows the value of a system Environment Variable to be placed within the file path. This replacement parameter is %envvar.<name>%, where <name> is the name of the environment variable to be inserted.

For example, if the environment variable SYS_NAME contains QA2 then C:\capture\%envvar.sys_name%_output.pdf results in the file path: C:\capture\QA2_output.pdf

Using TCP/IP Devices

Cypress’s TCP In module accepts, formats, captures, and stores files sent to Cypress devices via a TCP/IP connection.

Configuring a TCP In Device

Users can submit TCP In jobs to Cypress over a socket connection. Once you have submitted a job, you must create a device to receive it and configure that device’s TCP In tab to define the port number or number to which the device should listen. Note that a single Cypress device can support an unlimited number of incoming socket connections.

To create a TCP In device

1. Create the device to which the TCP In jobs will be submitted. See Defining Printers for more information.
2. Select the device’s TCP In tab.

3. Create a socket connection to Cypress by clicking the New toolbar button in the TCP-In Server List list view.
4. Select the General subtab within the TCP In tab if it is not already displayed.
5. Optional. Check the Only allow the connection from this server or IP address check box, then enter the name/IP address of the submitting server. This option will restrict job submission from the machine with the specified name/IP address only.
The screen example has an IPv4 IP address. If your system supports IPv6, you can also use IPv6 IP addresses (e.g., 2002:db8:1428:57ab). Cypress supports both protocols.
6. In the Port input field, enter the number of the TCP/IP port that Cypress is to monitor for TCP In jobs.
7. Optional. Enter the name of the sending system in the System Name input field.
The information entered in the System Name, Job Name, Creator, and Description fields can appear in the job ticket. Customizing the system name information may be useful for controlling processing events, such as using this value to automatically apply formats using the Auto Format feature.
8. Optional. Enter the job name in the Job Name input field.
9. Optional. Enter the name of the job’s sender in the Creator input field.
10. Optional. Enter a description in the Description input field.
11. Click the Data Stream radio button in the Protocol area.
If you want to submit HL7 data streams to Cypress via TCP In, see Configuring an HL7 Device for more information.
12. Select an input option in the Capture Format area:
DocuVault Format: Stores the document as a Cypress DDOC.
Native only: Stores the document as a native file.
DocuVault Format plus Native: Stores the document as both a Cypress DDOC and a native file.
13. Select the Security tab, and configure Cypress security for this TCP In server.
14. Click the Apply button to save your TCP In tab settings.
15. Repeat steps 3 through 13 for each additional socket connection to be supported.

Configuring an HL7 Device

You can submit HL7 data streams to Cypress via TCP In. This feature enables health care organizations to securely manage the processing and delivery of HL7 data streams.

HL7 jobs are submitted to Cypress over a socket connection. To receive these jobs, you must create a device that will receive HL7 jobs, configure the device’s TCP In tab (to enable job submission over a socket connection), and define the number(s) for port(s) over which jobs can be submitted. A single Cypress device can support any number of incoming socket connections.

To create an HL7 device

1. Create the device to which HL7 jobs will be submitted. See Defining Printers for more information.
2. Select the device’s TCP In tab.

3. Create a socket connection to Cypress by clicking the New toolbar button in the TCP-In Server List list view.
4. Select the General subtab within the TCP In tab if it is not already displayed.
5. Optional. Check the Only allow the connection from this server or IP address check box, then enter the name/IP address of the submitting server. This option will restrict job submission from the machine with the specified name/IP address only.
This screen example has an IPv4 IP address. If your system supports IPv6, you can also use IPv6 IP addresses (e.g., 2002:db8:1428:57ab). Cypress supports both protocols.
6. Enter the TCP/IP port number that Cypress is to monitor for HL7 jobs in the Port input field.
7. Optional. Enter the name of the sending system in the System Name input field.
The information entered in the System Name, Job Name, Creator, and Description fields can appear in the job ticket. Customizing the system name information may be useful for controlling processing events, such as using this value to automatically apply formats using the Auto Format feature.
8. Optional. Enter the job name in the Job Name input field.
9. Optional. Enter the name of the job’s sender in the Creator input field.
10. Optional. Enter a description in the Description input field.
11. Click the HL7 MLP radio button in the Protocol area.
12. Select an input option in the Capture Format area:
DocuVault Format: Stores the document as a Cypress DDOC.
Native only: Stores the document as a native file.
DocuVault Format plus Native: Stores the document as both a Cypress DDOC and a native file.
13. Select the Security tab, and configure Cypress security for this HL7 server.
14. Click the Apply button to save your TCP In tab settings.
15. Repeat steps 3 through 13 for each additional socket connection to be supported.

Configuring a Cypress DesktopPrint Device

You can implement Cypress DesktopPrint (herein called DesktopPrint) to enable your users, who are running applications remotely (i.e., through Windows Remote Desktop or Citrix), to print to locally connected printers.

A DesktopPrint device can be displayed in the destination tree in three folders:

Local Printers. All DesktopPrint devices defined for the local host are displayed in this folder.
My Devices. You can add frequently used devices to this folder. See Adding a Device to the My Devices Folder for more information.
Printer/Devices. The DesktopPrint device is displayed in this folder if the user has read and append permissions.

After you add the device, it displays in the Administration Device, Output Manager, Address Book Device, or the RDM Device trees. It also displays in the Device folder of the Dynamic Printer Setting dialog, which is launched from DocuSpace, Inbox Viewer, Inbox/Query controls, and the Capture Driver.

You must first install Cypress DesktopPrint Client before you can use the DesktopPrint feature. See the topic on Implementing Cypress DesktopPrint in the ASG-Cypress Installation and Upgrade topic for more information.

To configure a DesktopPrint device

1. Open the Administration Tools module, and select the Device tab.
2. Select the General tab on the Device dialog if it is not already selected.
3. Create a Cypress device definition for the locally attached device. See Defining Printers for more information.
4. Select Desktop_print from the Device DLL drop-down list.

The Select Desktop Printer dialog is displayed.

5. In the IP/DNS Name field, enter the IP address or fully qualified DNS name for the computer from which the printer will be selected. This information displays in the Description field on the General tab.

After you enter the IP/DNS Name, the List Printers button is enabled.

6. Click List Printers to display a list of printers associated with the specified computer. Then, select a printer to fill the Computer Name and Printer Name fields automatically.

Or 

Enter the appropriate information in the Computer Name and Printer Name fields If you did not select a printer from the list, enter the name of the printer in the Printer Name field.

The Computer Name and Printer Name values display in the Host and Unit fields, respectively, on the General tab.

7. Click Select to choose the specified printer.
8. Select the Enable Desktop Printer Feature to display the Printer Properties dialog, which allows you to set printer-specific features.
9. Click Apply to save your changes.
10. Other than the fields in steps step 4. through step 9. , you define the DesktopPrint device as you would any other device.

To modify a DesktopPrint device

1. Open the Administration module, and select the Device tab.
2. From the device tree view, select the DesktopPrint device you want to modify.
3. In the Device DLL drop-down list, select Desktop_print to display the Select Desktop Printer dialog for the selected device.

4. Click List Printer to display a list of printers associated with the specified computer.
5. Select a printer from the list.
6. Click Select to fill the information on the General tab automatically.
7. Check the Enable Desktop Printer Feature check box.
8. Click Apply to save the changes.

To delete a DesktopPrint device

1. Open the Administration module, and select the Device tab.
2. From the device tree view, select the DesktopPrint device you want to delete.
If you are allowed to delete the device, the Delete button is enabled.
3. Click Delete to remove the device.

After you delete the device, it no longer displays in the Administration Device, Output Manager, Address Book Device, or the RDM Device trees. Deleting the device also removes it from the Device folder of the Dynamic Printer Setting dialog, which is launched from DocuSpace, Inbox Viewer, Inbox/Query controls, and the Capture Driver.

Adding a Device to the My Devices Folder

You can add a device to your My Devices folder. You must have at least Append permission for the device in order to add it to the folder.

To add a device to the My Devices folder

1. Select a document, then click Print.
2. Select a Capture Driver as the printer.
3. Expand the Print Devices folder to display the Dynamic Printer Setting dialog.
4. Right-click the selected device to display the context menu.

5. Click Add the Selected Device to ‘My Devices.’

The device is added to the user-specific My Devices folder in the DocuVault and is displayed in the My Devices folder in the Dynamic Printer Setting dialog.

Sending a Print Job to a DesktopPrint Device

The Dynamic Printer Setting dialog allows you to quickly access the DesktopPrint devices associated with your computer. You can view a document in Cypress GUI (i.e., DocuSpace, Inbox Viewer, or Query/Inbox controls), then queue it to a Cypress DesktopPrint device.

To send a print job to a DesktopPrint device

For example, these steps allow you to print from a DocuSpace:

1. Select a JTIC from Output Manager and view it in a DocuSpace.
2. Select the Document/Page(s) in the DocuSpace.
3. Select Print from the File Menu.

Or 

Click the Print button in the toolbar.

4. Select a Cypress Capture Driver. The Dynamic Printer Setting dialog is displayed.

5. Click OK to print to the selected device.

Implementing a Windows GDI Device

If your site requires proprietary or nonstandard printers that use third-party drivers, you can create Windows GDI devices to manage these printers. Creating Windows GDI devices enable you to receive the benefits of Cypress document capture (e.g., page-level indexing, archival, and retrieval) while still using a third-party driver to control printing.

The Windows_GDI Device DLL enables you to create a Cypress device that captures documents at print time, but uses a third-party driver to control the printing process between the Cypress Server and the device. This eliminates the need to install the third-party driver on every client.

Before you decide to use a third-party driver, contact ASG Customer Support to see if your device is supported or will be supported in the future.

To create a Windows GDI device

1. Create a Windows printer for the device using the Add Printer wizard, if you have not already done so.
The printer you create must exist in the Windows Printers folder on the Cypress Server, and the manufacturer’s driver must be resident at the Cypress Server.
2. From the Cypress Server, configure and save all desired properties in the manufacturer’s driver.
3. From the Cypress Administration Tools module, select the Device tab.
4. Enter the name of the printer in the Unit field. This name must exactly match the name of the printer you created in step 1.
5. Select Windows_GDI from the Device DLL drop-down list.
6. Select <None> from the Link DLL drop-down list.
7. Click the Add button to save your device in Cypress.

Creating an FT In Directory on a Remote Server

If you need to create an FT In directory on a machine other than the Cypress Server, you can appropriately configure Windows domain security to ensure that the Cypress service can access the remote directory. See the ASG-Cypress Document Capture Administrator’s topic for more information.

Transferring Documents to other DocuVaults

To transfer documents to other systems, such as other DocuVaults, configure a device with a Device DLL of ADF and a Link DLL of rest_api. Enter the URI of the destination system in the Host field, in the format <system>:<port> where <system> is the name of the system (or IP Address) and <port> is 11506 for Cypress. Enter the name of the destination device into the Unit field.

This configuration transfers the document, along with its fonts, security information, and index information to the destination system. The document is archived into that DocuVault and a job ticket is queued to the device specified in the Unit field.