Trees       Indices       Help   
Zenoss
Products :: ZenEvents :: ActionRule :: ActionRule :: Class ActionRule
[hide private]
[frames] | no frames]

Class ActionRule

source code

                                                        object --+        
                                                                 |        
                                ZenModel.ZenModelBase.ZenModelBase --+    
                                                                     |    
                               ExtensionClass.Base --+               |    
                                                     |               |    
                         OFS.CopySupport.CopyContainer --+           |    
                                                         |           |    
              ZenRelations.RelCopySupport.RelCopyContainer --+       |    
                                                             |       |    
                               ExtensionClass.Base --+       |       |    
                                                     |       |       |    
                         OFS.CopySupport.CopyContainer --+   |       |    
                                                         |   |       |    
                               ExtensionClass.Base --+   |   |       |    
                                                     |   |   |       |    
                             App.Management.Navigation --+   |       |    
                                                         |   |       |    
                               ExtensionClass.Base --+   |   |       |    
                                                     |   |   |       |    
                                   App.Management.Tabs --+   |       |    
                                                         |   |       |    
                                  Acquisition.Implicit --+   |       |    
                                                         |   |       |    
                                Persistence.Persistent --+   |       |    
                                                         |   |       |    
                           ExtensionClass.Base --+       |   |       |    
                                                 |       |   |       |    
            webdav.EtagSupport.EtagSupport --+   |       |   |       |    
                                             |   |       |   |       |    
                  webdav.Lockable.LockableItem --+       |   |       |    
                                                 |       |   |       |    
                          webdav.Resource.Resource --+   |   |       |    
                                                     |   |   |       |    
                          webdav.Collection.Collection --+   |       |    
                                                         |   |       |    
                           OFS.Traversable.Traversable --+   |       |    
                                                         |   |       |    
                           OFS.ObjectManager.ObjectManager --+       |    
                                                             |       |    
                               ExtensionClass.Base --+       |       |    
                                                     |       |       |    
                           ExtensionClass.Base --+   |       |       |    
                                                 |   |       |       |    
                        OFS.CopySupport.CopySource --+       |       |    
                                                     |       |       |    
                           ExtensionClass.Base --+   |       |       |    
                                                 |   |       |       |    
                               App.Management.Tabs --+       |       |    
                                                     |       |       |    
                       OFS.Traversable.Traversable --+       |       |    
                                                     |       |       |    
                           ExtensionClass.Base --+   |       |       |    
                                                 |   |       |       |    
                         AccessControl.Owned.Owned --+       |       |    
                                                     |       |       |    
                              ZenRelations.ZItem.ZItem --+   |       |    
                                                         |   |       |    
                                  Acquisition.Implicit --+   |       |    
                                                         |   |       |    
                               ExtensionClass.Base --+   |   |       |    
                                                     |   |   |       |    
       AccessControl.PermissionMapping.RoleManager --+   |   |       |    
                                                     |   |   |       |    
                        AccessControl.Role.RoleManager --+   |       |    
                                                         |   |       |    
  ZenRelations.PrimaryPathObjectManager.PrimaryPathManager --+       |    
                                                             |       |    
                                   ExtensionClass.Base --+   |       |    
                                                         |   |       |    
                                      App.Undo.UndoSupport --+       |    
                                                             |       |    
ZenRelations.PrimaryPathObjectManager.PrimaryPathObjectManager --+   |    
                                                                 |   |    
                                                    object --+   |   |    
                                                             |   |   |    
                                   ExtensionClass.Base --+   |   |   |    
                                                         |   |   |   |    
                                 OFS.ZDOM.Node --+       |   |   |   |    
                                                 |       |   |   |   |    
                                  OFS.ZDOM.Element --+   |   |   |   |    
                                                     |   |   |   |   |    
                        OFS.ZDOM.ElementWithAttributes --+   |   |   |    
                                                         |   |   |   |    
                       OFS.PropertyManager.PropertyManager --+   |   |    
                                                             |   |   |    
            ZenRelations.ZenPropertyManager.ZenPropertyManager --+   |    
                                                                 |   |    
              ZenRelations.RelationshipManager.RelationshipManager --+    
                                                                     |    
                                           ExtensionClass.Base --+   |    
                                                                 |   |    
                                            OFS.History.Historical --+    
                                                                     |    
                                                        object --+   |    
                                                                 |   |    
                                      ZenModel.ZenPacker.ZenPacker --+    
                                                                     |    
                                        ZenModel.ZenModelRM.ZenModelRM --+
                                                                         |
                                                            object --+   |
                                                                     |   |
                                               EventFilter.EventFilter --+
                                                                         |
                                                                        ActionRule

