Downloading and running the Domain Configuration tool

The Domain Configuration tool configures your on-premises servers to connect to your hosted IBM SmartCloud® Notes® servers. The server configuration information that you provide in the Account Settings of SmartCloud Notes Administration is the data that is used to configure the connections.

Before you begin

Before you can download and run the Domain Configuration tool for the first time, all of the required Account Settings information must be complete. To confirm that all of the required information is available, complete the task Checking the status of your hybrid account setup. If any information is incomplete, provide the missing information.

The IBM® Notes client from which the tool is run must be able to connect to the passthru servers in the passthru domain. The client must also be able to connect to the directory synchronization and mail hub servers in the on-premises hub domain. Firewall rules at your company might prevent connections from systems inside the firewall to the passthru servers. In this case, use a Notes client running on a system connected outside the firewall. Allow a direct connection to the passthru servers, and through them, connect to the servers in the on-premises hub domain.

If you are configuring the service for the first time, to make sure your on-premises environment is prepared, complete the task Using the pre-configuration tool to check your environment.

About this task

You run the Domain Configuration tool when you first configure the service to interoperate with your on-premises environment.

You also run the tool after the initial configuration. Run the tool again if you change a server configuration in Account Settings or if you correct a configuration problem in your on-premises environment.

If you are performing the initial service configuration, the Domain Configuration tool includes pre-configuration options you can use to test your on-premises environment before you actually configure it. No changes are made to your environment as a result of these tests.
  • Pre-configuration Test - Runs the same series of pre-configuration tests as the SmartCloud Notes Hybrid Pre-configuration tool (liveservercheck.nsf). If you did not complete the task Using the pre-configuration tool to check the status of your hybrid account setup, you can run those tests now. The tool then provides a report that identifies configuration issues that you can address before configuration.
  • Pre-configuration Report - Simulates the configuration, and provides a report of the configuration changes that would be made to your environment during the actual configuration process.

After you run the Domain Configuration tool, a detailed report lists the changes that were made to your on-premises server configuration. Typical changes include:

  • Allowing SmartCloud Notes servers sufficient access to your Domino® directories to perform directory synchronization
  • Creating connection documents to support server passthrough and mail routing to SmartCloud Notes servers
  • Modifying server configuration documents to allow passthrough access to these servers
  • Setting a server environment variable
Note: Do not edit the directory content added by the tool. For example, do not edit changes to the ACL or to Connection documents. Doing so prevents proper operation of the service. Refer to the report generated by the tool to see the exact directory changes the tool makes

Procedure

  1. Log on to the service as an administrator.
  2. If your account also has the User role, click Admin > Manage Organization.
  3. In the System Settings section of the navigation pane, click IBM SmartCloud Notes and then click Account Settings.
  4. In the navigation pane, click Domain Configuration Tool.
  5. Follow the steps in the window that opens to download the file liveserverconfig.nsf, and save it in your local Notes data directory.

    If you are trying to overwrite a previously downloaded copy, and you get the error message File is in use from your browser, it means that the IBM Notes client has the old copy of liveserverconfig.nsf open. If that does not seem to be the case, close Notes or use a different filename.

  6. From the Notes client using an ID that has Manager access to your Domino directory, click File > Open > IBM Notes Application, and then select the liveserverconfig.nsf file.
  7. Optional: Select Pre-configuration Test to run a series of pre-configuration tests based on information provided in the Hybrid Account Settings.
    1. Make any changes to your configuration environment, based on information in the report.
    2. To correct any account settings information, return to the SmartCloud Notes Administration windows where you first entered the hybrid account setup information, and make the corrections.
    3. Repeat steps 4 and 5 to download a new copy of liveserverconfig.nsf.
  8. Optional: Select Run a Pre-configuration Report to simulate the configuration that will occur. No changes are made to your environment.
  9. If all of the information is correct, select Configure Servers, and then click Begin.
  10. Review the resulting detailed report so that you know the changes that the tool made to your on-premises server configuration. Optionally, print the report for reference later.
    Note: If you failed to save the original report, the file liveserverconfig.log in your Notes data directory contains the same information. This log file is in English only. Running the tool again does not produce an identical report because the report lists the changes that were made when the tool runs. During a second run no changes are made.
  11. Allow time for the Domino directory changes to replicate to other servers in your environment.

What to do next

If you must run the tool again to make sure that your setup is still correct, perform steps 1-5 to get a new copy of liveserverconfig.nsf. When troubleshooting any communication issues with the service, running the tool is a good way to check whether anything has been changed, and whether you must return to the previous settings.

When you are satisfied that your environment is set up correctly after the initial service configuration, complete the task Verifying Internet domain names in a hybrid environment.