Predefined Business Logic Workflows for Client Registrations
Commvault provides the following predefined business logic workflows for client registrations:
The XML message specified in the properties of each workflow is CVInstallManager_ClientSetup, which allows you to manage and monitor client registrations.
The predefined workflows are activated after a user installs the Commvault software on a new client. Installation jobs on existing clients do not activate the workflows, such as the following jobs:
- Adding packages to existing clients
- Installing service pack updates
- Repairing clients or reinstalling the Commvault software
You can use the predefined workflows as a reference model (or template) to help you create your own business logic workflow. To obtain the workflows, see Download Workflows from Commvault Store.
Important: If you download all of the predefined workflows, you can only enable one of the workflows in your CommCell environment. Enabling more than one of these workflows is not supported.
For more information about each workflow, refer to the following sections:
|What does it do?||This workflow verifies client names to make sure that new clients do not have the same name as existing clients. If a new client is registered with the name of an existing client, then the workflow adds "_CV" to the new client name. For subsequent clients that have the same name, the workflow adds a number next to "_CV". For example, "_CV2".|
|When to use it?||Use this workflow to rename new clients that have the same name of a client that already exists in the CommCell environment.|
|Example|| Suppose that client A exists in your CommCell environment. If you register a new client that has the same name, then the workflow changes the name of the new client to A_CV.
After the client A_CV registration, if a user tries to register another client A, then the workflow changes the client name to A_CV2.
|What does it do?|| This workflow modifies the name of a client by adding the name of the Commvault package that is installed on the client. The workflow only considers the following packages: (the package are listed in priority order)
Note: The workflow can be modified to adjust to your environment needs. For example, you can rearrange the priority order or add more packages to the list.
|When to use it?||Use this workflow if you want to identify the Commvault package that is installed on your clients.|
|Example|| Suppose you register client A. If the workflow detects that the client has the MediaAgent, File System, and File System Core packages, then the workflow renames the client name to A_MediaAgent, because the MediaAgent package has precedence over the File System package.
After the client A_MediaAgent registration, if a user tries to register another client A that also has the MediaAgent installed, then the workflow renames the client name to A_MediaAgent2.
|What does it do?|| This workflow modifies the name of an existing client when a new client registers with the same client name. The workflow adds "_CV" to the name of the existing client.
Note: You cannot register clients that have the same name as the CommServe computer. If you do, you will receive the following message: Client Name is same as CommServe name. Please choose another name.
|When to use it?||Use this workflow if you do not want to rename the new client because there is another client with the same name in the CommCell environment.|
|Example|| Suppose that client A exists in your CommCell environment. If you register a second client A, then the workflow changes the name of the existing client to A_CV.
After the registration of the new client A, if a user tries to register a third client A, then the workflow renames the new client A to A_CV2. The third client becomes the new client A.
|What does it do?|| This workflow monitors the number of laptop clients that are registered by each CommCell user.
The workflow adds a limitation of three laptop clients per CommCell user. If a user tries to register a fourth laptop client, the registration fails and the workflow generates the following error message: User: galaxy_user_name has exceeded the allowed number of laptops to be registered.
|When to use it?||Use this workflow if you want to limit the number of laptop clients that can be registered per CommCell user.|