Tools SQL

Form Fields

• Name - The name of the tool.

• Icon - The icon used when viewing the list of available tools.

• SQL - The entire SQL query that will be run when the tool is selected.

• Journal - A checkbox to control whether or not a journal entry is added to the event when the tool is used.

• Entry - The journal entry that will be added when the tool is used.

Best Practices

• When the SQL command is run, the following tokens will be replaced in SQL field:

  • $USERNAME - User name of the user running the tool.

  • $EVENTLIST - Comma delimited list of the selected Event IDs.

• When the journal is written, the following tokens will be replaced in the Entry field:

  • $USERID - UserID of the user running the tool.

  • $USERNAME - User name of the user running the tool.

  • $USERFULLNAME - Full name of the user running the tool.

  • $USERGROUPID - User Group ID of the user running the tool.

• The global property "EventUpdateBatchSize" controls how many events can be updated at once by an SQL tool. Multiple calls will be made if the number of events selected is greater than the batch size. This value defaults to 1,000, but can be reduced to fit the needs of specific event databases. Reduce this value if the event database is extremely busy and SQL tool batch updates are failing to complete.