acos print agent reference

8/10/2019 ACOS Print Agent Reference

1/355


2/355


3/355


4/355


5/355


6/355


7/355


8/355


9/355


10/355


11/355


12/355


13/355


14/355


15/355


16/355


17/355


18/355


19/355


20/355


21/355


22/355


23/355


24/355


25/355


26/355


27/355


28/355


29/355


30/355


31/355


32/355


33/355


34/355


35/355


36/355


37/355


38/355


39/355


40/355


41/355


42/355


43/355


44/355


45/355


46/355


47/355


48/355


49/355


50/355


51/355


52/355


53/355


54/355


55/355


56/355


57/355


58/355


59/355


60/355


61/355


62/355


63/355


64/355


65/355


66/355


67/355


68/355


69/355


70/355


71/355


72/355


73/355


74/355


75/355


76/355


77/355


78/355


79/355


80/355


81/355


82/355


83/355


84/355


85/355


86/355


87/355


88/355


89/355


90/355


91/355


92/355


93/355


94/355


95/355


96/355


97/355


98/355


99/355


100/355


101/355


102/355


103/355


104/355


105/355


106/355


107/355


108/355


109/355


110/355


111/355


112/355


113/355


114/355


115/355


116/355


117/355


118/355


119/355


120/355


121/355


122/355


123/355


124/355


125/355


126/355


127/355


128/355

Adobe Central Output Server Print Agent Reference for Microsoft Windows Command Line Options 128

Note: The -auwp command line option is not identical to the -autfss command line option.When using the -auwp option, Print Agent will not switch fonts to print a character. Forexample, if your current font is Arial and you have Korean data in your data file, with the-auwp option Print Agent will just print blank characters. However, with the same

scenario and the -autfss option, Print Agent will switch to a Korean font to print the data.

-avl (Set Variable Leading)

Format-avl{f|v|fv}

The -avl option affects leading, or the distance between printed lines of text. When the font size

for a field changes from the default font, the leading may need to change accordingly.For another method of setting leading, see the "[fixed| variable|fixed variable]" arguments of the^inline command on page 200 .

The arguments for -avl are:

f (Fixed Leading)The -avlf option, or fixed leading, is the default. Print Agent processes all text using the linespacing from the field definition, as provided by the template designer, regardless of the font

size used.

v (Variable Leading)The -avlv option, or variable leading, adjusts all line spacing based on the largest font within aline of text. If the largest font used is still smaller than the default font for the field, the linespacing is adjusted accordingly.

fv (Fixed Variable Leading)The -avlfv option, or fixed variable leading, adjusts the line spacing only when the font usedwithin a line of text is larger than the default font for the field. The use of smaller fonts does notadjust the line spacing.

-avnh (Hard Disk Volume Number)

Format-avnh n


129/355


To specify a volume number for a printer that has more than one hard disk, start Print Agentwith the -avnh option. This option is necessary when formatting the hard disk, downloadingmacros to it, and using macros stored on it. It does not affect macros stored in ordinary RAM.

n is the volume number. The default volume number is zero. The range for the volume number

is zero through nine, inclusive. You may specify both -avnh and -avnr (see page 129 ) on thesame command line; Print Agent uses whichever (if either) is appropriate to the job.

-avnr (Nonvolatile Memory Volume Number)

Format-avnr n

To specify a volume number for a printer that has nonvolatile (flash) memory, start Print Agentwith the -avnr option. This option is necessary when formatting the nonvolatile memory,downloading macros to it, and using macros stored on it. It does not affect macros stored inordinary RAM.

n is the volume number. The default volume number is zero. The range for the volume numberis zero through nine, inclusive. You may specify both -avnh (see page 129 ) and -avnr on thesame command line; Print Agent uses whichever (if either) is appropriate to the job.

The TEC label printer is a special case, but only when reformatting its nonvolatile memory. (See-afmf (Format Nonvolatile Memory) on page 82 .) In this case -avnr specifies an area of thememory card to reformat: two means the PC save area, three means the writable character

area, and all other values of zero through nine mean the whole card.

-avs (Set Variable Substi tut ion)

Format-avs{on|off}

By default, Print Agent performs variable substitution, but in rare cases this may beundesirable. You may enable variable substitution by starting Print Agent with the -avson

option. Otherwise, start Print Agent with the -avsoff option.For another method of setting variable substitution, see the [novarsub|varsub] arguments ofthe ^inline command on page 200 .

For the substitution variables, see page 281 .


130/355


-axml (Process as XML)

Format

-axml{yes|no|strict|medium|lax}

To control the automatic detection of XML format in the main data file, start Print Agent with the-axml option.

With -axmlyes , Print Agent treats the file as XML format.

With -axmlno , Print Agent treats the file as field-nominated format.

With -axmlstrict , Print Agent treats the file as XML format if and only if the first five bytes afterthe byte-order mark are


131/355


command line option, if supplied, overrides the corresponding configuration file option.However if the command line option has the value of the null string (that is, if it is supplied as-axml), it is considered not to have been supplied.

The ^file command has an option similar to the -axml command line option. This makes it

possible to override the default XML recognition rule for files included this way. For detailsabout including the axml option in a ^file command, see ^file (Include File in Data) onpage 189 .

The -axml option does not affect the processing of a preamble file specified with the -apr command line option or with the PreambleFile option in jfmerge.ini . Preamble files are alwaysprocessed using the default XML recognition rule specified by the ProcessAsXML option in

jfmerge.in i .

-axpf (Execute Preamble Upon Processing ^ form)

Format-axpf{on|off}

To process a JFPREAMBLE document variable associated with a ^form command, start PrintAgent with the -axpfon option. This is the default. This option is another means of associatingpreamble information with the transaction.

For templates created with Output Designer, the template designer creates a documentvariable, with a Custom name of JFPREAMBLE. Its associated Custom value can include any

commands or data. When Print Agent encounters a ^form command with the option -axpfon , itlooks in the template for the JFPREAMBLE document variable. It stores the document variableand its value in the DocVar Dictionary ( see page 58 ). Print Agent then processes the dictionaryentry as data. When it finishes, Print Agent resumes processing with the line after the ^form command.

When you specify the -axpfon option on the command line, processing applies to all ^form commands, not just the first. To have the -axpfon option apply to only one ^form command,include it with the command, instead of on the command line. To ignore the JFPREAMBLEdocument variable, start Print Agent with the -axpfoff option.

-axps (Execute Preamble at Start-up)

Format-axps{on|off}

To process a JFPREAMBLE document variable at start-up, start Print Agent with the -axpson option. This is the default. This option is another means of associating preamble informationwith the transaction.


132/355


For templates created with Output Designer, the template designer creates a documentvariable, with a Custom name of JFPREAMBLE. Its associated Custom value can include anycommands or data. When Print Agent encounters the -axpson option on the command line, itimmediately opens the template and retrieves the JFPREAMBLE document variable. It storesthe document variable and its value in the DocVar Dictionary ( see page 58 ). Print Agent then

processes the dictionary entry as data. When it finishes, Print Agent resumes processing withthe first line of the data stream.

Note: When you use the -axpson option, you must supply the template name on thecommand line. When you include the template name in the transaction file with a ^form command, use the -axpf option to process a JFPREAMBLE document variable.

When you start Print Agent with both the -axpson and the -apr preamblefile options, PrintAgent processes the -axpson option first. To ignore the JFPREAMBLE document variable, startPrint Agent with the -axpsoff option.

