Administrator

Configuring OData Back-end Connections for Agentry Applications

The first time you publish an application from Agentry Editor, the publication process creates initial back-end configuration information, which you must modify using Management Cockpit. Use the OData option for an Agentry application that access an OData back-end service. Certain tasks may or may not pertain to a particular implementation environment and you should perform a careful review of the application’s requirements and functionality before proceeding.

Prerequisites

  • Obtain or generate the URL for the back-end service connection
  • (Optional) Obtain the user name and password for the URL, if required

Procedure

  1. In Management Cockpit, select Start of the navigation path Applications Next navigation step  Next navigation step Configure Next navigation step Back End End of the navigation path.
  2. Under OData, edit OData-related connection settings.
    Definitions Values Descriptions
    Authentication Certificate Store MY Specifies the location of the authentication certificate for the server. This file may be a Certificate file (.cer), Certificate store file (.sst), or Personal Information Exchange file (.pfx). Used only if Listen On is set to a valid port. Requires application restart.
    Authentication Certificate Store Password None The Authentication Certificate Store password. Requires application restart.
    baseURL Valid URL and optional port number (format: http://localhost:81). Default: none The base URL address of HTTP (or OData) requests made by the server for this system connection. Set this option before starting the server.
    basicAuthenticationPassword None The base authentication password.
    basicAuthenticationUserID None The base authentication user identification.
    Constants File Valid file name or path and file name to constants file. Default: odata_sd.ini The constants file used for this system connection. This file contains constant named values that may be referenced by the HTTP (or OData) application components.
    Enable Authentication Enabled by default. Whether users are authenticated against the back-end system for this system connection. At least one system connection within the application must perform user authentication.
    Enable Previous User Authentication   Whether previous users are authenticated against the back-end system for this system connection. This authentication occurs when a user change occurs on the client.
    httpConnectTimeout 60 Time out period, in milliseconds, for this system connection. When the connection attempt exceeds this value, the connection terminates. The timer resets when data is exchanged between server and the back-end system during client synchronization.
    httpReceive Timeout 300 Time out for receiving the response from the remote Web server.
    httpResolve Timeout 60 Time out for resolving the DNS name for a remote connection into an IP address.
    httpSendTimeout 300 Time out for sending a request to the remote Web server.
    listenOn Disabled Port to use for connections to the OData back end by remote systems to trigger system events in Agentry (used for Web service calls). Requires application restart.
    Name Text Value Any text value used to identify the system connection in log files and other areas. This should be set to a unique value especially when working with multiple system connections. Requires application restart.
    Time Zone Name None The time zone to which date and time values are converted when received from clients; or from which they are converted when sent to clients. This conversion is based on the application definitions. This setting is used only to specify a time zone that differs from the back-end system.
    Timeout 300 (seconds) Specifies how long the server will keep a connection open with a client when no messages or responses are received from the client.
    Trusted Certificate Store None Specifies the location of the trusted certificate store for the server. This store is only used when clients are required to provide authentication certificates during synchronization. Used only if Listen On is set to a valid port. Requires application restart.
    useSSL None Whether to use SSL when accepting incoming Web connections. This is used for system event processing for the OData back end, since system events for this back end are connections to Agentry's built-in Web server from remote systems. Used only if Listen On is set to a valid port. Requires application restart.
    xml Namespaces None Registers new XML prefixes (the "<<localNames>>") for XML namespaces that may appear in documents retrieved from remote servers; these prefixes can then be used in XPath expressions that are defined in the Agentry Editor for processing the documents. The format is <<<localName>>>|<<URI>>[|<<localname>>|<<URI>>]*, with as many pairs as needed to define the needed namespaces. Separate each entry using a pipe ( | ) symbol.
  3. Restart the application if you changed any setting that requires it.