DevicesFile Connection Type (Print to PDF, Image, or XML)

A File device connection allows you to print to a PDF or PNG file, or create an XML file. When configuring a device connection, the following options are available in the Connection tab when you select File as the connection type.

Note: PDFs created through a Loftware Enterprise SP PDF device driver are read-only and cannot be edited in other applications.

Note: Not all connection types are available to all device families and models. The options available are dependent on the type of connection and device family selected.

Note:

If you will be sending multiple jobs in quick succession through this device connection, you should create or update the following system property:

  • Namespace: deviceManagement
  • Key: force.dedicated
  • Value: true

For more information, see View and Update System Properties

Common File Settings

The following settings are common to all Storage Types.

Option Description Values and Variables

Storage Type

The type of storage where files output using this File connection are to be stored.

File System (Default)

Amazon S3

Microsoft Azure

File Path

The folder on the Loftware Application Server where PDF, image, or XML files are stored. A UNC path is recommended, but physical paths to folders on the Loftware Application Server can also be used.

Best Practice

Use a UNC path such as \\Server\SharedFolder. Mapped drives are not supported.

Default value if Model is set to PDF:

%W/pdfs

Default value if Model is set to Image:

%W/images

Default value if Model is set to Generic:

%W/generic

 

Where %W is defined as

${catalina.home}/webapps/ROOT

File Name Pattern

The file name creation tools. This field is parsed for instances of ${<value>}, #{<value>}, %{<value>}, which are replaced with the corresponding data sources. For more information, see Dynamic Field Values.

To print labels to a single file from a single print job, use the same file name from label to label or print job detail to print job detail.

To print labels to separate files from a single print job, change the file name from label to label or print job detail to print job detail.

Example: Separate file for each page

From a single print job, you can create separate files for each page of each print job detail. You can do so by incorporating a placeholder for the print job detail context ID and a data map entry for the page number into the File Name Pattern.

/%U_%L_%P_${/Body/PageNumber}

Example: Separate file for each print job detail

From a single print job, you can create separate files for each print job detail. You can do so by incorporating a placeholder for the print job detail ID into the File Name Pattern.

/%U_%L_%P

Example: Files at the root level of an S3 bucket

If you are using Amazon S3 storage, you can create files at the root level of your S3 bucket by using the following File Name Pattern.

/%U_%L_%J_%D{yyyy-MM-dd'T'HHmmss}

Example: Files in a subfolder of an S3 bucket

If you are using Amazon S3 storage, you can create files in subfolders of your S3 bucket by using the following File Name Pattern.

/%U/public_html/%J_%D{yyyy-MM-dd'T'HHmmss}

%U: User

%L: Device

%J: Job Number

%P: Print Job Detail Context ID

%D {yyyy-MM-dd'T'HHmmss}: Date Format

 

For additional values, see Dynamic Field Values.

Create Directory

Whether Loftware Enterprise SP should create the folder if it does not exist.

: Do not create the folder

: Create the folder if needed (Default)

Job Retry Timeout (s)

The time between attempts to write to the file.

This option is not displayed for a Generic device.

Milliseconds

Amazon S3 File Settings

The following options are available when the Storage Type is Amazon S3.

Option Description Values and Variables

S3 Access Key

A credential for an existing Amazon S3 account that is comparable to a username. An access key and private key pair is required to save files to S3 storage.

 

S3 Private Key

A credential for an Amazon S3 account that is comparable to a password. This must be the S3 Private Key associated with the S3 Access Key entered.

 

S3 Bucket

An existing storage subdivision created and named by an Amazon S3 user and assigned to a region for an S3 account. A bucket is comparable to a drive letter or a mount point in other file systems.

 

S3 Region

The Amazon Web Services (AWS) region in which the specified S3 Bucket exists. This value is not case sensitive.

region_subregion_number

Examples:

  • us_east_1
  • ap_east_1
  • eu_west_1

Microsoft Azure File Settings

The following options are available when the Storage Type is Microsoft Azure.

Option Description Values and Variables

Azure Account Name

The name of the Azure account.

 

Azure Account Key

The key used to access storage.

 

Azure Service Url

The URL of the storage.

 

Azure Container

The Azure Container

 

Azure Storage Types

The type of blob storage. You configure the type of blob in Azure first.

BLOCK

APPEND

PAGE

Advanced Connection Settings

Option

Description

Values

Automated Device Health Check

Whether Loftware Enterprise SP's automated device health check is enabled for this device.

This option is displayed only for devices that use the Generic driver. For all other drivers, the automated health check is enabled and is not configurable.

: Disabled (Default)

: Enabled

Test Connection to Device

Use the specified TCP or USB connection settings to attempt to connect to the device.

This option is displayed only for devices using a TCP-based or USB connection type.

Test Connection