Rule applied to events that then executes an action on matching events.

Instance Methods [hide private]
list 
>>> dmd.Devices.Server.breadCrumbs()
[('/zport/dmd/Devices', 'Devices'),
    ('/zport/dmd/Devices/Server', 'Server')]
breadCrumbs(self, terminator='dmd')
Return the breadcrumb links for this object add ActionRules list.		 source code
 
getEventFields(self)
Return list of fields used in format.		 source code
 
checkFormat(self)
Check that the format string has valid fields.		 source code
 
getAddresses(self)
Return the correct addresses for the action this rule uses.		 source code
 
getUser(self)
Return the user this action is for.		 source code
 
getUserid(self)
Return the userid this action is for.		 source code
 
manage_editActionRule(self, REQUEST=None)
Update user settings.		 source code
 
_clearAlertState(self)
Clear state in alert_state before we are deleted.		 source code
 
sqlwhere(self)
Return sql where to select alert_state data for this event.		 source code
 
nextActiveWindow(self) source code
 
nextActive(self) source code
 
nextActiveNice(self) source code
 
nextDurationNice(self) source code
 
repeatNice(self) source code
 
manage_addActionRuleWindow(self, newId, REQUEST=None)
Add a ActionRule Window to this device		 source code
 
manage_deleteActionRuleWindow(self, windowIds, REQUEST=None)
Delete a ActionRule Window to this device		 source code

Inherited from ZenModel.ZenModelRM.ZenModelRM: __init__, changePythonClass, creator, editableDeviceList, findChild, getCreatedTimeString, getDmdKey, getModificationTimeString, getSubObjects, getTreeItems, getZenRootNode, index_object, primarySortKey, reindex_all, rename, setTitle, unindex_object, viewName, zmanage_addProperty, zmanage_delObjects, zmanage_delProperties, zmanage_editProperties, zmanage_exportObject, zmanage_importObject, zmanage_importObjects

Inherited from ZenModel.ZenModelBase.ZenModelBase: __call__, __hash__, all_meta_types, aqBaseHasAttr, callZenScreen, checkRemotePerm, checkValidId, createHierarchyObj, custPropertyIds, custPropertyMap, getBreadCrumbName, getBreadCrumbUrlPath, getDmd, getDmdObj, getDmdRoot, getHierarchyObj, getIconPath, getIdLink, getNowString, getObjByPath, getPrimaryDmdId, getUnusedId, getZopeObj, helpLink, isLocalName, manage_deleteObjects, prepId, saveCustProperties, todayDate, upToOrganizerBreadCrumbs, urlLink, view, visibleCustPropertyMap, yesterdayDate, zenScreenUrl, zenpathjoin, zenpathsplit, zentinelTabs

Inherited from ZenModel.ZenModelBase.ZenModelBase (private): _selectedTabName

Inherited from ZenRelations.RelationshipManager.RelationshipManager: addRelation, buildRelations, cb_isMoveable, checkRelations, exportXml, exportXmlProperties, exportXmlRelationships, getRelationshipManagerId, getRelationshipNames, getRelationships, manage_addRelation, manage_removeRelation, manage_workspace, moveMeBetweenRels, moveObject, removeRelation

Inherited from ZenRelations.RelationshipManager.RelationshipManager (private): _getCopy, _notifyOfCopyTo, _setObject

Inherited from ZenRelations.PrimaryPathObjectManager.PrimaryPathObjectManager (private): _delObject

Inherited from ZenRelations.RelCopySupport.RelCopyContainer: manage_linkObjects, manage_unlinkObjects

Inherited from ZenRelations.RelCopySupport.RelCopyContainer (private): _checkId, _getRelName, _getSourceObjects, _verifyObjectLink, _verifyObjectPaste

Inherited from OFS.ObjectManager.ObjectManager: __class_init__, __contains__, __delitem__, __getitem__, __iter__, __len__, __nonzero__, __setitem__, filtered_meta_types, get, getSiteManager, hasObject, items, keys, list_imports, manage_FTPlist, manage_FTPstat, manage_afterAdd, manage_afterClone, manage_beforeDelete, manage_delObjects, manage_exportObject, manage_hasId, manage_importObject, objectIds, objectIds_d, objectItems, objectItems_d, objectMap, objectMap_d, objectValues, objectValues_d, setSiteManager, superValues, tpValues, values

