Skip to main content
Version: 6.11

Ajax Command

Patriot can connect to and send arm, disarm, night mode on and night mode off commands to panels which support the Ajax Command service.

Prerequisites

  • This feature requires the 'Ajax Command' module to be added to your license.

Task Setup

Add a new Task into the system. See Tasks for general task setup information.

Select Ajax Command as the task type.

The Ajax Command task is responsible for receiving commands from Patriot workstations, and sending them on to the Ajax webservice, which in turn sends them on to connected customer alarm panels.

Ajax Command Task Settings
Ajax Command Task Settings

Task Settings

SettingDescription
API KeyThe authorization key to access Ajax webservice, issued to you by Ajax.
Company IDThe Ajax company ID for your control room, issued to you by Ajax.
Company TokenThe Ajax company webservice token issued to you by Ajax.
note

Your Control Room/Company must also be invited by the client from their Ajax software in Hub settings > Security Companies.

Your Control Room/Company credentials can not be used for Disarm commands. This is blocked by Ajax.

Client Setup

Enter the Ajax Hub ID, into the Patriot client's Device Ref No field located in the Panel Details section on the Maintenance tab. This should be the full Ajax Hub ID, which is the first 8 characters of the serial number. If you have separate Hubs for different areas you may add a Hub to each area of the client, otherwise If you have one hub for the entire client add the Hub ID to the base area.

Ajax Command Client Device Ref Setup
Enter the alarm panel's full Hub ID into the Device Ref No on the base area.

Actions

At the client level, Ajax Commands are configured and issued on the Actions tab of the Patriot client. The Actions tab will only be visible when a supported module (e.g. Ajax Command) is registered, and the task (e.g. Ajax Command) is configured.

Ajax only allows for action to be performed on Hubs.

Share Actions: allow actions to be referenced from the base area.

Default Action: select a default action for an area. The commands of this action can be sent directly from the Client Details tab in ICA. Please refer to Web Client section.

Ajax Command Client Actions Setup
Ajax actions setup in the Actions tab of a client's base area.

Add a new action

add Click the Add button at the bottom of the list on the Actions tab of the client area (or base area) that you wish to setup a new action against.

Add Ajax Action
Add an Ajax action

Action Type: You can choose a general action or a specific type. Currently only Status Change action is supported apart from the general type.

Task: select a task through which you want the command to be sent. For a Ajax action, it needs to be an Ajax Command type task.

Command Type: available command types will depend on the Task type. For Ajax Command tasks, only Arm Disarm is supported at present.

Setup Action Definitions

You need to setup Action Definitions after you created a new action. The Action Definitions form varies for different Action Types.

General Action

General Ajax Action Definitions
General Ajax Action Definitions

You need to define at least one command for a General action. To define a command, you need to specify an Label and select the Option you want to execute.

add You can add another command by clicking the Add button.

Status Change Action

Status Change Ajax Action Definitions
Status Change Ajax Action Definitions

Each Status Change Action can only have a pair of Arm/Disarm commands. You need to select the Action you want to execute on each command.

save Save the new action.

Send a Command

remote Select a command in the list, and then click the Execute Command button. A pop up window will soon appear with a success message, or an error message if there was a problem issuing the command.

Web Client

Once configured, commands may be issued remotely via the Patriot web client interface. Web users must be granted the Remote Commands security right to access this feature.

ICA interface commands
Panel commands can be issued from the ICA web client interface.

If you have a Default Action configured, all the commands of the action will be available in the Client Details tab from where you can issue a command directly.

Default Action
Commands of the default action can be issued from the Client Details tab.