Custom

Allows you to perform a custom action.

Example

http://12.3.4.56:9030/action=Custom&Library=email&Function=email&From=Administrator@company.com&To=Manager@company.com&Subject=Business&Comment=Urgent&Reference=http://www.company.com

This action uses the user_email library to run a custom action that sends an e-mail from Administrator@company.com to Manager@company.com with the subject line Business and the comment Urgent. The e-mail contains the document with the reference www.company.com.

Required Parameters

The following action parameters are required.

Parameter Description
Function A library function.
Library The configuration section in which the custom library is defined.

You must set one of the following parameters.

If you set more than one of these parameters, only one is used. URL is used in preference, then the ID, and then the Reference.

Parameter Description
ID The ID of the document to send by e-mail.
Reference The reference of the document to send by e-mail.
URL The URL to send by e-mail.

Optional Parameters

This action accepts the following optional parameters.

Parameter Description
Comment A comment to send in an e-mail.
EmailAddress The e-mail address of the user.
FieldFieldName A field for the user.
From The e-mail address of the e-mail sender.
Subject The e-mail subject line.
Security The security field for the user.
To The e-mail address of the e-mail recipient.
XMLEncoding Overrides the default XML encoding.

This action accepts the following standard ACI action parameters.

Parameter Description
ActionID A string to use to identify an ACI action.
FileName The file to write output to.
ForceTemplateRefresh Forces the server to load the template from disk.
Output Writes output to a file.
ResponseFormat The format of the action output.
Template The template to use for the action output.
TemplateParamCSVs A list of variables to use for the specified template.