Commands and Command Groups
On the KM user interface, commands can be gathered together in groups. These command groups can contain 'normal' commands as well as commands that offer selection options using a dialog box.
Command groups can be used in the Details dialog box, layout sets, and collection and resource renderers.
Commands
In addition to the information used for localization (bundle file specification) you can define whether a command can be applied to several resources simultaneously (parameter Mass Command).
The following parameters are available for the configuration of a command:
Command Parameters
| Parameters | Required | Description |
|---|---|---|
|
Alias |
Yes |
Alias of the command. This alias is used instead of the name of the Java class. |
|
Description |
No |
Description of the command. |
|
Java Class |
Yes |
Specifies the Java class that implements the command. |
|
Mass Command |
No |
Specifies whether the command can be applied to more than one resource at once. |
|
Parameters |
No |
Specifies additional parameters that can be evaluated by commands. The implementation of a command dictates whether it can evaluate additional parameters. |
|
Command Icon Path |
No |
Path to a graphic file to be displayed as an icon for the command, instead of text. Example: /etc/public/mimes/images/document.gif This setting can only be used with the menu icon (see Menus ). |
|
Bundle File |
No |
Specifies the bundle file in which the key and label for the command are stored. For example, com.sapportals.wcm.rendering.uicommand.UICConsts This bundle file is needed for localization. |
|
Key for Tooltip |
No |
Specifies the relevant key for the displayed tooltip. The key is stored in the bundle file. |
|
Key for Label |
No |
Specifies the corresponding key for the displayed label. The key is stored in the bundle file. |
|
Roles with Visibility |
No |
Comma-separated list of roles for which this command is valid. The role specifications are formulated as follows: Location/Role ID These specifications are located in the portal at User Administration → Roles. Select the required role and click on Edit Specifications are under Detailed Information. For example: pcd:portal_content/specialist/contentmanager/ ContentManager |
Commands with Selection Options in a Dialog Box
Commands such as Move To, or Copy To require that you specify a target folder. If you use one of these commands, you are asked to select a folder in an additional dialog box. You can specify a separate layout set for the dialog box in the configuration.
Parameters for Commands with Selection Options in a Dialog Box
| Parameters | Required | Description |
|---|---|---|
|
Alias |
Yes |
Alias of the command. This alias is used instead of the name of the Java class. |
|
Description |
No |
Description of the command. |
|
Java Class |
Yes |
Specifies the Java class that implements the command. |
|
Mass Command |
No |
Specifies whether the command can be applied to more than one resource at once. |
|
Layout Set |
No |
Specifies a layout set used for the display of the dialog box. |
|
Parameters |
No |
Specifies additional parameters that can be evaluated by commands. |
|
Command Icon Path |
No |
Path to a graphic file to be displayed as an icon for the command, instead of text. Example: /etc/public/mimes/images/document.gif This setting can only be used with the menu icon. |
|
Bundle File |
No |
Specifies the bundle file in which the key and label for the command are stored. For example, com.sapportals.wcm.rendering.uicommand.UICConsts This bundle file is needed for localization. |
|
Key for Tooltip |
No |
Specifies the relevant key for the displayed tooltip. The key is stored in the bundle file. |
|
Key for Label |
No |
Specifies the corresponding key for the displayed label. The key is stored in the bundle file. |
|
Roles with Visibility |
No |
Comma-separated list of roles for which this command is valid. The role specifications are formulated as follows: Location/Role ID These specifications are located in the portal at User Administration → Roles. Select the required role and click on Edit Specifications are under Detailed Information. For example: pcd:portal_content/specialist/contentmanager/ ContentManager |
|
Tooltip Key for Command in Dialog Box |
No |
Tooltip text displayed for a command in a selection window. |
|
Label Key for Command in Dialog Box |
No |
Specifies the label displayed in the selection window for a command.
|
|
Tooltip Key for Mass Command in Dialog Box |
No |
Tooltip text displayed for a mass command in a selection window. Only necessary if the Mass Command parameter is activated. |
|
Label Key for Mass Command in Dialog Box |
No |
Specifies the label displayed in the selection window for a mass command. Only necessary if the Mass Command parameter is activated. |
|
Label Key for First Input Field |
No |
Specifies a label for the first input field. |
|
Label Key for Second Input Field |
No |
Label for the second input field. |
Command Groups
Commands can be gathered together into groups. Command groups are structured hierarchically. This means that command groups can contain other command groups.
You can use the configuration of a command group to define which commands and command groups are to be used.
Parameters of a Command Group
| Parameters | Required | Description |
|---|---|---|
|
Alias |
Yes |
Alias of the command group. This alias is used instead of the name of the Java class. |
|
Description |
No |
Description of the command group. |
|
Command List |
No |
Aliases of commands and command groups in this command group. Separate the entries with commas. If a command cannot be applied to a particular resource, it is displayed as inactive on the interface. |
|
Java Class |
Yes |
Specifies the Java class that implements the command group. |
|
Parameters |
No |
Specifies additional parameters that can be evaluated by commands. The implementation of a command dictates whether it can evaluate additional parameters. |
|
Command Icon Path |
No |
Path to a graphic file to be displayed as an icon for the command, instead of text. Example: /etc/public/mimes/images/document.gif This setting can only be used with the menu icon. |
|
Bundle File |
No |
Specifies the bundle file in which the key and values for the command group are stored. For example, com.sapportals.wcm.rendering.uicommand.UICConsts This bundle file is needed for localization. |
|
Key for Tooltip |
No |
Specifies the relevant key for the displayed tooltip. The key is stored in the bundle file. |
|
Key for Label |
No |
Specifies the corresponding key for the displayed label. The key is stored in the bundle file. |
To create a command, or to modify the configuration of an existing command, choose Content Management → User Interface → Commands → UI Command.
To create or modify a command with selection options in a dialog box, choose Content Management →User Interface →Commands →UI Commands with Selection.
To create or modify a command group, choose Content Management → User Interface → Commands → UI Command Group.
More information: