User Guide > Getting Started Guide > Information through Notification

Information Through Notification

Aim:
- Creating a notificationAn Automation Engine object type used to send messages to users and user groups. [Formerly called "CallOperator."]
- Using the Notification MonitorWindow of the notification that is sent to one or several users at runtime.
- Assigning the notification to a file transferTransfers files from one computer to another. A particular Automation Engine object type (FileTransfer object).
- Restarting the file transfer in the workflowAn object of the Automation Engine that can include several executable objects and which runs them in a specified order. [Formerly called "ProcessFlow" and "JobPlan."]

Lesson 10

Notifications are very important and are commonly used object types. They can be used to send messages to individual users or even user groups of the AE system.

We will now create a Notification objectAutomation Engine controlled activities and processes are structured in the form of objects. See also: Task and include it in the first file transfer in order to assure that a message is sent if an error occurs.

  1. Open the folderTop level entities such as Environment, Deployment Target, Activity, … are stored in folders. The permissions a user has on an entity depend on the permissions that are set on the folder for the entities. in the Explorer in which you have stored the previous sample objects.
  2. Click the  button in the toolbar.
  3. Select the object typeAn individual object is provided for the individual activities: There are User, UserGroup, Notification, Cockpit, CodeTable, Documentation, Event, Agent, FileTransfer, Group, Include, Job, Workflow, Calendar, Login, Client, RemoteTaskManager, Schedule, Script, Server, Sync, Variable and TimeZone objects CALL (notification).
  4. Assign a suitable name and double-click on the Notification object to open it.
  5. Change to the Notification tab
  6. Select the priority "High" and the type "Alert".


  7. Change to the Notification tab.
  8. Enter a message text, keeping in mind whether this text should be used for multiple tasks or only for specific ones. Depending on the use, the message should contain a general text or a specific one.


  9. Change to the Recipients tab.
  10. Select your userIn the Automation Engine, a user is an instance of a User object, and generally the user is a specific person who works with Automic products. The User object is assigned a user ID and then a set of access rights to various parts of the Automation Engine system and product suite. These access rights come in the form of Automation Engine authorizations and privileges, Decision user roles and EventBase rights and ARA web application object rights. You can manage all these centrally in the ECC user management functions. See also, Unified user management. in the Recipients column.


     
  11. Store your modifications using the  button in the toolbar and close the object.

For testing reasons, the notification is now started manually.

  1. Highlight the notification in the Explorer and start it with the  button in the toolbar.
  2. The Notification Monitor opens. Additionally, a notification symbol in the right upper edge of the UserInterfaceThis is the Automation Engine's graphical user interface. [Formerly called the "Rich Client", "RichGUI" and "Dialog Client."] notifies you of the incoming message.


  3. Click Accept and then Done in order to successfully end the notification.
     The Notification object does not end if you close the Notification Monitor instead of responding to it as described above. The notification symbol is still shown in the UserInterface's upper right edge. Right-click this symbol and select the clientA closed environment within an Automation Engine system where you can create and run objects. A client name consists of a 4-digit number that must be indicated when a user logs on to the Automation Engine system. Users and their rights are also defined in clients. A particular Automation Engine object type.. A dialog opens in which you can reopen the Notification Monitor.

The notification sends a message if the first file transfer of the workflow could not be executed successfully.

  1. Open the Workflow object by double-clicking it.
  2. Switch to the Workflow tab. Properties can be specified for each object of the workflow (as in Schedule objects).
  3. Right-click the box that is used for the first file transfer and select the command Properties.
  4. Switch to the Postconditions tab.
  5. Select Conditions and use the drag and drop functionPre-defined run book template in the Automation Engine. One single step only, e.g. Start Windows Service, Copy file,… to move the STATUS entry to the left window area. Now click <STATUS> within the STATUS block. In the displayed dialog, select the statusThis represents the condition of a task (such as active, blocked, generating). that is expected for a successful execution, which in this case is ENDED_OK. Click OK to confirm this dialog.
  6. Now add an Else condition to the status block. Do so by calling the block's menu with the symbol in the upper right edge and select the command "Add Else block".
  7. In the Else section, you can define the expected reactions if the file transfer does not end with the status ENDED_OK. Click Actions (right window section) and drag EXECUTE OBJECT and BLOCK to the Else section.
  8. EXECUTE OBJECT executes any executable object of your choice and BLOCK blocks the taskAn executable object that is running. Tasks are also referred to as activities. if the previously defined status condition does not apply (Else). For the parameter <Object> of EXECUTE OBJECT, enter the object which should start (BSP_CALL01)and set the option "do not wait". In the BLOCK section, you can set any status text for the blocked task.


  9. Store your modifications in the Workflow object using the  button in the toolbar and close this object.

Now the notification can be tested in combination with the workflow.

  1. Enter a non-existing file name in the first FileTransfer object. This should cause an error in your workflow.
  2. Highlight the workflow in the Explorer and start its execution using the  button in the toolbar.
  3. The Workflow Monitor opens. As the file cannot be transferred due to the wrong file name, the workflow blocks. The file transfer box is displayed yellow.


  4. The Notification Monitor also opens. Click Accept in order to indicate that you are going to handle this problem. Thus, other recipients of this message know that somebody is already in charge of this situation.
  5. Right-click the file transfer box in the Workflow Monitor and select the command Edit. The FileTransfer object opens and the erroneous file name can be corrected. Now store and close the file transfer.
  6. The file transfer can now be re-activated. It is not necessary to restartA restart refers to the repetition of an object's execution. This action differs from a new start in some parts. the whole workflow. Just right-click the file transfer box and select the command Restart...
  7. Click OK, the default settings are appropriate in this case.
  8. The workflow will now end successfully. Click Done.

You can also create the notification CALL.ALARM using the  button. It has been pre-configured and information about the name of the AE system, object type etc. is then automatically included in messages.

Exercise

Select different priority levels and types in the Notification object. Start it manually and watch how the different settings affect the notification.

 

 


Automic Documentation - Tutorials - Automic Blog - Resources - Training & Services - Automic YouTube Channel - Download Center - Support

Copyright © 2016 Automic Software GmbH