Account configuration fields

The account configuration screen provides details to connect with the connector. The fields available might vary according to the selected connector.

Server URL
Provide the login endpoint to initiate communication with the SaaS provider.
Username
The user account name on the SaaS provider that the account uses to connect to the SaaS provider.
Password
The password for the username provided in the Username field.
JWT Keystore
Applicable when you select the OAuth V2.0 (JWT Flow) as the authentication type. The keystore used to encrypt the JWT payload. Use the same keystore, which contains the private key of the certificate (public keys) uploaded in your integration.
JWT Key Alias
Applicable when you select the OAuth V2.0 (JWT Flow) as the authentication type. This alias is the value that is used to sign the outgoing request from webMethods Integration to the authentication server. It is auto-populated based on the keystore that is selected in the JWT Keystore field. This field lists all the aliases available in the chosen keystore. Provide a key alias to sign the JWT payload.
Expiration Time (mins)
Applicable when you select OAuth V2.0 (JWT Flow) as the authentication type. Expiration Time (mins) is the time after which the JWT token expires. The generated access token might be valid post expiration time as well.
Access Token
Applicable when you select OAuth V2.0 (Authorization Code Flow) as the authentication type. The token is used for authentication by the authorization server. The access token is passed when you start any of the REST or SOAP API endpoints. The client application is responsible for storing and protecting this token. For the authentication type selected as OAuth V2.0 (JWT Flow), webMethods Integration implicitly gets an access token after you save the account.
Authorization Type
The type of HTTP authorization scheme to use for the connection. If you select none, no additional authorization scheme is run at run time. For example, when you specify a username and password, but do not specify a value for the authorization type, the user credentials are not inserted into an authorization header. If you enter the username and password, then set the authorization type as basic. Basic refers to HTTP basic authentication. The option can be used when the connector requires or supports HTTP basic authentication that uses a username and password.
Session Management
The session management scheme selection determines how a session or access token is handled for any SaaS provider. If you select none, webMethods Integration makes no attempt to refresh an established session or access token that is configured for a given SaaS provider. If you select fixed, webMethods Integration attempts to refresh an established session or access token that is configured for a given SaaS provider, during the next operation, flow service or workflow execution, subject to an interval that is configured by using the Session Timeout (min) field, is exhausted. If you select idle, webMethods Integration attempts to refresh an established session or access token that is configured for a given SaaS provider, during the next operation, flow service or workflow execution, subject to, the connection or session being idle for an interval configured by using the Session Timeout (min) field. If you select auto, webMethods Integration attempts to refresh an established session or access token as specified by a given SaaS provider by using the expires_in field value available in the refresh token response. If the SaaS provider does not provide the expires_in value, then the value that is configured for the Session Timeout (min) field prevails.
Session Timeout (min)
The number of minutes you want webMethods Integration to wait before refreshing a session. The value must be slightly less than the session timeout value specified at the SaaS provider back end.
Note: The Session Management and Session Timeout configurations together determine how the session is managed for any SaaS provider.
Response Timeout
The number of milliseconds webMethods Integration waits for a response before blocking the socket connection to the back end. In case the network is slow or the back end processing takes longer than usual, increase the response timeout value. You can specify a value other than 0. If you specify 0, webMethods Integration waits indefinitely for a response.
Issuer
Applicable when you select the OAuth V2.0 (JWT Flow) as the authentication type. It is the Client ID, or Identifier, or name of the server or system issuing the JWT token.
Subject
Applicable when you select the OAuth V2.0 (JWT Flow) as the authentication type. It is the identifier or the name of the user that this token represents.
Client ID
Applicable when you select the OAuth V2.0 (Authorization Code Flow) as the authentication type. It is a client identifier that is issued to the client to identify itself to the authorization server.
Client Secret
Applicable when you select the OAuth V2.0 (Authorization Code Flow) as the authentication type. It is a secret that is matched to the client identifier.
Refresh Token
Applicable when you select the OAuth V2.0 (Authorization Code Flow) as the authentication type. A token used by the client to obtain a new access token without involving the resource owner.
Refresh URL
Applicable when you select the OAuth V2.0 (Authorization Code Flow) as the authentication type. It is the provider-specific URL to refresh an access token.
Retry Count on Response Failure
The number of times webMethods Integration attempts to retry a request when the initial attempt to read a response fails. If an I/O error occurs, it retries specifically when you have selected the Retry on Response Failure option.
Retry on Response Failure
Whether webMethods Integration must attempt to resend the request when the response fails, even though the request was sent successfully. Select this option when you want to reestablish the connection.
Trust Store Alias
Select the alias name of the webMethods Integration trust store configuration. The trust store contains trusted certificates that are used to determine trust for the remote server peer certificates. You can also add a truststore from this field.
Keystore Alias
Select the alias for the webMethods Integration keystore configuration. It is a text identifier for the keystore alias. A keystore file contains the credentials (private key or a signed certificate) that a client needs for authentication. You can also add a keystore from this field.
Client Key Alias
Alias to the private key in the keystore file that is specified in the keystore alias field. The outbound connections use this key to send client credentials to a remote server. To send the client’s identity to a remote server, you must specify values in both the Keystore Alias and the Client Key Alias fields.
Hostname verifier
Select a hostname verifier implementation. Guards against man-in-the-middle (MITM) attacks. The default is org.apache.http.conn.ssl.DefaultHostnameVerifier, which enables hostname verification. Select org.apache.http.conn.ssl.NoopHostnameVerifier to disable hostname verification.
Use Chunking
Enable this option when you want to send or receive a binary stream with a chunk of 8192 bytes. It is applicable specifically when the back end supports HTTP/1.1 chunking.
Enable SNI
Server Name Indication (SNI) is an extension to the TLS protocol by which a client indicates which host name it is attempting to connect to at the start of the handshaking process. Enable this option if the SaaS provider offers SNI-based TLS connectivity, and if you want to connect to an SNI enabled SAAS provider to send the host name specified in the Server URL field, as part of the TLS SNI extension server_name parameter.
SNI Server Name
If you want to explicitly specify a host name to be included as a part of the SNI extension server_name parameter, in case the host name is other than the host name specified in the Server URL field, specify the host name value in the SNI Server Name field.
Enable Connection Pooling
Select this option when you want to enable connection pooling for a connection. webMethods Integration includes a connection management service that dynamically manages connections and connection pools based on configuration settings that you specify for the connection. A connection pool is a collection of connections with the same set of attributes. Connection pools improve performance by enabling integrations to reuse open connections instead of opening new connections for every service request. When you enable connection pooling, webMethods Integration creates the number of connection instances you specified in the connection’s minimum pool setting. Whenever an Integration requires a connection, webMethods Integration provides a connection from the pool. If no connections are available and the maximum pool limit has not been reached, webMethods Integration creates one or more new connections based on the value specified in the pool increment setting and adds them to the pool. If the pool has reached its maximum limit, the requesting service waits for up to one second for a connection to become available. Periodically, webMethods Integration inspects the pool and removes idle connections that exceeds the expiration period of 1 second.
Minimum Pool Size
The minimum number of connection objects that remains in the connection pool when the connection pooling is enabled. When the connector creates the pool, it creates this number of connections.
Maximum Pool Size
The maximum number of connection objects that can exist in the connection pool when the connection pooling is enabled. When the connection pool reaches its maximum number of connections, the connector reuses any idle connections in the pool. Or, when all the connections are active, it waits for a connection to become available.
Pool Increment Size
The number of connections added to the pool, up to the maximum limit, when connection pooling is enabled and additional connections are required.
Keep Alive Interval
The keep alive interval in milliseconds defines the interval for which a connection is kept alive when the back end does not respond with a Keep-Alive header. A value > 0 keeps the connection alive for the specified value. The default value of -1 implies that the connection is kept alive until a request fails due to a connection error.
Grant Type
Specify the grant type through which applications can gain access tokens and by which you grant limited access to your resources to another entity without displaying the credentials. The authorization code grant type is used by confidential and public clients to exchange an authorization code for an access token. The refresh token grant type is used by clients to exchange a refresh token for an access token when the access token expires.
Idle Timeout
The idle timeout interval in milliseconds defines the interval for which a connection is kept alive when it's not in use. A value > 0 keeps the connection alive for the specified value. The default value of -1 implies that the connection is kept alive until a request fails due to a connection error.
Block Timeout (msec)
The number of milliseconds that webMethods Integration waits to obtain a connection with the SaaS provider before the connection times out and returns an error. For example, you have a pool with maximum pool limit of 20. If you receive 30 simultaneous requests for a connection, 10 requests are waiting for a connection from the pool. If you set the Block Timeout to 5000, the 10 requests wait for a connection for 5 seconds before they time out and return an error. If the services that use the connections require 10 seconds to complete and return connections to the pool, the pending request fails and returns an error message stating that no connections are available. If you set the block timeout value too high, you might encounter problems during error conditions. If a request contains errors that delay the response, other requests are not sent. The setting must be tuned along with the maximum pool limit to accommodate such bursts in processing.
Expire Timeout (msec)

