HTTP - Define
Declaration
<AMHTTP ACTIVITY="define" SESSION="text (options)" BASEURL="text" AUTHENTICATION="text (options)" USERNAME="text" PASSWORD="text (encrypted)" TOKEN="text" KEY="text" VALUE="text" AUTHURL="text" TOKENURL="text" CLIENTID="text" CLIENTSECRET="text" SCOPE="text" PORT="number" PERSIST="text (encrypted)" CERTIFICATE="text" CERTIFICATEPASSPHRASE="text (encrypted)" IGNOREINVALIDCERTIFICATE="YES/NO" VERSION="text (options)" SSLVERSION="text (options)" CONTENTTYPE="text" USERAGENT="text" TIMEOUT="number" MEASURE="text (options)" COOKIE="text (options)" COOKIEFILE="text" OVERWRITECOOKIEFILE="YES/NO" ENCODEURL="YES/No" PROXYTYPE="text (options)" PROXYSERVER="text" PROXYPORT="number" PROXYUSERNAME="text" PROXYPASSWORD="text (encrypted)"><HEADER NAME="text" VALUE="text" /><COOKIE NAME="text" VALUE="text" /></AMHTTP>
Description
Creates and stores a predefined connection to share with other HTTP activities.
Practical usage
Used to create a predefined connection to share with other HTTP activities, rather than duplicating and storing those settings within each individual HTTP activity.
Parameters
General
Property | Type | Required | Default | Markup | Description |
---|---|---|---|---|---|
Connection Name | Text | Yes | HttpSession1 | SESSION="HttpSession1" | Specifies the name of the predefined connection to create. |
Base URL (optional) | Text | No | (Empty) | BASEURL="www.google.com" | Specifies the base URL on the server to use with the connection. This parameter is optional. |
Authentication type | Text (options) | No | None |
|
Specifies the type of authentication to use. The available options are:
|
Test URL | Text | No | (Empty) | N/A | If an Authentication type is selected, a test connection to the server can be executed using an HTTP GET request. Enter a URL on the server, the requested credentials, and then click Test Connection. The server will return a message. This parameter is optional and is not used in runtime. |
Username | Text | Yes, if Authentication type is set to Basic, Digest, or NTLM | (Empty) | USERNAME="Coolguy" | A valid user name to use during authentication. This parameter becomes active and is required if Authentication type is set to Basic, Digest, or NTLM. |
Password | Text | Yes, if Authentication type is set to Basic, Digest, or NTLM | (Empty) | PASSWORD="encrypted" | The password to use during authentication. If created in visual mode, this value is automatically encrypted. This parameter becomes active and is required if Authentication type is set to Basic, Digest, or NTLM. |
Token | Text | Yes, if Authentication type is set to Bearer Token | (Empty) | TOKEN="ServerAuthorizationToken" | The server generated bearer token to use during authentication. This parameter becomes active and is required if Authentication type is set to Bearer Token. |
Key | Text | Yes, if Authentication type is set to API Key | (Empty) | KEY="ServerAuthorizationKey" | The server generated API key to use during authentication. This parameter becomes active and is required if Authentication type is set to API Key. |
Value | Text | Yes, if Authentication type is set to API Key | (Empty) | VALUE="ServerAuthorizationValue" | The server generated API key value to use during authentication. This parameter becomes active and is required if Authentication type is set to API Key. |
Authorization URL | Text | Yes, if Authentication type is set to OAuth 2.0 | (Empty) | AUTHURL="https://accounts.google.com/auth" | The authorization URL to use during authentication. This parameter becomes active and is required if Authentication type is set to OAuth 2.0. |
Access Token URL | Text | Yes, if Authentication type is set to OAuth 2.0 | (Empty) | TOKENURL="https://accounts.google.com/token" | The access token URL to use during authentication. This parameter becomes active and is required if Authentication type is set to OAuth 2.0. |
Client ID | Text | Yes, if Authentication type is set to OAuth 2.0 | (Empty) | CLIENTID="ServerGeneratedID" | The client ID to use during authentication. This parameter becomes active and is required if Authentication type is set to OAuth 2.0. |
Client Secret | Text | No | (Empty) | CLIENTSECRET="encrypted" | The client secret to use during authentication. This parameter becomes active and is optional if Authentication type is set to OAuth 2.0. NOTE: Not all servers require a secret to accompany the client ID. |
Authorization Scope | Text | No | (Empty) | SCOPE="https://www.googleapis.com/profile" | Specifies the authorization scopes to limit access to resources on the server. This parameter becomes active and is optional if Authentication type is set to OAuth 2.0. |
Local machine callback listening port number | Text | Yes, if Authentication type is set to OAuth 2.0 | 8080 | PORT="8080" | Specifies the open port number on the local machine for Automate Desktop to use to receive the access token. This parameter becomes active and is required if Authentication type is set to OAuth 2.0. |
Persist Token | Text | No | Yes | PERSIST="GUID" | If selected, writes the token information to disk to persist the OAuth 2.0 connection to the server. This parameter becomes active and is optional if Authentication type is set to OAuth 2.0. |
Credentials
Property | Type | Required | Default | Markup | Description |
---|---|---|---|---|---|
Certificate file | Text | No | (Empty) | CERTIFICATE="C:\Temp\certFile.pfx" | The
path and file name of the certificate file used to validate connection.
Click the folder icon to navigate to the specified certificate
file or enter the path and file name manually. Enter this information
if a Certificate Authority (CA) is used to identify one end or
both end of the transactions. Automate Desktop supports the following
certificate file types:
|
Passphrase | Text | No | (Empty) | CERTIFICATEPASSPHRASE="encrypted" | The passphrase to use to authenticate the connection. A passphrase is a password that may comprise of a whole phrase. |
Ignore invalid server certificate | Yes/No | No | No | IGNOREINVALIDCERTIFICATE="YES" | If selected, specifies that this action ignores invalid certificates while connecting to a server using SSL. This option is disabled by default. |
Advanced
Property | Type | Required | Default | Markup | Description |
---|---|---|---|---|---|
Protocol version | Text (options) | No | HTTP 1.1 |
|
Specifies the
protocol version to use. The available options are:
|
Content type (optional) | Text | No | (Empty) | CONTENTTYPE="text/html" | The content type and subtype of the text or file to use with the intended request (for example, application/zip, text/csv, image/jpeg). |
SSL version | Text (options) | Yes |
TLS1, TLS1.1, TLS1.2, TLS1.3 |
|
Specifies the versions of SSL (Secure Sockets Layer) and/or TLS (Transport Layer Security) protocols to use to secure the connection to the server. To select multiple versions, manually enter and separate each version with a comma (see default setting). The available options are:
NOTE: For compatibility with most sites, it is recommended to use the default TLS1,TLS1.1,TLS1.2, TLS1.3 setting for this parameter. However, older sites may require SSL2 and/or SSL3. |
User agent | Text (options) | Yes | AutoMate | USERAGENT="text" | The user agent originating the request. A website may require a User Agent string to be sent to it for statistical purposes, tracing of protocol violations, and automated recognition of user agents for the sake of tailoring responses to avoid particular user agent limitations (the default User Agent entered is AutoMate). |
Timeout | Number | No | 100 | TIMEOUT="50" | The maximum time that the step should wait for a response from the HTTP server before failing with a time out error. It may be useful to increase this value when posting extremely large amounts of data or if waiting for a long transaction to complete. (default value is 100 seconds). |
Measure (unlabeled) | Text (options) | No | Seconds |
|
The
time measurement that should correspond to the value entered in
the Timeout parameter.
The available options are:
|
Cookies permission | Text (options) | No | Block |
|
Specifies
how this activity handles cookies sent to/from the server.
The available options are:
NOTE: HTTP cookies are used for authenticating, session tracking (state
maintenance), and maintaining specific information about users. |
Encode URL | Yes/No | No | No | ENCODEURL="YES" | Encodes the URL by converting non-compliant characters to ASCII format (for example, a space in a URL is converted to %20). |
Cookie file | Text | No | (Empty) | COOKIEFILE="c:\theFile" | The cookie file to use with this activity to identify and/or authenticate a server-based session. Cookies can be stored in different locations, depending on the version of explorer and Windows you are using. This parameter is not available if the Cookies to/from file parameter is set to Block. |
Overwrite cookie file | Yes/No | No | No | OVERWRITECOOKIEFILE="yes" | HTTP requests and responses are written to the same cookie file. By default, new request/response data is appended at the end of the cookie file as a new line. If this parameter is selected, new request/response data will overwrite existing data. Overwriting is a good way to minimize the size of a cookie file. This parameter is disabled by default. |
Request header(s) | Text | No | (Empty) |
|
Allows
entry of custom HTTP headers to the request. Required parameters
are:
|
Request cookie(s) | Text | No | (Empty) |
|
Allows
entry of custom HTTP cookies to the request. Request cookies can
be used in conjunction with cookie files. Required parameters
are:
|
Proxy type | Text (options) | No | System default |
|
Specifies the proxy type for Automate Desktop to use
when attempting network communications through a proxy server. The available options are:
NOTE:
|
Proxy server | Text | Yes, if Proxy type is set to SOCKS 4, SOCKS 4A, SOCKS 5, or HTTP | (Empty) |
|
The hostname (server.domain.com) or IP address of the proxy server. This parameter is only available and required if the Proxy type parameter is set to SOCKS 4, SOCKS 4A, SOCKS 5, or HTTP. |
Proxy port | Number | Yes, if Proxy type set to SOCKS 4, SOCKS 4A, SOCKS 5, or HTTP | 1028 | PROXYPORT="3000" | The proxy port number to use to connect to the proxy server. Most proxy servers operate on port 1028 ( default), however, a proxy server can operate on other ports. This parameter is only available and required if the Proxy type parameter is set to SOCKS 4, SOCKS 4A, SOCKS 5, or HTTP. |
Proxy username (optional) | Text | No | (Empty) | PROXYUSERNAME="username" | The username to use to authenticate when connecting through the proxy server. This parameter is only available if Proxy type is set to SOCKS 5 or HTTP. |
Proxy password (optional) | Text | No | (Empty) | PROXYPASSWORD="text (encrypted)" | The password corresponding with the Proxy username parameter to use to authenticate when connecting through the proxy server. This parameter is encrypted in Task Builder. This parameter is only available if Proxy type is set to SOCKS 5 or HTTP. |
Example
- Copy and paste the sample AML code below directly into the Task Builder Steps Panel.
- To successfully run the sample code, update parameters containing user credentials, files, file paths, or other information specific to the task to match your environment.
Description
Using a predefined connection with the GET request, this sample task gets content from the server and then displays result data, request header information, and response header information in a dialog. Then, the task clears the connection information.
<AMVARIABLE NAME="myVar" VALUE="" />
<AMHTTP ACTIVITY="define" SESSION="HttpSession1" AUTHENTICATION="basic" USERNAME="myUsername" PASSWORD="AM5oDoxAdt+QDxeXhPeW9NBCmdsy6+Csc4EVMzS49H547I=aME" IGNOREINVALIDCERTIFICATE="YES" />
<AMHTTP SESSION="HttpSession1" URL="http://www.fortra.com" RESULTDATASET="myDataset" RESULTVARIABLE="myVar" />
<AMSHOWDIALOG>Request Header Info - %myDataset.RequestHeader%Response Header Info - %myDataset.ResponseHeader%</AMSHOWDIALOG>
<AMHTTP ACTIVITY="clear" SESSION="HttpSession1" />