Server rename workflow

The following diagram illustrates the general workflow for renaming a server. Below the diagram is a list of the main steps for this workflow. Both the diagram and list have links to more information, if available.

If you are moving to new hardware, the source and target represent two distinct installations on two distinct physical systems. If you are using the same hardware (performing a rename in place), the source and target represent two distinct installations on the same physical system.

Workflow

The following diagram displays the main steps for server rename. Click the individual boxes for further information, if available.
Tip: To keep this topic open while you check details in a box, right-click the box and select Open Link in New Tab or Open Link in New Window, depending on your browser.

Because server rename is a long process, you can find a checklist of the steps below the diagram. The checklist provides more specific information.

Server rename flow Click this area to get information about supported scenarios for server rename Click this area to get information about the mappings file and topologies for server rename Click this area to get information about possible impact on your applications and server rename Click this area to get information about planning URLs Click this area to get information about obtaining an activation key Click this area to get information about installation Click this area to get information about generating and editing a mappings file Click this area to get information about verifying a mappings file Click this area to get information about fixing mappings file errors Click this area to get information about stopping the servers Click this area to get information about backing up databases and copying text indices and configuration files Click this area to get information about importing a mappings file Click this area to get information about starting the servers Click this area to get information about viewing the status of the rename Click this area to get information about verifying application data Click this area to get information about flagging URLs Click this area to get information about updating URLs Click this area to get information about performing post-rename steps Click this area to get information about finishing the verification wizard

Checklist

If you want, print this topic and check off the steps as you complete them. Where available, click the link in a step for more information.
Tip: To keep this topic open while you check details of a step, right-click the link and select Open Link in New Tab or Open Link in New Window, depending on your browser.
Note: This checklist is a guide to give you a view of the server rename process. For detailed instructions on how to do server rename, see Setting up a test staging environment with production data and Moving a pilot or full production deployment by using server rename.
  1. Review Server rename to understand the risks, precautions, restrictions, software requirements, and other things to know about server rename.

  2. Review Supported scenarios for using server rename to learn what scenarios are supported and not supported for server rename.

  3. Review Server rename topology diagrams and mapping file examples to help you perform a server rename.

  4. Review Impact of server rename on the IBM Engineering Lifecycle Management to help you evaluate what impact there might be for your integration or integrations before you proceed with the actual steps of renaming a server.

  5. Review Planning your URIs to help you decide what URI to use for the server.

  6. Obtain a feature key file from IBM Software Support. Mention that you are requesting a server rename feature key file. The key file is named ImportURLMappings.activate. Copy the file to the JazzInstallDir/server/conf directory for the applications that you will rename. The key is only needed to execute the repotools importURLMappings command.

  7. On the target environment, install and configure IBM Engineering Lifecycle Management (ELM). Use the interactive installation guide.

  8. On the source environment, generate/edit your mappings file, which you use later when you rename your ELM servers; see Preparing the mapping file.
    Note: This task is automated with a script or the repotools command.
  9. In the source environment, verify your mappings file; see Repository tools command to verify a mapping file.
    Note: This task is automated with a script or the repotools command.
  10. In the source environment, fix any mappings file errors; see Recovering from generateURLMappings errors.

  11. For the Lifecycle Query Engine and the Link Index Provider, make sure that you completed the Preparing for server rename procedure mentioned in Impact of server rename on Lifecycle Query Engine and the Link Index Provider.

  12. In the source environment, stop the JTS, ELM servers, and other affected servers.

  13. In the source environment, back up your databases, and copy your text indices.

  14. In the target environment, copy the activation key to /server on target JTS server.

  15. For the Lifecycle Query Engine and the Link Index Provider, make sure that you completed the During server rename procedure mentioned in Impact of server rename on Lifecycle Query Engine and the Link Index Provider.

  16. In the target environment, import the mappings file to the target Jazz Team Server.
    Note: This task is automated with a script or the repotools command.
  17. In the target environment, start the JTS and distributed ELM apps on the target servers.

  18. In the target environment, go to the rename status page and wait for application renames to complete; see Verifying URLs and links after a server rename.

  19. In the target environment, verify the renamed application data while in read-only mode; see Verifying URLs and links after a server rename.

  20. In the target environment:
  21. In the target environment, do the post-rename steps, see Completing the server rename verification process.

  22. In the target environment, finish the wizard to complete the rename. The servers are fully operational. No restart is required. See Verifying URLs and links after a server rename.

  23. Do the following steps for these components:
    1. For the Lifecycle Query Engine and the Link Index Provider, complete the After server rename procedure mentioned in Impact of server rename on Lifecycle Query Engine and the Link Index Provider.

    2. For Report Builder, complete the post-rename steps for Report Builder.


video icon Video

Jazz.net channel
Software Education channel

learn icon Courses

IoT Academy
Skills Gateway

ask icon Community

Jazz.net
Jazz.net forums
Jazz.net library

support icon Support

IBM Support Community
Deployment wiki