-axusetempfi le (Use Temporary File)

Format-axusetempfile {yes|no}

When Print Agent is processing an XML data file, it does so in two steps, first translating thedata file into field-nominated format and then processing the translated data. In previousreleases Print Agent always held the translated data in memory. Print Agent now has the optionof holding the translated data in memory or keeping it in a temporary file.

To specify the location for storing translated data, start Print Agent with the -axusetempfile option.

With -axusetempfileyes , Print Agent keeps the translated data in a temporary file until it isprocessed. This is the default. The use of a temporary file provides better system performanceand it is friendlier to other applications running concurrently on the same computer.

With -axusetempfileno , Print Agent holds the translated data in memory until it is processed.

The corresponding configuration file option for -axml is UseTempFile in the [Options] section ofthe Print Agent configuration file, jfmerge.ini .

-azc (Zebra Hex Indicator Character)

Format-azc character


133/355


To change the hex indicator character used with a Zebra printer, start Print Agent with the -azc option. When printing to a Zebra printer, the hex indicator character must not occur in the inputdata stream.

The default value at installation is set to _ (underscore). This value is controlled by theZebraHexControlChar setting in the [Options] section of the Print Agent configuration file, jfmerge.in i .

-c (Number of Copies)

Format-c nn

To specify the number of printed copies of a template, start Print Agent with the -c option. nn isthe number of copies, which must be an integer. The maximum number of copies is 99,999,999,subject to the limitations of your printer. Refer to your printer documentation for limitations onthe maximum number of copies you can print.

For example, to merge the data in the file costs.dat with the template report.mdf and print fivecopies, type this command:

jfmerge report.mdf costs.dat -aiijfmerge.ini -c5

Print Agent does not collate the output. For example, if report.mdf is a two page template andPrint Agent prints five copies, you receive five copies of page 1 and then five copies of page 2.

When you do not specify a number of copies, Print Agent prints the number of copies compiledin the template in Output Designer.

This option is supported only for Print Agent presentment targets and only for printed copies.

-f (File Name Override)

Format-f mdfname

To override any template name entered earlier on the command line, start Print Agent with the-f option.

mdfname is the template name. It may be any of a fully qualified file name, a fully qualified URLbeginning with http:, or a file or resource name without a path. If mdfname is not fullyqualified, Print Agent will attempt to open it as a file in the current directory. If this attempt failsand the -afp template path option ( see page 82 ) has been supplied, Print Agent will try againusing the template path.


134/355


mdfname may also be a place holder when a ^form command ( see page 191 ) occurs early inthe data stream.

This option is useful when starting Print Agent within a script.

-i (Record Length Initial Value)

Format-i n

To change the initial value of the record length of a physical line in the data stream, start PrintAgent with the -i option. n is the record length initial value, and can be any number up to andincluding the maximum positive value for an integer on the platform. For most machines, this is2 to the power of 31.

The default record length initial value is 6144 bytes. The record length upper limit is 19996bytes.

For example, to change the initial value of the record length for the file costs.dat to 8600 bytes,type this command to merge the data in costs.dat with the template:

jfmerge report.mdf costs.dat -aiijfmerge.ini -i8600

-j (Suppress Banner)

Format-j

When you start Print Agent on text-oriented platforms, a banner displays the version of PrintAgent you are running. When you do not wish to see this banner, start Print Agent with the -j option.

For example, to merge the data in costs.dat with the template report.mdf without displayingthe banner, type this command:

jfmerge report.mdf costs.dat -aiijfmerge.ini -j

-l (Template Already Loaded)

Format-l


135/355


To specify that the template may already be downloaded as a macro in the printer, start PrintAgent with the -l option. Note that this is the letter el, not the number one. Print Agentmerges the data with the template in the macro number specified by the -m option. This allowsfor much faster printing, as Print Agent does not send the template to the printer at thebeginning of the print job.

For example, to merge the data in the file costs.dat with a template named prices.mdf storedas permanent macro number 12, type this command:

jfmerge prices.mdf costs.dat -aiijfmerge.ini -l -m12p

You must download the macro before you can print using the -l option. Use the -m optiondescribed below to download the template to the printer. Using the -l option affects all templatesin the data stream. You must download all referenced templates to the printer as macros.

-m (Download Macro to Printer)

Format-mnn [p|t|f|m|r|h]

Start Print Agent with the -m option to: Download a template to the printer with a macro number different from the macro number

assigned when the template was compiled. Print a template that is already downloaded to the printer. Both download and print the template.

nn is the number of the macro. It can have a maximum of five digits and be between 0 and32767. To download a template to the printer as a specific macro number, replace nn with thedesired number. When you do not enter a value for nn , or when you enter a value of -1, themacro number defaults to the number compiled into the template in Output Designer. This is thedefault.

When you want to store a template as a permanent macro, you must use a macro numbergreater than one. If you do not supply a macro type, a macro number of one is taken as atemporary macro, and a macro number greater than one is taken as a permanent macro. Amacro number less than -1 tells Print Agent not to use macros at all, for any printer type.

For example, to download a template named lease.mdf to the printer as macro number 132,type this command:

jfmerge lease.mdf -aiijfmerge.ini -m132

The -m option also prints a blank template. To download the template without printing a copy,include the -q option (see page 139 ).

jfmerge lease.mdf -aiijfmerge.ini -m132 -q


136/355


To print a template that is already downloaded to the printer as a macro, specify the macronumber, append the p (Permanent) argument, and include the -l option ( see page 134 ).

jfmerge lease.mdf -aiijfmerge.ini -m132p -l

When the template is a multipage template, Print Agent downloads the template intoconsecutive macro numbers. For example, when you download a six-page template namedlease.mdf as macro number 14:

jfmerge lease.mdf -aiijfmerge.ini -m14

page 1 of the template is macro 14, page 2 is macro 15, and so on. This overwrites any macroswith these macro numbers. When you download a multipage template as macro 1 or as atemporary macro, Print Agent clears all pages of the template from the printer memory whenprinting finishes.

Your printer memory capacity determines the maximum number of macros that can reside inyour printer at any time. Refer to your printer documentation for limitations on resident macros.

-m ArgumentsThe arguments for the -m option tell Print Agent how and where to store printer macros. PrintAgent maintains this information for some types of macros in a Macro Status Table file for eachprinter.

If the printer is powered off, all downloaded templates are lost, leaving the Macro Status Tableout of sync. You can download the permanent template macros to one or more printers andre-synchronize the Macro Status Table files for each printer by choosing the Printer Reload command from the Control menu in Central Control.

For the Printer Reload command, see the guide, Central Control .
http://control.pdf/http://control.pdf/


137/355


This table describes how Print Agent interprets the -m option, with the inclusion of itsarguments, and with and without the inclusion of the -l option. It also lists the supported printersfor each argument.

-m Argument Without -l option With -l option

p (Permanent) For PCL 5, PostScript Level 2 andsome labels printers - downloadsthe macro to the printer as apermanent macro and updates theMacro Status

For PCL 5, PostScript Level 2 andsome label printers - assumes themacro is downloaded, but does notconsult or update the Macro StatusTable.

For PCL 6 printers, permanent macros are not supported.

t (Temporary) The inclusion or not of the -l option does not affect the downloading oftemporary macros.

For PCL 5, PCL 6, PostScript Level 2, and some label printers, downloads

the macro to the printer as a temporary macro.For PCL 5 and PCL 6 printers, the macro is deleted at the end of the print

