The CreateClassObjAndLoad client API create new classified objects and uploads them into a Data Validator workflow.
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 |
RelDef to related object |
Parameter 4 default |
None |
Parameter 4 description |
The relationship definition, prefixed with + or -, to the related object. |
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 |
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 description |
SPFDesignFile~SPFFileComposition~PROMPT |
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 |
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 |
Classification tree filtering |
Parameter 9 default |
None |
Parameter 9 description |
A ~ separated list of interfaces to perform classification tree filtering (optional) |
Parameter 9 type |
String |
Parameter 10 |
Not used |
Parameter 11 |
Not used |
Parameter 12 |
Maximum Number of Control Files |
Parameter 12 default |
1 |
Parameter 12 description |
Specifies the maximum number of control files that may be selected. |
Parameter 12 type |
Integer |
Parameter 13 |
Show File Upload page |
Parameter 13 default |
False |
Parameter 13 description |
Boolean to control whether to show the file upload page in the wizard. |
Parameter 13 type |
Boolean |
Parameter 14 |
Show Configuration Selection Page |
Parameter 14 default |
False |
Parameter 14 description |
Boolean to control whether to show the configuration selection page in the wizard. |
Parameter 14 type |
Boolean |
Parameter 15 |
Is file attachment mandatory |
Parameter 15 default |
False |
Parameter 15 description |
At least one file attachment is mandatory if this flag is set to true |
Parameter 15 type |
Boolean |
Parameter 16 |
Not used |
Parameter 17 |
Create Form UID |
Parameter 17 default |
None |
Parameter 17 description |
UID of the create form to be used. (Not supported in the Desktop Client). When configured, the selected create form will be launched during the create object process. |
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 to create objects and upload them to Data Validator.
-
SDALoad_Areas
-
SDALoad_Disciplines
-
SDALoad_Documents
-
SDALoad_Locations
-
SDALoad_Systems
-
SDALoad_Tags
-
SDALoad_Units
-
SDALoad_Workpackages