An HTTP connection is configured using the HTTP connector, establishing access to an HTTP or HTTPS web service (including RESTful web services). Once a connection is established, you can configure one or more HTTP activities associated with that connection to be used either as a source to provide data to an operation or script, or as a target to consume data in an operation or script.
Creating or Editing an HTTP Connection
From the design canvas, open the Connectivity tab of the design component palette:
To configure a new HTTP connection, use the Show dropdown to filter on Connectors, and then click the HTTP connector block:
To configure an existing HTTP connection, use the Show dropdown to filter on Endpoints, and then double-click the HTTP connection block:
These open the configuration screen for the HTTP connection, covered next.
Configuring an HTTP Connection
Configuration of an HTTP connection includes these fields:
- Endpoint Name: Enter a name to use to identify the HTTP connection. The name must be unique for each HTTP connection and must not contain forward slashes (
/) or colons (
:). As a specific connection and its activities are referred to as an endpoint, this name is also used to identify the HTTP endpoint.
Base URL: Enter a valid base URL for the connection. To use SSL encryption, simply use
https://in the URL. Do not include any query parameters or paths unless they will be used for all associated activities (You will be able to specify unique paths and parameters during activity configuration.). The final URL will be concatenated from the Base URL provided here along with any paths specified during activity configuration.
Username & Password: If applicable, enter a username and password that will allow access to the HTTP server. You can leave these fields blank for anonymous authentication if no username or password is required.
Certificate: Use the dropdown to select an available certificate to authenticate with the HTTP server.
Retry: Available only when using an environment associated with a Private Agent Group, this setting is used to retry a request when an HTTP endpoint returns one of these status codes:
In order for this setting to take effect, Private Agents must be version 10.22 or higher. With earlier agent versions, the configuration of this setting will be ignored without an error.
Select the checkbox to expand additional configuration options:
- Retry Interval (Seconds): Enter the number of seconds (maximum of 5) to wait between resending a request to the HTTP endpoint.
- Max Retries: Enter the number of times (maximum of 5) that a request will be resent to NetSuite. If the request still fails after the maximum number of retries, an exception with an error message will be returned in the operation log. In addition, the Private Agent log file
jitterbit.logwill log each retry.
Each retry is treated as part of the same operation run, where only a single record appears in the operation log. Any operation actions configured to run downstream operations are triggered based on the end status of the operation after retrying up to the maximum number of retries.
Optional Settings: Click to expand additional optional settings:
Security Option: If applicable, select Use Basic HTTP Authentication to authenticate with the host using basic HTTP authentication without SSL encryption. Note that if this option is used, the provided password will be sent in clear text. (Unless required, this is not recommended.)
If this option is not used, by default Jitterbit Harmony will negotiate with the endpoint to determine which authentication methods are supported, and use the provided credentials against one of the protocols. In addition to HTTP Basic, Jitterbit Harmony supports these HTTP authentication options:
HTTP Digest with authentication with an IE flavor
Ignore Lines: If there are headers and/or footers in the data, enter the number of lines to ignore in the First and Last fields. The system will ignore these lines in the source.
Proxy Settings: If you want to specify a custom proxy, you can do so here. Use the dropdown to select one of these options:
Default: Proxy settings are enabled, using the Private Agent proxy configuration if one exists. If proxy settings are not specified in the agent configuration, then the Default setting has the same result as the Disable setting.
Disable: Proxy settings are disabled for this specific connection, bypassing the Private Agent proxy configuration if one exists.
Custom: Proxy settings are enabled for this specific connection using custom information provided here. This option bypasses the Private Agent proxy configuration if one exists, and instead uses custom proxy information. When Custom is selected, additional fields become available for you to configure. For details on these fields, see Enabling Proxy for Private Agents.
Advanced HTTP Properties: If applicable, set these advanced options:
Content-Type: Enter the content-type of the request structure that is expected by the particular API. If the method being used does not accept structured data, or if the API does not require the content-type to be specified, you can leave this field blank. Examples of content-types include
Enable content encoding: If selected, the "Accept-Encoding" header will be sent with the encoding supported by Jitterbit Harmony. Currently Gzip is supported. This option is off by default.
Enable chunked transfer encoding: If selected, the "Transfer-Encoding: chunked" header will be sent. Use this option if you are transferring large data sets. This option is off by default.
Send expect 100-continue: If selected, the "Expect: 100-continue" header will be sent. With this option, no data will be sent until the HTTP server has validated the headers. Use this option if you are sending large amounts of data but don't want to use chunked transfer encoding. This option is off by default.
Allow weak ciphers: Select this checkbox to communicate with HTTP servers that use weak ciphers (DES/3DES and RC4). This option is off by default.
HTTP accept encoding GZip: Selected by default, this option tells the HTTP server that Jitterbit Harmony can accept a Gzip-compressed response. In return, Harmony will follow the RFC 1952 standard and automatically decompress Gzip HTTP responses. If the server does not use Gzip, Harmony will see that the response is not compressed and handle it as usual.
Only applicable when using HTTPS: Use the dropdown to select a specific SSL version if the HTTP server requires it. The default is “Negotiate.”
Request Headers (one line per header): Any text entered in this box will be sent as an HTTP header. Specify each header on one line unless the header is wrapped according to the HTTP standard. This field also supports using global variables, project variables, and Jitterbit variables by replacing variables in square brackets
[ ]with their values.
- Test: Click this button to verify the connection. Jitterbit Harmony will do an HTTP GET request with no authorization.
- Save Changes: Click this button to save and close the connection configuration.
- Discard Changes: After making changes to a new or existing configuration, click Discard Changes to close the configuration without saving. A message will ask you to confirm that you want to discard changes.
- Delete: After opening an existing connection configuration, click Delete to permanently delete the connection from the project and close the configuration (see Component Dependencies, Deletion, and Removal).
After configuring an HTTP connection, you can configure one or more HTTP activities associated with that connection to use as a source or target within an operation or script. For more information, see HTTP Activities, which covers GET, PUT, POST, DELETE, and Custom activities.
Last updated: Nov 23, 2020
- No labels