The number of milliseconds an idle connection can remain in the pool before it is closed and removed when connection pooling is enabled. The pool continues removing idle connections until the total number of connections equals the Initial Pool setting. The inactivity timer for a connection is reset when the connection is used by the connector. This setting must be tuned along with the initial pool limit to avoid excessive opening and closing of connections during normal processing. The general recommendation is to keep the expire timeout value equal to the Session Timeout value.

Streaming Server URL
You can bring your data into Adobe Experience Platform through streaming ingestion. Streaming ingestion allows you to send data from client and server-side devices to the Adobe Experience Platform in real time. After registering a streaming connection that you have a unique URL, which can be used to stream data to the Platform. The base path for streaming ingestion API for data collection is - https://dcs.adobedc.net/.
Organization ID
The issuer, organization ID from the Adobe I/O Console integration, in the format org_ident@AdobeOrg. Identifies your organization that is configured for access to the Adobe I/O API.
Technical Account ID
The subject, your technical account ID from the Adobe I/O Console integration, in the format - id@techacct.adobe.com.
Audience
The audience for the token, your API Key from the Adobe I/O Console integration, in the format - https://ims-na1.adobelogin.com/c/api_key.
Sandbox Name
Adobe Experience Platform provides virtual sandbox environments, which provide isolation and access control for Platform integrations. When making calls to Experience Platform APIs, a sandbox name must be supplied under the header x-sandbox-name. Provide the name of an available sandbox for your organization, for example, prod. The sandbox name must consist exclusively of lowercase alphabetic characters and function as a valid identifier.
Region
An area-specific value.
Signing Algorithm
Explicitly select the signing algorithm, for example, HMAC-SHA1 Signatures that are used to sign the message.
Authorization Token
The Alfabet Authorization Token as defined in the web.config file of the Alfabet Web Application on the server side, under the alfaSection element.
Wait For Continue Time
The number of milliseconds that the client connection must wait for a 100 Continue response from the server when the Expect/Continue handshake is used.
Strict Transfer Encoding
Whether the connection validates the HTTP Transfer Encoding header Valid values.
  • true- The connection validates the Transfer Encoding header and returns an error when the header is invalid.
  • false- The connection does not validate the Transfer Encoding header.
