Format Dialects

abort_on_ilc_error

Causes Cypress to stop processing an incoming document if an invalid InLine command is encountered. If this dialect is not specified, the command will be ignored and the error will be written to the History Log, but Cypress will continue to process the document.

All

AFPLD_parse_title

Extracts the AFP Linedata parameters from the file title.

See Extracting the AFP Linedata Parameters for a Document for a description of the parameters.

7.2.0.46

7.3 and higher

AFP_NOOP

Enables NOOP data to be stored in Cypress page variables.

The parameter to this dialect specifies the prefix of the variable names, with an incremental number appended to the end.

For example, the dialect AFP_NOOP("Afp_Noop_var_") will store the NOOP data in variables with names of Afp_Noop_var_1, Afp_Noop_var_2, etc. The incremental number will start at 1 for each page.

If a Cypress Index has been defined with a matching name, the page will be indexed by that value also.

If the dialect is specified without a parameter, the variable prefix will be set to AFP_NOOP_.

7.3.1.13 and higher

AFPX_force_char_size

Applicable for AFP and Xerox capture only.

Forces Cypress to use the character size from the actual AFP or Xerox data.

7.1 and higher

AFPX_overlay

AFPX_overlay(replace)

Applicable for AFP and Xerox capture only.

Stores any overlays within AFP or Xerox data as Cypress forms, which are referenced by the appropriate pages.

If you specify the optional replace parameter, any overlay with the captured data is stored as a new form even if a form with this name already exists.

7.2.0.46

7.2.1.7

7.3 and higher

AFPX_remap_unknown_chars

Remaps any unknown character codes from EBCDIC to ASCII.

This is primarily useful in cases when an AFP file has insufficient codepage tables.

7.3.2.31 and higher

AFPX_use_face_values

Causes Cypress to use the scaling and position values of the first front face to adjust how the pages are built.

7.2.048

allow_duplex_mixed_stock

Allows a duplex page from a PDF to have different stocks on the front and back. This can cause undesired printing results unless stock substitution is used.

7.3.x.26 and higher

apply_xerox_shift

Applicable for Xerox capture only.

When specified, any shift commands in the JSL are applied to the document. Otherwise, shift commands are ignored.

7.1.0.54

7.2.0.48

7.3 and higher

auto_image_stock

auto_image_stock("<prefix>", "short")

auto_image_stock("<prefix>", "long")

Selects a specific stock based on the dimensions of the image on the document.

To use this dialect, you must specify the prefix of the stocks that should be used. Cypress will choose a stock from among the subset of defined stocks with the prefix that you have specified.

All

You must also specify whether the short dimension or the long dimension of the stock will receive priority.

For example, using this command with a legal-sized document causes Cypress to choose the Win Legal stock:

auto_image_stock("Win", "long")

The same command with a letter-sized image would cause Cypress to choose Win Letter.

auto_title

auto_title(x)

Chooses a format based on the title of the file being processed.

This dialect will extract a specified number of characters from the beginning of the file title and look for a format by that name. For example, if the name of your file is Accounting_summary.txt, then the command string auto_title (10) looks for a format called Accounting.

All

barcode_2of5

barcode_2of5 ("<font #>", "<cpi>", "<height>", "T")

barcode_2of5("<font #>", "<cpi>", "<height>", "F")

Used when printing applications that include 2-of-5 bar codes. When the PCL datastream selects the font typeface number specified in this dialect, Cypress will emit the data as a 2-of-5 bar code.

When using this dialect, you must specify the number of the PCL typeface used for the barcode, the horizontal spacing of the bar code in characters per inch (a real number between 1 and 18), and the height of bar code in inches (a minimum of 0.25 inches).

All

You must also indicate whether Cypress should calculate and append a check digit to the end of the data. Specify T to include a check digit and F to omit it.

Each value must be surrounded by quotation marks. For example, this is a valid command:

barcode_2of5 ("24641", "12.7", "0.5", "T")

barcode_enc_2of5

barcode_enc_2of5("<font #>", "<cpi>", "<height>")