job. For PostScript Level 2 and label printers, the macro remains in theprinter until replaced by another macro with the same number, or until theprinter is manually reset.

f (Load-first-time) For PCL 5, PostScript Level 2 andsome label printers - downloads themacro to the printer the first time it isused and updates the Macro StatusTable.

For PCL 5, PostScript Level 2 andsome label printers - checks theMacro Status Table and downloadsthe macro only if it is not currentlydownloaded.

For PCL 6 printers, load-first-time macros are not supported.m (ManagedMemory Macro)

Downloads the macro into managedmemory and updates the MacroStatus Table.

Checks the Macro Status Table anddownloads the macro only if it is notcurrently downloaded. Beforedownloading, it may remove othermanaged macros from the printer inorder to make room for the newmacro.

This macro type is supported for PCL 5 and some label printers.

r (Nonvolatile

Memory Macro)

Downloads the macro into

nonvolatile memory. Does notupdate the Macro Status Table.

Assumes the macro is downloaded,

but does not consult or update theMacro Status Table.


138/355


-n (Event Trace Level)

Format-n nn

To specify the Intelligent Pagination event trace level, start Print Agent with the -n option. nn can be any number within the range 0 to 100. When you do not enter a value for nn , the valueis set to 0. The default is 100. Print Agent sends the output to the log file

The possible values for the-n

option are:.

This macro type is supported for some PCL 5 and some label printers.

Print Agent does not print the template at the same time it is downloading itinto nonvolatile memory.

Note: Once the macro is downloaded to nonvolatile memory, it can beinvoked as a permanent macro with the p argument; the printersearches both RAM and nonvolatile memory for the macro. Thiscan be convenient if you have some printers with nonvolatilememory, and some without.

h (Macro in HardDisk Drive)

Downloads the macro intothe printers hard disk. Does notupdate the Macro Status Table.

Assumes the macro is downloadedalready, but does not consult orupdate the Macro Status Table.

This macro type is only supported on some models of PCL 5 andPostScript Level 2 printers.

Print Agent does not print the template at the same time it is downloading itinto the printer hard disk.

Note: Once the macro is downloaded to disk, it can be invoked as apermanent macro with the p argument; the printer searches bothRAM and hard disk memory for the macro. This can be convenientif you have some printers with disks, and some without.

-m Argument Without -l option With -l option

Value Description

Between 0 and 39 Returns all event trace messages, including the macro content of allevent macros found. In addition, each line of the data stream isechoed to the log file.

Between 40 and 49 Returns all event trace messages, with the exception of the macrocontent and the contents of the data stream.

Between 50 and 100 Sets event trace messaging off.


139/355


-p (Printer Offset)

Format

-p[c|m|i] x , y

To offset the data on the page, start Print Agent with the -p option. Use c to indicatecentimeters as units of measure, m to indicate millimeters, or i to indicate inches. If you donot specify a unit of measure, the default is inches.

x is the horizontal offset and y is the vertical offset. x and y may be decimals for offsets ofless than an even number of units. This enables you to arrange the data on a pre-printedtemplate correctly.

For example, to move the data to the right 5 inches and down 12.5 inches, start Print Agent withthis command:

jfmerge formname datafile -aiijfmerge.ini -pi5,12.5

When you want a vertical offset only, that is moved down 12.5 centimeters, start Print Agentwith this command:

jfmerge formname datafile -aiijfmerge.ini -pc0,12.5

-q (Quiet Download)

Format-q

To download the template as a macro without printing it, start Print Agent with the -q option.

For example, to download a template named lease.mdf into the printer using the macronumber compiled into the template, use this command:

jfmerge lease.mdf -aiijfmerge.ini -q

Note: If you include the transaction file name with the command, Print Agent will print the

template and data.

-r (Reformat Data)

Format-r{yes|no|fold|off|clip|trunc}


140/355


To control the handling of newline characters when processing multi-line fields, start Print Agentwith the -r option. The default is off .

You can achieve the same result by including the ^reformat command ( see page 220 ) in thedata stream. However, the ^reformat command overrides the -r option on the command line.

Print Agent recognizes two newline characters in the data stream: The carriage return/line feed sequence. The ~ (tilde), which is the Print Agent alternate newline character to the < CR/LF> carriage

return/line feed sequence.

The examples that follow use the ~ alternate newline character, although the data streamrepresentations make it appear otherwise. In order to depict the data on the page, the lineswere broken to fit the space. Only the ~ character represents actual new lines.

The arguments for -r are:

yesWhen -r is yes :

Print Agent discards all newline characters in the data with these exceptions: When the first character in a line is a space, Print Agent keeps the newline character at

the end of the previous line and the space. When two or more newline characters immediately follow each other, Print Agent keeps

them all. Print Agent word wraps the data within the field boundaries. When there is more data than a field can hold, Print Agent overflows the data to the next field

on the template, and the next, until the data finishes. When the fields on the template cannotcontain all the data, Print Agent overflows the data to the next page. When there is dataspecifically designated for a field that receives overflow data, Print Agent overprints the firstdata with the second.


141/355


This example shows how Print Agent handles data when the -r argument is yes :

This is the blank template showing theposition and size of fields.

This is the data stream, showing the data foreach field.

^field FIELD_1This field is~field_1. All~data word~wrapswithin the~field boundaries. If~thereis~more data~than will fit, the~dataoverflows~to the next~field on~the form. Ifthere is~data specifically designated~forthe field that took the~overflow, the Print Agent~overprints the first data with thesecond.^field FIELD_2This field is~field_2. All~newline~characters~in the data are~discarded except~for the exceptions~in field_3and~field_4.^field FIELD_3This field is~field_3.~ If the~firstcharacter~in a line is a~space, the Print Agent~keeps the~new line character~at the

end~of the~previous line~and the space.^field FIELD_4This field is~field_4.~~If two~or morenew~line characters~immediately follow~eachother, then the Print Agent keeps them all.


142/355


This is the result of merging the template anddata stream.

In Field_1 and Field_2, Print Agent discardsthe newline characters and word-wraps thedata within the field boundaries.

Field_2, Field_3 and Field_4 show theoverflow of data from the previous fields. Ineach instance, data overflows to the newfield, and data intended for that fieldoverprints the overflow data.

Normally, merging this template and datastream produces a one page output.However, all data designated for Field_4 didnot fit in the field. The data overflows the fieldto a second page.

This field is field_1. Alldata word wraps within thefield boundaries. If there is more data than will fit, the

data overflows to the nextfield on the form. If there isdata specifically designated for the field that took theoverflow, the Print Agentoverprints the first

This field is field_2. Allnew line characters in thedata are discarded except forthe exceptions in field_3 and

field_4.This field is field_3.If the first character in a

line is a space, the Print

Agent keeps the new linecharacter at the end of the

previous line and the space.This field is field_4.

If two or more new linecharacters immediately followeach other, then the Print

data with the second.

Agent keeps them all.


143/355


noWhen -r is no , in fill justified fields Print Agent: Retains all newline characters in the data.

Word wraps the data between newline characters. Truncates the data at the end of the last word that fits in the field, when there is more data

than the field can hold.

When -r is no , in all other fields Print Agent: Retains all newline characters in the data. Does not word wrap the data. Extends the data outside the left and right boundaries of the field, when there is more data


This example shows how Print Agent handles data when the argument for the -r option is no :



