Enterprise Content Management System Monitor 5.1 Working with Categories Revision CENIT AG Author: Marc Brandner

Transcription

1 Enterprise Content Management System Monitor 5.1 Working with Categories Revision CENIT AG Author: Marc Brandner

2 INTRODUCTION... 3 DEFINE CATEGORIES AND ASSIGN ITEMS... 4 UTILIZE CATEGORIES FOR CUSTOM TREES... 7 APPENDIX...12

3 Introduction About this Guide This guide explains use cases of the Categories feature in ECM SM on the basis of how-to guides. The explanations are valid for ECM SM and newer versions. If you are looking for a guideline on how to configure permissions for Custom Trees built with categories, refer to the chapter Procedure to grant access of custom tree to other system users in section Tips in the ECM SM Newsletter of Q If you want to notify us about mistakes or improvement suggestions, either talk to us in the IBM developerworks forums 2 or send us a mail to ECM.SystemMonitor@cenit.com. An Overview on the Categories Feature Categories are an instrument whose usage eases the interaction with the ECM SM Server UI. The feature allows the ECM SM users and administrators to group elements (tree items) displayed in the Tree view with meaningful terms and refer to these groups of items by referring to their category name. In version individual categories can be used for straightforward creation and maintenance of multiple custom tree views and also to simplify assignment of permissions on individual items as permissions can be associated with categories. Assumptions The following guide assumes that your user has access to the Event Management Console, the Tree view Categories and the User Management. 1 IBM ECM SM Newsletter 4 th Quarter November 3 rd, 2014 ECM System Monitor 5.1 Page 3 of 12

4 Define Categories and Assign Items Define Categories Before assigning an element to a category the required categories can be created separately in the Categories tree. Doing this before beginning with the assignment of categories is not mandatory, as new categories can also be created in one step together with the category assignment in the Category Assignment Dialog. To define a category open the Tree view or the Event Management Console. In the Tree view select the Categories tree element in the drop-down list. The context menu of the tree folder Categories offers the menu item New > Category. At this point you can create as much categories as needed. It makes sense to create categories which describe one characteristic feature of a tree item, for example Storage for all tree elements which are associated with your storage solution, Front-End for all datastreams and instances associated with web pages and APIs responsible for end-user experience, or New York as category for all your host in the companies branch office in New York. Figure 1: Defining a category in the Tree After creating a new category the Category Editor automatically opens. This editor is only used to unassign categories and can be closed. November 3 rd, 2014 ECM System Monitor 5.1 Page 4 of 12

5 Assign a Category to an Item The assignment of categories is accomplished in the SYSTEM tree. Right-click any tree item in the SYSTEM tree which you would like to categorize and select Assign Categories. The dialog opening up in this step is the Category Assignment Dialog. To assign a category now you have two options: Choosing an existing category (see Fig. 2) Choose one of the categories in the Category list. The list shows all available categories, including those which were defined in the Categories tree. Creating a category ad-hoc in the Category Assignment Dialog (see Fig. 3) To add a not yet existing new category in this dialog enter the favored name of this new category in the text field and add it by clicking the Plus button ( ). This field can also be used to search for categories in the list. Figure 2: Assigning predefined category "TestCategory" Figure 3: Assigning a category created ad-hoc November 3 rd, 2014 ECM System Monitor 5.1 Page 5 of 12

6 Multi-Assignments of Categories or Items In order to assign multiple categories to one tree item or multiple tree items to one category it is necessary to choose Assign Categories for one of the parent elements in the tree (DATASTREAM, HOST, INSTANCE or SYSTEM). This makes it possible to multi-select the selected item and from all subordinate items (see Figure 4). Figure 4: Assigning multiple categories to items and vice versa It is possible to categorize all types of tree items. In some cases it is useful not only to categorize hosts or datastreams, but also to categorize instances, as this provides further distinctness. Notice: If the context menu of a tree item only shows the items Refresh, but not Assign Categories, click Refresh and try again. If this behavior occurs frequently it might be possible that the Automatic Refresh (Menu bar item Options ) is deactivated. Unassign Items from Categories Switch to the Categories folder in the tree and edit a category by double-clicking it or clicking the Edit item in a categories context menu. In the area Category Items simply choose an item and click Unassign. November 3 rd, 2014 ECM System Monitor 5.1 Page 6 of 12