Used when printing applications that encode 2-of-5 bar code information using the nwNW pattern. When the PCL datastream selects the font typeface number specified in this dialect, Cypress will emit the data as a 2-of-5 bar code.

When using this dialect, you must specify the number of the PCL typeface used for the bar code, the horizontal spacing of the bar code in character per inches (a real number between 1 and 18), and the height of barcode in inches (a minimum of 0.25 inches).

All

Each value must be surrounded by quotation marks. This is an example of a valid command:

barcode_enc_2of5 ("24641", "12.7", "0.5")

black_box_to_white

Draws black boxes of a certain size as opaque white boxes.

If a PCL command specifies a black box whose height and width are both greater than three millimeters, specifying this dialect will draw the box as an opaque white box rather than a black box.

All

capture_adept_log

This dialect should be used only if ASG Customer Support asks you to set it.

Causes Adept software to generate a log file of the data that is processed. If this dialect is specified, the log file is copied to the xxx_captured_files directory (where xxx is the DDI or LPD protocol or the protocol by which the data came in to Cypress). Supported only for AFP and Xerox LCDS/Metacode documents.

5.5.0.1

6.0.0.1

codepage

Instructs Cypress to use a particular code page with documents that use this format. A code page refers to a specific set of characters used by a computer.

5.5.0.1

convert_CMYK_with_ICC

Causes Cypress to use an ICC colorspace to convert CMYK colors to RGB during PDF capture, giving more accurate results.

7.3.x.24 or higher

copies (x)

Allows the number of copies to be specified in the spool form, where x is the number of copies desired.

5.5.1.17

6.0.0.5

copy_inx_into_nondata_form

Allows static forms to be indexed just as other document pages are.

By default, static forms are not indexed, even if the idx+ command is in effect. Specifying this dialect will cause Cypress to index static forms if the idx+ command is in effect.

All

copy_vars_into_nondata_form

Allows page variables to be set on static forms just as they are set on other document pages.

By default, page variables are not set on static forms, even if the var+ command is in effect. Specifying this dialect will cause Cypress to set page variables for static forms if the var+ command is in effect.

All

dbox_background_shade

When specified, any shade inline command is drawn to the background of the page, “behind” any form overlays or other page content.

7.5.2.23 and above.

delay_doc_index

When specified, Document Level indexes that are set via Inline Commands or via the Imaging Control will not be immediately set as part of the document capture, but will be set later via a background task.

This dialect will speed up document capture, but a query using these indexes may not return the document for a little while.

This dialect will only take affect when the System Index Delay option is set for the input type on the Administration/Parameters/Index tab.

7.5.1.16 and higher

discard

discard("<literal>", "<literal>", ...)

Discards print lines that begin with specified strings. You can specify up to 10 strings.

This dialect is useful for removing proprietary or printer-specific commands. This allows print files designed for a specific output device to be processed by Cypress.

This command will cause Cypress to remove any lines that begin with either %%DJDE or %%REPORT PAGE:

discard("%%DJDE", "%%REPORT PAGE")

All

discard_bad_image

Causes Cypress to discard any bad images in PDF or PostScript files being captured.

Without this dialect, a bad image will abort the document capture. A message will be emitted to the History stating that images were discarded.

7.3.2.27 and higher

discard_blank_page

Discards any completely blank page. This dialect is particularly useful for applications that send an extra blank character after the final page.

All

discard_data

Removes the data from a document, storing only the form. Supported only for AFP and Xerox LCDS/Metacode documents.

5.5.0.1

discard_empty_file

Discards completely empty files. By default, a document that contains only blanks will still be saved in Cypress.

All

discard_form

Removes the form from a document, storing only the data. Supported only for AFP and Xerox LCDS/Metacode documents.

5.5.0.1

discard_graphics

Discards graphics from a document, storing only text and lines.

For instructions on using discard_graphics, discard_lines, and discard_text in combination, see the ASG-Cypress Output Environment Administrator’s topic.

All

discard_lines

Discards lines from a document, storing only graphics and text.

For instructions on using discard_graphics, discard_lines, and discard_text in combination, see the ASG-Cypress Output Environment Administrator’s topic.

