Principals Reconnect Utility
Windchill Directory server is no longer supported and bundled with Windchill. You are required to configure the directory server of your choice to retain the user or group information.
PTC supports moving the participants to any other LDAP V3 compliant directory server by providing a command line utility that helps in the bulk reconnection of the principals. This utility is called Principals Reconnect Utility, and it can be used only by Windchill administrator. This utility can also be used to move participants to other directory server of your choice.
Procedure
1. Generate the mapping file in xml format. The file must be in one of the following formats:
◦ Format with multiple DN (Distinguished Name) entries—This format takes sourceDN and targetDN mappings for each user to be reconnected. It is recommended to use this format when specific source and target DN has to be mapped individually; for example separate uid values can be provided in the xml file.
<dnMapping>
<reconnect>
<sourceDN>uid=<>,ou=<>,cn=<>,cn=<>,o=<></sourceDN>
<targetDN>cn=<>,ou=<>,cn=<>,cn=<>,o=ptc</targetDN>
</reconnect>
<reconnect>
<sourceDN>uid=<>,ou=<>,cn=<>,cn=<>,o=<></sourceDN>
<targetDN>cn=<>,ou=<>,cn=<>,cn=<>,o=ptc</targetDN>
</reconnect>
</dnMapping>
 |
As the ampersand is a special character in XML, data containing the ampersand character in the XML file should escape it with &. In the example below, the data value users & computers is represented as users & computers.
//Original entry <sourceDN>cn=<value>,ou=users,ou=users & computers,ou=usa,DC=ab,DC=corp,DC=abcd,DC=com</sourceDN> //To be replaced by entry <sourceDN>cn=<value>,ou=users,ou=users & computers,ou=usa,DC=ab,DC=corp,DC=abcd,DC=com</sourceDN> |
◦ Format with single adapter name entry—This format takes adapterMapping as the attribute to map.
<adapterMapping>
<sourceAdapter>Adapter1</sourceAdapter>
<targetAdapter>Adapter2</targetAdapter>
</adapterMapping>
<sourceAdapter>Adapter1</sourceAdapter>
<targetAdapter>Adapter2</targetAdapter>
</adapterMapping>
2. Before you use the mapping file in the command line utility, check the following:
◦ The value specified in the targetDN should not already exist in the database.
◦ The sourceDN and targetDN should represent the same principal type.
◦ The specified sourceDN entry should be deleted in LDAP.
◦ The principal referenced by sourceDN should be present in the database.
◦ The targetDN should exists in any of the LDAP adapters configured for the system.
3. Run the following command line utility from the Windchill shell. Only a Windchill site administrator can run this utility.
windchill wt.org.util.ReconnectPrincipalsUtility [-u <user>] [-p <password>] -f <mappingFile> [-d][-h]
where the mandatory arguments are:
◦ -u <userName>—Administrator user name.
◦ -p <password>—Administrator password.
◦ -f <mappingFile>—Mapping file that takes a fully qualified path of an xml format file with the mappings.
Non-mandatory arguments are:
◦ -d <debug>—Save debug messages to a log file.
◦ -h <help>—Print usage notes to a console.
If any parameter is incorrectly specified, then the appropriate message is displayed above the display note. The usage note is displayed if it is explicitly requested.
4. After a command is successfully executed, a message appears with the path to log files. Verify the log file.