How Do I Connect On-Premises SharePoint to AgilePoint NX in a Public Cloud Environment?

To integrate on-premises SharePoint with AgilePoint NX in a public cloud environment, do the procedure in this topic.

Prerequisites

Good to Know

  • You must change the values in the list items before you can use SharePoint Integration.
  • For all AgilePoint Configuration List settings, the following values apply:
    • Application - This value must be AgilePoint.
    • Encrypted - If you select this option, data associated with this setting is encrypted to and from SharePoint. This setting is optional except in these conditions:

How to Start

  1. Open a SharePoint site collection where the AgilePoint App Part or Web Part is installed.
  2. Click Settings Settings icon > Site Contents.
  3. Click AgilePoint Configuration.

Procedure

  1. For HostingType, enter OnDemand.
  2. For HostingMechanism, enter WCF.
  3. Set your AgilePoint tenant information.
    TitleAP Setting Value

    ServerInstanceUrl
    Function:
    Specifies the REST URL for your virtual AgilePoint server.

    For more information, refer to Find your AgilePoint Server Instance REST URL.

    Accepted Values:
    A valid REST URL in the following format:

    https://[virtual AgilePoint Server instance host name]:[REST port]/AgilePointServer

    Note: If your AgilePoint Server instance uses HTTPS, to use on-premises SharePoint, the web application for your SharePoint site must be configured to use HTTPS.
    Default Value:
    None
    Example:
    https://sunres.com:1451/AgilePointServer

    PortalInstanceUrl
    Function:
    Specifies the URL for the AgilePoint NX service in the following format:

    https://[AgilePoint NX portal host name]

    For more information, refer to Find your AgilePoint Server Instance REST URL.

    Accepted Values:
    A valid AgilePoint NX service URL.
    Note: If your AgilePoint Server instance uses HTTPS, to use on-premises SharePoint, the web application for your SharePoint site must be configured to use HTTPS.
    Default Value:
    None
    Example:
    https://sunresportal.com

    TenantName
    Function:
    Specifies the name of your AgilePoint NX tenant.

    For more information, refer to Find your AgilePoint Server Instance REST URL.

    Accepted Values:
    A valid AgilePoint NX tenant name.
    Default Value:
    None
  4. Configure how you want to connect from SharePoint to AgilePoint.
    TitleAP Setting Value

    AdminBindingUsed
    Function:
    Specifies the type of binding used to connect to AgilePoint for administration.
    Accepted Values:
    • WS HTTP - WSHttpBinding_IWCFAdminService
    • Basic HTTP - BasicHttpBinding_IWCFAdminService
    • TCP -  NetTcpBinding_IWCFAdminService
    Default Value:
    TCP

    WorkflowBindingUsed
    Function:
    Specifies the type of binding that is used to connect to AgilePoint to send and receive workflow, or process, information.
    Accepted Values:
    • WS HTTP - WSHttpBinding_IWCFWorkflowService
    • Basic HTTP - BasicHttpBinding_IWCFWorkflowService
    • TCP -  NetTcpBinding_IWCFWorkflowService
    Default Value:
    TCP

    AuthenticationType
    Function:
    Specifies the type of authentication to connect from SharePoint to AgilePoint.

    If you select Salesforce, Windows Azure, or Microsoft 365, you can use single sign-on for AgilePoint, which works through the third-party authentication service. For these options, your authentication credentials are not visible to either AgilePoint or SharePoint.

    If you use your AgilePoint ID, you must enter your AgilePoint authentication credentials as list items in the configuration list.

    Accepted Values:
    Default Value:
    • Microsoft 365 integration - Microsoft 365
    • SharePoint on premises integration - Active Directory

    ImpersonatorDomain
    Function:
    The domain name for the SharePoint impersonator account.
    Accepted Values:
    A valid domain name for your AgilePoint SharePoint Impersonator account.
    Default Value:
    None

    ImpersonatorUser
    Function:
    The user name for the SharePoint impersonator account.
    Accepted Values:
    A valid user name.
    Default Value:
    None

    ImpersonatorPass
    Function:
    The password for the SharePoint impersonator account..

    You must select Encrypted to True to encrypt the value of this setting if you are using AgilePoint NX OnPremises or AgilePoint NX Private Cloud, and your AgilePoint Server instance is configured to use HTTP or HTTPS.

    Accepted Values:
    A valid password.
    Default Value:
    None
  5. (Optional) Configure additional SharePoint settings as necessary.

    For more information, refer to Set the AgilePoint Configuration List for SharePoint Integration On Premises.

    ​
  6. Run the Windows Service Client Utility Tool.