How Do I Change the REST URL for the AgilePoint NX Portal?

To change the REST URL that AgilePoint NX Portal uses to connect to AgilePoint Server (called the server instance URL), do the procedure in this topic. For example, you may want to change this URL to use SSL.

Prerequisites

Good to Know

  • The Manage AgilePoint NX Portal Configuration Utility lets you enter configuration information for your NX Portal server. The following limitations apply:
    • You can enter a first-time database configuration (Initialize) or update an existing configuration (Update). Usually this utility is used to update an existing configuration because the initial configuration is created during installation.
    • If you update an existing configuration, the utility does not retrieve the existing information. This utility lets you set the configuration for a new database connection string, but it does not retrieve or parse the existing connection string, if one exists.
    • This utility configures a single tenant environment. If you want to change the configuration for a multi-tenant environment, contact AgilePoint Professional Services.

How to Start

  1. On the AgilePoint Server machine, open the (NX Portal installation folder) C:\Program Files\AgilePoint\AgilePointWebApplication\AgilePointPortal.

Procedure

  1. To change the REST URL, do one of these.
    • To change the REST URL with the Manage AgilePoint NX Portal Configuration Utility, do this procedure.
      1. Open the folder (NX Portal installation folder) C:\Program Files\AgilePoint\AgilePointWebApplication\AgilePointPortal\bin.
      2. Right-click the file AgilePointNXPortalManagement.exe, and click Run as Administrator.
      3. On the Manage AgilePoint NX Portal Configuration Utility screen, in the Manage Portal Database Connection String section, complete the fields as necessary.
      4. In the AgilePoint REST URL field, enter the value for the REST URL as necessary.
    • To change the REST URL manually, do this procedure.
      1. On the AgilePoint Server machine, open each of the configuration files in this table, and change the value for the REST URL as necessary.
        File NameLocationSetting

        web.config

        (NX Portal installation folder) C:\Program Files\AgilePoint\AgilePointWebApplication\AgilePointPortal

        		 
        <add key="AgilePointServerUrl" 
  value="http://[AgilePoint Server machine]:[HTTP binding port]/AgilePointServer" />

        PD.Settings.xml

        (NX Portal installation folder) C:\Program Files\AgilePoint\AgilePointWebApplication\AgilePointPortal\Modules\AgilePoint.Portal.AppBuilder\Content

        		 
        <Property>
  <Name>AgilePointServerURL</Name>
  <Value>http://[AgilePoint Server machine]:[HTTP binding port]/AgilePointServer</Value>
</Property>

        FD.Settings.xml

        (NX Portal installation folder) C:\Program Files\AgilePoint\AgilePointWebApplication\AgilePointPortal\Modules\AgilePoint.Portal.AppBuilder\Content

        		 
        <Property>
  <Name>APIURL</Name>
  <Value>http://[AgilePoint Server machine]:[HTTP binding port]/AgilePointServer</Value>
</Property>

        tl.settings.xml

        (NX Portal installation folder) C:\Program Files\AgilePoint\AgilePointWebApplication\AgilePointPortal\Modules\AgilePoint.Portal.WorkCenter\Content 

        <Property>
  <Name>SERVER_URL</Name>
  <Value>http://[AgilePoint Server machine]:[HTTP binding port]/AgilePointServer</Value>
</Property>

        em.settings.xml

        (NX Portal installation folder) C:\Program Files\AgilePoint\AgilePointWebApplication\AgilePointPortal\Modules\AgilePoint.Portal.Manage\Content

        		 
        <Property>
  <Name>APIUrl</Name>
  <Value>http://[AgilePoint Server machine]:[HTTP binding port]/AgilePointServer</Value>
</Property>