Inherited from OFS.ObjectManager.ObjectManager (private): _delOb, _getImportPaths, _getOb, _importObjectFromFile, _setOb, _subobject_permissions

Inherited from OFS.CopySupport.CopyContainer: cb_dataItems, cb_dataValid, manage_CopyContainerAllItems, manage_CopyContainerFirstItem, manage_clone, manage_copyObjects, manage_cutObjects, manage_pasteObjects, manage_renameObject, manage_renameObjects, validClipData

Inherited from OFS.CopySupport.CopyContainer (private): _get_id

Inherited from App.Management.Navigation: manage_zmi_logout

Inherited from ZenRelations.PrimaryPathObjectManager.PrimaryPathManager: getPrimaryId, getPrimaryParent, getPrimaryPath, getPrimaryUrlPath, primaryAq

Inherited from ZenRelations.ZItem.ZItem: __repr__, getId, manage_editedDialog, this, titleOrId, title_and_id, title_or_id, tpURL

Inherited from OFS.CopySupport.CopySource: cb_isCopyable, cb_userHasCopyOrMovePermission

Inherited from OFS.CopySupport.CopySource (private): _canCopy, _postCopy, _setId

Inherited from App.Management.Tabs: filtered_manage_options, tabs_path_default, tabs_path_info

Inherited from webdav.Collection.Collection: DELETE, HEAD, PUT, dav__init, listDAVObjects

Inherited from webdav.Resource.Resource: COPY, LOCK, MKCOL, MOVE, OPTIONS, PROPFIND, PROPPATCH, TRACE, UNLOCK, dav__simpleifhandler, dav__validate, manage_DAVget

Inherited from webdav.Lockable.LockableItem: wl_clearLocks, wl_delLock, wl_getLock, wl_hasLock, wl_isLocked, wl_lockItems, wl_lockTokens, wl_lockValues, wl_lockmapping, wl_setLock

Inherited from webdav.EtagSupport.EtagSupport: http__etag, http__parseMatchList, http__processMatchHeaders, http__refreshEtag

Inherited from OFS.Traversable.Traversable: absolute_url, absolute_url_path, getPhysicalPath, restrictedTraverse, unrestrictedTraverse, virtual_url_path

Inherited from AccessControl.Owned.Owned: changeOwnership, getOwner, getOwnerTuple, getWrappedOwner, manage_changeOwnershipType, manage_fixupOwnershipAfterAdd, manage_takeOwnership, owner_info, userCanTakeOwnership

Inherited from AccessControl.Owned.Owned (private): _deleteOwnershipAfterAdd

Inherited from AccessControl.Role.RoleManager: ac_inherited_permissions, access_debug_info, acquiredRolesAreUsedBy, get_local_roles, get_local_roles_for_userid, get_valid_userids, has_local_roles, manage_access, manage_acquiredPermissions, manage_addLocalRoles, manage_changePermissions, manage_defined_roles, manage_delLocalRoles, manage_editRoles, manage_getUserRolesAndPermissions, manage_permission, manage_role, manage_setLocalRoles, permission_settings, permissionsOfRole, possible_permissions, rolesOfPermission, userdefined_roles, users_with_local_role, validRoles, valid_roles, validate_roles

Inherited from AccessControl.Role.RoleManager (private): _addRole, _delRoles, _has_user_defined_role, _setRoles

Inherited from AccessControl.PermissionMapping.RoleManager: manage_getPermissionMapping, manage_setPermissionMapping

Inherited from AccessControl.PermissionMapping.RoleManager (private): _isBeingUsedAsAMethod

Inherited from App.Undo.UndoSupport: get_request_var_or_attr, manage_undo_transactions, undoable_transactions

Inherited from ZenRelations.ZenPropertyManager.ZenPropertyManager: deleteZenProperty, getOverriddenObjects, getProperty, getPropertyType, getZ, hasProperty, isLocal, manage_editProperties, saveZenProperties, setZenProperty, zenPropIsPassword, zenPropertyIds, zenPropertyItems, zenPropertyMap, zenPropertyOptions, zenPropertyPath, zenPropertyString

Inherited from ZenRelations.ZenPropertyManager.ZenPropertyManager (private): _findParentWithProperty, _setPropValue, _setProperty, _updateProperty

