The CreateClassObj 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) |
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 |
|
Parameter 8 type |
String |
Parameter 9 |
Not used |
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 |
Not used |
Parameter 13 |
Not used |
Parameter 14 |
Not used |
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 |
Classification expansion edgedef property comparison |
Parameter 16 default |
None |
Parameter 16 description |
Property comparison to be added to the edge definition, which is used for expansion of the classifications. |
Parameter 16 type |
String |
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 |
Template Document Seed File Configuration |
Parameter 18 default |
None |
Parameter 18 description |
Parameter to add the UID classification to create document method and rename files with document parent suffix TemplateclassificationUID~IsSingleSelection~IsRenameChkBoxEnabled |
Parameter 18 type |
String |
-
Argument 4 can be used to restrict which classification nodes are available for selection based on the presence of optional interfaces.
-
Argument 18 allows you to rename any file attached to a new document from a Template Document with the new document parent suffix. The default is empty. On the creation of a document using ENS, the option is not available to be deselected.
Many methods use this client API, and the list can be viewed in the Web Client. To see the methods in your system that use this client API, find the client API, right-click it, and click Show Methods.