Callback hooks

 

Advanced system administrators can attach callback functions to logged events that could be used to send XML commands to third party servers. The format of the command and what the third party does when it receives is outside the scope of the PACS.

 

To set up the callback, do the following:

  1. Click the Admin tab.

  2. Click the Settings tab.

  3. Scroll to the System Settings section and click the Register Callback Hooks link to display the callback hooks table.

  4. Click the New Callback button, , to display the callback edit page.

  5. Enter a callback name.

  6. Click Enable to activate the callback. To create the callback without enabling it, clear the Enable checkbox.

  7. Enter the callback URL. Include the entire URL, including the prefix (http:// or https://) and the server address. The format of this URL complies with the command structure defined by the recipient of the command.

  8. Select the message format. XML sends the data in XML-compliant format. Text sends the data in a flat text format.

  9. Select the trigger actions that will result in this callback sending the URL. Click the Add Trigger button, , and select one or more log actions from the list, move them to the left side of the window, and click Apply. The trigger actions appear in the Trigger Actions section.

  10. Select the study and other fields to include in the data sent to the destination. Click the Add Field button, , and select one or more database fields form the list, move them to the left side of the window, and click Apply. The fields appear in the Notification Fields section.

  11. Click Save.

To edit an existing callback, including temporarily disabling it without deleting it, click the Edit button, , in the callback’s row. The same edit panel described above appears. Make your changes and click Save.