BatchPrint client API - SmartPlant Foundation - IM Update 46 - Help - Hexagon

SmartPlant Foundation Help

Language
English
Product
SmartPlant Foundation
Search by Category
Help
SmartPlant Foundation / SDx Version
10
SmartPlant Markup Plus Version
10.0 (2019)
Smart Review Version
2020 (15.0)

The BatchPrint client API is used to configure the batch printing of selected files by the Scheduler.

Argument

Description

Parameter 1

Is local

Parameter 1 default

False

Parameter 1 description

If set to True, prints file(s) locally with printers configured on the client machine.

Parameter 1 type

Boolean

Parameter 2

Print watermark

Parameter 2 default

True

Parameter 2 description

Prints watermarks when set to True.

Parameter 2 type

Boolean

Parameter 3

Watermark

Parameter 3 default

None

Parameter 3 description

Watermark object name to be used for all the files.

Parameter 3 type

String

Parameter 4

Is watermark editable?

Parameter 4 default

False

Parameter 4 description

Allows users to edit the watermark text and other properties in the Print dialog box.

Parameter 4 type

Boolean

Parameter 5

Print label

Parameter 5 default

True

Parameter 5 description

Prints labels when set to True.

Parameter 5 type

Boolean

Parameter 6

Label

Parameter 6 default

None

Parameter 6 description

Label object name to be used for all the files.

Parameter 6 type

String

Parameter 7

Is label editable

Parameter 7 default

False

Parameter 7 description

Allows users to edit the label text and other properties in the Print dialog box.

Parameter 7 type

Boolean

Parameter 8

Print reference files

Parameter 8 default

False

Parameter 8 description

Prints associated reference files if set to True.

Parameter 8 type

Boolean

Parameter 9

Print markups

Parameter 9 default

False

Parameter 9 description

Prints associated markups if set to True.

Parameter 9 type

Boolean

Parameter 10

Print alternate renditions

Parameter 10 default

False

Parameter 10 description

Prints the alternate rendition attached to the file if set to True.

Parameter 10 type

Boolean

Parameter 11

Preferred alternate rendition file types

Parameter 11 default

FT.pdf

Parameter 11 description

Lists the alternate rendition file types for printing. Multiple types can be listed here, for example, FT_pdf/FT_bmp. If a file has multiple alternate renditions, the order in which the file types are listed here determines which alternate rendition is printed.

For example, if configured as FT_pdf/FT_bmp, the rendition of type .pdf is printed; if .pdf doesn't exist, the .bmp is printed.

Parameter 11 type

String

The following methods use the BatchPrint client API to batch print files.

  • FileBatchPrint

  • FileLocalPrint

  • LocalPrintOnFiles

  • BatchPrintOnFileswithEditWatermarkLabel

  • BatchPrintWithEditWatermarkLabel

  • BatchPrintWithNoWatermarkLabel