listPrincipals command

Edit online

The listPrincipals command lists the users and groups that are assigned to a project area. Users who are not assigned to a project area cannot log in to Case Builder.

Syntax

The following syntax includes line breaks to format the command for reading. Enter the command and options on a single line without any line breaks.

configmgr_cl listPrincipals -projectAreaName project_area_name
 -profile myprofile
 [-help]

Parameters

-projectAreaName project_area_name

The name of the project area. The default project area is named dev_env_connection_definition. The name can contain up to 255 characters. If the name includes a space, put the name in double quotation marks, for example, "Credit Dispute Area". The name cannot contain any of the following characters: \ / : * ? " < > |

-profile myprofile

Specifies the profile to use. The myprofile value can be one of the following items:

The name of the profile, such as develop1. The profile is located in the install_root/CaseManagement/configure/profiles directory. install_root is the location where IBM® Business Automation Workflow is installed.
The full path to the profile directory, such as "install_root\CaseManagement\configure\profiles\develop1" or /install_root/CaseManagement/configure/profiles/develop1.
The full path to the profile input file, such as "install_root\CaseManagement\configure\profiles\develop1\develop1.cfgp" or /install_root/CaseManagement/configure/profiles/develop1/develop1.cfgp.

-help

Optional: Shows a brief message on the command syntax instead of running the command.

Sample commands

The following examples include line breaks to format the command for reading. Enter the command and options on a single line without any line breaks.

List the users and groups that area assigned to a project area.

The following command lists the users and groups that are assigned to the project area MyProjectArea for the MyDevelop1 profile:

configmgr_cl addPrincipals -projectAreaName MyProjectArea
 -profile MyDevelop1

List the users and groups that are assigned to the default project area.

The following command lists the users and groups that are assigned to the default project area for the MyDevelop1 profile:

configmgr_cl addPrincipals
 -projectAreaName dev_env_connection_definition
 -profile MyDevelop1

Show the help for the addPrincipals command.

The following command shows the help for the addPrincipals command:

configmgr_cl addPrincipals -help