IBM Training Filenet CM 5-2 Implementation and Administration - Excercises.pdf

V10.1

cover

IBM Training Front cover Student Exercises IBM FileNet Content Manager 5.2: System Implementation and Administration Course code F115 ERC 6.0

Student Exercises

Trademarks IBM, the IBM logo, and ibm.com are trademarks or registered trademarks of International Business Machines Corp., registered in many jurisdictions worldwide. The following are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide: Cognos® FileNet® Prospect®

WebSphere® Lotus® Quickr®

DB2® Notes® Tivoli®

Adobe is either a registered trademark or a trademark of Adobe Systems Incorporated in the United States, and/or other countries. Microsoft and Windows are trademarks of Microsoft Corporation in the United States, other countries, or both. Java™ and all Java-based trademarks and logos are trademarks or registered trademarks of Oracle and/or its affiliates. Other product and service names might be trademarks of IBM or other companies.

May 2015 edition The information contained in this document has not been submitted to any formal IBM test and is distributed on an “as is” basis without any warranty either express or implied. The use of this information or the implementation of any of these techniques is a customer responsibility and depends on the customer’s ability to evaluate and integrate them into the customer’s operational environment. While each item may have been reviewed by IBM for accuracy in a specific situation, there is no guarantee that the same or similar results will result elsewhere. Customers attempting to adapt these techniques to their own environments do so at their own risk. This information contains examples of data and reports used in daily business operations. To illustrate them as completely as possible, the examples include the names of individuals, companies, brands, and products. All of these names are fictitious, and any similarity to the names and addresses used by a real business enterprise is entirely coincidental. © Copyright International Business Machines Corporation 2013, 2015. This document may not be reproduced in whole or in part without the prior written permission of IBM. US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.

V10.1 Student Exercises

TOC

Table of Contents Table of Contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iii Trademarks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiii Course description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xv Unit 0. Course introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 0-1 0.1. Roles and responsibilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 0-3 Roles and responsibilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 0-4 Activities that you need to complete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 0-5 Role descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 0-6 Solution development and deployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 0-7 Course overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 0-8 Course Objectives . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 0-9 Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 0-10 Unit 1. Introduction to IBM FileNet Content Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1 Unit Lessons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2 Lesson 1.1. Introduction to IBM FileNet Content Manager. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3 Introduction to IBM FileNet Content Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4 Activities that you need to complete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5 What is IBM FileNet Content Manager? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6 IBM FileNet P8 product bundles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8 Content management capabilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-11 Integration capabilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-14 Social capabilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-17 IBM FileNet Content Manager solutions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-19 Industry examples of solutions on FileNet P8 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-21 Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-23 Lesson 1.2. System Architecture and Startup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-25 System Architecture and Startup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-26 Activities that you need to complete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-27 Single-server versus distributed systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-28 Sample distributed system architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-29 Student system details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-30 Core components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-31 Content Platform Engine: Content components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-34 Content Platform Engine: Process components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-36 Components that must be started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-37 Component dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-39 Determine Content Platform Engine status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-40 Start and stop the Content Platform Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-41 Startup troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-42 Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-43 Lesson 1.3. Use Content Navigator to Work with Content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-45 Use Content Navigator to Work with Content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-46 Activities that you need to complete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-47 Objects, properties, and classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-48 © Copyright IBM Corp. 2013, 2015 Course materials may not be reproduced in whole or in part without the prior written permission of IBM.

Table of Contents

iii

Student Exercises

Folders and documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-50 Adding content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-52 Document versioning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-55 Version status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-57 IBM Content Navigator interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-58 IBM Content Navigator Viewers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-60 FileNet Viewer interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-61 Annotations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-62 Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-64 Lesson 1.4. Content Storage Concepts and Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-65 Content Storage Concepts and Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-66 Activities that you need to complete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-67 Content Engine storage components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-68 What is a FileNet P8 domain? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-69 What is a site? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-71 Sample FileNet P8 domain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-72 Object stores . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-73 What is the object store database? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-74 Object store table schemas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-76 What is a file storage area? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-77 What is a content cache area? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-79 Using object store components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-80 Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-81 Unit 2. Build an Object Store . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-1 Unit lessons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-2 Lesson 2.1. Create an Object Store . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-3 Create an Object Store . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-4 Activities that you need to complete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-5 What is an Object Store? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-6 What is IBM FileNet Configuration Manager? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-7 Testing JDBC Data Sources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-8 Database Connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-9 Sharing Database Connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-10 Prepare to Create an Object Store . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-12 Add-ons for an Object Store . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-14 Modifying an Object Store . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-16 Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-18 Lesson 2.2. Create a File Storage Area and a Storage Policy . . . . . . . . . . . . . . . . . . . . . . . . . .2-19 Create a File Storage Area and a Storage Policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-20 Activities that you need to complete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-21 Storing content for Content Platform Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-22 File Storage Area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-24 File Storage Area Directory Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-26 File Storage Area Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-27 Guidelines for Managing File Storage Area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-29 Content Compression . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-31 Resource statuses of File Storage Area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-33 Storage Area Activation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-35 Storage Policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-37 Assigning Storage Areas to a Storage Policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-39 iv

System Implementation and Administration

© Copyright IBM Corp. 2013, 2015

Course materials may not be reproduced in whole or in part without the prior written permission of IBM.


TOC

Use Storage Policies to Distribute the Content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-41 Storage Policies and Storage Areas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-42 Set default storage location for a Document class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-43 Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-44 Lesson 2.3. Create Properties and Choice Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-45 Create Properties and Choice Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-46 Activities that you need to complete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-47 What is a Property? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-48 What is a Property Template? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-50 What is a Property Definition? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-52 What are Choice Lists? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-54 Using Choice Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-56 How are Classes, Properties, and Choice Lists Related? . . . . . . . . . . . . . . . . . . . . . . . . . 2-57 Working with Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-58 Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-59 Lesson 2.4. Create Document and Folder Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-61 Create Document and Folder Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-62 Activities that you need to complete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-63 What is a Class? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-64 Class Inheritance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-66 Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-68 Containment Concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-69 What are Document Objects? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-70 Steps to Create a Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-71 Guidelines for Creating or Modifying a Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-72 Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-74 Lesson 2.5. Modify Classes and Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-75 Modify Classes and Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-76 Activities that you need to complete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-77 Changing a Display Name for a Metadata Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-78 Modifying a Choice List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-79 Assigning a Different Document Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-80 Metadata Dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-82 Deleting metadata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-83 Delete a property template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-84 Remove property definitions from a class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-85 How do you find metadata dependencies? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-86 Delete a class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-87 Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-88 Unit 3. Extend Content Platform Engine Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1 Unit lessons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2 Lesson 3.1. Create a Subscription with an Event Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3 Create a Subscription with an Event Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-4 Activities that you need to complete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-5 About Server Extensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-6 Events and Subscriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-8 Define Subscription Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-10 Workflow Subscription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-12 Launching Workflows: Property Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-13 Expressions in Event Subscriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-14 © Copyright IBM Corp. 2013, 2015 Course materials may not be reproduced in whole or in part without the prior written permission of IBM.

Table of Contents

v

Student Exercises

Steps to create an Event Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-15 Update Event Action with new code module version . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-17 Disabling Subscriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-18 Subscription Run Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-19 Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-20 Unit 4. Configure IBM Content Navigator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-1 Unit lessons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-2 Lesson 4.1. Configure a Content Navigator Desktop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-3 Configure a Content Navigator Desktop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-4 Activities that you need to complete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-5 Common administrative configuration tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-6 IBM Content Navigator web client components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-7 IBM Content Navigator Admin Desktop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-9 Repository connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-11 Repository configuration parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-13 Configure desktops for business roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-15 Customizing Menus and Toolbars . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-17 Customizing the Layout and Appearance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-18 Viewer Maps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-19 Configuring Content Navigator web client label text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-21 Configuring Content Navigator for workflows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-22 Controlling user access to desktops . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-23 Server logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-24 Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4-26 Unit 5. Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-1 Unit lessons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-2 Lesson 5.1. Security Concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-3 Security Concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-4 Activities that you need to complete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-5 Security in the IBM FileNet P8 domain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-6 Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-7 Authorization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-9 Security principals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-11 Users and groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-12 Security realms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-13 Access rights . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-14 Security sources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-15 Security sources and order of evaluation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-16 Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-18 Lesson 5.2. Modify Direct Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-19 Modify Direct Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-20 Activities that you need to complete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-21 What is direct security? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-22 Access Control From Workplace XT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-23 Access Control from IBM Content Navigator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-24 Ownership . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-26 Permission Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-27 Permission Levels in FileNet Enterprise Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-28 Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-29 vi





TOC

Lesson 5.3. Configure Object Store Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-31 Configure Object Store Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-32 Activities that you need to complete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-33 Required Accounts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-34 Configure Object Store Administrators and Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-35 Example security scenario . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-37 Overview of Initial Security Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-38 Super Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-39 Update object store with new principals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-40 Root folder security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-42 Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-43 Lesson 5.4. Configure Class and Property Security. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-45 Configure Class and Property Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-46 Activities that you need to complete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-47 Default instance security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-48 Setting default instance security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-49 Property modification security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-50 Configure Property Modification Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-51 System Property Modification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-52 Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-53 Lesson 5.5. Configure Security Inheritance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-55 Configure Security Inheritance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-56 Activities that you need to complete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-57 Overview of Security Inheritance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-58 Definition of terms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-59 Security Inheritance Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-61 Characteristics of inherited permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-62 Inheritable permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-63 Methods for configuring security inheritance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-64 Use a Security Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-66 Use an object as a security proxy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-67 Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-69 Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-70 Lesson 5.6. Work with Security Policies. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-71 Work with Security Policies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-72 Activities that you need to complete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-73 Document version states . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-74 Two kinds of security templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-75 Security policies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-76 Security policy architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-78 When to use security policies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-79 Security policy guidelines (1) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-80 Security policy guidelines (2) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-81 Security Policy Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-82 Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-83 Unit 6. Optimizing Search Performance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1 Unit lessons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2 Lesson 6.1. Create Property Indexes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-3 Create Property Indexes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-4 Activities that you need to complete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-5 © Copyright IBM Corp. 2013, 2015 Course materials may not be reproduced in whole or in part without the prior written permission of IBM.

Table of Contents

vii

Student Exercises

Searching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-6 What is property-based searching? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-7 Content Engine and the database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-8 How a user request can affect the database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-9 What are property indexes? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-10 Locating data without an index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-11 Indexing properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-12 Property indexing guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-13 Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-14 Lesson 6.2. Create Stored Searches and Search Templates . . . . . . . . . . . . . . . . . . . . . . . . . .6-15 Create Stored Searches and Search Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-16 Activities that you need to complete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-17 Why do you create searches? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-18 Considerations for creating searches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-19 An overview of searches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-20 Types of searches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-21 Simple search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-22 Search Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-23 Operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-24 Search criteria options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-25 Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-26 Lesson 6.3. Configure Content Search Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-27 Configure Content Search Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-28 Activities that you need to complete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-29 What is content-based retrieval (CBR)? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-30 What is a content index? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-31 What is IBM Content Search Services? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-32 Starting and stopping IBM Content Search Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-33 What is an index area? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-34 Use affinity groups to control server assignment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-35 Enable Content Based Retrieval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-37 Domain level tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-39 IBM Content Search Server console commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-40 Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-42 Lesson 6.4. Configure Index Partitions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-43 Configure Index Partitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-44 Activities that you need to complete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-45 What is an index partition? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-46 Configuring Index partitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-47 Settability values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-48 Selecting a string property for an index partition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-49 Use a date property for a partition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-50 Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-51 Lesson 6.5. Create Content Based Indexes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-53 Create Content Based Indexes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-54 Activities that you need to complete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-55 Index areas and full-text indexes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-56 Index area states . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-57 Automatic activation of index areas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-59 Enable Content Based Retrieval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-61 Object store level tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6-63 viii





TOC

Create an index area object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-64 Index jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-66 How to run a CBR search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-68 CBR SQL query format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-70 CBR enabled properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-71 Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-72 Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-73 Lesson 6.6. Optimize CBR Queries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-75 Optimize CBR Queries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-76 Activities that you need to complete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-77 Combined CBR ad database searches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-78 How the mixed query works . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-79 CBR Query Optimization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-80 Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-81 Handling requests for ranked results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-82 Configure CBR query optimization options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-83 Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-84 Unit 7. Deploy Assets with FileNet Deployment Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1 Unit lessons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2 Lesson 7.1. Configure Deployment Environments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-3 Configure Deployment Environments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4 Activities that you need to complete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-5 What is application deployment? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-6 What is a FileNet application? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-7 FileNet P8 data and configuration information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-8 What is FileNet Deployment Manager? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-9 Connected and Disconnected Uses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-10 IBM FileNet Application Deployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-11 What is an environment? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-12 Deployment process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-13 How to create an environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-15 Deployment Tree Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-17 Terminology review . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-18 Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-20 Lesson 7.2. Export Assets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-21 Export Assets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-22 Activities that you need to complete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-23 Export assets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-24 Exporting assets overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-25 Asset preparation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-26 What is an Export Manifest? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-29 How do you add assets to the Export Manifest? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-30 Select Include Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-31 What Type of Data to Export? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-34 Asset Include Option propagation example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-35 Export Options dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-36 Deploy Dataset structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-37 Deploy Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-38 Deployment Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-39 Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-40 © Copyright IBM Corp. 2013, 2015 Course materials may not be reproduced in whole or in part without the prior written permission of IBM.

Table of Contents

ix

Student Exercises

Lesson 7.3. Retrieve source and destination half maps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-41 Retrieve source and destination half maps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-42 Activities that you need to complete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-43 Prepare Half Maps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-44 How to create half maps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-45 Retrieve Object Store Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-46 Retrieve Security Principal Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-47 Retrieve Security Principal Data - Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-48 Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-50 Lesson 7.4. Map and Convert Assets. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-51 Map and Convert Assets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-52 Activities that you need to complete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-53 Map and convert assets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-54 Create the Source-Destination Pair . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-55 What options are available for Data Maps? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-56 What is an Object Store Map? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-57 What is an Object Store Map? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-59 Data Map Icons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-61 View and update a data map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-62 Edit labels: Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-64 What is a Security Principal Map? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-65 Many-to-one security principal mappings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-66 Convert assets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-67 Troubleshoot conversion issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-68 Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-70 Lesson 7.5. Analyze and Import Assets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-71 Analyze and Import Assets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-72 Activities that you need to complete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-73 Analyze and import assets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-74 What is a Change Impact Analysis Report? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-75 Analyze a Change Impact Analysis Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-77 Resolve failures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-78 Change Impact Analysis Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-79 Import Options window (1) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-80 Import Options window (2) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-82 Import Options window (3) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-84 Import Options window (4) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-86 Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7-87 Unit 8. Manage Sweep Jobs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-1 Unit lessons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-2 Lesson 8.1. Configure a Sweep Job. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-3 Configure a Sweep Job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-4 Activities that you need to complete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-5 Sweep Framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-6 Sweep Framework Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-7 Types of Sweeps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-8 Job Sweeps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-9 Use Bulk Move Content Job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-10 Properties of Bulk Move Content Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-11 Sweep Job Monitoring tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8-13 x





TOC

Filter Expression Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-14 Storage Policy Property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-15 End Replication After Move Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-16 Lab Scenario: Objects Used for Bulk Move Content Job . . . . . . . . . . . . . . . . . . . . . . . . . . 8-18 Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-19 Lesson 8.2. Work with Sweep Policies. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-21 Work with Sweep Policies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-22 Activities that you need to complete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-23 Policy-Controlled Sweeps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-24 Sweep Policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-25 Disposal Policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-26 Properties of Policy-Controlled Sweeps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-27 More information about other Sweeps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-28 Queue Sweeps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-29 Retention Update Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-30 Thumbnail Generation Job Sweep . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-32 Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-33 Unit 9. System Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-1 Unit Lessons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-2 Lesson 9.1. Perform Searches and Bulk Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-3 Perform Searches and Bulk Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-4 Activities that you need to complete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-5 Actions on Multiple Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-6 Types of Multiple-object Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-7 Actions and Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-8 Perform Bulk Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-9 Perform Batch Operations (1) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-10 Perform Batch Operations (2) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-11 Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-12 Lesson 9.2. Work with Audit Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-13 Work with Audit Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-14 Activities that you need to complete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-15 What is auditing? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-16 Why audit? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-17 Audit Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-18 Audit Definition Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-19 Object operations that you can audit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-20 Audit entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-21 Audit Definition Extensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-22 View Audit Entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-23 Audit Disposition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-24 Where to configure auditing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-26 Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-27 Lesson 9.3. Work with System Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-29 Work with System Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-30 Activities that you need to complete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-31 Content Platform Engine System Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-32 System Log Locations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-33 Trace Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-34 Trace Subsystem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-35 © Copyright IBM Corp. 2013, 2015 Course materials may not be reproduced in whole or in part without the prior written permission of IBM.

Table of Contents

xi

Student Exercises

Web Application Server Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-37 More Tools for the Workflow System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-38 Guidelines: Monitor Log Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-39 Guidelines: Manage the Growth Of Log Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-40 Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9-41

xii





TMK

Trademarks The reader should recognize that the following terms, which appear in the content of this training document, are official trademarks of IBM or other companies: IBM, the IBM logo, and ibm.com are trademarks or registered trademarks of International Business Machines Corp., registered in many jurisdictions worldwide. The following are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide: Cognos® FileNet® Prospect®

WebSphere® Lotus® Quickr®

DB2® Notes® Tivoli®

Adobe is either a registered trademark or a trademark of Adobe Systems Incorporated in the United States, and/or other countries. Microsoft and Windows are trademarks of Microsoft Corporation in the United States, other countries, or both. Java™ and all Java-based trademarks and logos are trademarks or registered trademarks of Oracle and/or its affiliates. Other product and service names might be trademarks of IBM or other companies.

© Copyright IBM Corp. 2013, 2015 Course materials may not be reproduced in whole or in part without the prior written permission of IBM.

Trademarks

xiii

Student Exercises

xiv





Unit 1. Introduction to IBM FileNet Content Manager

EXNoSideHead

Unit overview Lessons Lesson 1.1, "Introduction to IBM FileNet Content Manager," on page 1-3 Lesson 1.2, "System Architecture and Startup," on page 1-9 Lesson 1.3, "Use IBM Content Navigator to Work with Content," on page 1-23 Lesson 1.4, "Content Storage Concepts and Components," on page 1-39

Requirements The activities in this unit assume that you have access to the student system configured for these activities.




1-1

Student Exercises

1-2





Lesson EXNoSideHead

1.1. Introduction to IBM FileNet Content Manager

Overview Why is this lesson important? You are new to IBM FileNet Content Manager. You must know what IBM FileNet Content Manager is and how it is used.

Activities • Identify functions of IBM FileNet Content Manager solutions: Written exercise, on page 1-5 • Explore the architecture: Interactive exercise, on page 1-7

User accounts Type

User ID

Password

Operating system

administrator

passw0rd

WebSphere Administrator

P8Admin

IBMFileNetP8

Note Passwords are always case-sensitive.




1-3

Student Exercises

1-4





Identify EXNoSideHead

functions of IBM FileNet Content Manager solutions: Written exercise Introduction Identify the functions of IBM FileNet Content Manager solutions. For each question, indicate the correct answer or the best answer. 1. Which product is the core of the IBM FileNet P8 family of products? a. IBM Case Manager b. IBM Content Manager c. IBM FileNet Content Manager d. IBM Content Federation Services 2. Which two clients connect to IBM FileNet Content Manager by using FileNet Collaboration Services? a. Microsoft Office and SharePoint b. IBM Connections and Lotus Quickr c. IBM Content Manager OnDemand and SAP d. IBM Enterprise Records and IBM Case Manager 3. A user can tag managed objects by using which client? a. IBM Connections b. FileNet Workplace XT c. Administration Console for the Content Platform Engine d. Application Engine 4. IBM FileNet Content Manager is the former name of the product IBM Content Manager. True or False?




1-5

Student Exercises

1-6





Explore EXNoSideHead

the architecture: Interactive exercise

Introduction An interactive architecture diagram is included on your student system. Take a few minutes to explore the diagram and then answer the questions that follow.

Instructions 1. Log on to your student system as Administrator: - User name: Administrator - Password: passw0rd 2. Open the P8 Architecture folder on the desktop of your student system. 3. Open P8 Architecture.htm in Firefox. 4. Take a few moments to explore the system architecture diagrams. - Hover your cursor over components to read about them. - Click components to learn more about them. - Click the Main Map button to go back to the start. 5. Answer the questions in the following section.

Questions Select the best answer. 1. Where does the component integrator for non-legacy components run? a. Application Engine. b. FileNet Workplace XT. c. Rendition Engine. d. Content Platform Engine. 2. Which product uses OLAP cubes? a. Case Analyzer b. Rendition Engine c. Datacap d. Image Services Resource Adapter




1-7

Student Exercises

3. Rendition is based on which product? a. Adobe PDF Maker. b. Liquent InSight Rendering c. FileNet Image Services d. Datacap 4. What controls document security after it is declared as a record? a. A security template b. A record template c. A record object d. A security object 5. What protocol does the Content Platform Engine use to communicate with the Rules Listener? a. SOAP b. TCP/IP c. RPC d. HTTP

1-8





Lesson EXNoSideHead

1.2. System Architecture and Startup

Overview Why is this lesson important? You are going to implement a business solution on an IBM FileNet Content Manager system. You must be able to identify the system components and their functions. You are going to be working with an IBM FileNet Content Manager system. Occasionally, you must stop or restart the system.

Activities • Identify system components: Written exercise, on page 1-11 • Start and stop System Components: Activity, on page 1-13 • Verify that the system is started: Activity, on page 1-19

User accounts Type

User ID

Password

Operating system

administrator

passw0rd


P8Admin

IBMFileNetP8





1-9

Student Exercises

1-10 System Implementation and Administration




Identify EXNoSideHead

system components: Written exercise

Introduction Identify the function of each system component. For each question, indicate the correct answer or the best answer. 1. The Content Platform Engine handles process management services. True or False?

2. Which component is not an IBM FileNet P8 component? a. Rendition Engine b. Content Navigator c. Object store d. Directory service

3. What is the primary administration tool for the Content Platform Engine? a. Administration Console for the Content Platform Engine b. FileNet Enterprise Manager c. Configuration Manager d. Deployment Manager

4. You can log in to Administration Console for the Content Platform Engine, but you cannot see any of the object stores. Which cause is most likely? a. The application server is down. b. IBM FileNet Content Manager is down. c. The directory service is down. d. The RDBMS is down.




1-11

Student Exercises





Start EXNoSideHead

and stop System Components: Activity

Introduction In this activity, you start the IBM Content Manager system and then use the Ping pages to check the system status. You then shut down individual components and observe the results of the component dependencies.

Procedures Procedure 1, "Start WebSphere Application Server," on page 1-13 Procedure 2, "View the Content Engine Startup Context page," on page 1-14 Procedure 3, "Open the Content Platform Engine log files," on page 1-14 Procedure 4, "View the Process Engine Server Information (Ping Page)," on page 1-14 Procedure 5, "View web applications," on page 1-15 Procedure 6, "Shutdown individual components," on page 1-16 Procedure 7, "Restart the system components," on page 1-17

Procedure 1: Start WebSphere Application Server WebSphere Application Server hosts the following applications: • Tivoli Directory Server Administration tool • Content Platform Engine • IBM Content Navigator • Administration Console for Content Platform Engine • FileNet Workplace XT 1. Click Start > All Programs > IBM WebSphere > IBM WebSphere Application Server V8.5 > Profiles > AppSrv01 > Start the server. 2. Wait for the Start the server window to close. Note You can also use the Start the Server batch file in the WebSphere Admin folder on the desktop to start WebSphere Application Server.




1-13

Student Exercises

Procedure 2: View the Content Engine Startup Context page The Content Engine Startup Context (Ping Page) provides detailed information about the Content Platform Engine. You can use the Ping Page to quickly determine whether the Content Platform Engine is running. 1. Use Firefox to open the Content Engine Startup Context page. - http://ecmedu01:9080/FileNet/Engine - In general, the URL is http://:/FileNet/Engine. 2. Verify the following information: - Product name: P8 Content Platform Engine - 5.2.0 - Log file location: C:\Program Files\IBM\WebSphere\AppServer\profiles\AppSvr01\FileNet\server1 - P8 Domain: P8Domain - JDBC Driver: IBM DB2 JDBC Universal Driver Architecture 3.62.56

Procedure 3: Open the Content Platform Engine log files Inspect the Content Platform Engine log files. If startup problems occur, the log files provide information for troubleshooting. 1. Go to the location of the log files that you identified in the previous procedure. 2. View each log file by using Notepad. - p8_server_error.log - p8_server_trace.log - pesvr_system.log - pesvr_trace.log Note The Content Platform Engine has two main services: Content Services and Process Services. Both services create log files in the same location. Content Service log files begin with “p8,” while Process Service log files begin with “pe.”

Procedure 4: View the Process Engine Server Information (Ping Page) The Process Service also has a ping page. 1. Use Firefox to open the Process Engine Server Information (Ping Page). - http://ecmedu01:9080/peengine/IOR/ping - In general, the URL is http://:/peengine/IOR/ping. 2. If prompted, log on as P8Admin. 1-14 System Implementation and Administration




EXNoSideHead - User name: P8Admin - Password: IBMFileNetP8 3. Review the information on this page. - Some of the information is the same as on the Content Engine ping page. - The Process Engine ping page includes Helpful links at the bottom of the page. - The Database row shows database connection information.

Procedure 5: View web applications You can view the applications that are running in the WebSphere Administrative Console. From there, you can also shut down and restart any web application individually. 1. Use Firefox to open the WebSphere Administrative Console: - https://ecmedu01:9043/ibm/console - In general, the URL is https://:/ibm/console Note The URL is a secure location. Do not forget to include the “s” in https.

2. Log in to WebSphere Integrated Solutions Console as P8Admin. - User name: P8Admin - Password: IBMFileNetP8 3. In the navigation pane, go to Applications > Application Types > WebSphere enterprise applications. 4. Verify that the following applications are running (running applications display a green arrow in the Application Status column): Application name FileNetEngine IDSWebApp WorkplaceXT p8docs navigator SampleEDSService

Purpose IBM Content Platform Engine Directory Services Web Administration console. FileNet Workplace XT Local P8 5.2 Information Center IBM Content Navigator A sample external data service




1-15

Student Exercises

Procedure 6: Shutdown individual components In this procedure, you shut down the components individually. You are viewing the Enterprise Applications in the WebSphere Integrated Solutions Console. 1. Stop FileNet Workplace XT and IBM Content Navigator: a. In WebSphere Integrated Solutions Console, select the FileNet Workplace XT and IBM Content Navigator applications. b. Click Stop. c. Wait for the Application Status to change to stopped. 2. Stop FileNetEngine. 3. Log out from WebSphere integrated Solutions Console. 4. Stop WebSphere Application Server: a. Click Start > All Programs > IBM WebSphere > IBM WebSphere Application Server V8.5 > Profiles > AppSrv01 > Stop the server. b. Enter the following username and password to stop the server: - User name: P8Admin - Password: IBMFileNetP8 Note You can also use Stop the Server.bat in the WebSphere Admin folder on the desktop. The batch file enters the username and password for you.

5. Stop the database server software for the Content Platform Engine: a. Open the Windows Services Console: Click Start > Services. b. Locate the two DB2 server instances:

c. Stop these two database services. Note IBM Tivoli directory Server Instance V6.3 - dsrdbm01 stops when you stop the directory database instance.





Procedure EXNoSideHead

7: Restart the system components

1. Start the Directory Server and Content Platform Engine database DB2 server instances in this order: a. DB2 - TDSV63DB2 - DSRDBM01 (Directory Services DB2 instance) b. DB2-TDSV63DB2 - DB2TDS63-0 (Content Platform Engine DB2 instance) c. IBM Tivoli Directory Server Instance V6.3 - dsrdbm01 (Directory server) 2. Start WebSphere Application Server.




1-17

Student Exercises





Verify EXNoSideHead

that the system is started: Activity

Introduction In this exercise, you check that the system is running and functioning normally. Whenever you start working with a system in an unknown state, it is useful to do a quick verification to ensure that all of the components are started.

Procedures Procedure 1, "Check Content Platform Engine status," on page 1-19 Procedure 2, "Check object store connectivity," on page 1-19 Procedure 3, "Check the workflow system," on page 1-20

Procedure 1: Check Content Platform Engine status Open the ping pages to verify that the Content Platform Engine is running. If the ping pages do not display, start the system. 1. Open the Content Engine ping page: - http://ecmedu01:9080/FileNet/Engine 2. Open the Process Engine ping page as P8Admin - http://ecmedu01:9080/peengine/IOR/ping - User name: P8Admin - Password: IBMFileNetP8

Procedure 2: Check object store connectivity 1. Open the Administration Console for the Content Platform Engine website in Firefox: • http://ecmedu01:9080/acce 2. Log on to Administration Console for the Content Platform Engine as P8Admin. - User name: P8Admin - Password: IBMFileNetP8




1-19

Student Exercises

3. Verify object store connectivity by expanding the object store node and selecting the object stores to view their properties

- If you get an error when you attempt to open the object store, the object store database might be offline. 4. Log out from Administration Console for the Content Platform Engine.

Procedure 3: Check the workflow system One quick way to check the workflow system is to open the Tasks page. The Tasks page connects to the process region and displays tasks that are assigned to you. If it cannot connect to the process region, then the process service is not running, or FileNet Workplace XT is configured incorrectly. Information If you see a Java update message, select the “Do not ask me again” option and then click “Later.”

1. Log on to FileNet Workplace XT as P8Admin. a. Use Firefox to browse to http://ecmedu01:9080/WorkplaceXT.





EXNoSideHead b. Log on as P8Admin • User name: P8Admin • Password: IBMFileNetP8 2. Verify that the workflow system is running by clicking the Tasks page icon.

- If the Tasks page opens to My Inbox, then the workflow system is running. 3. Log out from FileNet Workplace XT. 4. Close the browser.

Summary In this lesson, you started the P8 system and verified that the components started.




1-21

Student Exercises





Lesson EXNoSideHead

1.3. Use IBM Content Navigator to Work with Content

Overview Why is this lesson important? You are planning to implement a FileNet P8 Content Manager system. Most users are going to use Content Navigator to work with documents. You need to understand how users are going to use Content Navigator.

Activities • Use IBM Content Navigator to work with content: Tour, on page 1-25 • Practice working with content: Exercises, on page 1-35

User accounts Type

User ID

Password

Operating system

administrator

passw0rd

P8 Administrator

P8Admin

IBMFileNetP8

Loan Officer

Olivia

filenet

Clerk

Clark

filenet

P8User

Pamela

filenet





1-23

Student Exercises





Use EXNoSideHead

IBM Content Navigator to work with content: Tour

Introduction Perform the procedures in this lesson to learn basic content management skills.

Procedures Procedure 1, "Log in to IBM Content Navigator," on page 1-25 Procedure 2, "Browse object stores," on page 1-26 Procedure 3, "Inspect document properties," on page 1-26 Procedure 4, "View document content," on page 1-27 Procedure 5, "Create annotations," on page 1-27 Procedure 6, "Search for documents by title," on page 1-28 Procedure 7, "Search for documents by using other metadata," on page 1-28 Procedure 8, "Add folders," on page 1-29 Procedure 9, "Add a document to an object store," on page 1-30 Procedure 10, "Optional: Test document security," on page 1-31 Procedure 11, "File a document," on page 1-31 Procedure 12, "Checkout," on page 1-32 Procedure 13, "Optional: Verify document reservation," on page 1-32 Procedure 14, "Check in," on page 1-33 Procedure 15, "Inspect document versions," on page 1-33

Procedure 1: Log in to IBM Content Navigator 1. Open Firefox and go to http://ecmedu01:9080/navigator. 2. Log in to Content Navigator as Olivia: - User name: Olivia - Password: filenet Information IBM Content Navigator is configured to open to the Browse page on your system. The default repository is the Sales object store.




1-25

Student Exercises

Procedure 2: Browse object stores Olivia has access to multiple object stores. As Olivia, you can browse the Sales object store and the LoanProcess object store. The Sales object store opens by default. 1. Open the LoanProcess object store by selecting LoanProcess from the object store menu.

2. Inspect the folders and contents in the LoanProcess object store by expanding the folder nodes and viewing the contents in the contents panel. 3. Select the Loans folder. The folder contents are displayed in the content area. 4. Select the document titled J Jones’ Loan. 5. Review the information that is displayed in the properties pane on the right. Note The document class is HomeLoan, which includes many custom properties that are specific to home loan documents, such as CustomerName, Address, LoanAmount, DownPayment. Content Navigator also provides a preview of the document.

Procedure 3: Inspect document properties You can get more details about the document properties by using the Properties page. 1. With the J Jones’ Loan document selected, click Properties. The Properties page opens to the Property tab by default. 2. Inspect the property values for this document. 3. Verify that the property values are visible, but not editable by attempting to change the LoanAmount value. 4. Expand the System Properties section at the bottom of the Properties window. System properties are read-only. 5. Click the Security tab. 6. Verify that Olivia, as a member of the Loan Officers group, is a reader for this document, but is not an author or an owner. 7. Click the Versions tab. This document has only one version. 8. Click Folders Filed In. This document is filed in only one folder. 9. Click Cancel.





10. Log out from IBM Content Navigator. EXNoSideHead

Procedure 4: View document content The IBM Content Navigator Viewer provides many tools that you can use to change how you view the document, including rotating, flipping, reversing, and splitting the views on the screen. 1. Log in to IBM Content Navigator as P8Admin: - User name: P8Admin - Password: IBMFileNetP8 2. Open J Jones’ Loan document. a. Open the LoanProcess object store. b. Open the Loans folder. c. Select J Jones’ Loan. d. Click Actions > Open. The document opens in the Viewer. 3. Experiment with the Viewer controls to magnify, rotate, and invert the image. 4. Return the image to its original view. 5. Click the View item properties button to view the image and properties at the same time.

Procedure 5: Create annotations The Viewer provides tools for adding annotations to the document. If you have Author access to the document, you can save the annotations. 1. Use the Draw Highlight annotator to highlight the Down Payment amount.

2. Hover your cursor over the highlighted area. Verify that the annotation has associated metadata.




1-27

Student Exercises

3. Right-click the highlighted area. New controls open that allow you to change or delete the annotation. 4. Delete the annotation. 5. Add a stamp that shows that the document was approved: a. Click the Stamps button. b. Select Reviewed c. Click the open space at the top of the document, just to the right of the word LoanID. d. Click somewhere else on the page. The stamp automatically includes your user name and the date. 6. Click the Save button to save your annotation changes.

7. Close the Viewer.

Procedure 6: Search for documents by title IBM Content Navigator includes a search tool for finding documents. You can use this tool to search for documents or folders by their metadata. You are signed in as p8admin and you have the LoanProcess object store open. 1. Click the Search icon.

2. Create a search: a. Click New Search. b. Enter the following search options: Property Document Title

Operator Like

Value Jones

3. Click Search to execute the search. 4. Verify that the Jones’s loan document is returned, as well as two bank statements.

Procedure 7: Search for documents by using other metadata Searches can be more useful if you use more specific properties. In this example, you are interested in loans over $250,000. 1. Expand the Search Criteria area. 2. Create and execute a search for all loan documents for which the LoanAmount is greater than 250000. 1-28 System Implementation and Administration




3. Verify that your results match the graphic: EXNoSideHead

4. Log out from IBM Content Navigator.

Procedure 8: Add folders When you add a document or folder, you set the property values and the security. You are going to add two folders. The first folder is going to be for Loan Officers. The second folder is for all P8 users. 1. Log in to IBM Content Navigator as Clark, a clerk. - User name: Clark - Password: filenet 2. Open the Sales object store. 3. Click New Folder 4. Name the folder New Docs. 5. Expand the security area to specify folder security: a. In the Security area, click Select. b. Select Groups in the Search for menu. c. Type Clerks in the search field. d. Click Search. e. Select Clerks and use the arrow button to add them to the Selected field. f.

Select Author from the Permissions menu.




1-29

Student Exercises

g. Click Add.

b

c

d

Clerks

e Clerks

f g

h. Verify that Clerks are now listed in the Author permission area. i.

Click the X to remove P8Users from the Reader permission area.

6. Click Add to create the folder. 7. Verify that you can see your new folder. 8. Create a second folder named Public that allows all P8Users to add documents. a. Click New Folder. b. Name the folder Public. c. In the Security area, click the P8Users link. d. Select Authors from the menu. e. Click OK. P8Users are moved from Readers to Authors. f.

Click Add.

Procedure 9: Add a document to an object store You can add documents to the folder that you recently created. 1. Open the New Docs folder.





2. Add a document to this folder. EXNoSideHead a. Click Add Document. b. Click Browse to select a document from the local machine. c. Browse to C:\SalesQA\Content. d. Select the Approved Basic Model 200.doc e. Click Open. f.

In the Document Title field, change the title to Approved Basic Model 201.doc

g. Click Add. 3. Verify that you can see the new document in the folder. 4. Log out from IBM Content Navigator. Information The Document Title property automatically takes the value of the file name. However, you can edit the Document Title.

Procedure 10:Optional: Test document security General P8Users are Readers of this document, but they do not have access to the New Docs folder. P8Users cannot browse to the document, however, they can search for it. You are going to log in as Pamela, a P8User who is not a Clerk, in order to verify. 1. Log in to IBM Content Navigator as Pamela: - User name: Pamela - Password: filenet 2. On the Browse page, verify that the New Docs folder is not visible in the Sales object store. 3. Open the Search page. 4. Create a search for documents that have “201” in the title by using the “like” operator. 5. Verify that the search returns the document that you recently added as Clark. 6. Log off from IBM Content Navigator.

Procedure 11:File a document A single document can be filed in multiple folders within an object store. 1. Log in to IBM Content Navigator as Clark. - User name: Clark - Password: filenet 2. On the Browse page, go to the Sales object store > New docs.




1-31

Student Exercises

3. Select the document that you added to this folder. 4. Click Actions > Folders > Add to Folder. 5. Select the Public folder. You can select only folders to which you have Author access. 6. Click Add. 7. Open the Public folder to verify that the document is now filed in two folders. Information Other folder options include moving and removing from the folder. If you move a document from one folder to another, then the document is no longer filed in the original folder. If a document is removed from all folders, it continues to exist as an unfiled document that can be found by using Search tools.

Procedure 12:Checkout When you are working on a document, you can check it out so that other users cannot edit it. While the document is checked out, only the person who checked it out (or the administrator) can change it. In this procedure, you are going to change the file name of the document to match the document title. You are logged in as Clark. 1. Go to the Sales object store > New docs. 2. Select the document that you added to this folder. 3. Click Actions > Check Out > Check Out and Download. 4. Save the file. 5. Locate the file on the local machine. By default, Firefox saves the file in C:\Users\Administrator\Downloads. 6. Change the file name to Approved Basic Model 201.doc. 7. On IBM Content Navigator, verify that the document has a lock icon. This icon means that the document is checked out.

8. Log out from IBM Content Navigator.

Procedure 13:Optional: Verify document reservation Clark filed the document in the Public folder, so all P8 users can browse to it. The document is checked out, so only Clark can edit it. You are going to verify these statements. 1. Log on to IBM Content Navigator as Pamela: - User name: Pamela





EXNoSideHead - Password: filenet 2. On th Browse page, open the Public folder. 3. Verify that you can see the document that you added as Clark. 4. Verify that the document is checked out. 5. Select the document and click Actions. 6. Verify that the Check Out action is disabled. 7. Log out from IBM Content Navigator.

Procedure 14:Check in As Clark, you checked out a document and changed the content element. When you check the document back in, a new version of the document is created in the repository. 1. Log in to IBM Content Navigator as Clark. - User name: Clark - Password: filenet 2. On the Browse page, go to the Sales object store > New Docs. 3. Select the document that you added to this folder. 4. Click Actions > Check In. 5. Browse for the document that you changed. If you saved it in the default location, it is in C:\Users\Administrator\Downloads. 6. Select the document. 7. Click Open. 8. Click Check In. 9. Verify that the lock icon is gone. The document is checked in.

Procedure 15:Inspect document versions The document that you checked in has a version history. You can download and read earlier versions of the document. You can also determine when the document versions were created and by whom. You are logged in to IBM Content Navigator as Clark. You are viewing the Public folder of the Sales object store. 1. Select the document that you recently checked in. 2. Click Properties. 3. Open the Versions tab.




1-33

Student Exercises

4. Verify that the document has two versions that were modified by Clark on both occasions. The latest version is Released and the prior version is Superseded.

5. Click Cancel to close the Properties page. 6. Log out from IBM Content Navigator.





Practice EXNoSideHead

working with content: Exercises Complete the three exercise scenarios to practice the procedures that you learned in this lesson. You must complete the exercises in order.

Scenario 1: Loan document inspection You are Olivia, a loan officer. You receive a call from a clerk regarding a loan with government ID of 571982480. The borrower claims that the loan term of 30 years is incorrect. You must review the loan information.

Challenge • Use the Search page to find the loan document. • Compare the value of the LoanTerm property with the loan term as it was handwritten on the form.

Data Loan documents are in the LoanProcess object store.

Verification • Your search returned George Green’s loan. • You were able to compare the property value of the loan document side by side with the scanned content. • You determined that the loan term matched.




1-35

Student Exercises

Scenario 2: Changing document access You are an administrator. Olivia, a loan officer, has requested Author access to a George Green’s loan document in order to add annotations.

Challenge • Add Olivia as an Author to George Green’s Loan document.

Data • P8admin’s password: IBMFileNetP8 • Olivia’s password: filenet • George Green’s Loan document is in LoanProcess > Loans.

Hint • You must log on as P8Admin to make the security change, then log on as Olivia to test the change.

Verification • In the Security tab of the property page, Olivia is listed as an Author.





Scenario EXNoSideHead

3: Annotations You are Olivia, a loan officer. You need to make annotations to a loan document to highlight the loan term.

Challenge • Create and save an annotation to George Green’s Loan.

Data • George Green’s Loan document is in LoanProcess > Loans.

Hint • Olivia must have Author access to save annotations to the document. You must have completed the previous scenario.

Verification • After you save the annotation, close and reopen the document. The annotation must be visible.

Summary In this lesson, you used IBM Content Manager to perform the most common content user tasks, including the following task: • • • • • • • • • • • • •

Log in to IBM Content Navigator Browse object stores Inspect document properties View document content Create annotations Search for documents by title Search for documents by other metadata Add folders Add a document to an object store File a document Checkout Check in Inspect document versions




1-37

Student Exercises





Lesson EXNoSideHead

1.4. Content Storage Concepts and Components

Overview Why is this lesson important? You are going to implement the content storage system. You need to be familiar with the storage capabilities and components of an IBM FileNet Content Manager system.

Activities • Examine the P8 Domain structure: Tour, on page 1-41

User accounts Type

User ID

Password

Operating system

administrator

passw0rd

P8 administrator

P8Admin

IBMFileNetP8





1-39

Student Exercises





Examine EXNoSideHead

the P8 Domain structure: Tour

Introduction As an administrator or solution builder, you must be able to quickly find any structure within the P8 Domain. In this exercise, you locate and examine structures within the P8 domain. Important Do not make changes to the domain, site, or database settings.

Procedures Procedure 1, "Start WebSphere," on page 1-41 Procedure 2, "Explore domain structures by using Administration Console for the Content Platform Engine," on page 1-41 Procedure 3, "Explore domain structures by using FileNet Enterprise Manager," on page 1-43 Procedure 4, "Explore the site by using FileNet Enterprise Manager," on page 1-44 Procedure 5, "Obtain a document GUID," on page 1-45 Procedure 6, "Inspect storage areas," on page 1-46 Procedure 7, "Inspect databases," on page 1-47 Procedure 8, "Inspect the gcdDBfile," on page 1-48

Procedure 1: Start WebSphere If the IBM WebSphere Application Server is not started, you need start it now. 1. Click Start > All Programs > IBM WebSphere > IBM WebSphere Application Server V8.5 > Profiles > AppSrv01 > Start the server. 2. Wait for the Start the server window to close.

Procedure 2: Explore domain structures by using Administration Console for the Content Platform Engine Examine the hierarchical structure of a P8 domain by using Administration Console for the Content Platform Engine. 1. Log in to Administration Console for the Content Platform Engine as P8Admin: a. In Firefox, go to http://ecmedu01:9080/acce.




1-41

Student Exercises

b. Log in: - User name: P8Admin - Password: IBMFileNetP8 2. Examine the P8 domain properties: a. Select P8Domain at the top of the tree view. b. Open the Properties tab to review the domain properties. c. Open the Directory Configuration tab. Verify that IBM Tivoli is used as a directory service provider. 3. Examine the database connections: a. Expand the Global Configuration > Administration > Database Connections node. b. Verify that one database connection exists: FNOSDS. 4. Examine the object stores: a. Expand the Object Stores node. b. Verify that you see the following object stores: - LoanProcess - LoanProcessQA - P8ConfigObjectStore - Sales - SalesQA - SalesSBx Information Six object stores share a database connection. Using a single database connection for multiple object stores can reduce administration time.

5. Examine the site. a. Expand P8Domain > Global Configuration > Administration > Sites. b. Expand Initial Site. Only one site exists. c. Select Content Cache Areas. Verify that none exist. d. Select Index Areas. e. Select Object Stores. f.

Select Rendition Engine Connections

g. Select Storage Areas.





EXNoSideHead

Information

These items are not yet supported in Administration Console for the Content Platform Engine. You must use FileNet Enterprise Manager to inspect them.

h. Expand Virtual Servers > P8Node01 > server1 i.

Review the properties of the virtual server, opening tabs as needed.

j.

Verify that on most tabs, virtual server settings are inherited from the P8Domain. Information

You can override those settings for this server by selecting server1 as the configuration source. e

6. Close unnecessary tabs. 7. Inspect Process Engine connection points: a. Open the P8ConfigObjectStore node. b. Expand Administrative > Workflow System > Connection Points. c. Select P8ConnPt1. 8. Inspect the process region: a. Click the isolated region: P8Region hyperlink. b. Review the configuration data for P8Region. c. Confirm that the table space used for the P8Region is PEDATA_TS. 9. Log out from the Administration Console for the Content Platform Engine. 10. Close Firefox.

Procedure 3: Explore domain structures by using FileNet Enterprise Manager FileNet Enterprise Manager provides another view into the P8 Domain, and also provides different capabilities. 1. Log in to FileNet Enterprise Manager: a. Double-click the FileNet Enterprise Manager desktop icon. b. Click Connect.




1-43

Student Exercises

Hint FileNet Enterprise Manager sometimes starts behind other windows. If you double-clicked the desktop icon, but do not see the connection window, select the task from the Tasks bar.

2. Examine the P8 Domain properties: a. Right-Click Enterprise Manager [P8Domain]. b. Select Properties. c. Inspect the following tabs, but do not change any data: - General - Directory Configuration - IBM Search Servers d. Click Cancel when you are finished inspecting the information. 3. Select the Database Connections node. Confirm that a single database connection exists: FNOSDS. 4. Expand the Object Stores node. Confirm that multiple object stores exist. 5. Select the PE Connection Points node. Verify that you can find the P8ConnPt1 connection point. 6. Select the PE Region Ids node. Confirm that you can find P8region. 7. Minimize FileNet Enterprise Manager. Information In Administration Console for the Content Platform Engine, the process region and connection point are specified at the object store level. In FileNet Enterprise Manager, the process region and connection point are specified at the domain level. In either case, each region uses a connection point.

Procedure 4: Explore the site by using FileNet Enterprise Manager Your student system has one site. In this procedure, you use FileNet Enterprise Manager to inspect the structures of that site. 1. Restore FileNet Enterprise Manager. 2. Expand the Sites node. 3. Inspect the Initial Site: a. Expand and select Initial Site. - Verify that the site components are shown in both the navigation tree and the details pane. 1-44 System Implementation and Administration




EXNoSideHead - Verify that the site properties are shown in the details pane. b. Right-Click Initial Site. c. Select Properties. The site properties page displays. 4. Click cancel on the Properties page. 5. Minimize FileNet Enterprise Manager. Information The site properties page has several tabs. The tabs correspond to the properties shown in the details pane. From here, you can change the site properties. The property values are disabled because they are inherited from the P8 Domain. If you choose to override these inherited values, you can set the values here.

Procedure 5: Obtain a document GUID Every object has a globally unique identifier (GUID). The GUID is a system property that you cannot change. You can view this ID by using different tools. 1. Open the Administration Console for the Content Platform Engine website in Firefox: • http://ecmedu01:9080/acce 2. Log on to Administration Console for the Content Platform Engine as P8Admin. - User name: P8Admin - Password: IBMFileNetP8 3. Open the Sales object store. 4. Select Browse > Root Folder > Manuals. 5. Select User Manual for Basic Model A.doc. You might need to expand the column for document titles in order to read the entire title. 6. Open the Properties tab. 7. Scroll down until you find the ID field. This ID is the Global Unique Identifier (GUID). 8. Select the text in the ID field and copy that text to the clipboard. 9. Log out from Administration Console for the Content Platform Engine. 10. Close Firefox. Information The Globally Unique Identifier (GUID) is a unique string that individually identifies every object. The GUID cannot be changed, so it can reference the same document regardless of document title, file name, or other changes.




1-45

Student Exercises

Procedure 6: Inspect storage areas Your student system has several database storage areas and file storage areas. You can manage these storage areas by using FileNet Enterprise Manager. Although metadata is stored in the object store, the content can be stored in the file system. You are going to inspect a storage area and also find a document in the file system. 1. Restore FileNet Enterprise Manager. 2. Select the Storage Areas folder under the Initial Site. 3. Verify that you see both the database storage areas and the file storage areas that belong to this site.

Information Each object store has a default database storage area. Additionally, three object stores have file storage areas. The file storage areas correspond to folders in the file system. The File Count and File Bytes columns show the file storage usage. For example, the Sales file storage area contains 51 files. Your file count might be a different number.

4. Right-click the Sales file storage area and select Properties. 5. Note the root directory field: c:\filenet\file_stores. 6. Click Cancel. 7. Close FileNet Enterprise Manager. 8. Using Windows Explorer, navigate to c:\filenet\file_stores on your student system. 9. Search for the document in the file store: a. Paste the GUID of the User Manual for Basic Model A into the search field in Windows Explorer.

b. The search returns one document. c. Open the file location. 1-46 System Implementation and Administration




EXNoSideHead d. Open the document by using Microsoft Word Viewer. e. Verify that it is the User Manual for Basic Model A document. 10. Close Microsoft Word Viewer. 11. Close the Windows Explorer folder. Information The Content folder contains the documents. The document file names are replaced by their GUIDs. They are contained in two levels of folders named FNX, where X is an integer between 1 and 22.

Procedure 7: Inspect databases The Content Platform Engine uses several databases. The Global Configuration Database contains information about the P8 domain, such as object stores and add-ons. Object store databases contain all of the object store metadata and sometimes content. 1. Open the DB2 Control Center: a. Click Start > All Programs > IBM DB2 > TDSV63DB2 (Default) > General Administration Tools > Control Center. b. Select Advanced mode and then click OK. 2. Expand All Databases. 3. Verify that you see the following databases: • GCD_DB: This database is for the GCD. • NEXUSDB: This database is for IBM Content Navigator. • OS_DB: This database is for the object stores. 4. Expand OS_DB. 5. Select Table Spaces. 6. Verify that you can see the following table spaces: • CEDATA_TS: This table space is for content services. • PEDATA_TS: This table space is for process services. 7. Select CEDATA_TS. 8. Click Show Related Objects. 9. Scroll through the list of objects. Verify that you can find the following objects: • DocVersion table: This table has a row for each document. Searches for documents are executed against this table. • Schema names for each object store. 10. Close the CEDATA_TS objects window.




1-47

Student Exercises

11. Close the DB2 Control Center. Information Each object store has its own set of tables, including a DocVersion table. The tables are listed under separate schema names.

Procedure 8: Inspect the gcdDBfile Each site maintains a copy of the GCD in a local file named gcdDBfile. If the GCD cannot be reached when the Content Platform Engine server is started, the server starts in File Fallback Mode. The server starts by reading from the gcdDBfile. This file is updated whenever an update is made to the GCD. You can inspect the file to see what information is contained in the GCD. Additionally, you can send the file to customer support if you need to provide information about your system configuration. 1. Use Windows Explorer to go to C:\Program Files\IBM\WebSphere\Appserver\profiles\AppSrv01\FileNet\server1\GCD. 2. Copy the file and rename the copy to gcdDBFile.Copy.xml. 3. Open the copy by using Internet Explorer. 4. Inspect the contents of this file. Use the search field to try to find the following objects: • An add-on (search for AddOn) • An isolated region (search for Region). • An object store (search for ObjectStore). 5. Close Internet Explorer. 6. Close Windows Explorer.

Summary In this lesson, you located and examined structures in a P8 Domain, including: • Sites • Object stores • File storage areas • Database tables • The local gcdDBFile





Unit 2. Build an Object Store

EXNoSideHead

Unit Overview This unit contains these lessons.

Lessons Lesson 2.1, "Create an Object Store," on page 2-3 Lesson 2.2, "Create a File Storage Area and a Storage Policy," on page 2-25 Lesson 2.3, "Create Properties and Choice Lists," on page 2-43 Lesson 2.4, "Create Document and Folder Classes," on page 2-59 Lesson 2.5, "Modify Classes and Properties," on page 2-71

Unit Dependencies Refer to Unit 1: Introduction to IBM FileNet Content Manager for the system startup and system check.


Activity, Practice, and Tour Lessons in this unit contain the following items. • Activity: Provides step by steps directions on how to do a procedure. • Practice: Provides a scenario and data to practice the procedures that you learned in that lesson. • Tour: Provides directions to explore a preset configuration.

System Startup Start the WebSphere Application Server by double-clicking the Start Server.bat file in the WebSphere Admin folder on the desktop. Wait for the Start the server window to close.

System Check Perform a system check whenever you start an IBM FileNet P8 system or start working on a system that is in an unknown state. These activities assume that you did a system check when you begin an activity session. © Copyright IBM Corp. 2013, 2015



2-1

Student Exercises

2-2





Lesson EXNoSideHead

2.1. Create an Object Store

Why is this lesson important to you? As a Solution Builder, you control how objects and the related metadata are stored in your Content Platform Engine system. The main steps are to determine how data sources are shared and to define the object stores along with storage areas. You are going to create a Database Connection and an Object Store for Marketing Department as designed in your business solution.

Activities • Create a Connection Object: Activity, on page 2-5 • Create an Object Store: Activity, on page 2-14 • Create an Object Store: Practice, on page 2-23

User accounts Application Name

User ID

Password

DB2 Control Center

p8admin

IBMFileNetP8

IBM FileNet Configuration Manager

p8admin

IBMFileNetP8

Administration Console for Content Platform Engine

p8admin

IBMFileNetP8





2-3

Student Exercises

2-4





Create EXNoSideHead

a Connection Object: Activity

Procedures Procedure 1, "Examine the target database," on page 2-5 Procedure 2, "Create the required Data Sources," on page 2-6 Procedure 3, "Test the Data Sources," on page 2-10 Procedure 4, "Create a Database Connection Object," on page 2-12

Procedure 1: Examine the target database In this procedure, you examine a database that is used as the target for the connection object that you are going to create. 1. Start the DB2 Control Center. a. Click Start > All Programs > IBM DB2 > TDSV63DB2 (Default) > General Administration Tools > Control Center. The Control Center window opens. b. In Control Center View window, Leave the default value Advanced and click OK. 2. In the left pane, expand All Databases. a. A list of databases is shown in the left pane.

3. Connect to the MARKDB database. a. In the left pane of the Control Center, select the All Databases > MARKDB node. b. In the lower right corner of the Control Center, click the Connect link.




2-5

Student Exercises

c. The properties of the MARKDB database are listed in the lower right pane of the Control Center. • DBM State: Started. • The Size of the database is shown in MB. • The Capacity of the database is shown in MB. A small horizontal bar icon displays the percentage of the available capacity used (such as 20%). 4. Expand the MARKDB in the left pane of the Control Center window. Many database components are listed, including Tables, Views, Triggers, Indexes, and Table Spaces. 5. Examine database components. a. Click the MARKDB > Table Spaces node. b. Several table spaces are listed in the upper right pane of the window. MARK_TS, USERTEMP1 and TEMPSYS1 are user-defined table spaces. c. From the menu bar, click Control Center > Exit to close the tool.

Procedure 2: Create the required Data Sources In this procedure, you use the Configuration Manager to create the Data Sources that are required for the Content Platform Engine to access the MARKDB database. 1. Start the IBM FileNet Configuration Manager. a. From the Windows desktop, double-click the FileNet Configuration Manager icon. The IBM FileNet Configuration Manager for Content Platform Engine window opens. b. If necessary, click the X icon on the Welcome tab to close the Welcome screen. 2. Open the profile. a. Click File > Open Profile. The window opens. b. In the Open window, go to the following folder: C:\Program Files (x86)\IBM\cpit\install-scripts\profiles\CEConfig c. Select the CEConfig.cfgp file and then click Open.

2-6





EXNoSideHead d. When prompted with the “Verify your application server settings before proceeding” message, click OK.

e. A list of tasks are listed in the left column. 3. Verify that the correct version of WebSphere Application Server selected. a. Right-click CEConfig in the left pane.

b. Click Edit Application Server Properties from the list. The Properties page opens. c. Change the Application server version to version 8.5. d. Enter IBMFileNetP8 in the Application server administrator password. e. Click Test Connection. A Test Results window is shown with the message that the connection to the server is successful. f.

Click OK to close the Test Results message window.

g. Click Finish. 4. Create a task for Configure Marketing Object Store JDBC Data Sources. a. Right-click the Configure Object Store JDBC Data Sources task and click Copy Selected Task.




2-7

Student Exercises

A copy of the task with a name beginning with the string Copy_of_ is listed in the left pane.

b. Right-click the task Copy_of_Configure Object Store JDBC Data Sources and click Rename Task. A Rename Task window opens. c. Enter the following name and then click OK: Configure Marketing OS JDBC Data Sources d. In the left pane, double-click the renamed task. e. The Configure Marketing OS JDBC Data Sources task properties are shown in the right pane. 5. Edit the configuration properties page for the task. Use the following data. Item

Value

JDBC driver name

DB2 Universal JDBC Driver

JDBC driver version

3.0

JDBC Data Source name

MOSDS

JDBC XA Data Source name

MOSDSXA

Database server name

localhost

Database port number

50000

Database name

MARKDB

Database user name

osdbuser

Database password

IBMFileNetP8

Important Make sure that you change the database name to MARKDB.

2-8





. EXNoSideHead

a. Accept the default settings for any values that are not specified in the table b. Click Test Database Connection. c. Click Yes on the Action Required window to save the task before proceeding. d. A Test Results window is shown with the message that the connection to the database is successful.

e. Click OK to close the Test Results message window. 6. Run the task to create and configure the Data Sources: a. Right-click the Configure Marketing OS JDBC Data Sources task in the left pane and click Run Task.




2-9

Student Exercises

b. Monitor the status in the Console on the lower right corner of the window.

c. Wait for the message Finished running Configure JDBC Data Sources in the Console. 7. Close the profile and exit Configuration Manager. a. From the menu bar, click File > Close Profile. b. Click File > Exit to close the Configuration Manager.

Procedure 3: Test the Data Sources In this procedure, you test the Data Sources in the WebSphere Application Server Administrative Console. 1. Open WebSphere Application Server Administrative Console. a. In a Firefox browser, click the WAS Admin link in the Bookmarks toolbar to open the Integrated Solutions Console. You can also use the following URL to open this page: https://ecmedu01:9043/ibm/console/logon.jsp The Integrated Solutions Console login page is displayed. b. Enter the account information and click Login. • User ID: p8admin • Password: IBMFileNetP8 The Welcome page is displayed. • If a Login Conflict message is displayed, click OK. Note The activities in this unit refer to the Integrated Solutions Console as the WebSphere Application Server Administrative Console.

2. Open the Data Sources page. a. In the left pane, expand the Resources > JDBC link. b. Click the Data Sources link. The Data Sources page is displayed in the right pane. 2-10 System Implementation and Administration




EXNoSideHead c. Scroll down and locate the MOSDS Data Source.

3. Test the MOSDS connection. a. Select the MOSDS and the MOSDSXA check boxes. b. Click Test connection.

After a few moments, a message is shown on the same page that the test connection operations for Data Source MOSDS and MOSDSXA were successful.

4. Log out of the WebSphere Application Server Administrative Console and close the browser.




2-11

Student Exercises

Procedure 4: Create a Database Connection Object In this procedure, you create a Database Connection Object in the Administrative Console for Content Platform Engine. You use the Data Source values that you created. 1. Start the Administration Console for Content Platform Engine. a. In your browser, go to http://ecmedu01:9080/acce b. Log in as the P8admin user (password: IBMFileNetP8). 2. Open the New Database Connection Object wizard. a. In the administration console, expand the P8Domain > Global Configuration > Administration node on the left pane. b. Click Database Connections. c. In the Database Connections tab on the right pane, click New.

d. The New Database Connection tab opens. 3. Specify the Database Connection Name and Site. a. Enter MarketingDC as the value for the Display name field. b. Leave the default value (Initial Site) for the Site field. c. Click Next. 4. Specify Database Connection Data Source Names. a. Enter MOSDS for the JNDI Data Source field. b. If it is not automatically populated, enter MOSDSXA for the JNDI XA Data Source field. c. Click Next. 5. Complete the wizard. a. In the Summary page, view the details and click Finish. b. In the Success page, click Close. 6. Verify the new Database Connection object. a. In the Database Connections tab, click Refresh.





EXNoSideHead b. Verify that the new MarketingDC connection is listed.

7. Leave the Administration Console open for the next activity. Troubleshooting If you get an error similar to the following screen capture when you complete the wizard, do the following steps: 1. Click OK on the Error page.

2. Verify your inputs and click Cancel in the Error page of the wizard. 3. Repeat the Steps 2-6 to create the Database connection.




2-13

Student Exercises

Create an Object Store: Activity In this activity, you are going to create an object store with the Data Source that you created in the previous activity.

Procedures Procedure 1, "Create an object store," on page 2-14 Procedure 2, "Verify the new object store," on page 2-18 Procedure 3, "Configure your repository," on page 2-18 Procedure 4, "Edit the desktop to add your repository," on page 2-20

Procedure 1: Create an object store 1. If needed, start the Administration Console for Content Platform Engine. a. In your browser, go to http://ecmedu01:9080/acce b. Log in as the P8admin user (password: IBMFileNetP8) 2. Open the New Object Store wizard. a. In the administration console, click the P8Domain > Object Stores node on the left pane. b. In the Object Stores tab on the right pane, click New. c. The New Object Stores tab opens. 3. Name the Object Store. a. Enter Marketing as the value for the Display name field. The Symbolic name field is automatically populated with the same name. Note The symbolic name, which is used for internal programmatic purposes, must contain only ASCII characters and must begin with an alphabetic character.

b. Optionally, enter a description to your object store. c. Click Next. 4. Define the Database with the database connection that you created. a. Select MarketingDC from the list for the Database connection field. There is also an option to create a new database connection. 5. Enter MSchema for the Schema name field.





EXNoSideHead

Important

Since, the same database can be shared for two or more object stores, each object store must contain a schema name that is unique for that object store.

6. Leave the default values (no value) for the other fields. a. Click Next. 7. Select the Type of Storage Area for Content. a. Accept the default Database Storage Area and click Next. Information If you select a storage area other than Database, two storage areas get created because an object store always has a database storage area. You are going to configure File Storage Area in the next lesson.

8. Grant Administrative Access. a. Click Add. The Add Users and Groups window opens.




2-15

Student Exercises

b. In the Search for field, clear the Search for Users and Search for Special accounts check boxes. Leave Search for Groups selected. c. Type P8 in the text field that is next to the Starts with field. Click Search. d. In the Search Results section > Available Users and Groups column, a list of groups that starts with P8 is listed. e. Select and Move P8Admins to the Selected Users and Groups column by clicking right arrow. Click OK. 9. Repeat Steps 8a-8e to add the Admins group. a. The completed list looks like the one in the following screen capture.

b. Click Next. 10. Grant Basic Access. a. Click Add. b. Repeat Steps 8a-8e to add the P8Users group. Note If you specify an empty list, the wizard automatically adds #AUTHENTICATED-USER, which gives all network users in the authentication realm access to the object store.

c. Click Next. 11. Select AddOns. a. Select the following add-ons. • • • • • • • • • •

5.2.0 Base Application Extensions 5.2.0 Base Content Engine Extensions (by default selected) 5.2.0 Process Engine Extensions 5.2.0 Publishing Extensions 5.2.0 Stored Search Extensions 5.2.0 Teamspace Extensions 5.2.0Thumbnail Extensions 5.2.0 Workplace Base Extensions 5.2.0 Workplace Template Extensions 5.2.0 Workplace XT Extensions

b. Click Next.





12. Complete the wizard: EXNoSideHead a. In the Summary page, review your selections.

b. Click Finish to create the object store. Information It could take a few seconds before the progress bar changes, and several more seconds for the new object store to be created. If a message states that the script is unresponsive, click OK to continue.

c. In the Success page, click Close.




2-17

Student Exercises

Procedure 2: Verify the new object store In this procedure, you create a test folder in the new object store to verify that the object store is working. 1. In the Administration Console > Object Stores tab, click Refresh. a. Verify that the new object store is listed.

b. Observe that the Marketing object store uses the new MOSDS data connection. c. Click the Marketing object store. 2. Create a folder. a. In the left pane, expand Marketing > Browse. b. Right-click the Root Folder and click New Folder from the list. The New Folder tab opens. 3. Define New Folders. a. Enter Test Folder in the Folder name field. b. Notice that Class field has Folder as the value. Click Next. 4. Complete the wizard. a. In the Specify Settings for Retaining Objects, leave the defaults and click Next. b. In the Summary page, click Finish. c. In the Success page, click Close. 5. Verify the new folder. a. In the Marketing tab, click Refresh. b. In the left pane, expand Marketing > Browse > Root Folder. c. Verify that the Test Folder that you created is listed. If the new folder is added, you successfully created the object store. 6. Log out of Administration Console for Content Platform Engine. a. Close the browser.

Procedure 3: Configure your repository Users access and add content to your object store in IBM Content Navigator. To access the content in an IBM FileNet P8 repository, you must first configure IBM Content Navigator to connect to that repository. Then, you must associate this repository with a desktop to enable users to access the content.





You are going to learn in more detail how to configure the IBM Content Navigator in a separate unit. EXNoSideHead In this procedure, you configure the repository that recently created. 1. Start the IBM Content Navigator. a. In your browser, go to http://ecmedu01:9080/navigator/ The URL value is case-sensitive. b. Enter the logon credentials for an administrator (user name: P8admin, password: IBMFileNetP8). The user should have administrative access. 2. On the Content Navigator desktop, click the Open Administration View icon in the leftmost pane.

3. Open the Repositories tab. a. In the Administration View page, click Repositories in the left pane. b. On the Repositories tab, a list of the repositories that are configured is shown. 4. Create a connection to your repository. a. Click New Repository and select FileNet Content Manager from the list. b. On the General tab of the New Repository page, enter your object store name for the Display name field, (Marketing). c. The ID field is automatically populated based on the Display name field entry.

d. Enter the Server URL: iiop://ecmedu01:2809/FileNet/Engine. ecmedu01 is your server name. e. Enter the object store symbolic name: Marketing f.

Enter the object store display name: Marketing




2-19

Student Exercises

5. Test the connection to the repository. a. Click Connect. b. In the Log In page, enter the credentials of a user with administrator access to the repository (User: P8admin; password: IBMFileNetP8). c. Click Log In. 6. Save the configuration settings for the new repository. a. Click Save and Close to save and close the New Repository tab. 7. Test the new repository. a. Verify that the new repository is listed on the Repositories tab. b. This repository is now available to be used in the Content Navigator. c. Close the Repository tab.

Procedure 4: Edit the desktop to add your repository In this procedure, you associate your repository with a desktop. 1. In the Admin desktop page > Desktops tab, right-click Sample Desktop and click Edit. a. In the Sample Desktop tab, click the Repositories subtab. 2. Specify the repository for the desktop. a. In the Repositories tab, Select Marketing repository from the Available Repositories pane and use the right arrow (Add) to move it to the Selected Repositories pane.

3. Save the settings for the new desktop. a. Click Save and Close. b. If you get a prompt: “You must refresh your browser”, click Close. 4. Test the Desktop. a. Refresh your browser. b. The desktop opens in Browse view.





EXNoSideHead c. Verify that you are able to select your repository (Marketing) from the list.

d. Click Marketing. e. The Browser view now shows your object store and the Test Folder that you created.

Information In the following lessons, you are going to create other content objects in this object store in Content Navigator.




2-21

Student Exercises





Create EXNoSideHead

an Object Store: Practice Complete the following exercise scenario to practice the procedures that you learned in this lesson.

Scenario: Create an Object Store for Human Resources Department You create an object store for the Human Resources department to store their content. Your Database Administrator advises you to create the object store with a shared database connection.

Challenge • Create an object store with a shared database connection.

Data Item

Value

Administration Console for Content Platform Engine account (logon/password)

p8admin/IBMFileNetP8

Name and Symbolic name

HR

Database connection

MarketingDC

Schema name

HRSchema

Storage area type

Database

Grant Administrative Access

P8Admins, AEAdmins

Grant Basic Access

Legal 5.2.0 Base Content Engine Extensions

Add-ons

5.2.0 Process Engine Extensions

Hint • You are sharing an existing database connection. You complete the create object store activity.

Verification • Verify that the new object store is listed in the Object Stores tab. • Verify that you are able to create a folder in the new object store.




2-23

Student Exercises





Lesson EXNoSideHead

2.2. Create a File Storage Area and a Storage Policy

Why is this lesson important to you? A Storage Area is a place where Content Platform Engine stores content. A File Storage Area is a directory tree on a local or shared network drive. You can create a File Storage Area to group documents with the same deletion or backup requirements. Your business solution requires creating File Storage Areas to use them as part of a Storage Area farm. As the Solution Builder, you must create the File Storage Areas, define a Storage Area Farm, and create a Storage Policy to manage how the Storage Area Farm is used.

Activities • Activity: Create a File Storage Area, on page 2-26 • Activity: Create a Storage Policy, on page 2-35


User ID

Password


p8admin

IBMFileNetP8

IBM FileNet Enterprise Manager

p8admin

IBMFileNetP8

IBM Content Navigator (Administrator user)

p8admin

IBMFileNetP8

IBM Content Navigator (Business User)

burt

filenet





2-25

Student Exercises

Activity: Create a File Storage Area In this activity, you create a file storage area and set it as the default storage area for the Document class.

Procedures Procedure 1, "Verify the default storage area," on page 2-26 Procedure 2, "Create a subdirectory for the file storage area," on page 2-27 Procedure 3, "Create a file storage area," on page 2-28 Procedure 4, "Verify the storage area directory structure," on page 2-30 Procedure 5, "Configure a Document class," on page 2-31 Procedure 6, "Edit your storage area," on page 2-32 Procedure 7, "Add a document to verify the configuration," on page 2-33

Procedure 1: Verify the default storage area In this procedure, you add a document to check its default storage option for the Document class. To add content elements to the document, you use the FileNet Enterprise Manager. 1. Start the FileNet Enterprise Manager by double-clicking the icon on the desktop. 2. In the FileNet P8 Logon page, ECMEDU01 entry is already selected. Click Connect. Verify the current File Count for the storage area before you add document. After adding the document, you can compare them. a. Select Object Stores > Marketing > Storage Areas in the left pane. b. Observe the File Count column for the Default Database Storage Area.

c. Since you added no documents after creating this object store, the file count is 0. 3. Open Test folder. a. Expand the Marketing > Root Folder > Test folder in the left pane. 4. Add a document (Class: Document). a. Right-click the Test folder and click New Document. b. In the Create New Document wizard, enter TestDoc for the Document Title field. c. Select the With content option and click Next. 5. Click Browse/Add for the File name field. a. In the Open window, go to the C:\LabFiles\SampleDocuments folder and select a document (Example: Testfile.doc) b. Click Open. In the wizard page, the document path is added. Click Next. 2-26 System Implementation and Administration




6. In the Class and Properties page, verify that Document is selected for the Class field. Click Next. EXNoSideHead a. In the Object Retention page, leave the default values and click Next. 7. In the Advanced Features page > Storage Settings section, verify that is selected. After you configure a Storage Area for the Document class, your Storage Area is automatically selected.

a. Notice that Default Database Storage Policy is selected for the Storage Policy field. Click Finish. 8. Verify the File Count for the storage area after the document is added. a. Select Object Stores > Marketing > Storage Areas in the left pane. b. From the menu bar, click Action > Refresh to ensure that the current data is shown. c. Observe the File Count column for the Default Database Storage Area.

d. Since you added one document, the file count is now increased to one. 9. Leave the FileNet Enterprise Manager opened for a later procedure.

Procedure 2: Create a subdirectory for the file storage area 1. View the existing file storage directories. a. In Windows Explorer, go to C:\filenet drive. The student system uses this folder as the base directory for file storage. b. Expand the filenet folder and observe that there are several folders: file_stores, file_stores2, and BulkMoveFS. These folders are the root directories for file storage in the student system. Note You can use any string value for the base and root directory names. You can select any location in your local or distributed file system for the base directory.




2-27

Student Exercises

c. Expand the file_stores\content folder and verify that there are 23 folders named FN0 to FN22. These directories store the committed content element files. The Storage Area wizard creates these content folders. d. Expand the FN0 (or any one of the 23 folders) folder and verify that each of them contains a set 23 folders named FN0 to FN22. e. Expand the file_stores\inbound folder and verify that there are several folders. f.

The inbound folder is the working area for uploading new content.

2. Create a subfolder to use it as a root directory for the new file storage area. a. In Windows Explorer, go to C:\filenet drive. b. Create a folder with a name: Marketing_filestore. 3. Verify and set the security for the folder. Only the admin user must be able delete and write files in the file store directories. a. Right-click the Marketing subdirectory and select Properties. b. In the Properties window, click the Security tab.

c. Verify that the permission for the non-admin users is read-only to the folder. d. Close the Windows Explorer.

Procedure 3: Create a file storage area 1. Start the Administration Console for Content Platform Engine. a. In your browser, go to http://ecmedu01:9080/acce b. Log in as the P8admin user (password: IBMFileNetP8)





2. Start the New Storage Area wizard. EXNoSideHead a. In the administration console, expand the P8Domain > Object Stores node on the left pane and click the Marketing object store. b. In the Marketing tab, expand Marketing > Administrative node and click Storage Areas on the left pane.

c. In the Storage Areas tab on the right pane, click New. The New Storage Area wizard opens. 3. Create a Storage Area. a. In the New Storage Area tab, select File for the Storage area type field. b. Click Next. 4. Name the Storage Area: a. Enter Marketing Storage Area for the Display name field. b. Verify that Initial Site is selected for the Site field. Click Next. 5. Configure the Storage Area: a. Complete this page with the data provided in the following table. Item

Value or option

Root directory

C:\filenet\Marketing_filestore

Directory structure size

Small

Maximum number of elements

Unlimited

Maximum size

Maximum allowed on device

Delete method

Unrecoverable

Options

Suppress duplicate content elements: Cleared Encrypt content: Cleared Compress content: selected

Other fields

Leave the defaults.

b. Click Next. Hint Click the question mark next to each field name to get more details about that field.




2-29

Student Exercises

6. Select a Storage Policy for this Storage Area. a. You are going to create a storage policy in the next activity. Leave the defaults (not selected) and click Next. b. When you are prompted with “Informational message: The storage area cannot be used until it is mapped to a storage policy”, click OK. 7. Complete the wizard: a. In the Summary page, review the details and click Finish. b. In the Success page, click Close to close the tab. 8. Refresh the view of the Storage Areas. a. In the Storage Areas tab, click Refresh. 9. Verify that the Marketing Storage Area is listed. a. Notice that Marketing Storage Area has the Type that you assigned (File Storage Area) and it is empty (the File Count is 0).

10. Log out of Administration Console for Content Platform Engine. a. Close the Browser.

Procedure 4: Verify the storage area directory structure 1. In Windows Explorer, go to C:\filenet\Marketing_filestore drive. a. Expand the Marketing_filestore folder and observe the structure. b. Verify that content and inbound directories are created. The wizard also creates a folder that is called system and an xml file called fn_stakefile.xml.





EXNoSideHead

c. Expand the content folder and verify that there are 23 folders named FN0 to FN22. d. Expand the FN0 (or any one of the 23 folders) folder and verify that each of them contains a set of 23 folders named FN0 to FN22. e. Expand the inbound folder and verify that there are several folders. f.

Close the Windows Explorer.

Procedure 5: Configure a Document class In this procedure, configure the new file storage area that you created as the default storage container for the Document class. 1. Start the Administration Console for Content Platform Engine. a. In your browser, go to http://ecmedu01:9080/acce b. Log in as the P8admin user (password: IBMFileNetP8). 2. Open the Document class. a. In the administration console, expand the P8Domain > Object Stores node on the left pane and click the Marketing object store. b. In the Marketing tab, expand Marketing > Data Design > Classes > Document on the left pane. c. Click Document. The Document tab opens. 3. Set default storage for the document content of Document class. a. In the General subtab, scroll down and select Marketing Storage Area from the list for the Default storage area field.




2-31

Student Exercises

b. Select from the list for the Default storage policy field.

c. Click Save. d. When prompted, click Cancel in the Propagate Metadata Changes page. The configuration on this page affects the subclasses of the Document. e. Close the Document tab. 4. Refresh the object store. a. In the Marketing tab, click Refresh.

Procedure 6: Edit your storage area In this procedure, you edit the Marketing Storage Area that you created. 1. Open Marketing Storage Area. a. In the Marketing tab, expand Marketing > Administrative > Storage Areas on the left pane. b. Click Marketing Storage Area. The Marketing Storage Area tab opens. 2. Modify the properties of Marketing Storage Area. a. Click the Configuration tab. b. Edit the following values and leave the default values for the other fields. Item

Value

Content Caching

Not Allowed

Delete method

Purge

3. Update the Statistics tab. a. Open the Statistics tab. b. In the Storage Area Maximums section, change Maximum Size to 10 MB. • Click the circle beside the field. • Change the value.





EXNoSideHead c. Examine the Storage Policies tab. Observe that the Storage Area is not mapped to any Storage Policies. 4. Click Save to save your changes to the storage area properties. a. Click Close to close the tab. 5. Refresh the Marketing object store. a. In the Marketing tab, click Refresh.

Procedure 7: Add a document to verify the configuration In this procedure, you verify that adding a document of Document class to the system adds the content to the new file storage area. To add content elements to the document and verify which Storage areas are used, you use FileNet Enterprise Manager. 1. If needed, start the FileNet Enterprise Manager by double-clicking the icon on the desktop. a. In the FileNet P8 Logon page, ECMEDU01 is already selected. Click Connect. 2. Verify the current File Count for the storage area before you add document. After adding the document, you can compare them. a. In Enterprise Manager console, Expand Object Stores and select Marketing. b. Click Action > Refresh from the top menu. c. Select Marketing > Storage Areas in the left pane. d. Click Action > Refresh the menu bar to ensure that the most current data is shown. e. Observe the File Count column for the Marketing Storage Area. f.

Since you added no documents after creating this storage area, the file count is 0.

3. Open Test folder. a. Expand the Marketing > Root Folder > Test folder in the left pane. 4. Add a document (Class: Document). a. Right-click the Test folder and click New Document. b. In the Create New Document wizard, enter FSTestDoc for the Document Title field. c. Select the With content option and click Next. 5. Click Browse/Add for the File name field. a. In the Open window, go to the C:\LabFiles\SampleDocuments folder and select a document (Example: Testfile2.doc) b. Click Open. In the wizard page, the document path is added. Click Next.




2-33

Student Exercises

6. In the Class and Properties page, verify that Document is selected for the Class field. Click Next. a. In the Object Retention page, leave the default values and click Next. 7. In the Advanced Features page > Storage Settings section, verify that the Marketing Storage Area that you created is selected. Observe that it is set as default because you configured this Storage Area for the Document class.

a. Notice that is selected for the Storage Policy field. Click Finish. 8. Verify the File Count for the storage area after the document is added. a. Select Object Stores > Marketing > Storage Areas in the left pane. b. From the menu bar, click Action > Refresh to ensure that the current data is shown. c. Observe the File Count column for the Marketing Storage Area.

d. Since you added one document, the file count now increased to one. 9. Close the FileNet Enterprise Manager by clicking File > Exit from the top menu.





Activity: EXNoSideHead

Create a Storage Policy

Summary Create two file storage areas to represent a storage area farm. Create a storage policy that includes both of these storage areas and assign it to the Document class. The storage policy uses the load-balancing capabilities of the Content Platform Engine to distribute content within a storage area farm. Add some documents to the object store and observe the file count information in the storage areas.

Procedures Procedure 1, "Create storage area farms," on page 2-35 Procedure 2, "Configure a new storage policy," on page 2-37 Procedure 3, "Add more storage areas to the storage policy," on page 2-38 Procedure 4, "Assign the storage policy to the Document class," on page 2-38 Procedure 5, "Verify that storage area farming is working," on page 2-39

Procedure 1: Create storage area farms 1. Create two subdirectories for storage area farms. a. In Windows Explorer, go to C:\filenet drive. b. Create two folders: FS-Farm1 and FS-Farm2. c. Close the Windows Explorer. 2. Start the Administration Console for Content Platform Engine. a. In your browser, go to http://ecmedu01:9080/acce b. Log in as the P8admin user (password: IBMFileNetP8) 3. Start the New Storage Area wizard. a. In the administration console, expand the P8Domain > Object Stores node on the left pane and click the Marketing object store. b. In the Marketing tab, expand Marketing > Administrative > Storage Areas on the left pane. c. Right-click the Storage Areas and then click New Storage Area from the list. The New Storage Area wizard opens.




2-35

Student Exercises

4. Create two file storage areas in the Marketing object store. a. In the New Storage Area tab, configure the Storage Area and complete the wizard. Use the data that is provided in the following table. Item

Value for Storage Area 1

Value for Storage Area 2

Storage area type

File

File

Display name

FS1

FS2

Site

Initial Site

Initial Site

Root directory

C:\filenet\FS-Farm1

C:\filenet\FS-Farm2

Directory structure size Small

Small

Maximum number of elements

Unlimited

Unlimited

Maximum size

20 MB

20 MB

Delete method

Unrecoverable

Unrecoverable

Options

Suppress duplicate content elements: Cleared Encrypt content: Cleared

Suppress duplicate content elements: Cleared Encrypt content: Cleared Compress content: selected

Compress content: selected Select a Storage Policy Do not select any at this step. for this Storage Area

Do not select any at this step.

Other fields

Leave the defaults.

Leave the defaults.

Hint Select a Storage Policy for this Storage Area. a. You are going to create a storage policy in the next procedure. Leave the defaults (not selected). b. When you are prompted with “Informational message: The storage area cannot be used until it is mapped to a storage policy”, click OK.

5. Complete the wizard: a. In the Summary page, review the details and click Finish. b. In the Success page, click Close to close the tab. 6. Refresh the view of the Storage Areas. a. In the Storage Areas tab, click Refresh. 7. Verify that the FS1 StorageArea is listed. a. Notice that FS1 has 0 File Count. 8. Create a second File Storage area: a. Repeat Steps 3-6. Use the data in the table. 2-36 System Implementation and Administration




EXNoSideHead b. Verify that the FS2 StorageArea is listed. c. Notice that FS2 has 0 File Count.

d. Leave the administration console opened for the next procedure.

Procedure 2: Configure a new storage policy 1. Start the New Storage Policy wizard. a. In the administration console, expand the P8Domain > Object Stores node on the left pane and click the Marketing object store. b. In the Marketing tab, expand Marketing > Administrative > Storage Policies on the left pane. c. Right-click the Storage Policies and then click New Storage Policy from the list. The New Storage Policy wizard opens. 2. Name the Storage Policy: a. In the New Storage Policy tab, enter a value for the Display name field. (Example: Farm Storage Policy) b. Click Next. 3. In the Select the Content Storage Method page, choose the Select the storage Areas from a list option. a. Click Next. 4. In the Specify Storage Areas, select FS1 from the list for the Storage areas field. a. Click Next. 5. In the Summary page, review the information and click Finish. a. Click Close to close the tab. 6. Refresh the Object store. a. In the Marketing tab, click Refresh.




2-37

Student Exercises

7. If needed, expand Marketing > Administrative node and click Storage Policies on the left pane. a. Verify that the Storage Policy that you created is listed.

Procedure 3: Add more storage areas to the storage policy 1. In the administration console > Storage Policies tab, click the storage policy that you created (Farm Storage Policy). a. In the Farm Storage Policy tab > General subtab, scroll down to the Associated Storage Areas section, click Add. b. In the Add Associated Storage Areas page, select FS2 and click OK. c. In the Farm Storage Policy tab, verify that FS2 is added to the list. d. In the Farm Storage Policy tab, click Save. e. Click Close to close the policy tab. 2. Refresh the object store: a. In the Marketing tab, click Refresh.

Procedure 4: Assign the storage policy to the Document class 1. In the Marketing tab, expand Marketing > Data Design > Classes > Document on the left pane. a. Click Document Class. The Document tab opens. 2. In the General tab, scroll down and locate the Default storage policy field. a. Change the value to Farm Storage Policy by selecting it from the list. b. Select for the Default storage area field.





EXNoSideHead

Important

Verify that is selected for the Default storage area. The Farm Storage policy specifies the FS1 and FS2 storage areas to save the content for the Document class. If both the Default storage area and the Default storage policy are set, the Default storage area setting takes precedence and the storage policy that you defined is ignored.

3. In the Document tab, click Save. a. When prompted, click Cancel in the Propagate Metadata Changes window. b. Ensure that the check box for the Storage Policy item is cleared so that the changes are not propagated to the Document subclasses.

c. In the Document tab, click Refresh. d. Click Close to close the Document tab. 4. Refresh the Marketing object store: a. In the Marketing tab, click Refresh. 5. Log out of the Administration Console and close the browser.

Procedure 5: Verify that storage area farming is working To see the storage area farm at work, you are going to add some documents to the Marketing object store and then view the statistics of the FS1 and FS2 storage areas. To add content elements to the document, you use FileNet Enterprise Manager. 1. Start the FileNet Enterprise Manager by double-clicking the icon on the desktop. a. In the FileNet P8 Logon page, ECMEDU01 is already selected. Click Connect. b. In Enterprise Manager console, Expand Object Stores > Marketing. c. Refresh the Marketing object store by right-clicking and then click Refresh. 2. Open the Test folder. a. Expand the Marketing > Root Folder > Test folder in the left pane. © Copyright IBM Corp. 2013, 2015



2-39

Student Exercises

3. Add a document. a. Right-click the Test folder and click New Document. b. In the Create New Document wizard, enter SPTest1 for the Document Title field. c. Select the With content option. d. Click Next. 4. Click Browse/Add for the File name field. a. In the Open window, go to the C:\LabFiles\SampleDocuments folder and select a document (Example: Testfile3.doc). b. Click Open. In the wizard page, the document path is added. c. Click Next. 5. Complete the wizard: a. In the Class and Properties page, leave the default values (Class: Document). b. Click Next. c. In the Object Retention page, leave the default values and click Next. 6. In the Advanced Features page > Storage Settings section, verify that the Storage Area field has value. a. Verify that Farm Storage Policy is selected.

b. Click Finish. 7. Add a two more documents by repeating Steps 3-6. a. Verify that all the documents are listed. 8. Review the results in Enterprise Manager. a. In Enterprise Manager, select Marketing > Storage Areas. b. From the menu bar, click Action > Refresh to ensure that the current data is shown. c. Observe the File Count column for the FS1 and FS2 storage areas and verify that both storage areas contain files. d. When you created the FS1 and FS2 file storage areas, the file count was 0.





9. Close the File Enterprise Manager. EXNoSideHead a. Click File > Exit.




2-41

Student Exercises





Lesson EXNoSideHead

2.3. Create Properties and Choice Lists

Why is this lesson important to you? A property is a characteristic of a class. You must create custom property templates for your classes. As a Solution Builder, you create choice lists and property templates that are based on the needs of your organization and assign them to your custom classes.

Activities • Create a Choice List: Activity, on page 2-45 • Create a Choice List: Practice, on page 2-49 • Create Property Templates: Activity, on page 2-51


User ID

Password


p8admin

IBMFileNetP8

IBM Content Navigator

p8admin

IBMFileNetP8





2-43

Student Exercises





Create EXNoSideHead

a Choice List: Activity

Procedures Procedure 1, "Create a choice list," on page 2-45 Procedure 2, "Verify the new choice list," on page 2-48

Procedure 1: Create a choice list In this procedure, you create a choice list in the Administrative Console for Content Platform Engine. 1. Start the Administration Console for Content Platform Engine. a. In a Firefox browser, go to http://ecmedu01:9080/acce b. Log in as the P8admin user (password: IBMFileNetP8) 2. Open the New Choice List wizard. a. In the administration console, expand the P8Domain > Object Stores node on the left pane and click Marketing. b. In the Marketing tab, expand the Marketing > Data Design node on the left pane and click Choice Lists. c. In the Choice Lists tab on the right pane, click New.

d. The New Choice List tab opens. 3. Define Choice Lists. a. In the New Choice List tab, enter Prospect Type for the Display name field. b. Click Next. 4. Select Data Types. a. In the New Choice List tab, select String for the Choice list data type field. b. Click Next. 5. Add Choice List Items. a. In the New Choice List tab, click New Items.




2-45

Student Exercises

b. In the New Items window, for each name in the table, type the choice item name in the Display Name field. Display Name

Value

Reseller

Reseller

End User

End User

c. When you click outside Display Name field, the value is automatically populated in the Value field. Optionally, you can edit the value field. Important Verify that the Value field is populated before you click Add.

d. Click Add. The choice item is added to the panel.

e. Click OK to close the New Item window.

6. Add a group to the choice list. a. In the New Choice List tab, click New Groups. b. In the New Groups window, enter Dealer in the Display Name field. c. Click Add. The group name is added to the panel. d. Click OK. 7. Add choice items to the group. a. In the New Choice List tab, select Dealer. b. Add choice items to the Dealer group by clicking New Items.





EXNoSideHead c. In the New Items window, repeat Step 5 with the values in the table. Display Name

Value

Motorcycle

Motorcycle

Trailer

Trailer

Vehicle

Vehicle

d. Verify that your completed choice list looks like the one shown in the screen capture.

Hint You can edit the choice items. To edit, select the item and click Edit. You can also rearrange the choice items. To rearrange, click the item and use the Move Up or Move Down.

e. Click Next. 8. Complete the wizard. a. In the Summary page, view the details and click Finish. b. In the Success page, click Close.




2-47

Student Exercises

Procedure 2: Verify the new choice list 1. Click the Choice Lists tab and click Refresh. a. Verify that Prospect Type is shown.

b. Click Prospect Type. c. In the Prospect Type tab, click the Choice Items subtab. d. Verify that the choice items are listed as you defined.

2. Log out of the administration console and close the browser.





Create EXNoSideHead

a Choice List: Practice Complete the following exercise scenario to practice the procedures that you learned in this lesson.

Scenario: Create a Choice List for the Sales Department You must create a choice list that is based on the specification from the Solution Designer for the Marketing department.

Challenge • Create a choice list with choice items and a group.

Data Item

Value


P8admin/IBMFileNetP8

Object Store

Marketing

Choice List Name

Product Type

Data type

String

Choice Items

Software, Services

Choice Group Name

Hardware

Choice Items for the group

Monitors, Servers, Tablet PC

Verification • Verify that your completed choice list looks like the one shown in the screen capture.




2-49

Student Exercises





Create EXNoSideHead

Property Templates: Activity

Introduction In this activity, you create several property templates for the Marketing object store in Administration Console for Content Platform Engine. You associate the choice list that you created to a property template. You are going to use them to create Folder and Document classes in the next lesson.

Procedures Procedure 1, "Create a Property Template," on page 2-51 Procedure 2, "Create a Multi-valued Property Template," on page 2-53 Procedure 3, "Create a Value-required Property Template," on page 2-54 Procedure 4, "Create a Property Template with Choice List," on page 2-55 Procedure 5, "Create a Date Time Type Property Template," on page 2-56 Procedure 6, "Create an Integer type Property Template," on page 2-56

Procedure 1: Create a Property Template 1. Start the Administration Console for Content Platform Engine. a. In a Firefox browser, go to http://ecmedu01:9080/acce b. Log in as the P8admin user (password: IBMFileNetP8). 2. Open the New Property Template wizard. a. In the administration console, expand the P8Domain > Object Stores node on the left pane and click Marketing. b. In the Marketing tab, expand the Marketing > Data Design node on the left pane and click Property Templates. c. In the Property Templates tab on the right pane, click New. d. The New Property Template tab opens. 3. Name and Describe the Property Template. a. In the New Property Template tab, enter prospect_name for the Display name field. b. Verify that the Symbolic name and Descriptions fields are automatically populated. Click outside of the Display name field. c. Optionally edit the Description. Click Next. 4. Select the data type. a. Select String from the list for the data type field. b. Click Next.




2-51

Student Exercises

5. Select Choice List or Marking Set. a. Select from the list for both the fields.

b. Click Next. 6. Complete the Single or Multi-Value page. a. Select the Single option for the Single or Multi-Value. b. Click Next. 7. Complete the wizard. a. In the Summary page, view the details and click Finish. b. In the Success page, click Close. 8. Verify that the new property template is listed. a. Click the Property Templates tab and click Refresh. b. Scroll down and verify that prospect_name is listed.






2: Create a Multi-valued Property Template

1. Open the New Property Template wizard. a. In the administration console, expand the P8Domain > Object Stores node on the left pane and click Marketing. b. In the Marketing tab, expand the Marketing > Data Design node on the left pane and click Property Templates. c. In the Property Templates tab on the right pane, click New. d. The New Property Template tab opens. 2. Name and Describe the Property Template. a. In the New Property Template tab, enter contact_methods for the Display name. b. Verify that the Symbolic name and Descriptions fields are automatically populated. Click outside of the Display name field. c. Optionally edit the Description. Click Next. 3. Select the data type. a. Select String from the list for the Data type field. Click Next. 4. Select Choice List or Marking Set. a. Select from the list for both the fields. Click Next. 5. Complete the Single or Multi-Value page. a. Select Multi for the Single or Multi-Value. b. Select Unique and ordered values for the List order option.

c. Click Next. 6. Complete the wizard. a. In the Summary page, view the details and click Finish. b. In the Success page, click Close.




2-53

Student Exercises

7. Verify that the new property template is listed. a. Click the Property Templates tab and click Refresh. b. Verify that contact_methods is listed.

Procedure 3: Create a Value-required Property Template 1. In the administration console, create a property template called prospect_id. a. Follow the steps in Procedure 1 to complete this task. Use the following data table. Accept Field Value Name Symbolic Name Description

prospect_id prospect_id prospect_id

Data type

String

Assign a choice list Assign marking set

Single or Multi-Value

Single

Set other attributes

Selected

Value required

Selected

the default values for the other fields that are not listed in the table. Hint When you select the Set other attributes option in the Single or Multi-Value page, the wizard opens with more pages to set other attributes for the property template.





EXNoSideHead

2. Verify that the new property template is listed. a. Click the Property Templates tab and click Refresh. b. Verify that prospect_id is listed.

Procedure 4: Create a Property Template with Choice List 1. In the administration console, create a property template called prospect_category. 2. Follow the Steps 2-4 in Procedure 1. Use the following data table. Field

Value

Name

prospect_category

Symbolic Name

prospect_category

Description

prospect_category

Data type

String

3. In the Select Choice List or Marking Set window, select Assign choice list. a. Select the Prospect Type choice list that you created in the earlier activity. b. Click Next.

c. Select Single on the Single or Multi-Value page and click Next.




2-55

Student Exercises

d. In the Summary page, click Finish. e. Click Close in the confirmation page. 4. Verify that the new property template is listed. a. Click the Property Templates tab and click Refresh. b. Verify that prospect_category is listed.

Procedure 5: Create a Date Time Type Property Template 1. In the administration console, create a property template called last_contact_date. 2. Follow the steps in Procedure 1 to complete this task. a. Use the following data table. Accept the default values for the other fields that are not listed in the table. Field

Value

Name

last_contact_date

Symbolic Name

last_contact_date

Description

last_contact_date

Data type

Date Time


Single

3. Verify that the new property template is listed. a. Click the Property Templates tab and click Refresh. b. Verify that last_contact_date is listed.

Procedure 6: Create an Integer type Property Template 1. In the administration console, create a property template called times_contacted. 2. Follow the steps in Procedure 1 to complete this task. Use the following data table. a. Accept the default values for the other fields that are not listed in the table. Field

Value

Name

times_contacted

Symbolic Name

times_contacted

Description

times_contacted

Data type

Integer

Choice list


Single

3. Verify that the new property template is listed. a. Click the Property Templates tab and click Refresh. b. Verify that times_contacted is listed.





4. Review the Property Templates. EXNoSideHead a. Click Display Name in the column heading to sort the property templates in ascending order.

b. Click Data Type in the column heading to sort the property templates by data type. 5. Log out of the Administration Console for Content Platform Engine and close the browser.




2-57

Student Exercises





Lesson EXNoSideHead

2.4. Create Document and Folder Classes

Why is this lesson important to you? Documents that are checked into Content Platform Engine require a class. You can organize the documents and other objects into folders. You must define the Document and Folder classes that are based on the needs of your organization before you can add documents or other objects to an object store. As a Solution Builder, you create custom Document and Folder classes.

Activities • Create Document and Folder Classes: Activity, on page 2-61 • Create a Folder Class: Practice, on page 2-67 • Create a Document Class: Practice, on page 2-69


User ID

Password


p8admin

IBMFileNetP8


p8admin

IBMFileNetP8





2-59

Student Exercises





Create EXNoSideHead

Document and Folder Classes: Activity

Introduction You created property templates and choice lists that are required for your organization in the previous lesson. In this activity, you create custom Folder and Document classes with those property templates in the Administration Console for Content Platform Engine. You test each class by creating an instance in the IBM Content Navigator client.

Procedures Procedure 1, "Create a Folder Class," on page 2-61 Procedure 2, "Create a Document Class," on page 2-62 Procedure 3, "Test your Folder class," on page 2-64 Procedure 4, "Test your Document class," on page 2-65

Procedure 1: Create a Folder Class 1. Start the Administration Console for Content Platform Engine. a. In a Firefox browser, go to http://ecmedu01:9080/acce b. Log in as the P8admin user (password: IBMFileNetP8) 2. Open the New Folder Class wizard. a. In the administration console, expand the P8Domain > Object Stores node on the left pane and click Marketing. b. In the Marketing tab, expand the Marketing > Data Design > Classes node on the left pane. c. Right-click Folder and select New Class from the list. d. The New Folder Class tab opens. 3. Name and Describe the Class. a. In the New Folder Class tab, enter ProspectsFolder for the Display name. b. Verify that the Symbolic name and Descriptions fields are automatically populated. Click outside of the Display name field. c. Optionally edit the Description. Click Next. 4. Complete the wizard. a. In the Summary page, click Finish. b. In the Success page, click Close. 5. Verify that the new Folder subclass is listed. a. In the Marketing tab, click Refresh. b. If needed, expand the Marketing > Data Design > Classes > Folder node. © Copyright IBM Corp. 2013, 2015



2-61

Student Exercises

c. Verify that the ProspectsFolder class is listed. 6. Click ProspectsFolder in the left pane. The ProspectsFolder tab opens in the right pane. 7. Add Property Definitions to the class. a. Select the Property Definitions subtab. Click Add. b. In the Add Properties page, scroll down and select the following properties that you want to add to this class. • prospect_category • prospect_id c. Click OK to close the Add Properties page.

8. Verify that the properties are listed. a. Click Save. Click Close to close the ProspectsFolder tab. 9. Leave the administration console opened for the next procedure.

Procedure 2: Create a Document Class 1. Open the New Document Class wizard. a. In the administration console, expand the P8Domain > Object Stores node on the left pane and click Marketing. b. In the Marketing tab, expand the Marketing > Data Design > Classes node on the left pane. c. Right-click Document and select New Class from the list. d. The New Document Class tab opens. 2. Name and Describe the Class. a. In the New Document Class tab, enter Prospect for the Display name field. b. Verify that the Symbolic name and Descriptions fields are automatically populated. Click outside of the Display name field. c. Optionally edit the Description. Click Next.





3. Complete the wizard. EXNoSideHead a. In the Summary page, click Finish. b. In the Success page, click Close. 4. Verify that the new Document subclass is listed. a. In the Marketing tab, click Refresh. b. If needed, expand the Marketing > Data Design > Classes > Document node. c. Verify that the Prospect class is listed. 5. Add Property Definitions to the class. a. Click Prospect in the left pane. The Prospect tab opens in the right pane. b. Select the Property Definitions subtab. Click Add. c. In the Add Properties page, select the following properties that you want to add. • • • • •

contact_methods, last_contact_date prospect_category, prospect_name times_contacted

d. Click OK. Verify that all the properties are listed. e. Click Save and then Close. 6. Log out of Administration Console for Content Platform Engine.




2-63

Student Exercises

Procedure 3: Test your Folder class In this activity, you create an instance of your Folder class in IBM Content Navigator. You verify that the instance has the metadata as specified in the class specification. 1. Start the IBM Content Navigator. a. In your browser, go to http://ecmedu01:9080/navigator/ The URL value is case-sensitive. b. Enter the logon credentials for an administrator (user name: P8admin, password: IBMFileNetP8). c. The Content Navigator Sample Desktop opens in Browse view. d. Select the Marketing repository from the list.

e. The Browser view now displays your object store. 2. Create a folder of the class that you created. a. Click New Folder.

3. Select your Folder class. a. In the New Folder window > Properties section, select ProspectsFolder from the list for the Class field.

b. Click OK. 2-64 System Implementation and Administration




EXNoSideHead c. Enter NYB Company for the Folder Name. d. Select Reseller for the prospect_category from the list. e. Enter NYBC for the prospect_id. The value for the field is required as you specified. 4. Click Add to create the folder. 5. Verify that your new folder is listed.

Procedure 4: Test your Document class In this activity, you create an instance of your Document class in IBM Content Navigator. You verify that the instance has the metadata as specified by the class. You can add documents to the folder that you created. 1. Double-click the NYB Company folder to open. 2. Click Add Document to add a document to this folder. 3. Enter the properties for your class. a. In Add Document page, select “Information about the document” for the “What do you want to save?” field. b. In the Properties section, select Prospect from the list for the Class field. Click OK. c. Enter the values for the other fields from the following table. Field

Value

Document Title

NYB 252

contact_methods

Email, phone call

last_contact_date

Five days before the current date

prospect_category

Re seller (Select from the choice list)

prospect_name

Victor Byrd

times_contacted

2

d. For the contact_methods, click the field. A new window opens. Enter each value in the New field and click Add. e. Click OK.

f.

Click Add.

4. Verify that your new document is listed in the folder.




2-65

Student Exercises

5. Click the document. Verify that the properties and their values are shown in the rightmost pane.

Note Optional step: Add content to the document in Procedure 4, Step 3a. a. In the Add Document page, select “Local document” for the “What do you want to save?” field. b. Click Browse for the File name field. c. In the File Upload window, go to the C:\LabFiles\SampleDocuments folder and select a document (Example: BasicModel_500.doc) d. Click Open. In the Add Document page, the document path is added. e. Continue with the Procedure 4, Step 3b.

6. Log out of IBM Content Navigator and close the window.





Create EXNoSideHead

a Folder Class: Practice Complete the following exercise scenario to practice the procedures that you learned in the two lessons.

Scenario: Create a Folder class to organize Vendor information Your Solution Designer sends you the specification for a Folder class to organize the Vendor-related information.

Challenge • Create two property templates in the Administration Console. • Create a Folder class in the Administration Console. • Verify the class by creating an instance of that class in the IBM Content Navigator. • Use the default values for the fields that are not specified in the tables.

Data Field

Value



Object Store name

Marketing

Data for the property template - 1 Field

Value

Name Symbolic Name Description

vendor_name vendor_name vendor_name

Data type

String

Assign a choice list


Single




2-67

Student Exercises


Value


vendor_ID vendor_ID vendor_ID

Data type

Integer



Single

Data for creating a Folder class Field

Value


Vendor Vendor Vendor Folder • vendor_name • vendor_id

Add Properties

Data for creating an instance of a Folder Field

Value

IBM Content Navigator client account (logon/password)


Object Store name

Marketing

Folder class

Vendor

Name of the Folder

Vendors

vendor_name

PC Paper

vendor_id

1001

Verification • Verify that the property templates are available to add to the Folder class. • Verify that the new Folder class is listed under the Folder class node on the left pane. • Verify that you are able to create an instance of this Folder class.





Create EXNoSideHead

a Document Class: Practice Complete the following exercise scenario to practice the procedures that you learned in the two lessons.

Scenario: Create a Document class for the Quotes information Your Solution Designer sends you the specification for a Document class to store the Quotes information.

Challenge • Create two property templates in the Administration Console. • Create a Document class in the Administration Console. • Verify the class by creating an instance of that class in the IBM Content Navigator. • Use the default values for the fields that are not specified in the tables.

Data Item

Value



Object store

Marketing


Value


salesperson_name salesperson_name Sales person name

Data type

String



Single




2-69

Student Exercises


Value


salesperson_id salesperson_id Sales person ID

Data type

Integer



Single

Data for creating a Document class Field

Value


Quote Quote Quote • salesperson_name • salesperson_id

Add Properties

Data for creating an instance of a Document Field

Value

IBM Content Navigator client account (logon/password)


Object store

Marketing

Folder

Vendors

Document Title

TestPriceQuote

salesperson_name

Mary Williams

salesperson_id

1

Verification • Verify that the property templates are available to add to the Document class. • Verify that the new Document class is listed under the Document class node on the left pane. • Verify that you are able to create an instance of this Document class. • Verify that the properties have the value that you entered.





Lesson EXNoSideHead

2.5. Modify Classes and Properties

Why is this lesson important to you? Your Solution Designer identifies the aspects of your business solution that require changes to existing content data structures. As the Solution Builder, you must implement the required changes.

Activities • • • •

Change the Property Template Name: Activity, on page 2-73 Modify a Choice List: Activity, on page 2-77 Change the Class for an Object: Activity, on page 2-81 Work with Metadata Dependencies: Optional Activity, on page 2-85


User ID

Password


p8admin

IBMFileNetP8


p8admin

IBMFileNetP8





2-71

Student Exercises





Change EXNoSideHead

the Property Template Name: Activity

Procedures Procedure 1, "View the property template display name," on page 2-73 Procedure 2, "Change the property template display name," on page 2-73

Procedure 1: View the property template display name 1. Start the IBM Content Navigator. a. In a Firefox browser, go to http://ecmedu01:9080/navigator/ The URL value is case-sensitive. b. Enter the logon credentials for an administrator (user name: P8admin, password: IBMFileNetP8). c. The Content Navigator Sample Desktop opens in Browse view. d. Select the Marketing repository from the list. The Browser view now displays Marketing. 2. View the display name of the prospect_id property definition. a. Click Marketing in the left pane. b. Select the NYB Company folder in the middle pane. c. Click Properties. d. Observe the property display name prospect_id. e. You are going to change this display name to Prospect Code. f.

Log out of the Content Navigator.

Procedure 2: Change the property template display name In this procedure, you change the display name of the prospect_id property template to Prospect Code. 1. Start the Administration Console for Content Platform Engine. a. In a Firefox browser, go to http://ecmedu01:9080/acce b. Log in as the P8admin user (password: IBMFileNetP8) 2. Open the property definition. a. In the administration console, expand the P8Domain > Object Stores node on the left pane and click Marketing. b. In the Marketing tab, expand the Marketing > Data Design > Property Templates node on the left pane and click prospect_id. c. The prospect_id tab opens in the right pane.




2-73

Student Exercises

3. Change the display name for the property definition. a. In the prospect_id tab > General subtab, delete the existing value (prospect_id) and enter Prospect Code for the Display name field. b. Observe that the Symbolic Name field and Description field continues to display prospect_id. c. Edit the Description field value to prospect_id is changed to Prospect Code. d. Click Save to save the changes and then Close. The Properties page closes. 4. Refresh the object store. a. In the Marketing tab, click Refresh. 5. Verify the name change. a. If needed, expand the Marketing > Data Design > Property Templates node on the left pane. b. Verify that the property template is listed as Prospect Code in the right pane. 6. Verify the name change in your Folder class. a. Expand the Marketing > Data Design > Classes > Folder node on the left pane and click PropspectsFolder. b. In the PropspectsFolder tab > Property Definitions subtab, verify that the value is displayed as Prospect Code.

7. Log out of the administration console and close the browser. 8. Verify the new display name for the property definition in the IBM Content Navigator. a. In a Firefox browser, clear the cache by clicking Tools > Clear Recent History from the top menu. b. In the Clear All History window, click Clear Now. c. Repeat Step 1 and 2 in procedure 1 to go to the NYB Company folder properties.





EXNoSideHead d. Verify that the property display name now shows as Prospect Code (in stead of the old name: prospect_id).

e. Verify that the value of the property was retained. 9. Log out of the IBM Content Navigator and close the browser. Note The name change to the property template was automatically propagated to the property definition based on the property template. Only name changes to a property template are automatically propagated to property definitions.




2-75

Student Exercises





Modify EXNoSideHead

a Choice List: Activity

Procedures Procedure 1, "Add a group to a choice list," on page 2-77 Procedure 2, "Verify the modified choice list," on page 2-78

Procedure 1: Add a group to a choice list In this procedure, you add a group to an existing choice list. 1. Start the Administration Console for Content Platform Engine. a. In a Firefox browser, go to http://ecmedu01:9080/acce b. Log in as the P8admin user (password: IBMFileNetP8) 2. Open the choice list. a. In the administration console, expand the P8Domain > Object Stores node on the left pane and click Marketing. b. In the Marketing tab, expand the Marketing > Data Design > Choice List node on the left pane and click Prospect Type. The Prospect Type tab opens in the right pane. 3. Open the Choice Items. a. In the Prospect Type tab, click the Choice Items tab. b. In the Choice Items tab, verify and select the Prospect Type node. 4. Add a group to the choice list. a. Click New Groups. b. In the New Groups window, enter Manufacturer in the Display name field. c. Click Add. d. The group name is added to the panel. Click OK. 5. Add choice items to the group. a. In the Choice Items tab, select Manufacturer. b. Add choice items to the Manufacturer group by clicking New Items. c. In the New Items window, for each name in the table, type the choice item name in the Display name field.


Display Name

Value

Cars

Cars

Vans

Vans

Trucks

Trucks



2-77

Student Exercises

d. When you click outside Display name field, the value is automatically populated in the Value field. Optionally, you can edit the value field. Important Verify that the Value field is populated before you click Add.

e. Click Add. The choice item is added to the panel.

f.

Click OK to close the New Item window.

6. Click Save to save the choice list changes. 7. Verify that your completed choice list looks like the one shown in the screen capture.

8. Refresh the object store. a. In the Prospect Type tab, click Close. b. In the Marketing tab, click Refresh. 9. Log out of the administration console and close the browser.

Procedure 2: Verify the modified choice list 1. Start the IBM Content Navigator. a. In your browser, go to http://ecmedu01:9080/navigator/ 2-78 System Implementation and Administration




EXNoSideHead b. Enter the logon credentials for an administrator (user name: P8admin, password: IBMFileNetP8). The Content Navigator Sample Desktop opens in Browse view. c. Select the Marketing repository from the list. The Browser view now displays your object store. 2. Create a folder. a. Click New Folder. 3. Select your Folder class. a. In the New Folder window > Properties section, select ProspectsFolder from the list for the Class field.

b. Click OK. c. Enter Test New Choice for the Folder Name. 4. Verify that you are able view and select a choice item from you new choice group. a. Select Cars for the prospect_category from the list. Click OK.

b. Enter TNC for the Prospect Code. The value for the field is required.




2-79

Student Exercises

5. Click Add to create the folder. 6. Verify that your new folder is listed. 7. Click the Test New Choice folder. Verify that the properties are shown in the rightmost pane. 8. Optional: Examine an existing folder (that was created before you added the new choice item) to verify the new choice group. a. Right-click the NYB folder and click Properties. b. In the Properties window, verify that you are able view and select a choice item from you new choice group. c. Select Vans for the prospect_category from the list and click OK. d. Click Save. e. Right-click the NYB folder and click Properties. Verify that the properties are shown. 9. Log out of the IBM Content Navigator and close the browser.





Change EXNoSideHead

the Class for an Object: Activity

Introduction In this activity, you create a Document class and use it to change the class for an existing document (that belongs to a different class).

Procedures Procedure 1, "Create a Document class," on page 2-81 Procedure 2, "Examine the properties of a document," on page 2-82 Procedure 3, "Change the class of an object," on page 2-82

Procedure 1: Create a Document class 1. Start the Administration Console for Content Platform Engine. a. In a Firefox browser, go to http://ecmedu01:9080/acce b. Log in as the P8admin user (password: IBMFileNetP8) 2. Open the New Document Class wizard. a. In the administration console, expand the P8Domain > Object Stores node on the left pane and click Marketing. b. In the Marketing tab, expand the Marketing > Data Design > Classes node. c. Right-click Document and click New Class. The New Document Class tab opens in the right pane. 3. Complete the wizard and create a Document class with the data in the table. Field

Value


ProspectUpdated ProspectUpdated ProspectUpdated

4. Add Property Definitions to the ProspectUpdated class. a. Click Document > ProspectUpdated in the left pane. The ProspectUpdated tab opens in the right pane. b. Select the Property Definitions subtab. Click Add. c. In the Add Properties page, scroll down and select the following properties that you want to add. • • • •

contact_methods Prospect Code prospect_category prospect_name

d. Click OK. Verify that all the properties are listed.




2-81

Student Exercises

e. Click Save and then Close.

Procedure 2: Examine the properties of a document In this procedure, you examine the properties of the document (Class: Prospect) for which you are going to change the class to ProspectUpdated. 1. Recall a document that you added in a previous lesson. a. You added a document (Name: NYB252) to the Marketing object store > NYB Company folder. 2. Optionally, you can access this document in Content Navigator and examine it. 3. Examine the properties of the document in the following screen capture. a. Observe that the object class is Prospect.

b. Verify that the document has last_contact_date, times_contacted property names, and values. These properties are removed from this instantiated object when you change the class of this object. c. Verify that the document does not have Prospect Code property is displayed. These properties are added to this instantiated object when you change the class of this object.

Procedure 3: Change the class of an object 1. Open the document. a. In the administration console, expand the Marketing > Browse > Root Folder node. b. Click the NYB Company folder. The NYB Company tab opens in the right pane. c. In the NYB Company tab, click NYB252. The document tab opens.





2. Change the class of a document from Prospect to ProspectUpdated. EXNoSideHead a. In the NYB252 tab, click Actions > Change Class.

The Change Class window opens. b. In the Change Class window, select ProspectUpdated from the list of classes in Class List. c. Select the “Change the class of all versions” option. d. Click OK.

e. Click Close to close the document tab. f.

In the Marketing object store tab, click Refresh.

Procedure 4: Verify the class change 1. Open the document. a. In the NYB Company tab, click NYB252. The document tab opens. b. Click the Properties tab.




2-83

Student Exercises

2. Verify the Properties for the document. a. Verify that Prospect Code property is listed. Recall that this document did not have this property before changing the class.

b. Observe that the Class Description has the new class name (ProspectUpdated). c. The last_contact_date, times_contacted properties are removed from the document. d. Log out of the admin console and close the browser.





Work EXNoSideHead

with Metadata Dependencies: Optional Activity

Introduction In this activity, you replace a choice list with a data entry value for a property template. The updates to a property template do not automatically update the existing property definitions of a class. You must apply this change to a class definition. You must remove the original property definition from the class and add the updated one.

Procedures Procedure 1, "Remove the choice list," on page 2-85 Procedure 2, "Remove a property definition from a class," on page 2-86 Procedure 3, "Assign the property definition to the class," on page 2-87 Procedure 4, "Verify the modifications," on page 2-88 Procedure 5, "Examine the ProspectsFolder class," on page 2-90

Procedure 1: Remove the choice list In this procedure, you remove the association of a choice list from a property template and make the template as a data entry value. 1. Start the Administration Console for Content Platform Engine. a. In a Firefox browser, go to http://ecmedu01:9080/acce b. Log in as the P8admin user (password: IBMFileNetP8) 2. Open the prospect_category property template. a. In the administration console, expand the P8Domain > Object Stores node on the left pane and click Marketing. b. In the Marketing tab, expand the Marketing > Data Design > Property Templates node on the left pane. c. Scroll down and click prospect_category. 3. Remove the Prospect Type choice list from the property template. a. In the prospect_category tab, click the Properties subtab. b. Click the Property Name column to list the items in alphabetical order. c. Scroll down and find the Choice List property. d. Observe that this property template is associated with the Prospect Type choice list.




2-85

Student Exercises

e. To remove the association of the choice list, click the arrow next to it and select Unset Value.

f.

Verify that the Choice List field has no value.

g. Click Save to save the changes. h. This change makes the prospect_category as a data entry property template.

Procedure 2: Remove a property definition from a class 1. Check the classes that use the prospect_category property template. a. In the prospect_category tab > Properties subtab, click the Property Name column to list the items in alphabetical order. b. Scroll down and find the Used in Classes property. c. Click the arrow to see the list. Observe that the classes that use this property template is listed.

d. Close the prospect_category tab. 2. Remove the unmodified prospect_category property definition from the ProspectUpdated class definition. a. In the Marketing tab, expand the Marketing > Data Design > Classes > Document node on the left pane. b. Click ProspectUpdated. c. In the ProspectUpdated tab, click the Property Definitions subtab.





EXNoSideHead d. Select the prospect_category property definition and click Remove.

e. Verify that the property is removed from the list and click Save to save the changes. f.

Click Close to close the tab.

g. In the Marketing tab, click Refresh. 3. Optionally, examine the changes to the document in the IBM Content Navigator. a. Verify that the document (that you created earlier with the choice list value; Document class: PropspectUpdated) does not have the choice list property called prospect_category

Procedure 3: Assign the property definition to the class In this procedure, you assign the modified prospect_category property (without the choice list) to the PropspectUpdated class. 1. Open the PropspectUpdated class. a. In the administration console > Marketing tab, expand the Marketing > Data Design > Classes > Document node. b. Click the ProspectUpdated class. c. In the PropspectUpdated tab, click Property Definitions subtab.




2-87

Student Exercises

2. Assign the property. a. Click Add. b. In the Add Properties window, scroll down and select prospect_category. c. Click OK. d. Verify that the property is added to the list. e. Click Save to save your changes. f.

Click Close to close the tab.

g. In the Marketing tab, click Refresh. 3. Log out of IBM Content Navigator.

Procedure 4: Verify the modifications In this procedure, you create a document of the PropspectUpdated class and verify the change in property definition. 1. Open the WebSphere Integrated Solutions Console: a. In a Firefox browser, go to https://ecmedu01:9043/ibm/console/logon.jsp b. Log in as the P8admin user (password: IBMFileNetP8) c. The WebSphere Application Server console opens. 2. Restart the Content Navigator application. a. Expand the Applications > Application Types. b. Click the WebSphere enterprise applications node in the left pane. c. Select navigator from the list on the right pane.

d. Click Stop. Wait until the message is shown.





EXNoSideHead e. Select navigator and click Start. Wait until the message is shown. f.

Log out of the WebSphere Integrated Solutions Console. Important

For the property template changes to show in the IBM Content Navigator, you must restart the Content Navigator in the WebSphere Application Server.

3. Start the IBM Content Navigator. a. In a Firefox browser, go to http://ecmedu01:9080/navigator/ b. Enter the logon credentials for an administrator. c. Log in as the P8admin user (password: IBMFileNetP8) d. The Content Navigator Sample Desktop opens in Browse view. e. Select the Marketing repository from the list. The Browser view now displays Marketing. 4. Add a document. a. Click the Marketing > NYB Company folder in the left pane. b. Click Add Document in the tool bar. 5. Enter the properties. a. In Add Document page, select “Information about the document” for the “What do you want to save?” field. b. In the Properties section, select PropspectUpdated from the list for the Class field. c. Click OK. d. Enter the values for the other fields from the following table. Field

Value

Document Title

Test Prop

Prospect Code

TP724

prospect_name

Gloria Stanton

e. For the prospect_category, notice that there is no choice list. Enter Dealer as the value.




2-89

Student Exercises

f.

Click Add.

6. Verify that your new document is listed in the folder.

Procedure 5: Examine the ProspectsFolder class Recall that you created a ProspectsFolder class that also uses the prospect_category property template. This class still retains the choice list, because this property definition for the folder class is not updated after you removed the choice list from the template. The change in the property template is not automatically propagated to the Classes. In this procedure, you verify the prospect_category property of the folder class. 7. Open the folder properties: a. In the Content Navigator, click Marketing in the left pane. b. Select the NYB Company folder in the middle pane. c. Click Properties from the toolbar. 8. Observe the prospect_category property. a. Verify that if you edit the prospect_category property, the choice list is available. b. Click Cancel to close the Properties page.





EXNoSideHead

9. Log out of the Content Navigator and close the browser.

Summary In this activity, you did the following steps. • Removed the choice list from a property template. • Removed the original property definition (that has the choice list) from a class. • Assigned the modified property definition (no choice list) to the class. • Verified the modifications by creating a document class. • Examined the ProspectsFolder class that did not get affected by the change.




2-91

Student Exercises





Unit 3. Extend Content Platform Engine Functions

EXNoSideHead


Lessons Lesson 3.1, "Create a Subscription with an Event Action," on page 3-3

Unit dependencies Refer to Unit 1: Introduction to IBM FileNet Content Manager for the system startup and system check.




System Check Perform a system check whenever you start an IBM FileNet P8 system or start working on a system that is in an unknown state.




3-1

Student Exercises

3-2





Lesson EXNoSideHead

3.1. Create a Subscription with an Event Action

Why is this lesson important to you? Your business requires a customized action when a particular Content Platform Engine event occurs. For example, whenever a business user creates a document, you want to log the event in a file. You can extend Content Platform Engine functionality with your own server-based action handlers. The solution developer for your company provides you the Java code for the customized actions. As a Solution Builder, you must create subscription with event actions that uses the code.


Create a Subscription with an Event Action: Activity, on page 3-5 Update the Event Action with new Code Module: Activity, on page 3-11 Examine a Workflow Subscription: Tour, on page 3-15 Create a Subscription with an Event Action: Practice, on page 3-19


User ID

Password


p8admin

IBMFileNetP8

FileNet Enterprise Manager

p8admin

IBMFileNetP8


p8admin

IBMFileNetP8


burt

filenet





3-3

Student Exercises

3-4





Create EXNoSideHead

a Subscription with an Event Action: Activity

In this activity, you create a code module with prewritten Java code, an event action, and a subscription for the Order document subclass. You associate the event action with the subscription and test it by creating an Order document. Document creation triggers the subscription and the code is executed which creates an entry in a log file.

Procedures Procedure 1, "Create an Event Action," on page 3-5 Procedure 2, "Create a Subscription," on page 3-7 Procedure 3, "Test the Subscription and Event Action," on page 3-9 Procedure 4, "Examine the EventLog.txt file," on page 3-10

Procedure 1: Create an Event Action 1. Start the FileNet Enterprise Manager by double-clicking the icon on the desktop. a. In the FileNet P8 Logon page, ECMEDU01 entry is already selected. Click Connect. b. In the Enterprise Manager console, Expand Object Stores > Sales > Events > Event Action. 2. Create an event action. a. Right-click the Event Action and click New Event Action. b. Create Event Action wizard opens. c. In the Welcome window, click Next. 3. Name and Describe the Event Action. a. Enter Log Event Action in the Name field. b. Optionally, enter a description and click Next. 4. Specify the Type of Event Action. a. Leave the Enabled checked for the Initial Status field. b. Select the Class option. c. For the Handler Java Class Name field, type the following text: com.ibm.filenet.edu.LogEventActionEDU Note Type the Java class name exactly as shown because it is case-sensitive.

d. Select the Configure Code Module option.




3-5

Student Exercises

e. Click Next.

5. Specify the Code Module to be configured. a. Click Browse/Add. b. In the Open window, go to C:\LabFiles\ExtendCPEFxn. c. For the File of type field, select JAR files (*.jar) from the list.

d. Select EDULog.jar and click Open. e. Click Next. f.

Note the entries in the Create an Event Action wizard and click Finish.

g. Click OK when it prompts with the confirmation message that you successfully created the Log Event Action. h. Verify that the Event Action that you created is listed on the right pane.

i.

This event action is now one of the event actions available for selection when you create a subscription.

6. Close the Enterprise Manager application.

3-6






2: Create a Subscription

1. Start the Administration Console for Content Platform Engine. a. In your browser, go to http://ecmedu01:9080/acce b. Log in as the P8admin user (password: IBMFileNetP8) 2. Create a subscription. a. In the administration console, expand the P8Domain > Object Stores node on the left pane and click the Sales object store. b. In the Sales tab, expand Sales > Data Design > Classes > Document > Order on the left pane. c. Right-click Order and then click New Subscription from the list.

d. The New Subscription tab opens on the right pane. 3. Name and Describe the Subscription. a. In the New Subscription tab, enter Log Subscription in the Display name field. b. Optionally enter a description and click Next. 4. Specify the Subscription Behavior. a. Leave the default option of “Applies to all objects of this class” for the Scope field.

Note Observe that the “Create a workflow subscription” is not selected for the workflow subscription option field since you are not launching a workflow with this subscription. Later in this lesson, you explore a workflow subscription.

b. Click Next.




3-7

Student Exercises

5. Select the Triggers. a. Select Creation Event in the Event Name list. b. Click Next.

6. Select an Event Action. a. Select Log Event Action from the list. b. Click Next. 7. Specify Additional Options. a. Select Enable this subscription. b. Optionally, select Include subclasses. c. For the filter expression field, enter the following text: (MajorVersionNumber=1 and MinorVersionNumber=0) OR (MajorVersionNumber=0 and MinorVersionNumber=1)

d. Click Next. 8. Review the summary and click Finish. 9. Click Close when you receive the confirmation message that you successfully created the Log Subscription. 10. View the subscription that you created. a. Select the Sales tab, and click Refresh. b. Expand Sales > Events, Actions, Processes > Subscriptions on the left pane.

3-8





EXNoSideHead c. Click Subscriptions and verify that Log Subscription is listed on the right pane.

Procedure 3: Test the Subscription and Event Action Note The Java Code Module contains instructions to write an entry into a log file each time a document of the class that is subscribed to is created.

1. Create a folder. a. In the Sales object store tab, expand the Sales > Browse > Root Folder node on the left pane. b. Right-click the Root Folder and click New Folder. c. Enter Test Folder for the folder name. d. Leave the default value (Folder) for the Class field. e. Click Next and leave the default values for all other fields. f.

Click Next and click Finish.

g. Click Close to close the New Folder tab. h. In the Sales object store tab, click Refresh to refresh the Object store. 2. Add a document. a. In the Sales object store tab, expand the Sales > Browse > Root Folder > Test Folder node on the left pane. b. Right-click Test Folder and click New Document. c. Enter Log Test as the Document title. d. Select Order from the list for the Class field. e. Complete the wizard by clicking Next three times. Leave the default values for all the fields. f.

In the final page, view the summary and click Finish.




3-9

Student Exercises

g. When the page displays that the Log Test document is created, click Close to close the New Document tab. 3. In the Test folder tab, click Refresh. a. Verify that the new document is listed. 4. Log out of Administration Console for Content Platform Engine. a. Close the Browser.

Procedure 4: Examine the EventLog.txt file 1. Verify that the file EventLog.txt was created. a. In Windows Explorer, open the following folder and locate the file: C:\Program Files\IBM\WebSphere\AppServer\profiles\AppSrv01. b. Verify that the EventLog.txt file has the current date and time. Note The code for the Log Action adds a text line to the EventLog.txt file each time that the event action executes. This line consists of the following statement: A new document is created on: Day Mon DD HH:MM:SS EDT YYYY. Document class name = Order, Document id = {GUID}

2. Verify that the log file has an entry for the Order document that you created. a. Open the EventLog.txt file with the text editor. Example: Notepad b. Verify that it includes a line that identifies the date and time that your new document was created in the object store.

c. Close the EventLog.txt file.





Update EXNoSideHead

the Event Action with new Code Module: Activity

Your Management wants to include the user who creates the document in the event log every time a document is added. The Developer provides the new JAR file that contains the updated code to the Administrator. In this activity, you are going to modify the Code Module to use the new JAR file. You also update the Event Action that references the Code Module and test it.

Procedures Procedure 1, "Update the Code Module," on page 3-11 Procedure 2, "Update the Event Action," on page 3-12 Procedure 3, "Test the new Code Module," on page 3-13

Procedure 1: Update the Code Module In this procedure, you check in a new version of code module that contains more line code. 1. Start the FileNet Enterprise Manager by double-clicking the icon on the desktop. a. In the FileNet P8 Logon page, ECMEDU01 entry is already selected. Click Connect. b. In Enterprise Manager console, Expand Object Stores > Sales > Root Folder > CodeModules on the left pane. 2. Check out the code module: a. Click the CodeModules folder. b. Select the EDULog.jar code module on the right pane. c. In the menu bar, select Action > Exclusive Check Out (default). d. In the Open window, go to C:\Temp from the Look in selection list at the top of the window. The JAR file is saved in this location when you complete the checkout. e. Click Open. f.

Click No at the prompt Would you like to edit the file? You should see a checked out icon next to the containment/Folder Name.

3. Check in the new version of the code module. a. Select the EDULog.jar code module on the right pane. b. From the menu bar click Action > Check In. The Check In Content window opens. c. In Content Elements section, click Browse/Add next to the File Name field. d. Browse to C:\LabFiles\ExtendCPEFxn. © Copyright IBM Corp. 2013, 2015



3-11

Student Exercises

e. For the “File of type” field, select Jar files (*.jar) from the list.

f.

Select EDULogv2.jar and click Open.

g. Click Check In. 4. Verify that the new version was created. Locate the Major Version column in the list view and confirm that the version value is 2.

Procedure 2: Update the Event Action In this procedure, you edit the event action to associate it with the new version of code module. 1. Copy the object reference for the new code module version. a. Select the code module EDULog.jar. b. From the menu bar, click Action > Copy Object Reference. No visible change occurs. 2. Select the event action to update: a. Expand Sales > Events > Event Action. b. In the list view, open the Properties page of the Log Event Action by right-clicking and selecting Properties from the list. The Log Action Properties window is displayed. 3. Update the event action with the new code module version: a. Click the Properties tab and select the All Properties option in the Filter the properties displayed field.

b. Scroll down to the Code Module property at the bottom of the window.





EXNoSideHead c. Right-click the Code Module value field and click Paste Object.

The Select Object from Paste Buffer window opens. d. Select the latest version (Version value is 2.00) object reference.

e. Click OK. f.

Click Apply to save the changes.

g. Click OK to close the window.

Procedure 3: Test the new Code Module 1. Start the Administration Console for Content Platform Engine. a. In your browser, go to http://ecmedu01:9080/acce b. Log in as the P8admin user (password: IBMFileNetP8) c. In the Administration Console, expand P8 Domain > Object Stores in the left pane. d. Click Sales. 2. Add a document. a. In the Sales tab, expand the Sales > Browse > Root Folder > Test Folder node on the left pane. b. Right-click the Test folder and click New Document. c. Enter Log Update as the Document title. d. Select Order from the list for the Class field. e. Complete the wizard by clicking Next three times. Leave the default values for all the fields. f.

In the final page, view the summary and click Finish.

g. When the page displays that the document is created, click Close to close the New Document tab. 3. In the Test folder tab, click Refresh. a. Verify that the new document is listed.




3-13

Student Exercises

4. Verify that the file EventLog.txt was updated. a. In Windows Explorer, open the following folder and locate the file: C:\Program Files\IBM\WebSphere\AppServer\profiles\AppSrv01. b. Verify that the EventLog.txt file has the current date and time. Note The updated Code Module generates an event log entry that also includes the name of user that added the document: The entry consists of the following statement: A new document is created on: Day Mon DD HH:MM:SS EDT YYYY. Document class name = Order, Document id = {GUID} Added by: P8Admin

5. Verify that the log file has an entry for the Order document that you created. a. Open the EventLog.txt file with the text editor. Example: Notepad b. Verify that it includes a line that identifies the date and time that your new document was created in the object store and the user who created it.

c. Close the EventLog.txt file. d. Log out of the Administration Console for Content Platform Engine and close the browser. e. Close the FileNet Enterprise Manager application.





Examine EXNoSideHead

a Workflow Subscription: Tour

In response to a fired event on an object, a Workflow Subscription launches a workflow. In this activity, you examine a Subscription that is already configured on your student system. Information You can create a subscription that launches a workflow as well as executes an event action handler.

Procedures Procedure 1, "Open a Workflow Subscription," on page 3-15 Procedure 2, "Explore the Workflow Subscription," on page 3-16 Procedure 3, "Test the Workflow Subscription," on page 3-17

Procedure 1: Open a Workflow Subscription 1. Start the Administration Console for Content Platform Engine. a. Go to the http://ecmedu01:9080/acce b. Log in as theP8admin user (password: IBMFileNetP8) 2. Open a workflow subscription. a. In the Sales object store tab, expand the Sales > Events, Actions, Processes node and click the Subscriptions on the left pane. b. In the Subscriptions tab, observe that Test Workflow Subscription is listed. c. Verify that the subscription is enabled. The Enabled column has the value as True.

d. Click Test Workflow Subscription to open the Properties page.




3-15

Student Exercises

Procedure 2: Explore the Workflow Subscription 1. Open the General tab: a. Verify that the Description field identifies it as a workflow subscription. b. The Target ID is Product, indicating that the subscription monitors this object class. 2. Examine the Properties tab. a. The Event Action field has a value: Workflow Event Action indicating that when an event triggers a workflow is launched. 3. Examine the Configuration tab. a. There are options to enable the event action to include the subclasses, and to run the event action as a synchronously. b. In the Filter expression field, you specify conditions to trigger the subscription. This workflow is launched when quantity property has a value of 20. 4. Examine the Subscribed Events tab. a. Creation Event is selected. When a document is created, it triggers the subscription. 5. Examine the WorkFlow tab. Information The Properties page for this subscription has a WorkFlow tab because it is a Workflow Subscription. When the subscription is only associated with a custom event handler, the Properties page does not have a WorkFlow tab.

a. Verify that for the Workflow definition field, Test Subscription Workflow is selected. (Version number is selected at the time of creation but not shown in the view). b. Scroll down and locate the Property Maps.

c. Notice that the workflow properties are mapped to the document properties. 6. Log out of Administration Console for Content Platform Engine and close the browser.





EXNoSideHead

Important

The names of workflow and document properties do not have to match, but they must be of the same data type. Example: both quantity properties are of integer type; description and product_description are of string type.

Procedure 3: Test the Workflow Subscription In this procedure, you create a document of Product class that triggers the workflow. You verify that a workflow is launched and a work item is shown. 1. Start IBM Content Navigator for the Sample Desktop. a. In your browser, go to http://ecmedu01:9080/navigator/?desktop=SampleDesktop. The URL value is case-sensitive. b. Enter the logon credentials for an administrator (user name: P8admin, password: IBMFileNetP8). c. The IBM Content Navigator client opens with the Browse view. d. Verify that Sales object store is shown. 2. Add a document. a. Expand Sales object store node and click Test Folder in the left pane. b. Click Add Document from the toolbar on the right pane. Add Document page opens. 3. Specify the content: a. For the “What do you want to save” field, select “Information about a document” from the list. 4. Enter the properties: a. In the Properties section, select Product from the list for the Class field. Notice that a list of properties for this object class are displayed. b. Enter the following values for each property: Property Name

Value

Document Title

Subscription Test

product_id

PYM01

product_description

Good

price

15

quantity

20 (This value needs to be 20 for the workflow to launch as defined in the subscription filter).

c. Click Add. d. Verify that the new document is listed.




3-17

Student Exercises

5. Verify that the workflow is launched and work item is shown. a. Click the Work View icon on the left pane.

Information Your student system is configured for the Workflow Subscription. When you add a document of Product class, a workflow is launched. A work item is available in the Sales Officer in-box.

b. Expand Sales Officer and click My work items. c. Verify that a work item with the subject “Verify the subscription” is listed with the current date and time. d. Notice that the product_id, quantity, and description fields have the same values that you set for the document properties. These fields are the workflow properties that are mapped to the document properties

e. Log out of Administration Console for Content Platform Engine and Content Navigator. f.

Close the browsers.





Create EXNoSideHead

a Subscription with an Event Action: Practice Complete the following exercise scenario to practice the procedures that you learned in this lesson.

Scenario: Create an automated action for the Sales Department Sales Department of your company requests the following automated action for their IBM FileNet Content Manager system: Whenever, a business user creates a Project folder, they want specific subfolders to be automatically created for that project. Name of the sub folders: Contracts, Orders, and Quotes The Solution Developer provides you the Java code that creates these subfolders. As the Solution Builder, you must create a Subscription with an Event Action that uses the code.

Challenge • Create an event action with Code Module. Associate it with a Subscription and test it. Use the data in the following tables.

Data for creating an Event Action Item

Value

Name of the Event Action

CreateProjectSubFoldersAction

Type of Event Action

Initial Status: Enabled Class Handler Java Class: com.ibm.filenet.edu.CreateProjectSubFoldersActio n Configure code module: Yes

Location of the Java class

C:\LabFiles\ExtendCPEFxn\CreateProjectSubFold ersAction.class

File type

.class (Note: You used .jar type in the previous activity)

Hint Steps: 1. Create an Event Action with a code module in FileNet Enterprise Manager. 2. Create a Subscription in Administration Console for Content Platform Engine.




3-19

Student Exercises

3. Test the subscription by creating the specified folder under the Test folder in Administration Console for Content Platform Engine.

Data for creating a Subscription Item

Value

Administration Console for Content Platform p8admin/IBMFileNetP8 Engine account (logon/password) Object store

Sales

Target Object (Folder Class name)

ProjectFolder

Folder class node in the object store

Sales > Data Design > Classes > Folder > ProjectFolder

Name of the Subscription

Project Folder Subscription

Subscription Behavior

Scope: Apply to all objects of this class (default value)

Triggers > Event Name

Creation event

Name of the Event Action

CreateProjectSubFoldersAction

Specify Additional Options

Initial state: Enabled Subclass option: Include Subclasses

Verification • Create a folder (Name: Subscription Test) of ProjectFolder class under the Test Folder in Administration Console for Content Platform Engine. Verify that the subfolders (Contracts, Orders, and Quotes) are created under the Project folder.





Unit 4. Configure IBM Content Navigator

EXNoSideHead


Lessons Lesson 4.1, "Configure a Content Navigator Desktop," on page 4-3

Unit Dependencies Refer to Unit 1: Introduction to IBM FileNet Content Manager for the system startup and system check.




System Check Perform a system check whenever you start an IBM FileNet P8 system or start working on a system that is in an unknown state. These activities assume that you did a system check when you begin an activity session.




4-1

Student Exercises

4-2





Lesson EXNoSideHead

4.1. Configure a Content Navigator Desktop

Why is this lesson important to you? The Content Navigator installation provides the Admin desktop for administering the web client. You must create at least one desktop for business users. In addition, you must also configure connections to your Content Management repositories to access content through the web client. As a Solution Builder, you configure these features in the IBM Content Navigator web client application.

Activities • Configure a Content Navigator Desktop: Activity, on page 4-5 • Configure a Content Navigator Desktop: Practice, on page 4-17


User ID

Password


p8admin

IBMFileNetP8


p8admin

IBMFileNetP8


burt

filenet





4-3

Student Exercises

4-4





Configure EXNoSideHead

a Content Navigator Desktop: Activity

In this activity, you configure a new desktop in the IBM Content Navigator web client application. You also change the appearance of the banner for this decktop.

Procedures Procedure 1, "Configure Repositories," on page 4-5 Procedure 2, "Create a Desktop," on page 4-8 Procedure 3, "Configure the Layout and Menus," on page 4-9 Procedure 4, "Configure Workflow options," on page 4-10 Procedure 5, "Save the Desktop Configuration and test," on page 4-10 Procedure 6, "Edit the Desktop to customize the Banner," on page 4-12 Procedure 7, "Configure Sample Desktop as the default," on page 4-14

Procedure 1: Configure Repositories To access the content in an IBM FileNet P8 repository, you must first configure IBM Content Navigator to connect to that repository. Then, you must associate a desktop with this repository to enable users to access the content. 1. Start the IBM Content Navigator. a. In your browser, go to http://ecmedu01:9080/navigator/?desktop=admin. The URL value is case-sensitive. b. Enter the logon credentials for an administrator: • User name: P8admin • Password: IBMFileNetP8 2. Create a connection to a repository. a. On the Admin desktop, click Repositories in the left pane. On the Repositories tab is a list of the repositories that are configured. b. Click New Repository and select FileNet Content Manager. c. On the General tab of the New Repository page, enter a value for the Display name field, (Example: SalesQA). d. The ID field is automatically populated based on the Display name field entry. Hint Click the question mark next to each field name to get more details about that field.

e. Enter the Server URL: iiop://ecmedu01:2809/FileNet/Engine. ecmedu01 is your server name. © Copyright IBM Corp. 2013, 2015



4-5

Student Exercises

f.

Enter a value for the object store symbolic name: SalesQA

g. Enter a value for the object store display name: SalesQA h. Click Connect to test the repository connection. i.

In the Log In page, enter the logon credentials for an administrator and click Log In. • User name: P8admin • Password: IBMFileNetP8

j.

Save the changes by clicking Save.

3. Configure Parameters: a. In the Configuration Parameters tab, select Enable to use Teamspaces on this repository. b. Accept the default value (Yes) to Add and Check in as a Major version. c. Select “Inherit from the document” for Annotation security. d. Select a value from the list for workflow connection point. (Example: P8ConnPt2:2)

e. For all other fields, leave the defaults. 4. Set the system properties to display for documents. a. On the System Properties tab, accept the default values. The document properties that are listed in Selected Properties are displayed. 4-6





5. Set the system properties to display for folders. EXNoSideHead a. Select Folders from the list for the “System properties for” field. b. Select Folder Name in the Available Properties pane. c. Move it to the Selected Properties pane by clicking the forward arrow. d. The Folder Name property is listed in the Selected Properties pane. 6. Configure the properties to display in the Browse view. a. On the Browse tab, the properties in the Selected Properties pane are shown in the content list for users. b. Select customer_name in the Available Properties pane. c. Move it to the Selected Properties pane by clicking the forward arrow. d. Change the order of the properties in the Selected Properties by clicking the upward or downward arrow. 7. Configure the Search view. a. In the Search tab, select the values that are given in the following data table. Field

Value

Cross-repository searches

Enable

Number of results

Limit to:10

Timeout (in seconds)

Limit to:180

Match

All of the search criteria

Default Search Type

Documents

8. Configure Searchable properties. a. Users can search on the properties in the Displayed Properties list. b. In the Search tab > Searchable properties section, move the following properties to the Hidden Properties pane to hide them. Use the forward arrow. • Application name • Classification Status • Is Frozen Version 9. Configure Search operators. a. You can use the operators in the Displayed Operators list for search. b. In the Search tab > Search operators section, move Include Any to the Hidden Operators pane to hide them. Use the forward arrow. 10. Configure Search results. a. In the Search tab > Search results section, the properties in the Displayed Properties list are shown for the search results. b. Leave the defaults for this exercise. c. You can move the properties from the Displayed Properties list to hide them from the Search results. Use the Forward arrow. © Copyright IBM Corp. 2013, 2015



4-7

Student Exercises

11. Save the configuration settings for the new repository. a. Click Save and Close to save the settings and close the New Repository tab. b. During repository configuration, save your work at stages by clicking Save. 12. Test the new repository. a. Verify that the new repository is listed on the Repositories tab. b. This repository is now available to be used in the Content Navigator.

Procedure 2: Create a Desktop 1. If the IBM Content Navigator is not already opened, start the IBM Content Navigator. a. In your browser, go to http://ecmedu01:9080/navigator/?desktop=admin. The URL value is case-sensitive. b. Enter the logon credentials (user name: P8admin, password: IBMFileNetP8). 2. Create a desktop. a. In the Desktops tab, a list of the existing desktops is shown. Click New Desktop. b. On the General tab, enter a name for your desktop, for example My Desktop. Note The ID field is automatically populated based on the Name field entry. This desktop ID is used in the URL for accessing the desktop. It is case-sensitive.

3. Specify a repository (already configured) that you want to use to authenticate users. a. Select Sales from the list for the Repository field. b. Select Enable to Limit access to specific users and groups. c. Click Select Users. d. Enter the logon credentials (user name: P8admin, password: IBMFileNetP8). e. In the Add Users and Groups page, search for P8admin. f.

Move it to the Selected pane.

g. Select Allow from the list for the Permission field. h. Click Add to save the changes and close the page. i.

Repeat the steps to add the user called burt.

4. Select a Viewer map for the Viewer map field: a. On the General tab, verify that Default viewer map is selected in the list. 5. Configure Error message information: a. Accept the default option (IBM Information center). 4-8





6. Set this desktop as the default desktop: EXNoSideHead a. In the Additional Settings area, select the option Set as the default desktop. b. For all other fields, leave the defaults. You can also control some aspects of how documents are added and checked in and prevent users from some actions. 7. Click the Mobile tab and explore the options available for the Mobile applications. a. Leave the defaults. 8. Specify the repositories that can be accessed from this desktop. a. On the Repositories tab, move Sales from Available to Selected Repositories. • Use the right arrow to move it. b. Move more repositories. (Example: LoanProcess, SalesQA, and P8ConfigObjectStore) When you move your mouse over a repository name, the repository type and connection details are shown. 9. Configure an application name for this desktop: a. On the Appearance tab, enter a value for the Application name (Example: My Desktop). This value is displayed at the top of the page and on the Log In page for this desktop. You can also change other aspects of the banner and login pages in this section.

Procedure 3: Configure the Layout and Menus 1. On the Appearance tab, scroll down to the Layout section. 2. Select the features that you want to display in this desktop. a. Verify that Browse, Favorites, and Search are listed in the Selected Features pane. b. If they are not already moved, move Browse, Favorites, and Search. c. Move Work from Available to Selected Features by clicking the right arrow. d. Arrange them into the order that you want by clicking the up and down arrows. 3. Set a feature to be the default for this desktop. The web client opens with this feature when a user logs in to this desktop. a. Select Browse from the list for the Default feature field. 4. Set default repositories for other features: a. On the Appearance tab, scroll down to the Default repository section. b. Select Sales as a default repository for the Work view. c. Select Sales as a default repository for the Search and Browse views. A user can switch to other available repositories for searching and browsing. d. Click Save to save the changes.




4-9

Student Exercises

5. Set other options for appearance: a. Select Enable to show document thumbnails for documents in a preview pane. b. Leave the default value (Disable) for the Filmstrip view for this activity. c. Select the Enable option to show global toolbar above the content in the web client. 6. Set menu options for the desktop: You can specify the default toolbars and menus, or use custom toolbars and menus that are created and registered as plug-ins. a. On the Menus tab, scroll down to see the options available for each menu. b. Accept the defaults for this activity.

Procedure 4: Configure Workflow options 1. Click the Workflows tab. a. Select Sales from the list for the Repository field. b. When you are prompted to log in, enter the logon credentials for an administrator. • User name: P8admin • Password: IBMFileNetP8

c. Select DefaultApplication from Available to Selected Application Spaces. Use the right arrow to move it. 2. Repeat the step 1 to select the application spaces for other repositories in the list (Example: LoanProcess and SalesQA).

Procedure 5: Save the Desktop Configuration and test 1. Click Save and Close to save the Changes and to close the tab. 2. Verify that the new desktop is listed on the Desktops tab. Log out and close the browser.





3. Test the new desktop by accessing it with the (case sensitive) web address for that desktop in a EXNoSideHead browser: http://ecmedu01:9080/navigator/?desktop=MyDesktop a. Enter the logon credentials for a business user. • User name: burt • Password: filenet The desktop opens to the specified default feature page (Browse). b. Verify that the application name is shown in the banner area at the top of the page. c. The global toolbar that you enabled is shown at the top of the page.

d. Log out of IBM Content Navigator. 4. Log in as olivia (password:filenet) who does not have access to the desktop. a. Verify that “do not have access” message is shown.

Note After creating a desktop, you can copy your desktop and save it as another desktop. The http://ecmedu01:9080/navigator/ URL also brings up your desktop, since you set your desktop as the default desktop.




4-11

Student Exercises

Procedure 6: Edit the Desktop to customize the Banner 1. Start the IBM Content Navigator admin page. a. In your browser, go to http://ecmedu01:9080/navigator/?desktop=admin. b. Enter the logon credentials for an administrator. • User name: P8admin • Password: IBMFileNetP8 2. Edit the desktop. a. On the Admin desktop, the Desktops tab is already opened. b. In the Desktops tab, right-click My Desktop that you created and click Edit. c. Click the Appearance tab. 3. For the Banner and Login Page section, enter the values in the table. Field Name

Option

Value

Banner Logo

URL

MyImages/IBM_Nav_logo.png

Banner background color

Custom

#FFFFCC

Application name text color

Custom

#006600





EXNoSideHead

Note

An image for the banner logo is already copied into the C:\Program Files\IBM\WebSphere\AppServer\profiles\AppSrv01\installedApps\P8Node01Cell\navigat or.ear\navigator.war\MyImages folder.

4. Click Save and close. a. If prompted, click Close on the Information page. b. Log out of the IBM Content Navigator.

5. Test the desktop banner. a. Start your desktop in a browser: http://ecmedu01:9080/navigator/?desktop=MyDesktop b. Enter the logon credentials (user name: p8admin, password: IBMFileNetP8). The desktop opens.




4-13

Student Exercises

6. Observe the following changes (as you configured) in the banner for your desktop. - The banner background color - Banner logo - Application name text color

7. Compare the banner appearance with the desktop before editing.

Procedure 7: Configure Sample Desktop as the default Before you created My Desktop as the default, Sample Desktop was the default desktop. In this procedure, you reset the Sample Desktop configuration. 1. In your browser, go to http://ecmedu01:9080/navigator/?desktop=admin. a. Enter the logon credentials for an administrator. • User name: P8admin • Password: IBMFileNetP8 2. In the Desktops tab, My Desktop is shown as the default desktop. a. Click Sample Desktop to select it and click Edit.

3. Set Sample Desktop as the default desktop: a. On the Sample Desktop tab > General subtab, Scroll down to Desktop configuration section.





EXNoSideHead b. In the Additional Settings area, select the option “Set as the default desktop”.

c. Click Save and Close. d. In the Desktops tab, verify that Sample Desktop is shown as the default desktop.

4. Log out of IBM Content Navigator and close the Browser.




4-15

Student Exercises






a Content Navigator Desktop: Practice Complete the following exercise scenario to practice the procedures that you learned in this lesson.

Scenario: Create a Desktop for Loan Department Loan Process Department requests a customized desktop for their business use and they provide specifications for their desktop. As their administrator, you must configure a desktop with their specifications.

Challenge • Create and configure a desktop.

Data Item

Value



IBM Content Navigator Administrator account (logon/password)


Business User accounts for this desktop (logon/password)

sydney/filenet sylvia/filenet

Repositories to add to the desktop

LoanProcess

Default Repository

LoanProcess

Default Feature

Browse

Viewer Map, Layout, and Menu

Use Default.

Hint • You must log in as P8admin to configure the desktop. After the configuration, log in as Sydney or Sylvia to test the desktop. • The URL for the desktop: http://ecmedu01:9080/navigator/?desktop=

Verification • Log in to the desktop that you created. Verify that the desktop contains the repositories and other settings as you configured.




4-17

Student Exercises





Unit 5. Security

EXNoSideHead

Unit overview Lessons Lesson 5.1, "Security Concepts," on page 5-7 Lesson 5.2, "Modify Direct Security," on page 5-17 Lesson 5.3, "Configure object store security," on page 5-29 Lesson 5.4, "Configure Class and Property Security," on page 5-47 Lesson 5.5, "Configure Security Inheritance," on page 5-55 Lesson 5.6, "Work with Security Policies," on page 5-69


Clearing the browser cache In some instances, the browser cache might contain security information that prevents you from logging onto an application. If you see the following message, you must clear the browser cache before you can continue.

To clear the browse cache, do the following: 1. In Firefox, click Tools > Clear Recent History.


Unit 5. Security

5-1

Student Exercises

2. On the Clear All History window, click Clear Now.

3. With the browser cache cleared, you can proceed with the lab activity.

Users and groups list This table shows the users and groups defined on your student system. Group

Members

#Authenticated Users

*

Accounting

Allison Finance admins Legal AEadmin P8Admin Allen Amy Ana P8admin P8admin P8admin P8admin Sue Sue P8admin Cody Sue Cody Fred Addington P8admin

Admins AEAdmins Agent Approver BPM Administrator BPM Designer BPM User Case admins Case initiators

Case workers

CEadmins

5-2

Ceadmin


Object stores P8ConfigObjectStore SalesSBx

LoanProcessQA

LoanProcess LoanProcessQA




EXNoSideHead Group Clerks Components Coordinators Customers Finance Admins Finance Clerks Finance Managers Finance reviewers Legal Loan business analysts Loan business users Loan guests

Loan Managers

Loan officers Loan operations Loan processors Loan system administrators Loan underwriters Managers Operations

Members Clara Clark Component Connie Conrad Customer Adam Allison Steve Carol Charles Mark May Richard Roberta Larry Linda Barb Barry Burke Burt Gabe Gail loanGuest Mabel Mac Mary Matt Olivia Oscar Opal Ophelia Pat Peter Sydney Sylvia Uma Uri Manny Mary Opal Oscar

Object stores LoanProcessQA

LoanProcessQA LoanProcessQA LoanProcessQA LoanProcessQA

LoanProcess LoanProcess LoanProcess

LoanProcess LoanProcess LoanProcess LoanProcess LoanProcess LoanProcess


Unit 5. Security

5-3

Student Exercises

Group

Members

Object stores P8ConfigObjectStore LoanProcess

P8admins

P8admin

LoanProcessQA Sales SalesQA

P8users

5-4

CaseAdmins CaseWorkers CaseInitiators Accounting Agent Approver BPM Administrator BPM Designer BPM User Clerks Components Coordinators Customers Finance Admins Finance Clerks Finance Managers Finance Reviewers Legal Loan Business Analysts Loan Business Users Loan Guests Loan Managers Loan Officers Loan Operations Loan Processors Loan System Admins Loan Underwriters Managers Operations ProductDev QualityAssurance Reviewer Supervisor SysAdmins joe loanGuest p8guest


Sales SalesQA




EXNoSideHead Group

Members P8admin PEadmin Pamela Paul Queenie Quincy Mark Sue P8admin CEadmin Scott Steve AEadmin PEadmin

PEadmins ProductDev QualityAssurance Reviewer Supervisor

Sysadmins

Object stores LoanProcess


Unit 5. Security

5-5

Student Exercises

5-6





Lesson EXNoSideHead

5.1. Security Concepts

Overview Why is this lesson important? You are going to implement and maintain the security on your IBM FileNet P8 business solution. You need to be familiar with the basic security concepts.

Activities • Resolve Logon Failure, on page 5-9 • Verify object store access: Practice, on page 5-15

User accounts Type Operating system P8 Domain

User ID Administrator p8admin

Password passw0rd IBMFileNetP8


Before you begin Ensure that your student system is started. If it is not started, run StartServer.bat from the WebSphere Admin folder on your desktop and then wait for the startup sequence to complete before you continue.


Unit 5. Security

5-7

Student Exercises

5-8





Resolve EXNoSideHead

Logon Failure

Introduction In this exercise, you simulate a problem with the authentication provider and then observe the results.

Procedures Procedure 1, "Stop the authentication provider," on page 5-9 Procedure 2, "Observe logon failure," on page 5-9 Procedure 3, "Observe object store access," on page 5-10 Procedure 4, "Create a user," on page 5-11 Procedure 5, "Log on to IBM Content Navigator as outsider," on page 5-12 Procedure 6, "Log on to Workplace XT as outsider," on page 5-12

Procedure 1: Stop the authentication provider You stop the service that provides authentication information to the web application server and then observe the effects on the users who attempt to log on. 1. On the desktop of your student system, click Start > Services. 2. Select IBM Tivoli Directory Server Instance V6.3 - dsrdbm01

3. Stop the service.

Procedure 2: Observe logon failure Carol, a user, complains that she cannot log onto the system. You need to determine the reason. Assume that you have already eliminated the possibility that her account information is wrong. 1. Use Firefox to log on to IBM Content Navigator as carol: - http://ecmedu01:9080/navigator - User name: carol - Password: filenet 2. Verify that you get an error with the logon that indicates the wrong username or password was used. 3. Verify that the Content Platform Engine is running by going to the CE Ping Page.


Unit 5. Security

5-9

Student Exercises

- http://ecmedu01:9080/FileNet/Engine Note The ping page is up. You have verified that the Content Platform Engine is running. You can check the log files to find out what happened.

4. Copy the location of the log files from the CE Ping page. 5. Using Windows Explorer, open the p8_server_error.log file from this location: - C:\Program Files\IBM\WebSphere\AppServer\profiles\AppSrv01\FileNet\server1 6. Search the log files for any errors that relate to connectivity to the LDAP provider. 7. Use Windows Services console to restart IBM Tivoli Directory Server Instance V6.3 - dsrdbm01.

Procedure 3: Observe object store access Object stores are usually secured by using group memberships. Users who have access to object stores can log on and use the object stores. In addition, when a user logs on to IBM Content Navigator, the desktop must have the object store configured as a repository for that desktop. 1. Log on to IBM Content Navigator as carol: - http://ecmedu01:9080/navigator - User name: carol - Password: filenet 2. Verify that you can see the following object stores in the repository menu: - LoanProcess - Sales - LoanProcessQA - SalesSBx - Marketing (if you completed the unit Build the Object Store) 3. Attempt to open each of the object stores from the object stores menu. 4. Verify that carol is denied access to LoanProcess, but is able to view LoanProcessQA, Sales, and SalesSBx. 5. Log out of IBM Content Navigator. 6. Use Firefox to log on to Workplace XT as carol. - URL: http://ecmedu01:9080/WorkplaceXT - User name: carol - Password: filenet 7. Verify that you can see the following object stores in the Workplace XT navigation panel: 5-10 System Implementation and Administration




EXNoSideHead - LoanProcessQA - P8ConfigObjectStoreLog out - Sales - SalesQA - SalesSBx - Marketing (if you completed the unit Build the Object Store) 8. Log out of Workplace XT. Information You can see more object stores in Workplace XT than in IBM Content Navigator because, in addition to having authorization to use the object store, the object store must be defined as a repository for your IBM Content Navigator desktop.

Procedure 4: Create a user A user must have permission on at least one object store in order to log on to an IBM FileNet Content Manager client. However, if an object store is configured so that #AUTHENTICATED USERS have access, then anyone who can log into the domain can have access. You are going to create a user for testing system security. Use Internet Explorer for connecting to Tivoli Directory Service Web Administration Tool in order to ensure proper correct user interface presentation. 1. Use Internet Explorer to go to the Tivoli Directory Service Web Administration Tool. - http://localhost:9080/IDSWebApp/ - User DN: cn=root - Password: IBMFileNetP8 2. In the navigation pane, expand Directory Management > Manage entries. 3. In the details area, expand o=sample by clicking the plus (+) sign.

4. Expand cn=users. 5. Click Add to add a new user.


Unit 5. Security

5-11

Student Exercises

6. In the Select object class window, do the following steps: a. Select inetOrgPerson from the Structural object class menu. b. Click Next. Note You use inetOrgPerson to match the other entries in LDAP.

7. On the Select auxiliary object classes page, click Next. 8. On the Required Attributes page, enter the following information, an then click Next: - Relative DN: cn=outsider - Parent DN: cn=users,o=sample - cn: outsider - sn: outsider 9. On the Optional Attributes page, do the following steps: a. Scroll down to the bottom of the page. b. Enter a value for userPassword: filenet c. Click Finish. d. Click No to add a similar entry. 10. Close Internet Explorer.

Procedure 5: Log on to IBM Content Navigator as outsider 1. Attempt to log on to IBM Content Navigator as outsider: - http://ecmedu01:9080/navigator - User name: outsider - Password: filenet 2. Verify that you cannot log on. Information Outsider does not have access to the object stores defined for the default user desktop. A user must have access to at least one object store in order to log on. In some cases, an authorization problem might appear to be an authentication problem.

Procedure 6: Log on to Workplace XT as outsider 1. Log on to Workplace XT as outsider. 5-12 System Implementation and Administration




EXNoSideHead - http://ecmedu01:9080/WorkplaceXT - User name: outsider - Password: filenet 2. Verify that you can log on. Outsider has access to two object stores: P8ConfigObjectStore and SalesSBx. 3. Log out of Workplace XT. 4. Close the browser. Information The P8ConfigObjectStore and SalesSBx object stores were configured to allow all authenticated users to access them. Therefore, anyone who can log in with the authentication provider can also access these object stores. Ensure that security issues are resolved before moving any solution into production. Remember that if someone cannot log onto IBM Content Navigator, it is not always an authentication problem.


Unit 5. Security

5-13

Student Exercises





Verify EXNoSideHead

object store access: Practice

Introduction In this exercise, you log onto Workplace XT as different users to see the effects that group membership has on object store visibility.

Challenge Log onto Workplace XT as various users. Note any differences in object store visibility.

Data • Use the users and groups list Table on page 5-1for user names to test. • All passwords (except for administrators) are filenet.

Hint Try using users from groups that have access to different object stores. Try using groups that do not have access to any object stores.

Verification Verify that the LoanProcess, LoanProcessQA, Sales, SalesQA object stores are not visible to all users.

Summary In this lesson, you did the following tasks: • Resolved logon failure from stopped authentication system. • Observed logon failure from failed object store authorization. • Observed object store security.


Unit 5. Security

5-15

Student Exercises





Lesson EXNoSideHead

5.2. Modify Direct Security

Overview Why is this lesson important? Users with sufficient authorization can change the direct security on documents. This is particularly true with the owner of the document. You are going to change security of a document.

Activities • Change direct security of a document: Activity, on page 5-19 • Customize access: Activity, on page 5-25

User accounts Type Operating system P8 Domain Finance clerk Finance clerk

User ID Administrator p8admin Carol Charles

Password passw0rd IBMFileNetP8 filenet filenet



Unit 5. Security

5-17

Student Exercises





Change EXNoSideHead

direct security of a document: Activity

Introduction In this exercise, you create a document as one user in order to observe default instance security. You then modify the security directly and observe the results.

Procedures Procedure 1, "Add a folder and document," on page 5-19 Procedure 2, "Verify access," on page 5-20 Procedure 3, "Remove group access to a document," on page 5-20 Procedure 4, "Verify that access is removed," on page 5-21 Procedure 5, "Change access level," on page 5-21 Procedure 6, "Remove ownership," on page 5-22 Procedure 7, "Change ownership," on page 5-23 Procedure 8, "Verify the change in ownership," on page 5-24

Procedure 1: Add a folder and document You create a document and then change security on it. 1. Log on to IBM Content Navigator as carol: - http://ecmedu01:9080/navigator - User name: carol - Password: filenet 2. Open the LoanProcessQA object store. 3. Create a folder: a. Click New Folder. b. Name the folder Loandocs. 4. Open the Loandocs folder. 5. Create a document: a. Click Add Document. b. For the document content, select any file from C:\LabFiles\SampleDocuments. c. Click Add. 6. Log out of IBM Content Navigator.


Unit 5. Security

5-19

Student Exercises

Procedure 2: Verify access 1. Log on to IBM Content Navigator as charles. - User name: charles - Password: filenet 2. Open the LoanProcessQA object store. 3. Open the Loandocs folder. 4. Verify that you can see and open the document. 5. Log out of IBM Content Navigator.

Procedure 3: Remove group access to a document 1. Log on to IBM Content Navigator as carol. - User name: carol - Password: filenet 2. Open the LoanProcessQA object store. 3. Open the Loandocs folder. 4. Open the properties of the document. 5. Open the Security tab. 6. Verify the following settings: Access group

Owners

Readers

Members AEAdmins CEAdmins Finance Admins P8Admin P8Admins carol Clerks Finance Clerks Finance Managers Finance Reviewers





7. Remove the permission for Finance Clerks to read the document. EXNoSideHead a. Click the X on the Finance Clerks group.

b. Click Save. 8. Log out of IBM Content Navigator.

Procedure 4: Verify that access is removed Carol has removed access to the document to Finance Clerks. Other Finance clerks, such as Charles, should no longer see the document. However, Carol still has access. You are going to verify these statements. 1. Log on to IBM Content Navigator as Charles. - User name: charles - Password: filenet 2. Go to LoanProcessQA > Loandocs. 3. Verify that the folder is empty. 4. Log out of IBM Content Navigator.

Procedure 5: Change access level Finance Managers should be authors of the document. As an owner, Carol can change access levels. 1. Log on to IBM Content Navigator as Carol. - User name: carol - Password: filenet 2. Go to LoanProcessQA > Loandocs. 3. Open the document Properties page. 4. Open the Security tab. © Copyright IBM Corp. 2013, 2015 Course materials may not be reproduced in whole or in part without the prior written permission of IBM.

Unit 5. Security

5-21

Student Exercises

5. Click Finance Managers. 6. Select Author from the Permissions menu.

7. Click OK. 8. Verify that Finance Managers are now in the Authors group.

9. Click Save.

Procedure 6: Remove ownership Carol has removed Finance Clerks from the document Readers. Other Finance Clerks can no longer access the document. However, Carol can still access the document. Carol will now remove herself from the document owners. You are logged on to IBM Content Navigator as Carol. You are in the Loandocs folder of the LoanProcessQA object store. 1. Open the Security tab for the document. 2. Remove carol from the Owners group. 3. Click Save. Note that you can still see the file. 4. Log out of IBM Content Navigator. Note You might think that Carol’s continued access to the file is caused by browser caching or some other glitch. It is not, but you can test this hypothesis if you want.






7: Change ownership

Both Finance Clerks and Carol have been removed from the document’s ACL. However, Carol can still see it. To find out why she can still see it, you must use Administration Console for Content Platform Engine to investigate. 1. Use Firefox to log on to Administration Console for Content Platform Engine: - URL: http://emcedu01:9080/acce - User name: p8admin - Password: IBMFileNetP8 2. Go to LoanProcessQA > Browse > Root Folder > Loandocs. 3. Open the document properties. 4. Open the Security tab. 5. Verify that Carol is still the owner. a. Scroll down the page to the Owner/Active Markings area. b. Confirm that the Owner is CN=carol, cn=users,o=sample.

6. Change the owner to Charles: a. Click Change Owner. b. Select the Change Owner to option. c. Click Find. d. Search for Charles. e. Select Charles and click the right-facing arrow. f.

Click OK.

g. Verify that Charles is now the owner.

7. Click Save. 8. Log out from Administration Console for Content Platform Engine.


Unit 5. Security

5-23

Student Exercises

Information The Owner of a document is not the same thing as a member of the Owner role in the ACL. The Owner of an object has implicit READ, WRITE_OWNER and WRITE_ACL privileges no matter what is in the object's ACL. These implicit rights can be lost by marking sets.

Procedure 8: Verify the change in ownership 1. Verify that Charles can see the document: a. Log on to IBM Content Navigator as Charles. b. Go to LoanProcessQA > Loandocs. c. Verify that you can see the document. 2. Verify that Carol cannot see the document: a. Log on to IBM Content Navigator as Carol. b. Go to LoanProcessQA > Loandocs. c. Verify that you cannot see the document. 3. Log out of IBM Content Navigator.





Customize EXNoSideHead

access: Activity

Introduction In IBM Content Navigator, you can specify security on a document or folder using predefined security roles, including: • • • •

Owner Author Reader No access

Each of these groups has a predefined set of access rights. In Administration Console for Content Platform Engine, you can specify security using predefined Permission Groups. These groups are similar to, but not identical with the roles in IBM Content Navigator. The groups include: • • • • • • • • •

Full Control Minor versioning major versioning Modify properties View content View properties Publish Create subfolder Custom

In this exercise, you are going to see how to use Permission Groups for common security scenarios, and specify custom permissions for fine-grained security configurations.

Procedures • Procedure 1, "Add typical document permissions," on page 5-25 • Procedure 2, "Edit security settings," on page 5-27

Procedure 1: Add typical document permissions You create a document and then modify permissions for different security principals using the predefined Permission Groups. 1. Log on to Administration Console for Content Platform Engine as p8admin. - URL: http://emcedu01:9080/acce - User name: p8admin - Password: IBMFileNetP8 2. Open the SalesSBx object store. 3. Go to Browse > Root Folder.


Unit 5. Security

5-25

Student Exercises

4. Use the Actions menu to create a folder named Access Test. 5. Add a document to this folder, using one of the files in C:\LabFiles\SampleDocuments as a content element. a. Click Actions > New Document.

b. Name the document anything that you want. c. Click Add to add a content element. d. Browse to select a document from C:\LabFiles\SampleDocuments. e. Select default values to complete the wizard. f.

Open the properties of the document.

6. On the document properties page, open the Security tab. 7. Add Major Versioning permission to Coordinators. a. Click Add. b. Search for Coordinators. c. Add Coordinators to Selected Users and groups.





EXNoSideHead d. Select Major Versioning from the Permission group menu.

Troubleshooting If all the rights do not show, logout and log back in to retry.

e. Verify that the following individual permissions are selected: • View all properties • View content • Change state • Major versioning • Read permissions • Modify all properties • Link a document/Annotate • Create instance • Minor versioning • Unlink document f.

Click OK.

8. Click Save.

Procedure 2: Edit security settings The Major Versioning Permission group has permissions that are not quite what you need. You do not want coordinators to be able to unlink a document. You can specify security more precisely by


Unit 5. Security

5-27

Student Exercises

setting custom permissions. You are logged on to Administration Console for Content Platform Engine as p8admin. You are viewing document properties. 1. Select the Coordinators row. 2. Click Edit.

3. Clear the Unlink document permission. 4. Click OK. 5. Click Save. 6. Verify that the Permission group for Coordinators is now Custom. 7. Log out from Administration Console for Content Platform Engine.

Summary In this lesson, you completed the following tasks: • Modified direct security on a document. • Changed the owner of a document. • Customized user permissions on a document. • Observed the effects of implicit denial.





Lesson EXNoSideHead

5.3. Configure object store security

Overview Why is this lesson important? Your IBM FileNet P8 solution design identifies specific security requirements for the object store used in the business solution. As the solution builder you must implement these security requirements. Document security begins with object store security. Correctly configured object store security can make the difference between a security schema that is effective and flexible and one that must be constantly worked around.

Activities • Configure Initial Object Store Security: Exercise, on page 5-31 • Add groups to an object store using a supergroup: Procedure, on page 5-37 • Use the Security Script wizard: Procedure, on page 5-43 • Configure Finance for Content Navigator: Exercise, on page 5-45

User accounts Type Operating system P8 Domain Legal user unauthorized authenticated user Finance Admin Finance Admin

User ID Administrator p8admin Larry

Password passw0rd IBMFileNetP8 filenet

outsider

filenet

Adam Allison

filenet filenet

Note Passwords are always case-sensitive. ddd


Unit 5. Security

5-29

Student Exercises






Initial Object Store Security: Exercise

Introduction In this exercise, you create an object store. You specify security on the object store so that all P8 users (but not all authenticated users) can see it. The procedure for creating an object store is covered in the unit: Build an Object Store. Important You must complete this exercise to continue the lesson exercises.

Scenario The Finance department needs an object store for its operations. All P8 users must have default access to the object store. You can further configure security on objects within the object store at a later time.

Challenge • Create an object store for Finance. • Provide basic user access to the P8users group.

Reference Review the procedure for creating an object store: "Create an Object Store: Activity" on page 2-14

Object Store Data Use this data in the object store creation wizard. Page Name the Object Store

Property Display name Database Connection Schema name

Define the Database

Select the Type of Storage Area Storage area type for Content Grant Administrative Access Administrative users Grant Basic Access Basic access users Select Add-ons

Add-ons

Value Finance FNOSDS Finance Database P8admins (remove P8Admin) P8users Workplace/Workplace XT Configuration


Unit 5. Security

5-31

Student Exercises

Important For Add-ons, click the Workplace/Workplace XT Configuration button above the table.

Test user data Use the following users for testing object store security. • Larry (from the Legal department) • Outsider (see "Create a user" on page 5-11) • Passwords are both filenet.

Verification • Object store creation success message. • Use Workplace XT to test object store security. • Larry can access the object store. • Outsider cannot see the object store.





Modify EXNoSideHead

Root Folder Security: Procedure

Introduction The initial security on the object store allows P8users to use the object store. However, you do not want everyone to be able to add folders at the root level. This permission must be given only to Finance Administrators.

Scenario You have created an object store. The object store currently allows all P8 users default permission (Use object store). Any users can currently add documents and folders to the Root folder. In order to reserve the right to organize the top folders for P8admins, you must remove this access. You must also create the folders in which Finance users can create subfolders.

Procedures Procedure 1, "Edit Root Folder security," on page 5-33 Procedure 2, "Add a folder for Finance group," on page 5-34

Procedure 1: Edit Root Folder security Restrict general Root Folder permissions but give special permissions to the Finance Admins group. 1. Use Firefox to log on to Administration Console for Content Platform Engine: - URL: http://emcedu01:9080/acce - User name: p8admin - Password: IBMFileNetP8 2. Open the Finance object store. 3. Expand the Browse node. 4. Open the properties page for the Root Folder. 5. Open the Security tab for Root Folder. 6. Edit the P8Users access control entry: a. Select the P8users entry.


Unit 5. Security

5-33

Student Exercises

b. Click Edit.

c. In the Permission group menu, select View Properties. d. Click OK. 7. Provide Finance Admins with Root Folder access: a. Click Add. b. Search for Finance Admins. c. Add Finance Admins group to the Selected Users and Groups. d. Select This Object Only from the Apply To field. e. Specify the following custom permissions: • View all properties. • Create subfolder. • Read Permissions. f.

Click OK.

8. Click Save to save the changes on the Root Folder. 9. Log out of Administration Console for Content Platform Engine. Information Finance Admins are now allowed to add subfolders to the Root Folder. Finance Admins can then specify security on the folders that they create.

Procedure 2: Add a folder for Finance group Users in the various Finance groups need to be able to add folders and documents, but they can only be allowed to do this in designated subfolders. The P8 administrator has given the Finance Admin group permission to add subfolders to the Root Folder. You log on as a Finance Admin to add a folder and observe the permissions. 1. Use Firefox to log on to Workplace XT as Adam. - URL: http://ecmedu01:9080/WorkplaceXT - User name: adam - Password: filenet 5-34 System Implementation and Administration




2. Open the Finance object store. EXNoSideHead 3. Create a subfolder named Invoices. 4. Add Finance groups to the folder permissions: a. Select the Invoices folder. b. Right-click the Invoices folder. c. Select More information > Security. d. Click Add New. e. Search for Finance groups. f.

Select all Finance groups by holding the shift key and selecting the first and last group.

g. Click Accept. 5. Edit the permissions for each group: a. Click Finance Admins. b. Select the Allow option in the Owner Control row. c. Click Accept. d. Use this data to configure permissions for the remaining Finance groups: Group Finance Admins Finance Clerks Finance Managers Finance Reviewers

Access Level Owner Control Create subfolder Create Subfolder File in folder File in Folder

e. Verify that the completed folder ACL looks like this:

f.

Click OK.

6. Log out of Workplace XT.


Unit 5. Security

5-35

Student Exercises





Add EXNoSideHead

groups to an object store using a supergroup: Procedure

Introduction After you create an object store, you might have to add group access to new groups that did not exist when you first created the object store. When the object store is created, specified groups have access because they are added when the object store is instantiated. You cannot add new groups to the object store security because too many instantiated objects would need to be updated. You can add groups to an existing object store in either of two ways: • Using supergroups. • Using the security script wizard. In this lesson, you are going to practice both methods.

Procedures Procedure 1, "Preparation: Create users and groups," on page 5-37 Procedure 2, "Create test groups," on page 5-38 Procedure 3, "Test the accounts," on page 5-39 Procedure 4, "Edit the user token TTL," on page 5-40 Procedure 5, "Add the grouptest group to P8Users group," on page 5-40 Procedure 6, "Retest grouptester," on page 5-41

Procedure 1: Preparation: Create users and groups You are going to test security using new groups and users. You must create these groups and users for this lesson exercise. 1. Use Internet Explorer to go to the Tivoli Directory Service Web Administration Tool. - http://localhost:9080/IDSWebApp/ - User DN: cn=root - Password: IBMFileNetP8 2. In the navigation pane, expand Directory Management > Manage entries. 3. In the details area, expand o=sample by clicking the plus (+) sign. 4. Expand cn=users. 5. To create the user grouptester, click Add. a. In the Structural object classes menu, select inetOrgPerson . b. Click Next. 6. On the Select auxiliary object classes page click Next. © Copyright IBM Corp. 2013, 2015 Course materials may not be reproduced in whole or in part without the prior written permission of IBM.

Unit 5. Security

5-37

Student Exercises

7. On the Required Attributes page, enter the following information, an then click Next: - Relative DN: cn=grouptester - Parent DN: cn=users,o=sample - cn: grouptester c. sn: grouptester 8. On the Optional Attributes page, do the following steps: a. Scroll down to the bottom of the page. b. Enter a value for userPassword: filenet c. Click Finish. d. Click Yes to add a similar entry. 9. Create the user Scriptester: a. In the Structural object classes menu, select inetOrgPerson. b. Click Next. 10. On the Select auxiliary object classes page Click Next. 11. On the Required Attributes page, enter the following information, an then click Next: - Relative DN: cn=scriptester - Parent DN: cn=users,o=sample - cn: scriptester - sn: scriptester 12. On the Optional Attributes page, do the following steps: a. Scroll down to the bottom of the page. b. Enter a value for userPassword: filenet c. Click Finish. d. Click No to add a similar entry.

Procedure 2: Create test groups You have created the grouptester and scriptester users. Now you are going to create their groups. You are currently logged into Tivoli Directory Services, viewing cn=users. 1. Click o=sample to go up one level in the LDAP directory.

2. Expand cn=groups. 3. Click Add to add a new group.





4. Select Object Class: EXNoSideHead a. Select groupOfUniqueNames in the Structural object classes menu. b. Click Next. 5. Click Next on the Select Auxiliary object classes page. 6. On the Required Attributes page, enter the following information, then click Next: - Relative DN: cn=grouptest - Parent DN: cn=groups,o=sample - cn: grouptest - Unique Member: cn=grouptester,cn=users,o=sample 7. Click Finish. 8. Click Yes to add another group. 9. Click Next on the Select Object Class page (groupOfUniqueNames is selected) 10. Click Next on the Select Auxiliary Object Classes page. 11. On the Required Attributes page, enter the following information, then click Next: - Relative DN: cn=scriptest - Parent DN: cn=groups,o=sample - cn: scriptest - Unique Member: cn=scriptester,cn=users,o=sample 12. Click Finish. 13. Click No to add another group. 14. Close Internet Explorer.

Procedure 3: Test the accounts The users that you recently created are authenticated users now, but they are not members of the P8Users group. You are going to log on to Workplace XT to test the user access before proceeding. 1. Clear the Firefox browser cache. 2. Use Firefox to log on to Workplace XT as grouptester. - URL: http://ecmedu01:9080/WorkplaceXT - User name: grouptester - Password: filenet 3. Verify that you can see only the P8ConfigObjectStore and SalesSBX object stores. 4. Log out from Workplace XT. 5. Log on to Workplace XT as scriptester. The password is filenet. 6. Verify that you can see only the P8ConfigObjectStore and SalesSBX object stores.


Unit 5. Security

5-39

Student Exercises

7. Log out from Workplace XT. 8. Close the browser.

Procedure 4: Edit the user token TTL The Server Cache Subsystem caches user token information on the Content Platform Engine server in order to reduce traffic between the Content Platform Engine server and the authentication provider. The User Token Cache Entry TTL (time to live) value is set to 3600 seconds by default. This means that a user token is stored in cache for six minutes, so any changes that you make to users on the authentication provider take six minutes to be updated on the Content Platform Engine. To shorten this time, you can edit the User Token Cache Entry TTL value. 1. Use Firefox to log on to Administration Console for Content Platform Engine: - URL: http://ecmedu01:9080/acce - User name: p8admin - Password: IBMFileNetP8 2. On the P8Domain object, open the Server Cache Subsystem tab. 3. Scroll down to the User Token Cache area. 4. Change the value of the Entry TTL field to 36 seconds. 5. Click Save to save your changes to the P8Domain. 6. Log out of Administration Console for Content Platform Engine. 7. Close Firefox.

Procedure 5: Add the grouptest group to P8Users group Several object stores are configured with the P8Users supergroup. By adding a new group to the supergroup, you can instantly provide them default access to these object stores. 1. Use Internet Explorer to go to the Tivoli Directory Service Web Administration Tool. - http://localhost:9080/IDSWebApp/ - User DN: cn=root - Password: IBMFileNetP8 2. In the navigation pane, expand Directory Management > Manage entries. 3. In the details area, expand o=sample by clicking the plus (+) sign. 4. Expand cn=groups. 5. Open the P8Users group on Page 2 of the display.





6. Add the grouptest group: EXNoSideHead a. Click Multiple Values next to the uniqueMember field.

b. In the uniqueMember field, type: cn=grouptest,cn=groups,o=sample c. Click Add. d. Click OK at the bottom of the page. e. Click Next on the Edit an entry page. f.

Click Finish.

7. Close Internet Explorer.

Procedure 6: Retest grouptester 1. Clear the Firefox browser cache. 2. Use Firefox to log on to Workplace XT as grouptester. - URL: http://ecmedu01:9080/WorkplaceXT - User name: grouptester - Password: filenet 3. Verify that you can see the following object stores: - Finance - P8ConfigObjectStore - Sales - SalesQA - SalesSBx Troubleshooting If you cannot see these object stores, check the following: - The User Token Cache Entry TTL period has been shortened to 36 seconds. If not, then you can wait a few minutes and try again. - The user, grouptester, must be a member of the grouptest group. - The group, grouptest, must be a member of the P8Users group.


Unit 5. Security

5-41

Student Exercises





Use EXNoSideHead

the Security Script wizard: Procedure

Introduction If you need to add a group of users to an object store, and you do not have an established group to add them to, then you can use the Security Script Wizard. The Security Script wizard allows you to assign security roles to user and group accounts in order to create security principals for the objects in an object store. You must run the Security Script Wizard on each object store to which you are adding the accounts. Security Script Wizard is currently available only in FileNet Enterprise Manager. Important Be cautious about running the SecurityUpdate script. This script updates an object store's set of administrator groups and regular users. It makes wholesale changes to the Default Instance Permissions settings of many class definitions and also changes the security permissions of all folders. After running it you must remake your Default Instance Permissions changes and possibly redo the security for your folders.

Procedures Procedure 1, "Run the Security Script Wizard," on page 5-43 Procedure 2, "Test object store access," on page 5-44

Procedure 1: Run the Security Script Wizard 1. Start FileNet Enterprise Manager and connect to the P8Domain. a. Double-click the FileNet Enterprise Manager desktop icon. b. Click Connect. 2. Expand the Object Stores node. 3. Select the Finance object store. 4. Right-click Finance and then click All Tasks > Run Security Script Wizard. 5. On the Welcome page, click Next. 6. Select security script information file: a. Browse to and select C:\Program Files\IBM\FileNet\ContentEngine\Scripts\Component Library\OSecurityUpdate.xml b. Click Next.


Unit 5. Security

5-43

Student Exercises

7. Define Security Roles: a. Add Object Store Users b. Click Add. c. Search for scriptest. d. Select the scriptest group (do not select the user, scriptester). e. Click OK. f.

Click Finish.

8. Click OK to close the Notice. 9. Click OK to acknowledge log file location. 10. Wait for the Security Script Wizard to complete. 11. Click OK to close the completion notice.

12. Close FileNet Enterprise Manager.

Procedure 2: Test object store access You ran the Security Script Wizard to provide default object store access to the scriptest group. You are now going to log on to Workplace XT to verify that the security change was successful. 1. Log on to Workplace XT as scriptester. - URL: http://ecmedu01:9080/WorkplaceXT - User name: scriptester - Password: filenet 2. Verify that you can see the Finance object store. 3. Verify that you can open the Finance Object Store. 4. Log out from Workplace XT. 5. Close the browser.






Finance for Content Navigator: Exercise

Introduction Although this issue is not specifically related to security, the new object store cannot currently be seen by IBM Content Navigator users. You must configure the Finance object store as a repository so that IBM Content Navigator users can access it. The procedure to configure a repository is in the unit: Configure IBM Content Navigator. You must complete this exercise to continue the lesson exercises.

Challenge • Use the IBM Content Navigator Configuration feature to add the Finance object store as a FileNet Content Manager repository. • Add the new repository to the Sample Desktop.

Repository Data Property Display name ID Protocol Server URL Object store symbolic name Object store display name

Value Finance Finance EJB iiop://ecmedu01:2809/FileNet/Engine Finance Finance

Verification • Log on to IBM Content Navigator as May (password: filenet). • Verify that you can see the Finance object store as a repository.

Summary In this lesson, you did the following tasks: • Configured initial security on a new object store. • Configured the security on the Root Folder of an object store. • Provided access to an existing object store by adding a group to an established group. • Provided access to an existing object store by using the Security Script Wizard.


Unit 5. Security

5-45

Student Exercises





Lesson EXNoSideHead

5.4. Configure Class and Property Security

Overview Why is this lesson important? Your business solution requires specific group access to certain document classes. You must configure default instance security on those document classes. A document class has a custom property that you want to make modifiable only by people who have permission to delete the object.

Activities • Configure Default Instance Security: Activity, on page 5-49 • Configure property modification access, on page 5-53

User accounts Type Operating system P8 Domain Finance Clerk

User ID Administrator p8admin Carol




Unit 5. Security

5-47

Student Exercises






Default Instance Security: Activity

Introduction In this activity, you configure default instance security on a document class. Whenever an instance of that class is created, its security is determined by the default instance security.

Procedures Procedure 1, "Set default instance security on a new document class," on page 5-49 Procedure 2, "Verify default instance security," on page 5-50

Procedure 1: Set default instance security on a new document class Create a document class that includes one custom property. The procedures for creating classes and properties are covered in the unit: Build an Object Store. You need for Finance Managers to have ownership and Finance Clerks to have Modify Properties permission. You also want the creator of the document to be unauthorized to delete the document after it is created. 1. Use Firefox to log on to Administration Console for Content Platform Engine: - URL: http://emcedu01:9080/acce - User name: p8admin - Password: IBMFileNetP8 2. Create the Invoice number property template: a. Go to Finance > Data Design > Property Templates. b. Select the Property Templates folder. c. Click New to create a property template with the following characteristics. Page Name and Describe the Property Template Select the Data Type Single or Multi-value

Field

Value

Display name

InvoiceNumber

Data type Single or multi-value

String Single

3. Create the Invoice document class: a. Go to Finance > Data Design > Classes > Document. b. Select the Document class. c. Click Actions > New Class to create a document subclass named Invoice. 4. Add the InvoiceNumber property to the Invoice document class. a. Click Open to edit the class. b. Open the Property Definitions tab. © Copyright IBM Corp. 2013, 2015 Course materials may not be reproduced in whole or in part without the prior written permission of IBM.

Unit 5. Security

5-49

Student Exercises

c. Add the InvoiceNumber property. d. Save the change to the Invoice document class. 5. Remove default instance security on the class: a. Open the Default Instance Security tab. b. Select P8Users c. Select scriptest d. Click Remove. 6. Add the following principals with these Permission groups: Group Finance Managers Finance Clerks

Permission level Full Control Modify properties

7. Change the permission level of #CREATOR-OWNER to Major versioning. 8. Verify your default instance security settings:

9. Click Save to save the Invoice class properties. 10. Log out of Administration Client for Content Platform Engine. 11. Clear the browser cache.

Procedure 2: Verify default instance security In this procedure, you create an Invoice document and verify the security settings. 1. Log on to IBM Content Navigator as Carol. - URL: http://ecmedu01:9080/Navigator - User name: Carol - Password: filenet 2. Go to Finance > Invoices. 3. Add a new subfolder to Invoices. Name the folder Carol.





EXNoSideHead

Note

Finance Clerks do not have permission to file documents directly into the Invoices folder, but they can add subfolders.

4. Add a document to the Carol folder: Property File Class Document Title InvoiceNumber

Value Any file from C:\LabFiles\SampleDocuments Invoice Invoice 1 1

5. Open the Security Information page for the new Invoice. Verify the following settings:

6. Click Cancel. 7. Log out of IBM Content Navigator. 8. Close the browser.


Unit 5. Security

5-51

Student Exercises






property modification access

Introduction Finance clerks can currently edit the value of the InvoiceNumber property of any Invoice that they create. You want only users who have Full Access to the Invoice documents to be able to change this property. You can customize property modification access to change this. Information Property modification access behavior is a feature primarily intended for the IBM Enterprise Records application, especially in connection with markings. It is available for use by non-records management applications that need granular control over user ability to modify properties.

Procedures Procedure 1, "Set property modification access," on page 5-53 Procedure 2, "Verify property modification restriction," on page 5-53

Procedure 1: Set property modification access 1. Use Firefox to log on to Administration Console for Content Platform Engine: - URL: http://emcedu01:9080/acce - User name: p8admin - Password: IBMFileNetP8 2. Go to Object Stores > Finance > Data Design > Classes > Document > Invoice. 3. Open the Property Definitions tab. 4. Click InvoiceNumber. 5. On the Property Definition page, open the Modification Access tab. 6. Select the Delete option. 7. Click OK. 8. Click Save on the Invoice class definition page. 9. Log out from Administration Console for Content Platform Engine. 10. Clear the browser cache.

Procedure 2: Verify property modification restriction 1. Log on to IBM Content Navigator as Carol. - URL: http://ecmedu01:9080/navigator © Copyright IBM Corp. 2013, 2015 Course materials may not be reproduced in whole or in part without the prior written permission of IBM.

Unit 5. Security

5-53

Student Exercises

- User name: Carol - Password: filenet 2. Go to Finance > Invoices > Carol. 3. Open the Properties page for the Invoice document that you added. 4. Verify that you cannot edit the value of the InvoiceNumber property, even though you can edit the Document Title.

5. Click Cancel. 6. Log out from IBM Content Navigator. 7. Close the browser. Note You changed the InvoiceNumber property definition on the Invoice document class, but you did not change the InvoiceNumber property template. If you create a new class and you use this property template, the property will have normal modification access.

Summary In this lesson, you did the following tasks: • Configured default instance security on a document class. • Configured property modification access on a custom property.





Lesson EXNoSideHead

5.5. Configure Security Inheritance

Overview Why is this lesson important? The design for your business solution calls for some documents to have their security determined by the security of a folder or another object. As the solution builder, you must use security inheritance features to implement this functionality.

Activities • Configure folder inheritance: Procedure, on page 5-57 • Configure a security parent using a custom OVP: Procedure, on page 5-61

User accounts Type Operating system P8 Domain Finance Admin

User ID Administrator p8admin Adam


Note Passwords are always case-sensitive. ddd


Unit 5. Security

5-55

Student Exercises






folder inheritance: Procedure

Introduction In this exercise, you create a folder and use folder inheritance to secure documents.

Procedures Procedure 1, "Preparation: Create a document class," on page 5-57 Procedure 2, "Create a parent folder," on page 5-58 Procedure 3, "Create a receipt," on page 5-58 Procedure 4, "Configure the document to inherit security," on page 5-58 Procedure 5, "Verify security change," on page 5-59

Procedure 1: Preparation: Create a document class To have security completely controlled by inheritance, you must eliminate the default instance permissions. To set up the exercises for this lesson, you are going to create a document class that has no default instance permissions. 1. Use Firefox to log on to Administration Console for Content Platform Engine: - URL: http://emcedu01:9080/acce - User name: p8admin - Password: IBMFileNetP8 2. Create the Receipt document class: a. Go to Finance > Data Design > Classes > Document. b. Select the Document class. c. Click Actions > New Class to create a document subclass named Receipt. d. Open the document class definition page after you create the class. 3. Remove default instance security on the class: a. Open the Default Instance Security tab. b. Select all entries except P8Admins. c. Click Remove. d. Click Save. e. Close the Receipt tab.


Unit 5. Security

5-57

Student Exercises

Procedure 2: Create a parent folder Create the folder from which receipts inherit permissions. 1. Go to Finance > Browse > Root folder. 2. Click Actions > New Folder. 3. Name the folder: Receipts. 4. Accept default values to complete the wizard. 5. Add inheritable security settings: a. Click Add. b. Search for Finance groups. c. Add the Finance Admins and Finance Managers. d. From the Apply to menu, select All children, but not this object. e. From the Permission group menu, select Full Control. f.

Click OK.

6. Save the changes to the folder.

Procedure 3: Create a receipt 1. On the Receipts tab, click Actions > New Document. 2. Define the new document object: a. Name the new document Test receipt. b. Select the Receipt class. c. Click Next. 3. Add document content: a. Browse to and add any document from C:\LabFiles\SampleDocuments. b. Click Next. 4. Use default settings to complete the add document wizard. 5. Click Open to open the Test receipt properties page. 6. Open the Security tab. 7. Verify that the only ACE is P8Admins.

Procedure 4: Configure the document to inherit security 1. Open the General tab for the Test Receipt document. 2. Scroll down. 3. From the Inherit Security from folder, select Receipts. 4. Click Save.






5: Verify security change

1. Open the Security tab of the Test receipt. 2. Verify that Finance Admins and Finance Managers have inherited permissions.

3. Select one of the inherited ACEs. 4. Click Edit. 5. Verify that all of the permissions are selected.

6. Click Cancel. 7. Log out of Administration Console for Content Platform Engine.

Procedure 6: (Optional) Test security inheritance 1. Use Firefox to log on to IBM Content Navigator as Adam: - URL: http://ecmedu01:9080/navigator - User name: adam - Password: filenet 2. Go to Finance > Receipts. 3. Open the properties page for the Test Receipt document. 4. On the security tab. 5. Confirm the security settings: © Copyright IBM Corp. 2013, 2015 Course materials may not be reproduced in whole or in part without the prior written permission of IBM.

Unit 5. Security

5-59

Student Exercises

- Finance Manager, Finance Admins, and P8admins are all owners. 6. Delete the Test Receipt document. a. Select the document. b. Click Actions > Delete. 7. Log out of IBM Content Navigator.






a security parent using a custom OVP: Procedure

Introduction In this procedure, you create an object specifically to be a security parent. Documents that inherit security from this parent will be affected when you change security on the parent. You use a custom object-valued property (OVP) to designate a security parent. You can set this property’s default value on the class definition, so that all new documents of this class are created with the same default security parent.

Procedures Procedure 1, "Create a security parent folder," on page 5-61 Procedure 2, "Create a security parent," on page 5-62 Procedure 3, "Edit security of the security parent," on page 5-62 Procedure 4, "Create a custom object valued property template," on page 5-63 Procedure 5, "Create a document class," on page 5-63 Procedure 6, "Change default instance security," on page 5-64 Procedure 7, "Add the custom OVP to the document class," on page 5-64 Procedure 8, "Configure the default value for the custom OVP," on page 5-64 Procedure 9, "Create test document," on page 5-66 Procedure 10, "(Optional) Observe inherited security changes," on page 5-67

Procedure 1: Create a security parent folder Create a folder to keep track of security parents. 1. If you are not already logged on to Administration Console for Content Platform Engine, use Firefox to log on as p8admin. - URL: http://emcedu01:9080/acce - User name: p8admin - Password: IBMFileNetP8 2. Go to Finance > Root Folder. 3. Create a folder named Security Parents. 4. Open the folder.


Unit 5. Security

5-61

Student Exercises

Procedure 2: Create a security parent 1. In the Security Parents folder, create a contentless document: a. From the Security Parents folder, click Action > New Document. b. Name the document Accounts Payable Access. c. Clear the With Content option. d. Use default values to complete the wizard. 2. Open the Accounts Payable Access document. 3. Click Actions > Copy Object Reference. Information You are copying the object reference now, but you do not actually need to paste it until you edit the property definition for the document class that inherits security from this object. If for any reason your copy buffer gets erased before you edit the property definition, you must come back to this document to copy the object reference.

Procedure 3: Edit security of the security parent The security parent must have at least one inheritable ACE. You are viewing the Accounts Payable Access document properties page. 1. On the Accounts Payable Access document, open the Security tab. 2. Remove P8users, scriptest, and the P8admin entries. Do not remove the P8admins entry. 3. Save the changes to the document. 4. Add the following permissions. Principal Finance Admins Finance Managers Finance Reviewers Finance Clerks

Permission group Full Control Full Control View Content Major Versioning

Apply To All children, but not his object All children, but not his object All children, but not his object All children, but not his object

5. Verify that the ACL for the Accounts Payable Access document has the correct permissions:





EXNoSideHead

Troubleshooting

If the permissions are not what you expected after saving the document, try editing each ACE separately and saving between.

6. Save the changes to the document.

Procedure 4: Create a custom object valued property template The custom object valued property assigns the security parent to the document. You must create the property template before you can add it to the document class. You are signed into Administration Console for Content Platform Engine as p8admin. 1. Go to Finance > Data Design > Property Templates. 2. Click New to create a property template. 3. Complete the property template using the following values. Page Property Name and describe the property Display name template Select the data type Data type Single or Multi-value Single or Multi-value Set other attributes Additional property template Security Proxy Type attributes

Value Security parent OVP Object Single Selected Inherited

Information The Security Proxy Type value of Inherited appears as the integer 2 when viewed in the document’s property grid.

4. Use default values to complete the wizard. 5. Click Close.

Procedure 5: Create a document class The new document class must include the object valued property that you created. 1. Go to Finance > Data Design > Classes > Document. 2. Click Actions > New Class. 3. Name the class Accounts Payable. 4. Complete the document class wizard. 5. Click Open. © Copyright IBM Corp. 2013, 2015 Course materials may not be reproduced in whole or in part without the prior written permission of IBM.

Unit 5. Security

5-63

Student Exercises

Procedure 6: Change default instance security You want all of the security to be inherited from the security parent. Therefore, you are going to remove the default instance permissions. 1. Open the Default Instance Security tab. 2. Remove all of the ACEs except for P8admins. 3. Save the changes to the Accounts Payable class.

Procedure 7: Add the custom OVP to the document class You now add the custom OVP property to the Accounts Payable class. The Accounts Payable class definition is open. 1. Open the Property Definitions tab. 2. Click Add. 3. Select Security Parent OVP from the Add Properties menu. 4. Click OK. 5. Edit the property definition attributes: a. On the Property Definitions tab, click Security Parent OVP. b. In the Required Class field, select Document. c. Click OK. 6. Click Save to save the changes to the class definition. Information For the Required Class property, you must select the exact class of the parent object.

Procedure 8: Configure the default value for the custom OVP To save time when users add documents, you can configure the default value of Security Parent OVP property to point to the security parent. All new documents of this class automatically use the Accounts Payable Access document as a security parent by default. The Accounts Payble class definition is open. 1. Open the Properties tab.





2. Open the Property Definitions menu. EXNoSideHead

Hint Be patient: this menu sometimes takes a couple minutes to load. Click the arrow one time and wait. If you are prompted to continue running scripts or stop, select Continue.

Information The Property Definitions menu on the Properties tab is not the same as selecting the Property Definitions tab of the class definition.

3. Select Security Parent OVP from the list. 4. On the Security Parent OVP Properties page, do the following tasks: a. Scroll down to the Property Default Object property. b. Click the options arrow to the right of the field, and then select Paste Object.


Unit 5. Security

5-65

Student Exercises

Hint If the Paste Object option is inactive, you need to copy the object reference of the Accounts Payable Access document.

c. Verify that the Property Default Object Value is now Accounts Payable Access. Note You cannot save the values on the Security Parent OVP Properties page: you must save the changes to the class definition.

5. Select the Accounts Payable class definition tab. 6. Click Save.

Procedure 9: Create test document With all the preparations in place, you can create a test instance of an accounts payable document and verify that the inherited security is correct. You are logged on to Administration Console for Content Platform Engine. 1. Create a folder in the Root Folder of Finance. Name the folder Accounts Payable. 2. Open the folder. 3. In the Accounts Payable folder, Create a document: a. Type a name for the document. The document name is unimportant. b. Select the Accounts Payable document class. c. Use any document from C:\LabFiles\SampleDocuments for content. d. Complete the wizard using default values. 4. Click Open. 5. Select the Security tab.





6. Verify that the document has inherited the security settings from the security parent: EXNoSideHead

Procedure 10:(Optional) Observe inherited security changes Imagine that you have several thousand documents in the accounts payable class. A change to business practices requires that Finance Reviewers must have Major Versioning access to Accounts Payables. You can make the change on the parent document one time, and the security is changed on all child documents. You are signed in to Administration Console for Content Platform Engine as p8admin. 1. Go to Finance > Browse > Root Folder > Security Parents. 2. Open the Properties page of the Accounts Payable Access document. 3. Change the ACE to give Reviewers the Major Versioning permission group. Be sure to apply this setting to all children, but not the current object. 4. Save your changes to the document. 5. Verify the inherited security changes: a. Go to Finance > Browse > Root Folder > Accounts Payable. b. Open the properties page for the document in this folder. c. On the Security tab, verify that Reviewers have Major Versioning permission. You may need to refresh to see the security update. 6. Log out of Administration Console for Content Platform Engine. 7. Close Firefox.


Unit 5. Security

5-67

Student Exercises





Lesson EXNoSideHead

5.6. Work with Security Policies

Overview Why is this lesson important? The design for your business solution calls for certain documents to have different security settings based on their version status. As the solution builder, you must create security policies to implement this requirement

Activities • Configure a security policy: Procedure, on page 5-71

User accounts Type Operating system P8 Domain Finance Manager Finance Reviewer Finance Clerk

User ID Administrator p8admin May Richard Clara

Password passw0rd IBMFileNetP8 filenet filenet filenet



Unit 5. Security

5-69

Student Exercises






a security policy: Procedure

Introduction In this procedure, you create a security policy that changes document security when the document version status changes.

Scenario The solution requires a new Contracts class. When a Contract is first added to the system, it must be editable by Finance Managers. Finance Reviewers must be able to view the contract information, but not edit it. Finance Managers will promote the document to a Major Version. When it is released, the Contract content must be viewable by all P8users, but only Finance Managers can make changes. P8Admins must retain full control at all times.

Procedures Procedure 1, "Change versioning preference configuration," on page 5-71 Procedure 2, "Create the Contracts document class," on page 5-72 Procedure 3, "Create a security policy," on page 5-73 Procedure 4, "Configure security templates," on page 5-73 Procedure 5, "Add a Contract document," on page 5-76 Procedure 6, "Add a security policy to the document," on page 5-77 Procedure 7, "Promote the document," on page 5-77 Procedure 8, "Configure the default security policy on the class," on page 5-78 Procedure 9, "Test users and interfaces," on page 5-78

Procedure 1: Change versioning preference configuration By default, when a user adds a document to the Finance repository, it is added as a Major version. You are going to change this behavior so that new documents are always added as Minor versions first, so that they must be promoted before they can be accessed generally. 1. Use Firefox to log on to IBM Content Navigator as p8admin: - URL: http://ecmedu01:9080/navigator - User name: P8admin - Password: IBMFileNetP8 2. Open Administration View. 3. From Administration, go to Repositories > Finance. © Copyright IBM Corp. 2013, 2015 Course materials may not be reproduced in whole or in part without the prior written permission of IBM.

Unit 5. Security

5-71

Student Exercises

4. Click Connect. 5. Log on using p8admin user name and password. 6. Open the Configuration Paremeters tab. 7. Change the Add as major version option to No. 8. Change the Check in as major version option to No.

9. Click Save and Close. 10. Log out of IBM Content Navigator.

Procedure 2: Create the Contracts document class You create a document class. You can ignore the default instance security settings because you are going to use a security policy to override direct security. 1. Use Firefox to log on to Administration Console for Content Platform Engine. - URL: http://ecmedu01:9080/acce - User name: p8admin - Password: IBMFileNetP8 2. Go to Finance > Data Design > Classes > Document. 3. Create a New Class. - Name the class Contracts. 4. Click Open. 5. Open the Default Instance Security tab. 6. Review the Default Instance security. - P8Users have View Content - scriptest users have View Content 7. Close the Contracts class definition.






3: Create a security policy

You are logged on to Administration Console for Content Platform Engine. 1. Go to Finance > Administrative > Security Policies. 2. Click New. 3. Name and Describe the Security Policy: a. In the Display Name field, enter Contracts Security Policy. b. Click Next. 4. Specify Security Templates: a. Click Add. b. Select the following templates: • Released • In Process c. Click OK. d. Click Next. 5. Click Finish. 6. Click Open. 7. Clear the Preserve Direct Permissions option. 8. Click Save. Information By default, security templates add to the default instance security. You are changing this setting to allow the Security Policy to replace direct security.

Procedure 4: Configure security templates You have created the Security Policy for contracts, and you have created the versioning security templates. You must now edit the security templates. To edit the security template, you must first add an ACE, then go back and edit the ACE to specify permissions. You are logged on to Administration Console for Content Platform Engine. The Security Policy page is open. 1. Open the Security Templates tab. 2. Configure the In Process template: a. Select In Process.


Unit 5. Security

5-73

Student Exercises

b. Under Template Permissions, click Add.

c. Search for and add the following security principals to Selected Users and Groups: • Finance Managers • Finance Reviewers • P8admins d. Click OK. e. Click Save. 3. Edit the Finance Managers ACE: a. Select the Finance Managers. b. Click Edit. c. Select Major Versioning. d. Click OK. e. Click Save. Note All permissions for this security policy apply to This Object Only.

4. Edit the Finance Reviewers ACE. a. Select Finance Reviewers. 5-74 System Implementation and Administration




EXNoSideHead b. Give Finance Reviewers View Content permissions. c. Click Save. 5. Edit the P8Admins ACE. a. Select P8Admins b. Give P8Admins Full Control. c. Click Save. 6. Verify the ACL for the In Process template:

7. Configure the Released template: a. Select Released. b. Add, then edit the entries to create the following permissions: Principal P8users Finance Managers p8admins

Permission Group View Content Major Versioning Full Control

Apply to This object only This object only This object only

Hint Remember to save the Security Policy after you edit each ACE. After you save, you must re-select the Released security template.

8. Click Save to save the changes to the Security Policy. 9. Verify the ACL for the Released template:


Unit 5. Security

5-75

Student Exercises

Procedure 5: Add a Contract document To see the security policy work, you are going to create a contract and then add a security policy to it. Add the document as a minor version to simulate how the document is added with IBM Content Navigator. 1. Go to Finance > Root Folder. 2. Create a folder named Contracts. 3. Edit security on the Contracts folder: a. Open the Contracts folder properties. b. Open the Security tab. c. Add permission for Finance Managers to add documents to the Contracts folder (Add to folder). d. Click Save. 4. Create a document in the Contracts folder. a. On the Contracts folder, click Actions > New Document.

b. Name the document Contract 1. c. Use the Contracts class. d. Use content from C:\LabFiles\SampleDocuments. e. On the Document Content and Version page, select Create Minor Version. f.

Use default values to complete the wizard.

5. Click Open to inspect the document properties. 6. Open the Security tab.





7. Verify the following security settings: EXNoSideHead

Procedure 6: Add a security policy to the document You are viewing the Properties page of a Contract document. 1. Open the Security Policy tab. 2. In the Security Policy menu, select Contracts Security Policy. 3. Click Save. 4. Open the Security page. 5. Verify that the Security Template has replaced Direct Security:

Information The direct permissions are gone. Only the Template permissions remain.

Procedure 7: Promote the document If you promote the document to a major version, the Released security template is applied. Consequently, security permissions change. You are logged on to Administration Console for Content Platform Engine. You are viewing the properties page of the Contract 1 document. 1. Click Actions > Version > Promote Version. 2. Open or refresh the Security tab.


Unit 5. Security

5-77

Student Exercises

3. Verify the security change:

Procedure 8: Configure the default security policy on the class You have tested the security policy to ensure that the permissions meet the business requirements. Now you are going to edit the Contracts class definition so that the policy is applied whenever a new Contract is created. You are logged on to Administration Console for Content Platform Engine. 1. Go to Finance > Data Design > Classes > Document > Contracts. 2. Open the Security Policy tab. 3. From the Default Security Policy menu, select Contracts Security Policy. 4. Click Save. 5. Log out of Administration Console for Content Platform Engine. 6. Clear the browser cache.

Procedure 9: Test users and interfaces As a final test, you are going to use IBM Content Navigator to add a Contract document. You are going to use Finance Manager, Finance Reviewer, and P8User accounts to verify the security settings. 1. Use Firefox to log on to IBM Content Navigator: - URL: http://ecmedu01:9080/navigator - User name: may - password: filenet 2. Go to the Finance object store. 3. Open the Contracts folder. 4. Create a Contract document as a Finance Manager: a. Use any file in C:\LabFiles\SampleDocuments for content. b. Use the Contracts document class. c. Name the document Contract 2 d. Click Add. 5. Verify the document settings: a. Open the properties page for Contract 2. 5-78 System Implementation and Administration




EXNoSideHead b. Open the Versions tab. c. Verify that the contract was added as a minor version. d. Open the Security tab. e. Verify that the contract has only the ACEs provided by the In Process template.

f.

Verify that you can check the document out.

g. Cancel the checkout. 6. Log out of IBM Content Navigator. 7. Test document security as a Finance Clerk: a. Log on to IBM Content Navigator as clara. • User name: clara • Password: filenet b. Open the Finance object store. c. Open the Contracts folder. d. Verify that you cannot see Contract 2. e. Log out from IBM Content Navigator. 8. Promote the document: a. Log on to IBM Content Navigator: • User name: may • password: filenet b. Go to the Finance object store. c. Open the Contracts folder. d. Select the Contract 2 document. e. Click Actions > Version > Promote Version. 9. Open the properties page. © Copyright IBM Corp. 2013, 2015 Course materials may not be reproduced in whole or in part without the prior written permission of IBM.

Unit 5. Security

5-79

Student Exercises

10. Open the Security tab. 11. Verify the document settings:

12. Close the document properties page. 13. Log out of IBM Content Navigator. 14. Retest security as a Finance Clerk. a. Log on to IBM Content Navigator as Clara: • User name: clara • Password: filenet b. Open the Finance object store. c. Open the Contracts folder. d. Verify that you can now see Contract 2. e. Verify that you can view the content, but cannot check the document out. 15. Log out of IBM Content Navigator. 16. Close Firefox.

Summary In this lesson, you did the following tasks: • Created a Security Policy. • Created security templates. • Applied a security policy to a document. • Associated a security policy with a document class.





EXempty

Unit 6. Optimizing Search Performance Unit overview Lessons Lesson 6.1, "Create Property Indexes," on page 6-3 Lesson 6.2, "Create Stored Searches and Search Templates," on page 6-11 Lesson 6.3, "Configure Content Search Services," on page 6-27 Lesson 6.4, "Configure Index Partitions," on page 6-33 Lesson 6.5, "Create Content-based Indexes," on page 6-41 Lesson 6.6, "Optimize CBR Queries," on page 6-55



Unit 6. Optimizing Search Performance


6-1

Student Exercises

6-2





EXempty

Lesson 6.1. Create Property Indexes Overview Why is this lesson important? Property indexes can improve the efficiency of the system by shortening the amount of time that the database is accessed during user queries. You must create a property index to improve system efficiency.

Activities • Create a Property Index: Procedure, on page 6-5 • Create a Property Index: Exercise, on page 6-9

User accounts Type

User ID

Password

Operating system

administrator

passw0rd


P8Admin

IBMFileNetP8






6-3

Student Exercises

6-4





EXempty

Create a Property Index: Procedure Introduction This exercise shows you how to create a property index and then verify that it exists.

Procedures Procedure 1, "Create a property index," on page 6-5 Procedure 2, "Verify that the property index exists," on page 6-6

Procedure 1: Create a property index You are going to create a property index for the Order_ID property of the Order class. 1. Use Firefox to log in to Administration Console for Content Platform Engine: - URL: http://ecmedu01:9080/acce - User name: P8Admin - Password: IBMFileNetP8 2. Open the object class properties. a. Expand Sales > Data Design > Classes > Document> Order. b. Open the Property Definitions tab. c. Click the order_id link to open the property definition attributes. d. Select Single Indexed.

e. Click OK © Copyright IBM Corp. 2013, 2015



6-5

Student Exercises

f.

Click Save to save the changes to the object store.

3. Log out from Administration Console for Content Platform Engine.

Procedure 2: Verify that the property index exists Use the DB2 Control Center to verify that the property index was created. 1. Start the DB2 Control Center: a. Click Start > All Programs > IBM DB2 > TDSV63DB2 (Default) > General Administration Tools > Control Center.

b. Click OK to select Advanced mode. 2. Find the DocVersion table for the Sales object store: a. Expand All Databases > OS_DB. b. Select Tables. c. Click the heading for the Name column to alphabetize the tables by table name.

d. Scroll down to find the DocVersion tables.

6-6





EXempty

e. Select the DocVersion table for the Sales schema.

3. Find the related indexes: a. Right-click the DocVersion table. b. Select Show Related. c. Select the Indexes tab. d. Verify that the order_id index exists.

4. Click Close. 5. Close DB2 Control Center.




6-7

Student Exercises

6-8





EXempty

Create a Property Index: Exercise Introduction In this exercise, you practice creating a property index.

Scenario Customer service representatives are going to be searching the Sales object store for Orders by using the customer_id property frequently. You must improve the search performance by indexing the customer_id property.

Challenge Create a property index for the customer_id property on the Sales object store.

Verification Use the DB2 Control Center to verify that the property index exists.




6-9

Student Exercises





EXempty

Lesson 6.2. Create Stored Searches and Search Templates Overview Why is this lesson important? In your application, clerks are going to need to be able to quickly find account documents by their account number. You can create a search template that streamlines the search process. You want users to be able to find specific documents that are contained folders with thousands of documents. You create a stored search that targets the specific documents that you want users to access.

Activities • Create Stored Searches and Search Templates: Walkthrough, on page 6-13 • Practice Creating a Search Template: Exercise, on page 6-25

User accounts Type

User ID

Password

Operating system

administrator

passw0rd

Content Platform Engine administrator

CEAdmin

filenet





6-11

Student Exercises





EXempty

Create Stored Searches and Search Templates: Walkthrough Introduction This exercise gives you the opportunity to practice creating stored searches and search templates by using the Search Designer tool.

Procedures Procedure 1, "Create a stored search," on page 6-13 Procedure 2, "Create a stored search with multiple conditions," on page 6-18 Procedure 3, "Create a search template," on page 6-22 Windows For this activity, you use the Windows student system.

Procedure 1: Create a stored search Use the following instructions to create a simple stored search by using the Search Designer. The search must return documents that meet the following criteria: • Sales documents that have a quantity value that is greater than 1000. 1. Open the Search Designer. a. Use Firefox to log in to WorkplaceXT at the following URL: http://ecmedu01:9080/WorkplaceXT. b. Log in as CEAdmin: • User name: CEAdmin • Password: filenet c. On the FileNet Workplace XT menu bar, click Tools > Advanced Tools > Search Designer. The Search Designer browser window opens.




6-13

Student Exercises

2. Configure the search to be a stored search. a. In Search Designer, select Stored Search from the selection list near the top of the window.

3. Configure Object Stores. a. Select Sales from the Available Object Stores column. b. Click the green arrow button. The Sales object store is listed in the Selected Object Stores column.

4. Configure Object Types. a. Click the Object Types tab. b. Accept the default Object Type selection of Document.

5. Configure Subfolders. a. Click the Subfolders tab. b. Note the empty table with the three column headings.





EXempty

c. Click the folder icon

above the Include Subfolders column.

The Select a Folder window opens. i.

Select the Sales icon and click Open.

ii. Select Products.

iii. Click Select. d. Click the Include Subfolders check box. View

Object Subclass

Include Subfolders

Sales:\Products

Note The View column has no affect on a stored search even though it is settable in the UI. Not setting simply allows it to default to the first item in the list, which just happens to be Editable.

6. Configure Search Criteria. a. Click the Search Criteria tab. b. Accept the Current View selection of Document. c. Select the values for the Property and Operator columns, and then type the value in the Value column. View

Property quantity

Operator is greater than or equal to

Value 1000

7. Configure Format Results. a. Click the Format Results tab.




6-15

Student Exercises

b. Select or verify the values for each column on each of the three lines as shown here. Property

Alignment

Sort

Priority

Document title

left

none

0

product_id

left

none

0

price

left

descending

1

quantity

left

none

0

Note If necessary, reorder the sequence in which the properties are listed by using the Up and Down arrows.

8. Save the search: a. Click File > Add New to add the search to the object store. The Add a new search browser window opens. i.

Browse to Sales and then click Open.

ii. Click Add New Folder.

iii. Type Searches for the new folder name. iv. Click Finish. v. Click Select to select the Searches folder. vi. Click Next.





EXempty

b. Complete the Properties page. i.

In the Document Title field, type Excess Inventory.

ii. Click Next.

c. Accept the default security settings and click Finish. 9. Click File > Exit to close the Search Designer applet. 10. Log out from FileNet Workplace XT. 11. Run the search. a. Use Firefox to log in to IBM Content Navigator. - User name: CEAdmin - Password: filenet b. Select the Sales object store. c. Browse to the Sales > Searches folder.




6-17

Student Exercises

d. Double-click the search Excess Inventory to run it. The window displays the results of the search.

e. Observe the results of the stored search:

f.

i.

Verify that all the returned documents have a value for the quantity property of greater than 1000.

ii.

Verify that the results are sorted by price, with the highest price at the top of the list.

Explore the columns in the search results: i.

Click one or more of the different column headings to see that the results can be resorted.

ii. Click one of the column headings twice to see that you can sort the results in either ascending or descending order. g. Close IBM Content Navigator.

Procedure 2: Create a stored search with multiple conditions You can combine multiple search conditions with Boolean operators (AND and OR). Use the following instructions to create another stored search by using the Search Designer. The search must return Sales documents that meet one or both of the following criteria: • ServiceOrder documents that have the requested amount due and have the number of hours that are listed in the table. • Service orders that are for a customer that has ABC in its name. 1. Open the Search Designer. a. Use Firefox to log in to FileNet Workplace XT: - User name: CEAdmin - Password: filenet b. On the FileNet Workplace XT menu bar, click Tools > Advanced Tools > Search Designer. The Search Designer browser window opens.





EXempty

c. In Search Designer, select Stored Search from the selection list near the top of the window.

2. Configure Object Stores. a. Add the Sales object store from the Available Object Stores column. 3. Configure Object Types. a. Click the Object Types tab. b. Accept the default Object Type check box selection of Document. c. Note the empty table with View and Object Subclass column headings. d. Click the object Subclass column of the first line of the empty table. e. From the displayed selection list, scroll down and select ServiceOrder.

The table is now populated as shown here. View Hidden

Object Subclass

ServiceOrder

4. Configure Search Criteria. a. Click the Search Criteria tab. b. Accept the Current View selection of Document.




6-19

Student Exercises

c. Add entries in the first table. View

Property

Operator

Value

Read Only

amount_due

is less than or equal to

1000

Read Only

hours


100

Read Only

customer_name

is like

%ABC%

d. Click the Value column for the first entry in the table. Next, hold down the Ctrl key and click the Value column for each of the remaining two entries in turn, and then click the OR icon and release the Ctrl key.

All three entries are shown as being part of a single OR clause. e. Click the value for the first entry, hold down the Ctrl key again, and click the value column for the second entry, and then click the AND icon and release the Ctrl key.

Now the first two entries are shown as part of an AND clause, and this pair of entries and the third entry are shown as part of an OR clause. 5. Configure Format Results. a. Click the Format Results tab. b. Change the Alignment values for amount_due and hours to right-aligned. Property

Alignment

Sort

Priority

amount_due

right

none

0

hours

right

none

0

customer_name

left

none

0





EXempty

6. Save the search: a. Click File > Add New to add the search to the object store. The Add a new search browser window opens. i.

Browse to Sales and click Open.

ii. Select the Searches folder and then click Select. iii. Click Next. b. Complete the Properties page. i.

In the Document Title field, type Priority Service Orders.

ii. Click Next. c. Accept the default security settings and click Finish. d. Click File > Exit to close the Search Designer applet. 7. Close FileNet Workplace XT. 8. Open the search. a. Use Firefox to log in to IBM Content Navigator. - User name: CEAdmin - Password: filenet b. Select the Sales object store c. Browse to the Sales > Searches folder. 9. In the navigation pane, double-click Priority Service Orders to run it. The browser window displays the search results in the right pane.

The right pane of the browser window displays a number of documents that meet the search criteria. i.

Verify that at all but one service order has an hours value less than or equal to 100.

ii.

Verify that one service order has an hours value greater than 100, and that this service order is for a customer that has ABC in its name. This result is because of the OR condition in the search.




6-21

Student Exercises

iii. Verify that at least one service order has an amount_due value of greater than 100, and that this service order is for a customer that has ABC in its name. This result is because of the OR condition in the search. 10. Close IBM Content Navigator.

Procedure 3: Create a search template In this activity, you use Search Designer to create, save, and use a search template. 1. Use Firefox to go to http://ecmedu01:9080/WorkplaceXT - User name: CEAdmin - Password: filenet 2. Open the Search Designer tool. 3. In Search Designer, select Search Template from the selection list near the top of the window.

4. Create a Find Service Orders search template. Use the data in the following tables to build a search template that allows users to edit the maximum amount due, the maximum allowed hours, and the customer name. To be returned by the search, a service order must meet all of the requirements. a. Configure Object Stores, Object Types, and Subfolders Tab Object Stores Object Types

Subfolders

Selection Selected Object Stores Object Type Object Subclass View Object Sublass View Subfolders Include Subfolders

Value Sales Document Read Only ServiceOrder Editable Sales:\Orders

Hint To specify which subfolder in an object store to limit a search to, click the Select a Folder button or type the subfolder path exactly as shown in the table.





EXempty

b. Configure Search Criteria tab. View

Property

Operator

Value

Editable

amount_due


Editable

hours


Editable

customer_name

is like

AND/OR AND

c. Configure Format Results tab. Property

Alignment

Sort

Priority

amount_due

right

none

0

hours

right

none

0

customer_name

left

none

0

d. Save the search: i.

Click File > Add New to add the search.

The Add a new search browser window opens. ii. Browse to and select the Sales > Searches folder.

iii. Click Next. iv. Enter a document title Find Service Orders and click Next. v. Accept the default security settings and click Finish. e. Exit Search Designer. i.

From the menu bar, click File > Exit.

5. Log out from Workplace XT. 6. Run the search. a. Use Firefox to log in to IBM Content Navigator as CEAdmin. - User name: CEAdmin - Password: filenet b. In IBM Content Navigator, go to Sales > Searches. Double-click Find Service Orders to open it.




6-23

Student Exercises

Hint Search fields are case-sensitive.

c. Enter the following sample data to test it: • Amount_due is less than or equal to 500. • Hours is less than or equal to 70 • Customer_name starts with XY. d. Verify that one result is returned: Quote_XYZ.pdf 7. Log out of IBM Content Navigator.





EXempty

Practice Creating a Search Template: Exercise Scenario The Sales team often verifies service orders over the telephone. The caller must have the order_id, which the clerk uses to find the order. The clerk must be able to see the customer_name, po_number, and service_date in the results to verify the order.

Challenge Use Search Designer to create a search template that searches by order_id and displays the order_id, customer_name, po_number, and service_date fields in the results. The search must be available to Sales clerks.

Data Document class: ServiceOrder Test user: Clara Password: filenet

Verification Log in to IBM Content Navigator as Clara and then run the search. Use the following test value: Order_id = 9992131. The search must display the following result:

Summary In this lesson you did the following tasks: • Created a Search Template and Stored Searches. • Combined search criteria by using Boolean operators. • Selected document subclasses. • Formatted the search results.




6-25

Student Exercises





EXempty

Lesson 6.3. Configure Content Search Services Overview Why is this lesson important? IBM Content Search Services manages content-based indexing and searching tasks. After IBM Content Search Services is installed, you must configure Content Platform Engine to use it.

Activities • Configure a Text Search Server: Exercise, on page 6-29

User accounts Type

User ID

Password

Operating system

administrator

passw0rd


P8Admin

IBMFileNetP8





6-27

Student Exercises





EXempty

Configure a Text Search Server: Exercise Introduction In this exercise, you learn how to obtain the Content Search Services authentication token, and then use that token to create a text search server.

Procedures Procedure 1, "Obtain the authentication token," on page 6-29 Procedure 2, "Create a text search server," on page 6-30 Procedure 3, "Inspect the text search server," on page 6-31 Procedure 4, "Verify indexing on P8 Domain," on page 6-31 Procedure 5, "Verify indexing at the site level," on page 6-32

Procedure 1: Obtain the authentication token The IBM Content Search Services server uses a security token to identify itself with Content Platform Engine. The authentication token is displayed on the last window of the IBM Content Search Services installation window. IBM Content Search Services was installed some time ago, so you do not have that window open. You need to obtain the authentication token by using a command-line request. 1. Open a command prompt by clicking Start > Command Prompt. 2. Change directory to C:\Program Files\IBM\Content Search Services\CSS Server\bin 3. Enter the following command, exactly as shown: configTool printToken -configPath “C:/Program Files/IBM/Content Search Services/CSS Server/config” Note Use forward slashes (/) in the path.

4. Copy the authentication token from the screen output.




6-29

Student Exercises

Hint Do not confuse the security token with the encryption key. The security token in this example is printed on line 5 of the output: ISzPjZk=. You must include the equals sign (=) as part of the token text. The token is case-sensitive.

5. Create a text document on your desktop. 6. Paste the security token into this document and save the document. You will use the security token in the next procedure.

Procedure 2: Create a text search server You need to register the IBM Content Search Services server with the P8 Domain. You can register the server in Index mode, Server mode, or Index and Server mode. You are going to configure only one server, so it must perform both index and search operations. 1. Use Firefox to log on to Administration Console for Content Platform Engine: - User name: P8Admin - Password: IBMFileNetP8 2. Select the following node: P8Domain > Global Configuration > Administration > Text Search Servers. 3. Click New to create a text search server entry. 4. Name the server: a. Enter a display name, such as CBR Server. b. Click Next. 5. Define the server, a. Complete the fields by using the following values: Property Mode Status Host Name Port Authentication token

Value Dual Index and Search Enabled ecmedu01 8191

b. In the Authentication Token field, paste or type the authentication token that you obtained in the previous procedure. c. Click next. 6. Click Finish. Wait for the Success message. 7. Verify that your new CBR Server is now displayed under Text Search Servers. 6-30 System Implementation and Administration




EXempty

8. Click Open.

Procedure 3: Inspect the text search server The text search server that you configured in the previous procedure is open. 1. Inspect the text search server configuration. Field Display name Description Mode

Status Host name Port Authentication token Site Affinity Group

Notes The name that you see in Administration Console for Content Platform Engine. Descriptive text Dual mode runs both indexing and search services. If you have multiple search servers, you can dedicate them to a specific role. You can disable the status to prevent the submission of index or search requests to the server. The computer that hosts the search server. The default is 8191. The token is required for setup, but is not shown for security reasons. Corresponds to the physical location of connected resources. You can assign or reassign an affinity group when the server topology changes.

2. Click the Properties tab and review the information that the Properties page provides. Note On the Properties tab is a required Text Search Credential field. This property contains the value of the authentication token that you entered when you created the Text Search Server. The field is not actually blank, but the value is hidden.

Procedure 4: Verify indexing on P8 Domain You can configure parameters that govern the way that Content Platform Engine performs content-based retrieval functions at the domain and site levels. Unless otherwise specified, each site inherits the domain level settings. 1. In Administration Console for Content Platform Engine, select the P8 Domain node in the Navigation pane. 2. Open the Text Search Subsystem tab.




6-31

Student Exercises

Hint Use the left and right arrows to shift the tabs; then select Text Search Subsystem.

3. Verify that the Enable indexing check box is checked. 4. Inspect the Searching, Indexing, Extracting, and Schedule areas. These values can be customized to improve performance.

Procedure 5: Verify indexing at the site level Indexing is enabled at the domain level, but you must ensure that indexing is also either inheriting from the domain or configured separately. 1. In Administration Console for Content Platform Engine, go to Global Configuration > Administration > Sites > Initial Site. 2. Open the Text Search Subsystem tab. 3. Verify that the Configuration source has the P8 domain selected. Note The Searching, Indexing, Extracting areas have values that are disabled. These values are set at the domain level. If you choose to override them at the site level, they become editable.

4. Log out from Administration Console for Content Platform Engine.

Summary In this lesson you did the following tasks: • Obtained an authorization token for IBM Content Search Services to communicate with Content Platform Engine. • Registered IBM Content Search Services with Content Platform Engine as a text search server. • Inspected the text search server properties. • Verified that indexing is enabled at the domain and site levels.





EXempty

Lesson 6.4. Configure Index Partitions Overview Why is this lesson important? Users need to be able to find documents in an object store according to text within the document. Many documents fall into a few categories that vary on a string property. You can make the searches more efficient by creating an index partition.

Activities • Select a Property for an Index Partition: Written Exercise, on page 6-35 • Configure a String Index Partition: Procedure, on page 6-37 • Configure a Date Property Index Partition: Practice, on page 6-39

User accounts Type

User ID

Password

Operating system

administrator

passw0rd


P8Admin

IBMFileNetP8





6-33

Student Exercises





EXempty

Select a Property for an Index Partition: Written Exercise Introduction Selecting a property for an index partition is not a trivial task. A good index partition can improve search efficiency for properties that are often used in searches, but has no effect otherwise. Plan to make the selection before you create the indexes: If you change the index partition later, you must reindex.

Scenario Users are going to be searching mainly for Product Orders and Service Orders, which both belong to the Orders document class. Users often search by customer_name, customer_id, po_number, product_id (for product orders), and service date (for service orders).




6-35

Student Exercises

Instructions Read the notes for each property and then circle the property that would make best candidate for a string index partition. Property

Document title

Notes Inherited from the Document class. String data type. Large number of values that are non-unique. Occasionally used in searches. System property.

ID

String data type. Globally unique identifier. Never used in searches. Custom property.

customer_name

String data type. Large number of values that are non-unique. Often used in searches. Custom property.

customer_id

String data type. Large number of values that are unique. Often used in searches. Custom property.

po_number

String data type. Small number of values that are non-unique. Often used in searches. Custom property.

product_id

String data type. Currently unused. Not used in searches. Custom property.

service_date

DateTime data type. Sometimes used in searches.





EXempty

Configure a String Index Partition: Procedure Introduction This procedure shows how to configure an index partition for a string property.

Procedures Procedure 1, "Change the property settability option," on page 6-37 Procedure 2, "Create the index partition," on page 6-37

Procedure 1: Change the property settability option A property must be Settable only on create in order to be configured as an index partition. In Administration Console for Content Platform Engine, the Settable only on create option is represented by the value 2. You must set this attribute on the property template (not the property definition on a particular class). All classes that use this property template are indexed with this partition. 1. Use Firefox to log on to Administration Console for Content Platform Engine: - User name: P8Admin - Password: IBMFileNetP8 2. Go to the Sales object store > Data Design > Property Templates. 3. Click the po_number property link to open the property template. 4. Open the Properties tab. 5. Change the Settability value to 2. 6. Click Save. 7. Close the po_number tab. 8. Close the Property Templates page. The Sales object store page is left open.

Procedure 2: Create the index partition 1. On the Sales object store page, open the Text Search tab.




6-37

Student Exercises

2. In the Index Partitions area, select po_number.

3. Click Save.





EXempty

Configure a Date Property Index Partition: Practice Introduction In this exercise, you practice the steps to create an index partition. You can have only one string property partition and one date property partition for each object store. You must create a date property partition.

Scenario Customer service representatives often search for service orders by using the service_date property.

Challenge Create an index partition based on the service_date property. Set the Date property interval to 1 month.

Verification Your Text Search page Index Partitions section must show the following field values:

Summary In this lesson you did the following tasks: • Selected a string property for an index partition. • Configured a string property index partition • Configured a date property index partition.




6-39

Student Exercises





EXempty

Lesson 6.5. Create Content-based Indexes Overview Why is this lesson important? Users must be able to find documents in an object store by using text within the document. Many documents fall into a few categories that vary on a string property. You can make the searches more efficient by creating an index partition.


Configure CBR: Walkthrough, on page 6-43 Configure an Index Area: Practice, on page 6-49 Check Indexing Logs: Activity, on page 6-51 Reindex: Challenge, on page 6-53

User accounts Type

User ID

Password

Operating system

administrator

passw0rd


P8Admin

IBMFileNetP8

User

Charles

filenet





6-41

Student Exercises





EXempty

Configure CBR: Walkthrough Introduction In this exercise, you create and configure a content-based index area.

Procedures Procedure 1, "Create an index area," on page 6-43 Procedure 2, "Enable IBM Content Search Services on the object store," on page 6-44 Procedure 3, "Enable CBR on the document class," on page 6-45 Procedure 4, "Create an index job," on page 6-45 Procedure 5, "View the index job progress," on page 6-45 Procedure 6, "View the index properties," on page 6-46 Procedure 7, "View the index in the file system," on page 6-46 Procedure 8, "Create a content-based search," on page 6-46 Procedure 9, "Create a search by using an SQL query," on page 6-47

Procedure 1: Create an index area The index area must be created in a file system location. The folder location must exist before you can create the index area. The IBM Content Services Server user must have full access to the folder. The IBM Content Services Server user is P8Admin. If P8Admin has insufficient permissions on this folder, the index area creation process fails. 1. Create the following folder: C:\Indexes. 2. Ensure that the folder allows the CSS Server account user full access: a. Right-click C:\Indexes and select Properties. b. Open the Security tab. c. Click Edit. d. Click Add. e. Type P8Admin and then click Check Names. Verify that the name ECMEDU01\P8Admin is displayed. f.

Click OK.

g. Select the check box for to allow P8Admin Full control of this folder. h. Click OK to save your changes. i.

Click OK to close the folder properties page.

3. Use Firefox to log on to Administration Console for Content Platform Engine: - User name: P8Admin © Copyright IBM Corp. 2013, 2015



6-43

Student Exercises

- Password: IBMFileNetP8 4. Go to Sales > Administrative > Index Areas. 5. Click New. 6. Name the Index Area a. Type Index Area 1 in the Display Name field. The name that you choose is unimportant but lesson activities refer to this name. b. Click Next. 7. Configure the Index Area: a. In the Root directory field, type C:\Indexes. b. Click Next. 8. On the Summary page, click Finish. 9. Wait for confirmation of success. 10. Click Open. Note The index area is currently in the Open state. You can change the state from here if you need to. You cannot change the state to Full. However, you can set the Maximum index count to some number greater than zero so that when that limit is reached, the index status changes to Full. You can have another index in Standby mode so that it can be opened when the previous index is full.

Procedure 2: Enable IBM Content Search Services on the object store You must enable IBM Content Search Services at the object store level before you can use it for indexing. 1. In Administration Console for Content Platform Engine, open the Sales object store. 2. Open the Text Search tab for the Sales object store. 3. Select the Indexing Language: a. Scroll down the Available Languages list. b. Select en (for English). c. Click the arrow button to move the language to Selected Languages. d. Click Save. 4. Place a check mark in the Enable IBM Content Search Services option. 5. Click Save. 6. Click Refresh to ensure that the changes are saved.





EXempty

Procedure 3: Enable CBR on the document class You must enable content-based retrieval (CBR) on a document class. You can enable this option on the root Document class if you want, but if you can more selectively specify only subclasses that need to be indexed, you can shorten the indexing time. The Sales object store page is open in Administration Console for Content Platform Engine. 1. Select Data Design > Classes > Document > Product. The Product class definition is open. 2. Scroll down the page until you see the CBR enabled check box. 3. Place a check mark in the CBR enabled check box. 4. Click Save to save your changes for the document class.

Procedure 4: Create an index job Indexing is now configured on the Sales object store for the Product document class. The index does not exist until you initiate an index job. When you create an index job, the system creates the index. The Product document class definition is open in Administration Console for Content Platform Engine. 1. Click Actions > Index Class for Content Search (include subclasses). 2. Click OK to close the message that informs you that the system created an index job.

Procedure 5: View the index job progress The index job is started. You can view the progress of the index job. 1. Go to Sales > Administrative > Index Jobs Manager. 2. Click Refresh if you see no index jobs. 3. Wait for your index job status to change to Terminated Normally. If it is Pending or In Progress, click Refresh.




6-45

Student Exercises

Note Indexing can take several minutes. On a production system, the index job might take several hours, so you must plan the index job to run when the system resources are not in high demand. e

Procedure 6: View the index properties When the indexing job completes, the index area contains an index. You are going to view the index properties. 1. Go to Sales > Administrative > Index Areas > Index Area 1. 2. Open the Index tab. 3. Verify that the Index Selection field contains a value:

4. Log out from Administration Console for Content Platform Engine. 5. Close Firefox.

Procedure 7: View the index in the file system The index job created an index. You can view the index properties from the Index Area node. You can also verify the index area by going to the location in the file system. 1. Using Windows Explorer, open C:\Indexes 2. Verify that C:\Indexes contains a new subfolder that begins Sales_Document_XXX, where XXX is a long string of alphanumeric characters. 3. Explore the contents of this folder. Most of the files cannot be opened with standard viewing tools.

Procedure 8: Create a content-based search Test content-based retrieval by creating a content-based search. 1. Use Firefox to log on to IBM Content Navigator as Charles - User name: Charles - Password: filenet





EXempty

2. Open the Search page.

3. Click New Search. 4. Type Model A in the Find items with the following terms field. 5. Change the text options: a. Click Text options. b. Select the All of the terms option. c. Click OK.

6. Click Search (you might need to scroll down to see the button). 7. Verify that the search returned a few documents. 8. Open one of the documents to verify that it contains the term “Model A.” 9. Log out from IBM Content Navigator.

Procedure 9: Create a search by using an SQL query You might need to create an SQL query for administrative purposes. 1. Start FileNet Enterprise Manager by using the desktop icon. 2. Connect to the P8 domain. 3. Expand the Sales object store. 4. Right-click Search Results and then select New Search. 5. Click View > SQL View. 6. Click File > Clear All to delete the SQL Text field contents. 7. Enter the following SQL statement exactly as shown: SELECT d.This FROM Document d INNER JOIN ContentSearch c ON d.This = c.QueriedObject WHERE CONTAINS(d.*,'Model')




6-47

Student Exercises

8. Save the search: a. Click Save. b. Save the search to C:\LabFiles\SampleDocuments c. Name the search CBRQuery.qry d. Click Save. 9. Click OK to run the search. 10. Review the results. If the result is this...

Then, do this. 1. Click OK.

The query finds and displays objects.

2. Review the returned object names. 1. Read the error message carefully. 2. Correct any errors in your query syntax.

The query produces an error.

3. Save the query. 4. Rerun the query.

5. Close FileNet Enterprise Manager.





EXempty

Configure an Index Area: Practice Introduction You created an index area and a full-text index using the procedures in this lesson. Now you are going to practice what you learned.

Scenario Users must search for service orders. You need to index the ServiceOrder class so that users can find service orders based on their content.

Data ServiceOrder is a subclass of the Order document class in the Sales object store.

Challenge Enable the ServiceOrder class for CBR. Create an index job for the ServiceOrder index.

Verification Use the Index Jobs Manager to verify that the index job for the ServiceOrder class terminates normally.




6-49

Student Exercises





EXempty

Check Indexing Logs: Activity Introduction Index jobs sometimes generate errors when documents fail to be indexed. The error messages contain enough information for you to find the problem document and identify the cause of the error. When an index job completes, review the log file to see whether any problems occurred.

Procedures Procedure 1, "Check indexing entries in the log file," on page 6-51

Procedure 1: Check indexing entries in the log file 1. Find the P8 server log files: a. Using Firefox, go to the Content Engine Ping Page: http://ecmedu01:9080/FileNet/Engine b. Find and then copy the Log File Location path. c. Use the Log File Location to find the p8_server_error.log. 2. Open the p8_server_error.log file by using Notepad. 3. Scroll to the bottom of the log file. 4. Look for any errors or warnings. - If you find this log entry, read the entry and verify that you can identify the reason for the error. - If you do not find any errors or warnings, continue to the next exercise. Hint The ServiceOrder class contains only images without text. Images cannot be indexed.




6-51

Student Exercises





EXempty

Reindex: Challenge Introduction You can change the status of an index area and an index itself by changing the options in the index area General and Index tabs. You can use these controls to recover from data corruption errors.

Scenario The ServiceOrder class contains only images, not indexable documents. The attempt to index this class causes errors in the log file. You must disable CBR on this class in order to prevent indexing errors. Additionally, data corruption occurred. The index in Index Area 1 is failing.

Challenge Disable CBR on the ServiceOrder class. Make the full-text index in Index Area 1 unavailable and then reindex.

Hints You can use the Reindex button on the Index tab to reindex. You must shut down Content Platform Engine to delete the p8_server_error.log file.

Verification Review the P8_Server_error.log file. Verify that the reindex operation completed without errors.




6-53

Student Exercises

Summary In this lesson you did the following tasks: • Created an index area. • Enabled IBM Content Search Services on an object store. • Enabled CBR on a document class. • Created an index job. • Viewed index job progress. • Viewed index properties. • Viewed the index in the file system. • Created a content-based search. • Created a search .using an SQL Query • Reviewed index log files. • Reindexed a full-text index.





EXempty

Lesson 6.6. Optimize CBR Queries Overview Why is this lesson important? You want content-based searches to run faster and more efficiently. Searches that include both property-based criteria and content-based criteria take too long. You want these mixed searches to run faster and more efficiently.

Activities • Configure CBR Query Optimization Options: Procedure, on page 6-57

User accounts Type

User ID

Password

Operating system

administrator

passw0rd


P8Admin

IBMFileNetP8





6-55

Student Exercises





EXempty

Configure CBR Query Optimization Options: Procedure Introduction In this lesson, you configure the CBR Query Optimization option for dynamic switching between CBR-first searches and DB-first searches.

Procedures Procedure 1, "Set the CBR Query Optimization options," on page 6-57

Procedure 1: Set the CBR Query Optimization options 1. Use Firefox to log in to Administration Console for Content Platform Engine as P8Admin. - User name: P8Admin - Password: IBMFileNetP8 2. Open the Sales object store. 3. Open the Query page. 4. In the CBR Query Optimization area, select the Dynamic Switching option. 5. In the Excessive full-text search hits threshold, type 1000. 6. Requests for ranked results, select Grant never. 7. Click Save. 8. Log out from Administration Console for Content Platform Engine.

Summary In this lesson you did the following tasks: • Set the CBR Query Optimization mode. • Set the Requests for ranked results option. • Set the Excessive full-text search hits threshold.




6-57

Student Exercises





EXempty

Unit 7. Deploy Assets with FileNet Deployment Manager Unit Overview Lessons Lesson 7.1, "Configure Deployment Environments," on page 7-3 Lesson 7.2, "Export Assets," on page 7-11 Lesson 7.3, "Prepare the Half Maps," on page 7-21 Lesson 7.4, "Map and convert assets," on page 7-33 Lesson 7.5, "Analyze and import assets," on page 7-39



Unit 7. Deploy Assets with FileNet Deployment Manager


7-1

Student Exercises

7-2





EXempty

Lesson 7.1. Configure Deployment Environments Overview Why is this lesson important? You have finished developing and testing your FileNet Content Manager solution. The next step is to move your solution to the User Acceptance Test (UAT) environment and eventually to Production. You need to create a source and destination environment, in FileNet Deployment Manager so that you can export the solution assets from your source environment and import them into your destination environment.

Activities • Create a Source Environment: Exercise, on page 7-5 • Create a Destination Environment: Exercise, on page 7-9

User accounts Type

User ID

Password

Operating system

administrator

passw0rd


P8Admin

IBMFileNetP8






7-3

Student Exercises

7-4





EXempty

Create a Source Environment: Exercise Introduction In this activity, you create an environment in FileNet Deployment Manager by connecting to the P8 domain.

Scenario The solution is ready for Universal Acceptance Testing (UAT). You are going to create an object store for Scott, the QA lead. Scott is going to be the administrator of the test system. You are then going to create an environment that includes the new object store.

Procedures Procedure 1, "Start FileNet Deployment Manager," on page 7-5 Procedure 2, "Disable FIPS," on page 7-5 Procedure 3, "Create an environment," on page 7-6 Procedure 4, "Establish P8 Domain Connection," on page 7-6

Procedure 1: Start FileNet Deployment Manager 1. Using Windows Explorer, create the folder C:\FDM-deploy 2. Double-click the FileNet Deployment Manager icon on the desktop. 3. Click Browse to change the default deployment tree path to C:\FDM-deploy.

4. Click OK.

Procedure 2: Disable FIPS FileNet Deployment Manager runs with FIPS (Federal Information Processing Standards) 140 ready mode enabled the first time that you start it. When running in this mode, the application does not save passwords to disk. It retains obfuscated passwords in memory. You can disable this mode




7-5

Student Exercises

to allow passwords to be saved to the disk in encrypted format.This feature is usually disabled unless the customer requires FIPS 140 compliance. 1. Click Window > Preferences. 2. Clear the Enable FIPS 140-ready mode option.

3. Click OK.

Procedure 3: Create an environment 1. Right-click the Environments node. 2. Select New > Environment. 3. Type Sales_Dev in the name field. 4. Click Finish. 5. Use Windows Explorer to explore the C:\FDM-deploy deployment tree. Make sure to explore all the sub-folders, including the new Sales_Dev environment. 6. Open the C:\FDM-deploy\Environments\Sales_Dev\EnvironmentConfig.xml file, using notepad or wordpad. Notice the tag, and note that there are a series of empty tags inside it. Information The environment exists, but it does not have any configuration data.

Procedure 4: Establish P8 Domain Connection The Sales_Dev environment must connect to the local P8 Domain before you can retrieve the half maps. 1. Right-click the Sales_Dev environment and then click Open.

7-6





EXempty

2. Open the CE Connection tab.

3. In the Content Engine Connection Information page, do the following tasks: a. In the Server field, type ECMEDU01. b. Select the Save the password option. c. In the Username field, type p8admin. d. In the Password field, type IBMFileNetP8.

e. Click Test Connection.

f.

Verify that you see the Successfully Connected message, and that the PE Connection Point field displays P8ConnPt1.




7-7

Student Exercises

g. Select P8ConnP2 from the menu.

4. Click File > Save All. 5. Open the C:\FDM-deploy\Environments\Sales_Dev\EnvironmentConfig.xml file, using notepad or wordpad, again. Note that the tags, under the tag, are no longer empty, they contain the CE connection information you just entered.

7-8





EXempty

Create a Destination Environment: Exercise Introduction You created a source environment in FileNet Deployment Manager. When you create a source-destination pair, you must have a source and a destination. You must now create the destination environment. Typically, the source and destination environments are different P8 Domains. You do not have two domains on your student system, so you must create a second environment in the same P8 Domain. Important You must complete this task to continue with the lesson exercises.

Challenge • Create a second environment by using the same P8 domain as before. • Name the new environment: Sales_UAT. • Use the PE Connection point P8ConnP2.

Verification • You have two environments in the tree view, Sales_Dev and Sales_UAT.

Summary In this lesson, you did the following tasks: • Created source environment in FileNet Deployment Manager. • Created a destination environment in FileNet Deployment Manager.




7-9

Student Exercises





EXempty

Lesson 7.2. Export Assets Overview Why is this lesson important? The content and associated data structures of your FileNet Content Manager solution, in your development environment, need to be moved to the UAT environment. You must export solution assets so that they can be imported to your UAT system.

Activities • Export Object Store Data: Procedure, on page 7-13

User accounts Type

User ID

Password

Operating system

administrator

passw0rd


P8Admin

IBMFileNetP8





7-11

Student Exercises





EXempty

Export Object Store Data: Procedure Introduction In this activity, you create an export manifest and add objects to it for export. You then run the export operation.

Scenario You created the Sales_UAT destination environment that has no custom classes, workflows, or any other solution data on it. You need to export the assets, that comprise your Finance Solution, from the Sales_Dev object store so that they can be imported into the Sales_UAT object store.

Procedures • Procedure 1, "Explore the Finance Solution assets," on page 7-13 • Procedure 2, "Create the export manifest," on page 7-16 • Procedure 3, "Add assets to the export manifest," on page 7-16 • Procedure 4, "Export the data," on page 7-18 • Procedure 5, "Inspect the Deploy Dataset files," on page 7-19

Procedure 1: Explore the Finance Solution assets Before exporting data and metadata, explore some of the assets, of the Finance Solution, that need to be moved to the Sales_UAT environment. A FileNet Content Manager application can contain: • Business information • Application Definition • Configuration information • Executable Code The Finance Solution contains business information, application definitions and configuration information which already exist in the Sales object store. In this exercise you will explore the assets that you will be exporting. 1. Start the Administration Console for Content Platform Engine. a. In your browser, go to http://ecmedu01:9080/acce b. Log in as the P8admin user (password: IBMFileNetP8). 2. Open the Sales object store. 3. Explore the Customers folder a. Expand Browse > Root Folder. b. Open the Customers folder.




7-13

Student Exercises

c. On the Contents tab, change the default view of Show Documents to Show Custom Objects. Two objects should be listed.

d. Open each of the objects and notice that they belong to the Class Description: Customer. 4. Explore the Customer Custom Object. e. In the left navigation pane, expand Data Design > Classes > Custom Object f.

Open Customer

g. Select the Property Definitions tab, you should see 4 property definitions.





EXempty

5. Explore the Products folder a. In the left navigation pane, expand Browse > Root Folder. b. Open the Products folder. c. On the Contents tab, you should see a total of 7 documents, all of Class: Product. 6. Explore the Product Class. a. In the left navigation pane, expand Data Design > Classes > Document b. Open Product c. Select the Property Definitions tab, you should see 5 property definitions.

Important The Finance Solution assets include: • Folders - Customers • 2 custom objects of class type: Customer - Products • 7 documents of document class type: Product • Classes - Customer • 4 property definitions - Product • 5 property definitions




7-15

Student Exercises

It is important to have this information so that when the data is exported, you can validate the number of assets.

Procedure 2: Create the export manifest 1. Open FileNet Deployment Manager, if it is not already open. 2. Expand Environments > Sales_Dev 3. Select Export Manifests. 4. Click File > New > Export Manifest. 5. Name the export manifest: Finance-app-assets. 6. Click Finish. The export manifest is visible in the tree view.

Procedure 3: Add assets to the export manifest 1. Open the export manifest: a. Select Finance-app-assets.xml. b. Click File > Open. 2. Add items to the export manifest: a. Click the green plus icon, in the menu bar, to add Assets. b. In the tree view, expand Object Stores > Sales > Browse c. Select the Root Folder. d. In the right pane, select the following folders (hold the Ctrl key to make multiple selections): • Customers • Products

e. Click Add. f.

Click Close when you are finished adding assets.

3. Configure the Include Options: a. Select Customers in the export manifest





EXempty

b. Click the pencil icon, next to the green plus sign icon, in the menu bar, to open the Include Options screen. c. For the Include Options, uncheck Document Related: Include all document versions.

d. Click OK. 4. Repeat step 3 for the Products entry, using the same Include Options. Important You have to be very careful when selecting the include options, for the assets. You want to include only the assets you need (documents, classes, properties, etc.) Normally you would not include all the versions of documents when moving a solution from development to UAT.

5. Click File > Save All to save your data.




7-17

Student Exercises

Troubleshooting If you see a blank gray area instead of the Include Options menu, increase your screen resolution. The menu cannot display properly on screen resolutions under 1024x768.

Procedure 4: Export the data The assets have been added with the appropriate include options. You are now ready to export the assets and create the Deploy Dataset. 1. Select Finance-app-assets.xml. 2. Click File > Export.

3. Make note of the Output Folder for the deploy dataset. 4. Click OK. 5. You should see 46 items processed. Click OK to close the success notification. 6. Review the deployment.log to see what assets were exported. a. In Windows Explorer, open the C:\FDM-deploy\Temp\Run. folder for the latest run. b. Open the deployment.log, in the bottom half of the file you will see details of the items that were exported.





EXempty

Note Adding two items to the export manifest with appropriate include options can result in a large number of exported items.

Procedure 5: Inspect the Deploy Dataset files You exported files from an object store to a Deploy Dataset. The Deploy Dataset is a set of files in the deployment tree. You can inspect these files in the file system. 1. Open Windows Explorer. 2. Browse to C:\FDM-deploy\Environments\Sales-Dev\Assets 3. Open the ExportManifests folder 4. Edit the Finance-app-assets.xml file. Note The include options you selected are included as xml tags and serve as instructions for FileNet Deployment Manager, identifying what to include in the export.

5. Close the Finance-app-assets.xml file. 6. Go up one level, to the Assets folder, and open the Finance-app-assets folder. 7. Inspect the contents. a. Verify that a Content folder exists, which includes a number of subfolders named FNXX (where XX can be from 0 to 22). b. Verify that the Finance-app-assets folder also contains the following files: • Catalog.xml • deployDataSet1.xml • DeploymentOperation_Export.xml. • Finance-app-assets.xml • ObjectList.xml c. Open any of the XML files with WordPad to inspect the contents. 8. Close all the open tabs but leave FileNet Deployment Manager open for the next exercise.




7-19

Student Exercises

Summary In this exercise, you did the following tasks: • Explored the Finance Solution assets • Created an export manifest. • Exported data to a Deploy Dataset. • Inspected the Deploy Dataset created.





EXempty

Lesson 7.3. Prepare the Half Maps Overview Why is this lesson important? The content and associated data structures of a development object store need to be exported to a test object store. You must create a mapping between the two environments in order to convert objects to work in the new environment. You create the map by combining two half maps into a data map.

Activities • Prepare half maps: Exercise, on page 7-23

User accounts Type

User ID

Password

Operating system

administrator

passw0rd


P8Admin

IBMFileNetP8





7-21

Student Exercises





EXempty

Prepare half maps: Exercise Introduction In this activity, you prepare the half maps of your source and destination environments.

Scenario You have created your source and destination environments and exported the solution assets from your source environment. You need to create the object store half maps and the security principal half maps for your source and destination environment. These two sets of half maps will allow FileNet Deployment Manager to map source object stores to destination object stores and source security principals to destination security principals, when the data maps are created.

Procedures Procedure 1, "Retrieve object store data for the source environment," on page 7-23 Procedure 2, "Retrieve security principal data for the source environment," on page 7-24 Procedure 3, "Retrieve security principal data for the destination environment," on page 7-25 Procedure 4, "Create an object store for UAT," on page 7-27 Procedure 5, "Configure the object store for CBR (optional)," on page 7-28 Procedure 6, "Configure CBR on the object store (optional)," on page 7-28

Procedure 1: Retrieve object store data for the source environment 1. In FileNet Deployment Manager, in the left navigation pane, double-click the Sales_Dev environment to open it.




7-23

Student Exercises

2. Retrieve object store data: a. Click Retrieve Data for object stores, storage policies, and storage areas. If you do

not see this screen, ensure that you have selected the Overview tab. b. Select the two Options: Retrieve storage policies for each object store and Retrieve storage areas for each object store. c. On the Mode option, you can take the default Merge... d. Click OK. e. Click OK to close the success confirmation. 3. Verify the object store data: a. Expand the Sales_Dev node in the Tree View. b. Right-click Object Store Data node and select open. c. You should see a list of the object stores configured on your Sales_Dev environment.

Procedure 2: Retrieve security principal data for the source environment 1. Click the Sales_Dev tab to return to the Sales_Dev properties page. 2. Retrieve Security Principal Data: a. Click Retrieve Data for Security Principal.





EXempty

b. Keep the default option, Deploy Dataset File.

c. Click Next. d. For the Select Deploy Dataset: field, ensure that the full path to the Finance-app-assets is displayed, if not, use the Browse button to select it. e. On the Mode option, you can take the default Merge... Information Since this is the first time you are creating this half map, it does not matter which mode you select, merge or overwrite. However, if you already have an existing half map, the merge and overwrite modes will do what you expect, so ensure you choose the appropriate mode.

f.

Click Finish.

g. Click OK to close the success confirmation. 3. Verify the security principal data. a. Right-click the Security Principal Data node and select Open. b. You will see the list of security principals associated with the assets you exported in

the deploy dataset file, Finance-app-assets. 4. Leave FileNet Deployment Manager open for the next exercise.

Procedure 3: Retrieve security principal data for the destination environment Prior to retrieving the users and groups for a destination environment, planning must take place to decide what users and groups will be used in the destination environment. For this exercise, the following table outlines the users and groups to be used for the two environments.




7-25

Student Exercises

User and group accounts Source Environment p8admin p8admins p8users

Destination Environment p8admin Finance Admins Finance Clerks

Label admins users

1. In the left navigation pane, double-click the Sales_UAT environment to open it. 2. Use Notepad to create a filter Label File: a. Notepad to create a text file, C:\FDM-deploy\UAT-users.txt. b. Add the users and groups listed under Destination Environment, in the table above, and the corresponding label, separated by a comma. One entry per line.

c. Save the file 3. Retrieve Security Principal Data: a. Click Retrieve Data for Security Principal b. Select the option From Content Engine’s LDAP Provider, click Next. c. Click Retrieve Realms d. Under Filter, select Use a Label File, browse to C:\FDM-deploy\UAT-users.txt





EXempty

e. Click Finish

Procedure 4: Create an object store for UAT At a customer site, the development system and the UAT system would be two distinct FileNet P8 domains. Unfortunately the lab image is restricted to just one FileNet P8 domain. To demonstrate the deployment process, you will create a new object store to take the role of the destination object store, Sales_UAT. Create a destination object store. Specify the group Finance Admins as administrators (in addition to P8Admin). 1. Use Firefox to log in to Administration Console for the Content Platform Engine: - User name: P8Admin - Password: IBMFileNetP8 2. Select Object Stores > New Object Store. 3. Use the following data to create the object store: Page Name the Object Store

Field Display Name Database connection Schema name

Define the Database

Select the Type of Storage Area Storage area type for Content Grant Administrative Access

Administrators

Grant Basic Access

basic users

Value SalesUAT FNOSDS SalesUAT Database P8Admin Finance Admins Finance Clerks

4. In the Select Add-ons window, click the Workplace/WorkplaceXT Configuration button.

5. Complete the wizard using defaults, click Finish after reviewing the Summary page. Note You may get a prompt stating that a script is taking too long to complete, go ahead and click continue to complete the script.




7-27

Student Exercises

6. On the Success screen, click Close.

Procedure 5: Configure the object store for CBR (optional) Important Perform this procedure only if you completed the lesson activities in the unit "Optimizing Search Performance". If you did not configure the Sales object store for CBR, then skip this procedure.

If you performed the lesson activities in "Optimizing Search Performance", then the Sales object store was configured for content-based retrieval (CBR). In order for the import operation to succeed, both object stores must be configured the same way. Use this procedure to create an index area on the SalesUAT object store. You are logged on to Administration Console for Content Platform Engine as P8admin. 1. Click to open the SalesUAT object store. 2. Click Administrative > Index Areas. 3. Click New. 4. Name the Index Area a. Type Index Area 2 in the Display Name field. The name that you choose is unimportant but lesson activities refer to this name. b. Click Next. 5. Configure the Index Area: a. In the Root directory field, type C:\Indexes. b. Click Next. 6. On the Summary page, click Finish. 7. Wait for confirmation of success. 8. Click Close.

Procedure 6: Configure CBR on the object store (optional) Important Perform this procedure only if you completed the lesson activities in the unit "Optimizing Search Performance". If you did not configure the Sales object store for CBR, then skip this procedure.





EXempty

If you performed the lesson activities in "Optimizing Search Performance", then the Sales object store was configured for content-based retrieval (CBR). Use this procedure to enable CBR on the SalesUAT object store. 1. Click to open the SalesUAT object store. 2. Click the Text Search tab. 3. Select the Indexing Language: a. Scroll down the Available Languages list. b. Select en (for English). c. Click the arrow button to move the language to Selected Languages. d. Click Save. 4. Place a check mark in the Enable IBM Content Search Services option. 5. Click Save. 6. Click Refresh to ensure that the changes are saved. 7. Log out from Administration Console for the Content Platform Engine. 8. Close Firefox.




7-29

Student Exercises





EXempty

Retrieve the Object Store Data for the Destination Environment: Exercise Introduction You created two environments in FileNet Deployment Manager. You must create object store half maps for the source and destination environments in order to create the mapping between object stores. You have retrieved the object store data for the source environment, now you need to retrieve the object store data for the destination environment. Important You must complete this task to continue with the lesson exercises.

Challenge • Retrieve the object store data for the Sales_UAT environment. • Inspect the resulting object store half map

Verification • Your object store half map should include the following;

Troubleshooting If you cannot retrieve the object store data, do the following checks: • Ensure that you made a valid connection to the object store. • Ensure that you saved your configuration.

Note This solution does not include any services, so you do not need to retrieve service data.




7-31

Student Exercises





EXempty

Lesson 7.4. Map and convert assets Overview Why is this lesson important? The content and associated data structures of your FileNet Content Manager solution, in a development environment, need be moved to UAT environment. You must create a mapping between the two environments in order to convert objects to work in the UAT environment.

Activities • Map and Convert Assets: Activity, on page 7-35

User accounts Type

User ID

Password

Operating system

administrator

passw0rd


P8Admin

IBMFileNetP8





7-33

Student Exercises





EXempty

Map and Convert Assets: Activity Introduction You must create a source destination-pair to store the data maps that will be used for conversion.

Procedures Procedure 1, "Configure object store labels," on page 7-35 Procedure 2, "Configure security principal labels," on page 7-36 Procedure 3, "Create the source-destination pair," on page 7-36 Procedure 4, "Inspect the source-destination pair," on page 7-37 Procedure 5, "Convert the deploy dataset," on page 7-38

Procedure 1: Configure object store labels You are mapping a source object store to a destination object store. If you label the source and destination object stores properly, they are automatically mapped when you generate the source-destination pair. 1. Open FileNet Deployment Manager, if not already open. 2. Label the Sales_Dev object stores: a. Open the Sales_Dev > Object Store Data node. b. In the Label column of the Sales object store, type Sales.

3. Label the Sales_UAT object stores: a. Open the Sales_UAT > Object Store Data node. b. In the Label column of the SalesUAT object store, type Sales.

4. Click File > Save All.




7-35

Student Exercises

Note Ensure that the Sales_Dev and Sales_UAT object stores are correctly labeled. Environment Sales_Dev Sales_UAT

Object Store Sales SalesUAT

Label Sales Sales

Procedure 2: Configure security principal labels In the previous procedure, you used labels to identify the source and destination object stores. You will use labels to help FileNet Deployment Manager map the users and groups. Note For the Sales_UAT security principal half map, you added the labels to the label file used to filter the retrieval of the security principals from the Content Engine LDAP, which allowed FileNet Deployment Manager to automatically add the labels to the users and groups in the generated half map, so you only need to add labels to the Sales_Dev security principal half map.

User and group accounts Label

Source Environment p8admin p8admins p8users

admins users

Destination Environment p8admin Finance Admins Finance Clerks

1. Add labels to the Sales_Dev security principle half map: a. Open the Sales_Dev > Security Principal node. b. Using the table above, add the appropriate labels. 2. Click File > Save All.

Procedure 3: Create the source-destination pair You create a source-destination pair that is used for conversion and import. 1. Click File > New > Source-Destination Pair. 2. Name the pair Sales_Dev-Sales_UAT. 3. Add an appropriate description, for example, “Deploy finance application from Sales development to Sales UAT for testing” 4. In the Source Environment menu, select Sales_Dev. 5. In the Destination Environment menu, select Sales_UAT.





EXempty

6. Click Finish.

Procedure 4: Inspect the source-destination pair 1. Expand the Sales_Dev-Sales_UAT source-destination pair. 2. Double-click the Object Store Map node. 3. Verify that the Sales object store is mapped to the SalesUAT object store.

4. Double-click the Security Principal Map node. 5. Verify that the users and groups are mapped as follows:

Information The second column of a data map always includes one of the following icons for each entry.

Icon

Description More information is available about the items in the row of the data grid. Hover over the icon to see the additional details. Mapping generated from FDM default matching rules based on item attributes.

Mapping is explicit user match using labels or direct assignment on the data mapping dialog.

No match exists; item will not be mapped during conversion.




7-37

Student Exercises

Procedure 5: Convert the deploy dataset The object stores and principal maps are ready. You can now convert the exported Deploy Dataset and change any object store or security principal references according to the mappings that you specified. 1. Select the source destination pair, Sales_Dev-Sales_UAT. 2. Right-click and then select Convert Assets.

3. On the Asset Type Selection page: a. Select Content Engine Deploy Dataset. b. Click Next. 4. On the Select the Source Deploy Dataset page: a. Verify that the Deploy Dataset is C:\...\Environments\Sales_Dev\Assets\Finance-app-assets. b. Click Next. 5. On the Select Output Folder for Converted Deploy Dataset page: a. Verify that the Folder for Converted Deploy Dataset is C:\...\Environmetns\Sales_UAT\Assets. i.

Note the name of the Converted Deploy Dataset that will be created.

b. Click Finish. 6. Click OK to close the success notification. Note You should see 46 items processed.

Summary In this exercise, you did the following tasks: • Created a source-destination pair. • Mapped object stores and security principals. • Converted content assets.





EXempty

Lesson 7.5. Analyze and import assets Overview Why is this lesson important? The content and associated data structures of your FileNet Content Manager solution, in a development environment, need be moved to UAT environment. You must run a report to see how the converted assets will affect the system. If the results are acceptable, you can import the assets into the UAT environment.

Activities • Analyze and import assets: Activity, on page 7-41

User accounts Type

User ID

Password

Operating system

administrator

passw0rd


P8Admin

IBMFileNetP8

Finance Admins

Adam

filenet





7-39

Student Exercises





EXempty

Analyze and import assets: Activity Introduction In this exercise, you run an import analysis and then review the results. After you review the results and everything is acceptable, you can import the assets into the UAT environment.

Procedures Procedure 1, "Analyze the Finance-app-assets dataset," on page 7-41 Procedure 2, "Import the Deploy Dataset," on page 7-42 Procedure 3, "Inspect the imported assets," on page 7-43

Procedure 1: Analyze the Finance-app-assets dataset You are in FileNet Deployment Manager. 1. In the left navigation pane, Right-click Source-Destination Pairs > Sales_Dev-Sales_UAT. 2. Click Analyze. c. Click Next on the Analyze Change Impact window. d. On the Analyze Change Impact on Destination Environment window, ensure that the C:\...\Finance-app-assets.converted Deploy Dataset is selected. e. Click Next. f.

On the Select Import Analysis Options page, select Always update the object if it exists at the destination, click Next.

g. On the Change Impact Report Options page, select the Include details for all objects in report check box, click Next. h. On the Summary page, click Finish. 3. Note any failed items in the notification, then click OK. The Change Impact Analysis Report opens.




7-41

Student Exercises

4. Review the Change Impact Analysis Report. i.

Click on the Assets that failed Analysis link i.

j.

Note that the failure is caused because we have a workflow subscription but the WorkflowDefinition does not exist in the destination environment. This is an expected error, for this exercise. For workflow defintions you need to migrate the workflow definition and transfer it to make it available for use in a workflow subscription.

Click on the Back to Top link

k. Click on the Assets that Passed Analysis with Warnings link. i.

Note that there are 5 warnings for the Class: Product, and they all warn of the storage area that does not exist in the destination environment, For this exercise we will allow FileNet Deployment Manager to use the default storage area, but in a real environment there might be a plan to use a different storage area in the destination environment, this storage area would need to be setup prior to doing the import operation.

5. Close the report.

Procedure 2: Import the Deploy Dataset 1. Right-click Source-Destination Pairs > Sales_Dev-Sales_UAT 2. Click Import.

3. In the Select Storage Policy for Imported Objects. a. Leave the default setting, but notice the option available: • Use default storage policies or areas from class definitions at destination





• Use storage policies or areas from the imported objects in the deploy dataset (this option assumes that the appropriate storage policies and areas have been configured in the destination environment).

EXempty

• Select a specific storage policy from the destination object store (this allows you to map the storage policies at the time of import, again the storage areas need to have been already configured in the destination environment). 4. Uncheck the Use original create/udpate timestamps and users 5. Select Always Update 6. Click Finish. 7. Note that 46 items were processed, 45 succeeded and 1 failed. 8. Inspect the deployment.log a. Using Windows Explorer, browse to C:\FDM-deploy\temp\Run. folder, corresponding to the most recent timestamp. b. Open the deployment.log i.

The log shows that the Test Workflow Subscription will not be imported because the workflow it references does not exist in the destination. (It is Ok for ignore this error for this exercise).

ii. Close the deployment.log file when you are done reviewing it. 9. Close FileNet Deployment Manager.

Procedure 3: Inspect the imported assets You imported both data and metadata into the new object store. Now you are going to see the results of the import. 1. Log in to Administration Console for the Content Platform Engine as a member of the Finance Admins group. - User name: adam - Password: filenet 2. Open the SalesUAT object store. 3. Expand the Browse > Root Folder. 4. Verify that the Root Folder contains the following subfolders: - Customers - Products 5. Open the folders and verify that they contain the expected documents. 6. Explore the class types and the property definitions. 7. Logout when you are done exploring. 8. Close the browser.




7-43

Student Exercises

Summary In this exercise, you did the following tasks: • Created a Change Impact Analysis Report. • Reviewed the report. • Imported converted assets. • Inspected the imported assets.





Unit 8. Manage Sweep jobs

EXNoSideHead


Lessons Lesson 8.1, "Configure a Sweep Job," on page 8-3 Lesson 8.2, "Work with Sweep Policies," on page 8-15

Unit Dependencies • Refer to Unit 1: Introduction to IBM FileNet Content Manager for the system startup and system check. • Refer to Unit 2: Build an Object Store for the concepts on Storage.







8-1

Student Exercises

System Check Perform a system check whenever you start an IBM FileNet P8 system or start working on a system that is in an unknown state. These activities assume that you did a system check when you begin an activity session.

8-2





Lesson EXNoSideHead

8.1. Configure a Sweep Job

Why is this lesson important to you? As an Administrator, you manage objects on the Content Platform Engine by monitoring and controlling object activity. You plan to archive and you must move content for large numbers of documents and annotations from the primary storage area to another storage area. You use a bulk move content job to complete the task.

Activities • Configure a Bulk Move Content Job: Activity, on page 8-5 • Configure a Bulk Move Content Job: Practice, on page 8-13


User ID

Password


p8admin

IBMFileNetP8





8-3

Student Exercises

8-4






a Bulk Move Content Job: Activity

In this activity, you configure a sweep job to do a bulk move of document content. You specify a Document class so that documents of that particular class only moved. You also specify a File Storage area in the Filter Expression, so the documents in that storage only moved. The destination Storage area is mentioned in the Storage Policy. You test the sweep job execution by comparing file count and content in the File Storage Areas. Storage Areas, Storage Policy, Document classes, and the documents in the file storage are already configured on the student system for this activity.

Procedures Procedure 1, "Examine the File Storage Areas," on page 8-5 Procedure 2, "Create a Bulk Move Content Job," on page 8-7 Procedure 3, "Test the Bulk Move Content Job," on page 8-10

Procedure 1: Examine the File Storage Areas In this procedure, you examine the File Storage Areas for their file count before running the Bulk Move Content Job. You are going to compare these values after running the job. 1. Start the Administration Console for Content Platform Engine. a. In your browser, go to http://ecmedu01:9080/acce b. Log in as the P8admin user (password: IBMFileNetP8). 2. In the Administration Console, expand the P8Domain > Object Stores node on the left pane and click the Sales object store. 3. Open the Storage Areas: In Sales tab, expand Sales > Administrative and click Storage Areas. Storage Area tab opens and all the available storage areas are listed. 4. Examine the File Storage Areas. a. Verify that the PurchaseOrderFileStorageArea (from where you want to move the content) contains nine files.

b. Observe that the destination storage area (BulkMoveStorageArea) contains o files.




8-5

Student Exercises

Note The BulkMoveStorageArea is associated with the Bulk Move Storage Policy. You configure this Storage Policy as the destination in the Sweep Job that you are going to create.

c. In the Storage Areas tab, click the BulkMoveStorage Area to open its properties. d. Click the Storage Policies tab to view the policy that is associated with this storage area.

5. Examine the Document Class for the nine files in the PurchaseOrderStorage Area. a. In Sales tab, expand Sales > Browse> RootFolder and click TestBulkMove folder. b. In the TestBulkMove tab, observe that nine documents are listed. In the Class column, verify that five documents belong to PurchaseOrder and four documents belong to PriceQuote. c. Both the Document Classes use PurchaseOrderStorageArea for storage.

8-6





EXNoSideHead

Hint

Your Bulk Move Content Job moves the content for the PurchaseOrder Document class only as you specify in the wizard. After running the Job, you are going to verify that the documents belong to PriceQuote Document are not moved.

Procedure 2: Create a Bulk Move Content Job 1. Start the New Bulk Move Content Job wizard. a. In the Sales tab, select the Sweep Management > Job Sweeps > Bulk Move Content Jobs folder in the left pane. b. In the Bulk Move Content Jobs tab, click New in the right pane. The New Bulk Move Content Job tab opens. 2. Define a Bulk Move Content Job. a. In the New Bulk Move Content Job tab, enter a value for the Display name field (Example: BMCJob). b. If needed, Scroll down. Select Normal from the list for the Sweep mode field. Information Sweep mode The value decides whether to preview the objects that the sweep is going to process. The Preview mode is useful for testing the filtering expression criteria without performing any actions on the selected objects. You are going to use the Preview setting in the next Practice activity.

c. Click the Enable bulk move content job option and click Next.

3. Define Sweep Targets - Target class: a. For the Target class field, copy the object reference by completing the following step 4. Then, continue on the New Bulk Move Content Job wizard in step 5.




8-7

Student Exercises

4. Copy the Object Reference. a. In the Sales tab, expand Sales > Data Design > Classes > Document > PurchaseOrder on the navigation (left) pane. b. Right-click PurchaseOrder, and click Copy Object Reference from the list.

5. Paste Object. a. In the New Bulk Move Content Job tab, click Paste Object. b. Verify that the Target class field now has the PurchaseOrder value. 6. Define Sweep Targets - Filter expression: a. For the Filter expression field, copy the GUID by completing the following step 7. Then, continue on the New Bulk Move Content Job wizard in step 8. 7. Copy the GUID value. a. In the Sales tab, expand Sales > Administrative > Storage Areas on the navigation (left) pane. Click PurchaseOrderFileStorageArea. b. In the PurchaseOrderFileStorageArea tab > General subtab on the right pane, copy the GUID value in the Id field.

8. In the New Bulk Move Content Job tab, paste it in the Filter expression field and build the expression. Example: StorageArea = OBJECT(‘{GUID}’)

Important Verify that there are no typing errors in the Filter expression statement. Type the value exactly as shown. It is case-sensitive and extra spaces are not allowed.

9. Select BulkMove Storage Policy for the Storage policy names field. 8-8





EXNoSideHead This storage policy and BulkMoveStorageArea (a file storage area that is associated with the policy) are already created on the student system for this lab exercise. 10. Set other options: - Include subclasses - Not Enabled - End replication after move- Enabled - Record Failures - Enabled

a. Click Next. 11. Define Bulk Move Content Job Dates. a. Enter today’s date for the Effect start date field. (Example: 6/21/2013) b. Enter tomorrow’s date for the Effect end date field. (Example: 6/22/2013) After you enter the value, the system is configured to automatically format the dates. c. Edit the start time to the current time and end time to 11.00.00 PM.

d. Click Next. 12. In the Summary page, review the information and click Finish. a. In the Success page, click Close to close the tab. 13. In the Bulk Move Content Jobs tab, click Refresh. a. Verify that the new sweep job is listed.




8-9

Student Exercises

Troubleshooting If there is an error in the Filter expression value, the wizard does not create the Job. It throws an error similar to the one in the screen capture. In this example, notice that the expression is missing a single quotation mark before the GUID # starts.

Fix the format: • Click OK to close the Error window. Click Back in the wizard, correct the Filter expression value, and complete the wizard.

Procedure 3: Test the Bulk Move Content Job In this procedure, you examine the Bulk Move Content Job properties. You also examine the File Storage Areas for their file count after running the Bulk Move Content Job. You compare these values with the ones before running the job. 1. Refresh the object store: In the Sales tab, click Refresh. Important It might take a couple minutes for the Sweep Job to complete. If you do not see the expected results, wait for a couple minutes and refresh the Sales object store.





2. Examine the Bulk Move Content Job properties. EXNoSideHead a. In the Bulk Move Content Jobs tab, click BMCJob. 3. In the General tab, scroll down and observe the values for the start and end dates. Verify that five objects were examined and processed. The Failed object count is 0.

a. Examine the Properties tab for object counts. Hint If you do not see the expected results, refresh the object store and the Bulk Move Content Jobs.

4. Open the Storage Areas. a. In Sales tab, expand Sales > Administrative and click Storage Areas. Storage Area tab opens and all the available storage areas are listed. 5. Examine the File Storage Areas. a. Verify that the target storage area (PurchaseOrderFileStorageArea) now contains only four files. b. Observe that the destination storage area (BulkMoveStorageArea) now contains five files.

The content for the five documents of the PurchaseOrder class is moved from the PurchaseOrderStorage Area to the BulkMoveStorageArea by running the Bulk Move Content Job. The four documents of the PriceQuote class are not moved. 6. Log out of the Administration Console for Content Platform Engine and close the browser.




8-11

Student Exercises

Information You can also search for the documents of the class that is used for bulk move content job and verify that their Storage area value is changed.






a Bulk Move Content Job: Practice Complete the following exercise scenario to practice the procedures that you learned in this lesson.

Scenario: Product Department The Sales Department sends a request to archive the Price Quote documents that are not active. As an Administrator, you complete this task by creating a bulk move content job with the data in the table to move the content to another file storage.

Challenge • Create a Bulk Move Content Job and test it. • Use the age of the document as the filter expression in this job. You used File Storage Area for the filter in the previous activity. • Use Preview for the Sweep mode. (in stead of Normal)

Data Item

Value

Display name

MyBulkMoveJob

Sweep mode

Preview

Enable bulk move content

True

Target class

PriceQuote

Filter expression

DateCreated < NOW() - TimeSpan(2, 'Days')

Storage policy names

Bulk Move Storage Policy

Include Subclasses

False

End replication after move

True

Record Failures

True

Effective Start date

Today’s date (Example: 06/22/2013)

Effective End date

Tomorrow’s date (Example: 06/23/2013)

Hint Set the age of the document for the Filter expression field. - Example: DateCreated < NOW() - TimeSpan(2, 'Days') - This filter moves any documents that were created at least two days ago. - Type the value as shown in the table. It is case-sensitive and extra spaces are not allowed. In a production system, the age of the documents could be in months or years, but for this lab exercise, you use in days.




8-13

Student Exercises

Effective start date and end date format: The system automatically formats the date that you entered. You can edit the time to be the current time for the start date.

Verification • Examine the MyBulkMoveJob properties > General tab. • Verify that four objects were examined and processed. The failed object count is 0.

• Since you chose Sweep mode value as Preview, verify that the Sweep Results tab contains a list of objects that the sweep is going to move.

• The Preview mode helps to test the filtering expression criteria without performing any actions on the selected objects.





Lesson EXNoSideHead

8.2. Work with Sweep Policies

Why is this lesson important to you? The Sweep examines the database tables that store objects and deletes objects that are based on the criteria that are defined in the disposal policy. These sweeps run multiple iterations until they are either disabled or deleted. You must configure the system to automatically delete the documents of a specified class that is based on a filter criteria. (Example: Based on the age of the documents or based on documents in a particular File Storage Area). As an Administrator, you create a disposal policy to complete this task.

Activities • Create a Disposal Policy: Activity, on page 8-17

User accounts: Windows Application Name

User ID

Password

Administration Console for Content p8admin Platform Engine

IBMFileNetP8


IBMFileNetP8

p8admin





8-15

Student Exercises





Create EXNoSideHead

a Disposal Policy: Activity

In this activity, you configure a disposal policy to delete the objects. You specify a Target Class so that documents of that particular class only deleted. You also specify a File Storage area in the Filter Expression, so the documents in that storage only deleted. You test the disposal policy by verifying the processed object count and the documents in the folders.

Procedures Procedure 1, "Examine documents and File Storage Area," on page 8-17 Procedure 2, "Create a Disposal Policy," on page 8-18 Procedure 3, "Test the Disposal Policy," on page 8-20

Procedure 1: Examine documents and File Storage Area In this procedure, you examine the number of documents in the object store folder before running the disposal policy. You also examine the File Storage Area for its file count. You are going to compare the documents and the file count after running the policy. 1. Start the Administration Console for Content Platform Engine. a. In your browser, go to http://ecmedu01:9080/acce b. Log in as the P8admin user (password: IBMFileNetP8) 2. In the administration console, expand the P8Domain > Object Stores node on the left pane and click the Sales object store. 3. Examine the number of documents and their Document Class: a. In Sales tab, expand Sales > Browse> RootFolder and click TestBulkMove folder. b. In the TestBulkMove tab, observe that nine documents are listed. In the Class column, verify that four documents belong to PriceQuote. c. The four documents are stored in PurchaseOrderFileStorageArea.

4. Examine the File Storage Area. a. In Sales tab, expand Sales > Administrative and click Storage Areas. Storage Area tab opens and all the available storage areas are listed. b. On the Statistics tab, verify that the PurchaseOrderFileStorageArea (from where you want to delete the files) contains four files.




8-17

Student Exercises

Procedure 2: Create a Disposal Policy 1. Open the New Disposal Policy wizard. a. In the Sales tab, select the Sweep Management > Sweep Policies > Disposal Policies folder in the left pane. b. In the Disposal Policies tab on the right pane, click New. The New Disposal Policy wizard opens in the right pane. 2. Define a Disposal Policy. a. In the New Disposal Policy tab, enter a value for the Display name field (Example: MyDisposalPolicy). b. Select Normal from the list for the Sweep mode. c. Select the Enable disposal policy option. d. Click Next. 3. Define Sweep Targets - Target class: a. For the Target class field, copy the object reference by completing the following step 4. Then, continue on the New Disposal Policy wizard in step 5. 4. Copy the object reference. a. In the Sales tab, expand Sales > Data Design > Classes > Document > PriceQuote on the navigation (left) pane. b. Right-click PriceQuote, and click Copy Object Reference from the list.

5. Paste Object. a. In the New Disposal Policy tab, click Paste Object. b. Verify that the Target class field now has the PriceQuote value. 6. Define Sweep Targets - Filter expression: a. For the Filter expression field, copy the GUID by completing the following step 7. Then, continue on the New Disposal Policy wizard in step 8.





7. Copy the GUID value. EXNoSideHead a. In the Sales tab, expand Sales > Administrative > Storage Areas on the navigation (left) pane. Click PurchaseOrderFileStorageArea.

b. In the PurchaseOrderFileStorageArea tab > General subtab on the right pane, copy the GUID value in the Id field. 8. In the New Disposal Policy tab, paste the GUID value in the Filter expression field and build the expression. Example: StorageArea = OBJECT(‘{GUID}’)

Important Verify that there are no typing errors in the Filter expression statement. Type the value exactly as shown. It is case-sensitive and extra spaces are not allowed.

Hint Use the age of the document for the Filter expression field. - Example: DateCreated < NOW() - TimeSpan(10, 'Days') - This filter moves any documents that were created at least 10 days ago. - Type the value as shown. It is case-sensitive and extra spaces are not allowed. In a production system, the age of the documents could be in months or years, but for testing, you use in days.

9. Set other options: - Include subclasses - Not Enabled - Number of sweep iterations- 10 (Leave the default value)




8-19

Student Exercises

a. Click Next. 10. Define Policy Dates: a. Leave the date fields blank. b. Click Next. 11. In the Summary page, verify the details and click Finish. a. In the Success page, click Close to close the tab. 12. Verify that the policy is created. a. In the Sales tab, click Refresh. b. In the Disposal Policies tab, click Refresh. c. Verify that the policy that you created is displayed.

d. Click the policy to view its properties page.

Procedure 3: Test the Disposal Policy 1. Verify the properties of the policy that you created: a. In the Disposal Policies tab, click MyDisposalPolicy.





EXNoSideHead b. In MyDisposalPolicy tab, > General sub tab, observe the object counts.

2. Verify that Policy Controlled Sweeps is created automatically. a. In the Sales tab, select the Sweep Management > Policy-Controlled Sweeps folder in the left pane. b. In the Policy Controlled Sweeps tab in the right pane, verify that an item is listed.

c. Click the item, and observe its properties for each tab. d. In the Subscribers tab, verify that the policy that you created is listed.

3. Examine the documents: a. In Sales tab, expand Sales > Browse> RootFolder and click TestBulkMove folder. b. In the TestBulkMove tab, verify that all four documents belong to PriceQuote Class are deleted from the folder.




8-21

Student Exercises

4. Examine the File Storage Area. a. In Sales tab, expand Sales > Administrative and click Storage Areas. The Storage Areas tab opens and all the available storage areas are listed. b. In the Storage Area tab, verify that the PurchaseOrderFileStorageArea (from where you deleted the files) shows o file count.

5. Log out of the Administration Console for Content Platform Engine and close the browser. Information You can also search for the documents of the PriceQuote class and verify that they are deleted.





EXempty

Unit 9. System Maintenance Unit Overview Lessons Lesson 9.1, "Perform Searches and Bulk Actions," on page 9-3 Lesson 9.2, "Work With Audit Logs," on page 9-17 Lesson 9.3, "Work with System Logs," on page 9-31



Unit 9. System Maintenance


9-1

Student Exercises

9-2





EXempty

Lesson 9.1. Perform Searches and Bulk Actions Overview Why is this lesson important? Changing business needs require that you find and modify the security of many existing documents. You must find many existing documents and file them in a specified folder. You must create a search with a bulk action that performs these tasks.

Activities • Use Bulk Actions to Modify Security: Procedure, on page 9-5 • Practice Using Bulk Actions: Exercise, on page 9-15

User accounts Type

User ID

Password

Operating system

administrator

passw0rd


P8Admin

IBMFileNetP8

Security administrator

cn=root

IBMFileNetP8

Marketing manager

Mark

filenet

Note All passwords are case-sensitive.




9-3

Student Exercises

9-4





EXempty

Use Bulk Actions to Modify Security: Procedure Introduction In this exercise, you use a search with a bulk action to modify security on existing documents.

Scenario Your company was reorganized. You have a new Marketing team. You must create a new Marketing group and then modify security on marketing documents to provide group members special permissions.

Procedures Procedure 1, "Create the Marketing security group," on page 9-5 Procedure 2, "Create a search for marketing materials," on page 9-7 Procedure 3, "Create and run bulk actions," on page 9-7 Procedure 4, "Verify security change," on page 9-8 Procedure 5, "Use a batch operation to modify security," on page 9-9 Procedure 6, "Verify the security change," on page 9-11 Procedure 7, "Use FileNet Enterprise Manager (optional)," on page 9-12 Procedure 8, "Review the search results," on page 9-13

Procedure 1: Create the Marketing security group You can create the Marketing group by using Tivoli Directory Server. 1. Use Internet Explorer to go to the Tivoli Directory Server website: - http://localhost:9080/IDSWebApp 2. Sign in to Tivoli Directory Server as root: - User DN: cn=root - Password: IBMFileNetP8 3. Click Directory Management > Manage entries.




9-5

Student Exercises

4. Click the plus sign (+) to expand o=sample.

5. Expand cn=groups. 6. Click Add to add a group. 7. On the Select object class page, do the following steps: a. Select groupOfUniqueNames from the Structural object classes menu. b. Click Next. 8. On the Select auxiliary object classes page, click Next. 9. On the Required attributes page, enter the following data: a. Relative DN: CN=Marketing b. cn: Marketing c. uniqueMember: CN=mark,cn=users,o=sample

10. Click Next. 11. On the Optional attributes page, click Finish. 12. Click No to add a similar entry. 13. Close Internet Explorer.

9-6





EXempty

Procedure 2: Create a search for marketing materials 1. Using Firefox, sign in to Administration Console for Content Platform Engine: - URL: http://ecmedu01:9080/acce 2. Log in as p8admin: - User name: p8admin - Password: IBMFileNetP8 3. Open Object Stores > Sales. 4. Click Search. 5. Click New to create a new search. 6. On the Simple View tab, create a search with the following criteria: - Column: Document Title - Condition: Starts With - Value: Marketing

Procedure 3: Create and run bulk actions The search is open. Bulk actions are currently disabled. 1. Click the Bulk Actions tab. 2. Select Enable to enable bulk actions. 3. Scroll down to the Security area. 4. Select the Update security option. 5. Click Add. 6. On the Add Users and Groups page, add the Marketing group: a. Type Marketing in the search field. b. Click Search. c. Select the Marketing group. d. Move the Marketing group to Selected Users and Groups by using the right arrow. e. Click OK. 7. Scroll down to the permissions area to select the following permissions: - View all properties - Modify all properties - View content - Link a document/annotate - Publish - Create an instance © Copyright IBM Corp. 2013, 2015



9-7

Student Exercises

- Change state - Minor versioning - Major versioning - Read permissions 8. Click Save As. 9. Enter a Document title for your query (Example: Marketing search) and then click OK. 10. Refresh the saved search: a. Click the Saved Searches tab. b. Click Refresh. c. Reopen your saved search. Information The Search page does not auto-refresh, so when you save a new search, you must manually refresh the Searches page.

11. Click Run. 12. Click OK to close the Results notification. 13. Review the Search Results tab. Several documents are returned.

Procedure 4: Verify security change You ran a search that includes a bulk action. The action occurred as the search ran. Inspect one of the documents to ensure that the Marketing group was added to the document. The search results tab is open, displaying the results of the search. 1. Click the title of one of the documents in the Search Results table. 2. On the document properties page, click the Security tab. 3. Click Refresh. 4. Verify that Marketing is now displayed in the Access Control List. 5. Select the Marketing row.

9-8





EXempty

6. Click Edit. 7. Verify that the permissions match the permissions that you specified for this group in the bulk action.

8. Click Cancel. 9. Click Close.

Procedure 5: Use a batch operation to modify security The bulk action modified all of the documents that the search returned. Some documents remain, however, that the search did not return. You can use batch operations on these remaining documents to provide the Marketing group permissions. You are logged on to Administration Console for Content Platform Engine as P8admin. 1. In the Sales object store, go to Browse > Root Folder > Marketing. 2. Confirm that the folder contains several documents: - Documents that begin with “Marketing” were updated by the bulk action. - Remaining documents that begin with “Testfile” were not updated by the bulk action. 3. Select all of the documents in the Marketing folder that do not begin with “Marketing.”




9-9

Student Exercises

4. Select Actions > Batch Operations.

5. Open the Security tab. 6. Add the Marketing group by using the Add button. 7. Add the following permissions: - View all properties - Modify all properties - View content - Link a document/annotate - Publish - Create an instance - Change state - Minor versioning - Major versioning - Read permissions





EXempty

Important Ensure that the group is selected when you edit permissions.

8. Scroll to the bottom to click OK.

Procedure 6: Verify the security change You used a batch operation to give the Marketing group access to the remaining documents in the Sales > Marketing folder. You are now going to verify the change. You are logged on to Administration Console for Content Platform Engine as p8admin. The Sales > Marketing folder is open. 1. Click Testfile5.doc. 2. Open the Security tab. 3. Verify that the Marketing group has access to the document.

4. Select the Marketing row and then click Edit.




9-11

Student Exercises

5. Verify that the Marketing group has the correct permissions.

6. Click Cancel. 7. Click Close. 8. Log out of Administration Console for Content Platform Engine.

Procedure 7: Use FileNet Enterprise Manager (optional) You can also use the Query Builder in FileNet Enterprise Manager to perform bulk actions. This procedure is optional. You can use this procedure if Administration Console for Content Platform Engine is not working. 1. Start FileNet Enterprise Manager and connect to the P8 domain. 2. Expand the Sales object store. 3. Right-click Search Results and then select New Search. 4. Enter the following data: - Select From Table: Document - Column: Document Title - Condition: Starts With - Value: Marketing. 5. Select the Security tab. 6. Add the Marketing group: a. Click Add. b. Type Marketing in the search field. c. Click Find. d. Select Marketing. e. Click OK. 7. Add Permissions: a. Select the following permissions: 9-12 System Implementation and Administration




EXempty

- View all properties - Modify all properties - View content - Link a document/annotate - Publish - Create an instance - Change state - Minor versioning - Major versioning - Read permissions 8. Click OK to run the search. 9. Click OK to close the Query Status window.

Procedure 8: Review the search results You can review the results of your search and bulk action by using FileNet Enterprise Manager. 1. Right-click a document from the Search Results pane. 2. Click Properties. 3. Select the Security tab. 4. Select the Marketing group row.




9-13

Student Exercises

5. Verify that the Rights correspond to the Permissions that you added.





EXempty

Practice Using Bulk Actions: Exercise Introduction Practice the procedures that you learned by completing this exercise.

Scenario Mark, a member of the Marketing group, has left the company. He has left some documents checked out. You must cancel the checkout so that other users can edit these documents.

Challenge • As the user, Mark, check out some documents from the Sales object store. • Use a search with a bulk action that cancels checkout on all of the documents that Mark has checked out.

Data • The password for Mark: filenet.

Hints • Mark can check out only documents to which the Marketing group has major and minor versioning permissions. • Use the Last Modifier property in your search. • Use the Version Status = 3 as a criterion to confine the search to documents that are checked out. • Refresh the view if you do not see the changes.

Verification Verify that all of the documents that are checked out by Mark are no longer checked out.

Summary In this lesson, you did the following tasks: • Used a search with a bulk action to modify security on multiple objects. • Used a batch operation from within a folder to modify security on multiple objects. • Used a bulk action to cancel document checkouts.




9-15

Student Exercises





EXempty

Lesson 9.2. Work With Audit Logs Overview Why is this lesson important? As a Content Engine administrator, you must determine when event actions are successful and when they fail. You need to know how to configure auditing to log these event actions, search for the audit events, and manage the audit log size.


Before you begin: Exercise Setup, on page 9-19 Create an Audit Definition: Procedure, on page 9-21 Prune Audit Entries: Procedure, on page 9-27 Practice Audit Configuration: Exercise, on page 9-29

User accounts Type

User ID

Password

Operating system

administrator

passw0rd


P8Admin

IBMFileNetP8

Clerk

Clark

filenet





9-17

Student Exercises





EXempty

Before you begin: Exercise Setup Audit logs can be used to track which user altered an object, which can be a powerful tool in determining responsibility for changes. To demonstrate this capability, you are going to use a user account to change a property value. Before you begin this lesson exercise, you must change the security on existing Order documents on the Sales object store to allow clerks to edit Order properties.

Procedure 1: Change security on Order documents Using the skills that you learned in Lesson 9.1, "Perform Searches and Bulk Actions," on page 9-3, you are going to create a search with a bulk action that changes security on all documents of the Order class to allow Clerks to modify property values. Important In a production environment, do not run a search without specifying criteria. A search without criteria can affect performance. On your student system, there are only a few Order documents, so the search does not have a negative performance impact.

1. Using Firefox, sign in to Administration Console for Content Platform Engine: - URL: http://ecmedu01:9080/acce - User name: p8admin - Password: IBMFileNetP8 2. On the Sales object store, create a search: - Class: Order - Bulk Action: Update Security - Group to add: Clerks - Permissions: Allow Modify All Properties 3. Run the search. 4. Save the search template as Order Security. 5. Select any Order document in the Sales > Orders folder.




9-19

Student Exercises

6. Verify that Clerks have permission to modify all properties:.





EXempty

Create an Audit Definition: Procedure Introduction In this exercise, you add an audit definition to a custom document class. You update a document and then observe the audit history.

Scenario Order information is contained in the Order document class properties. You want to ensure that when someone updates a property value of an Order document, that the change is recorded in the audit log.

Procedures Procedure 1, "Enable auditing on the Sales object store," on page 9-21 Procedure 2, "Create an audit definition," on page 9-21 Procedure 3, "Make document updates," on page 9-23 Procedure 4, "View the audit history," on page 9-23 Procedure 5, "Create more audit entries," on page 9-24 Procedure 6, "Query the audit log," on page 9-25

Procedure 1: Enable auditing on the Sales object store You can enable and disable auditing at the object store level. Auditing is disabled by default. 1. Using Firefox, sign in to Administration Console for Content Platform Engine: - URL: http://ecmedu01:9080/acce 2. Log in as p8admin: - User name: p8admin - Password: IBMFileNetP8 3. Open Object Stores > Sales. 4. On General tab of the Sales object store properties page, select Yes from the Enable Auditing menu. 5. Click Save to save changes to the object store.

Procedure 2: Create an audit definition In this procedure, you create an audit definition on the Order custom document class. The Order class has two subclasses, so you must apply the audit definition to subclasses. You are signed into Administration Console for Content Platform Engine as p8admin. 1. From the Sales object store, go to Data Design > Classes > Document > Order.




9-21

Student Exercises

2. Open the Audit Definitions tab for the Order class. Hint If you do not see the Audit Definitions tab, use the arrows to scroll through the tabs.

3. Click New. 4. On the New Audit Definition page, enter the following information: - Display Name: Update. - Event: Update Event - Object State Recording Level: Modified object only. - Audit type: Success - Apply to Subclasses: checked - Is Enabled: checked

5. Click OK to create the Audit Definition. 6. Click Save to save the changes to the Order class definition. 7. Log off of Administration Console for Content Platform Engine.





EXempty

Procedure 3: Make document updates To view audit entries, you must update a document that is a member of the audited class. 1. Log on to IBM Content Navigator as Clark. - URL: http://ecmedu01:9080/navigator - User name: Clark - Password: filenet 2. From the Sales object store, open the Orders folder. 3. Select a document (Example: Order Basic A). 4. Click Properties. 5. Change a property value (Example: Amount_due). 6. Click Save. 7. Log out of IBM Content Navigator.

Procedure 4: View the audit history When auditing is enabled, you can view the audit history of an object to see which audited events took place. The audit log entries can tell you when the change was made, as well as who made the change. 1. Using Firefox, sign in to Administration Console for Content Platform Engine: - URL: http://ecmedu01:9080/acce 2. Log in as p8admin: - User name: p8admin - Password: IBMFileNetP8 3. Go to Sales > Browse> Root Folder > Orders. 4. Open the properties page for the document that you changed in the previous procedure. 5. Open the Audit History tab (you might need to scroll to the right to find it). 6. Verify that you can see at least one audit log entry that shows Clark as the creator.

7. Click the Update link to open the audit entry.




9-23

Student Exercises

8. Verify that you can see which properties were modified:

9. Close the Update tab.

Procedure 5: Create more audit entries You are going to query the audit log. In this procedure, you create some additional audit log entries so that the audit log has more entries. If you saved the query that you created in "Before you begin: Exercise Setup" on page 9-19, you can modify this query and rerun it to generate more events. If you did not save the query, recreate it before you proceed. You are logged in to Administration Console for Content Platform Engine as p8admin. 1. Open the Order Security search template that you created on "Before you begin: Exercise Setup" on page 9-19. - Search > Saved Searches > Order Security. 2. On the Bulk Actions tab, add the Minor versioning permission for the Clerks group. 3. Save the search. 4. Refresh the Search page: a. Close the Order Security tab. b. Click the Search page.

c. Click Refresh. d. Reopen the Order Security search. 5. Run the search.





EXempty

6. Verify that the security change took place by opening the Properties page of one of the returned Order documents. Ensure that Clerks have specific permissions for modifying properties and making minor versions.

7. If you do not see both permissions, do the following tasks: a. Click Refresh on the document information page. b. Recheck the permissions for the Clerks group. c. If that does not work, recheck and rerun the search. 8. Click Cancel to close the Edit Permissions page.

Procedure 6: Query the audit log In this procedure, you use the Search page to find audit log entries. You are logged in to Administration Console for Content Platform Engine as p8admin. 1. From the Sales object store, open the Search page. 2. Create a search with the following criteria: - Class: Object Change Event - Column: Date Created - Condition: Greater or Equal - Value: Yesterday’s date and any time. 3. In the Results area, select Audit Sequence in the Order By menu. 4. (Optional) Save the search. 5. Run the search. 6. Review the search results. - Verify that you can see several returns. - Verify that you can find the audit event that Clark created at the top of the returns list. 7. Click the ID of any of the audit entries to review the details.




9-25

Student Exercises

- The first entry was the event that was created when Clark changed a property value. - The remaining entries were created when p8admin updated security by using a bulk action. 8. Log out of Administration Console for Content Platform Engine.





EXempty

Prune Audit Entries: Procedure Introduction Audit logs can grow quickly and use up storage space if they are not pruned. You can prune the audit logs manually, by using a search template, or automatically by using an audit disposition policy. In this exercise, you create an audit disposition policy.

Procedures Procedure 1, "Create an audit disposition policy," on page 9-27 Procedure 2, "Configure the Audit Subsystem task," on page 9-28 Procedure 3, "Verify that the audit logs are deleted," on page 9-28 Procedure 4, "Configure an audit disposition schedule," on page 9-28

Procedure 1: Create an audit disposition policy In this procedure, you create an audit disposition policy that deletes all audit entries from the moment the task runs. 1. Using Firefox, sign in to Administration Console for Content Platform Engine: - URL: http://ecmedu01:9080/acce 2. Log in as p8admin: - User name: p8admin - Password: IBMFileNetP8 3. Open Object Stores > Sales > Administrative > Audit Disposition > Audit Disposition Policies. 4. Click New. 5. Name the Audit Disposition Policy: a. Type Audit Cleanup in the Name field. b. Click Next. 6. Set the Audit Disposition Policy parameters: a. Enter the following Disposition rule: DateCreated < Now() Information To establish an audit disposition policy with a longer time limit, add a TimeSpan expression. For example, DateCreated < Now () - TimeSpan(30, ‘Days’)




9-27

Student Exercises

b. Enable the audit disposition policy. c. Click Next. 7. On the Summary page, click Finish.

Procedure 2: Configure the Audit Subsystem task The audit subsystem controls the pruning of the audit events from the audit log. You can specify a schedule and configure parameters that control how the audit pruning process is run. The schedule specifies one or more time periods that determine when the audit subsystem task starts and how long it runs. You are logged on to Administration Console for Content Platform Engine as p8admin. 1. Open the Properties page for the P8Domain. 2. Open Audit subsystem tab. 3. Select Enable audit pruning. 4. Change the Wait Interval to 10 seconds. 5. Click Save.

Procedure 3: Verify that the audit logs are deleted You enabled audit log pruning. You configured the audit disposition policy to delete audit logs that are older than the time at which the task runs. After you enabled audit pruning at the domain level, the audit logs were deleted. Now you are going to verify the deletion. 1. In Administration Console for Content Platform Engine, go to the Sales object store. 2. Create a search for Object Change events or Deletion events. Optionally, you can rerun any of the audit event searches you saved from previous exercises. 3. Verify that the search returns zero results.

Procedure 4: Configure an audit disposition schedule You are going to apply a schedule to the Audit Disposition Policy so that the audit disposition sweep runs weekly. 1. In Administration Console for Content Platform Engine, open the P8domain node. 2. Open the Audit Subsystem node. 3. Scroll down to the Schedule area. 4. Click New. 5. Select a Day of the week, start time, and Duration. 6. Click OK. 7. Log off of Administration Console for Content Platform Engine.





EXempty

Practice Audit Configuration: Exercise Introduction In this exercise, you practice by using auditing and audit disposition skills.

Scenario The Loan department wants loan objects to be audited for Update and Deletion events. Loan object audit entries must be deleted after 30 days.

Challenge • Enable auditing on the LoanProcess object store. • Create audit definitions for Update and Deletion events on the Loan document class. • Create an audit disposition policy that deletes audit log entries older than 30 days.

Verification Create, update, and delete a Loan document. Search the audit log and review the audit entries. Verify that an event is created when you add the document, update the document property, and delete the document. Verify that you can save the audit disposition policy without receiving an error message.

Summary In this lesson you did the following tasks: • Created an audit definition. • Viewed the audit history of an object. • Queried the audit logs. • Created an audit disposition policy. • Created an audit disposition schedule. • Pruned audit log entries automatically.




9-29

Student Exercises





EXempty

Lesson 9.3. Work with System Logs Overview Why is this lesson important? As the system administrator, you need to be familiar with the logs that the IBM FileNet P8 Content Manager system uses. You must know how to monitor their contents and sizes. You must know how to archive log files. You must know how to enable extra logging in certain circumstances.

Activities • Configure Trace Logging: Procedure, on page 9-33

User accounts Type

User ID

Password

Operating system

administrator

passw0rd


P8Admin

IBMFileNetP8

User

Carol

filenet





9-31

Student Exercises





EXempty

Configure Trace Logging: Procedure Introduction In this exercise, you change trace logging options and then compare log entries and file sizes.

Procedures Procedure 1, "Preparation: remove log files," on page 9-33 Procedure 2, "Examine new log files," on page 9-33 Procedure 3, "View trace configuration," on page 9-34 Procedure 4, "Configure trace logging on the domain," on page 9-34 Procedure 5, "Configure trace logging at the site," on page 9-35 Procedure 6, "Inspect the trace log files," on page 9-36 Procedure 7, "Create trace log entries," on page 9-36 Procedure 8, "Disable trace logging," on page 9-37

Procedure 1: Preparation: remove log files Before you change the trace options, you are going to save the existing log files in order to compare them with the log files that are generated after tracing. 1. Stop WebSphere Application Server: a. Open the WebSphere Admin folder on your desktop. b. Double-click Stop the Server.bat. c. Wait for the operation to complete. 2. Use Windows Explorer to go to C:\Program Files\IBM\WebSphere\AppServer\profiles\AppSrv01\FileNet\server1 3. Create a folder in this directory named Archived Logs. 4. Move all of the *.log files in the server1 folder to the Archived Logs folder. 5. Minimize this folder so that you can later access it easily. 6. Start WebSphere Application Server: a. Double-click the Start the Server.bat file in the WebSphere Admin folder. b. Wait for the operation to complete.

Procedure 2: Examine new log files If no log files exist in the server1 folder when Content Platform Engine starts, new log files are generated. 1. Restore the server1 folder. © Copyright IBM Corp. 2013, 2015



9-33

Student Exercises

2. Examine the log files. For each log file, do the following actions: - Note the size of each file. - Open each file with Notepad and examine the entries. 3. Verify that no p8_server_trace.log exists. Trace logging is disabled. 4. Close all log files. 5. Minimize this folder so that you can later access it easily.

Procedure 3: View trace configuration Trace logging options can be set on the domain or at the site level. If the settings are configured on the site, they override the settings on the domain. On your student system, trace logging is configured at the site level. You are going to verify these settings. 1. Using Firefox, sign in to Administration Console for Content Platform Engine: - URL: http://ecmedu01:9080/acce 2. Log in as p8admin: - User name: p8admin - Password: IBMFileNetP8 3. On the P8Domain object, open the Trace Subsystem tab. 4. Verify that trace logging is disabled. 5. Go to Global Configuration > Administration > Sites > Initial Site. 6. On the Initial Site object, select the Trace Subsystem tab. 7. Verify the current settings: - Configuration source: Initial Site (this object). - Enable trace logging: disabled - Log file location: c:\temp\tracelogs

Procedure 4: Configure trace logging on the domain Trace logging is configured at both the site level and the domain level. You are going to configure trace logging at the domain level, and then configure the site to inherit these settings. 1. Select P8Domain (server hierarchy object). 2. Enable trace logging at the top of the Trace Subsystem page. 3. Select the Detail level trace options for the following subsystems: - Code module trace flags - Database trace flags - EJB trace flags - Error trace flags





EXempty

- Security trace flags

Important Log files at the Detail level grow quickly. In production, be specific about which subsystems to enable. Also, remember to disable trace logging when you no longer need it.

4. Click Save to save the P8Domain configuration. 5. Click OK to accept the default log file location.

Procedure 5: Configure trace logging at the site You enabled trace logging on the domain, but no trace logs exist because the settings are overridden at the site level. You are going to configure the site to inherit the domain settings. 1. Go to Global Configuration > Administration > Sites > Initial Site. 2. On the Initial Site object, select the Trace Subsystem tab. 3. Select P8Domain (server hierarchy object) as the configuration source. 4. Click OK to close the Warning Message. 5. Click Save to save the site settings. 6. Log out of Administration Console for Content Platform Engine.




9-35

Student Exercises

Procedure 6: Inspect the trace log files By default, trace logs are generated in the same location as the Content Platform Engine log files. With trace options enabled, the log files are already being generated. 1. Using Firefox, open the CE Ping page. - http://ecmedu01:9080/FileNet/Engine 2. Copy the log file location. 3. Use Windows Explorer to open the folder that contains the log files. - C:\Program Files\IBM\WebSphere\AppServer\profiles\AppSrv01\FileNet\server1 4. Verify that p8_server_trace.log exists. Note The size of the file is already large compared to the other log files.

5. Use Notepad to open the p8_server_trace.log file to inspect the contents. 6. Verify that the file contains DEBUG level entries. 7. Close p8_server_trace.log.

Procedure 7: Create trace log entries You enabled security trace logging. You are going to log in to IBM Content Navigator as Carol and then check the trace log file for this entry. 1. Use Firefox to log on to IBM Content Navigator as Carol. - http://localhost:9080/navigator - User name: Carol. - Password: filenet 2. Log out from IBM Content Navigator. 3. Use Windows Explorer to open the folder that contains the log files. - C:\Program Files\IBM\WebSphere\AppServer\profiles\AppSrv01\FileNet\server1 4. Use Notepad to open the p8_server_trace.log file. 5. Search for the word “Carol.” 6. Review the entry. Several log entries show Carol’s login event.

7. Close the p8_server_log file.





EXempty

Procedure 8: Disable trace logging Disable trace logging unless you are using it to troubleshoot a particular problem. Trace logging affects system performance and uses disk space. 1. Using Firefox, sign in to Administration Console for Content Platform Engine: - URL: http://ecmedu01:9080/acce 2. Log in as p8admin: - User name: p8admin - Password: IBMFileNetP8 3. On the P8Domain object, open the Trace Subsystem tab. 4. Clear the Enable trace logging option. 5. Save the changes to the P8Domain. 6. Log off from Administration Console for Content Platform Engine.

Summary In this lesson, you did the following tasks: • Enabled trace logging. • Configured trace logging options at the domain level and site level. • Inspected trace logs. • Disabled trace logging.




9-37

Student Exercises





Appendix A. Create a DB2 database

EXNoSideHead

Introduction This exercise gives you the opportunity to practice creating a DB2 database. In this activity, you create a standard DB2 database, increase two HEAP configuration parameters, and add several different types of temporary table spaces.

User accounts Application name

User ID

Password

DB2 Control Center

p8admin

IBMFileNetP8

Configuration Manager

p8admin

IBMFileNetP8

Important In this activity, you create a simple database suitable for training purposes and for a single user development system. Your Database Administrator creates a database for your organization requirements.

Procedures Procedure 1, "Create a target database," on page A-1 Procedure 2, "Change database configuration parameters," on page A-5 Procedure 3, "Configure a MARK_TS table space," on page A-7 Procedure 4, "Configure user temporary table space," on page A-10 Procedure 5, "Configure a system temporary table space," on page A-11 Procedure 6, "Stop and start the database," on page A-13

Procedure 1: Create a target database 1. Start the DB2 Control Center. a. Click Start > All Programs > IBM DB2 > TDSV63DB2 (Default) > General Administration Tools > Control Center. The Control Center window opens. b. In Control Center View window, Leave the default value Advanced and click OK.




A-1

Student Exercises

2. In the left pane, expand All Databases. a. A list of databases is shown in the left pane.

3. Run the Create Database wizard. a. Verify that in the left pane the All Databases node is selected. b. From the menu bar, click Selected > Create Database > Standard.

A Create Database wizard window opens. 4. Complete the Specify a name for your new database page. a. In the Database name field, type MARKDB as the database name. b. Leave the default value C:\ for the Default path. c. Enter MARKDB in the Alias field. d. Enter Marketing Database in the Comment field. e. Leave the default option Let DB2 manage my storage (automatic storage). f.

Select 32 K from the Default bufferpool and table space page size selection list. Important

The 32 K Default bufferpool and table space page size selection is necessary because 32 KB is the minimum page size that is required for Content Platform Engine databases.

g. Click Next.

A-2





EXNoSideHead

5. Complete the Specify where to store your data page. a. Select the following check box if not already selected: Use the database path as a storage path: C:\ b. Click Next. 6. Complete the Specify the locale for this database page. a. Leave the following default values for the Database locale pane. • Country/Region: default • Territory: US b. Select UTF-8 from the list for the Code set field. Important Verify that you select UTF-8 code set. If any other option is selected, the object store creation fails when you use this database.

c. Leave the Collating Sequence default option System. d. Click Next.




A-3

Student Exercises

7.Complete the wizard. a.Click Finish in the Review the actions that will take place page when you click Finish page. b.The wizard closes, and a small Progress window is displayed for up to several minutes until the database is created. c.A DB2 Message window is shown that indicates that the command completed successfully. Click Close. d. Verify that the MARKDB database is listed in the DB2 Control Center under the All Databases folder. 8. Add the OSDBUSER user. a. In the left pane of the Control Center, expand MARKDB > User and Group Objects. b. Select the MARKDB > User and Group Objects > DB Users node. c. Click Selected > Refresh from the top menu. Observe that ADMINISTRATOR and P8ADMIN are listed in the upper right pane. Troubleshooting If the P8ADMIN user is not listed, refresh it again. If the P8ADMIN user is not shown even after refresh, you must restart the database as given in the procedure 6 in this activity.

d. In the lower right window, click the Add New User link.

The Add User window opens with the Database tab selected. e. Select ODDBUSER from the User selection list. f.

In the Authorities pane, select the following two check boxes. • Connect to database • Create tables

g. Click OK and close the window. A-4





9. Add or edit the P8ADMIN user. EXNoSideHead a. Select the MARKDB > User and Group Objects > DB Users node in the left pane. b. Select P8ADMIN from the DB Users list in the upper right pane. c. If P8ADMIN is not listed, add the user by repeating the steps 8d-8e. d. Click Change User Privileges from the lower right pane. e. In the Change User - P8ADMIN page > Authorities section, select the following three check boxes. • Connect to database • Create tables • Security administrator authority f.

Click OK to close the window.

g. In the main Control Center window, Verify that three users are listed

Procedure 2: Change database configuration parameters 1. Increase the Application heap size parameter. a. In the left pane of the Control Center, select the MARKDB node. b. Click Selected > Configure Parameters from the top menu bar. The Database Configuration window opens. c. Scroll down to the Performance section and select the APPLHEAPSZ entry. Information The APPLHEAPSZ parameter defines the number of private 4 KB memory pages for use by the database management system on behalf of a program (agent or subagent).




A-5

Student Exercises

d. Click on the Value column. Click the ellipse.

e. The Change Database Configuration Parameter window opens. Type 2560 in the Application heap size field. You increase the value by 10 fold.

f.

Leave the default check box selections: • Set automatically by DB2 • Update when available (Dynamic)

g. Click OK. Note Configuration parameter changes take effect after the database is stopped and restarted. Complete all the changes in the following steps and then restart the database.

2. Increase the SQL statement heap size parameter. a. In the Database Configuration window, scroll down to the Performance section and select the STMTHEAP entry. b. Click on the Value column. c. Click the ellipse to open the Change Database Configuration Parameter window.

A-6





EXNoSideHead

Information

The STMTHEAP parameter defines the number of 4 KB memory pages for the workspace that is used for the SQL compiler during compilation of an SQL statement.

d. Verify and enter 8192 in the Statement heap size field.

e. Leave the default check box selections and click OK. - Set automatically by DB2 - Update when available (Dynamic) f.

Click OK.

3. Apply the configuration parameter changes. a. In the Database Configuration window, click OK. b. Verify that a DB2 Message window is displayed indicating that the configuration settings were updated successfully.

c. Click Close.

Procedure 3: Configure a MARK_TS table space Use the following instructions to drop the USERSPACE1 table space and add a new table space. 1. View the list of database table spaces. a. In the Control Center, expand the MARKDB database. b. Select Table Spaces.




A-7

Student Exercises

Several table spaces are listed in the upper right pane.

2. Drop USERSPACE1. a. Select USERSPACE1 and then click Selected > Drop from the menu bar. b. A Confirmation window is opened. Click OK.

3. Create a table space. a. In the lower right pane, click the Create New Tablespace link that is under the Table Spaces folder icon.

The Create table Space wizard window opens. 4. Specify a name for you new table space page. a. Type MARK_TS in the Table space name field. b. Leave the default option of Let DB2 manage my storage (automatic storage).

c. Click Next.

A-8





5. Specify the type of table space you want to create. EXNoSideHead a. Note the four options on this page. • • • •

Regular Large System temporary User temporary

b. Select the Large option and click Next. 6. Specify a buffer pool for your new table space. a. Leave the default Buffer Pool named IBMDEFAULTBP. b. Click Next. 7. Specify the extent and prefetch sizes for this table space. a. Leave the default Determining recommended settings panel option: • Between 200 MB and 2 GB. b. Leave the Recommended settings panel options: • Extent size of 16 32 KB pages. • Prefetch size of 16 32 KB pages. c. Click Next. 8. Describe hard drive specifications. a. In the Determining your specifications and calculated settings panel, select the Server (SCSI) option: b. Click Next. 9. Review the actions that will take place when you click Finish. a. Verify that the entries match what your previous selections specified.




A-9

Student Exercises

b. Click Finish. A DB2 Message window opens.

10. Verify that the command completed successfully and click Close. The new MARK_TS table space is listed in the upper right pane.

Procedure 4: Configure user temporary table space 1. Create a temporary table space. a. In the lower right pane, under the Table Spaces folder icon click the Create New Tablespace link. The Create table Space wizard window opens. 2. Complete the Specify a name for you new table space page. a. Type USERTEMP1 in the Table space name field. b. Leave the default option of Let DB2 manage my storage (automatic storage). c. Click Next. 3. Specify the type of table space you want to create. a. Select the User temporary option. b. Click Next. 4. Specify a buffer pool for your new table space. a. Leave the default Buffer Pool named IBMDEFAULTBP. • Default Table space page size value: 32 KB. b. Click Next.

A-10 System Implementation and Administration




5. Specify the extent and prefetch sizes for this table space. EXNoSideHead a. Leave the default Determining recommended settings option of Between 200 MB and 2 GB. b. Leave the Recommended settings panel options: • Extent size of 16 32 KB pages. • Prefetch size of 16 32 KB pages. c. Click Next. 6. Describe hard drive specifications. a. In the Determining your specifications and calculated settings panel, select the Server (SCSI) option. b. Click Next. 7. Review the actions that will take place when you click Finish. a. Verify that the entries match what your previous selections specified.

b. Click Finish. A DB2 Message window opens. 8. Verify that the command completed successfully and click Close. The new USERTEMP1 table space is listed in the upper right pane.

Procedure 5: Configure a system temporary table space 1. Create a system temporary table space. a. In the lower right pane, under the Table Spaces folder icon click the Create New Tablespace link. The Create table Space wizard window opens. 2. Specify a name for you new table space. a. Enter TEMPSYS1 in the Table space name field. © Copyright IBM Corp. 2013, 2015



A-11

Student Exercises

b. Leave the default option of Let DB2 manage my storage (automatic storage). c. Click Next. 3. Specify the type of table space you want to create. a. Select the System temporary option. b. Click Next. 4. Specify a buffer pool for your new table space. a. Leave the default Buffer Pool named IBMDEFAULTBP. b. Leave the default Table space page size value of 32 KB. c. Click Next. 5. Specify the extent and prefetch sizes for this table space. a. Leave the default Determining recommended settings option of Between 200 MB and 2 GB. b. Leave the Recommended settings panel options: • Extent size of 16 32 KB pages. • Prefetch size of 16 32 KB pages. c. Click Next. 6. Describe hard drive specifications. a. In the Determining your specifications and calculated settings panel, select the Server (SCSI) option. b. Click Next. 7. Review the actions that will take place when you click Finish. a. Verify that the entries match what your previous selections specified.

b. Click Finish. A DB2 Message window opens. 8. Verify that the command completed successfully and click Close.





EXNoSideHead The new TEMPSYS1 table space is listed in the upper right pane.

Procedure 6: Stop and start the database 1. Stop the database. a. In the left pane of the Control Center, select MARKDB. b. Click Selected > Stop from the menu bar. The Confirm Stop window opens.

c. Click OK. After a few moments a DB2 Message window opens. d. Verify that the stop command completed successfully and click Close. 2. Start the database server. a. In the left pane of the Control Center, verify that MARKDB is selected. b. Click Selected > Start from the menu bar. After a few moments a DB2 Message window opens. c. Verify that the start command completed successfully and click Close. 3. Close the DB2 Control Center. From the menu bar, click Control Center > Exit.




A-13

Student Exercises





Appendix B. Optional Content

EXNoSideHead

Introduction These lessons are optional lessons that you can study if you have time.

Lessons • • • • •

Appendix B.4, "Create a Custom Root Class," on page B-3 Appendix B.5, "Configure a Change Preprocessor," on page B-27 Appendix B.6, "Configure an External Data Service," on page B-49 Appendix B.7, "Work with Content Caches," on page B-65 Appendix B.8, "Use System Dashboard," on page B-89




B-1

Student Exercises

B-2





Lesson EXNoSideHead

B.4. Create a Custom Root Class




B-3

Student Exercises

Lesson

Create a Custom Root Class • Why is this lesson important to you? – As a Solution Builder, you need object classes to store customer accounts, customer policies, and policy data. You plan to store this data as property values of the objects since you do not need content storage. The volume of customer information is expected to be high which can reduce retrieval performance. – Each custom root class uses its own data table and helps optimize the retrieval performance. You must create custom root classes for storing customer, account, and policy data.

© Copyright IBM Corporation 2013

Figure B-1. Create a Custom Root Class

F1156.0

Notes:

B-4





EXNoSideHead

Create a Custom Root Class

Activities that you need to complete • Create Custom Root Classes.


Figure B-2. Activities that you need to complete

F1156.0

Notes: These are the activities that you are going to perform in this lesson.




B-5

Student Exercises


What are Custom Root Classes? • Custom root classes – Are a specialized set of classes. – Can be customized by subclassing and adding properties. – Can be renamed and deleted.

• Each subclass exists in a separate database table. • Custom root classes are different from regular classes: – – – –

Not containable. Do not carry content. Not versionable. Do not support lifecycle function.

• You can create a custom root subclass. – From one of the abstract class definitions that are supplied by the FileNet P8 system. © Copyright IBM Corporation 2013

Figure B-3. What are Custom Root Classes?

F1156.0

Notes: Help paths • IBM FileNet P8 Version 5.2 Information Center > Administering FileNet P8 > Administering Content Platform Engine > Adding documents and objects > Classifying documents > Classes > Class overview > Custom root classes • IBM FileNet P8 Version 5.2 Information Center > Developing IBM FileNet P8 applications > Content Engine Development > Content Engine Java and .NET Developer's Guide > Custom Root Classes > Custom Root Classes Concepts The following limitations exist with custom root classes: • Cannot query across custom root classes. You can only search specific classses (that are in one data table). • Cannot change the class of a custom root object to another class that does not fall under the same custom root class. Because it requires spanning different tables. • Custom root instances cannot be contained in Folders. If you need containment, use CustomObject.

B-6





• No support for content bearing instances. If you need to store content, use Document (or EXNoSideHead Annotation) • Properties of custom root instances are not full-text indexable.




B-7

Student Exercises


What are Abstract Class Definitions? • Abstract class definitions – Are special system classes. – Can be used to create custom root subclasses. – Cannot be queried. – Cannot create instances. • You create custom root classes from the following abstract class definitions: – CmAbstractPersistable • Replication and subscribable – CmAbstractQueueEntry • Compatibility with queue sweep tasks. – CmAbstractSequential • Support for objects to be processed in chronological order. • Allows custom applications that require custom queue processing. © Copyright IBM Corporation 2013

Figure B-4. What are Abstract Class Definitions?

F1156.0

Notes: Help path • IBM FileNet P8 Version 5.2 Information Center > Administering FileNet P8 > Administering Content Platform Engine > Adding documents and objects > Classifying documents > Classes > Class overview > Custom root classes CmAbstractPersistable It provides replication and subscribable functionality (event targets, change preprocessing and auditing) Examples: Social Collaboration: Tags, Comments, Recommendations, Download Counts

B-8





EXNoSideHead


Abstract Custom Root Classes Hierarchy Independently Persistable Object

Abstract Sequential

Queue Item

Abstract Queue Entry

Subscribable

Storage Area

Replicable

Abstract Persistable

Link Containable

AP1 Custom Object

AP1a

AP2 AP1b

AP2a


Figure B-5. Abstract Custom Root Classes Hierarchy

F1156.0

Notes: The diagram shows where the abstract custom root classes participate. The three purple dotted lined rectangles represents abstract custom root classes. You can not instantiate these abstract classes. But you can create subclasses of these abstract classes which will result in custom root class which you can instantiate. The AbstractSequential and AbstractQueueEntry classes are independently persistable. The AbstractPersistable class is both subscribable and replicable. This is the most commonly used abstract custom root class. In this scenario, each of the custom root classes (AP1 and AP2) have their own database table. All the subclasses of AP1 (AP1a and AP1b) will be stored in the same table as AP1.




B-9

Student Exercises


Abstract Sequential Class • Abstract Sequential Class provides Support for the objects that must be processed in chronological order. – Ordered rows by implementing a column sequence for every insert.


Figure B-6. Abstract Sequential Class

F1156.0

Notes: The screen capture shows the SEQNUM_IDENTITY field in a database table in DB2 Control Center. The second screen capture shows the Sequence Number property for an object of a custom root class (Abstract Sequential class) in the Administration Console for Content Platform Engine.

B-10 System Implementation and Administration




EXNoSideHead


Benefits of Custom Root Classes • Each custom root subclass exists in a separate table in the object store database. – This arrangement offers high performance and scalability.

• Faster retrieval rates – You can apply the index specific for the set of classes that are more closely related. – It results in faster retrieval rates because the indexed columns are less likely to contain null values since the columns are more tightly coupled at a logical level.

• You can manage data storage easily. – Less risk of reaching row-length limits (Example: table overflow). – Fewer null columns.

• Content Platform Engine auto-creates and auto-deletes tables (and related objects) to manage the custom root classes. © Copyright IBM Corporation 2013

Figure B-7. Benefits of Custom Root Classes

F1156.0

Notes: Creation of custom root class establishes that all instances of a class and its subclasses be stored in a table used solely for that class hierarchy's persistence. For example, all your customer data could be stored in one table and all the order data in a separate table and so on. With the Generic table, the stored classes can become unrelated, but not so much with well-designed custom root classes.




B-11

Student Exercises


How to create Custom Root Classes? • The procedure for creating a new custom root class is identical to creating any subclass. – The Content Platform Engine creates separate database tables.


Figure B-8. How to create Custom Root Classes?

F1156.0

Notes: The screen capture shows how to create a custom root class in the Administration Console for Content Platform Engine.





EXNoSideHead


Activities In your Student Exercises • Unit: Build an Object Store • Lesson: Create a Custom Root Class • Activities: • Create Custom Root Classes.


Figure B-9. Activities

F1156.0

Notes: Use your Student Exercises to perform the activities listed.




B-13

Student Exercises





Exercise EXNoSideHead

B.4, "Create a Custom Root Class"

Introduction In this activity, you create custom root classes and subclasses and examine the database tables. You also create Abstract Sequential type custom root class and observe the Sequence Number property.

Why is this lesson important to you? As a Solution Builder, you need object classes to store customer accounts, customer policies, and policy data. You plan to store this data as property values of the objects since you do not need content storage. The volume of customer information is expected to be high which can decrease retrieval performance. Unlike other classes, each custom root class uses its own data table and helps optimize the retrieval performance. You must create custom root classes for storing customer, account, and policy data.

Activities • Exercise B.4, "Create a Custom Root Class", on page B-15


User ID

Password


p8admin

IBMFileNetP8


Procedures Procedure 1, "Create property templates," on page B-16 Procedure 2, "Create custom root classes," on page B-17 Procedure 3, "Verify the database table," on page B-18 Procedure 4, "Create an instance (object) of the class," on page B-19 Procedure 5, "Create a Customer class," on page B-21 Procedure 6, "Create a class of Abstract Sequential," on page B-21 Procedure 7, "Delete the class and verify the database table," on page B-24 © Copyright IBM Corp. 2013, 2015



B-15

Student Exercises

Procedure 1: Create property templates In this procedure, you create property templates for custom root classes. 1. Start the Administration Console for Content Platform Engine. a. In a Firefox browser, go to http://ecmedu01:9080/acce b. Log in as the P8admin user (password: IBMFileNetP8) 2. Open the New Property Template wizard. a. In the administration console, expand the P8Domain > Object Stores node on the left pane and click Marketing. b. In the Marketing tab, expand the Marketing > Data Design node on the left pane and click Property Templates. c. In the Property Templates tab on the right pane, click New. d. The New Property Template tab opens. 3. Name and Describe the Property Template. a. In the New Property Template tab, enter customer_name for the Display name field. b. Click outside of the Display name field. Verify that the Symbolic name and Descriptions fields are automatically populated. c. Optionally, edit the Description. Click Next. 4. Select the data type. a. Select String from the list for the data type field. b. Click Next. 5. Select Choice List or Marking Set. a. Select from the list for both the fields. b. Click Next. 6. Complete the Single or Multi-Value page. a. Select the Single option for the Single or Multi-Value. b. Click Next. 7. Complete the wizard. a. In the Summary page, view the details and click Finish. b. In the Success page, click Close. 8. Verify that the new property template is listed. a. Click the Property Templates tab and click Refresh. b. Scroll down and verify that the customer_name item is listed.





9. Create two more property templates. Use the data provided in the tables. Use default values for EXNoSideHead other fields. Field

Value


loan_amount loan_amount loan_amount

Data type

Float


Single

Field

Value


home_type home_type home_type

Data type

Integer

Select a Choice List

none, Leave default (blank)


Single

10. Verify that the new property templates are listed.

Procedure 2: Create custom root classes 1. Open the New Abstract Persistable Class wizard. a. If needed, in the administration console > P8Domain tab, expand the P8Domain > Object Stores node on the left pane and click Marketing. b. In the Marketing tab, expand the Marketing > Data Design > Classes > Other Classes node on the left pane. c. Right-click Abstract Persistable and select New Class from the list. d. The New Abstract Persistable Class tab opens. 2. Name and Describe the Class. a. Enter Loan for the Display name field. b. Click outside of the Display name field. Verify that the Symbolic name and Descriptions fields are automatically populated. c. Optionally edit the Description. d. Click Next. 3. Complete the wizard. a. In the Summary page, click Finish. b. In the Success page, click Close.




B-17

Student Exercises

4. Verify that the new custom root lass is listed. a. In the Marketing tab, click Refresh. b. If needed, expand the Marketing > Data Design > Classes > Other Classes > Abstract Persistable node. c. Verify that the Loan class is listed. 5. Add Property Definitions to the class. a. Click Loan in the left pane. The Loan tab opens in the right pane. b. Select the Property Definitions subtab. c. Click Add. d. In the Add Properties page, select the following properties: • customer_name • loan_amount e. Click OK. f.

Verify that the properties are listed.

g. Click Save and then Close. 6. Leave the administration console opened for other procedures.

Procedure 3: Verify the database table In this procedure, you examine database tables that are created when you create custom root classes. 1. Start the DB2 Control Center. a. Click Start > All Programs > IBM DB2 > TDSV63DB2 (Default) > General Administration Tools > Control Center. The Control Center window opens. b. In Control Center View window, Leave the default value Advanced and click OK. 2. Open the MARKDB database tables. a. In the left pane, expand All Databases > MARKDB and click Tables. b. Right-click the MARKDB > Tables and click Refresh.





EXNoSideHead c. In the right pane, scroll down and verify that a table called UT_Loan is created.

d. Leave the DB2 Control Center opened for other procedures. 3. Create a subclass for the Loan class in the administration console. Use the data in the table. Field

Value


HomeLoan

Add Properties

home_type

4. Verify the database tables in the DB2 Control Center. a. Refresh the table view. b. Right-click the MARKDB > Tables and click Refresh. c. Verify that no table (called UT_HomeLoan) is created because HomeLoan is a subclass of Loan class and not the custom root class. d. Leave the DB2 Control Center opened for other procedures.

Procedure 4: Create an instance (object) of the class 1. Create an instance (object) of HomeLoan in the administration console. a. If needed, in the Marketing tab, expand the Marketing > Data Design > Classes > Other Classes > Abstract Persistable > Loan node on the left pane. b. Right-click HomeLoan and select Create Instance from the list.

c. The New HomeLoan tab opens. d. Enter John Smith for the customer_name field and 100000 for the Loan_amount field.




B-19

Student Exercises

e. Click Next.

f.

In the Summary page, click Finish.

g. In the Success page, click Close. 2. View the object. Since the custom root class objects are not filed in the folders, you must do a search to view the object. a. In the Marketing tab, click Marketing > Search on the left pane.

b. In the Saved Searches tab, click New. c. Click Run. d. Click OK to close the Message about running a query without a WHERE clause. Note Because there is only one document object for this class, you do a simple search. When there are many documents, narrow the results by specifying Query criteria.

e. Verify that an object is listed.





3. Use the scroll bar at the bottom of the page to verify that the property values that you entered EXNoSideHead are shown.

4. Close the Search tab. Do not save the search.

Procedure 5: Create a Customer class In this procedure, you create another custom root class of the Abstract Persistable class type and use it in the next procedure. 1. Create a custom root class in the administration console. Use the data provided. Field

Value

Class Type

Abstract Persistable


Customer

Add Properties

customer_name

2. Optional step: Verify the database tables are in the DB2 Control Center. a. Refresh the table view. b. Verify that UT_Customer table is created because Customer is a custom root class.

Procedure 6: Create a class of Abstract Sequential In this procedure, you create a custom root class of Abstract Sequential and examine the Sequence Number property. 1. Create a property template in the administration console. a. In the Marketing tab, expand the Marketing > Data Design node on the left pane and click Property Templates. b. In the Property Templates tab on the right pane, click New.




B-21

Student Exercises

c. Use the data provided in the table. Field

Value


customer_info customer_info customer_info

Data type

Object


Single

d. In the Property Templates tab, click Refresh. e. Scroll down and verify the property template that you created is listed. 2. Create the class in the administration console. a. In the Marketing tab, expand the Marketing > Data Design > Classes > Other Classes node on the left pane. b. Right-click Abstract Sequential and select New Class from the list. c. The New Abstract Sequential Class tab opens. d. Complete the wizard with the data provided in the table. Field

Value


Order

e. In the Marketing tab, click Refresh. 3. Verify the class that you created is listed. a. In the Marketing tab, expand the Marketing > Data Design > Classes > Other Classes > Abstract Sequential node on the left pane. b. Click the Order class in the left pane. The Order tab opens in the right pane. 4. Add Property Definition to the class. a. In the Order tab, select the Property Definitions subtab. b. Click Add. c. In the Add Properties page, scroll down and select the customer_info property. d. Click OK. Verify the property that you selected is listed. 5. Configure the Property definition. a. Click the customer_info property.





EXNoSideHead b. In the Property Definition page > More tab > Required class field, select Customer.

c. For Target access required, select the first three options.

d. Click OK. e. In the Order tab, click Save and then click Close. 6. Optional step: Verify the database tables the DB2 Control Center. a. Refresh the table view. b. Verify that the UT_Order table is created because Order is a custom root class.

7. Create instances (objects) of Order in the administration console. a. In the Marketing tab, expand the Marketing > Data Design > Classes > Other Classes > Abstract Sequential node on the left pane. b. Right-click Order and select Create Instance from the list. c. The New Order tab opens. d. Click Next and then click Finish. e. In the Success page, click Close. 8. Repeat Step 7 to create three more instances of this class. 9. Verify the instances in the administration console. a. Go to the Search page. b. Click New. c. Select Order from the Class menu.




B-23

Student Exercises

d. Select Sequence Number from the list for the Order by field. Select the Ascending option.

e. Click Run. f.

Verify that four objects are listed in the Search Results. Information

The Sequence Number value is assigned by the system for the Abstract Sequential class in the sequence of the objects created. In this case, the value can be used as the order number to keep track of the orders.

g. Scroll the side bar and observe the values in the Sequence Number column.

h. Leave the search tab open for the next procedure.

Procedure 7: Delete the class and verify the database table In this procedure, you delete one of the custom root classes that you created and verify that the table corresponding to the class is also deleted. 1. Delete the instances (objects) of the Order class. a. In the Search Results tab, select all the objects. b. Click Actions and select Batch Operations.

c. In the Batch Operations window, select Delete objects and click OK. d. Click OK on the message window to delete. e. Verify that the Search Results tab, does not have any objects that are listed. B-24 System Implementation and Administration




2. Delete the Order class. EXNoSideHead a. In the Marketing tab, if needed expand the Marketing > Data Design > Classes > Other Classes > Abstract Sequential node on the left pane. b. Right-click Order and select Delete from the list. c. In the message window, click OK to delete. d. Verify on the left tab, the class is no longer listed. 3. Log out of the Administration Console for Content Platform Engine and close the browser. 4. Verify that the database table is deleted the DB2 Control Center. a. Refresh the table view. Verify that the UT_Order table is not listed. b. From the menu bar, click Control Center > Exit to close DB2 Control Center.




B-25

Student Exercises





Lesson EXNoSideHead

B.5. Configure a Change Preprocessor




B-27

Student Exercises

Lesson

Configure a Change Preprocessor Why is this lesson important to you? • Your business requires a change to the default value for a system property when an object is created in the object store. A change preprocessor has the following capabilities: (1) Alter properties that are settable only during object creation (2) Synchronously modify a source object (3) Completes the action in time to satisfy the dependency of other processes. • The programmer for your company provides you the JavaScript that does the required actions on Content Platform Engine objects. As a solution builder, you must create a change preprocessor definition with a change preprocessor action that uses this code.

© Copyright IBM Corporation 2013, 2015

Figure B-10. Configure a Change Preprocessor

F1156.0

Notes:





EXNoSideHead

Configure a Change Preprocessor

Activities that you need to complete • Configure a Change Preprocessor.



F1156.0





B-29

Student Exercises


Change Preprocessor • Change preprocessor is a user-implemented action. – It allows you to make source object modifications.

• Examples of object modifications that change preprocessors can make: – Alter properties that are settable only during object creation. – Modify a source object synchronously. – Complete actions in time to satisfy dependencies of other applications.

• Characteristics of a change preprocessor – – – –

Events (create, update, and delete) trigger the Change Preprocessor. It runs synchronously during a transaction. It is started unconditionally. User must have permissions to save the preprocessor changes. © Copyright IBM Corporation 2013, 2015

Figure B-12. Change Preprocessor

F1156.0

Notes: Help path • IBM FileNet P8 Version 5.2 Information Center > Administering FileNet P8 > Administering Content Platform Engine > Changing objects > Subscribing to events > Change preprocessors In addition to synchronous and asynchronous event actions, you can create a user-implemented action called a change preprocessor. By using this feature you can make source object modifications that are difficult or impossible to achieve with synchronous or asynchronous event actions. Examples of object modifications that change preprocessors can make: • A change preprocessor must be used to alter properties that are settable only during object creation. The reason for this requirement is that when committed to the database, this type of property cannot be changed. • A change preprocessor can be used to synchronously modify a source object. The only other method of modifying a source object is by using an asynchronous event action. However, for high-volume operations, asynchronous event actions reduce throughput due to the increased processor usage inherent in using them. B-30 System Implementation and Administration




• A change preprocessor can be used in cases when the action must complete in time to satisfy EXNoSideHead dependencies of other applications. With asynchronous actions, there is a brief time period between object persistence in one transaction and action changes in a separate transaction. Therefore, avoid an asynchronous event action if a dependent client cannot tolerate a time period when required action changes have not been applied. Characteristics of change preprocessors: • A change preprocessor is triggered by the following types of events: create, update, and delete. • A change preprocessor runs synchronously during a transaction before database updates occur; so an exception rolls back the entire transaction. If auditing is enabled, the audit log entry shows the changes that are made by change preprocessors. • Unless disabled, change preprocessors are invoked unconditionally. • Changes made by a preprocessor can be saved only if the user making the request has the required permissions, and if property constraints are not violated.




B-31

Student Exercises


Components of a Change Preprocessor • Change preprocessor definition – It associates a change preprocessor action to an object class. – A class can have one or more change preprocessor definitions that are associated with it.

Change Preprocessor Definition Trigger Event

• Change preprocessor action on the

– It references the JavaScript or code module that is used for the action.

Target Object

• A Java or JavaScript action handler – It does the action.

Change preprocessor Action © Copyright IBM Corporation 2013, 2015

Figure B-13. Components of a Change Preprocessor

F1156.0

Notes: Help path • IBM FileNet P8 Version 5.2 Information Center > Administering FileNet P8 > Administering Content Platform Engine > Changing objects > Subscribing to events > Change preprocessors The diagram shows a Change Preprocessor with a trigger event on a target class that results in a Change Preprocessor Action. The trigger events are Content Platform Engine events Example: create, update, and delete. A Java-implemented action handler can be placed in a code module. It can also coexist with other action handler types, such as event action, lifecycle action, and document classifier.





EXNoSideHead


Change Preprocessor Definitions • You can set one or more change preprocessor definitions per class. – The definitions are applied recursively to subclasses in the class hierarchy. – You can update or remove a definition only from the class where it was originally defined.

• Administrators do the following tasks for the change preprocessor definitions: – – – – –

Create a change preprocessor definition. Enable or disable a change preprocessor definition. Assign a different action to an existing definition. Change the display name of an existing definition. Remove a change preprocessor definition.


Figure B-14. Change Preprocessor Definitions

F1156.0

Notes: Help path • IBM FileNet P8 Version 5.2 Information Center > Administering FileNet P8 > Administering Content Platform Engine > Changing objects > Subscribing to events > Change preprocessors > Managing change preprocessor definitions Characteristics of change preprocessor definitions One or more change preprocessor definitions per class If identical change preprocessor definitions are assigned to a class, the duplicate definitions are silently ignored. However, if the definitions are not identical, but reference the same action, you receive an error when you try to save the subsequent definitions. Subclasses in the class hierarchy The change preprocessor definitions are applied recursively to subclasses in the class hierarchy. If multiple definitions within a class hierarchy reference the same action, only the definition closest to the root of the class hierarchy is invoked. The other definitions that reference the same action, but are further down in the class hierarchy, are silently ignored. © Copyright IBM Corp. 2013, 2015



B-33

Student Exercises

Updating a change preprocessor You can update or remove a change preprocessor definition only from the class where it was originally defined. You cannot update or remove the definition from subclasses of that class.





EXNoSideHead


Change Preprocessor Actions • A change preprocessor action contains the code that does the change preprocessing. – The JavaScript code is stored in the change preprocessor action ScriptText property. – The Java code is stored outside the action object, either as a code module or as a class or JAR file.

• Administrators do the following tasks for the change preprocessor definitions: – – – – –

Create, modify, or delete a change preprocessor action. Create a code module. View or modify change preprocessor action properties. Enable or disable a change preprocessor action. Export or import a change preprocessor action.


Figure B-15. Change Preprocessor Actions

F1156.0

Notes: Help path • IBM FileNet P8 Version 5.2 Information Center > Administering FileNet P8 > Administering Content Platform Engine > Changing objects > Subscribing to events > Change preprocessors > Managing change preprocessor actions > Change preprocessor actions Characteristics of change preprocessor actions • They are independently persistable, so that they can be created separately from other objects and then assigned to one or more change preprocessor definitions. • If the Java-based action is not included in a code module, the class or JAR file must be located on the local Content Platform Engine application server. In addition, it must be included in the application server class path. • A change preprocessor action can be enabled or disabled. If you disable an action, all classes in the system with change preprocessor definitions that reference the disabled action are affected. Therefore, if you want to disable change preprocessing for a class, disable the change preprocessor definition. If you want to disable a particular action everywhere in the system, disable the change preprocessor action. © Copyright IBM Corp. 2013, 2015



B-35

Student Exercises


Steps to set up a Change Preprocessor 1. Set object store security so that you have access rights to modify. 2. Create a subclass of Document and other objects as needed. 3. Create a change preprocessor action. •

Java code or JavaScript

4. Create a change preprocessor definition and associate the action that you created. 5. Test your configuration.


Figure B-16. Steps to set up a Change Preprocessor

F1156.0

Notes:





EXNoSideHead


Action Handlers: Restrictions and Best Practices Change Preprocessor synchronous

Event Action synchronous

Event Action asynchr onous

Runs before source object is saved?

yes

yes

no

Can update source object?

yes

no

yes

Can update SettableOnlyonCreate (SOOC) properties?

yes

no

no

Can subscribe to events?

no

yes

yes


Figure B-17. Action Handlers: Restrictions and Best Practices

F1156.0

Notes: Help path • IBM FileNet P8 Version 5.2 Information Center > Developing IBM FileNet P8 applications > Content Platform Engine Development > Content Platform Engine Java and .NET Developer's Guide > Server Extensions > Action Handlers> Action Handlers: Restrictions and Best Practices The table compares some features of change preprocessors (which always execute synchronously) with features of event action handlers (which you can configure to run either synchronously or asynchronously). For a complete list, refer to the documentation. When does action handler run? Change Preprocessor (synchronous) - In transaction, before database updates have occurred. Runs first. Event Action (synchronous) – In transaction, after database updates have occurred. Runs second. Event Action (asynchronous) - After transaction has committed. Runs third in a separate transaction.




B-37

Student Exercises


Activities In your Student Exercises • Unit: Extend Content Platform Engine Functions • Lesson: Configure a Change Preprocessor • Activities: – Configure a Change Preprocessor.



F1156.0







B.5, "Configure a Change Preprocessor"

Why is this lesson important to you? Your business requires a change to the default value for a system property when an object is created in the object store. A Change Preprocessor has the following capabilities: (1) Alters properties that are settable only during object creation (2) Synchronously modifies a source object (3) Completes the action in time to satisfy the dependency of other processes. The Programmer for your company provides you the JavaScript that does the required actions on Content Engine objects. As a Solution Builder, you must create a Change Preprocessor Definition with a Change Preprocessor Action that uses this code.

Activities • Configure a Change Preprocessor: Activity, on page B-41


User ID

Password


p8admin

IBMFileNetP8


p8admin

IBMFileNetP8


burt

filenet





B-39

Student Exercises






a Change Preprocessor: Activity

Procedures Procedure 1, "Edit object store security," on page B-41 Procedure 2, "Create a Document subclass," on page B-42 Procedure 3, "Create a Change Preprocessor Action," on page B-43 Procedure 4, "Create a Change Preprocessor definition," on page B-45 Procedure 5, "Test your Change Preprocessor," on page B-46 Procedure 6, "Reset the object store security," on page B-48

Procedure 1: Edit object store security 1. Start the Administration Console for Content Platform Engine. a. In your Firefox browser, go to http://ecmedu01:9080/acce b. Log in as the P8admin user (password: IBMFileNetP8) 2. Open the object store Properties page. a. In the administration console, expand the P8Domain > Object Stores node on the left pane. b. Click the Sales object store where you want to create the change preprocessor. c. In the Sales tab, click the Security subtab. 3. Select the P8Admins security group. a. Verify that the Permission Group column has Full control for P8Admins. b. Click the check box for cn=P8Admins, o=sample

c. Click Edit. 4. Set object store security. a. In the Edit Permissions window, Full control is selected in the Permission group list. b. For the “Apply to” field, select “This object and all children” from the list.




B-41

Student Exercises

c. Select “Modify certain system properties”

d. Verify that Custom is selected in the Permission group list. Click OK. 5. In the Sales tab, click Save. a. Click Refresh. Important Full Control access does not include the required access rights by default. You must set the object store security so that you have access rights to modify the Creator system property. The “Modify certain system properties” permission must be used cautiously.

Procedure 2: Create a Document subclass 1. Start the Administration Console for Content Platform Engine. a. In your browser, go to http://ecmedu01:9080/acce b. Log in as the P8admin user (password: IBMFileNetP8) 2. Create a Document subclass. a. In the administration console, expand the P8Domain > Object Stores node on the left pane and click the Sales object store. b. In the Sales object store tab, expand the Sales > Data Design > Classes> Document node on the left pane. c. Right-click Document Class and click New Class. d. Use the following values and complete the steps for Create a Class: • Name: ChangeProcess • Symbolic Name: ChangeProcess • Description: Document subclass for testing change preprocessors. e. Click Next and verify the summary page. f.

Click Finish.





3. In the Success page, click Close to close the tab. EXNoSideHead a. In the Sales tab, verify that the new subclass is listed in the left pane under the Document node. b. If needed, click Refresh.

Procedure 3: Create a Change Preprocessor Action 1. Open the Change Preprocessor Action page. a. In the Sales object store tab, expand the Sales > Events, Actions, Processes node and click the Change Preprocessor Actions on the left pane. 2. Create a Change Preprocessor Action. a. In the Change Preprocessor Actions tab on the right pane, click New.

b. In the New Change Preprocessor Action tab on the right pane, use the following values and complete the steps: - Display Name: CP Test Action - Description: This action sets the value for the Creator property to “CP Test” when a new document is added to the system. c. Click Next. 3. Specify the Type of Change Preprocessor Action. a. Verify that Enabled is selected for the Status field.




B-43

Student Exercises

b. Select the JavaScript option for the Type field.

c. Click Next. 4. Copy and paste JavaScript code. a. Delete the existing text in the Script text field. b. Copy the code from the C:\LabFiles\ExtendCPEFxn\ChangePreprocessor.txt file. c. Paste the code. Avoid any leading space while pasting the text. Note JavaScript shown here is for your reference only. To avoid any typing errors, copy and paste the code from the file. // Set Creator property to "CP Test" when a new document is created. importClass(Packages.com.filenet.api.action.Create); function preprocessObjectChange (sourceObj) { // Verify that the pending action is a create action. var actions = sourceObj.getPendingActions(); for ( var i = 0; i < actions.length; i++ ){ if ( actions[i] instanceof Create ) { // Set Creator property to "CP Test"

sourceObj.getProperties().putValue("Creator", "CP Test"); return true; } } return false; }

d. Click Next.





5. Verify the summary page and click Finish. EXNoSideHead a. In the Success page, click Close to close the tab. b. In the Change Preprocessor Actions tab on the right pane, click Refresh. c. Verify that the newly created action is listed. d. Close the tab.

Procedure 4: Create a Change Preprocessor definition 1. Open the ChangeProcess class. a. In the Sales object store tab, expand the Sales > Data Design > Classes> Document node on the left pane. b. Click ChangeProcess (the document subclass that you created earlier). c. In the ChangeProcess tab on the right pane, click the right arrow to locate the Change Preprocessor Definitions and click the subtab.

2. Optional: Select Show Inherited to show inherited change preprocessor definitions. 3. Click New.

4. In the New Change Preprocessor Definition page, enter the following values: - Display Name: CP Test Definition - Status: Enabled selected. - Change preprocessor action: Select the CP Test Action from the list. a. Click OK to close the page. 5. In the ChangeProcess tab, click Save to save the changes. a. Click Refresh. © Copyright IBM Corp. 2013, 2015



B-45

Student Exercises

b. Verify that the CP Test Definition is listed. c. The Is Enabled column shows the value as True. d. In the Action Display Name column, the CP Test action that is associated with this definition is shown.

Information In this same tab, you can add more change preprocessor definitions, update a definition, or remove an existing definition.

Procedure 5: Test your Change Preprocessor 1. Open the folder. a. In the Sales object store tab, expand the Sales > Browse > Root Folder > Test Folder node on the left pane. 2. Create a document. a. Right-click the Test Folder and click New Document. b. Enter CP Test 1 as the Document title. c. Select ChangeProcess from the list for the Class field. d. Clear the With Content option. e. Click Next and leave the default values for all other fields.





EXNoSideHead f.

In the summary page, click Finish.

g. Click Close to close the New Document tab. h. In the Test Folder tab, click Refresh. i.

Verify that the new document (CP Test 1) is listed.

3. Verify the document property value. a. Notice that the “Created By” property of the CP Test 1 has CP Test as the value.

a. You can also verify by clicking CP Test 1 to open the document properties. b. In the CP Test 1 tab, click the Properties tab. c. Scroll down and verify that the Creator property is set to CP Test.




B-47

Student Exercises

Note You logged in to the administration console as P8Admin. The document Creator should be P8Admin. But because of the Change Preprocessor and the JavaScript action that is defined, the value is changed to CP Test.

Procedure 6: Reset the object store security In this procedure, you reset the object store security to remove the “Modify certain system properties” access right. 1. In the Sales tab, click the Security subtab. 2. Select the P8Admins security group. a. Click the check box for cn=P8Admins,o=sample b. Click Edit. 3. Reset object store security. a. In the Edit Permissions window, Custom is selected in the Permission group list. b. Clear the “Modify certain system properties” option. c. Verify that Full control is selected in the Permission group list. Click OK. 4. In the Sales tab, click Save. 5. Log out of Administration Console for Content Platform Engine and close the browser.





Lesson EXNoSideHead

B.6. Configure an External Data Service




B-49

Student Exercises

Lesson

Configure an External Data Service Why is this lesson important to you? • You can extend the default capability and change the behavior of the IBM Content Navigator web client with the use of plugins. For example, you can create a plug-in to add a menu action or to validate data entry. IBM Content Navigator includes several plug-ins that your Developer can customize for your company as required. • As a Solution Builder, you register and configure a plug-in for the IBM Content Navigator web client application.


Figure B-19. Configure an External Data Service

F1156.0

Notes:





EXNoSideHead

Configure an External Data Service

Activities that you need to complete • Configure an External Data Service.



F1156.0





B-51

Student Exercises


Content Navigator Plug-ins • You can extend the Content Navigator default capability with the use of plug-ins. • You can create plug-ins for the following uses: – New Features and Layouts – New menus, menu items, toolbars – Viewers, Widgets, and Services

• IBM Content Navigator includes several plug-ins that you can register and configure. – Example: External data services plug-in (EDS) – Default location of the plug-in file: • Microsoft Windows: C:\Program Files (x86) • \IBM\ECMClient\plugins\edsPlugin.jar • Linux or AIX: /opt/IBM/ECMClient/plugins/edsPlugin.jar © Copyright IBM Corporation 2013, 2015

Figure B-21. Content Navigator Plug-ins

F1156.0

Notes: Help paths • IBM FileNet P8 Version 5.2 Information Center > Installing additional IBM FileNet P8 products > Planning, installing, and configuring IBM Content Navigator > Administering IBM Content Navigator > Configuring the IBM Content Navigator web client > Registering and configuring plug-ins • IBM FileNet P8 Version 5.2 Information Center > Developing IBM FileNet P8 applications > Developing applications with IBM Content Navigator > Creating plug-ins to IBM Content Navigator IBM Content Navigator includes the following plug-ins: • External data services plug-in • IBM Content Analytics with Enterprise Search plug-in • IBM Content Collector Viewer plug-in





EXNoSideHead


Set up the External Data Service Plug-in • Deploy the EDS plug-in to a Web Application Server. – Example: WebSphere Application Server

• Register the plug-in in Content Navigator admin tool. – Load the plug-in file from the directory where it is located. – Specify the URL where the EDS plug-in is deployed.

• Configure the repository in the Admin Console for Content Platform Engine: – Create the Document classes, Property Templates, and other objects that are required for the plug-in.

• Restart the IBM Content Navigator application for the changes to take effect.


Figure B-22. Set up the External Data Service Plug-in

F1156.0

Notes: Help path • IBM FileNet P8 Version 5.2 Information Center > Installing additional IBM FileNet P8 products > Planning, installing, and configuring IBM Content Navigator > Administering IBM Content Navigator > Configuring the IBM Content Navigator web client > Registering and configuring plug-ins > Configuring the external data service plug-in




B-53

Student Exercises


Steps to register and configure a plug-in 1. Open the Plug-ins page in the admin tool. 2. Click New Plug-in or Edit for the existing plug-in. 3. Enter the location or the URL for the plug-in JAR file.

4. Click Load.

5. Configure plug-in parameters.

6. Save the settings. © Copyright IBM Corporation 2013, 2015

Figure B-23. Steps to register and configure a plug-in

F1156.0

Notes: Help path • IBM FileNet P8 Version 5.2 Information Center > Installing additional IBM FileNet P8 products > Planning, installing, and configuring IBM Content Navigator > Administering IBM Content Navigator > Configuring the IBM Content Navigator web client > Registering and configuring plug-ins > Configuring the external data service plug-in The screen capture shows the plug-in configuration fields. Enter the URL in the following sample format: http://host_name:port_number/ECMClient_installdir/plugins/edsPlugin.jar.





EXNoSideHead


Activities In your Student Exercises • Unit: Configure IBM Content Navigator • Lesson: Configure an External Data Service • Activities: – Configure an External Data Service.



F1156.0

Notes: Help path Use your Student Exercises to perform the activities listed.




B-55

Student Exercises






B.6, "Configure an External Data Service"

Why is this lesson important to you? You can extend the default function and change the behavior of the IBM Content Navigator web client with the use of plug-ins. For example, you can create a plug-in to add a menu action or to validate data entry. IBM Content Navigator includes several plug-ins that your developer can customize for your company as required. As a solution builder, you register and configure a plug-in for the IBM Content Navigator web client application.

Activities • Configure External Data Service: Activity, on page B-59

User accounts: Windows Application Name

User ID

Password

Administration Console for Content p8admin Platform Engine

IBMFileNetP8


IBMFileNetP8

p8admin





B-57

Student Exercises






External Data Service: Activity

In this activity, you register a plug-in in the Admin desktop of the IBM Content Navigator web client application. A sample External Data Services (EDS) plug-in that is provided with IBM Content Navigator is used for this example.

Procedures Procedure 1, "Configure the External Data Service," on page B-59 Procedure 2, "Test the Plug-in," on page B-61

Procedure 1: Configure the External Data Service The plug-ins must be deployed on your system before configuring them in the admin tool. 1. Verify that the external data service application is deployed. a. In your browser, go to http://ecmedu01:9080/SampleEDSService/types (The URL is case-sensitive). b. Verify that a JSON file is shown.

c. Note down the base URL of the EDS application. 2. Start the IBM Content Navigator admin desktop. a. In your browser, go to http://ecmedu01:9080/navigator/?desktop=admin b. Log in as the admin user. • User name: P8admin • Password: IBMFileNetP8 3. Create a plug-in. a. On the Admin desktop, click the Plug-ins icon in the left pane. b. On the Plug-ins tab, click New Plug-in . 4. Configure the plug-in. a. On the New Plug-in page, select the “JAR file path” option. b. Enter the location for the JAR file: C:\Program Files (x86)\IBM\ECMClient\plugins\edsPlugin.jar




B-59

Student Exercises

Hint In Windows Explorer, browse to the location of the JAR file. Copy and paste the directory to eliminate any typing errors.

c. Click Load. d. If the File entry is valid, the page shows more information about the plug-in, as defined by the developer of the plug-in. Note In this procedure, you are using the default Content Navigator install location for the JAR file. You can save your custom plug-ins code in any directory that you choose. The programmer in your company provides the code as a JAR file. If the plug-in requires more information to complete the registration, it must be supplied as well. In this case, the External Data Service URL must be entered.

e. Enter the value for the External Data Service URL (you got this value in step 1): http://ecmedu01:9080/SampleEDSService This URL value is case-sensitive.

5. Click Save and Close.





6. Verify that the new plug-in is listed in the Plug-ins tab. EXNoSideHead

f.

Log out of IBM Content Navigator and close the browser.

7. This external data services support feature is now available in the IBM Content Navigator web client application.

Procedure 2: Test the Plug-in A custom document class is created in your system for EDS test. EDS validates data entries and also it populates values for the metadata fields for this document class. 1. Start the IBM Content Navigator My Desktop. a. In your web browser, go to http://ecmedu01:9080/navigator/?desktop=MyDesktop The URL is case-sensitive. b. Log in as the P8admin user (password: IBMFileNetP8). 2. The Browse view is opened. a. If it is already not selected, select the Sales repository. b. Create a folder with the following name: EDSTest. 3. Test the populated values by adding a document. a. Open the EDSTest folder. b. Click Add Document. c. For the “What do you want to save” field, select “Information about a document” from the list. d. In the Properties section > Class field, select the Book class from the list and click OK. e. Notice that the Author property has a list of values already populated.




B-61

Student Exercises

f.

Select a value for the Author, notice that the values in the list for the Document Title field are dynamically changed to match the Author value.

g. Repeat the step 3e with a different author and notice that values are changed. h. Optionally, complete adding a document. 4. Test Data Validation feature. The Folder Name field uses a validation feature from the EDS plug-in. a. Select the EDSTest folder. b. Click New Folder. c. In the Properties section, make sure that Folder is selected for the Class field. d. Enter any value that contains number 3 for the Folder Name field. (Example: Department3) e. Click Add. f.

Notice that you get an error message:

g. If you remove the number 3, you are able to add the folder.





EXNoSideHead h. Log out of IBM Content Navigator and close the browser. Troubleshooting If the testing of the Plug-in function does not work as expected, you must restart the Content Navigator web application in WebSphere Application Server Administrative Console. 1. In a Firefox browser, click the WAS Admin link in the Bookmarks toolbar or go to the following URL: https://ecmedu01:9043/ibm/console/logon.jsp a. Enter the account information and click Login. • User ID: p8admin • Password: IBMFileNetP8 2. Open the Enterprise Applications page. a. In the left pane, expand Applications > Applications Types. b. Click the WebSphere enterprise applications link.

3. Restart the Content Navigator application. a. On the right pane, select navigator in the Enterprise Applications page.

b. Click Stop and wait for the stop message to display.

c. Select navigator again and click Start. Wait for the Start message to display. d. Logout of the administration console and close the browser.




B-63

Student Exercises





Lesson EXNoSideHead

B.7. Work with Content Caches




B-65

Student Exercises

Lesson

Work with Content Caches Why is this lesson important to you? • A department in your company frequently accesses document content that exists on geographically remote storage areas that are accessed through a wide area network (WAN). As the IBM FileNet P8 Administrator, you must create a content cache to expedite access to this remote document content.


Figure B-25. Work with Content Caches

F1156.0

Notes:





EXNoSideHead

Work with Content Caches

Activities that you need to complete • Create, configure, and assign a content cache area.



F1156.0





B-67

Student Exercises


Review: content cache area • Content cache – A storage area in a file system that is used to temporarily hold files and database content for faster retrieval – By providing local storage of frequently accessed documents without having to repeatedly request them over the network

• For local sites – Content cache areas can also be useful to local sites. – The cache can be on a faster disk than the file storage area.

• Confidential documents – Documents can remain in the cache after they are deleted from the system.


Figure B-27. Review: content cache area

F1156.0

Notes: Help path • IBM FileNet P8 Version 5.2 Information Center > Administering FileNet P8 > Administering Content Platform Engine > Defining the repository infrastructure > Storing content > Optimizing storage area performance > Caching content > Content cache areas A distributed FileNet P8 system has many clients reading content from either a remote file server (for example, over a WAN) or database (possibly on a remote server). To reduce network traffic, content can be cached in the file system on a local server. Save files to cache when they are added. A cache can be configured to hold files at the time they are added to object stores. This feature is useful if the same documents are likely to be retrieved soon after adding. Do not enable this feature if a content cache area is intended for a site that is heavily used to create new documents if those documents are not subsequently retrieved. Confidential documents. If you have sensitive or confidential documents, you need to consider whether caching is appropriate. Files are not automatically deleted from the content cache area when the document is deleted from the storage area.





EXNoSideHead


Content Cache at a Remote Location

Object store Remote object store Database storage area

Wide area network (WAN)

Content cache at remote location

Remote object store

Content cache is a secondary option after content has been stored in the object store database, file store, or fixed storage area.

Fixed storage area

File storage area © Copyright IBM Corporation 2013, 2015

Figure B-28. Content Cache at a Remote Location

F1156.0

Notes: The diagram shows the relationship between a content cache, an object store, file storage area, and a remote object store. All object store content is stored in file storage areas, fixed storage areas, or database storage areas, all of which can be the objects of storage policies. Database storage areas provide permanent storage for document content. A database storage area is managed by the Content Platform Engine and converts document content into binary large objects (BLOBs) for storage in the database specified as the object store database. A file storage area contains document content in a hierarchy of folders on a local or shared network drive accessible by the Content Platform Engine server. The content is stored in a folder on a shared network drive. A fixed storage area is a file storage area that has a connection to a third-party fixed-content system providing additional storage capacity and security. This connection is provided by an object called a fixed-content device. Content cache areas provide local storage of frequently accessed documents, which are accessible over a LAN. © Copyright IBM Corp. 2013, 2015



B-69

Student Exercises





EXNoSideHead


Content cache overview • The content cache handles content only. – Both the API layer and Workplace XT have their own property caching. – The cache works for both file and database content stores.

• Content cache performance – Can be improved by adding content cache areas. – Supports write-through caching. – Is a function of the Content Platform Engine, not of the web server.

• Any client can use a cache: – Content Navigator, Workplace XT, Custom Java application, Enterprise Manager, Administrative Console for Content Platform Engine.

• Exists on – The Content Platform Engine server or on a network share. © Copyright IBM Corporation 2013, 2015

Figure B-29. Content cache overview

F1156.0

Notes: The Content Platform Engine server initiates object caching thus a Content Platform Engine server is required at each site that uses a cache. Upon retrieval, the Content Platform Engine checks whether the objects in a cache are local to its server, to a virtual server, or to the site. Multiple caches can store multiple copies of a content object but the local storage area holds one copy of the object. Documents remain in a cache until cleared, even if the document is deleted from the object store unless a cache lifespan is specified. Disable caching at sites with confidential files - If cache is enabled, files can remain in cache and accessible to users with physical access to the server, even after the files have been purged from the original file storage area.




B-71

Student Exercises


Create a Content Cache • You can create a cache in one of the following areas: – – – –

Domain Site definition Virtual Server definition Server definition

• Content cache configuration is inherited from parent objects in the hierarchy. – Unless you assign specific servers to the cache, all member servers of a site or virtual server use the same configured cache. – You can override the default cache assignment at each definition level

• Caching is enabled for cross-site only by default.


Figure B-30. Create a Content Cache

F1156.0

Notes: A cache can be assigned to one of the following owner objects within the server hierarchy (listed from highest to lowest level): Domain, site, virtual server, or server instance. This assignment determines the servers that use the cache: a server finds the lowest-level server hierarchy owner to which both the server and a cache belong. For any content not found by the server in the cache, the server copies the content from the storage area into the cache. The level of caching permitted for a storage area is set independently of the cache area assignment and is not affected by that assignment. For example, only cross-site caching might be permitted for a storage area.





EXNoSideHead


Content Caching Property • Content caching property – A storage area property that specifies whether the content data in the storage area can be cached.

• Property values: – Allowed: Content is cached whenever it is accessed. • Use case: To improve performance in single-site deployments. – Cross-site only (default): Content is cached only when accessed from another site. • Use case: Typical multi-site traffic optimization. – Not allowed: Content caching is not allowed. • Use case: To prevent confidential documents from being cached.


Figure B-31. Content Caching Property

F1156.0

Notes:




B-73

Student Exercises


Pruning • Definition of pruning – Automatic deletion of content files that have not been accessed recently.

• Purpose of pruning – To ensure that the cache is the minimum size necessary to store the most recently accessed content.

• Types of pruning – Periodic pruning • Triggered by the Content Lifespan property • Occurs automatically halfway through the period that the Content Lifespan property specifies. – Mandatory pruning • Removes content files in a the order of the least recently accessed to achieve a calculated target total. © Copyright IBM Corporation 2013, 2015

Figure B-32. Pruning

F1156.0

Notes: Help path • IBM FileNet P8 Version 5.2 Information Center > Developing IBM FileNet P8 applications > Content Engine Development > Content Engine .NET API Reference > FileNet.Api.Admin Namespace > IContentCacheArea Interface > IContentCacheArea Properties > IContentCacheArea.PruneAmount Property Mandatory pruning removes content files in the order of least recently accessed until the total of the remaining files does not exceed some calculated target total. The target total calculation involves a property that specifies the percentage to prune and the following threshold properties: Threshold Size and Threshold Elements. The pruning occurs automatically when the number or size of the content files exceeds one of these thresholds.





EXNoSideHead


Content Lifespan • You can set the Content Lifespan property by using FileNet Enterprise Manager. • Content Cache Properties > Processing tab.


Figure B-33. Content Lifespan

F1156.0

Notes: The graphic shows the Content Lifespan setting on the Processing tab of the Cache Properties window in FileNet Enterprise Manager.




B-75

Student Exercises


Other Content Cache Attributes • Preload On Create – A cache duplicates content when new content is added.

• Prune threshold size kbytes – The minimum size of all content elements in the cache area sufficient to trigger a cache prune action

• Prune Threshold Content Elements – The minimum number of content elements in the cache area sufficient to trigger a cache prune action.

• Maximum Size Kbytes – Maximum size (in kbytes) that allows content to be added to the cache.

• Maximum Content elements – Maximum size (in content elements) that allows content to be added to the cache. © Copyright IBM Corporation 2013, 2015

Figure B-34. Other Content Cache Attributes

F1156.0

Notes: Content preloading: When content preloading has been enabled (with the PreloadOnCreate property), the cache receives duplicates of any new content added to the main storage area. Cache content can sometimes slightly exceed the designated storage capacity, as statistics are managed on a delayed basis, and multiple servers can be adding content.





EXNoSideHead


Content Cache Performance Guidelines • Optimize pruning thresholds – Using the Threshold Size property – Using the Threshold Elements property

• Preload accessed content only • Adjust Content Lifespan property – Shorter lifespan increases the refetching of content – Longer lifespan requires a larger cache area

• Make the cache accessible to all servers in the domain – Accessible from every Content Platform Engine server in the FileNet P8 domain.


Figure B-35. Content Cache Performance Guidelines

F1156.0

Notes: Optimize pruning threshold using the Threshold Size property. - Set the Threshold Size property to optimize system performance. If the content cache server has a large hard disk, you can afford to enlarge the maximum space for content caching. This enlargement minimizes network traffic and reduces network access time by keeping the most recently accessed content in local cache. If your caching server has limited space available, reduce the maximum space for content caching. Avoid allocating more space than the server has available can so that system resources are not stressed and system performance is not degraded. Optimize pruning threshold using the Threshold Elements property. - Determine the number of files frequently accessed by users. Increase that number by 5 to 10% to determine the maximum number of files allowed in the cache. If your system maintains relatively small files, you can allow a greater number of files in cache. Preload accessed content only. - Do not enable the Preload On Create option when the associated site is heavily used to create documents that are not retrieved later. Adjust Content Lifespan property. - Review your system requirements before setting the Content Lifespan interval. The shorter the lifespan is, the more often content is removed and refetched. The longer the lifespan is, the more deleted content occupies the content cache area. © Copyright IBM Corp. 2013, 2015



B-77

Student Exercises

Periodically review cache properties. - Analyze the content cache settings periodically and modify the configuration properties as necessary. For example, you might experience a system slowdown if users access more files than the configured threshold permits for the content cache area. In this case, increase the maximum number of files allowed. Make the cache accessible to servers. - Make a cache area accessible from every Content Platform Engine server in the FileNet P8 domain. If only some servers have access to the area, the information displayed by Enterprise Manager depends on the server to which Enterprise Manager is connected. No information is displayed for a non-accessible storage area. A server that does not have access to a cache generates the following error every 30 seconds: CONTENT_CACHE_AREA_ACCESS_FAILED: Access to the content cache area directory failed. This error is displayed in the system error logs.





EXNoSideHead


Activities In your Student Exercises • Unit: System Maintenance • Lesson: Work with Content Caches • Activities: – Create, Configure, and Assign a Content Cache Area.



F1156.0





B-79

Student Exercises






B.7, "Work with Content Caches"

Overview Why is this lesson important? A department in your company frequently accesses document content that resides on geographically remote storage areas that are accessed through a wide area network (WAN). As the IBM FileNet P8 administrator, you must create a content cache to expedite access to this remote document content.

Activities • Create, Configure, and Assign a Content Cache Area: Procedure, on page B-83

User Accounts Type

User ID

Password

Operating system

administrator

passw0rd


P8Admin

IBMFileNetP8





B-81

Student Exercises





Create, EXNoSideHead

Configure, and Assign a Content Cache Area: Procedure Introduction In this exercise, you create a content cache; then configure it and assign it to a site.

Procedures Procedure 1, "Create a content cache," on page B-83 Procedure 2, "Inspect the content cache area object," on page B-84 Procedure 3, "Inspect content cache area file location," on page B-85 Procedure 4, "Assign the content cache area," on page B-85 Procedure 5, "Change content caching permission," on page B-86 Procedure 6, "View content cache statistics," on page B-87 Important In a production environment, do not collocate the content cache with file stores or indexes.

Procedure 1: Create a content cache 1. Create a folder: C:\filenet\contentcache. 2. Using Firefox, sign in to Administration Console for Content Platform Engine: - URL: http://ecmedu01:9080/acce 3. Log in as p8admin: - User name: p8admin - Password: IBMFileNetP8 4. Go to Global Configuration > Administration > Content Cache Areas. 5. Click New. 6. Specify the Content Cache Area Name: a. In the Name field, type Cache1. b. Click Next. 7. Specify the Content Cache Area Management Parameters: a. In the Root Directory field, type C:\filenet\contentcache b. Enable the PreloadOnCreate option.




B-83

Student Exercises

Important In production, do not enable the Preload On Create option when the associated site is heavily used to create documents that are not retrieved later.

c. Click Next. 8. Specify the Content Cache Sizing Parameters: a. Accept the defaults on this page. b. Click Next. 9. On the Summary page, click Finish. 10. Click Open to view the cache information.

Procedure 2: Inspect the content cache area object Now that the cache exists, you can inspect the structure of the content cache area in the P8 Domain. You are logged in to Administration Console for Content Platform Engine as P8Admin. The content cache information page is open. 1. Click the Properties tab to open the cache properties page. 2. Use the scroll bar to see the properties for this cache area. 3. Verify the following values: - Display Name: Cache1 - Root directory: C:\filenet\contentcache - Content Element Count: 0 - Content Element Kbytes: 0 - Content Elements Created: 0 - Content Elements Deleted: 0 Information From here, you can change cache area property values that affect pruning, maximum size, and other settings.

4. Minimize Administration Console for Content Platform Engine. 5. Close Firefox.






3: Inspect content cache area file location

When you create the content cache area, Content Platform Engine creates a folder structure in the content cache area file location. You are going to verify that the folder structure was created. 1. Use Windows Explorer to go to C:\filenet\contentcache 2. Verify that the folder now contains several subfolders and files.

3. Open the content folder. Verify that the folder structure is similar to the structure of a file storage area.

Procedure 4: Assign the content cache area After content cache areas are created for a site, they can be associated with the servers in that site. Content cache areas can be shared between servers, or each server can have its own content cache area. You can assign the content cache area by using Administration Console for Content Platform Engine. In this exercise, however, you are going to use FileNet Enterprise Manager. 1. Minimize all windows. 2. Start FileNet Enterprise Manager by using the desktop shortcut. 3. Connect to the ECMEDU01 domain. 4. Open the Properties panel for the P8Domain.

5. Open the Content Cache tab.




B-85

Student Exercises

6. Select Cache1.

7. Click Apply. 8. Click OK to close the Notice. 9. Click OK to close the P8Domain properties. 10. Close FileNet Enterprise Manager.

Procedure 5: Change content caching permission By default, content caching is set to cross-site only. Documents are only cached when they are requested from another site. Your student system has only one site, so with this setting, documents are never cached. In order to view content caching in action, you must change this setting on the storage area. You are signed into Administration Console for Content Platform Engine as p8admin. 1. Restore Administration Console for Content Platform Engine. 2. Open Object Stores > Sales. 3. Go to Administrative > Storage Areas, 4. Select the Sales storage area. 5. Open the Properties tab.





6. Set the Content Caching field to Allowed. EXNoSideHead

7. Click Save. 8. Log out of Administration Console for Content Platform Engine.

Procedure 6: View content cache statistics 1. Add a document to the Sales object store. a. Use Firefox to log in to Workplace XT as p8admin. • http://ecmedu01:9080/WorkplaceXT • User name: p8admin • Password: IBMFileNetP8 b. Open the Sales object store. c. Create a folder named Cache Test. d. Open the Cache Test folder. e. Add some documents to the Cache Test folder: • With the Cache Test folder open, drag ten files from C:\LabFiles\SampleDocuments into the Drag files here to add box.

f.

If Firefox prevented the site from opening a pop-up window, click the Options button and then select Allow pop-ups for ecmedu01.




B-87

Student Exercises

g. Complete the document add wizard. h. Log out of Workplace XT. 2. Review the cache statistics: a. Using Firefox, log in to Administration Console for Content Platform Engine as p8admin: • User name: p8admin • Password: IBMFileNetP8 b. Go to Global Configuration > Administration > Sites > Initial Site > Content Cache Areas. c. Click Cache1. d. Click the Properties tab. 3. Verify the following property values: - Content Element Count: 10 - Content Elements Created: 10 4. Log off of Administration Console for Content Platform Engine.

Summary In this exercise, you did the following tasks: • Created a content cache. • Assigned a content cache. • Viewed content cache statistics.





Lesson EXNoSideHead

B.8. Use System Dashboard




B-89

Student Exercises

Lesson

Use System Dashboard Why is this lesson important to you? • The IBM System Dashboard tool is installed on a server within your IBM FileNet P8 Content Manager system. You must know how to use this tool to monitor the components of your system.


Figure B-37. Use System Dashboard

F1156.0

Notes:





EXNoSideHead

Use System Dashboard

Activities that you need to complete • Monitor the System State • Run Dashboard Reports • Reconnect a Listener



F1156.0





B-91

Student Exercises


What is System Dashboard? • IBM System Dashboard for Enterprise Content Management – Also referred to as System Dashboard

• A real-time, performance-monitoring tool that tracks the following: – – – –

IBM FileNet P8 system data Application-specific events System environment data Operating system data

• Do not confuse System Dashboard with System Monitor. • Use System Dashboard to collect and distribute performance data on FileNet products that are installed at a site. – System Dashboard comes with many IBM ECM products. – Monitors multiple components on an IBM FileNet system.


Figure B-39. What is System Dashboard?

F1156.0

Notes: Help paths • IBM FileNet P8 Version 5.2 Information Center > System overview > FileNet P8 architecture > Administrative components • IBM FileNet P8 Version 5.2 Information Center > Administering FileNet P8 > Monitoring IBM FileNet P8 > Using the IBM System Dashboard for Enterprise Content Management IBM System Dashboard for Enterprise Content Management is sometimes referred to as System Dashboard. IBM System Dashboard for Enterprise Content Management was previously called FileNet System Manager, System Manager, or Manager Dashboard. System Dashboard monitors all components in the same console, a useful feature for sites that use various management consoles. IBM System Dashboard for Enterprise Content Management runs on the following platforms: Windows, Solaris, AIX, HPUX (Itanium and PA-RISC), Linux. Comparison of IBM System Dashboard for Enterprise Content Management and ECM System Monitor





System Dashboard is easily confused with another product named System Monitor. The confusion EXNoSideHead arises because System Monitor allows you to manage the system, while System Dashboard (formerly known as FileNet System Manager) allows you only to monitor the system. IBM System Dashboard for Enterprise Content Management is the standard interface used to access performance data from IBM FileNet products. Although FileNet System Monitor can access the same data used by IBM System Dashboard for Enterprise Content Management, FileNet System Monitor is a separately purchased product for proactive monitoring. FileNet System Monitor supports prevention by maintaining a corrective action database. You do not need to install Dashboard if you currently have System Monitor installed. In addition to providing system information (also provided by System Dashboard), System Monitor does the following tasks: • System Monitor has a web interface and uses IBM System Dashboard for Enterprise Content Management data. • Starts and stops components (if directed). • Notifies support personnel through System Management consoles such as the IBM Tivoli Enterprise Console. • Reads the log files to report error messages and conditions. • Provides alerts for critical errors, such as fault detection.




B-93

Student Exercises


Why use System Dashboard? • View system metrics in real time: – Individual components, the system environment, operating systems

• Gather and archive performance data, and run reports to do these tasks: – – – – – –

Generate benchmark data. Evaluate workload and its effect on system resources. Observe changes and trends in workloads and resource usage. Test configuration changes or other tuning efforts. Diagnose problems. Target components or processes for optimization.

• Integrate system metrics with external applications. • Goal: Use the gathered data to identify and resolve potential performance problems before they occur. © Copyright IBM Corporation 2013, 2015

Figure B-40. Why use System Dashboard?

F1156.0

Notes: The following examples of system metrics are collected by IBM System Dashboard for Enterprise Content Management: • Component-specific examples: Remote Procedure Calls (RPCs), event times, and custom metrics. • Environment examples: Configuration, version, patch levels • Operating system examples: CPU usage, memory usage, disk I/O, network I/O You can run management and trend reports on current and archived data. You can use performance data to do benchmarking. You can collect data immediately after initial installation and configuration, and then collect the same information after the system has been running a while. Compare the initial and current data to check whether the system is maintaining the same performance level.





EXNoSideHead

Monitor Use P8 Components with Other Tools System Dashboard

Dashboard Terms (1) • System Dashboard – Configure data collection with clusters and view data for a cluster. – Assign servers and a monitoring frequency to each cluster.

• Cluster – A user-defined group of servers that System Dashboard monitors. – Not related to active and passive clusters that are used for business continuity – A cluster must be defined before monitoring components.

• Listener – A component that provides performance data from the monitored component to System Dashboard – Optionally accumulates and aggregates that data.

• Container – It is a node in System Dashboard that groups containers, events, and meters. © Copyright IBM Corporation 2013, 2015

Figure B-41. Dashboard Terms (1)

F1156.0

Notes:




B-95

Student Exercises

Monitor Use P8 Components with Other Tools System Dashboard

Dashboard Terms (2) • Event – An occurrence that happens in the application that is significant. – Examples: • Document checkout • Database lookup – Can have duration

• Meter – It is an absolute value of something inside the application software.

• Counter – Provides the count of how many events occurred.

• Accumulator – Contains the sum of some event-related quantities. – Summarizes data from several events (such as averages). – Example: • Average database lookup duration © Copyright IBM Corporation 2013, 2015

Figure B-42. Dashboard Terms (2)

F1156.0

Notes: Events Event values and accumulator values both stay the same or increase over time. Example events: a document creation, a document retrieval Example meter: the number of entries in a cache, the total memory of the Java virtual machine Example subevents: "success" and "failure" subevents for an event that counts the number of document creations Note: Subevents for an event are usually related to each other. Example accumulator: the duration of an event An event and duration accumulator example Every time a document is added to an object store in the Content Platform Engine, the Content Platform Engine increments the Creations Event by 1 (counting the number of creations). The Content Platform Engine also adds to a duration accumulator the time that it takes to perform that operation. During a specified interval, Content Platform Engine creates three documents. The time that it takes to create these documents was 30 milliseconds, 40 milliseconds, and 35 milliseconds. B-96 System Implementation and Administration




During that collection interval, the Creations Event is increased by 3, and the subordinate duration EXNoSideHead accumulator is increased by 105 (30 + 40 + 35). System Dashboard divides 105 by 3 to obtain an average value of 35 milliseconds for each creation operation during that period of time. System Dashboard displays this average value along with the minimum value (30), maximum value (40), and standard deviation of the duration value over that interval. Note: This example uses milliseconds for simplicity. The Listeners actually report durations in nanoseconds, which were divided by 1 million to produce the millisecond values.




B-97

Student Exercises


System Dashboard Structure Navigation tabs Listener Container Data area

Event. Accumulator, or Meter node

Details view

Message area © Copyright IBM Corporation 2013, 2015

Figure B-43. System Dashboard Structure

F1156.0

Notes: Help path • IBM FileNet P8 Version 5.2 Information Center The graphic shows the Details view of System Dashboard. In the Details view of IBM System Dashboard, the container node in the tree is shown as a folder, and the event and accumulator nodes in the tree are shown as filled circles. Content Platform Engine has a separate container node for each object store under USER. The object store container node provides access to all the counters for that object store.





EXNoSideHead


Components of System Dashboard • Dashboard, used to configure data collection and to view data – Configure data collection with clusters and view data for a cluster. – Assign servers and a monitoring frequency to each cluster.

• Manager – Connects to and retrieves and processes data from a Listener.

• Listener utilities that gather and save component data – They send the data to System Dashboard when queried or scheduled. – They are built-in for the core IBM FileNet engines.

• Data Archiving options – Use Archiving Manager to save data in compressed log files. – Archiver.jar stores the data of one Listener to its own log file (1:1).

• You can use Java and C++ APIs to build custom Listeners for custom applications, and to report their performance data. © Copyright IBM Corporation 2013, 2015

Figure B-44. Components of System Dashboard

F1156.0

Notes: Help path • IBM FileNet P8 Version 5.2 Information Center > System overview > FileNet P8 architecture > Administrative components > System Dashboard for Enterprise Content Management Multiple Dashboards can talk to one Listener, and multiple Listeners can talk to one Dashboard. After creating a cluster in System Dashboard, you can also save the cluster as a file (clustername.xml) for use in later monitoring sessions. Manager Manager connects to and retrieves reports from a listener and processes the collected data, such as storing it, displaying it graphically, or using it to perform other application-specific tasks. Dashboard provides two Managers: Dashboard and Archiving Manager. Listeners Listeners continuously collect data from monitored components. This time period is the collection interval and it is specified in seconds. The data collected is discarded when it becomes older than




B-99

Student Exercises

permitted for the component it is monitoring. The data sent to System Dashboard must be archived in order to accumulate historical data for use in reporting and analysis. A listener waits passively for Managers to connect to it and to inquire about its performance counter values. In the absence of a Manager connection, the presence of a listener component is nearly invisible to an outside observer. Dashboard offers Java and Microsoft C++ implementations of the listener. The type of data collected by the Listener depends on the component or application that the Listener is monitoring. Each Listener collects either automatic data (CPU, network, and disk statistics) or application-specific data, which is determined by its developers. Many IBM products for enterprise content management come with System Dashboard and Listeners for their core engines or application, for example: • IBM FileNet Content Manager • IBM FileNet Image Manager • IBM Enterprise Records • IBM FileNet Workplace XT Data Archiving options provide the following two ways to save captured performance data to compressed log files: Within System Dashboard, you can right-click a Listener node in the tree view on the Details screen and archive the data collected by the Listener to a history file. From a command prompt, you can use the Archiving Manager to archive data (historical and on-going) from a given host. The use of commands makes the archive process available for use in scripts and recurring events, for example. Use the APIs to write Listeners for custom programs and integrate them with the IBM System Dashboard for Enterprise Content Management framework. Integrated applications can then be monitored alongside the IBM FileNet P8 components. Specific ways to use the API include the following: • Create a program that archives the performance and system data into a database. • Expose the data through standard protocols including JMX and SNMP to enterprise system management consoles, such as IBM Tivoli Monitoring and HP OpenView. • Create a custom Dashboard.





EXNoSideHead


Average and Rate Meters • In previous System Dashboard versions, some counters frequently displayed zero values because the rate of display in System Dashboard was faster than the reporting rate. – Users saw multiple rows with zeros.

• Average and rate meters provide information for performance analysis. • Simple moving average meter – Provides an average for the last 15 minutes – Used for long running transactions

• Rate of progress meter – Computes the rate per-minute for a counter that is based on the last 15 minutes – Used for counters like objects indexed per-minute © Copyright IBM Corporation 2013, 2015

Figure B-45. Average and Rate Meters

F1156.0

Notes: Help path • IBM FileNet P8 Version 5.2 Information Center > Administering FileNet P8 > Performance tuning IBM FileNet P8 components > Tuning IBM FileNet P8 Content Platform Engine > Tuning IBM Content Search Services > Tuning operating system resources for indexing performance > Monitoring system performance Average and Rate meters provide more useful data for long running transactions, such as Content Search Services indexing. Moving average and rate of progress meters provide useful information. For example: The average amount of time it takes to full index an object making it available for full text searches, beginning from the time an object is submitted/created in Content Platform Engine. The ability to determine the impact of a configuration change such as adding a new CSS server or Index Area. The “Objects Indexed per-Minute” counter provides a way to monitor the impact of the change. Determine whether a chronic indexing failure problem exists. Retries of indexing batches and retries of object indexing failures. © Copyright IBM Corp. 2013, 2015



B-101

Student Exercises

Provide detail analysis by using a break out view of counters by type of text extraction, CSS server, index job, Index Area, and other factors. Provides useful insight, such as whether an issue with a specific index area exists.





EXNoSideHead


Overview of CSS Counters • Index Job – Rates of index requests submitted and indexed per-minute. – Includes a subbreakout for each individual job.

• Indexing Batch – Counters for the tasks that are indexing data to the full text indexes. – Includes a subbreakout by index area.

• Search – Full text search counters which include the number of worker threads, number of full text indexes searched. – Object Store searches can span many full text indexes and CSS servers.

• Text Extraction – Example: Number of text extractions performed per-minute. – Includes a subbreakout by text extraction type. © Copyright IBM Corporation 2013, 2015

Figure B-46. Overview of CSS Counters

F1156.0

Notes: The functional areas reported by the CSS server are: Index Search, which provides search counters by the CSS server and a specific index. This area is not a representation of the cost of the user CBR search. For User CBR search information you must view the object store search counters. Indexing Batch, which provides counters for the tasks that index data for full text indexes.




B-103

Student Exercises


Get started with System Dashboard • Use Start menu in Windows, Dashboard shell script in UNIX. • You must use a cluster in order to view Listener data. – A cluster can contain one or more servers. – It normally contains all servers that are related to a particular application. – All Listeners on the servers in a cluster are discovered automatically.

• You can define any number of clusters. • To define a cluster, do the following steps: – Name the cluster and add the servers. – Specify how often Listener data is accumulated.

• Optional steps – Override the time span for summary data collection. – Override the number of data points. – Save the settings in an XML file to reuse the cluster. © Copyright IBM Corporation 2013, 2015

Figure B-47. Get started with System Dashboard

F1156.0

Notes: Start System Dashboard To start IBM System Dashboard for Enterprise Content Management in Windows, click Start > Programs > IBM FileNet P8 Platform > Dashboard. To start IBM System Dashboard for Enterprise Content Management in UNIX, start the manager shell script called Dashboard from the directory that contains the required JAR files. Clusters: You can create a single cluster that defines all your hosts. Or you can create multiple clusters, one cluster for each service. In this case, the cluster is a logical grouping of servers that you want to view together, because only when all of them are working well is the service working well. By defining a cluster for each service, you can view just the data for the servers and components that support one service rather than seeing all the hosts at the same time. Example: You define a cluster for a mortgage service and another cluster for a bank accounts service. Each cluster consists of the servers that customers can connect to for information on their mortgage and their bank accounts, respectively. The bank cluster consists of an Application Engine, Content Platform Engine, and Process Services combination. The mortgage cluster includes multiple instances of each engine.





The cluster allows you to concurrently monitor the performance metrics of applications that run on EXNoSideHead the servers included in the cluster. System Dashboard uses an automatic discovery process to find the Listeners running on the specified hosts.  Tip: Use cluster names that describe their functions. Each cluster definition includes an Interval setting, which defines how frequently data is sampled from the applications within that cluster. If the interval is not defined, IBM System Dashboard for Enterprise Content Management accepts samples at the Listener default sampling rate. If multiple Listeners are used, they can be configured with different polling schedules. In that case, it is best to define the interval so that data is aggregated at a consistent interval. Tip: The Image Manager and workflow system Listeners ignore the interval setting. Their interval is determined by the polling schedule set in the configuration file perf_mon.script. Each cluster definition includes a data points value. This value specifies how many data blocks are saved in memory by IBM System Dashboard for Enterprise Content Management . The interval setting does not affect the data points value. Edit the Max Data Points value to overwrite the default, which is 500. This value is the default number of interval details that Dashboard keeps in the display. Edit the TCP port numbers (only if necessary).




B-105

Student Exercises


Use Listener Options and View Data • In Details, right-click Listener node and click an option. – – – – – –

Query it for the health status (heartbeat) of its application. Query it for the uptime of its application. Save (archive) the data that the Listener gathers. Send a custom message to the Listener. Disconnect a Listener (if its historical data is not needed). Request user list (provides a list of all users signed in by name).

• View accumulator data in tables and charts. – Select the accumulator node and view data numerically. – Or right-click the accumulator node and click a chart option. • Move and size the graph window as you like. • Select Chart in the graph window, select other graph option, click OK, and view the data as you selected the view. © Copyright IBM Corporation 2013, 2015

Figure B-48. Use Listener Options and View Data

F1156.0

Notes: The Request user list option is available only for the Content Platform Engine. Typically, you disconnect Listeners that are monitoring stopped components when you are no longer interested in their historical data the data is archived. If you reconnect to a Listener after disconnecting from it, you must stop and start System Dashboard.





EXNoSideHead


Activities In your Student Exercises • Unit: System Maintenance • Lesson: Use System Dashboard • Activities: – Monitor the System State – Run Dashboard Reports – Reconnect a Listener



F1156.0





B-107

Student Exercises






B.8, "Use System Dashboard"

Overview Why is this lesson important? The IBM System Dashboard tool is installed on a machine within your IBM FileNet P8 Content Manager system. You need to know how to use this tool to monitor the components of your system.

Activities • Monitor the System State: Activity, on page B-111 • Run Dashboard Reports: Procedure, on page B-117 • Reconnect a Listener: Practice, on page B-121

User accounts Type

User ID

Password

Operating system

administrator

passw0rd


P8Admin

IBMFileNetP8





B-109

Student Exercises





Monitor EXNoSideHead

the System State: Activity

Introduction In this activity, you use IBM System Dashboard to view Listener data. You view the system status. You disconnect a Listener and then reconnect it.

Procedures Procedure 1, "Start the simulation program," on page B-111 Procedure 2, "Define a cluster," on page B-111 Procedure 3, "Check component status," on page B-113 Procedure 4, "View counter data," on page B-114 Procedure 5, "Find CBR counter information," on page B-114 Procedure 6, "Disconnect a listener," on page B-115 Procedure 7, "Use the Alerts view for important messages," on page B-115 Procedure 8, "Reconnect a Listener," on page B-116

Procedure 1: Start the simulation program Use the following instructions to start a program that is named Synth CE Java on your Windows student system. This Java program is a test program that exercises some of the functions of the Listener API. Synth CE Java does not interact with the IBM FileNet P8 servers. Because this program has an embedded Listener, you can monitor it with IBM System Dashboard for ECM. 1. Double-click the demo.bat file in the C:\LabFiles\SystemAdministration folder. 2. Minimize the DOS window and leave the program to run until you complete the activities for this lesson and are instructed to close it.

Procedure 2: Define a cluster Define a cluster that allows you to monitor the demonstration application, the Content Engine, Process Engine, and Workplace XT from your Windows student system. 1. Start IBM System Dashboard for ECM. a. Click Start > All Programs > IBM FileNet P8 Platform > Dashboard. Information No data is shown in the Average Response Time chart or Current Status chart on the Summary tab. No data is reported because the student system does not yet have clusters.




B-111

Student Exercises

2. Define a cluster: a. Click the Clusters tab. b. Click New. c. In the Add Cluster window, type C1 as the cluster name, and click OK. 3. Specify the servers in the cluster: a. On the Clusters tab, select the cluster that you defined, and click Edit. b. Click Add to add a new host. c. In the Add Host field, type ecmedu01. d. Accept the default number for the Primary Listener Port, 32775. e. Click OK to enter the server information. f.

Type 5 in the Interval field. Information

The amount of activity data that you are going to generate while using this cluster is minor compared to the volume of data generated by a production system. In this step, you reduce the data collection period to 5 seconds so that the activity data that you generate manually is visible in the Dashboard.

g. Click OK to save the C1 cluster. h. Verify that you see messages in the Messages area that indicate a connection.

Information Connection messages are displayed in the Messages pane at the bottom of the Dashboard console. Each message identifies a component with an active Listener on the hosts in the cluster.

4. Verify that the following listeners are connected: - ECMTS (Content Search Services) - WorkplaceXT - IBM FileNet Content Platform Engine PVU Non Prod (Content Services)





EXNoSideHead - IBM FileNet Content Platform Engine PVU Non Prod ICF PE (Process Services) - Synth CE Java (Activity simulator) 5. Save the cluster. a. Click File > Save Clusters. b. In the Save window, browse to the My Documents folder. c. Type C1 as the file name. d. Click Save.

Procedure 3: Check component status Use Listener options from the Details view to check whether an application on a server is running and to check how long the application has been running. The Dashboard is open and the C1 cluster is loaded. 1. In the IBM System Dashboard for ECM window, open the Details tab. 2. Double-click the C1 cluster node to expand it. 3. Expand the ecmedu01 host node. Information A container node represents each component that a Listener monitors. This container node is the Listener node, and its context menu is the Listener menu. The Listener node has the name of the monitored component.

4. Check whether the Content Platform Engine is running. a. Right-click the Listener node for IBM FileNet Content Platform Engine PVU Non Prod. b. Click Request heartbeat. c. Verify that you see a new message in the Message area that shows that the listener is up. Important Be sure to select the proper node. You might see more than one node that begins with the text IBM FileNet Content Platform Engine. Tip: You can expand the left pane to see the entire node names by moving the panel border.

5. Check how long the FileNet P8 Content Engine application has been running. a. Right-click the Listener node for IBM FileNet Content Platform Engine PVU Non Prod. b. Click Request uptime. c. Verify that a message reports how many seconds the Listener has been up (running). © Copyright IBM Corp. 2013, 2015



B-113

Student Exercises

Procedure 4: View counter data Each Listener provides data at each sampling interval. You can view the activity on the disk, RPC calls, and other information in near real time. 1. On the Details tab, expand IBM FileNet Content Platform Engine PVU Non Prod > Disk > Reads. 2. Observe the Count, Rate Per Second, and Total Count columns. 3. Open and view other counter data: - IBM FileNet Content Platform Engine PVU Non Prod > CPU > Busy - IBM FileNet Content Platform Engine PVU Non Prod > CPU > jvm_free_memory 4. Verify that the times in the Time column are configured at 5-second intervals. a. Scroll to the bottom of the Performance Data table. b. Observe that a new row is added every 5 seconds. c. Observe that the times are recorded at 5-second intervals. Information You configured the time interval when you defined the C1 cluster.

Procedure 5: Find CBR counter information Longer term counters are added for Full Text Search indexing jobs. You can find this information for each index area in the object store node. 1. Expand IBM FileNet Content Platform Engine PVU Non Prod > User > Sales > CBR > Index Job.





2. Verify that you can find counters that are used for indexing jobs. EXNoSideHead

Procedure 6: Disconnect a listener Use this procedure to disconnect the Listener from the application that it is monitoring and review the results. You are in the Details view, with the C1 node and ecmedu01 expanded. 1. Right-click IBM FileNet Content Platform Engine PVU Non Prod node and click Disconnect this listener. 2. Verify that the Listener node for IBM FileNet Content Platform Engine PVU Non Prod is no longer listed. 3. Verify that a disconnect message for the node is displayed in bold text in the Messages pane.

Procedure 7: Use the Alerts view for important messages Use the Alerts view to check for the critical messages, such as a disconnected Listener. 1. Click the Alerts tab. 2. Verify that the same message that you see in bold text in the Messages pane is also listed in the Urgent Messages pane.




B-115

Student Exercises

Information The Alerts tab makes it easy for you to find important messages when you are monitoring many servers over a time, because messages scroll up out of view when they accumulate in the Messages pane.

3. Select the message in the Urgent Messages pane and click Dismiss. 4. Verify that the Critical disconnection message in the Messages pane at the bottom is still listed.

Procedure 8: Reconnect a Listener Reload the C1 cluster to reconnect to the Listener for the Content Services. 1. Exit System Dashboard. 2. Restart System Dashboard. 3. Load the C1 cluster. a. Click File > Open Clusters. b. Select the C1.xml cluster and click Open. 4. On the Summary tab, select C1. 5. Go to the Details view. 6. Expand the C1 node and the ecmedu01 host node. 7. Verify that all running components with an active Listener on the ecmedu01 server have a Listener node under ecmedu01, including IBM FileNet Content Platform Engine PVU Non Prod. 8. Verify that the connection messages in the Messages pane for the listed components, including a connection message for IBM FileNet Content Platform Engine PVU Non Prod. 9. Leave System Dashboard open for the next exercise.





Run EXNoSideHead

Dashboard Reports: Procedure

Introduction In this activity, you use all the reporting features of IBM System Dashboard. You create a report template and then verify the template works s designed by using it to run a report. You then archive and report Listener data.

Procedures Procedure 1, "Create a report template," on page B-117 Procedure 2, "Run a report," on page B-118 Procedure 3, "Examine the report," on page B-118 Procedure 4, "Archive and report Listener data," on page B-119 Procedure 5, "Run a report on archived data," on page B-120 Procedure 6, "Inspect a report on archived data," on page B-120

Procedure 1: Create a report template In this procedure, you configure a report template by selecting the counters to be included in the report content. 1. Start IBM System Dashboard if it is not already started. 2. Create a report template; a. Open the Reports tab. b. Click New. c. Name the template: CPE Template. d. Click OK. 3. Select data to be included in the report: a. Click Edit. b. Expand C1 > ecmedu01 > IBM FileNet Content Platform Engine PVU Non Prod > CPU. Hint Expand the window to see the full names of the Listeners.

c. Select jvm_total_memory. d. Click Add to Template. e. Select IBM FileNet Content Platform Engine PVU Non Prod > RPC > ExecuteChanges > Requests. © Copyright IBM Corp. 2013, 2015



B-117

Student Exercises

f.

Click Add With Children.

g. Select IBM FileNet Content Platform Engine PVU Non Prod > RPC > ExecuteChanges > Requests In Progress. h. Click Add to Template 4. Click OK to complete edits. 5. Save the report template: a. Click File > Save Report Templates As. b. Browse to My Documents. c. Type CPE_Template as the template name. d. Click Save.

Procedure 2: Run a report In this procedure, you modify the report template to accommodate the current need for data, and then run and examine the report. 1. From the Reports tab, select the report template, CPE_Template. 2. Click Run. 3. Specify the report parameters in the CPE Template window: a. Select C1 > ecmedu01 > IBM FileNet Content Platform Engine PVU Non Prod. b. Select the following options for the report in the Options pane: • Environment • Average • Sum c. Type 1 in the Length in hours field. 4. Save the report as a file: a. Click the ellipsis button (...) next to the Output To field. b. Browse to My Documents. c. Type CPE_Report for the file name. d. Click Save. 5. Click Run.

Procedure 3: Examine the report 1. Using Windows Explorer, go to My Documents.





2. Open CPE_Report.csv by using WordPad. EXNoSideHead Information The data is presented in the following sequence: • Environment variables • Metric headings • Data for the duration specified • The average and sum of each metric

3. Close the report file.

Procedure 4: Archive and report Listener data In this procedure, you archive the data that the Listener collected within the last 48 hours. Afterward, you run a report of the archived data. 1. Archive the data that is collected by the Listener by using the archive defaults: a. In the System Dashboard, open the Details tab. b. Expand C1 > ecmedu01. c. Right click IBM FileNet Content Platform Engine PVU Non Prod and then click Archive history. d. Browse to My Documents. e. Type CPE_Archive for the file name. f.

Click Save.

g. Wait for the History archived message. h. Click OK. Information The CPE_Archive file is a proprietary binary file that is used to generate views and reports of archived data.

2. Add the archive file to the Archives cluster. a. From the Details view, click File > Open Archive. b. Select My Documents > CPE_Archive. c. Click Open. d. Wait for the archive to open. © Copyright IBM Corp. 2013, 2015



B-119

Student Exercises

e. Double-click the Archives cluster that is displayed in the tree view pane. f.

Expand the ecmedu01 > IBM FileNet Content Platform Engine PVU Non Prod node. Note

The label for the IBM FileNet Content Platform Engine PVU Non Prod container in the Archives cluster is red and contains the message currently unavailable. This message exists because the node is not displaying data from an active Listener connection.

3. View the archived data by selecting and expanding nodes under the IBM FileNet Content Platform Engine PVU Non Prod container.

Procedure 5: Run a report on archived data 1. Open the Reports tab. 2. Select the CPE_Template and then click Run. 3. Expand the Archives > ecmedu01 node. 4. Select IBM FileNet Content Platform Engine PVU Non Prod. 5. Select all of the options in the Options pane. 6. Type 2 in the Length in hours field. 7. Click the ellipsis (...) beside the Output To field. 8. Browse to My Documents. 9. Type CPE_Archive_Report as the file name. 10. Click Save and then click Run. 11. Close System Dashboard. 12. If demo.bat is still running, stop it by closing the window.

Procedure 6: Inspect a report on archived data 1. Use Windows Explorer to go to My Documents/ 2. Open CPE_Archive_Report.csv by using WordPad. 3. Inspect the file. 4. Close the file when you are finished.





Reconnect EXNoSideHead

a Listener: Practice

Introduction In this exercise, you observe the Dashboard when one of the monitored components goes offline. You then restart the component and restart the Listener.

Scenario The Content Search Services server goes offline after a power fluctuation. The server was restarted. You observe the changes to the system remotely by using the System Dashboard.

Challenge • Start System Dashboard. • Use Windows Services to stop the CSS Server service. • View the Dashboard messages. • Request a heartbeat from each Listener. • Determine which Listener is offline. • Use Windows Services to restart the CSS Server service. • Restart the Listener for CSS Service.

Verification Verify that you can find information about the ECMTS Listener going down, either in the Messages window, or in the Alerts tab. Verify that you can get a heartbeat from the ECMTS Listener after you restart the ECMTS Listener.




B-121

Student Exercises

Summary In this lesson, you did the following tasks: • Started System Dashboard. • Created a cluster. • Viewed Listener status. • Viewed Listener data. • Disconnected and reconnected a Listener. • Ran a report. • Archived Listener data. • Ran a report on archived data.





Appendix C. Answers to Written Exercises

EXNoSideHead

Introduction This appendix includes answers to quizzes from the course.

Answers • "Answers to "Identify functions of IBM FileNet Content Manager solutions: Written exercise" on page 1-5" on page C-3 • "Answers to "Explore the architecture: Interactive exercise" on page 1-7" on page C-5 • "Answers to "Identify system components: Written exercise" on page 1-11" on page C-7




C-1

Student Exercises

C-2





Answers EXNoSideHead

to "Identify functions of IBM FileNet Content Manager solutions: Written exercise" on page 1-5 Introduction Identify the functions of IBM FileNet Content Manager solutions. For each question, indicate the correct answer or the best answer. 1. Which product is the core of the IBM FileNet P8 family of products? a. IBM Case Manager b. IBM Content Manager c. IBM FileNet Content Manager d. IBM Content Federation Services Answer = c 2. Which two clients connect to IBM FileNet Content Manager by using FileNet Collaboration Services? a. Microsoft Office and SharePoint b. IBM Connections and Lotus Quickr c. IBM Content Manager OnDemand and SAP d. IBM Enterprise Records and IBM Case Manager Answer = b 3. A user can tag managed objects by using which client? a. IBM Connections b. FileNet Workplace XT c. Administration Console for the Content Platform Engine d. Application Engine Answer = a 4. IBM FileNet Content Manager is the former name of the product IBM Content Manager. True or False? Answer = False




C-3

Student Exercises

C-4






to "Explore the architecture: Interactive exercise" on

page 1-7 Questions Select the best answer. 1. Where does the component integrator for non-legacy components run? a. Application Engine. b. FileNet Workplace XT. c. Rendition Engine. d. Content Platform Engine. Answer = d 2. Which product uses OLAP cubes? a. Case Analyzer b. Rendition Engine c. Datacap d. Image Services Resource Adapter Answer = a 3. Rendition is based on which product? a. Adobe PDF Maker. b. Liquent InSight Rendering c. FileNet Image Services d. Datacap Answer = b 4. What controls document security after it is declared as a record? a. A security template b. A record template c. A record object d. A security object Answer = c 5. What protocol does the Content Platform Engine use to communicate with the Rules Listener? a. SOAP b. TCP/IP c. RPC




C-5

Student Exercises

d. HTTP Answer = b

C-6






to "Identify system components: Written exercise" on page 1-11 Introduction Identify the function of each system component. For each question, indicate the correct answer or the best answer. 1. The Content Platform Engine handles process management services. True or False? Answer = True 2. Which component is not an IBM FileNet P8 component? a. Rendition Engine b. Content Navigator c. Object store d. Directory service Answer = d 3. What is the primary administration tool for the Content Platform Engine? a. Administration Console for the Content Platform Engine b. FileNet Enterprise Manager c. Configuration Manager d. Deployment Manager Answer = a 4. You can log in to Administration Console for the Content Platform Engine, but you cannot see any of the object stores. Which cause is most likely? a. The application server is down. b. IBM FileNet Content Manager is down. c. The directory service is down. d. The RDBMS is down. Answer = d




C-7

Student Exercises

Answers to "Select a Property for an Index Partition: Written Exercise" on page 6-35 Read the notes for each property and then circle the property that would make best candidate for a string index partition. Property

Document title

Notes Inherited from the Document class. String data type. Large number of values that are non-unique. Occasionally used in searches. System property. String data type.

ID

Globally unique identifier. Never used in searches. Custom property.

customer_name

String data type. Large number of values that are non-unique. Often used in searches. Custom property.

customer_id

String data type. Large number of values that are unique. Often used in searches. Custom property.

po_number

String data type. Small number of values that are non-unique. Often used in searches. Custom property.

product_id

String data type. Currently unused. Not used in searches. Custom property.

service_date

DateTime data type.

ANSWER

Sometimes used in searches. po_number

C-8




V10.1

backpg

Back page

IBM Training Filenet CM 5-2 Implementation and Administration - Excercises.pdf

Recommend Documents