CreateObjectFromSelectedObjects client API - HxGN SDx - Update 64

CreateObjectFromSelectedObjects 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 CreateObjectFromSelectedObjects client API (modified in an update).

The CreateObjectFromSelectedObjects client API is used to create a new signature object and relate it to multiple selected objects.

Argument	Description
Parameter 1	ClassDef (or Relationship to ClassDef) to create
Parameter 1 default	None
Parameter 1 description	The class definition of the new object to be created or the relationship definition to the class definition, if the new object is a classified object.
Parameter 1 type	String
Parameter 2	Relationship to create
Parameter 2 default	None
Parameter 2 description	The relationship definition to create between the selected objects and the new object being created.
Parameter 2 type	String
Parameter 3	Name of template object to copy
Parameter 3 default	None
Parameter 3 description	Name of the template object to copy (optional). Uses an object template that is configured to copy objects so that they are copied with the same specific properties. This parameter is not currently supported for methods used in the Web Client.
Parameter 3 type	String
Parameter 4	EdgeDef to child object in template
Parameter 4 default	None
Parameter 4 description	The edge definition to the child object in the copied template (optional). Uses an edge definition configured to copy specific objects. This parameter is not currently supported for methods used in the Web Client.
Parameter 4 type	String
Parameter 5	Mapping criteria 1
Parameter 5 default	None
Parameter 5 description	Used to map a property value from the starting object to the object to be created.
Parameter 5 type	String
Parameter 6	Mapping criteria 2
Parameter 6 default	None
Parameter 6 description	Used to map a second property value from the starting object to the object to be created.
Parameter 6 type	String
Parameter 7	Mapping criteria 3
Parameter 7 default	None
Parameter 7 description	Used to map a third property value from the starting object to the object to be created.
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 choose a workflow to attach to the object. For example, None, which is the default option, indicates that no workflow page appears and no workflow is attached to the object. Other options include Select, SelectRequired, or a named workflow. For more information on the options, see Configure create object to attach 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 any workflow to the object.
Parameter 8 type	String
Parameter 9	Non-interactive creation
Parameter 9 default	False
Parameter 9 description	Indicates whether the object and relationship will be created automatically, without any interaction from the user (True), or whether the user will be prompted to provide information (False). This parameter is not currently supported for methods used in the Web Client.
Parameter 9 type	Boolean
Parameter 10	Multi-option creation
Parameter 10 default	False
Parameter 10 description	Indicates whether multiple objects can be created (True) or only one object (False).
Parameter 10 type	Boolean
Parameter 11	Specific UID of classification
Parameter 11 default	None
Parameter 11 description	The UID of the specific classification for the object to be created. The parameter is optional and used only if the new object being created is a classified object. This parameter is not currently supported for methods used in the Desktop Client but is supported in the Web Client.
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. True value navigates to the next screen even when no workflow is attached to the object. 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	This parameter is only supported in the Web Client. 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	This parameter is only supported in the Web Client. 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	Relationships mapping criteria
Parameter 18 default	None
Parameter 18 description	This parameter is only supported in the Web Client. Relationships mapping criteria to copy relations. Relationship mapping criteria, separated by comma. The relationship definition is used to map the relationships between objects. For example: SourceRelDefUID_12/21~TargetRelDefUID_12/21,SourceRelDefUID_12/21~TargetRelDefUID_12/21. SourceRelDefUID_12/21~TargetRelDefUID_12/21~False,SourceRelDefUID_12/21~TargetRelDefUID_12/21~True. When the parameter is set to False, object creation is not allowed when the relationship maximum cardinality is one, and the selected source objects have different relations. When the parameter is set to True, you can create objects.
Parameter 18 type	String

The following methods use the CreateObjectFromSelectedObjects client API to create transmittals from selected documents, to create internal change actions from selected documents, to create change requests from selected documents and tags, and to comment on or markup documents in a change action workflow.

CreateExternalXmtlFromDocs
CreateInternalXmtlFromDocs
SCLBCreateDocumentInternalReviewAction
SCLBQFindInternalReviewAction
SCLBQueryInternalReviewAction
SOPSCreateInternalChangeAction
SDACreateIncomingTransmittalFromMultipleDocuments
SDACreateInternalTransmittalFromMultipleDocuments
SDACreateOutgoingTransmittalFromMultipleDocuments
SDACreateChangeRequestFromDocs
SDACreateChangeRequestFromTags