Table of Contents

Search

  1. Preface
  2. Understanding Data Types and Field Properties
  3. Designing Processes
  4. Using and Displaying Data
  5. Designing Guides
  6. Designing Process Objects
  7. Designing Service Connectors
  8. Using Connectors
  9. System Services, Listeners and Connectors

2. Design

2. Design

Defining App Connection Properties

Defining App Connection Properties

For each app connection, you enter descriptive properties, identify the scope, and set authentication parameters, if required.
These options display for all app connections:
  • Connection Type
    : From this list, select a published service connector, native toolkit connector (such as JDBC), or web service connector (such as Salesforce). When you create a connection, the connection type that you select determines the connection properties that are displayed.
    After you publish an app connection, you cannot change its connection type.
  • Name
    : Enter a name that identifies an app connection within
    processes
    and in the Designer. The name must contain only letters, numbers, and hyphens.
    Important
    : If you define an app connection to be used for publishing
    processes
    in Salesforce, the
    Connection Name
    must be
    Salesforce
    to ensure that the
    processes
    are accessible to users in Salesforce. Only one Salesforce app connection is permitted for each
    Application Integration
    organization.
  • Description
    : Enter a description to identify an app connection.
  • Run On
    : Select the agent where you want to access a service behind your firewall or select
    Cloud Server or any Secure Agent
    . This list displays the agents available for your organization.
  • Connection Test
    : Displays the results of any connection test run on the Cloud Server or the agent named in the
    Run On
    field.
  • OData Enabled
    : Select
    Yes
    to enable OData feeds. If you select
    Yes
    , you must specify either the allowed users or the allowed groups that can access the connection at design time. You can also enable or disable Cloud access to the OData endpoint URLs.
  • OData Cloud Access Enabled
    : If you enable OData and configure the connection to run on a Secure Agent machine or a Secure Agent group, you can choose to disable Cloud access to the OData endpoint URLs for security purposes.
  • Allowed Roles for OData:
    The roles that have access to this app connection at run time. Users assigned these roles have access to an OData endpoint URL. You can enter a custom role or a system-defined role. You can enter more than one role in this field.
    IMPORTANT
    : If you enter a custom role in the
    Allowed Roles for OData
    field, a user invoking the OData endpoint URL must have or belong to groups that have the custom role and the and Service Consumer role.
    Example:
    Your organization has a custom role, Testers, with the Run privilege enabled for Application Integration. You create a process and enter 'Testers' in the
    Allowed Roles
    field.
    For a user to be able to use the OData endpoint URL, the following conditions need to be met:
    • Condition 1: The user has the Testers role, a role that this app connection requires.
    • Condition 2: The user has the Service Consumer role. Application Integration requires this role to invoke any endpoint URL.
    A user with the Testers role and the Service Consumer role will be able to invoke the OData endpoint URL. This is because
    both
    , Condition 1 and Condition 2, are satisfied.
    A user with
    only
    the Testers role will be unable to invoke the OData endpoint URL. This is because Condition 1 is satisfied but Condition 2 is not satisfied.
    A user with
    only
    the Service Consumer role will also be unable to invoke this OData endpoint URL. This is because Condition 2 is satisfied but Condition 1 is not satisfied.
The remaining properties are determined by the connector or the connection type that you selected.
For example, the Salesforce connection type in the following image requires a
Name
,
Type
,
Authorization URL
, and
Token Request URL
:
The image shows the connection properties for a Salesforce connection.