Establishes connections with an HTML application.

An HTML connector allows Convertigo to connect to a website to perform transactions, that is to say navigate through web pages and either:

• extract data into a proper XML document (CWI),
• clip defined web pages (CWC).

HTML connector is needed by Convertigo to connect to HTML applications. Once connected, all tasks (screen classes detection, data extraction, browsing, etc.) associated with the HTML connector can be carried out as defined in the project thanks to several objects:

• Screen classes,
• Criteria,
• Extraction rules,
• HTML transactions,
• Screen classes handlers,
• Statements.

Property Type Category Description
Comment String standard Describes the object comment to include in the documentation report.
This property generally contains an explanation about the object.
Is HTTPS boolean standard Defines whether the connection is secured (HTTPS).
If set to true, the connection is SSL-based. Make sure the target SSL port (usually 443) is correctly set.
Port int standard Defines the server port.
Root path String standard Defines the root path.
This is the first URI requested by the HTTP connector. Any other URI in the project is relative to this URI.
Server String standard Defines the server name (or its IP address).
This property defines the DNS name or IP address of the target application server.
Trust all certificates boolean standard Defines whether trusted certificates must be checked. Reload the project to be effective.
In SSL mode, the server sends existing certificates to Convertigo. In most cases, set this setting to true to automatically trust all server certificates. If set to false , target server certificates must be installed in Convertigo.
Authentication type AuthenticationMode expert Defines the authentication type between basic and NTLM authentications.
This property allows to define which type of authentication has to be used for the HTTP request. Default value is Basic.
If Basic/NTLM authentication user and Basic/NTLM authentication password properties are not filled, no authentication is performed.
Notes:

• If you are using basic authentication setting, the target application should accept WWW-Authenticate header.
• If you are using NTLM authentication setting, do not forget to also fill the NTLM authentication domain property.
Basic/NTLM authentication password String expert Defines the user’s password for basic or NTLM authentication.
This property value is used as user password for basic or NTLM authentication.
Notes:

• The type of authentication is chosen using the Authentication type property.
• If you are using basic authentication setting, the target application should accept WWW-Authenticate header.
• If you are using NTLM authentication setting, do not forget to also fill the NTLM authentication domain property.
Basic/NTLM authentication user String expert Defines the user name for basic or NTLM authentication.
This property value is used as user name for basic or NTLM authentication.
Notes:

• The type of authentication is chosen using the Authentication type property.
• If you are using basic authentication setting, the target application should accept WWW-Authenticate header.
• If you are using NTLM authentication setting, do not forget to also fill the NTLM authentication domain property.
Billing Java class String expert Defines the Java class name executed for billing pruposes.
Convertigo supports a plugin architecture offering billing functionalities. Set the name of the billing class to be called by Convertigo for billing purposes.
Carioca authentication boolean expert Defines whether the connector requires a Carioca authentication.
Set to true if you require that only Carioca-authenticated users be able to use this connector.
Default URL charset encoding String expert Defines the default charset encoding to use for the transactions variable values sent as parameters in HTTP requests.
This property allows to define the charset encoding used to URL-encode the parameter values:

• GET parameters for the query string,
• POST parameters in case of application/x-www-form-urlencoded content-type.

Default value is UTF-8.
End transaction String expert Defines the transaction to execute before removing the context.
When a Convertigo context is removed, the specified “End transaction” is executed. Place in this transaction any clean up code, for example a Logout transaction.
HTTP headers forwarding policy XMLVector expert Defines the HTTP headers to forward and the policy to use to forward them.
This property allows forwarding HTTP headers from the client browser to the target application.
This property allows to define a list of HTTP headers to forward and, for each header, the forwarding policy to use. For each header, two columns have to be set:

Header name: defines the name of the header to forward,
Forwarding policy: defines how to replace the header value when forwarding it.

This second property can take the following values:

Merge: If the forwarded header exists, its value is merged with existing one. If the forwarded header doesn’t exist, it is added.
Ignore: If the forwarded header exists, its value is not replaced, it is ignored. If the forwarded header doesn’t exist, it is added.
Replace: Replaces all headers without any condition by forwarded values.

Note: A new HTTP header can be added to the list using the blue keyboard icon. The HTTP headers defined in the list can be ordered using the arrow up and arrow down buttons, or deleted using the red cross icon.
Ignore empty attributes boolean expert Defines whether DOM empty attributes must be parsed or ignored.
HTML elements can include empty attributes. This property allows removing these attributes from the page’s DOM by setting it to true.
NTLM authentication domain String expert Defines the NTLM authentication domain in case of NTLM authentication.
This property value is used as user domain for NTLM authentication.
Notes:

• The type of authentication is chosen using the Authentication type property.
• If you are using basic authentication setting, this property does not need to be filled.
Parse mode ParseMode expert Defines the HTML parser version (since Convertigo 4.0 / since Convertigo 4.5).
This property takes one of the following values:

4.0: uses parsing mode developed since Convertigo 4.0 (original parsing mode),
4.5: uses parsing mode developed since Convertigo 4.5 (faster parsing mode, but sometimes not adapted).