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

SmartPlant Foundation Web Client Help

Language
English
Product
SmartPlant Foundation
Search by Category
Help
SmartPlant Foundation / SDx Version
10

The CreateRenditionsInBatch client API is used to configure the creation of batch renditions, such as PDF, 2D WebGL viewer, 3D WebGL viewer, and markup rendition files.

Argument

Description

Parameter 1

Rendition file type

Parameter 1 default

None

Parameter 1 description

Specifies the rendition file type the batch conversion is for.

Parameter 1 type

String

Parameter 2

ClassDefs

Parameter 2 default

None

Parameter 2 description

A class definition is valid only if it realizes ISPFAlternateRenditionComposition if the target rendition file type is FT_csf, FT_pdf, FT_binz, or FT_vecz or realizes ISPFThumbnailComposition if the target rendition file type is FT_png.

Parameter 2 type

String

Parameter 3

File Types

Parameter 3 default

None

Parameter 3 description

File types are valid only if they have a SPFFileTypeFileType relation with the target rendition file type.

Parameter 3 type

String

Parameter 4

Regenerate alternate renditions in batch

Parameter 4 default

False

Parameter 4 description

When Regenerate alternate renditions in batch is set to True, any existing alternate renditions are regenerated

Parameter 4 type

Boolean

The following methods use the CreateRenditionsInBatch client API to create batch renditions.

  • CreateRenditionsInBatch

  • CreateThumbnailsInBatch