Tools SQL

To open this subform, select or create an event tool with the SQL type from the Tools UI.

Form Fields

• Name: The name of the tool.

• Icon: The icon used for the tool in menus.

• SQL: The entire SQL query to run when the tool is selected.

  You can use the following tokens, which are replaced with actual values when the tool is run:

  • $USERNAME: The username of the user running the tool.

  • $EVENTLIST: A comma-delimited list of the selected EventIDs.

• Journal: Select this to add a journal entry to the event when the tool is used.

• Entry: The journal entry to add when the tool is used.

  You can use the following tokens, which will be replaced with actual values when the journal is written:

  • $USERID: The UserID of the user running the tool.

  • $USERNAME: The username of the user running the tool.

  • $USERFULLNAME: The full name of the user running the tool.

  • $USERGROUPID: The user group ID of the user running the tool.

• Actor: The actor value to be used when the tool is run. It will default to the UserID of the user running the tool if it is left blank.

• Action: The action value to be used when the tool is run. It will default to the name of the tool if it is left blank.

Best Practices

The global EventUpdateBatchSize property controls how many events a SQL tool can update at a time. If the number of events selected is greater than the batch size, the tool makes multiple calls.

The default batch size value is 1000. You can reduce this value if your Event database is extremely busy and SQL tool batch updates are failing to complete. See Global Properties for information about the UI for updating EventUpdateBatchSize.