Skip to content

Instantly share code, notes, and snippets.

@tcosentino
Created January 13, 2014 22:18
Show Gist options
  • Save tcosentino/8409214 to your computer and use it in GitHub Desktop.
Save tcosentino/8409214 to your computer and use it in GitHub Desktop.
Org list documentation

Org List

This document will serve as documentation on how to display the list of org/groups.

Change Log

  • 1/13/14 - Troy Cosentino - created

Open questions

  • what orgs do we show on the map?

Hierarchy

We will only distinguish between two different levels of the hierarchy. First we have the top level orgs, those that have no parents, only children. Then we will lump all children into a second tier. To start, only the top level orgs are displayed in the list. Each top level card will have an 'expand' button in the bottom right corner. When expand is clicked, all child org/groups will be displayed below it, slightly indented to show the difference, but have the same information on the card.

Selection

When an org/group is selected, all children are selected by default - regardless of it being top level or not. De-selecting any org/group makes all of its parent org/groups de-select as well, to conform to the first statement. Examples (starred means selected):

mg
|-mg.mg1
| |-mg.mg1.mg4
| | |-mg.mg1.mg4.mg8
| | |-mg.mg1.mg4.mg9
| | |-mg.mg1.mg4.mg10
| | |-mg.mg1.mg4.mg11
| |-mg.mg1.mg5
|-mg.mg2
| |-mg.mg1.mg6
|-mg.mg3
| |-mg.mg1.mg7

Select mg.mg1

mg
|-*mg.mg1*
| |-*mg.mg1.mg4*
| | |-*mg.mg1.mg4.mg8*
| | |-*mg.mg1.mg4.mg9*
| | |-*mg.mg1.mg4.mg10*
| | |-*mg.mg1.mg4.mg11*
| |-*mg.mg1.mg5*
|-mg.mg2
| |-mg.mg1.mg6
|-mg.mg3
| |-mg.mg1.mg7

De-select mg.mg1.mg9

mg
|-mg.mg1
| |-mg.mg1.mg4
| | |-*mg.mg1.mg4.mg8*
| | |-mg.mg1.mg4.mg9
| | |-*mg.mg1.mg4.mg10*
| | |-*mg.mg1.mg4.mg11*
| |-*mg.mg1.mg5*
|-mg.mg2
| |-mg.mg1.mg6
|-mg.mg3
| |-mg.mg1.mg7

Alarm Status

The alarm status of an org should be passed up to all of its ancestors. Example (starred means in alarm):

mg
|-mg.mg1
| |-mg.mg1.mg4
| | |-mg.mg1.mg4.mg8
| | |-mg.mg1.mg4.mg9
| | |-mg.mg1.mg4.mg10
| | |-mg.mg1.mg4.mg11
| |-mg.mg1.mg5
|-mg.mg2
| |-mg.mg1.mg6
|-mg.mg3
| |-mg.mg1.mg7

mg.mg1.mg4.mg9 goes into alarm

*mg*
|-*mg.mg1*
| |-*mg.mg1.mg4*
| | |-mg.mg1.mg4.mg8
| | |-*mg.mg1.mg4.mg9*
| | |-mg.mg1.mg4.mg10
| | |-mg.mg1.mg4.mg11
| |-mg.mg1.mg5
|-mg.mg2
| |-mg.mg1.mg6
|-mg.mg3
| |-mg.mg1.mg7

mg.mg1.mg5 goes into alarm

*mg*
|-*mg.mg1*
| |-*mg.mg1.mg4*
| | |-mg.mg1.mg4.mg8
| | |-*mg.mg1.mg4.mg9*
| | |-mg.mg1.mg4.mg10
| | |-mg.mg1.mg4.mg11
| |-*mg.mg1.mg5*
|-mg.mg2
| |-mg.mg1.mg6
|-mg.mg3
| |-mg.mg1.mg7

mg.mg1.mg4.mg9 comes out of alarm

*mg*
|-*mg.mg1*
| |-mg.mg1.mg4
| | |-mg.mg1.mg4.mg8
| | |-mg.mg1.mg4.mg9
| | |-mg.mg1.mg4.mg10
| | |-mg.mg1.mg4.mg11
| |-*mg.mg1.mg5*
|-mg.mg2
| |-mg.mg1.mg6
|-mg.mg3
| |-mg.mg1.mg7
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment