GenerateThumbnail client API and its delivered methods - SmartPlant Foundation - Help

SmartPlant Foundation Help

PPMProductFamily
Asset Information Management
PPMProduct
SmartPlant Foundation
PPMCategory
Help
SPFVersion_custom
2019 (10.0)
Version_Integration
(none)
Version_SPM_custom
2019 (10.0)
Version_SPPID
8.0.0
Version_SDAConnectorforTruView
(none)
Version_Fusion
(none)
Version_MTR
(none)
Version_SPO
(none)
Version_SPR
13.x(2018)
Version_TruView
(none)
Version_SDV
(none)

The GenerateThumbnail client API is used to configure the creation of thumbnail images of files stored in SmartPlant Foundation.

Argument

Description

Parameter 1

Thumbnail File Type

Parameter 1 default

FT_png

Parameter 1 description

The file type in which the new thumbnail will be saved.

Parameter 1 type

String

Parameter 2

Thumbnail width

Parameter 2 default

250

Parameter 2 description

The width of the thumbnail image that will be created.

Parameter 2 type

Integer

Parameter 3

Thumbnail height

Parameter 3 default

250

Parameter 3 description

The height of the thumbnail image that will be created.

Parameter 3 type

Integer

Parameter 4

Custom Text

Parameter 4 default

None

Parameter 4 description

Text that will be stamped on the thumbnail image as a label. This parameter is optional.

Parameter 4 type

String

Parameter 5

Path of default Thumbnail

Parameter 5 default

None

Parameter 5 description

If the file for which a thumbnail is being generated is not supported for this operation, the file indicated here (along with its network path) will be used as the thumbnail image.

Parameter 5 type

String

Parameter 6

Regenerate Thumbnail

Parameter 6 default

False

Parameter 6 description

Indicates whether a new thumbnail should be generated when a thumbnail for the file already exists.

Parameter 6 type

Boolean

The following methods use the GenerateThumbnail client API to create thumbnail images.

  • FileGenerateThumbnail

  • FileCompositionGenerateThumbnail