CreateWizardClassObj client API - HxGN SDx - Update 64

CreateWizardClassObj client API - HxGN SDx - Update 64 - Administration & Configuration

Administration and Configuration of HxGN SDx

Language

English

Product

HxGN SDx

Search by Category

Administration & Configuration

SmartPlant Foundation / SDx Version

This functionality was modified in an update. For more information, see CreateWizardClassObj client API (modified in an updated).

The CreateWizardClassObj client API is used to create classified objects from a node of a classification tree.

Argument	Description
Parameter 1	RelDef to navigate to the ClassDef
Parameter 1 default	None
Parameter 1 description	The relationship definition used to navigate class definition and to derive the class definition of the classified object being created.
Parameter 1 type	String
Parameter 2	Allow classification tree drilldown
Parameter 2 default	True
Parameter 2 description	Indicate whether to allow the display of a classification tree drill down when creating the new object.
Parameter 2 type	Boolean
Parameter 3	UID of classification
Parameter 3 default	None
Parameter 3 description	The unique identification number (UID) of the top classification on the selection page that can be expanded to select the classification required.
Parameter 3 type	String
Parameter 4	Classification tree filtering
Parameter 4 default	None
Parameter 4 description	A ~ separated list of interfaces to perform classification tree filtering (optional) This can be used to restrict the availability of the classification nodes for selection based on the optional interfaces present.
Parameter 4 type	String
Parameter 5	Title
Parameter 5 default	None
Parameter 5 description	The title that will appear on the form for creating the new classified object.
Parameter 5 type	String
Parameter 6	File attachment configuration
Parameter 6 default	SPFDesignFile~SPFFileComposition~PROMPT
Parameter 6 description	File attachment configuration (optional) FileClassDef~FileRelDef~ReferenceAction~SeedFileTemplateDocName. SPFFileComposition is the default relationship definition if none other is specified. The seed file document is optional. Reference file not found actions are CONTINUE\|PROMPT\|ABORT.
Parameter 6 type	String
Parameter 7	Details of secondary class (Not Supported in the Web Client)
Parameter 7 default	None
Parameter 7 description	Details of the secondary class to create and its relationship to the parent class definition specified in Argument 1. Use ~ as a separator.
Parameter 7 type	String
Parameter 8	Workflow processing option
Parameter 8 default	None
Parameter 8 description	For Desktop Client - The option selected determines whether or not creation or revision wizards should include a workflow page to attach an object. For example, None, which is the default option, indicates that no workflow page appears and no object is attached to a workflow. Other options include Select, SelectRequired, or a named workflow. For Web Client - There is no workflow selection in the create pages. The Web Client chooses the applicable workflow unless a named workflow is specified. However, if more than one applicable workflow is found, the software does not attach the object to any workflow.
Parameter 8 type	String
Parameter 9	Template Document Seed File Configuration
Parameter 9 default	None
Parameter 9 description	Parameter to add the UID classification to the create document method and rename files with the document parent suffix. TemplateclassificationUID~IsSingleSelection~IsRenameChkBoxEnabled
Parameter 9 type	String
Parameter 10	Post method name (Not Supported in the Web Client)
Parameter 10 default	None
Parameter 10 description	The method that will be run on the new object. For complex objects, add ~InterfaceDefUI to identify the object on which the method will be run.
Parameter 10 type	String
Parameter 11	Delete local files configuration (Not Supported in the Web Client)
Parameter 11 default	True~True
Parameter 11 description	Desktop Client includes two options, separated by a ~, to control whether local files are deleted when attached and whether to expose the option for deleting local files on the form used for creation. Web Client ignores this as it uses a different file loading process.
Parameter 11 type	String
Parameter 12	Additional property to set (Not supported in the Desktop Client).
Parameter 12 default	None
Parameter 12 description	Four ~ separated arguments (UID~Text~Method~Boolean) which set the property identified by the UID to True, and invoke the specified method, when the button with the specified text is clicked. The default value of the fourth argument is False. For example, if the user specifies SDACreatedAsDraft~Save As Draft~MTH_SOPSPrepareChangeRequest, a Save As Draft button appears on the form and when clicked, the value of the property with the UID SDACreatedAsDraft is set to True, and the SOPSPrepareChangeRequest method is invoked.
Parameter 12 type	String
Parameter 13	RelDef or EdgeDef for search objects
Parameter 13 default	None
Parameter 13 description	Relationship definition or edge definition used for searching objects on the form relationship section.
Parameter 13 type	String
Parameter 14	Columnset for filter criteria search
Parameter 14 default	None
Parameter 14 description	The column set used to display the filter criteria on the form relationship section.
Parameter 14 type	String
Parameter 15	RelDef to create a relation from grid column
Parameter 15 default	None
Parameter 15 description	Relationship definition used to create a relationship between a specific object and the grid column.
Parameter 15 type	String
Parameter 16	RelDefs to find target display items
Parameter 16 default	None
Parameter 16 description	Relationship definitions (separated by ~, prefixed with +) used to find the target display items.
Parameter 16 type	String
Parameter 17	Link properties
Parameter 17 default	None
Parameter 17 description	Link properties, each separated by a comma (,). For example, PropertyDef1~Title1,PropertyDef2~Title2. The property definition is used to set the link property in the relationship between a document and a specific object (for example, a transmittal). The title, separated by a tilde (~), is used to display the column name in the grid. The Transmittal default file type value in System Options and the Title value must be the same.
Parameter 17 type	String
Parameter 18	Is file attachment mandatory
Parameter 18 default	False
Parameter 18 description	At least one file attachment is mandatory if this flag is set to true
Parameter 18 type	Boolean

The following methods use this client API:

SCLBCreateInternalReviewAction to create an Internal Review action.
SDACreateOutgoingTransmittal to create an outgoing transmittal.
SDACreateInspectionWorkPackage to create an inspection work package.
SDACreateMaintenancePlanningWorkPackage to create a maintenance planning work package.

The following is applicable to the transmittal methods, if you are using a custom column set to show the documents related by an edge or a relationship definition specified in argument 13:

Set the SPFCellReadOnlyInd property to True, for all the column set-column item relations.
Argument 9 allows you to rename any file attached to a new document from a Template Document with the new document parent suffix. The default is True. On the creation of a document using ENS. the option is not available to be deselected.