^field FIELD_1This field is field_1. The~field IS NOTfill justified.~The data will overflow thefield boundary.^field FIELD_2This field is field_2. The field IS filljustified. The data will truncate at theend of the last word that fits in thefield.^field FIELD_3This field is~field_3. The field IS NOTfill justified. The data will notword-wrap.^field FIELD_4This field is field_4. The field~IS filljustified. The data word-wraps between newline characters.


144/355


fold

When-r

isfold

, Print Agent: Retains all newline characters in the data. Word wraps data within the field boundaries. When there is more data for a field than the field can hold:

For fields with a height of one line, overflows data outside the field boundaries. For fields with a height of more than one line, truncates data at the end of the last word

that fits in the field.

This is the result of merging the template anddata stream. In all fields, Print Agent retainsthe newline characters.

Field_2 and Field_4 are fill justified. PrintAgent word-wraps the data within the newlinecharacters and truncates the data at the endof the last word that fits in the field.

Field_1 and Field_3 are top left justified. PrintAgent does not word-wrap the data. Wheredata between newline characters is too longto fit on one line, it extends outside the fieldboundaries. In this example, it extendsoutside the right boundary only because thefields are left justified.

This field is field_1. Thefield IS NOT fill justified.The data will overflow the field boundary

This field is field_2. The

field IS fill justified. Thedata will truncate at the end

This field isfield_3. The field IS NOT fill justified

This field is field_4. Thefield IS fill justified. The data


145/355


This example shows how Print Agent handles data when the argument for the -r option is fold:



^field FIELD_1This field is field_1. With~fold, the~Print Agent retains all new line characters and word-wraps data within the field boundaries.^field FIELD_2This field is field_2. The Print Agentoverflows data outside the field boundariesfor fields with one line height.^field FIELD_3This field is field_3. The Print~Agenttruncates data at the end of the~last word that fits in the field,~when there is moredata than the field can hold.


146/355


off

When-r

isof f

, in fill justified fields Print Agent: Discards newline characters from the data with these exceptions:

When the first character in a line is a space, Print Agent keeps the newline character atthe end of the previous line and the space.

When two or more newline characters immediately follow each other, Print Agent keepsthem all.

Word wraps the data within the field boundaries. Truncates the data at the end of the last word that fits in the field, when there is more data


When -r is of f , in all other fields Print Agent: Retains newline characters. Does not word wrap the data. Extends the data outside the boundaries of the field, when there is more data than the field

can hold. Does not keep vertical (top, middle and bottom) placement of the data, but begins printing

data at the top of the field. Keeps horizontal (left, right and center) placement of the data.


Field_1 shows that Print Agent retains thenewline characters. Where data betweennewline characters is too long to fit on oneline, it word-wraps within the field boundaries.

Where there is more data for a field than thefield holds, the resulting output depends onthe height of the field. When the field has aheight of one line, as shown in Field_2, thedata overflows outside the field boundaries.When the field has a height of more than oneline, as shown in Field_3, the data truncatesat the end of the last word that fits in the field.

This field is field_1. Withfold, thePrint Agent retains all new linecharacters and word-wraps data withinthe field boundaries.

This field is field_2. The Print Agent over

This field is field_3. The Print Agent truncates data at the end of thelast word that fits in the field, when


147/355


This example shows how Print Agent handles data when the argument for the -r option is off :



^field FIELD_1This field is field_1. In~filljustified~fields, the Print Agent~discardsnew line characters~except for theexceptions in~field_2 and field_3.Data~word-wraps within~field boundaries.Data truncates at the end~of the last word that fits in the field, when there~is moredata than the field can hold.^field FIELD_2This field is field_2.~ If the firstcharacter~in a line is a space, the~Print Agent keeps the new line~character at theend of the~previous line and the space.^field FIELD_3This field is field_3.~~If two or morenew~line characters immediately~follow eachother, the Print Agent~keeps them all.

^field FIELD_4This field is field_4. In~non filljustified~fields, the Print Agent retainsnew line characters but~does not word-wrapthe data.^field FIELD_5This field is field_5. This~field is bottom~right justified. The Print Agentdoes not keep vertical~placement~of thedata but keeps horizontal placement.


148/355


clip

When-r

isclip

, Print Agent: Discards all newline characters in the data with these exceptions:

When the first character in a line is a space, keeps the newline character at the end of theprevious line and the space.

When two or more newline characters immediately follow each other, keeps them all. Word wraps the data within the field boundaries. Truncates the data at the end of the last word that fits in the field, when there is more data



Field_1, Field_2 and Field_3 are fill justifiedfields. Other than the specified exceptions inField_2 and Field_3, Print Agent discards thenewline characters in these fields. Data wordwraps within the field boundaries andtruncates at the end of the last word that fitsin the field.

Field_4 is top left justified and Field_5 isbottom right justified. The data does not wordwrap and extends outside the field. PrintAgent keeps horizontal placement of the databut does not keep vertical placement of the

data.

This field is field_1. Infill justified fields, thePrint Agent discards newline characters except forthe exceptions in field_2 and field_3. Data word-wrapswithin field boundaries. Data

This field is field_2.If the first character in a

line is a space, the Print Agent keeps the new linecharacter at the end of the

This field is field_3.

If two or more new linecharacters immediately follow

This field is field_4. Innon fill justified fields, the Print Agent retains new linedoes not word-wrap the data.

This field is field_5. Thisfield is bottom

right justified. The Print Agent placement

of the data but keeps horizontal placement.


149/355


This example shows how Print Agent handles data when the argument for the -r option is clip :



^field FIELD_1This field is~field_1. The Print Agent~discards new line characters~exceptfor the exceptions infield_2 and~field_3. Data~word-wrapswithin~field boundaries. Data truncates atthe end of the last word that~fits in thefield, when there~is more data thanthe~field can hold.^field FIELD_2This field is~field_2.~ If the firstcharacter~in a line is a space, the~Print Agent keeps the new line~character at theend of the~previous line and the space.^field FIELD_3This field is~field_3.~~If two or morenew~line characters immediately~follow eachother, the Print Agent~keeps them all.


150/355


trunc

When-r

istrunc

, Print Agent: Retains all newline characters in the data. Word wraps the data within the field boundaries. Keeps vertical (top, middle, and bottom) and horizontal (left, right and center) placement of

data. Truncates data at the end of the last character that fits in the field, when there is more data



Print Agent discards all newline characters,other than the exceptions noted in Field_2and Field_3 and word wraps data within thefield boundaries.

When there is more data for the field than thefield can hold, the data truncates at the end ofthe last word that fits in the field.

This field is field_1. The Print Agentdiscards new line characters except forthe exceptions in field_2 and field_3.Data word-wraps within field boundaries.

Data truncates at the end of the lastword that fits in the field, when there

This field is field_2.If the first character in a line is a

space, the Print Agent keeps the newline character at the end of the previous line and the space.

This field is field_3.

If two or more new line charactersimmediately follow each other, the Print

Agent keeps them all.


151/355


This example shows how Print Agent handles data when the argument for the -r option istrunc :



^field FIELD_1This field is~field_1. With trunc,~thePrint Agent retains~all new line charactersand~word-wraps data within the~field boundaries.^field FIELD_2This field is field_2. The Print~Agenttruncates data at the end~of the lastcharacter that fits in the field, whenthere is more data than the field can hold.^field FIELD_3This field is field_3. This field~is middlecenter justified. The~Print Agent keepsvertical~and horizontal placement~of data.


152/355


-s (Starting Page Number)

Format-s nn

