GenDatasheet client API - SmartPlant Foundation - IM Update 46 - Help

GenDatasheet 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

The GenDatasheet client API is used to generate a datasheet for a selected object.

Argument	Description
Parameter 1	DatasheetMode (Online/Offline)
Parameter 1 default	None
Parameter 1 description	Indicates whether the datasheet generated should be in online or offline mode.
Parameter 1 type	String
Parameter 2	DatasheetType (IPD, PID, etc.)
Parameter 2 default	None
Parameter 2 description	Indicates the type of datasheet that will be created, such as IPD, Instrument List, Document List, and so forth.
Parameter 2 type	String
Parameter 3	DatasheetDefUID (optional)
Parameter 3 default	None
Parameter 3 description	The UID of the datasheet definition that will be used to create the datasheet.
Parameter 3 type	String
Parameter 4	Multi object datasheet
Parameter 4 default	None
Parameter 4 description	If set to True, denotes that the datasheet or datalist does not start from a single object, so do not include the shortcut menu object in the query. This parameter is optional.
Parameter 4 type	String
Parameter 5	Read Only (True/False)
Parameter 5 default	None
Parameter 5 description	If set to True, the results of the datasheet will be provided in a read-only format. If set to False, the contents of the generated datasheet will be editable.
Parameter 5 type	String

The following methods use the GenDatasheet client API to generate various types of datasheets.