Adding users to a project area by using the command line

You can add users to a project area or to the default project area. Users cannot log in to Case Builder until they are added to a project area.

Before you begin

Be sure to have your completed configuration checklist available.

About this task

Each user can belong to only one project area and the default project area. If you assigned a user who is already assigned to any nondefault project area to another project area, that user is automatically removed from the original nondefault project area.

You can add groups to the default project area only. You must add users individually to your nondefault project areas.

Procedure

To add users to a project area:

  1. Change the current directory to the install_root/CaseManagement/configure directory. Where install_root is the location where IBM® Business Automation Workflow is installed.
  2. Optional: List the users or groups that are already signed to the project area by running the following command. Do not enter any line breaks when you enter the command.
    configmgr_cl listPrincipals -projectAreaName project_area_name
     -profile myprofile
     [-silent] [-force][-help]
    -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.
    -silent
    Optional: When you specify the -silent parameter, no prompts or informational messages are shown in the console, but the errors are written to the log. Failure messages and validation error messages are shown as needed, such as messages about missing passwords or invalid port numbers. If you run the execute command to run all the activities in a profile and you specify the -silent parameter, you must also specify the -force parameter.
    -force
    Optional and applies only when the -silent parameter is used. When you specify the -force parameter, the activity is run without pausing for required responses to validation error messages, such as messages about missing passwords or invalid port numbers.
    -help
    Optional and displays a brief message on the command syntax instead of running the command.
  3. Add a users or groups by running the following command. Do not enter any line breaks when you enter the command.
    configmgr_cl addPrincipals -projectAreaName project_area_name
     -profile myprofile
     [-users user_name] [-groups group_name]
     [-silent] [-force][-help]
    -projectAreaName project_area_name
    Specifies the name of the project area to add users to. The default project area is named dev_env_connection_definition.
    -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.
    -users user_name

    Specifies the short name or display name of the user that you want to add. A user can belong to the default project area and one other project area. If you add a user to a nondefault project area, that user is removed from any other nondefault project area.

    You can add multiple users at one time by adding additional -users user_name entries on the same command.

    You can omit this option if you are adding only groups.

    -groups group_name

    Specifies the short name or display name of the group that you want to add. Groups can be added to the default project area only.

    You can add multiple groups at one time by adding additional -groups group_name entries on the same command.

    You can omit this option if you are adding only users.

    -silent
    Optional: When you specify the -silent parameter, no prompts or informational messages are shown in the console, but the errors are written to the log. Failure messages and validation error messages are shown as needed, such as messages about missing passwords or invalid port numbers. If you run the execute command to run all the activities in a profile and you specify the -silent parameter, you must also specify the -force parameter.
    -force
    Optional and applies only when the -silent parameter is used. When you specify the -force parameter, the activity is run without pausing for required responses to validation error messages, such as messages about missing passwords or invalid port numbers.
    -help
    Optional and displays a brief message on the command syntax instead of running the command.
  4. Repeat the previous step to add more users or groups for the project area.