All

discard_text

Allows a page from a document to enter Cypress without its text.

For instructions on using discard_graphics, discard_lines, and discard_text in combination, see the ASG-Cypress Output Environment Administrator’s topic.

All

discrete_doc_size

Causes any file larger than the specified size to be captured as a discrete document.

This command accepts a file size in kilobytes.

For example, enter this command to capture all files larger than 12,500 kilobytes as discrete documents:

discrete_doc_size (12500)

4.5 and higher

dont_emit_rop

Prevents ROPs from being emitted onto the cypress page and will instead emit the image as a normal opaque image.

This can improve print speed but may result in incorrect document capture.

7.1.0.29

7.2.0.18

dont_quote_eapf_params

Prevents Cypress from surrounding EAPF string parameters with quotes.

7.1.0.28

7.2.0.17

draw_pattern_as_color

Emits an appropriate gray shade when a dot pattern is encountered. Supported only for AFP and Xerox LCDS/Metacode documents.

5.5.0.4

eapf_timeout_minutes(<minutes>)

Sets the time in minutes that Cypress will wait for an EAPF program to complete before it times out and aborts the capture process. The default timeout value if this dialect is not specified is 12 hours.

All

emit_fmt_pagevars

emit_fmt_pagevars(hmi)

Adds page variables to each page that specifies the characters per inch, lines per inch, and format used to build the page.

By default, Cypress sets the characters per inch value to the pitch value of the font. If you specify the optional hmi parameter, however, Cypress will set the characters per inch value to the horizontal motion index (HMI) value.

ASG recommends that you specify the hmi parameter for greatest accuracy.

All

emit_ps_print_commands

Controls whether postscript debug print commands, such as =, are sent to an output text file. If you do not use the dialect, the output is discarded.

6.5 and higher

enable_math8_symbolset

Enables the printing of data in the Math8 symbol set. Used in conjunction with the PCL symbol set command.

All

Controls how the fmt (format) inline command works. When you use this dialect, it treats a fmt inline command like a rfmt inline command. This causes the page to be reset to the specified format at that point.

7.1 and higher

force_newline(chars)

Causes the Formatter to force a new line after the specified number of characters are processed.

7.3.x.26 and higher

force_pcl_opaque

Forces white fill areas in PCL graphics to be opaque, not transparent. If this dialect is not specified, white fill areas in PCL graphics will be transparent. Using this dialect can save storage space and processing time.

All

fti_asa_cc

Applies the FORTRAN ASA carriage control for jobs submitted to Cypress via FT In.

When using this dialect, you should also be sure to configure the format’s Channel tab appropriately.

All

grid

grid(stream)

Prints a grid over the print data. This allows you to identify the row and column positions of a particular piece of data. The row and column information can then be used when you include the text function in your format identify criteria.

The stream parameter enables you to use the grid across several pages of data, ignoring all form feeds, InLine commands, and PCL data. This allows you to identify the row and column positions of a particular piece of data. The row and column information can then be used when you include the stream function in your format identify criteria.

All

ignore_font_encoding

Causes PDF capture to ignore the font encoding value set on an embedded TrueType font and reference the font glyphs directly by the character codes.

7.2.0.58, 7.3.x.22 and higher

ignore_initial_cc

Causes Cypress to always treat the first carriage-control command on a page as an instruction to move to the top of the page.

5.5.0.1

ignore_pcl_orientation

Causes Cypress to ignore any PCL orientation commands in the incoming data. The orientation specified in the Format tab is applied to the document.

7.1.0.23

7.2.0.15

ignore_pcl_plex

Overrides PCL plex commands with the plex configurations specified in the format definition.

All

image_error_device

Causes Cypress to route documents containing invalid images to the specified device. When you are using this dialect, any document with an invalid image will be sent to the error device queue while remaining documents will still be processed normally.

This dialect is useful when creating multiple documents using the InLine command start_new_document.

5.5.1.4

image_quality_factor

image_quality_factor(x)