7 Utilize Categories for Custom Trees About Custom Trees The Tree view offers the functionality to assemble custom trees for specific use cases. These trees can consist of tree items from the SYSTEM tree which contains all available datastreams, hosts and instances. This for example, enables an ECM SM Administrator to create trees specifically for different groups of operators, e.g. one tree for the database administrator and another tree for web server administrators. These separate trees can be compiled in a way, that each tree gives an appropriate view on the events for the specific user group. Custom Trees could be created by simply copying tree items from the SYSTEM tree and inserting them into a custom tree. A more advanced way to create custom trees is the usage of categories, because it decreases the maintenance effort of Custom Trees if your environment changes. Additionally it gives other users the possibility to reuse the categories you define and maintain for their own Custom Trees. This way their multiple trees are automatically updated as soon as tree items are added to or removed from the category. Create a Custom Tree Using Categories Initially create a Custom Tree by clicking New in the Tree view ( ) and give it a meaningful name (e.g. Archiving Systems Asia ). In order to use an existing category in this newly created custom tree, switch to the Categories tree and copy one or multiple categories by selecting them in the tree and clicking the menu item Copy in the context menu. Subsequently switch back to the custom tree and Paste the copied category using the context menu either of the tree root node or of a manually created subfolder. Figure 5: Adding a category to a custom tree November 3 rd, 2014 ECM System Monitor 5.1 Page 7 of 12

8 Administrators and users can use your categories in multiple different custom trees if they have the permission to view these categories. If items are removed from or added to a category the respecting items will also appear or disappear in the trees in which the categories are used. Notice: The Categories tree solely lists the existing categories and lets you manage them. Only in the context of a custom tree the assigned items are shown as children of the category. Figure 6 shows a custom tree which can result from the examples mentioned above. Figure 6: An example custom tree built with categories November 3 rd, 2014 ECM System Monitor 5.1 Page 8 of 12

9 Combine Categories to Subsets Besides the possibility to create subfolders in a custom tree to provide additional structure there is another way to fully scoop the capabilities of the Categories feature: Existing categories can also be nested. The benefit of nesting categories is that subsets of one or multiple categories can easily be displayed. A real-world example. Suppose that there are four categories: On the one hand two categories Development and Production which shall label tree items from a staging pointof-view, on the other hand two categories Singapore and Bangalore which shall label systems by their physical location. If each host in your tree view is categorized with an adequate stage and physical location it allows you to setup a tree like it is shown in Figure 7. Figure 7: Custom tree with subsets example The number of steps needed to set up a tree of this kind is manageable once you are familiar with the steps explained in the previous chapters: 1. Create categories which label the physical locations ( location categories ). Use the Categories tree to add new categories. 2. Also create categories which label the stage they are assigned to ( stage categories ). 3. Assign the appropriate hosts to the location categories. Achieve this using the context menu of individual hosts in the HOST folder of the SYSTEM tree. 4. Also assign the appropriate hosts to the stage categories. In case a host accomplishes tasks in multiple stages, it is possible to link a host with multiple categories. 5. Create a new custom tree, for example called MyEnvironment. November 3 rd, 2014 ECM System Monitor 5.1 Page 9 of 12

10 6. Now build up the first level of the tree structure. For this purpose copy the category elements (location categories) in the Categories tree using Copy in the context menu (right click on a category in the Categories tree). Multiselect is supported for this use case. 7. Subsequently switch to your custom tree, right-click the tree root (a folder named MyEnvironment in this example) and paste the copied location categories subordinate to the tree root by using Paste in the context menu. 8. The next step is to build up the second level of the tree structure. Copy the category elements (stage categories) in the Categories tree using Copy in the context menu. 9. To finish the tree switch to the custom tree and paste the copied stage categories subordinate to each of the location category elements which we added to the custom tree in step 7. This tree gives you the following display options (descriptions refer to figure 7): Selecting tree node Development (child node of Bangalore ) will show events for the Development systems in Bangalore Selecting the parent element Singapore will only show events from systems from the Singapore site (Development and Production). Select the root node MyEnvironment will show all events from Bangalore and Singapore regardless if they are in the Development or the Production stage. This way you are not compelled to create categories like DEV-Singapore or PROD- Bangalore, as the maintenance effort would increase rapidly if additional new physical locations or stage levels are to be added. If further systems are added to the Development or Production stages on those two sites they will automatically appear in the respective nodes as long as they are properly categorized after their first occurrence in the SYSTEM tree. November 3 rd, 2014 ECM System Monitor 5.1 Page 10 of 12

11 Additional Explanations As a general approach these nested combinations are very similar to set theory: If Category B is subordinate to Category A, Category B will only show those events which Category A and B have in common (intersection). If Category A and B are on the same level of a tree their parent item will show events from both categories regardless if they both categories have them in common (union). A limitation regarding nested categories: Consider a limitation when you create nested custom trees using categories in order to dynamically display subsets. Once a category consists of objects of different types, the tree will not be able to dynamically subsets does not work anymore. This only works using categories which only contain one type of element (either only HOST, only INSTANCE or only DATASTREAM elements). November 3 rd, 2014 ECM System Monitor 5.1 Page 11 of 12

12 Appendix List of Figures Figure 1: Defining a category in the Tree... 4 Figure 2: Assigning predefined category "TestCategory"... 5 Figure 3: Assigning a category created ad-hoc... 5 Figure 4: Assigning multiple categories to items and vice versa... 6 Figure 5: Adding a category to a custom tree... 7 Figure 6: An example custom tree built with categories... 8 Figure 7: Custom tree with subsets example... 9 November 3 rd, 2014 ECM System Monitor 5.1 Page 12 of 12