To override the starting page number for $PAGE fields, start Print Agent with the -s option. nn is the starting page number. The default is 1.

For example, to set the starting page number to 17 for a template named estimate.mdf andmerge it with a transaction file named costs.dat , use this command:

jfmerge estimate.mdf costs.dat -aiijfmerge.ini -s17

$PAGE is an Output Designer special field name that is filled automatically at print time.

-v (Message Display)

Format-v[ nn ]


Print Agent retains all newline characters andword-wraps the data within the fieldboundaries.

When there is more data for the field than thefield can hold, the data truncates at the end ofthe last character that fits in the field.

Field_1 is top left justified, Field_2 is middleleft justified and Field_3 is middle center

justified. Print Agent keeps all vertical andhorizontal placement of data.

This field isfield_1. With trunc,the Print Agent retainsall new line characters and

word-wraps data within thefield boundaries.

This field is field_2. The Print Agent truncates data at the end of the last character that fits in the f

This field is field_3. This field is middle center justified. ThePrint Agent keeps vertical

and horizontal placementof data.


153/355


As Print Agent processes a transaction file, it writes status and information messages to the logfile. It can also include trace messages in the log file, produced as a result of a ^trace (seepage 227 ) or \trace (see page 280 ) command in the data stream. To set the level of messageswritten to the log file, start Print Agent with one of the -v options.

Note: Trace messages, produced as a result of a ^trace or \trace command, can also bedirected to a file other than the log file. For details, see -atf (Trace File Name) onpage 119 .

-z (Direct Output)

Format

-z xxx - or -

-z dirpath ,u[. ext ]

- or -

-z queue /q

- or -

-z port

- or -

-z queuename- or -

-z\\ servername \ queuename

- or -

-z" queuename /File= filename "

or -

-z"http:// ip_address /ipp/q"

Option Description

-v0 Writes all messages, including trace, informational, warning, error and severemessages. This is the default.

-v10 Suppresses trace and informational messages.

-v20 Suppresses trace, informational, and warning messages.

-v30 Suppresses trace, informational, warning, and error messages.

-v40 Suppresses all messages.


154/355


or -

-z$windows

To specify the output location, start Print Agent with the -z option.

Not all -z arguments are available for use with all supported platforms or with all presentmenttargets. This table outlines the valid platforms and presentment targets for each.

The default for the -z option is taken from the template (specified at compile time if the templateis created with Output Designer).

-zxxxxxx specifies an output location, which can be a device or a disk file name.

For example, to merge a template named shop.mdf with a transaction file named needed.dat and send the output to a file named output.prn in the current directory, start Print Agent withthis command:

jfmerge shop.mdf needed.dat -aiijfmerge.ini -zoutput.prn

The output file name can contain spaces. If it does, it must be enclosed in (quotation marks).For example

jfmerge shop.mdf needed.dat -aiijfmerge.ini -z"My output.prn"

-zdirpath ,u[.ext ]Use this argument with the -z option to direct output to a directory. This is used, in particular,with fax packages that use a collector directory. The ,u argument allows for the creation of aunique file name, to avoid overwriting a file which may be in the directory.

-z Option Platforms Presentment Target

-zxxx All supported platforms Print Agent

-zdirpath ,u[.ext ] All supported platforms Print Agent

-zqueue /q Windows 2000 and up Print Agent

-zport Windows 2000 and up Print Agent

-zqueuename Windows 2000 and up Windows-z\\servername\queuename(with UNC queue name)

Windows 2000 and up Windows

-z\\servername\queuename (withUNC share name of the queue)

Windows 2000 and up Print Agent and Windows

-z"queuename /File=filename " Windows 2000 and up Windows

-z"http://ip_address /ipp/q" Windows 2000 and up Print Agent

-z$windows Windows 2000 and up Windows


155/355


Note: For some fax packages, the use of the ,u argument is mandatory.

dirpath specifies the name of a directory in which to create a file, and ,u is a keywordindicating that a unique file name is to be generated. The . ext is an optional argument tospecify an extension, when you require a specific extension. The default extension is .tmp,except for certain fax packages such as TOPCALL, where it is .fx.

For example, providing this option for -z :

-zd:\fax\collector,u.dat

generates a file of the template:

d:\fax\collector\jfmA1EOF.dat

-zqueue /qqueue is the name of a queue and /q is a keyword indicating that you want to direct theoutput to the queue. Use the /q argument when you want to use the operating system spoolerfacility to print a job in a queue, rather than treating the queue as a file.

For example, on a Windows platform:

-z\\server1\lj5si/q

or ...

-z"http://172.16.5.83/ipp/q"

This option only works with templates compiled for Print Agent presentment targets.

-zport port causes the output to print to the first printer attached to the named port.

For example,

-zlpt1:

prints to a local printer port using the first printer in the [devices] section that uses lpt1:. The :(colon) is required; in the Job Management Database, ensure that the default printer includes acolon after the lpt1.

-zqueuenamequeuename causes the output to print to the first port attached to the named printer name.

For example,

-z"LaserJet 4L"

prints to the first port attached to the LaserJet 4L printer.


156/355


-z\\servername \queuename\\servername\queuename prints to the device, specified using Universal NamingConvention (UNC). queuename can be either the UNC queue name or the UNC share nameof the queue.

For example,

-z"\\central1\LaserJet 5si MX"

prints to the UNC queue name,

and,

-z\\central1\lj5si

prints to the UNC share name of the queue.

-zqueuename /File= filename This format of the -z option tells Print Agent to save the output to a file rather than printing it.

queuename specifies the name of a queue. Print Agent will use the driver associated with thequeue to generate the output.

filename identifies the file where Print Agent will write the output.

When either queuename or filename contain spaces, enclose the arguments in (quotation marks).

For example:-z"HP LaserJet 4Si/File=MoreOutput.prn"

generates output in the file moreoutput.prn using the driver associated with the queue,HP LaserJet 4Si.

-z"http:// ip_address /ipp/q""http:// ip_address /ipp/q" prints directly to the device specified by the Internet Protocol(IP) address ip_address .

The string must start with the literal http:// .

ip_address can be the numeric IP address, BUT it may be a better practice to use a nameinstead of an ip address directly. Contact your network administrator for this information.

/ipp varies by printer manufacturer. Consult the printer documentation or the embedded Webserver on the printer for this information.

/q is required by Print Agent.


157/355


For example:

-z"http://123.231.32.2/ipp/q"-z"http://myprinter/ipp/q"

Caution: You may encounter difficulties when printing to an IP address, depending on thespeed of your communication link. Print Agent prints directly to the IP address; the

job is not placed in a queue. Therefore, Print Agent will not process a subsequent job until the print job has been transmitted to the remote IP address.

-z$windowsUse this argument with the -z option to direct output to your default printer.

OutputFileName Parameter Whenever Print Agent output is directed to a file or device, it automatically places the name ofthe file or device into a Central substitution variable called @OutputFileName. This isparticularly useful in subsequent job steps, after Print Agent is invoked with the ,u argument.

For an example of this processing, see the job PREVIEW that ships with the Job ManagementDatabase. This job consists of two steps, the first to invoke Print Agent to direct the output to atemporary file, and the second to invoke Preview Agent to route the file to a users workstationfor previewing.

@parmfile (Parameter File)

Format@ parmfile

To direct Print Agent to read its command line options from a file, start Print Agent with the@parmfile option. parmfile is a text file containing the options for starting Print Agent. Whenyou do not specify a path for the parameter file, Print Agent searches the current path.