Overrides the default image compression setting. You must specify a compression setting that ranges from 1 to 100, where 1 represents the smallest size, lowest quality compression and 100 represents the largest size, highest quality compression. The compression must be specified as a whole number.

All

init_ilc_char

init_ilc_char(<ascii code>)

init_ilc_char("<literal>")

Changes the initial InLine command character from the default caret (^) character. This is useful when the default InLine command characters need to be treated as print data rather than as InLine commands.

This dialect’s only parameter is the new InLine command character. You can specify this character either by its ASCII decimal value (not octal or hex) or by a string literal. For example, both of these init_ilc_char dialects will change the initial character from ^ to a comma (,):

init_ilc_char(",")

init_ilc_char(44)

All

This format dialect is still supported to provide backward compatibility. However, the simplest way for you to specify a new initial InLine command character is to use the Initial Character field on the Data Type tab of the Format dialog in the Administration Tools module. ASG recommends the use of this field rather than the dialect when creating new format definitions.

lpd_asa_cc

Directs Cypress to use the first character in each line as the carriage control character for data coming from the LPD protocol.

When using this dialect, you should also be sure to configure the format’s Channel tab appropriately.

All

max_codepage_errors

max_codepage_errors(<x>)

Specifies the number of code page errors in a document that Cypress will tolerate before it stops processing the document.

5.5.0.1

max_page_forms

max_page_forms(x)

Specifies the maximum number of form overlays that will appear on a page processed by this format. Required when you need to have pages with more than one form.

All

native_desc_only

When used with an FTin directory configured to also capture as Native File, this dialect causes a page to be built containing the file title and capture time, instead of reading the actual file content.

7.3.2.28 and higher

native_file (also)

native_file (convert)

native_file (convert_nowait)

native_file (only)

Allows you to capture documents input using LPD, TCP, and DDI protocols in their native format.

If the DDI protocol’s capture type is specified elsewhere in Cypress, it will override the native_file setting.

This dialect requires a parameter that specifies the type of native file capture.

6.5.0.1

native_tiff_res (x)

Allows you to specify the resolution at which TIFF images are captured.

6.1.0.11

6.5.0.1

no_fti_security

Directs Cypress to not apply the FT in directory’s security settings to captured documents.

6.1.0.12

6.5.0.1

no_lpd_asa_cc

Directs Cypress not to use the first character in each line as the carriage control character for data coming from the LPD protocol.

In most cases, this dialect will be needed only if you are using an EAPF that has already handled and removed ASA carriage control.

All

old_font_linespacing

Causes the PCL line spacing and top margin commands to use the size of the initial font (old incorrect behavior) instead of the currently selected font (new correct behavior).

7.3.1.16

old_pcl_top_position

Cypress has changed the way it determines the initial PCL position at the top of a page. Because this could affect regions and data boxes, the old_pcl_top_position format dialect has been created to allow users to revert to the previous method of determining the initial PCL position. You should use this dialect only if existing regions and data boxes are affected by this change.

5.0.02

override_pcl_pattern

override_pcl_pattern(clear)

override_pcl_pattern(gray)

override_pcl_pattern(<r>, <g>, <b>)

Forces Cypress to override the pattern specified by PCL. Using the clear parameter will cause Cypress to replace the pattern with a clear background; using the gray parameter will cause Cypress to replace the pattern with a gray shade that matches the pattern as closely as possible.

You can also specify a particular color using RGB notation. This is an example that produces a red background:

override_pcl_pattern(255, 0, 0)

5.0.02

pcl_edge_to_edge

Allows printing to the edge of the page when capturing a PCL file.

6.1 and higher

pcl_init_lpi

Sets the initial lines per inch (lpi) to be used by Cypress when jobs with PCL commands are processed.

This dialect can be useful for applications that insert PCL commands in a print file, but rely on the printer’s default lpi setting to control line spacing.

If this dialect is not specified, Cypress will control line spacing using the format’s configuration.

All

pcl_initial_pos

pcl_initial_pos("old")

pcl_initial_pos("new")

Forces Cypress to process documents under pre-Build 4 rules. This dialect can be useful if you have pre-Build 4 RDM regions set up. Without this dialect, the region text might not be captured as expected.

