ExcelImporter 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 ExcelImporter client API is used to open the Excel Import feature for loading information from an Microsoft Excel spreadsheet into the database.

Argument

Description

Parameter 1

Template options

Parameter 1 default

True~False~True

Parameter 1 description

Template options are: Expose in the GUI (True/False)~ReadOnly (True/False)~Template(Name/Select)

Parameter 1 type

String

Parameter 2

Import document options

Parameter 2 default

True~False~True

Parameter 2 description

Import document options are: Expose in GUI (True/False)~ReadOnly (True/False)~Default (True/False)

Parameter 2 type

String

Parameter 3

Compare options

Parameter 3 default

True~False~True

Parameter 3 description

Compare options are: Expose in GUI (True/False)~ReadOnly (True/False)~Default (True/False)

Parameter 3 type

String

Parameter 4

Document form control

Parameter 4 default

Create~Update~Major

Parameter 4 description

Document form purposes for new and repeat loads and revision control (if Import document = True). Enter ~ separated values.

Parameter 4 type

String

Parameter 5

Document classification details

Parameter 5 default

ISPFDocumentClass~Equipment List~SPFDesignDoc

Parameter 5 description

Document classification (if Import document= True). Enter PrimaryIDef~ClassificationName~RelDefToClassDef

Parameter 5 type

String

Parameter 6

Expose document attachments option

Parameter 6 default

True

Parameter 6 description

Indicates whether to expose the option to attach documents.

Parameter 6 type

Boolean

Parameter 7

File details

Parameter 7 default

SPFDesign~SPFFileComposition~SPFDesignFile~

Parameter 7 description

File details (If Import document = True). Enter FileClassDef~FileRelDef~AttachmentFileClassDef~AttachmentFileRelDef

Parameter 7 type

String

Parameter 8

Show in New Items window options

Parameter 8 default

True~False~True

Parameter 8 description

Show in New Items window options are: Expose in GUI (True/False)~ReadOnly (True/False)~Default (True/False)

Parameter 8 type

String

Parameter 9

Document to item RelDef

Parameter 9 default

None

Parameter 9 description

The relationship definition to link the loaded items to the document (If Import document = True)

Parameter 9 type

String

Parameter 10

Compare scope visible option

Parameter 10 default

True~False~By object

Parameter 10 description

Compare scope options are: Expose in GUI (True/False)~ReadOnly (True/False)~Default Value (By object/By container ID)

Parameter 10 type

String

Parameter 11

Delete local files configuration

Parameter 11 default

True~True

Parameter 11 description

2 ~ separated options (IsChecked~IsEnabled) to control deleting local files and to expose the option on the form

Parameter 11 type

String

The following methods use the ExcelImporter client API:

  • ExcelImport

  • SPFNFileIndex_Load