Configuring › How to Implement Multi-Tenancy › Utilities Used for Multi-Tenancy › pdm_buildtenant—Creating Tenants from Another Object

pdm_buildtenant—Creating Tenants from Another Object

The pdm_buildtenant utility is used to create tenants from another object. You may have used data partitions and another CA SDM object to achieve some of the functionality now provided by multi-tenancy. If you want to convert an implementation to multi-tenancy, the first step is to use pdm_buildtenant to map the data in the previously-used object to the new tenant object.

Important! Before you run pdm_buildtenant, you must configure the service provider.

In this section, the object used to hold tenant-like information is named the pre-tenant object. For most sites with these requirements, the org (organization) object is the pre-tenant object, but the following approach can be used for any pre-tenant object.

The pdm_buildtenant utility builds the tenant objects from pre-tenant objects. This application creates a tenant for each pre-tenant object, and sets the tenant attribute in the pre-tenant object to reference the new tenant. This utility has the following syntax:

pdm_buildtenant [-h] | [-f [configuration_file]

-f configuration_file

(Optional) Specifies the location of a configuration file specifying the rules for creating tenants from the pre-tenant object. If this argument is not included, pdm_buildtenant uses the configuration file from the $NX_ROOT/site/cfg directory. This file assumes the pre-tenant object is org; if this is not the case, you must edit the configuration file before using pdm_buildtenant.

Note: You must copy buildtenant.xml to the $NX_ROOT/site/cfg directory. In addition, buildtenant.xsd must be in the same directory as buildtenant.xml, or you receive an error. When you install the product, buildtenant.xsd is located in $NX_ROOT/site/cfg, so you do not have to copy this file.

-h

Displays usage information for pdm_buildtenant.

The following is the format of the configuration file:

<?xml version="1.0" encoding="utf-8" ?>
<BuildTenant>

<Object from="MajicObjectName">

<Attribute from="sourceAttribute1" to="tenantAttribute1" />
<Attribute from="sourceAttribute2" to="tenantAttribute2" />

</Object>

</BuildTenant>

The from attribute of the Object tag identifies the pre-tenant object. Each Attribute tag identifies an attribute to be copied from the pre-tenant object to an attribute of the new tenant.

Important! For UNIX implementations of multi-tenancy, you must run pdm_task to export LIBPATH before executing the pdm_settenant and pdm_buildtenant utilities. If you do not run pdm_task before executing these utilities, you receive system errors. Use ../pdm_task to run the command.