Creating Workflows for Monitoring Client Registrations

You can create a workflow to monitor clients that want to join your CommCell environment. This is useful if you want to perform client management operations before the client registers with the CommServe computer. For example:

  • You might want to rename a new client because it has the name of an existing client.

  • You might want to limit the number of laptop clients that a user can register.

To manage and monitor the client registration process, you must create a business logic workflow.


Create the workflow using the steps in Creating a Business Logic Workflow.

During the workflow creation, locate the General tab in the Workflow Properties pane, and then specify the following properties:

  • In the Value column of the Message Name property, type CVInstallManager_ClientSetup.

    Note: CVInstallManager_ClientSetup is the name of the XML request that manages client registrations. To review the XML attributes that are defined in the request, see Sample XML Request.

  • In the Value column of the Module property, select CVD.

Tip: Commvault provides predefined business logic workflows for client registrations. If you need help creating the business logic workflow, you can use the predefined workflows as a reference model. For more information, see Predefined Business Logic Workflows for Client Registrations.

Sample XML Request

CVInstallManager_ClientSetup is the XML request in charge of providing information to the CommServe database about the client to be registered. The request helps you identify the response from the CommServe database as well as the actions to be performed based on the response.

The following XML content is a sample of the CVInstallManager_ClientSetup XML request. The sample displays the XML attributes that are defined in the request.

Note: To manage and monitor the client registration, you can configure the workflow to check some attribute values against specific conditions. For example, if the bLaptopBackup attribute is 1, the request detects whether the client has the Commvault laptop package installed.

<?xml version="1.0" encoding="UTF-8"?> 
<CVInstallManager_ClientSetup Focus="Instance002" Operationtype="0" RemoteClient="1" requestFlags="4096" requestType="1">
      <userAccountToLogin domainName="" password="*******" userName="user" />
      <CommserveHostInfo _type_="3" clientName="" hostName="" />
    <clientComposition activateClient="1" packageDeliveryOption="0">
        <client clientPassword="********" cvdPort="8405" installDirectory="C:\Program Files\Commvault\ContentStore2">
         <clientEntity _type_="3" clientName="vmtest1_2" hostName="" />
         <jobResulsDir path="C:\Program Files\Company\Software\iDataAgent\JobResults" />
         <osInfo PlatformType="X64" SubType="Server" Type="Windows" Version="6.2">
         <OsDisplayInfo OSBuild="9200" OSName="Windows Server 2012 R2 Datacenter" ProcessorType="WinX64" /></osInfo>
         <versionInfo GalaxyBuildNumber="BUILD80"> <GalaxyRelease ReleaseString="11.0" _type_="58" /> </versionInfo>
       <clientProps BinarySetID="3" ClientInterface="" byteOrder="Little-endian" />
      <clientRoles bLaptopBackup="1" bNetworkProxy="0" />
        <commonInfo> <storagePolicyToUse _type_="17" storagePolicyId="1" storagePolicyName="CV_DEFAULT" /> </commonInfo>
        <componentInfo ComponentId="1" ComponentName="File System Core" _type_="60" clientSidePackage="1" consumeLicense="1" /> <fileSystem />
      <patchInformation spVersion="4.1"> <packagePatches pkgId="1" /> </patchInformation>
    <installFlags activateAllUserProfiles="0" />