Create the parameter file with any text editor that produces a plain text file. Separate theoptions with spaces, or place the options on separate lines. When one of the options includes (quotation marks), the entire option must be on one line.

You can place any command line options in the parameter file, including the names of thetemplate and transaction files.


158/355


For example, when a parameter file named input.txt contains these entries:

bank.mdf branch.dat -aiijfmerge.ini -c3 -s25-agv"BRANCH=Ash Place"

and you type this command:

jfmerge @input.txtthe result is the same as if you typed:

jfmerge bank.mdf branch.dat -aiijfmerge.ini -c3 -s25 -agv"BRANCH=AshPlace"

Use the @parmfile option when your command line length exceeds the maximum commandline length set by the operating system. For example, in Microsoft Windows, the maximumcommand line length is 120 characters.

XML OPTIONSThere are a number of options that determine the way in which Print Agent processes XMLdata. These XML options use the same format as the Processing options ( see page 65 ).

For a description of how XML data is translated, refer to the guide, Integrating XML withCentral .

You can choose any of the following XML options:

-axattributes (Map Attributes)

Format-axattributes=ignore|preserve

To specify the processing of attributes for data group elements, start Print Agent with the-axattributes option.

With -axattributes=ignore , Print Agent ignores all attributes for data group elements. This isthe default.

With -axattributes=preserve , Print Agent maps all attributes for data group elements to datavalues, resulting in ^field commands. It ignores all attributes for data values.

For example, in this XML data fragment, the element represents a data group that hasthe attribute status with a value of stocked:

15536455Introduction to XML
http://integratingxml.pdf/http://integratingxml.pdf/http://integratingxml.pdf/http://integratingxml.pdf/


159/355


Using the -axattributes=ignore option results in:

^group G_book^field ISBN15536455^field titleIntroduction to XML

Print Agent omits the attribute status and the value stocked from the translation.

Using the -axattributes=preserve option results in:

^group G_book^field statusstocked^field ISBN15536455^field titleIntroduction to XML

Print Agent translates the attribute status into a ^field command with a value of stocked.

You can change the default for this option by editing the At tr ibutes=ignore setting in the[XMLOptions] section of the Print Agent configuration file, jfmerge.in i .

-axaxsl (Apply XSLT Stylesheet)

Format-axaxsl= stylesheet_uri

To specify a stylesheet to use when processing data, start Print Agent with the -axaxsl option.

stylesheet_uri is the URI of the XSLT stylesheet.

By default, Print Agent does not apply an XSLT stylesheet. When you specify an XSLTstylesheet, Print Agent calls an XSLT processor to translate the source XML data file intoanother XML data file. Print Agent then processes the resulting XML data file.

For example, with -axaxsl=http://www.adobe.com/data/mystylesheet.xsl , Print Agentapplies the stylesheet mystylesheet.xsl .

-axcodepage (Specify Code Page)

Format-axcodepage= codepage_name


160/355


Print Agent supports XML data files encoded in:

During processing, the XML data file is converted into a field-nominated data file. To specify thecode page to use when processing the field-nominated data file, start Print Agent with the-axcodepage option.

codepage_name is the name of one of the supported code pages. The default code page isUTF-8.

The supported code pages are:

For example, when you do not specify a code page name, Print Agent processes this XML datafragment ...

15536455Introduction to XML125.00

... as:^symbolset UTF8^group G_order^group G_book

UTF-8 Russian (ISO-8859-5)

Roman 8 Greek (ISO-8859-7)

PC-850 Hebrew (ISO-8859-8)Latin 1 (ISO-8859-1) Turkish (ISO-8859-9)

Latin 2 (ISO-8859-2) Russian (DOS)

Baltic (ISO-8859-4)

Code Page Name Output symbolset

UTF-8 UTF8

ISO-8859-1 WINLATIN1

ISO-8859-2 Latin2

Shift-JIS SHIFT-JISKSC-5601 HANGEUL

Big-Five BIGFIVE

GB2312 GB2312


161/355


^field ISBN15536455^field titleIntroduction to XML^field quantity

1field unitprice25.00

With -axcodepage=ISO-8859-1 , Print Agent processes the XML data fragment with the^symbolset value from the -axcodepage option:

^symbolset WINLATIN1^group G_order^group G_book^field ISBN15536455^field titleIntroduction to XML^field quantity1^field unitprice25.00

-axendgroupprefix (End Group Prefix)

Format-axendgroupprefix= prefix

To change the group prefix for a ^group command that represents the end of each data group,start Print Agent with the -axendgroupprefix option.

The default value at installation is set to G_END_ (G underscore END underscore). This valueis controlled by the EndGroupPrefix=G_END_ setting in the [XMLOptions] section of the PrintAgent configuration file, jfmerge.ini .

-axexclude (Exclude Namespaces)

Format-axexclude= uri1 uri2 ... uriN

To identify portions of the XML data to exclude from processing, start Print Agent with the-axexclude option.

uri is a Uniform Resource Identifier (URI) that refers to a namespace. Print Agent ignores allelements belonging to the specified URIs.


162/355


For example, this XML data fragment contains a number of namespaces, each prefaced by thenamespace declaration attribute xmlns=.

2000-11-10

Pat White

2000-11-10

Chris White

Using the -axexclude= urn:microsoft:biztalk urn:microsoft:body-biztalk option results in:

^symbolset UTF8^group G_po^global date2000-11-10^group G_shipTo^field namePat White^field address^undefine global:date^group G_po^global date2000-11-10^group G_shipTo^field nameChris White^field address^undefine global:date

Print Agent ignores the elements , , and that belong to the namespaceurn:microsoft:biztalk, and the element that belongs to the namespaceurn:microsoft:body-biztalk. It also ignores the namespace declaration attributes xmlns andthe XFA-Data attributes that belong to the namespacehttp://www.xfa.org/schema/xfa-data/1.0/. It starts processing the XML data at the firstoccurrence of the element .


163/355


-axflatten (Suppress Data Groups)

Format

-axflatten={yes|no|1|0|on|off}

To specify the handling of multiple level data groups, start Print Agent with the -axflatten option.This is useful when the structure of the data does not match the structure of an existingtemplate.

With -axflatten=no , -axflatten=0 , or -axflatten=off , Print Agent treats all data groups assubforms and prefaces them with a ^group command. This is the default behavior.

With -axflatten=yes , -axflatten=1 , or -axflatten=on , Print Agent treats only top level datagroups as subforms and prefaces them with a ^group command. It ignores all lower level datagroups and translates their data values to ^field commands, contained by the top level ^group command.

For example, in this XML data fragment, the element represents a top level data groupand the element represents a lower level data group:


PatWhite

Using the -axflatten=yes option results in:

^group G_book^field ISBN15536455^field titleIntroduction to XML^field firstnamePat^field lastname

White

Print Agent translates only the top level data group to a ^group command. It ignoresthe lower level data group and translates its data values to ^field commandscontained by the top level data group .


164/355


-axincrementalload (Incremental Loading)

Format

-axincrementalload={yes|no|1|0|on|off}

When Print Agent processes an XML data file, it first loads the data into the XFA-DataDocument Object Model (XFA -Data DOM), then translates it into Central field-nominatedformat. For large XML data files that contain many records, Print Agent provides the capabilityto incrementally load the XML data into memory on a record-by-record basis.

To specify how Print Agent loads XML data when converting it to field-nominated format, startPrint Agent with the -axincrementalload option.

