API

This Settings screen enables you to select the actions to be taken by Installation Manager (e.g., install, uninstall) and to specify the machine name, database server, and port to be used by the Web Services (APIs) for Regulatory.

Set Up the APIs

  1. In the Installation menu, click API. The API screen for Regulatory is displayed. Closed

    API Settings

  2. Click Add to add a line to the Settings screen.

  3. Select an appropriate Action. The following Action values are available:

    • None – Performs no action.

    • Install – Performs a fresh installation or upgrade of a component. You can install or upgrade multiple components at same time.

    • Uninstall – Removes all subcomponents on that machine and uninstalls the component from Programs and Features.

    Optional: Click Select All to set the Action field to Install for all components listed on this screen. Click Unselect All to set the Action field to None.

  4. Enter the Machine Name for the component to be installed. This is the machine where the APIs for CampusNexus Student will be installed.

  5. In the Database field, select a database for Regulatory. The drop-down contains a list of databases configured in the Database settings screen.

  6. In the Port field, enter the name of the port where the Web Services will be installed.

  7. Click Options (ellipsis) icon to view and edit the Options form. The Authentication Override form is displayed. Closed

    Authentication Options

    1. Select the check box Override Global Settings CampusNexus Student credentials for this component to enable the fields on the form.

    2. Enter the Username and Password of the CampusNexus Student account for the selected machine.

    3. Click Test to ensure the user authentication settings are correct. A confirmation message is displayed.

    4. Click OK to save changes on the Options form. The form is closed.

  8. Click copy icon to copy a line. Edit the copied line as needed.

  9. Click Delete icon to delete a selected line.

  10. If multiple API servers are installed in a server farm:

    1. Select the Protocol (http or https).
    2. Enter the farm's virtual IP address or DNS name in the Machine Name field.
    3. Specify the Port number.

  11. Click Test to ensure the setup for the corresponding line is correct. If a test on a particular line fails, check all associated fields and click Test again.

    Notes:

    • The Test button checks if the port number is in use; if so, the user is prompted to enter a different port number.

    • If an upgrade is performed, Installation Manager first checks if the port number is in use by the same Web Service that’s being installed.

  12. If all tests pass, click right arrows.