Put process

The Put process, like the Post process sends data to a specified URL. Also, the Put process can send a data file to the URL.

The following table describes the process inputs for the HTTP adapter with the Put process.

Put process inputs

Input

Description

Required

<adapter name>

Specifies the name of the adapter to use for this process

Default value: HTTPAdapter

No

<url>

Specifies the URL defining the location of the content to be sent

Default value: None

Yes

<data format>

Specifies the format of the data

Valid values: HTML_DATA_FORMAT (default), XML_DATA_FORMAT

Yes

<use ssl certificate>

Specifies whether to establish a secure connection

Set the value of this element to true when url uses HTTPS.
Set the value of this element to false or leave it blank when url uses HTTP.

Valid values: true, false (default)

No

<allow unsigned certificate>

Specifies whether to allow unsigned certificates from trusted zones

Set the value of this element to true, if you are using self-signed SSL certificates (a common practice).

On ecommerce sites or military installations, if you need to use signed
certificates such as Verisign or Thawte, set the value of this element to false (a rare practice).

Valid values: true, false (default)

No

<install certificate>

Specifies whether to install certificates

Set the value of this element to true if you prefer to have security certificates installed automatically (a common practice). Set the value of this element to false if you prefer to manually export the security certificate from the specified target server and manually import it into the BMC Atrium Orchestrator's local peer's cacerts file (a rare practice).

Valid values: true, false (default)

No

<pass phrase>

Specifies the Java Standard Trust Key Store passphrase

Warning

  • The value of the <passphrase> element is the passphrase for the cacerts certificate stored on the BMC Atrium Orchestrator local peer (CDP or AP) and not the specified target host.
  • Changing the passphrase can be tricky and might destroy the cacerts security file integrity.



Verify the cacerts passphrase using the following command in UNIX or Linux:

$ /opt/bmc/ao/cdp/jvm/bin/keytool -list -keystore
/opt/bmc/ao/cdp/jvm/lib/security/cacerts

Default value: changeit

No

<user name>

Specifies the user name to be used for basic authentication

No

<password>

Specifies the password corresponding to the user name provided for basic authentication

No

<data>

Specifies the information to be sent

No

<file path>

Specifies the local path of the file (including the file name) to be sent over the URL

For example,
Windows:

C:\\adapters\\testfile.txt


UNIX or Solaris: //home//user//testfile.txt

No

<file content type>

Specifies the content type of the file being uploaded

Default value: Plain

Conditional; used if the adapter request contains a <file-path> element

<connection properties>

Includes an XML document for the http connection properties to specify the user name and password for basic authentication and to set the information in the HTTP request header before executing the http request

Note

user name and password properties are not set in request header and properties are case sensitive.

For example:
<http-connection-properties>
<Content-Type>text/html</Content-Type>
<Accept>Yes</Accept> <Blob></Blob>
</http-connection-properties>

No

<character-set>

Specifies the supporting CharSet

Also called character set, it includes identifiers describing a series of universal characters.

Note

If you do not specify the supporting character set, the adapter response is parsed based on the character set in the HTTP response header.

No

<signature mode>

Specifies the format in which the public (X.509 certificate) and private keys are provided for signing the HTTP request

Valid values: keystore (default), key-files, key-data

You can provide the keys using one of the following formats:

  • Java Keystore (JKS)
  • Privacy Enhanced Mail (PEM)
  • Definite Encoding Rules (DER) files
  • Base64-encoded PEM

No

<key store file>

Specifies the path to the JKS that contains the client certificate

Conditional; required when the signature mode is keystore

<key store password>

Specifies the password to the JKS

Conditional; required when the signature mode is keystore

<key password>

Specifies the password of the key contained in the JKS

Note: If you do not specify key password, then the value of key store password is used as the key password

No

<client alias>

Specifies the name of the alias in the JKS that identifies the Public Key Certificate (PKC) that the web server uses to authenticate the client

Note

The value of the client alias element is verified only when install certificate is set to true and allow unsigned certificate is set to false

Conditional; required when the signature mode is keystore

<private key file>

Specifies the file containing the private key that is used to sign the HTTP request

The adapter supports the following formats:

  • Base64-encoded PEM
  • DER

Conditional; required when the signature mode is key-files

<certificate file>

Specifies the file containing the public key (X509 Certificate)

The adapter supports the following formats:

  • Base64-encoded PEM
  • DER

Conditional; required when the signature mode is key-files

<private key data>

Contains an XML file specifying the private key in an Base64-encoded PEM format

For example:
<private-key-data> ----- BEGIN PRIVATE KEY -----
MIICdQIBADANBgkqhkiG9w0
BAQEFAASCAl8wggJbAgEAAo
GBAKomKro6VbW4PeQtUhNz
ZpSH26vbBTBtH1r4EjnIv4vnh
SyyA62ewpROVNn0Spvjo
BFwE88HcX3tXym/zbVgtd
Pke9K+SYHP6CWdiLqn
........
----- END PRIVATE KEY -----</private-key-data>

Conditional; required when the signature mode is key-data

<certificate data>

Contains an XML file specifying the public key (X509 Certificate) in an Base64-encoded PEM format

For example:
<certificate-data> ----- BEGIN CERTIFICATE -----
MIICdzCCAeCgAwIBAgIFXseN1xYwDQYJKoZIhvcNAQEFBQ
AwUzELMAkGA1UEBhMCVVMxEzARBgNVBAoTCkFtYXpvbi5jb20x
DDAKBgNVBAsTA0FXUzEhMB8GA1UEAxMY
........
----- END CERTIFICATE -----</certificate-data>

Conditional; required when the signature mode is key-data

<enable json conversion>

Specifies whether the adapter should treat the input data in the request and the data received in the adapter response as a JavaScript Object Notation (JSON) string

If <enable json conversion> is set to true, the input data in the request (XML format) is converted to a JSON string after parsing and the response (if a JSON string) is converted to an XML format.

Valid values: true, false (default)

Note

  • The JSON string in the response is parsed to XML only if <enable-json-conversion> is set to true and <data-format> is set to XML.
  • If you specify <enable-json-conversion> in the adapter configuration and the adapter request, the value in the adapter request overrides the value in the configuration.

No

<ignore-line-break-in-response>

Specifies whether to ignore the line breaks while generating the adapter response

If true, the line break markups are ignored and the response is returned as a single line. If false, the line break markers (if specified in the adapter response) are retained.

Valid values: true (default), false

No
<request-timeouts>

Specifies the time (in seconds) to wait when establishing a connection.
Default value: 10 seconds (if not specified in request and configuration)

No
<include-expect-header>

Specifies whether to include the 'Expect' header with '100-continue' value in the generated request or not.

As per HTTP/1.1 specifications, this element should be set by the clients while sending a request when it intends to send the request body in the subsequent request and expects an intermittent 100-contnue response from the server. A few web servers do not recognize this header and end up sending a 400-BAD Request error to the client. In such cases, this header should not be set by the clients to successfully run the request.

Valid Values: true, false
Default: true (per HTTP/1.1 specification)

No

The following table describes the process output parameters for the HTTP adapter with the Put process.

Put process outputs

Outputs

Description

status code

Specifies the HTTP status code

status reason

Specifies the HTTP status reason

header lines

Specifies the HTTP header lines

message body

Specifies the message body

Was this page helpful? Yes No Submitting... Thank you

Comments