With -axincrementalload=yes , -axincrementalload=1 , or -axincrementalload=on , PrintAgent will load the XML data one record at a time. This is the default behavior.

With -axincrementalload=no , -axincrementalload=0 , or -axincrementalload=off , PrintAgent will load the entire XML data file before converting it to field-nominated format.

-axorder (Output Order)

Format-axorder=document|datavaluesfirst

When using Print Agent and dynamic templates, depending on the template design, it may benecessary to process all the data values for a data group before processing a child data group.To specify the processing order for data values and data groups, start Print Agent with the-axorder option.

With -axorder=document , Print Agent outputs the data values and data groups in the sameorder as in the XML data. This is the default.

With -axorder=datavaluesfirst , for each parent data group, Print Agent outputs the datavalues first, then the child data groups.

For example, this XML data fragment contains the element , which represents a childdata group of the data group :

15536455

PatWhite

Introduction to XML1


165/355


25.00

4344-31020-2Big Calm

119.00

Notice how the data value elements , , and belong to the datagroup element .

Using the -axorder=document option results:

^symbolset UTF8^group G_order

^group G_bookitem^field ISBN15536455^group G_author^field firstnamePat^field lastnameWhite^field titleIntroduction to XML^field quantity1

^field unitprice25.00^group G_musicitem^field cdid4344-31020-2^field titleBig Calm^field quantity1^field unitprice19.00

In the example above, the translation results do not match the template. The fields title,quantity, and unitprice do not belong to the subform author. These fields belong to thesubform bookitem.

To have Print Agent associate the fields title, quantity, and unitprice with the subformbookitem, use the -axorder=datavaluesfirst option:

^symbolset UTF8^group G_order^group G_bookitem ^field ISBN15536455


166/355


^field titleIntroduction to XML^field quantity1^field unitprice

25.00^group G_author ^field firstnamePat^field lastnameWhite^group G_musicitem^field cdid4344-31020-2^field titleBig Calm^field quantity

1field unitprice19.00

The fields title, quantity, and unitprice appear below the subform bookitem. The datastructure now matches the structure of the template.

Using the -axorder=datavaluesfirst option results in:

^group G_order^group G_bookitem^field ISBN

15536455^field titleIntroduction to XML^field quantity1^field unitprice25.00^group G_author^field firstnamePat^field lastnameWhite

^group G_musicitem^field cdid4344-31020-2^field titleBig Calm^field quantity1^field unitprice19.00

The child data group appears after the data values for its parent data group.


167/355


-axrecord (Specify Records)

Format

-axrecord={ record-name | record-number }

To specify the data group elements that represent records, start Print Agent with the -axrecordoption. Print Agent will process the data contained within the designated records.

record-name is the tag name of an element. Print Agent maps each data group element at thesame level in the hierarchy of the specified record-name as a separate record. Data groupswith names that match record-name will translate to top-level ^group commands in the datafile. Print Agent ignores: All higher-level nodes. Same-level data groups with names that do not match record-name .

record-number is an integer that indicates the level in the hierarchy down from the startelement. The start element is located at a node level of 1. Print Agent maps each data groupelement at the record-number level in the hierarchy as a separate record. Data groups thatmatch record-number will translate to top level ^group commands in the data. Print Agentignores all higher-level nodes.

The default record is the outermost node.

This example demonstrates the result of including record-name in the -axrecord option. ThisXML data fragment contains a single record, which is the element . This element

represents the top-level data group within the document range.

1

c00114111998


15536456XML Power230.00


168/355


Using the -axrecord=item option results in:

^group G_item^group G_book^field ISBN15536455^field titleIntroduction to XML^field quantity1^field unitprice25.00^group G_item^group G_book^field ISBN15536456^field titleXML Power^field quantity2^field unitprice30.00

When the XML data makes use of different element types for similar groupings of data, theability to express data records via a record number is useful. This example demonstrates theresult of including record-number in the -axrecord option:


4344-31020-2Big Calm119.00

Using the -axrecord=2 option results in:

^group G_bookitem^field ISBN15536455^field titleIntroduction to XML^field quantity1


169/355


^field unitprice25.00^group G_musicitem^field cdid4344-31020-2

^field titleBig Calm^field quantity1^field unitprice19.00

-axstartgroupprefix (Start Group Prefix)

Format-axstartgroupprefix= prefix

To change the group prefix for a ^group command that appears at the beginning of each datagroup, start Print Agent with the -axstartgroupprefix option.

The default value at installation is set to G_ (G underscore). This value is controlled by theStartGroupPrefix=G_ setting in the [XMLOptions] section of the Print Agent configuration file,

jfmerge.in i .

-axstartnode (Specify Start Node)

Format-axstartnode="xfasom( xfasom-expression )"

To identify the portion of the XML data to process, start Print Agent with the -axstartnodeoption. This lets you constrain the processing to a fragment of the data.

xfasom( xfasom-expression ) is an XFA-Scripting Object Model (XFA-SOM) Expression,specifying the start (top-level) element of the XML data. The expression must be afully-qualified path of element types (tag names), starting with the root of the XML data andreferring to a single element. The expression must be surrounded with (quotation marks).Print Agent will ignore all elements outside this element. The default start element is theoutermost node.

In this XML data fragment, the top level element is , under which there are two elements, each containing a element.

1

c001


170/355


15536455Introduction to XML1

25.00

15536456XML Power230.00

With -axstartnode=xfasom(order.item[2].book) , Print Agent starts processing the data atthe second element:

^group G_book^field ISBN15536456^field titleXML Power^field quantity2^field unitprice

30.00All elements outside the element of the second occurrence of the element areignored.

-axuseendgroup (End Group)

Format-axuseendgroup={yes|no|1|0|on|off}

To specify the insertion of a ^group command at the end of each data group, start Print Agentwith the -axuseendgroup option. The creation of a ^group command at the end of a datagroup enables Print Agent to recognize when a data group ends and identify the next datagroup in the data file.

With -axuseendgroup=yes , -axuseendgroup=1 , or -axuseendgroup=on , Print Agentgenerates a ^group command at the beginning of each data group with the default start groupprefix G_, and a ^group command at the end of each data group, with the default end groupprefix G_END_.


171/355


With -axuseendgroup=no , -axuseendgroup=0 , or -axuseendgroup=off , Print Agentgenerates a ^group command at the beginning of each data group, with the default start groupprefix G_. This is the default behavior.

For example, in this XML data fragment, the elements and represent data

groups:


PatWhite

Using the -axuseendgroup=no option results in:

^group G_book^field ISBN15536455^field titleIntroduction to XML^group G_author^field firstnamePat^field lastname

White

Using the -axuseendgroup=yes option results in:

^group G_book^field ISBN15536455^field titleIntroduction to XML^group G_author^field firstnamePat^field lastnameWhite^group G_END_author

^group G_END_book

-axuseformcommand (Use form Command)

Format-axuseformcommand={yes|no|1|0|on|off}

To specify the name of the template that Central uses to process the data, start Print Agent withthe -axuseformcommand option.


172/355


With -axuseformcommand=no , -axuseformcommand=0 , or -axuseformcommand=off ,Print Agent prefaces all top level data groups with a ^group command. This is the defaultbehavior.

With -axuseformcommand=yes , -axuseformcommand=1 , or -axuseformcommand=on ,

Print Agent prefaces all top level data groups with a ^form command.

For example, in this XML data fragment, the element represents a top level data group:


4344-31020-2Big Calm119.00