X-COUPA-API-KEY
The API Key received from the user account. Coupa REST APIs authentication requests require a unique API key that is generated in Coupa. All API requests must pass an X-COUPA-API-KEY header with an API key. A key can be created from the API Keys section of the administration tab by an administrator. The key is a 40-character long case-sensitive alphanumeric code. The API key is associated with an API user who is the equivalent of an administrator in Coupa. Any changes to resources through the API are attributed to the API user.
Use CSRF Token
To prevent cross-site request forgery, SAP C4C protects its resources by using a CSRF token. Select this option if you want webMethods Integration to use the CSRF token key, received in the response from SAP C4C, to run any state-changing requests on SAP C4C. By default, the SAP C4C back end enables the CSRF token. Enable this option particularly when the entity state-changing operation is started.
Metadata Caching
Select this option when you want the SAP C4C Application to cache the backend metadata. Caching of the metadata significantly increases the performance of a request that is sent through SAP C4C. If this option is selected, the cache is refreshed every 12 hours. You can enable the metadata cache to increase the performance.
Validate Metadata
Whether to validate the $metadata xml during edm object creation. Select this option to enable the metadata validation.
Shopify API key
Shopify REST APIs authentication requests require a unique API key that is generated in Shopify. All API requests must pass an X-Shopify-Access-Token header with an API key.
Company ID
The company ID that SuccessFactors provided when your company registered with them.
PubId
Enter the PubId (Profile ID) associated with your AddThis account. Refer this link to find your PubID (profile ID of AddThis).
API Key
Enter the API key associated with your AddThis account. Refer this link to retrieve the API key associated with your AddThis account.
Domain
Enter the domain for your Aha account. If your account URL is https://example.aha.io, enter example.aha.io as the domain.
Signing Algorithm
The signing algorithm to use for an outbound AS2 message. The available options are MD5, SHA-1, SHA-256, SHA-384, and SHA-512.
Receive Signed Message
Select this option to receive a signed inbound AS2 message. If you select this option and the incoming AS2 message is not signed, then an insufficient message security error is encountered and shared with the sender if the sender requests the MDN.
Signature Verification Certificate
The certificate to use for verifying an inbound signed AS2 message.
Encrypt Message
Select this option to encrypt an outbound AS2 message.
Encryption Algorithm
The encryption algorithm to use for an outbound AS2 message.
Encryption Certificate
The certificate to use for encrypting an outbound AS2 message.
Decryption Keystore and Key Aliases
The keystore aliases and the key aliases in the keystore are to use for decrypting an inbound AS2 message.
Request MDN

Whether you want the recipient to return an MDN to the sender. Select one of the listed options.

  • None- The recipient of the AS2 message does not return an MDN to the sender.
  • Synchronous- The recipient of the AS2 message returns an MDN to the sender through the same HTTP connection that is used to send the original AS2 message.
  • Asynchronous- The recipient of the AS2 message returns an MDN to the sender through a different HTTP connection instead of the one used to send the original AS2 message.
Request Signed MDN
Select this option when you want the recipient to sign an AS2 MDN. Also select an option in the Request MDN field if you want the recipient to sign and return an AS2 MDN.
Asynchronous MDN Endpoint
Type your endpoint URL that accepts an inbound AS2 MDN if you selected the Asynchronous option for Request MDN.
AS2 Version
Select the AS2 protocol version to use from the list.
Language Translator Service API Key
Enter the language translator service API key of your account.
Community
URL of the igloo community to log in to, for example, https://{your_domain}.igloocommunities.com.
Auth Source
Specify the name of the MongoDB database against which you want to authenticate the user.
Replica Set
Enter the replica set for the specified database.