Inherited from OFS.History.Historical: manage_afterHistoryCopy, manage_beforeHistoryCopy, manage_change_history, manage_historicalComparison, manage_historyCompare, manage_historyCopy

Inherited from ZenModel.ZenPacker.ZenPacker: addToZenPack, eligiblePacks, findObject

Inherited from EventFilter.EventFilter: genMeta, getQueryElements, getWhere, getWhereClauseAsJavaScript

Inherited from EventFilter.EventFilter (private): _whereClauseAsJavaScript

Inherited from OFS.PropertyManager.PropertyManager: manage_addProperty, manage_changeProperties, manage_changePropertyTypes, manage_delProperties, propdict, propertyDescription, propertyIds, propertyItems, propertyLabel, propertyMap, propertyValues, valid_property_id

Inherited from OFS.PropertyManager.PropertyManager (private): _delPropValue, _delProperty, _propertyMap, _wrapperCheck

Inherited from OFS.ZDOM.ElementWithAttributes: getAttribute, getAttributeNode, getAttributes

Inherited from OFS.ZDOM.Element: getChildNodes, getElementsByTagName, getFirstChild, getLastChild, getNextSibling, getNodeName, getNodeType, getParentNode, getPreviousSibling, getTagName

Inherited from OFS.ZDOM.Node: getNodeValue, getOwnerDocument, hasChildNodes

Class Methods [hide private]

Inherited from ZenRelations.RelationshipManager.RelationshipManager: lookupSchema

