GenerateAlternateRendition 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 GenerateAlternateRendition client API is used to configure the conversion of a file to a PDF file or to any other alternate rendition, as well as the generation of a WebGL viewer file for viewing 2D drawings (.igr, .pid, .sma, .spe, .sha, and .zyq), and Smart 3D models (.zvf and .vue) in the Hexagon web-based portal applications.

Argument

Description

Parameter 1

GraphDef for structure

Parameter 1 default

None

Parameter 1 description

Graph definition for the structure resulting in files for which alternate renditions have to be generated.

Parameter 1 type

String

Parameter 2

Synchronous

Parameter 2 default

True

Parameter 2 description

When set to true, this task run synchronously. When set to False, the task runs asynchronously in the background while the user performs other tasks.

Parameter 2 type

Boolean

Parameter 3

Alternate rendition file type

Parameter 3 default

FT_PDF

Parameter 3 description

This is the final rendition type. For example, if generating a PDF file from a DGN file, there may be several intermediate steps in the processing. Alternate Rendition File Type indicates the final type, which is PDF. Typically, the conversion process is DGN -> PS -> PDF

Parameter 3 type

String

Parameter 4

Include reference files

Parameter 4 default

True

Parameter 4 description

True indicates that reference files should be included in the rendition. False indicates that referenced files should not be included.

Parameter 4 type

Boolean

Parameter 5

Include markups

Parameter 5 default

True

Parameter 5 description

True indicates that markup layers associated with the file will be included in the rendition. False indicates that markup layers will not be included.

Parameter 5 type

Boolean

Parameter 6

Include watermarks

Parameter 6 default

False

Parameter 6 description

True indicates that watermarks associated with the document will be included in the rendition. False indicates that watermarks will not be included.

Parameter 6 type

Boolean

Parameter 7

Include labels

Parameter 7 default

False

Parameter 7 description

True indicates that labels associated with the document will be included in the rendition. False indicates that labels will not be included.

Parameter 7 type

Boolean

Parameter 8

Watermark name

Parameter 8 default

None

Parameter 8 description

Name of watermark object to be displayed

Parameter 8 type

String

Parameter 9

Label name

Parameter 9 default

None

Parameter 9 description

Name of label object to be displayed

Parameter 9 type

String

Parameter 10

Regenerate alternate rendition

Parameter 10 default

False

Parameter 10 description

This parameter is used to regenerate the alternate rendition even though it exists

Parameter 10 type

Boolean

Parameter 11

EdgeDef UID to filter markups

Parameter 11 default

None

Parameter 11 description

UID of the edge definition to use when filtering markups

Parameter 11 type

String

Parameter 12

File search string

Parameter 12 default

None

Parameter 12 description

Search string to be used to filter files

Parameter 12 type

String

Parameter 13

Replace with PDF files

Parameter 13 default

False

Parameter 13 description

This flag will indicate whether to replace the input file with the generated PDF file (True) or to relate the generated PDF file as alternate file to the input file (False).

Parameter 13 type

Boolean

Parameter 14

Include action pin details

Parameter 14 default

False

Parameter 14 description

If set to True, action pin details are included when generating PDF files asynchronously. To do this, set Parameter 3 to FT_PDF and Parameter 5 to True.

Parameter 14 type

Boolean

Parameter 15

Rendition Class Definition

Parameter 15 default

None

Parameter 15 description

Class Definition to be used for the rendition object

Parameter 15 type

String

The following methods use the GenerateAlternateRendition client API to generate a WebGL viewer file or to convert a file to a PDF or to any other alternate rendition.

  • FileCompositionGenerateAlternateRendition

  • FileCompositionGenerateViewRenditions

  • FileCompositionGenerate2DWebGLViewerFiles

  • FileCompositionGenerateWebGLViewerFiles

  • FileGenerateAlternateRendition

  • FileGenerateViewRendition

  • FileGenerate2DWebGLViewerFile

  • FileGenerateWebGLViewerFile

  • GenerateReportPDFAndReplace

  • NonSectionedXmtlGenerateAlternateRendition

  • SectionedXmtlGenerateAlternateRendition

  • XmtlSectionGenerateAlternateRendition