version

HTTP Request

Makes a request to a server using HTTP/HTTPS and passes the result to the database. The component is mostly used for lightweight integrations, for example periodically fetching a CSV file from a web server.

Uses proxy settings defined in application variables PROXY and PROXYBYPASSLOCAL to make the request.

The component requires that any text it downloads is encoded in either UTF-8 or ASCII.

Component modes: Single | Batch

Component mode: Batch

Component settings

Request timeout

Timeout in seconds for the HTTP request. Leave blank to use default (20 minutes).

SQL

SQL Call: Init (mandatory)

May modify database: No

Parameters

@Action string

Will be set to "Init".

Resultset: Batch

Table count: repeated exactly once

Row count: zero or one row

Columns

BatchId optional string

BatchId to send to all remaining calls to the component.

SQL Call: Get requests (mandatory)

May modify database: No

Parameters

@Action string

Will be set to "GetRequests".

@BatchId string

BatchId created in the init call.

Resultset: Requests (optional)

The requests to be performed by the component.

Table count: repeated zero or one time

Row count: zero or more rows

Columns

RequestId mandatory string

The Id of the request, specified as a parameter to the actions operating on the request.

Url mandatory string

The url of the request. (including http:// or https://).

SpecifyData optional bit

Specifies if the GetData action should be called. Default 0.

Method optional string

The HTTP method to use.
GET is the default method used.

FormEncoding optional string

Determines how posted data is encoded. This column is only allowed if the Method is specified as POST.

Default: "multipart/form-data" is the default.

Possible value	Description
application/x-www-form-urlencoded	Parameter names and values are escaped: non alphanumeric characters are replaced by %HH (two hex digits ASCII code). Not efficient for large quantities of non alphanumeric data. Parameters with Filename are not allowed.
multipart/form-data	Accepts text data, binary data and files.

BeginExtraParams optional any

Marker that indicates that all columns with a higher ordinal than this column will be passed as parameters to the procedure for all actions created by this request. This column must only contain NULL.

<xxx> optional any

Values in columns to the right of the BeginExtraParams column are passed as parameters to the procedure for the calls created by the command.

SQL Call: Get request data

Called if column SpecifyData is set to 1.

May modify database: No

Parameters

@Action string

Will be set to "GetData".

@BatchId string

BatchId specified in the Init call.

@RequestId string

RequestId specified in the Request call.

Resultset: Parameters (optional)

Table count: repeated zero or one time

Row count: zero or more rows

Columns

<xxx> optional string

A parameter to supply with the request. The way these are passed depends on the method specified. For a GET request they passed on the querystring, for POST requests they passed as form parameters. Currently form data is always posted as 'multipart/form-data'.

<xxx>ContentType optional string

Used to specify the content type of the parameter. Only relevant for POST requests. Default is 'application/octet-stream' for binary data and 'text/plain' for all other data.

<xxx>Filename optional string

Used to specify the filename of the parameter . Only relevant for POST requests. Setting this flags also sets 'Content-Disposition' to 'attachment'.

Resultset: Headers (optional)

Table count: repeated zero or one time

Row count: zero or more rows

Columns

HttpHeaderName mandatory string

Name of the custom HTTP header.

You should not pass standard HTTP headers like Content-Type or Accept-Encoding as doing so may interfere with the component and may break in future versions.

HttpHeaderValue optional string

The value to pass. If NULL then the header will be omitted.

SQL Call: Store response (mandatory)

SQL statement that passes the data retrieved from the server to the database.

If the Content-Type of the data received from the server is a text type (any type that starts with "text/", for example text/plain, text/csv, text/html) then the response will be passed through the @TextResponse parameter. Otherwise it will be passed through the @ImageResponse parameter.

May modify database: Yes

Parameters

@Action string

Will be set to "StoreResponse".

@BatchId string

BatchId specified in the Init call.

@ContentType string

Set to the Content-Type field of the HTTP response.

@Disposition string

Set to the Content-Disposition field of the HTTP response. (The filename part is passed separately).

@Filename string

Set to the filename supplied if disposition is 'attachment'.

@ImageResponse binary

Binary data returned by server.

@RequestId string

RequestId specified in the Request call.

@TextResponse string

Text data returned from the server.

SQL Call: Store error (mandatory)

May modify database: Yes

Parameters

@Action string

Will be set to "StoreError".

@BatchId string

BatchId specified in the Init call.

@ErrorMessage string

The error messsage when performing the request.

@RequestId string

RequestId specified in the Request call.

SQL Call: Finished (mandatory)

May modify database: No

Parameters

@Action string

Will be set to "Finished".

@BatchId string

BatchId specified in the Init call.

Resultset: Forwarding (optional)

Table count: repeated zero or one time

Row count: zero or one row

Columns

ADMIN_ErrorMessage optional string

Displays a user friendly error message to the user.

ADMIN_InfoMessage optional string

Displays a user friendly success message to the user.

ADMIN_SuccessMessage optional string

Displays a user friendly success message to the user.

<passing_field> optional string

Any column with no other specific meaning will pe passed along to the menu item you are forwarding to.

ADMIN_CancelCidStepsBack optional int

Number of steps in the page history to jump back if the user clicks Cancel in an ADMIN_FORCE dialog (the default being none). This value overrides cancelcidstepsback specified in the query string.

ADMIN_CancelReturnToMenuItem optional string

Jumps back to the menu item with this alias if the user clicks Cancel in an ADMIN_FORCE dialog (the default being none). If no prior menu item is found with the given alias, then an error is thrown.

ADMIN_CancelMenuItem optional string

Alias of the menu item to execute if the user clicks Cancel in an ADMIN_FORCE dialog (the default being none). This value overrides cancelmenuitemid specified in the query string.

ADMIN_CancelMenuItemId optional int

Deprecated. Use ADMIN_CancelMenuItem instead.

Id of the menuitem to execute if the user clicks Cancel in an ADMIN_FORCE dialog (the default being none). This value overrides cancelmenuitemid specified in the query string.

ADMIN_CidStepsBack optional int

Number of steps in the page history to jump back after execution (the default being one step back). This value overrides any destination specified by the query string.

ADMIN_ReturnToMenuItem optional string

Jumps back to the menu item with this alias after execution. This value overrides any destination specified by the query string. If no prior menu item is found with the given alias, then an error is thrown.

ADMIN_Force optional string

Prompts the user with the specified text and the user may answer OK or cancel. If the user chooses OK the sql call will be rerun with the parameter @force set to 1.

ADMIN_Forward optional string

Displays a user friendly message and then forwards to the next menu item.

ADMIN_ForwardLink optional string

Alias of the link to forward to.

ADMIN_ForwardMenuGroup optional string

Alias of the menu group to show after execution (instead of former menu item). This value overrides any destination specified by the query string.

ADMIN_ForwardMenuGroupId optional int

Deprecated. Use ADMIN_ForwardMenuGroup instead.

Id of the menu group to show after execution (instead of former menu item). This value overrides any destination specified by the query string.

ADMIN_ForwardMenuItem optional string

Alias of the menu item to execute after execution (instead of former menu item). This value overrides any destination specified by the query string.

ADMIN_ForwardMenuItemId optional int

Deprecated. Use ADMIN_ForwardMenuItem instead.

Id of the menu item to execute after execution (instead of former menu item). This value overrides any destination specified by the query string.

ADMIN_Message optional string

Displays a user friendly error message to the user.

ADMIN_PasteHtmlFromPopup optional string

Pastes HTML into an HTML editor. See ADMIN_SetFieldValueFromPopup.

ADMIN_SetFieldValueFromPopup optional string

Sets the value of the field specified in the menuitempopup call. Only select this column if menu item is opened in a popup.

ADMIN_ClosePopup optional bit

If this column is anything but NULL the popup will be closed. Only select this column if the menu item is opened in a popup.

Default: The default behavior is to step back inside the popup window and close it if there is nothing to step back to.

ADMIN_ClearHistory optional any

When the value is not NULL all navigation history is cleared and the user can't navigate back. This is only supported when forwarding to another menu item.

ADMIN_RefreshMenu optional bit

Will trigger a reload of the sidebar if the column is anything but NULL.

Cache optional string

Cache key to be cleared. Supports wildcards.

CacheUserId optional string

Either a user id or '%'.

Clears all caches (e.g. access permissions) related to the specified user id.

Use '%' to clear caches for all users.

CancelButtonText optional string

Changes the text of the Cancel button when used with ADMIN_Force.

OkButtonText optional string

Changes the text of the OK button when used with ADMIN_Message, ADMIN_Force, or ADMIN_Forward.

SQL Call: Validate parameters

Allows you to validate the parameters supplied by the user before any other SQL is run in the component. This call is only made if the component has visible parameters, the SQL is a stored procedure, and Validate parameters is checked.

May modify database: No

Parameters

@Force bit

Set to 1 if the last call to validate parameters used admin_force and the user clicked OK in the OK/Cancel dialog.

@ValidateParams bit

Set to 1 when this call is made.

Resultset: Messages (optional)

Table count: repeated zero or one time

Row count: zero or one row

Columns

ADMIN_Force optional string

Message asking the end user to confirm their parameters.

ADMIN_Message optional string

Message explaining why the parameters are rejected.

Custom access control and logging

SQL Call: Custom access control and logging

Use this call to restrict which entries a user is allowed to view and edit, and to log which entries a user views.

Access to a menu item is normally controlled through functions and roles alone but some entities need more fine grained control. For example, a user may have access to the View Member menu item for normal members but not for members with a protected identity.

The menu items a user visits are always logged (in ADMINLogMenuItem) but for sensitive data you may need to log exactly what entries are viewed. Do the logging in this call as the common ways of viewing data (grid and InfoSQL) are not allowed to modify the database.

If you bind a scalar function instead of a stored procedure to this call then its name must end with '_GrantAccess'.

May modify database: Yes

Resultset: Access permissions

Return whether the user is allowed to visit the menu item with the current parameters.

Table count: repeated exactly once

Row count: exactly one row

Columns

GrantAccess mandatory bit

1 if the user is allowed to view the menu item, 0 if the user should not be allowed to view the menu item.

If 0 then an error will be logged as the user should not have been able to reach the menu item with the given parameters in the first place.