Class Variables [hide private]
  meta_type = "ActionRule"
  where = "severity >= 4 and eventState = 0 and prodState = 1000"
  delay = 0
  repeatTime = 0
  action = "email"
  format = "[zenoss] %(device)s %(summary)s"
  body = "Device: %(device)s\n" "Component: %(component)s\n" "Se...
  sendClear = True
  clearFormat = "[zenoss] CLEAR: %(device)s %(clearOrEventSummar...
  clearBody = "Event: '%(summary)s'\n" "Cleared by: '%(clearSumm...
  enabled = False
  actionTypes = "page", "email"
  targetAddr = ""
  plainText = False
  _properties = ZenModelRM._properties+({'id': 'where', 'type': ...
  _relations = "windows", ToManyCont(ToOne, "Products.ZenEvents....
  factory_type_information = {'id': 'ActionRule', 'meta_type': '...
  security = ClassSecurityInfo()

Inherited from ZenModel.ZenModelRM.ZenModelRM: default_catalog, isInTree

Inherited from ZenModel.ZenModelBase.ZenModelBase: index_html, sub_meta_types

Inherited from ZenModel.ZenModelBase.ZenModelBase (private): _zendoc

Inherited from ZenRelations.RelationshipManager.RelationshipManager: manage_main, manage_options

Inherited from ZenRelations.RelationshipManager.RelationshipManager (private): _operation

Inherited from OFS.ObjectManager.ObjectManager: has_order_support, isAnObjectManager, isPrincipiaFolderish, manage_addProduct, manage_importExportForm, manage_index_main, meta_types

Inherited from OFS.ObjectManager.ObjectManager (private): _components, _objects

Inherited from OFS.CopySupport.CopyContainer: manage_renameForm

Inherited from App.Management.Navigation: manage, manage_copyright, manage_form_title, manage_menu, manage_page_footer, manage_page_header, manage_top_frame, manage_zmi_prefs, zope_quick_start

Inherited from ZenRelations.ZItem.ZItem: REQUEST, __allow_access_to_unprotected_subobjects__, __name__, __propsets__, getId__roles__, icon, id, isTopLevelPrincipiaApplicationObject, title

Inherited from ZenRelations.ZItem.ZItem (private): _manage_editedDialog

Inherited from App.Management.Tabs: manage_tabs, manage_workspace__roles__

Inherited from webdav.Collection.Collection: __dav_collection__

Inherited from webdav.Resource.Resource: __dav_resource__, __http_methods__

Inherited from OFS.Traversable.Traversable: getPhysicalRoot

Inherited from AccessControl.Owned.Owned: manage_owner

Inherited from AccessControl.Role.RoleManager: __ac_local_roles__, __ac_roles__, aclAChecked, aclEChecked, aclPChecked, manage_acquiredForm, manage_editLocalRoles, manage_listLocalRoles, manage_permissionForm, manage_reportUserPermissions, manage_roleForm, permissionMappingPossibleValues, selectedRoles, smallRolesWidget

Inherited from AccessControl.Role.RoleManager (private): _normal_manage_access

Inherited from App.Undo.UndoSupport: manage_UndoForm

Inherited from ZenRelations.ZenPropertyManager.ZenPropertyManager: __pychecker__, manage_propertiesForm

Inherited from ZenRelations.ZenPropertyManager.ZenPropertyManager (private): _onlystars

Inherited from OFS.History.Historical: HistoricalRevisions, manage_change_history_page

Inherited from OFS.History.Historical (private): _manage_historyComparePage

Inherited from EventFilter.EventFilter: formName

Inherited from OFS.PropertyManager.PropertyManager: manage_propertyTypeForm, propertysheets

Inherited from OFS.PropertyManager.PropertyManager (private): _reserved_names

Method Details [hide private]

breadCrumbs(self, terminator='dmd')

source code 

Return the breadcrumb links for this object add ActionRules list. [('url','id'), ...]

Returns: list 
>>> dmd.Devices.Server.breadCrumbs()
[('/zport/dmd/Devices', 'Devices'),
    ('/zport/dmd/Devices/Server', 'Server')]
List of tuples to create a bread crumbs
Overrides: ZenModel.ZenModelBase.ZenModelBase.breadCrumbs

Class Variable Details [hide private]

body

Value:
"Device: %(device)s\n" "Component: %(component)s\n" "Severity: %(sever\
ityString)s\n" "Time: %(firstTime)s\n" "Message:\n%(message)s\n" "<a h\
ref=\"%(eventUrl)s\">Event Detail</a>\n" "<a href=\"%(ackUrl)s\">Ackno\
wledge</a>\n" "<a href=\"%(deleteUrl)s\">Delete</a>\n" "<a href=\"%(ev\
entsUrl)s\">Device Events</a>\n"

clearFormat

Value:
"[zenoss] CLEAR: %(device)s %(clearOrEventSummary)s"

clearBody

Value:
"Event: '%(summary)s'\n" "Cleared by: '%(clearSummary)s'\n" "At: %(cle\
arFirstTime)s\n" "Device: %(device)s\n" "Component: %(component)s\n" "\
Severity: %(severityString)s\n" "Message:\n%(message)s\n" "<a href=\"%\
(undeleteUrl)s\">Undelete</a>\n"

_properties

Value:
ZenModelRM._properties+({'id': 'where', 'type': 'text', 'mode': 'w'}, \
{'id': 'format', 'type': 'text', 'mode': 'w'}, {'id': 'body', 'type': \
'text', 'mode': 'w'}, {'id': 'sendClear', 'type': 'boolean', 'mode': '\
w'}, {'id': 'clearFormat', 'type': 'text', 'mode': 'w'}, {'id': 'clear\
Body', 'type': 'text', 'mode': 'w'}, {'id': 'delay', 'type': 'int', 'm\
ode': 'w'}, {'id': 'action', 'type': 'selection', 'mode': 'w', 'select\
_variable': 'actionTypes',}, {'id': 'enabled', 'type': 'boolean', 'mod\
e': 'w'}, {'id': 'targetAddr', 'type': 'string', 'mode': 'w'}, {'id': \
...

_relations

Value:
"windows", ToManyCont(ToOne, "Products.ZenEvents.ActionRuleWindow", "a\
ctionRule"),

factory_type_information

Value:
{'id': 'ActionRule', 'meta_type': 'ActionRule', 'description': """Defi\
ne action taken against events""", 'icon': 'ActionRule.gif', 'product'\
: 'ZenEvents', 'factory': 'manage_addActionRule', 'immediate_view': 'e\
ditActionRule', 'actions':({'id': 'edit', 'name': 'Edit', 'action': 'e\
ditActionRule', 'permissions':(ZEN_CHANGE_ALERTING_RULES,)}, {'id': 'm\
essage', 'name': 'Message', 'action': 'editActionRuleMessage', 'permis\
sions':(ZEN_CHANGE_ALERTING_RULES,)}, {'id': 'schedule', 'name': 'Sche\
dule', 'action': 'editActionRuleSchedule', 'permissions':(ZEN_CHANGE_A\
...

   Trees       Indices       Help   
Zenoss
Generated by Epydoc 3.0.1 on Wed Jul 14 12:01:23 2010 http://epydoc.sourceforge.net