To import and export event projects
What is an event project?
An event project configures the Entuity event management system (EMS). Entuity comes with a default event project, which is given the version number 1, that includes:
- over 350 system events.
- over 100 system incidents.
- syslog events.
- derived events, e.g. Port Flapping. Port Flapping is generated only when the Detect Flapping rule is met with the Port Down and Port Up events (which are in turn derirved from the Port Link Down and Port Link Up events).
- rules, e.g. Filter Port Status Events. This rule does not raise Port Link Down and Port Link Up events for ports that have status events deactivated.
Rules are defined under either the Pre Storage folder or the Post Storage folder:
- rules defined under Pre Storage are applied to events before those events are saved to the database or raised in the UI.
- rules defined under Post Storage are applied to events after those events are saved to the database but before incidents are raised in the UI.
- actions, e.g. to send emails, forward SNMP traps.
You can make changes to an event project. It will only configure the EMS once you have saved and deployed the project.
Please see this video for a quick tutorial on event projects in Entuity.
Viewing your event projects:
- Click the Main Menu and then Administration. This will open the Administration page.
- Click Event Administration. This will open the Event Administration page.
- Click the View all projects link in the top left.
- This will open the Project History page.
- This page contains a table listing all event projects you have on your current server. If there are remote servers, you can access the event project history of a remote server by selecting it from the Server dropdown field at the top of the page. The table contains the following information:
Column Name Description Status if the project is Live, Draft or in Archive. Only one event project can be live at any time.
Live - project is currently applied to the EMS.
Draft - project is different from the current live project. It is saved to the server but has never been deployed to the server. You can have more than one draft project, and you can delete them from the system.
Archived - project was once applied to the server, but it is not currently applied. Archived projects are retained to allow you to reinstate a previous event project. You can delete archived event projects, but not the original event project supplied with Entuity.
Valid if the project is valid for deployment. Description description given to the event project upon saving it. This is the displayed name of the event project. From Entuity v20.0 upwards, this description cannot contain any of the following characters:
- <
- >
- \
Version version number assigned to the project upon saving it. Deployed Time date and time the project was last deployed. Deployed By user who deployed the project. Updated Time date and time the project was last updated. Updated By user who updated the project.
To edit an event project
You can make changes to an existing event project to beast suit your requirements, which when saved will become a new event project with its own automatically assigned version number.
Only users belonging to a user group with the Event Administration permission can edit event projects and perform the deployment of new projects.
Please find below an example edit to an event project:
Changing the period over which port state changes are counted, to determine whether the port is flapping:
In this example, we want to change the detection window from 2 minutes to 1 minute.
- Navigate to the Event Administration page, as described above.
- Click the Rules tab.
- On the left of the browser, open the Pre Storage stage.
- Open the Flapping stage.
- Select Detect Port Flapping. Click Edit to open the Edit Rule window.
- In the Detection - seen all of the following events in last fields, change the value from 2 to 1.
- Click OK to close the window.
- You now have two options, both in the top right of the browser. Choose between either:
- Save and deploy - this will save and deploy the new event project immediately, superseding the existing project.
- If you click this option, the Save and Deploy Project window will open.
- Enter a description in the Description field - this will be displayed as the 'name' of the event project. If you keep the description the same as the existing project, it will simply update the existing project.
- Click OK, otherwise click Cancel.
- The Project History page will then be updated to include this project, which will have its own version number automatically assigned.
- If you click this option, the Save and Deploy Project window will open.
- Save as draft - this will save the project as a draft, and it will go into the list of event projects on the Project History page.
- Enter a description in the Description field - this will be displayed as the 'name' of the event project. If you keep the description the same as the existing project, it will simply update the existing project.
- To deploy this project at a later time, navigate to the Project History page, select this project and click Deploy in the bottom right of the browser.
- Enter a description in the Description field - this will be displayed as the 'name' of the event project. If you keep the description the same as the existing project, it will simply update the existing project.
- Save and deploy - this will save and deploy the new event project immediately, superseding the existing project.
To deploy an event project:
When editing an event project, click Save and deploy in the top right of the window to immediately deploy that project.
Alternatively, navigate to the Project History page as described above, select the event project you want to deploy, and click Deploy at the bottom of the window.
To import and export event projects:
You can import and export Entuity event projects between Entuity servers. This is done by exporting the event configuration from one server to an XML file, and then importing that XML file to the second server.
Importing and exporting event projects is useful because it allows you to make changes on one server, and then copy these changes to other servers, and therefore keep all servers in sync.
To export an event project:
- Navigate to the Event Administration page as described above.
- Click View all projects to open the Project History page.
- Find and select the event project that you want to export, and click Export in the bottom right of the browser.
- Entuity will generate a unique filename and prompts you to open or save the event project file. Save the file, ensuring it is saved or copied to a location that is accessible from the import server.
To import an event project:
- Navigate to the Project History page on the import server.
- Click Import in the bottom right of the browser. This will open the file browser. Find and open the event project file.
- The project will be loaded as a draft project in the Project History list, and you can now deploy it at any time.
You can directly edit the event project file and then import it and its amendments into Entuity, but you should only do so under guidance from Entuity Support.
To delete event projects:
- Navigate to the Project History page as described above.
- Select the event project you want to delete.
- Click Delete in the bottom left corner of the window. Confirm that you want to delete the project, otherwise click Cancel.
To merge event projects:
As well as editing event projects, you can also merge any two selected event projects. This is useful, for example, if you want to:
- install a new Entuity release that has an updated event project but you also want to retain the customizations of your current project.
- apply a particular event project setup from an old project to your current project.
- apply settings from an imported project to your current project.
The event project merge function identifies differences between the two selected event projects and allows you to select the required version of each conflict.
When the merge is complete, you will have a new event project. The two source event projects will remain unchanged.
- Navigate to the Project History page and select the two projects you want to merge. Click Merge in the bottom right of the browser.
- The Merge Project window will open, and you will be asked to select which project to use as the base for the merge. The second project will then be compared to the base project.
- Entuity compares the following set of components and attributes to identify differences between the projects. Entuity will also identify if the two projects are identical.
Component Comparison Attributes Events* Name (custom events only)
Severity
Description (custom events only)Incidents** Name
Enabled
Description
Opened By
Updated By
Closed By
Age Out
ExpiryTrigger Name
Description
On Transition To
Condition
Tests (when condition is not none)
Invert Test Result (when condition is not none)
Delay
State After Delay (when delay is not none)
Action StepsRules Name
Description
Enabled
Validity
Condition
Behavior (Processing Stages Only)
Schedule (Rules Only)
Action (Rules Only)
Parent
Order of common children (Processing Stages Only)Variables Description
ValueConditions Description
Parameters
Condition
Tests
Invert Test ResultActions Description
Parameters
Action StepsOthers Description
Expression (target alias only)
Storage (custom attribute only)
*Note, system event Name and Description are not project specific nor user definable. They are only changed as part of an Entuity upgrade. Because these attributes are not user definable, an event project merge would not identify any changes to them.
**Note, incident definitions are completely user definable, therefore all incident attributes are compared during a merge. The Merge Details tab (see step 5 below) will list one row per incident. - Once you have selected your base event project, click OK. The UI will open in the Event Administration page, with the project description of '[base event project] vs [second event project]'. Where there is a difference between the two projects, Entuity will change the font of the tab title (Events, Incidents, Rules, Variables, Conditions, Actions, Others) to red and include an asterisk.
- Events:
- merge checks for differences in the following event attributes:
- Name of custom events.
- Severity level.
- Description of custom events.
- system event Name and Description are not project-specific or user-configurable, and are only changed as part of an Entuity upgrade. Therefore, merge would not identify any changes to them.
- merge checks for differences in the following event attributes:
- Incidents:
- incident definitions are completely user configurable, and therefore all incident attributes are compared during merge.
- Global Triggers are not associated to a particular incident, but are available to all incidents. Merge associates a change to a Global Trigger with the Default Incident.
- Rules:
- merge checks for differences in the following rule attributes:
- Name.
- Description.
- Enabled state.
- Validity.
- Condition.
- Behavior (Processing Stages Only).
- Schedule (Rules Only).
- Action (Rules Only).
- Parent.
- Order of common children (Processing Stages Only).
- merge checks for differences in the following rule attributes:
- Variables:
- merge checks for differences in the following variables attributes:
- Description.
- Value.
- merge checks for differences in the following variables attributes:
- Conditions:
- merge checks for differences in the following condition definitions:
- Description.
- Parameters.
- Condition.
- Tests.
- Invert Test Result.
- merge checks for differences in the following condition definitions:
- Actions:
- merge checks for differences in the following action definitions:
- Description.
- Parameters.
- Action Steps.
- merge checks for differences in the following action definitions:
- Others:
- merge checks the differences in the following custom attributes:
- Description.
- Expression (target alias only).
- Storage (custom attribute only).
- merge checks the differences in the following custom attributes:
- Events:
- To see the differences between projects, select the component and click the Merge Details tab at the bottom of the window to expand it. The tab will display both the base and second project's settings for that component, and if you wish, you can select the second project's settings by clicking its radio button.
- The status symbol in the leftmost column of the list above the Merge Details tab will be updated, depending on the difference between the two project settings and the selection you make. The status symbols are as follows:
Status Description
Grey italic textindicates the object does not exist in the base project. The proposal is to include this object to the merged project, but it requires you to select this version from the Merge Details tab.
Black regular textindicates the object does not exist in the base project, but you have selected it to include it in the merged project.
Black regular textindicates the object exists in the base project, but does not exist in the second project.
Grey italic textindicates the object exists in the base project, but by selecting the version in the second event project, you have decided not to include it in the merged project.
Black regular textindicates the object exists in both projects, but with different attribute values. The proposal is to apply values from the second project, but it requires you to select this version from the Merge Details tab.
Grey italic textindicates the object exists in both projects, with different attribute values, but you have selected to include the values from the second project to the merged project. indicates the position of the node in the base project, and that it has changed position in the second project. indicates the position of the node in the second project, and that you have selected that position for the merged project. - At the end of the merge process, either click the Save as draft or Save and deploy button as you would with any other event project. If you navigate away from the Event Administration page before you save the merge project, Entuity will maintain the current state of the merge process in your browser session.
- If you end the browser session, then your changes will be lost.
- If you attempt to start a new merge during the same browser session, Entuity will warn you that a merge job is already in progress and that to continue would result in you losing the merge process that is already in progress.
New patches:
After installing a new patch, a new event project will be created as a draft in EMS. You will then need to deploy the draft project, or merge it with an existing project.
Comments
0 comments
Please sign in to leave a comment.