Integrate > On-Premise Bridge Agents and Endpoints > Use endpoints

How to use endpoints

You must add an endpoint for each on-premise application.

  1. Add an endpoint

    1. From the main menu, select Administration > Utilities > Integration. Click the Endpoints tab.

    2. Click Add.

    3. Enter the endpoint details.

      Field Description
      Endpoint type Select the application that you want to use to synchronize data.
      Endpoint name Type a name for the endpoint. Use only Latin letters and spaces.
      Running on agent Select an agent from the drop-down list. These are agents that were installed using the On-Premise Bridge Agent.
    4. Click Add.

  2. Configure an endpoint

    1. From the main menu, select Administration > Utilities > Integration. Click the Endpoints tab.

    2. Click Configure. The Endpoint Configuration dialog box opens.

    3. Enter the endpoint details.

      Select an endpoint type from the list below to show or hide its configuration settings.

      ClosedUCMDB 10.20 and later

      Field Description
      Endpoint name

      The name of the endpoint.

      Note This field is read-only.
      Protocol Select the protocol to be used for connecting to the on-premise UCMDB installation. Valid values are HTTP or HTTPS.
      Host name Type the name or IP address of the on-premise UCMDB server.
      Port Type the number of the port listened to by the UCMDB API. The default is 443.
      Root context Type the root context value of the on-premise UCMDB installation. If no root context has been defined, leave this field with its default value.
      Credentials Choose the credentials to be used to connect to the UCMDB installation from the drop-down list. The full credentials are those defined as part of the agent to which the endpoint is connected.
      Probe name Type the name of the UCMDB probe on which to run the synchronization. The default is Integration Service.
      Probe domain The domain of the probe as defined in UCMDB.
      Sync content Select whether to synchronize only infrastructure records, or infrastructure and business records.
      Customer name Type the customer name.
      Remote machine state Select the state with which you want to connect when integrating with multi-state UCMDBs. Valid values are Actual State or Authorized State. The default is Actual.
      Custom sync Check this check box to run in custom synchronization mode. Automatic synchronization mode is the default mode.
      Additional field customization

      You can define additional fields to synchronize. Click Add to add a row for each additional set of fields. Select the Service Management record type and field from the drop-down lists on the left and enter the UCMDB CI type attribute name (not the display label) on the right.

      Note The Addtional field customization works for automatic synchronization only.

      For more information, see Identification and synchronization and How to set up automatic synchronization with UCMDB.

      ClosedKnowledge Indexing

      Field Description
      Endpoint name

      The name of the endpoint.

      Note This field is read-only.
      Indexing shared folder Specify the shared folder that the IDOL connector uses to save files.

      ClosedEmail Integration

      Caution  

      • Do not use the same email account for testing as will be used in your production environment. An email that is processed in your development environment will not be processed again in your production environment.
      • Each endpoint must use a unique email account, even on the same tenant.
      Field Description
      Mail server connection configuration
      Endpoint name

      The name of the endpoint.

      Note This field is read-only.
      IMAP/POP3 server Type the name or IP address of the IMAP or POP3 server.
      SMTP server

      Type the name or IP address of the SMTP server.

      Note To send emails using SMTP protocol, you must have STARTTLS enabled. This means that you must configure an appropriate trust store so that the client will trust the server's certificate. If STARTTLS is not enabled, error messages might not be sent in cases where there was an error in handling emails.
      Read messages protocol Select the protocol for to be used for reading emails. Both IMAP and POP3 protocols are supported. For a secure protocol, select IMAPS or POP3S.
      Credentials Choose the credentials to be used to connect to the email server from the drop-down list. The full credentials are those defined as part of the agent to which the endpoint is connected.
      Advanced Connection Configuration
      Proxy host Type a valid address for the proxy server.
      Proxy port

      Type the number of the port listened to by the proxy server (specified in the Proxy host field). The default is 1080.

      Note Leave this field blank if you are not using a proxy server.
      IMAP/POP3 port

      Type the number of the port listened to by the email server. The defaults are:

      • IMAP, non-secured - 143
      • IMAP, secured - 993
      • POP3, non-secured - 110
      • POP3, secured - 995
      SMTP port

      Type the number of the port listened to by the email server. The default is 25.
      Authorized email domains Specify the email domains that are authorized to send emails to the email account specified for the integration. Emails from unauthorized domains will be rejected. The email account specified for the integration is authorized by default. If a user wants to add additional domains, specify them here, separated by commas.
      Integration configuration
      New email action

      Specify how the receipt of the first email message will be handled:

      • Create request mode - each initial message automatically results in the creation of a new request.
      • Sent knowledge article and offering suggestions mode - each initial message receives an email response that contains possible suggestions.
      Inbox poll interval (minutes) Choose the frequency for the email server to be polled for messages from the drop-down list. The default value is 1 minute.
      Processed emails folder Specify the folder in the email account to which processed messages will be moved.
      Error emails folder Specify the folder in the email account to which messages with errors will be moved.
      Offering

      Specify the default offering to be used when a request is created.

      This field appears only when the New email action field is set to Create request. Offerings matching the following conditions are listed:

      • The status of an offering is Active or Internal.

      • The status of an offering’s service is Active.

      • The value of the IsAllowCreateRequestWithEmail field for the offering is True.

      Note After configuring an email integration endpoint for the first time, it may take up to 30 minutes for the task to start.

      ClosedRest Executor 1.0

      Field Description
      Endpoint name

      The name of the endpoint.

      Note This field is read-only.
      Location Type the URL of the remote server to which you want to direct the REST call, including the protocol, host, port and root context, if any.
      Credentials

      Select credentials to be used for the authentication of the remote server.

      Note If a text field appears, insert the credential ID manually.

      ClosedOperations Orchestration 10.02 and later

      Field Description
      Endpoint name

      The name of the endpoint.

      Note This field is read-only.
      Location

      Type the URL of the Operations Orchestration server in the format

      http://<server>:<port>

      Credentials

      The list of credentials is populated automatically. Service Management queries the OPB agent for the list of credential records that were created in the Endpoint Credentials Manager.

      If no credentials are received, there may be a problem with agent setup and authentication with Operations Orchestration.

      ClosedPPM Outbound Integration

      PPM Outbound Integration

      Field Description
      Endpoint name

      The name of the endpoint.

      Note This field is read-only.
      Location Type the base URL of the PPM server to be synchronized with Service Management.
      Credentials

      Select credentials to be used for the authentication of the PPM server.

      Note If a text field appears, insert the credential ID manually.
      Enable manual sync Select Yes or No. If Yes is selected, the Sync now button appears in each idea and proposal record for you to manually synchronize each record to the PPM server. If No is selected, the record-level synchronization function is disabled.

      ClosedPPM Optimization Solver

      PPM Optimization Solver

      Field Description
      Endpoint name

      The name of the endpoint.

      Note This field is read-only.
      Path

      Enter the path to the installation of the COIN-OR Optimization Suite on your local computer.

      The default path is: C:\Program Files (x86)\COIN-OR\1.8.0\win32-msvc12\bin\cbc.exe
      Timeout Specify a numeric timeout value for the optimization. The recommended value is 30 (seconds).

      ClosedLDAP Integration

      Field Description
      Connection configuration
      Endpoint name

      The name of the endpoint.

      Note This field is read-only.
      Host name Enter the name or IP address of the LDAP server.
      Port

      Enter the number of the port listened to by the LDAP server. The default is 389.
      Credentials

      Enter the credentials used to connect to the LDAP server. The full credentials are those defined as part of the agent to which the endpoint is connected.

      On the Microsoft Active Directory server, both Distinguished name and username login are supported. On the Apache DS server, only Distinguished name login is supported.
      Scheduled integration interval

      Select the interval between successive runs of the integration. The default value is 1 day.

      For example, if the current sync finishes at 10:00 AM on Monday, and the Scheduled sync interval is 1 day, the next sync will run at 10:00 AM on Tuesday.
      Use SSL Encryption

      Select this check box to run the sync using SSL encryption.

      Note Encryption is supported using TLS v1.1 and TLS v1.2 for Microsoft Windows 2008 R2 and above only.
      Integration configuration
      LDAP Server type

      The supported LDAP server types are:

      • Microsoft Active Directory 2008
      • Microsoft Active Directory 2012
      • Apache DS 2.0
      Starting search directory The root directory on the LDAP server where the data is stored.
      Record to record mapping
      Target record Select Person or Group.
      Source record Enter the corresponding record type from LDAP.
      Filter

      The default filter is based on the selected record type (person or group). You can enter a custom filter to specify the relevant records for the integration.

      Example:

      To sync all people from groups 1 and 2 only, enter: (&(objectClass=person)(&(group=group1)(group=group2))).

      To sync all people in either level 1 or level 3, enter:(&(objectClass=person)(|(level=level1)(level=level3))).
      <Field mappings>

      In each section, complete the following:

      • Target fields. Select the record fields from Service Management to be mapped.

        If you select a field of type Enum, click the arrow button next to Map values. Select the target values from the drop-down list and enter the source values from LDAP. Click Add map value to add additional value mappings.

        Note It is possible to map multiple source values to the same target value.

      • Source fields. Enter the corresponding fields from LDAP for the mapping. You can enter the fields in simple text or an Expression Language phrase.

        Click the Expression Language button to toggle between these options. When the button is selected (green), the field is in Expression Language mode. When it is not selected (white), the field is in Simple mode. For a full list of Expression Language functions, see Expression Language functions and syntax.

      • Mapping condition. Optionally, enter an Expression Language phrase defining a condition. The mapping applies only when the condition is satisfied.

      In each section, three default fields are provided. Click Add field to add additional field mappings. Click Remove next to any mapping to remove it.

      Important You must include mappings for all fields defined as mandatory for the selected record type.

    4. For UCMDB, Operations Orchestration, Email integration, PPM Outbound Integration, and LDAP integration, you can click the Test connection button to test the connection to the server.

      Note For Operations Orchestration, a test connection task is executed automatically when you save the configuration.

    5. When you are finished, click Save.

  3. Manage your endpoints

    Select an endpoint in the Endpoints pane to manage it.

    You have the following options for managing your endpoints:

    Label Description
    Set as default Specifies that the selected endpoint will be used by default in future synchronizations for the specified endpoint type. If a task is submitted without specifying a target endpoint, the default will be used.
    Disable/Enable Disables or enables the selected endpoint. If you disable an endpoint, no new tasks can be submitted to it. If you disable an endpoint that has running tasks on it, the tasks will continue to run.
    Remove Removes the selected endpoint from the list of endpoints. You can remove an endpoint only if all tasks on it have completed.
    Refresh Refreshes the list of tasks.
    Stop/Start

    For email integration endpoints only

    • Stop. Stops the polling of the mail server for email integrations. The task continues to run, but no emails are retrieved from the mail server.
    • Start. Restarts the polling of the email server, according to the value set for the Inbox poll interval in the endpoint configuration.

    Note If any values of the email integration endpoint are changed without stopping and restarting the polling, it might take up to 30 minutes for the new values to take effect.

  4. Configure a proxy for an endpoint type if necessary.

    You can configure a proxy for the On-Premise Bridge endpoint types (domains) in the <Agent Folder>\product\conf\wrapper-custom.conf <Agent_installation_directory>/product/conf/wrapper-custom.conf configuration file.

    The following parameters are available for the proxy:

    1. opb.all.executors.params. Contains the environment variables for all the executors.
    2. opb.executor.<specificDomainName>.params. Contains the environment variables for executor of a specific domain. It overrides similar parameters from the opb.all.executors.params.
    3. opb.executor.<specificDomainName>.remote.debug.params. Contains the remote debug parameters for executor of a specific domain.

    In the following example, we add a proxy configuration for all the domains, and override the ports only in the RestExecutorDomain-1.0 domain:

    -Dopb.all.executors.params="-Dhttp.proxyHost=web-proxy.isr.microfocus.com -Dhttp.proxyPort=8080 -Dhttps.proxyHost=web-proxy.isr.microfocus.com -Dhttps.proxyPort=8080"

    -Dopb.executor.RestExecutorDomain-1.0.params=”-Dhttp.proxyHost=web-proxy.isr.microfocus.com -Dhttp.proxyPort=9999 -Dhttps.proxyHost=web-proxy.isr.microfocus.com -Dhttps.proxyPort=9999"

    In this example, we add a remote debug configuration for the executor process of the RestExecutorDomain-1.0 domain:

    -Dopb.executor.RestExecutorDomain-1.0.remote.debug.params=”-agentlib:jdwp=transport=dt_socket,server=y,address=8000,suspend=n”

Related topics