Partner Setup

Partner Setup allows you to view/edit information necessary to integrate with a third-party partner. For example, it allows you to view/edit system setup information and the services rendered by the partner.

Accessing Partner Setup

  1. Mouse over Administration on the main navigator and then select Administration.
  2. In the General Administration area, select Manage Partner Integrations.
  3. The Partner Setup segment displays by default. You can select the User Account Setup segment by clicking on the segment name in the segment drop-list. If you are on the User Account Setting segment, click Partner Setup on the segment drop-list to access the Partner Setup segment.
  4. You can exit Manage Partner Integrations by selecting Close from the right side of the screen.

The Partner Setup Grid

The main Partner Setup page displays a grid showing a list of existing partners. The grid displays the partner name, the associated URL, the active status, the date that the partner information was last updated and the user that updated the information.

  • To view detail about the partner setup, click the name of the partner or the Active indicator.

The Partner Record

The Partner Record has two segments: Summary and Journal. The Journal keeps an audit record of all changes made to the partner record.

The Summary segment displays the following information:

  • Partner: Partner Name. This cannot be edited.
  • URL: The partner's associated URL. You can click on the URL (or on the globe icon if you are editing the page) to be taken to the associated web page.
  • Active: Indicates whether the partner integration is currently active (Y) or not active (N). You can use the Code Selection icon when in Edit mode to change the Active setting.
  • Services: Displays a list of services provided by the partner. You can click on the Service Type or the Active column to access detailed information about the service.
  • Partner Settings: Displays the various Partner Settings information including URL, User Name, Password, etc.

The Service Record

The Service Record displays information applicable to the service provided by the partner. The following information is available on the Service record:

  • Partner: Partner Name. This cannot be edited.
  • Service Type: Type of service provided. This cannot be edited.
  • Description: Description of the provided service.
  • Compass Portal: Indicates whether the service integrates with the Compass Portal. This cannot be edited.
  • Active: Indicates whether the service is active (Y) or not (N). In Edit mode, you can use the Code Selection icon to change the Active status.
  • Account ID: ID associated with the service.
  • Settings: Various system settings that allow the service to integrate with Adapt including Endpoint URLs, Callback URLs, etc. You can change the information by clicking on the appropriate row in the Settings grid.