Configure Common Tenant Administration

This article contains the following topics:
casm172
This article contains the following topics:
Common tenant administration (also named multi-tenant administration) lets administrators use a single administration tool to simultaneously create and maintain business units (tenants) for multiple products, including CA Service Catalog and CA Service Desk Manager. To configure CA Service Catalog to use common tenant administration, follow this process:
This topic applies
only
if your organization has CA Service Desk Manager installed.
  1. Meet the prerequisites: Verify that CA Service Catalog and CA Service Desk Manager are installed and share the same MDB.
  2. Configure the tenancy settings in CA Service Desk Manager.
    CA Service Catalog requires a tenant of type Service Provider in CA Service Desk Manager, as a prerequisite for completing this process.
  3. Prepare to run the common tenant merge utility.
    This utility uses the information in the common tenant mapping file to create a shared tenant structure between CA Service Catalog and CA Service Desk Manager.
  4. (Optional)Implement a common terms of use agreement for common tenants.
Configure the Tenancy Settings in CA Service Desk Manager
Configure the tenancy settings in CA Service Desk Manager to support the integration with CA Service Catalog.
Follow these steps:
  1. Log in to CA Service Desk Manager as ServiceDesk(administrator).
  2. Click Administration, Option Manager, Multi Tenancy.
  3. Verify that the multi-tenancy option is on.
  4. Verify that the multi-tenancy depth is 10.
  5. Click Administration, Security and Role Management, Tenants.
  6. Click Create New to create a tenant, if no tenant of type Service Provider exists. Enter a meaningful name for the new tenant.
  7. Verify that Service Provider Checked is on and Subtenants Allowed is on.
You have configured the tenancy settings in CA Service Desk Manager to support the integration with CA Service Catalog.
Create the Common Tenant Mapping File
When you configure common tenant administration, a required task is creating the common tenant mapping file. Map tenants between CA Service Catalog and CA Service Desk Manager, so that both products use the same tenant structure.
Follow these steps:
  1. Review the tenant structures in CA Service Catalog and CA Service Desk Manager. Plan the merged structure that you want to use.
  2. Stop the CA Service Catalog services on the computer where MDB is installed.
  3. Open the CA Service Catalog command prompt by clicking Start, Programs, CA, Service Delivery, Service Delivery Command Prompt.
  4. At the CA Service Catalog command prompt, enter the following ant command:
    ant generate-merge-config
    The common tenant merge utility runs and creates the tenant mapping file, which is named merge-tenants.conf. The utility:
    • Creates the initial mapping entry, which maps the Service Provider business units for each product to each other. This entry is the only
      required
      entry. The CA Service Catalog entry is named ca_tenant, and the CA Service Desk Manager entry is named usm_tenant_ext.
    • Lists the names and database IDs of all CA Service Catalog tenants
    • Lists the names and database IDs of all CA Service Desk Manager tenants
    You use these names and database IDs to create the mapping entries.
  5. Open the merge-tenants.conf file that is located in USM_HOME, using a text editor. After the Service Provider mapping entry, add a new line for each new mapping entry that you create. Specify each entry using the following format, using the Service Provider entry as a model:
    <usdk> business unit ID=<bcsc> business unit ID
    For example:
    0x60B4EAC8B85E41DH97E647CF84A93CFA=87958EK983987D42AB2A4PAEF808C129
    Mapping a parent tenant maps the parent
    only
    ,
    not
    the children! Therefore, for automatic mapping, eit
    her
    map parents and children individually
    or
    omit the mapping of the parent.
  6. Review the sample common tenant mapping file and verify the contents of your mapping file.
  7. Restart the CA Service Catalog services that you stopped at the beginning of this procedure.
You have created the common tenant mapping file. You are ready to run the utility.
Run the Common Tenant Merge Utility
Follow these steps:
  1. Open the CA Service Catalog command prompt on the computer where the MDB is installed. Click Start, Programs, CA, Service Delivery, Service Delivery Command Prompt.
  2. Enter the following command:
    ant merge-tenants
    The utility prompts you for the name (
    Default:
    merge-tenant.conf ) and location (
    Default:
    USM_HOME) of the common tenant mapping. The utility also prompts you for the password for any administrator with the Service Provider role in CA Service Catalog. An example is the default user named spadmin. If running the utility creates tenants in CA Service Desk Manager, you enter this password.
  3. The utility summarizes the changes to be made in the tenant table in the MDB for each product. The utility also creates any missing tenants in those tables.
  4. Restart the CA Service Catalog services that you stopped at the beginning of this procedure.
  5. Start CA Service Catalog and CA Service Desk Manager. Verify that the tenant structure and common attributes of tenants are the same in both products.
You have run the common tenant merge utility.
If the same name is used for two or more tenants being created in CA Service Desk Manager the utility aborts. In such cases, check the tenant structure of each product. Rename any duplicate tenant names and ensure that they are unique. Run the utility again.
Set Configuration Variables
When you configure common tenant administration, setting the related configuration variables is a required task.
Follow these steps:
  1. Log in to CA Service Catalog as a user with the Service Delivery Administrator role.
  2. Click Administration, Configuration, System Information.
  3. Verify that the value of the option 
    Common Tenant Data Synchronized
    is Yes. This value is read-only. "No" indicates that a discrepancy exists between the tenant structures of CA Service Desk Manager and CA Service Catalog. Verify the accuracy of the common tenant mapping file and run the common tenant merge utility again.
  4. Set the value of the option
    Common Multi-tenant Administration Enabled
    to Yes.
    When this setting is Yes, common multi-tenant administration is enabled for CA Service Catalog, through CA Service Desk Manager.
