Custom Agents

The Custom Agent in AlarmWorX Multimedia enables you to create your own Multimedia agent. You can create a customized executable file by specifying parameters that the Multimedia Server will use to call the Custom Agent's interface.

The following configuration fields are available for the Custom Agent:

Media Item Name: Enter a name for the Custom Agent configuration.
Node: Enter the node name for the computer on which you wish to run the Custom Agent. If this field is left blank, the Custom Agent will be run on the computer that is running the Multimedia Server. Click the ellipsis button to search for a node.
Description: Allows you to add comments to the agent configuration.
Media Template: You must choose a template to be used with the agent. The template determines the actual message that gets sent to instant message recipients. For more information about templates, please see Media Templates.
TEST button: Tests your custom agent configuration.
Scheduling: If you are using scheduling, choose from the configured schedules on the drop-down list. See Schedules for more information.
Role: Select a role from the drop-down list. For information about roles, please see Working With Roles.
Enable Alarm Prioritization: When this check box is checked, the multimedia system processes alarms based on the severity level of the alarm. If the check box is not checked, alarms are processed only on a first-in-first-out basis.
Apply button: Saves all changes to the configuration database.
Reset button: Clears all recently added information.
Refresh Button: Resets to the original data before it was changed, unless the Apply button was clicked.

Custom Agent Settings

The Custom Agent uses the "addMAPIMessage" interface method. The Multimedia Server calls this method, which passes parameters to the agent. In the Custom Agent configuration, you can specify these parameters, which the Multimedia Server will use to call the custom agent's interface.

[id(4), helpstring("method addMAPIMessage")]

HRESULT addMAPIMessage(

[in] BSTR message,

[in] BSTR transaction_id,

[in] VARIANT to,

[in] VARIANT CC,

[in] VARIANT BCC,

[in] VARIANT attach,

[in] BSTR subject,

[in] VARIANT_BOOL UseShort_id,

[in] BSTR Pin

);

Parameters [in] BSTR message, [in] BSTR subject, and [in] VARIANT attach, are set by the media template.
Parameters [in] VARIANT to, [in] VARIANT CC, [in] VARIANT BCC, [in] VARIANT_BOOL UseShort_id, and [in] BSTR Pin are set by the agent configuration.
Parameter [in] BSTR transaction_id, is set by the Multimedia Server and uniquely identifies each message.