Report no collection data - IX plan
Project information
Product and release | BMC Helix Operations Management Push date: 3 August 2022 |
|---|---|
Features | Report no collection data |
Content developer | Mukta Kirloskar |
Epic / User story | |
Design documents | |
Personas | |
Master space | |
Whatfix self-help plan | |
Product style sheet |
Use cases
Use case | Persona | Situation | Customer's information need | Delivery medium | Search keywords | Real-world example | Test case | Testing needs R&D help? | Review comments |
|---|---|---|---|---|---|---|---|---|---|
A user cannot determine if the data streamed from a PATROL Agent (PA) is the latest data or the PA has stopped collecting data. | Operator Administrator | Happy Path | How can I be sure that a PA is collecting data and is not down? | Wiki topic | alarm data_collection PA patrol_agent_collection patrol_agent_not_ | Jim is an Event Management Operations user in Acme. His job is to monitor events coming in from various PAs and assign the events to teams for corrective actions. For one of the PAs, Jim has not received an event for the past 2 hours. Jim is not sure if there have been no issues on the PA or if the PA has stopped collecting data. Jim needs a solution where he will receive an alarm if a PA stops collecting data. | Yes | MM: Great example 🙂️ For the customer information needs, consider also:
The last bullet point is because I saw something in the design doc about making the timing configurable. For example, by default it checks every hour, but perhaps they want to check every 30 minutes or perhaps less often. Mukta: Thank you. I have added the details in the paragraph. | |
Corner case | TBD | ||||||||
Troubleshooting | TBD | <Mukta: I have not received a use case for this.> |
Wiki structure
In the outline, list the sets of tasks, concepts, and reference information that forms a complete workflow for the use case. Depending on the complexity of the feature, you might have multiple workflows or parent/child workflows. If possible, try to keep topics only three levels deep (L2 - L4). If a topic contains a help context ID, review guidelines on IDD Central before renaming the topic.
Role | L1 - Branch | L2 | L3 | L4 | L5 | Subheadings | Topic type | Rich media | Writer notes | Review comments |
|---|---|---|---|---|---|---|---|---|---|---|
Release notes and notices | ||||||||||
22.3.01 | Out-of-the-box alarm policy to report no collection from a PATROL Agent | MM: OK. But also consider putting those details in the description, and write the headline for the goal: Detect if a PATROL Agent stops sending data Mukta: Done | ||||||||
Operator | Out-of-the-box policies > Policy to report no collection from a PATROL Agent | Reference | None | MM: This section does not list the OOTB policies, just the capabilities for each policy. Is this a capability that you are adding in the bullet points? Or a new policy that you are adding to the spreadsheet? If the latter, it seems like this information will get lost. The spreadsheet has a list of over 600 attributes for 34 policies! If you are proposing a separate subheading for this policy, I suggest making the heading an H2. Mukta: Yes, I was proposing a separate heading. I have used an H2. |
Content development references
Video guidelines | |
|---|---|
Whatfix guidelines | |
Topic analysis and content structure | |
Content models | |
Topic types and structure |
Template revised April 29, 2021