Using the -axuseformcommand=yes option results in:

^form order^group G_bookitem^field ISBN15536455^field titleIntroduction to XML^field quantity1^field unitprice25.00^group G_musicitem^field cdid4344-31020-2^field titleBig Calm

^field quantity1^field unitprice19.00

Print Agent translates the top level data group to a ^form command.


173/355

6 Command ReferenceThis chapter describes the four groups of commands available for Print Agent: Dynamic Merge commands Inline Text Control commands Intelligent Pagination commands Variable Substitution commands

Within each command group, the commands appear in alphabetical order. Print Agent iscase-insensitive, unless otherwise stated in the command description.

The command format is:

command options arguments

where command is the name of the Print Agent command, options are mandatory ornon-mandatory conditions that refine the command, and arguments are values that youprovide for the option.

Options without brackets or in brace brackets are mandatory. If the options in brace bracketsare separated by vertical lines, such as

{item1|item2|item3}

you may use only one of the options within the brace brackets at any one time.

Options in square brackets are optional. If the options in square brackets are separated byvertical lines, such as

[item1|item2|item3]

you may use only one of the options within the square brackets at any one time.

DYNAMIC MERGE COMMANDSDynamic Formatting commands are the base upon which Print Agent processes a transactionfile. These commands control field and template sequencing, data formats, transaction files andthe appearance of the templates. Using Dynamic Formatting commands, Print Agent can printmultipage templates, multipart templates, or can build a template dynamically using subforms.

A (caret) prefixes Dynamic Merge commands. A space must separate the command from itsoptions.


174/355

Adobe Central Output Server Print Agent Reference for Microsoft Windows Command Reference 174

^unrecognized-command (Unrecognized Command)

Format^ unrecognized-command text

When Print Agent encounters a line beginning with a Dynamic Merge command prefixcharacter but does not recognize the command, it issues a message to the log file butcontinues processing. It closes the currently active field, if any. Then it discards all text on theremainder of the line and on subsequent lines until it encounters another line beginning with theDynamic Merge command prefix character.

Note: This information is provided solely to help you debug your data stream. Do not rely onPrint Agent to not recognize a particular command. Print Agent currently recognizessome commands that are not documented, and Adobe reserves the right to add anyother commands, documented or undocumented, in future.

^comment (Insert Comment in Data Stream)

Format^comment text

To include a non-printing comment in the data stream, use the ^comment command. PrintAgent does not print a line beginning with ^comment . text can be any number of lines long,provided each line starts with the ^comment command.

For example:

field VENDOR_CODE1001^field VENDOR_NAME

A1 Business Products^comment IMPORTANT^comment When issuing purchase orders,^comment please ensure that you are using^comment the latest version of the vendor^comment address file.^field VENDADDR1234 Second St.^field VENDADDR2

Anytown, ST^field VENDADDR3USA 12345-6789

results in:

1001 A1 Business Products

234 Second St. Anytown, ST

USA 12345-6789


175/355


^continue (Continue Record Structure)

Format

^continue fieldname length [ position ]...

To use multiple lines for the definition of a fixed format record, use the ^continue command. A^record command must precede the first ^continue command for the record structure.

For example, defining this record layout for a purchase order:

^record PO_DETAIL^continue ITEM04 01^continue QTY04 05^continue DESC14 09

is the same as this ^record command:

^record PO_DETAIL ITEM 04 01 QTY 04 05 DESC 14 09

If your record must span more than one page in the template, indicate this with a ^continue and a ^page command.

For example:

^record PO_DETAIL^continue page 1^continue ITEM04 01^continue QTY04 05^continue DESC14 09^continue page 2^continue SUB_TOTAL14 01^continue DISCOUNT14 15^continue TOTAL14 29

The fields ITEM, QTY and DESC appear on page 1 of the template and the fields SUB_TOTAL,DISCOUNT and TOTAL appear on page 2 of the template. Define the records in order by page.For example, you cannot define some fields from page 1, then some fields from page 2, thenmore fields from page 1.

There may be portions of the data you want Print Agent to ignore. This happens when you use

the same data stream to print different templates. Print Agent ignores the data for the fieldname FILLER.

For example, to ignore the data in the fifth and sixth characters in the record, use this definition:

^record PO_DETAIL^continue ITEM04 01^continue FILLER02 05^continue QUANTITY 04 07^continue DESCRIPTION14 11^continue UNITS04 25^continue UNIT_PRICE 07 29^continue TOTAL14 36


176/355


^copies (Number of Copies)

Format

^copies nn

To specify the number of copies of the template that Print Agent outputs, insert a ^copiescommand in the data stream. nn is the number of copies of the completed template to print,and must be an integer. The maximum number of copies is 99,999,999, subject to thelimitations of your printer. Refer to your printer documentation for limitations on the maximumnumber of copies you can print.

^copies ConsiderationsWhen you use the ^copies command, keep these considerations in mind:

This command is supported only for printed copies. This command is supported only for Print Agent presentment targets and only for print

engines that support multiple copy printing. The ^copies command must appear in the data stream before the template is opened. It

then applies to that template and any subsequent templates in the same data stream. If PrintAgent opens a template before it encounters the ^copies command, the number of copiesspecified in the ^copies command will not apply to the template.

Conditions other than the execution of a ^form command can cause Print Agent to open thetemplate. For a list of these conditions, see either ^form (Open Template) on page 191 , or\form (Open Template) on page 260 .

The printed output is not collated. For example, if the template has two pages and PrintAgent prints five copies, you receive five copies of page 1 and then five copies of page 2. Ifyou do not specify a number of copies, Print Agent prints the number of copies compiled inthe template in Output Designer.

^currency (Currency Formatting)

Format

^currency [symbol= symbol ] [comma= comma ] [decimal= decimal ][parenthesis= parenthesis ] [location=left|right] [credit= credit ][debit= debit ] [incomma= incomma |DEFAULT] [indecimal= indecimal |DEFAULT]

To define currency specifiers, use the ^currency command. This command applies only tofields with a numeric picture format, either complied into the template in Output Designer oradded using the \pic command ( see page 242 ).


177/355


symbol is the currency symbol. The default is a $ (dollar sign). To change the currencysymbol to another character, for example, (pound sterling), use this command:

^currency symbol=

comma is the thousands separator. The default is a , (comma). To change the thousandsseparator to another character, for example, . (period), use this command:

^currency comma=.

decimal is the decimal separator. The default is a . (period). To change the decimalseparator to another character, for example, , (comma), use this command:

^currency decimal=&

parenthesis is the pair of characters used as currency parentheses, indicating negativevalues. The default is ( ) (left and right parentheses). To change the currency parentheses toanother pair of characters, for example, { } (left and right brace brackets), use this command:

^currency parenthesis={}

left|right is the location of the currency symbol. The default is left. To change the locationof the currency symbol to the right of the currency string, use this command:

^currency location=right

credit is the credit symbol, indicating a credit balance. The maximum size is four characters.The default is CR. To change the credit symbol to other characters, for example, PLUS, usethis command:

^currency credit=PLUS

debit is the debit symbol, indicating a debit balance. The maximum size is four characters.The default is DB. To change the debit symbol to other characters, for example, LESS, usethis command:

^currency debit=LESS

incomma |DEFAULT is the thousands separator for incoming data. The DEFAULT option setsthe incoming thousands separator to revert to using the comma value. At least one option mustbe supplied. To change the thousands separator for incoming data to another characte

acos print agent reference

Documents