To use pre-Build 4 rules in a format, use this command:

pcl_initial_pos("old")

It is not necessary to specify this dialect with the new parameter, as this is the default.

All

pcl_tray

pcl_tray("<tray #:stock>", ...)

Allows PCL tray select numbers reference in a job to be mapped to stocks that are defined within Cypress. You can specify up to 20 stocks within the command string. These stocks can then be accessed via a PCL escape sequence within the job. The escape sequence has this structure:

ESC&l<n>H

The ampersand in the escape sequence is followed by a lowercase L, not the number 1 or an uppercase I.

All

For example, this command causes Cypress to use the Win Letter stock when it encountered the escape sequence ESC&l1H:

pcl_tray("1:Win Letter", "4:cover", "5:banner")

Similarly, Cypress would use the cover stock when encountering the escape sequence ESC&l4H and the banner stock when encountering the escape sequence ESC&l5H.

You can also use this dialect with PostScript.

pdf_cache_purge_pages

pdf_cache_purge_pages(x)

This dialect causes Cypress to purge the PDF cache for a particular document after processing a specified number of pages. For example, if you specify 1000, the cache will be purged after every 1,000 pages.

This dialect is intended for use with large PDF files whose cache can take up a lot of memory during processing. Adjusting the number of pages before the cache is purged allows you to manage memory use when processing PDFs.

All

The lower the setting for the pdf_cache_purge_pages dialect, the slower the processing of the PDF as the cache is rebuilt after every purge.

If no value is entered for this dialect, the cache is purged every 2, 000 pages. When entering a value, enter the number of pages to store before purging.

pdf_ignore_clip

Ignores all clip path operations in the pdf input driver.

7.5.1.19 and higher.

pform_use_prev_matrix

Causes a PFORM inline command without a matrix to use the matrix values from the form being replaced.

7.3.1.16

proportional_font_factor(<factor>)

This dialect sets the scaling factor for proportional fonts in PCL_5 documents. In some cases, the character widths in proportional fonts specified by the PCL_5 data do not exactly match the widths of the Windows system fonts used by Cypress. This factor may be used to adjust the widths, and is specified as a percentage. The default value is 100, which does not adjust the character widths. For example: proportional_font_factor(97) sets the character widths to 97% of their ‘normal’ size.

9.0.0.10

ps_encoding_offset(<offset>)

Causes the specified offset amount to be added to the character codes in the PostScript encoding table.

This dialect is used for PostScript capture.
It is needed in unusual situations when a subsetted embedded font does not use standard Unicode character names.

7.2.0.63, 7.3.2.31 and higher

ps_ensure_blank_page

Ensures that completely blank pages in PostScript pages are stored in the document as blank pages.

7.1.0.49

7.2.0.43

retain_blanks

Causes blanks to be emitted as blanks. By default, when Cypress encounters 32 or more blanks, it uses PCL commands to position data rather than retain the blank characters.

All

retain_orig_text

Captures raw text and retains the original formatting for later export. This dialect is used in conjunction with the Export Unformatted Text feature and must be enabled prior to using the feature.

This dialect works only with simple text captures.

6.1.0.9

stripes

Causes colored stripes to be placed onto each captured page, using parameters to fit the captured data. The stripes are drawn horizontally from the left margin to the right margin.

This dialect requires these parameters:

For example, you would enter this command to create the typical greenbar look:

