The cdb.c commands provide general-purpose controls for managing components.
Table 3–2 CLI Commands for Managing Components
Command |
Description |
---|---|
cdb.c.ci |
Checks in non-browsable components and component models. |
cdb.c.co |
Checks out a component. |
cdb.c.la |
Lists all versions of all components. |
cdb.c.lo |
Lists detailed information about a component. |
cdb.c.lv |
Lists all versions of a component. |
cdb.c.mod |
Modifies a component. |
cdb.c.mv |
Moves or renames a component. |
cdb.c.sc |
Applies one or more categories to a component. |
cdb.c.sh |
Shows or hides a component. |
cdb.c.del |
Deletes a component |
Use the cdb.c.ci command to check in certain components. You will need to use this command in the following scenarios.
You need to check in a non-browsable component (for example: an untyped or container component).
If you need to check in a browsable component, use the cdb.rsrc.ci command. For a description of the command and its arguments, see cdb.rsrc.ci.
You need to check in a component model (the XML representation of a component), but not the referenced components or source objects. You might use this functionality when updating control blocks and variable values.
If you want to create new versions of the component and all of its referenced components, use the cdb.rsrc.ci command. For a description of the command and its arguments, see cdb.rsrc.ci.
Argument/Result |
Syntax |
Description |
|
---|---|---|---|
path |
[R] |
InputStreamWrapper |
The location of the XML component definition |
major |
[O] |
Boolean |
Whether to checkin as a new major version; default false. |
import |
[O] |
Boolean |
Whether to import variable settings, default true |
hidePrev |
[O] |
Boolean |
Whether to hide the previous component, default true. |
parents |
[O] |
Boolean |
Whether nonexistent parent folders are created during component check-in. Default is false. |
result |
Component |
The new component |
This command checks out a component. It outputs the specified component in XML format.
Table 3–4 Argument and Result for the cdb.c.co Command
Arguments/Result |
Syntax |
Description |
|
---|---|---|---|
comp |
[R] |
ComponentID |
The ID of the component XML to view. |
result |
Component |
The component in XML format |
The command lists all versions of all components.
Table 3–5 Arguments and Result for the cdb.c.la Command
Arguments/Result |
Syntax |
Description |
|
---|---|---|---|
sh |
[O] |
Boolean |
Whether hidden components are shown, default false |
cat |
[O] |
CategoryID |
Category filter to apply, default “all” |
folderID |
[O] |
FolderID |
Parent folder ID; default is the root folder (NM:/) |
flatView |
[O] |
Boolean |
Whether results should be displayed in flat view; default is true |
result |
SummaryComponent- Array |
The components |
This command lists the details of a specified component.
Table 3–6 Arguments and Result for the cdb.c.lo Command
Argument/Result |
Syntax |
Description |
|
---|---|---|---|
ID |
[R] |
ComponentID |
The ID of the component to view |
result |
Component |
The component |
This command lists all the versions of the specified component.
Table 3–7 Argument and Result for the cdb.c.lv Command
Argument/Result |
Syntax |
Description |
|
---|---|---|---|
comp |
[R] |
ComponentID |
The component |
result |
SummaryComponent- Array |
All the versions of the component |
This command modifies a component, which results in a new version of the component.
Table 3–8 Arguments and Result for the cdb.c.mod Command
Argument/Result |
Syntax |
Description |
|
---|---|---|---|
comp |
[R] |
ComponentID |
The component |
label |
[O] |
String |
The component label |
desc |
[O] |
String |
The component description |
rva |
[O] |
StringArray |
The component versions; use version number, “#” for recommended, “+” for default, and “-“ for latest; or omit this argument to use latest for all components. This argument is only applicable for composite components. |
hidePrev |
[O] |
Boolean |
Whether to hide the previous version. Default is true. |
result |
Component |
The component |
This command moves or renames a component.
Table 3–9 Arguments for the cdb.c.mv Command
Argument |
Syntax |
Description |
|
---|---|---|---|
ID |
[R] |
ComponentID |
The ID of the component to move or rename |
fullname |
[R] |
String |
The new full name (path + name) of the component |
This command associates a component with a set of categories.
Table 3–10 Arguments and Result for the cdb.c.sc Command
Argument/Result |
Syntax |
Description |
|
---|---|---|---|
ID |
[R] |
ComponentID |
The ID of the component to affect |
catIDs |
[R] |
CategoryIDSet |
The IDs of the Categories to associate with this component |
all |
[O] |
Boolean |
Whether to change all versions of the component, default false |
This command associates a component with a set of categories.
Table 3–11 Arguments and Result for the cdb.c.sc Command
Argument/Result |
Syntax |
Description |
|
---|---|---|---|
ID |
[R] |
ComponentID |
The ID of the component to affect |
catIDs |
[R] |
CategoryIDSet |
The IDs of the Categories to associate with this component |
all |
[O] |
Boolean |
Whether to change all versions of the component, default false |
This command deletes a component.
Table 3–12 Arguments for the cdb.c.del Command
Argument |
Syntax |
Description |
|
---|---|---|---|
ID |
[R] |
ComponentID |
The ID of the component to delete |
all |
[O] |
Boolean |
Whether to delete all versions of the component, default false |