You have set the configuration variables for common tenant administration.
Rules for Mapping File Entries
When you configure common tenant administration, a required task is creating the common tenant mapping file. Follow these rules when creating entries in this file:
Violations of any of these rules cause the common tenant merge utility to abort.
  • Do not map business units that are at different levels in CA Service Desk Manager and CA Service Catalog.
  • Do not map the same business unit more than once. If you have several business units, print the merge-tenants.conf file and mark each business unit after you map it and save the file.
  • Map a child only after mapping all its parents. Map the parents from the tenant level directly above the child through the level directly under the Service Provider business unit.
  • Verify that tenant names are unique across all products. For example, if you have a tenant AAA in CA Service Desk Manager and CA Service Catalog, rename at least one of them to a unique name.
  • Verify that the values in CA Service Desk Manager for common attributes meet your requirements for CA Service Catalog. This requirement is for every tenant and sub-tenant that you map. Doing so is important because for common attributes, the CA Service Desk Manager values overwrite the CA Service Catalog values.
  • Do
    not
    map that tenant or any of its sub-tenants explicitly in the merge-tenants.conf file, to add a complete tenant structure from one product to the other automatically. Instead, run the common tenant merge utility and confirm that you want to add any tenants that are not mapped in the merge-tenants.conf file. The utility then adds the complete structures of any unmapped tenants to each product automatically.
Sample Common Tenant Mapping File
Review the following sample common tenant mapping file and construct your own file:
... # CA Service Catalog Tenants (id, name) # ca.222.com   ca.222.com # 00234A51DC4A4F70A03D3BDE5526278C   BB # 9F6309A0CB654781B08080AD78C2280F   CC # 9CF5655B4B8D4833A0C6E74EB56128C5   AA # # CA Service Desk Manager Tenants (id, name) # 0xB3484A535A3D994B9FBCD28D3845F292   ca.111.com # 0xBB83719AA93DFC48B909D7D72CF8B0CB   A # 0xD9DC8FF2EB84CC43988FE71F4B489D3D   E # 0x67958EA983987D42AB2A4BAEF808C029   D # # Service Provider tenants must map to each other. This mapping is mandatory. 0xB3484A535A3D994B9FBCD28D3845F292=ca.222.com # # Map A to AA 0xBB83719AA93DFC48B909D7D72CF8B0CB=9CF5655B4B8D4833A0C6E74EB56128C5 ...
In this example, the following tenants exist:
  • CA Service Desk Manager tenants: ca.111.com, A, D, and E.
  • CA Service Catalog tenants: ca.222.com, AA, BB, and CC.
Service Provider tenants must map to each other. Hence, you merge the CA Service Desk Manager Service Provider tenant (ca.222.com) and the CA Service Catalog Service Provider tenant (ca.111.com).
Otherwise, you add a mapping entry only when you want to merge two tenants together. For example, in the sample file, you merge CA Service Desk Manager tenant A and CA Service Catalog tenant AA.
When you merge tenants, the CA Service Desk Manager tenant only overwrites common attributes in the CA Service Catalog tenant. The CA Service Catalog-specific attributes remain intact. After you run the common tenant merge utility with this sample file, the tenant ca.222.com in CA Service Catalog is renamed ca.111.com. Similarly, tenant AA in CA Service Catalog is renamed A. The tenants inherit the other common attributes of the CA Service Desk Manager tenant with which it was merged.
If you are simply adding tenants from one product to the other, do not map them in the common tenant mapping file. For this reason, the sample file does not map any other tenants. Thus, the following changes occur when you run the common tenant merge utility with this sample file:
  • CA Service Catalog tenants BB and CC are added to CA Service Desk Manager.
  • CA Service Desk Manager tenants E and D are added to CA Service Catalog.
(Optional) Implement Common Terms of Use Agreement
You can optionally implement a common terms of use agreement for CA Service Catalog and CA Service Desk Manager. Doing so helps enforce a consistent login policy for all common tenants in both products. CA Service Desk Manager administrators create and maintain this agreement in CA Service Desk Manager. CA Service Catalog administrators configure CA Service Catalog to adopt this agreement.
Verify that the CA Service Desk Manager setting meets the needs of your organization. For more information about configuring terms of use agreement in CA Service Desk Manager, see the CA Service Desk Manager documentation.
  1. Select Administration, Configuration, System Information in CA Service Catalog.
  2. Specify Yes for the setting
    Terms of Usage Prompt Enabled
    .
    If you specify No, then users attempting to log in to CA Service Catalog are
    not
    prompted to accept the terms of use agreement.
  3. Review the effect of the CA Service Desk Manager setting on users logging in to CA Service Catalog. The effect depends on the terms of use agreement that is configured for the common tenant in CA Service Desk Manager.
    • If the common tenant has an active, defined (not empty) terms of use agreement, prompt the user to accept it at every login.
    • If the common tenant has no terms of use agreement that is defined, or if the agreement is inactive, review the parent hierarchy of the tenant. Then perform the following steps:
      • If the nearest parent has active but empty terms of use agreement that is defined, then do not prompt the user with any terms of use agreement. Otherwise, prompt the user to accept the terms of use agreement of the nearest parent tenant that has an active terms of use agreement defined.
      • If no parent tenant has an active, specified terms of use, do not prompt the user with any terms of use.
    • If the common tenant has an active terms of use agreement defined but is configured to suppress it, then do
      not
      prompt the user to accept it.
    • If users attempting to log in to CA Service Catalog receive the prompt to accept the terms of use agreement but do not accept it, they cannot access CA Service Catalog.