stripes (3,3,3,230,250,230

The result is three lines before the first stripe, then stripes alternating on and off every three lines with the stripes in a light green color.

7.0.0.5

7.1.0.14

7.2 and higher

substitute_fonts

substitute_fonts("Type1")

substitute_fonts("Type3")

substitute_fonts("Type42")

Replaces the font type specified with DocuVault fonts.

Cypress has no way to determine the size of Type 3 fonts, so although it will substitute DocuVaults fonts for Type 3 fonts, the font size will in most cases be incorrect.

5.0.1

substitute_pcl_ttf

Substitutes embedded PCL 5 TrueType fonts instead of capturing the fonts per document.

7.5.1.26

8.0.5.13 and above

suspend

Causes all job tickets to be suspended when they are created.

5.5.0.1

6.0.0.1

symbol_set

symbol_set("latin1")

symbol_set("latin5")

symbol_set("iso8859-2")

symbol_set("win1250")

symbol_set("oem852")

symbol_set("roman8")

symbol_set("roman9")

symbol_set("latin2")

symbol_set("pc8")

symbol_set("pc850")

symbol_set("pc858")

symbol_set("win30latin1")

symbol_set("windows31")

symbol_set("win31latin1")

symbol_set("win31latin2")

symbol_set("oem855")

symbol_set("oem862")

symbol_set("oem866")

Replaces the default symbol set (Roman8) with the specified symbol set. Only these symbol sets are supported:

Latin1

Latin5

ISO8859-2

Win1250

OEM852

Roman8

Roman9

Latin2

PC8

PC850

PC858

Windows30Latin1

Windows31

Windows31Latin1

Windows31Latin2

OEM855

OEM862

OEM866

If an invalid symbol set is specified, the default symbol set will be used.

The symbol_set Dialect provides more information on the symbol_set dialect, as well as character tables for each of the supported symbol sets.

All

transparent_unknown_symbolset

Sends data associated with unknown symbol sets to a Cypress device but does not print it. The data will be archived with the document in the DocuVault, but it will not be viewable.

If the data is printed to a PCL printer, it will be processed as if it was in the PCL.

All

treat_masked_as_white

Causes PDF capture to treat a mask image as an opaque image by converting the masked out pixels to white. This prevents the image from using a Raster Operation.

7.3.2.28

treat_null_as_blank

Treats null characters as blank characters.

All

treat_unknown_as_space

Treats unknown characters as spaces.

4.5.0.24

5.0.1.11

5.5.0.1

unmask_errors

Turns off error-masking when a job fails, allowing a Dr. Watson session to be initiated.

All

updm

Abbreviated name for use_pcl_default_margins.

6.1.0.11

6.5.0.1

use_format_stock

Applies the stock specified in the format to the document rather than relying on Cypress’s automatic stock selection.

Valid only for PDF documents.

5.0.1.17

5.5.0.1

use_hmi_for_blanks

Uses the HMI value to determine the spacing rather than a space character.

4.5.0.28

5.0.1.16

5.5.0.1

use_innate_char_widths

Causes Cypress to use the widths of the Windows font glyphs, instead of the widths from the AFP or Xerox fonts.

This dialect is used for AFP or Xerox capture only.

7.1

7.2

7.3 and higher

use_old_ocr

Causes Cypress to use the old OCR engine instead of the newer (default) OCR facility.

7.5 and higher

use_pcl_default_margins

Instructs Cypress to use the standard PCL default value for margins instead of the values specified in the format.

6.1.0.11

6.5.0.1

varlen_linedata

Processes variable length line data without using the AFP Capture module.

This dialect processes data in this format:

7.2.0.40 and higher

view_orientation

view_orientation(por)

view_orientation(lan)

view_orientation(ipor)

view_orientation(ilan)

Overrides the default orientation of the view.

The view_orientation dialect takes one of four parameters:

Specifying view_orientation(por) forces the document to appear on the screen in portrait orientation.

Specifying view_orientation(lan) forces the document to appear on the screen in landscape orientation.

Specifying view_orientation(ipor) forces the document to appear on the screen in inverse portrait orientation.

Specifying view_orientation(ilan) forces the document to appear on the screen in inverse landscape orientation.

All

zpl_font_ids

Specifies the IDs of the fonts to be used in the ZPL label. This dialect accepts up to four font IDs:

The default fixed-pitch font is Lucida Console.

The default proportional font is Arial Bold.

The default OCR font is the fixed-pitch font.

Example: zpl_font_ids(166,2,1398,1456)

9.0.0.9

zpl_resolution

Sets the internal resolution for ZPL documents. This value is in pixels per mm, and is usually 6, 8, or 12, with the default value of 8.

9.0.0.9