See Working with Database items for details on how to open, edit, save or delete action lists.
Action lists behave differently to other database items:
- They reside in a Live group, therefore a Live group and not a Model group should be right-clicked in the Explorer Window to create an action list.
- To save an action list, either click Close (
) in the top right corner of the action list grid window, and select Yes when prompted to confirm the saving, or click Save (
) in the File toolbar.
- Action lists must be validated before they are used in manifests. The action list becomes read-only once it is associated with a manifest.
Define an action list
- Open an action list.
- Edit the fields in the
Action tab as appropriate.
If you want to group multiple alerts into one action (email), then ensure that the each action is given the same Category and HTML enabled setting, and that the same recipients are specified in the Email to addresses, and if required, the Email cc addresses and/or Email bcc addresses fields.
- Check that the syntax of the specified email addresses in the Actions tab are correct by validating the list (see below), and if necessary, correct any errors.
- Click the Email configuration tab and edit the fields as required. See below if you want to test the email connection.
- Click
to save the action list.
Edit and/or test an email connection configuration
- Open the action list (if not already open).
- Click the Email configuration tab.
- Right-click the email configuration that you want to change/test and select Edit connection configuration and test from the context menu. The SMTP Server dialog is displayed, which can then be used to edit the connection configuration and/or test the connection.
Send a test email from an action list
The following procedure outlines a simple way to test that an email will be sent from the server specified on the Email configuration tab to the email recipients specified on the Action tab.
- Open the action list (if not already open).
- Ensure that the email server has been defined in the Email configuration tab.
- Ensure that the action, including the email addresses for the recipients, has been specified in the Action tab, and that the Configuration ID in the Action tab is the same as the Configuration ID in the Email configuration tab.
If you want to receive the test email, ensure that your email address is specified in at least one of the Email to, Email cc, or Email bcc addresses fields.
- Right-click the row in the Action tab that contains the email addresses which are to receive the test email, and select Send test email from the context menu.
The Send Plain Text Email dialog opens. In this dialog:
- Edit the Subject field if you do not want to the default one to be used as the subject in the test email.
- If required, add a message in the Message field. Or remove the default one if you do not want to include a message in the test email.
- Add checks in the boxes next to the email address lists which contain the email addresses of the contacts you want the test email to be sent to. The selected box(es) must contain at least one email address specified in the corresponding Email to, Email cc or Email bcc addresses fields in the Action tab.
- Click Send.
If the test is successful a suitable message is displayed and, if you have included your email address then you should also receive the test message.
If unsuccessful, a log is displayed indicating where the test failed.
Note: The Send button is only enabled when a subject is specified in the Subject field and at least one address list box, for which email addresses have been specified in the Actions tab, has been checked.
Test an action list
The following procedure outlines a simple way to test that an action list has been setup successfully.
To perform the test, the following database items are required in a Live group:
- The applicable action list
- A network
- A simulation result
- An alert instance list or, if not available, an alert definition list
To test the action list
- Right-click a simulation result in the Explorer Window and select Open from the context menu.
- If an alert instance list for the simulation result (opened in Step 1) is not available, drag an alert definition list from the
Explorer Window and drop onto the simulation results on the GeoPlan.
The software generates an alert instance list as a child of the simulation.
- Drag the applicable alert instance list from the Explorer Window and drop onto the simulation results on the GeoPlan.
- Drag the action list you want to test from the Explorer Window and drop it onto the simulation results on the GeoPlan.
The actions contained in the action list should then be triggered according to their definitions in the action list.
Import and export action lists
Action lists can be imported from and exported to CSV files.
To import an action list
- Right-click a Live group in the Explorer Window
- Select Import
Action list
From InfoWorks format CSV file from the popup menu.
- Select the file to be imported.
- Click Open to import the file into the group.
A new action list objects, which is assigned the name of the CSV file, is created in the Live Group.
To export an action list
- In the
Explorer Window, right-click the action list and select Export
to CSV from the popup menu.
- Choose a location and filename for the exported file and click Save.
Validate an action list
- Open the action list by right-clicking and using the popup menu, or by dragging it to middle of the main window .
- Click
(Validate) on the Validation toolbar.
- The Output Window is displayed, where any error, warning or information messages (see Action List Validation Messages) is listed. Use the window options to investigate the corresponding fields and make corrections, where required.
- Close the Output window if required.