eB Web Insight User Guide - Beach Media · Introduction eB Web D002114 rev 1.0, oct 09 page 1 Introduction eB Web provides access to the powerful eB enterprise content and configuration

WEB USER GUIDED002114 rev 1.0

© 2006-9 Enterprise Informatics10052 Mesa Ridge CourtSan Diego, CA 92121

+1 858 625 3000+1 858 625 3010 FAX

http://www.enterpriseinformatics.com

eB Insight version 4 eB Web User Guide

Published by Enterprise Informatics

Information in this document is subject to change without notice and does not represent a commitment on the part of Enterprise Informatics. The software and/or databases described herein are provided under a license agreement or non-disclosure agreement. The software and/or databases may be used or copied only in accordance with the terms of the agreement. It is against the law to copy the software on any medium except as specifically allowed in the license or non-disclosure agreement. The purchaser may make one copy of the software for backup purposes. No part of this manual and/or databases may be reproduced or transmitted in any form or by any means, electrical or mechanical, including photocopying, recording, or information recording and retrieval systems, for any purpose other than the purchaser’s personal use, without the express permission of Enterprise Informatics.

Unless otherwise noted, all names of companies, products, street addresses, and persons contained herein are part of a fictitious scenario or scenarios and are designed solely to document the use of the product.

eB and its logo, and the EI logo, are trademarks of Enterprise Informatics.

Word is a trademark of Microsoft Corporation.

page ii

Table of Contents

Introduction ........................................................................................ 1Logging on ........................................................................................................................... 1

SECTION 1: DOCUMENT MANAGER 3

Window Layout .................................................................................. 3Routine Navigation............................................................................................................... 5Data Scope .......................................................................................................................... 6

eB’s Explorer Options ........................................................................ 7Explorer................................................................................................................................ 7Documents ........................................................................................................................... 8Directory............................................................................................................................... 8Distribution ........................................................................................................................... 9SharePoint ........................................................................................................................... 9File Plans ............................................................................................................................. 9Items .................................................................................................................................... 9Work Exchange.................................................................................................................... 9Bulk Import/Export.............................................................................................................. 10

Import/Update Documents.................................................................................. 10Import Folders/CDs ............................................................................................ 10

Publisher ............................................................................................................................ 10Basket ................................................................................................................................ 12My eB ................................................................................................................................. 13

Common eB Procedures .................................................................. 15Viewing a Document .......................................................................................................... 15Viewing Document History ................................................................................................. 15File Actions......................................................................................................................... 15

File Transfer ....................................................................................................... 15File Checkout...................................................................................................... 16Launching Files .................................................................................................. 16Rendition ............................................................................................................ 17Adding Files........................................................................................................ 17

Editing Document Information............................................................................................ 17Making a Copy of a Document........................................................................................... 19Deleting a Document.......................................................................................................... 19Adding and Deleting Folders.............................................................................................. 20Adding a New Object ......................................................................................................... 21E-mail ................................................................................................................................. 26eB Reports ......................................................................................................................... 28

User-Defined Reports ......................................................................................... 28eQL Queries ....................................................................................................... 34Objects ............................................................................................................... 34

Folder Reports ................................................................................................................... 35

Searches .......................................................................................... 37Search result reporting ....................................................................................... 38

Preferences ...................................................................................... 39

page iii

Document Distribution........................................................................................................ 40eB Web .............................................................................................................................. 40File Options ........................................................................................................................ 40Filters ................................................................................................................................. 40Publish Options .................................................................................................................. 41Search Options .................................................................................................................. 41System Default ................................................................................................................... 41

SECTION 2: WORK EXCHANGE 43Forthcoming........................................................................................................ 43Inbox................................................................................................................... 43Work in progress ................................................................................................ 43Completed .......................................................................................................... 43Delegated Work.................................................................................................. 43Approvals............................................................................................................ 44

Frequent Work Exchange Operations................................................................................ 44

SECTION 3: CHANGE MANAGEMENT 47

Change Management in eB Web ..................................................... 47Declaration that a data object is change-controlled ........................................................... 47Initiating a change request ................................................................................................. 47Change Request Tracking ................................................................................................. 49Change Request Status ..................................................................................................... 50Change Effects Analysis .................................................................................................... 51Implementing a Change Request....................................................................................... 52Editing a Change Request ................................................................................................. 53Copying a Change Request ............................................................................................... 53Deleting a Change Request ............................................................................................... 54

SECTION 4: PHYSICAL ITEM MANAGEMENT 55

Physical Item Management in eB .................................................... 55Editing physical items......................................................................................................... 56Copying a Physical Item..................................................................................................... 57Baseline management ....................................................................................................... 58Item List Management........................................................................................................ 59Serialized Item List Management....................................................................................... 59Creating a New Physical Item ............................................................................................ 59

page iv

List of Figures

Figure 1: eB-Web standard login dialog ...................................................................................................... 1Figure 2: Typical three-pane screen layout ................................................................................................. 3Figure 3: Content pane fully exposed showing all information about a physical item ................................. 5Figure 4: Main action button-row ................................................................................................................. 5Figure 5: Scope selector.............................................................................................................................. 6Figure 6: Tasks typically available in Explorer............................................................................................. 8Figure 7: Example of part of a directory ...................................................................................................... 8Figure 8: Distribution option list ................................................................................................................... 9Figure 9: Publisher package wizard, step 1............................................................................................... 10Figure 10: Publisher package wizard, step 2............................................................................................. 11Figure 11: Publisher package wizard, step 3............................................................................................. 11Figure 12: Publisher package wizard, step 4............................................................................................. 12Figure 13: Example of a basket................................................................................................................. 12Figure 14: Start of the document distribution wizard ................................................................................. 13Figure 15: Adding a data object to ‘My eB’................................................................................................ 14Figure 16: Example of document history ................................................................................................... 15Figure 17: The document checkout dialog ................................................................................................ 16Figure 18: Example of the ‘lock’ icon beside a checked-out document..................................................... 16Figure 19: Options in the document rendition dialog ................................................................................. 17Figure 20: Example document detail edit form .......................................................................................... 18Figure 21: Example document structure edit form..................................................................................... 19Figure 22: The Copy Document dialog...................................................................................................... 19Figure 23: Setup for adding a folder at root............................................................................................... 20Figure 24: Creating a folder at root............................................................................................................ 21Figure 25: Example template for purchased software ............................................................................... 22Figure 26: Add New document shortcut dialog.......................................................................................... 23Figure 27: Part of the new data object detail sheet ................................................................................... 23Figure 28: The document create dialog..................................................................................................... 24Figure 29: The project create dialog.......................................................................................................... 24Figure 30: The person create dialog.......................................................................................................... 25Figure 31: The organization create dialog ................................................................................................. 25Figure 32: The location create dialog ........................................................................................................ 26Figure 33: Location object showing child locations ................................................................................... 26Figure 34: E-mail window at start .............................................................................................................. 27Figure 35: Example of e-mail recipient list................................................................................................. 28Figure 36: Typical reports menu................................................................................................................ 28Figure 37: User-defined reports -- Info and Task panes............................................................................ 29Figure 38: User-defined report display ...................................................................................................... 29Figure 39: Reporting wizard page 1: Report Type..................................................................................... 30Figure 40: Reporting wizard page 2: Criteria (blank)................................................................................. 31Figure 41: Reporting wizard page 2: Twin drop-down lists........................................................................ 31Figure 42: Effective date criterion completed ............................................................................................ 32Figure 43: Reporting wizard page 3: Columns .......................................................................................... 32Figure 44: Reporting wizard page 4: Column Ordering ............................................................................. 33Figure 45: Reporting wizard page 5: Format/Execute ............................................................................. 33Figure 46: Example of finished report........................................................................................................ 34Figure 47: Example of an eB system object presentation ......................................................................... 35Figure 48: Folder reporting link in the Task pane ...................................................................................... 35Figure 49: Folder reporting options, Content pane.................................................................................... 35Figure 50: Example folder report ............................................................................................................... 36

page v

Figure 51: Template selection for Folder Reporting ................................................................................. 36Figure 52: Document search options......................................................................................................... 37Figure 53: Search results table (partial) .................................................................................................... 38Figure 54: Search object type selector ...................................................................................................... 38Figure 55: Preference Editor, unexpanded................................................................................................ 39Figure 56: Sample of part of an ‘about’ window ........................................................................................ 40Figure 57: Filter preferences dialog........................................................................................................... 41Figure 58: Unexpanded work exchange tree............................................................................................. 43Figure 59: E-mail notification of an incoming task ..................................................................................... 44Figure 60: Forthcoming task folder, expanded .......................................................................................... 44Figure 61: Typical forthcoming task details ............................................................................................... 45Figure 62: Task pane options for forthcoming work .................................................................................. 45Figure 63: Summary table of inbox tasks .................................................................................................. 46Figure 64: The ‘Delegate Task’ dialog....................................................................................................... 46Figure 65: Edit screen of a change-controlled object ................................................................................ 47Figure 66: Change request icon/link.......................................................................................................... 48Figure 67: Required fields in a change request form................................................................................. 48Figure 68: Example of an Affected Document........................................................................................... 49Figure 69: Part of a change request navigator .......................................................................................... 49Figure 70: Dialog for recording a status change........................................................................................ 50Figure 71: Example change effects analysis report................................................................................... 51Figure 72: The main Implement dialog ...................................................................................................... 53Figure 73: Dialog for copying a Change Request...................................................................................... 54Figure 74: The Physical item explorer ....................................................................................................... 55Figure 75: Typical physical item detail sheet............................................................................................. 56Figure 76: Physical item edit form ............................................................................................................. 57Figure 77: Copy Physical Item dialog ........................................................................................................ 58Figure 78: Baseline creation dialog ........................................................................................................... 58Figure 79: Physical Item List dialog........................................................................................................... 59

page vi

page vii

Introduction eB Web

IntroductioneB Web provides access to the powerful eB enterprise content and configuration management platform, designed for viewing via the Internet in a standard web browser window. Most modern browsers can dis-play and control eB Web, but MSIE 6+ is particularly recommended. Java must be enabled for some func-tions, and some popup blockers may interfere with eB Web screen renderings.

Browser navigation buttons may be used in the normal way to navigate your history list, e.g. to return to a previous screen.

eB Web is capable of accessing documents and physical items stored in the eB platform across the enterprise, or around the world, using a standard web browser.

eB Web presents assigned work order tasks via the Work Exchange option. eB Web includes two user-specific areas known as My eB and the Basket, which may be uti-

lized to store often-accessed data. eB Web can generate and distribute reports. eB Web can manage publishing packages. eB Web can interface with your SharePoint documents.

Logging onTo access eB Web, you are allocated a URL that connects to your company’s eB data sources, sometimes referred to as communities. You are, obviously, assigned a unique user name and password. If your com-pany has several communities, you need to select which community to connect to using the drop-down list on the third line of the login dialog.

Figure 1: eB-Web standard login dialog

The user name is forced to upper case, and the password is case sensitive. Checking the ‘Options’ box exposes two further choices: A choice of server name, and an option to remember your password.

To log out of eB Web, locate the red logout button at top right of the Navigator pane. If you do not log out using this method, eB License Manager will be unaware that you have logged out. Consequently, if you are using a named license, and try to log back in, the eB named license will be deemed to be in use, so access will be denied. Once 15 minutes of inactivity has elapsed a license timeout will occur. The license will then be available for the user to log back in.

D002114 rev 1.0, oct 09 page 1

eB Web Introduction

page 2 D002114 rev 1.0, oct 09

Window Layout eB Web

SECTION 1: DOCUMENT MANAGERWith the fully-installed eB document manager, a user can manage and present enterprise information related to documents, people (within the corporation and not), organizations, locations, physical items and serialized items as well as change management and records management. If your eB system does not include all of the eB products, some of the components and functionality described in this section will not be available.

Window LayoutThe eB Web window can contain up to three panes. Figure 2 shows a typical window arrangement with the Navigator/Search pane at left, the Content pane in the middle and the Task pane at right.

Figure 2: Typical three-pane screen layout

To reach this screen status, the Documents option has been selected from the drop-down menu at the head of the Navigator pane, then the Knowledgebase Article document class in the explorer tree has been expanded, and one of the documents in that folder selected.

Navigation pane Content pane Task pane

D002114 rev 1.0, oct 09 page 3

eB Web Window Layout

Note: In eB, a Document can contain an arbitrary number of individual files. The document shown contains one .doc file.

When viewing documents in the Content pane, the Sections area is present in the Task pane. You have the option of switching between the Details, Structure, and History default views of a document in the Content pane, by clicking on those links (The eB Web layout editor allows these information layout sections to be changed).

Note: The vertical border between the Navigator pane and the Content pane may be dragged to any position. In its rightmost position the Navigator pane fills the entire screen width. In its leftmost posi-tion, the Navigator pane is obscured. The Task pane (if any) stays the same width. Figure 3 shows the Content pane expanded to accommodate a physical item, with several associated documents and other links.

The ‘View Files’ option in the Media section of the Task pane opens a new browser window allowing rapid browsing of all files in the document. The ‘Launch files’ option opens files in their native application. ‘Get Local Copy’ initiates a file download to your own file structure.

Other Task pane options are described later in this document: Edit: “Editing Document Information” on page 17 Add: “Adding and Deleting Folders” on page 20 Copy: “File Transfer” on page 15 Add to Basket: “Basket” on page 12 Delete: “Adding and Deleting Folders” on page 20 Check Out: “File Checkout” on page 16 Launch Files: “Launching Files” on page 16 Render: “Rendition” on page 17 E-mail: “E-mail” on page 26

page 4 D002114 rev 1.0, oct 09

Window Layout eB Web

Figure 3: Content pane fully exposed showing all information about a physical item

Routine NavigationAt the head of the Navigation pane is a row of (typically seven) buttons in an action bar. These buttons control the content of that pane. They’re depicted and labeled in Figure 4.

Figure 4: Main action button-row

As with most navigation or directory trees, a plus-box to the left of a folder name indicates that the folder may be expanded to expose sub-folders one level down, by clicking on the plus-box. Click on the

minus-box to compress the sub-folders again. In eB Web, an up arrow-box also means that a topic is

expandable to show more information. Likewise the down arrow-box can be used to re-compress the line. Figure 3 shows the Events and Physical Item Links topics expanded.

Set preferences

Navigation mode

Add objects

System reports

Search

Help (this document)

Logout

D002114 rev 1.0, oct 09 page 5

eB Web Window Layout

Data ScopeA scope is a means for partitioning data within a single eB community. Each scope may have its own set of classes, attributes, templates, organizations, and people. Certain list values, e.g. Responsibilities, may also be unique to a scope.

Scope names within a community must be unique. Users, via their assignments to roles, have rights to access data in some scopes but not others.

As part of the installation of a community, a default scope, named Global, is created. Additional Scopes are only required where there is a requirement to create and maintain data in the same community that may exist independently of other data. Examples where this may be applicable are Project-based data and Organizational data.

A scope may be in a hierarchical structure, e.g. where there is a PROGRAM that is made up of many smaller PROJECTS. The program would be the parent scope and each project would be a child of this par-ent scope.

Users are able to view and use data from the Global scope, as well as from any scope associated with a role to which they belong, and any other parent scope. In order to be able to access a scope, the user must belong to at least one role in each scope in the hierarchy.

Immediately under the action bar is a prominent bar displaying the current data scope. The scope ID is an active link, popping up a scope selector.

Figure 5: Scope selector

page 6 D002114 rev 1.0, oct 09

eB’s Explorer Options eB Web

eB’s Explorer Options

To return to the navigation mode from searching or adding a new object, use this button: At the head of the Navigation pane is a drop-down list that typically includes the following items:

Explorer Documents Directory Distribution SharePoint File Plans Items Work Exchange Bulk Import/Export Publisher Basket My eB

Depending on your eB License and chosen plug-ins, your administrator may well have set up other explor-ers. Each of these explorer options is a specific Navigator. Selection of any one navigator completely changes the content of the Navigation pane, reflecting a view of the eB system that’s restricted so that the user may conveniently focus on one set of information. In general, a navigator is a list of links to content that may be selected and displayed in detail. A navigator is often, but not necessarily, a tree structure.

ExplorerThe Explorer exposes the system-defined folder structure of the eB community you are connected to. When you log on to eB Web, or when you select this navigator from the drop-down list, the System Root appears in the Content pane (see the section “Adding and Deleting Folders” on page 20 to learn how to create a new folder in the System Root.) You can then expand any part of the tree, drilling down through the folders, to any coherent group of data objects. At all times, the tasks that are appropriate and that you have permis-sion for appear in the Task pane. An example is shown below.

D002114 rev 1.0, oct 09 page 7

eB Web eB’s Explorer Options

Figure 6: Tasks typically available in Explorer

DocumentsThe Document class navigator provides another approach for accessing documents in the eB system by focusing on the hierarchical document class structure. You can expand the class tree to see a list of docu-ments for a particular class. Selection of an actual document changes the content of the Content pane to show the details of that document. You can view and update a document as described in the Common eB Procedures section on page 15. You cannot add folders to, or delete folders from, this hierarchy.

DirectoryThe Directory explorer is like a multi-level rolodex, storing categorized information on employees, custom-ers, vendors, etc. Your system administrator defines which person, location or organization objects are to be included in the Directory explorer.

Figure 7: Example of part of a directory

A directory content pane for an organization displays the key contact personnel, the directory information, related personnel (person objects,) and related organizations. Selection of a personnel name shows an individual 'rolodex card.’

Note: Creating a new record in the directory is an administrator function only.

page 8 D002114 rev 1.0, oct 09


DistributionThis explorer manages your document distribution lists. You can have as many of these lists as you wish, or you can pick individual distributees from a global list at the time you release your documents — typically from the Basket.

A wizard steps you through the distribution process.

Figure 8: Distribution option list

Other distribution options are as shown above.

SharePointMicrosoft SharePoint is a collaborative environment for information exchange and document manage-ment, applicable over a LAN, a WAN, or a VPN. This embedded feature allows you to expose any eB object to the SharePoint library.

Refer to the document eB for SharePoint for more detail.

File PlansFile Plans are long-term document management schemes that are the subject of a separate document, eB Records Management.

ItemsThis explorer focuses on physical items. See “SECTION 4: PHYSICAL ITEM MANAGEMENT” on page 55.

Work ExchangeSee “SECTION 2: WORK EXCHANGE” on page 43.

D002114 rev 1.0, oct 09 page 9


Bulk Import/ExportThe purpose of the Bulk Import/Export Utility is to allow selected users a mechanism to perform a bulk import/export routine of documents or folders into eB.

To ensure data is imported into eB in an improved manner and to ensure better performance is achieved, the generic document import process has been split into two steps. The steps can be run independently from each other, ensuring maximum use of the time allowed for data imports although each step is devel-oped to provide a logical sequence.

Import/Update DocumentsUsers who have 'Bulk Updates' permission have a menu option to bulk import/update documents using Excel spreadsheets. The images for the import should reside in a shared directory or UNC path determined by the Administrator.

Import Folders/CDs Users have a menu option to bulk import directories as folders and files as electronic files using directory structures in their disks/electronic media. The images for the import should reside in a shared directory or UNC path determined by the Administrator.

PublisherIn this explorer you can create, modify, delete and/or publish packages of eB objects. Figures 9 through 12 show the four steps of the publisher package creation wizard.

Figure 9: Publisher package wizard, step 1

page 10 D002114 rev 1.0, oct 09




D002114 rev 1.0, oct 09 page 11



BasketThe basket is very similar to a shopping cart on a commercial web site. Any item that can be displayed in the Content pane can be placed temporarily in the basket simply by clicking on ‘Add to Basket’ in the Actions section of the Task pane. Figure 13 illustrates a basket. Unlike a commercial shopping cart, the basket does not expire after a fixed time. All links remain in the basket until removed. Place anything in the basket that you’d like to keep handy for quick reference or work—it’s your personal area of eB Web.

Figure 13: Example of a basket

page 12 D002114 rev 1.0, oct 09


To remove some of the basket contents:1. Check the boxes to the left of any items you wish to remove.2. Click on ‘Remove Selection.’

To clear the basket completely:1. Click on ‘Empty.’

Removing items from the Basket does not delete them from the eB system. Basket items are merely point-ers to data.

To distribute basket contents:1. Check the boxes to the left of any items you wish to distribute.2. Click on ‘’Distribute Documents.’

The distribution wizard launches in the Content Pane, as shown below:

Figure 14: Start of the document distribution wizard

The distribution wizard takes you through a decision tree with a varying number of steps depending on your choice of distribution options.

My eBAnother personal data area of eB is designated ‘My eB.’ Use it to organize in folders any eB objects that you are interested in, including personal search routines.

Anything that can be located by the Explorer can be placed in My eB.

To add a data object to ‘My eB’:1. Display the object in the Content pane.2. In the Task pane, click on the ‘Add to Folder’ link.3. In the folder list that pops up, verify that ‘Use the selected folder’ is selected and highlight ‘My eB.’4. Click on the ‘Complete >’ button (see Figure 15).

D002114 rev 1.0, oct 09 page 13


Figure 15: Adding a data object to ‘My eB’

page 14 D002114 rev 1.0, oct 09

Common eB Procedures eB Web

Common eB ProceduresOnce a data object has been selected from one of the explorers in the Navigator pane, there are many ways in which it may be handled. Depending on the permissions of the user, it may be viewed, edited, trans-ferred, checked out, copied or deleted.

Viewing a DocumentClicking on a file name (at the bottom of the Content pane) causes the file to open for inspection. Depend-ing on your eB settings, it may open either in the ViewCafé viewer, if that plugin is installed, or in its native application (Adobe Reader or Microsoft Word, e.g.) with all controls including on-screen help. It may also open within the eB window.

Note: In general, ‘View’ invokes the Java ViewCafé generic viewer, while ‘Launch’ opens the file in its native application. You may be prompted with a File Download dialog, confirming the file type and offering the options of ‘Download’ or ‘Open.’ If you select ‘Open’ in this dialog, the file opens within the eB Web window.

When a file opens within eB, the Content pane remains open but the Task pane disappears. The large pane in which the document opens is sometimes referred to as the Page pane. Most of the native menus and controls are available, but editing is inhibited in this mode.

To return to the three-pane display, simply click on the document class in the Navigation pane again.

If the document to be displayed is non-literary—a photograph, or a movie, for example—it may open in the Viewer as ‘read-only.’ If an application capable of displaying the file exists on the user’s workstation it may also open within that application with full control. The ‘launch’ option (see “Launching Files” on page 16) would force the file into the separate application.

Viewing Document HistoryIf the ‘History’ link is available in the Sections area of the Task pane, you may click on it to bring the doc-ument’s edit history into the Content pane. The topic is listed as Audit Details, and every eB object has this topic. The name of the person responsible for each edit, and the date it was carried out, are listed for each audit event.

Figure 16: Example of document history

File ActionsFile TransferYou may wish to transfer a document to your local computer or workstation, and (so long as you have the necessary permission) there are several ways of accomplishing this.

D002114 rev 1.0, oct 09 page 15

eB Web Common eB Procedures

You can click on the file name, exactly as for viewing the document, but answer ‘download’ instead of ‘open’ in the Windows File Download dialog.

File CheckoutIf the ‘Check Out’ link is available in the Edit section of the Task pane, you can use that. A dialog appears in which you can specify the local folder as a destination for the file, and select from the list of files in the data object (see Figure 17). Other users are inhibited from editing the document until you check it back in.

Note: The checked-out files destination folder has a default value that you can set as a preference — see “Publish Options” on page 41

Figure 17: The document checkout dialog

In the above dialog, the checkbox in line with the list header selects all documents in the list if there are many.

Figure 18: Example of the ‘lock’ icon beside a checked-out document

Once a document is checked out by you, the option ‘Check in’ appears in the Task pane when that docu-ment is exposed in the Content pane. The check in dialog is virtually identical to the check out dialog.

Important: Checkout is only available for documents whose approval status is Not Approved.

Launching FilesIf the ‘Launch Files’ link is available in the Media section of the Task pane, you can use that. The file opens in the appropriate application in your local computer (if such an application exists). Other users are not inhibited from editing the document, and there is no ‘check back in’ function. If you do considerable work on a document in your local work station, and want to place it back into the eB vault (not a recommended procedure), you would have to use the ‘Add document’ function and give it a new filename.

Lock

page 16 D002114 rev 1.0, oct 09


RenditionIf the ‘Render’ link is available in the Media section of the Task pane, you may make a rendition of the document—typically as a PDF file, a TIFF image, or an ASCII text file.

Figure 19: Options in the document rendition dialog

To render a document:1. Click on the ‘Render’ option in the Task pane.2. In the ‘Create Rendition’ dialog, select what document type you wish to render to.3. Check if you want the document watermarked.4. Click on the ‘Render >’ button.

You are returned to the Content pane, and the new rendition appears in the file list.

Adding Files

Shown above is the large ‘Add’ button which appears in the task pane if you have permission to add files to a document.

To add a file from your local computer to a document in eB:1. Double-click the ‘Add’ button in the Task pane.2. Navigate to the file in the Select Files window that pops up.3. Click on the ‘Open’ button.

Another method:1. Open Windows Explorer and navigate to the file.2. Select the file.3. Drag-and-drop it onto the ‘Add’ button in the Task pane.

The file is transferred to the eB document that is currently showing in the Content pane. Refresh the browser window to see it.

Editing Document InformationIf an Edit link is available in the Task pane that means you have permission to edit the details and/or struc-ture of the document.

D002114 rev 1.0, oct 09 page 17


To edit details:1. Select ‘Details’ from the small drop-down list in the task pane.2. Click on the ‘Edit’ button.3. Edit the document properties, as needed.4. If changes are needed in related topics, expand the topic and edit as needed.5. Click on the ‘Save’ or ‘Save and Close’ button.

Figure 20: Example document detail edit form

Important: Three of the fields in the edit form are examples of mandatory, or required, fields. They are flagged with red lettering and a caution triangle. Required fields in all eB edit forms are flagged in this way.

To edit document views other than details:1. Select the required view from the small drop-down list in the task pane.2. Click on the ‘Edit’ button.3. Expand the desired topic and make your changes.4. Click on the ‘Save’ or ‘Save and Close’ button.

page 18 D002114 rev 1.0, oct 09


Figure 21: Example document structure edit form

Making a Copy of a DocumentIf the ‘Copy’ link is available in the Actions section of the Task pane, you may make a new document from the document in the Content pane. All chosen attributes and relationships are copied to the new document instance.

To make a copy:1. Click on the ‘Copy’ link in Actions. A Copy Document dialog opens:

Figure 22: The Copy Document dialog

2. Edit the Number and Revision fields (note the two-part ‘Number’ field).3. Ensure that all document relationships you wish to preserve in the copy are checked.4. Click on the ‘Copy >’ button.

Deleting a DocumentIf the ‘Delete’ link is available in the Edit section of the Task pane, that means you have permission to delete this document. Since the delete action is irrevocable, you see the following warning dialog before you confirm your intention:

D002114 rev 1.0, oct 09 page 19


The document details and all related electronic files are removed from the eB system.

Important: . All relationships to other objects also need to be removed before 'Delete' is possible.

Adding and Deleting FoldersNew folders may be created in the explorer tree, either at system root or as children of existing folders, so long as you have the necessary permission. Figures 23 & 24 show a folder about to be added at system root.

Figure 23: Setup for adding a folder at root

The procedure is to simply click on the ‘Add Folder’ link in the Task pane. The Create Folder dialog opens:

page 20 D002114 rev 1.0, oct 09


Figure 24: Creating a folder at root

Specify the data scope if not ‘Global,’ enter the name for the new folder and click on the ‘Add Folder >’ but-ton.

To delete a folder, provided you have the requisite permission, expose it in the Content pane and click on the ‘Delete’ link in the Task pane.

Adding a New ObjectIf you have the required permission level, you may add new data objects to the eB system.

Initiate the process by clicking on the ‘Add new Objects’ button at the top of the Navigator pane.

The object types you may add appear in a list in the Navigation pane. Typically, documents, change requests, items, locations, organizations, people, and projects are in the list.

Important: In all the ‘object create’ dialogs, a field name in red accompanied by the warning trian-gle indicates a required field.

Before using the free-form dialogs for data object addition, always look to see if a template is available for that object type. Click the plus-box beside the data object type to expand the information tree. An example of part of a document template, with its associated tasks, is shown as Figure 25.

D002114 rev 1.0, oct 09 page 21


Figure 25: Example template for purchased software

From the task pane, you can now use the ‘Create Instance’ task to add a document conforming to this tem-plate.

To add a new document and file using ‘shortcut’:1. Expand the documents tree and click on the appropriate document class name. The ‘Add new

object’ shortcut dialog is displayed in the Content pane.2. Select the data scope of this document in the title line (defaults to ‘Global’).3. Select a template from the drop-down list.4. Drag any files from your workstation that you wish to store within the eB document, and drop

them in the large Enterprise Informatics logo in the dialog box. The logo briefly animates to indi-cate that the file has been accepted.

5. Click on the ‘Add >’ button. A detail sheet opens in the Page pane.6. Click on the ‘Edit’ task. The document details can now be added (see Figure 27).7. Notice that a document number has been automatically assigned, based on the selected template.

Fill out any other needed details.8. Click on the ‘Save’ or ‘Save and Close’ button.

page 22 D002114 rev 1.0, oct 09


Figure 26: Add New document shortcut dialog

Figure 27: Part of the new data object detail sheet

To add a new document:1. Click on the word ‘Documents’ in the Navigation pane. A document create dialog is displayed in

the Content pane.2. Select the data scope if not ‘Global.’3. Complete the document number on the first line of the dialog.4. Enter a title in the second line of the dialog.5. Optionally, enter a revision number on the third line of the dialog.6. Enter the document class on the fourth line.7. Optionally, use the two calendar pickers to register the date effective/date obsolete.8. Check the checkbox for ‘Change controlled’ if appropriate.9. Optionally, enter any remarks and synopsis text.Note: If remarks and synopsis overflow the text boxes provided, click on the words ‘More room’ to obtain a free-form text box filling the entire screen.10. Select from the options Edit object/View object/Create another object/Add the new object to my

basket.11. Click on the ‘Save >’ button.

D002114 rev 1.0, oct 09 page 23


Figure 28: The document create dialog

To add a new project:1. Click on the word ‘Project’ in the Navigation pane. A project create dialog is displayed in the Con-

tent pane.2. Select the data scope if not ‘Global.’3. Enter a project code ID in the first field of the dialog.4. Enter a project name in the second field of the dialog.5. Enter the organization responsible in the third field of the dialog. This field is auto-complete,

allowing only organizations in the eB database to be entered.6. Select Authorized/Planned/Cancelled/Completed from the status drop-down menu.7. Select from the options Edit object/View object/Stay in this screen/Add the new object to my bas-

ket.8. Click on the ‘Save >’ button.

Figure 29: The project create dialog

To add a new person (Admins only):1. Click on the word ‘Person’ in the Navigation pane. A person create dialog is displayed in the Con-

tent pane.2. Select the data scope if not ‘Global.’3. Enter a personal code# in the first field of the dialog, or use ‘?’ together with a numbering mask.4. Enter the surname in the second field of the dialog.5. Enter the person’s initials in the third field of the dialog.6. Optionally, enter the first name, title, and status as ACTIVE in the subsequent fields.

page 24 D002114 rev 1.0, oct 09


7. Optionally, enter the person’s full name in the seventh field of the dialog.8. Optionally, enter any remarks in the last field of the dialog9. Select from the options Edit object/View object/Create another object/Add the new object to my

basket.10. Click on the ‘Save >’ button.

Figure 30: The person create dialog

To add a new organization:1. Click on the word ‘Organization’ in the Navigation pane. An organization create dialog is displayed

in the Content pane.2. Select the data scope if not ‘Global.’3. Enter a code# in the first field of the dialog.4. Enter the organization name in the second field of the dialog.5. Optionally, enter any remarks in the third field of the dialog.6. Select ACTIVE from the status drop-down menu.7. Select from the options Edit object/View object/Stay in this screen/Add the new object to my bas-

ket.8. Click on the ‘Save >’ button.

Figure 31: The organization create dialog

To add a new location:1. Click on the word ‘Location’ in the Navigation pane. A location create dialog is displayed in the

Content pane.2. Enter a location name in the first field of the dialog.3. Enter the organization name in the second field of the dialog.4. Select user-defined types (e.g. Assets/Documents/Geographical/Items/Tag) from the type drop-

down menu.5. Optionally, enter a unqiue location code in the third field of the dialog.6. Select from the options Edit object/View object/Stay in this screen/Add the new object to my bas-

ket.

D002114 rev 1.0, oct 09 page 25


7. Click on the ‘Save >’ button.

Figure 32: The location create dialog

Every Location data object in eB may have any number of child locations.

To edit child locations:1. Select the location object from the Directory, from basket, or from the Explorer tree.2. Click on the ‘Edit’ link in the Task pane and expand the Locations topic (Figure 33). 3. To add, click on the plus-button at the bottom of the list. An Object picker window opens.4. Check the radio button corresponding to ‘New Object.’5. Enter the name of the new child location.6. Click on the ‘Create’ button.7. To delete a child location, check the checkbox to the left of its name and click on the minus-button

at the bottom of the list.

Figure 33: Location object showing child locations

E-mailYou can send e-mail to all persons registered to your data community from within eB Web. This feature is particularly useful when you have exposed one or more data objects in the Content pane, and you’d like to send them out as an e-mail attachment. In general, the option for this is present in the Actions section of the Task pane.

page 26 D002114 rev 1.0, oct 09


You can also originate e-mail messages from your Basket, and place your frequent e-correspondents in the Basket for easy retrieval.

Figure 34 shows the e-mail window as it first pops up. Your task is to build up your recipient list using any of the three options indicated by the radio buttons.

Figure 34: E-mail window at start

Option 1: Enter names and numbers -- As soon as you enter any text in the ‘Select’ box, an auto-com-plete window pops up listing all people who satisfy your entry so far. If, say, your first character is a C, the window will contain any people whose first or last names OR code#s begin with C. Click on a name at any time to transfer it into the ‘Select’ box, then click on the ‘Select’ button to transfer that person to the recipi-ent list up above.

Option 2: Select objects from Basket — A list of people stored in your Basket pops up, from which you select recipients.

Option 3: Use the search — A directory search window pops up. This search uses the same search syn-tax and wildcards as the eB search function.

Inspect your recipient list (see Figure 35) to make sure it is complete and accurate. You can delete a name, if necessary, by checking the checkbox to the left of it and clicking on the minus-box beneath the list.

D002114 rev 1.0, oct 09 page 27


Figure 35: Example of e-mail recipient list

Complete the Subject line and message body, then click on the ‘Send >’ button to send the mail and attach-ment.

Note: Send is inhibited if either the Subject or Body is null.

eB ReportsThe extent of eB report-printing is highly dependent on the set of plug-ins that your installation includes and, as with all areas of eB, the complexity of your data sets. The procedure begins with a click on the Reports icon, which is found in the middle of the toolbar in the Navigation pane.

Content exposed in the Navigation pane might be as depicted in Figure 36, or it may be much more com-plex. For example, the Records Management module reports are shown in the Figure.

Figure 36: Typical reports menu

User-Defined ReportsFigure 37 shows the Content and Task panes with one page of reports already created. Typical navigation features are provided when the user-defined report list overflows. Column headings are Report Name, Description and Object Type.

page 28 D002114 rev 1.0, oct 09


Figure 37: User-defined reports -- Info and Task panes

Note: ‘Create New Report’ and ‘Create eQL Query’ links are only offered in the Task pane for users having ‘New Object Instances > Report’ permission.

To display an existing report:1. Click on the report title in the list.

Figure 38 shows display of a Purchase Requisition report, with user-defined column headers.

Figure 38: User-defined report display

Note that the Task pane allows for Download, Edit, Save and Delete operations.

D002114 rev 1.0, oct 09 page 29


To filter the report list1. Enter search criteria in the box labeled “Search for Report” (Figure 37.)2. Click on the green search arrow.

As usual, the % character is a wild-card. Entering ‘d%,’ for example, would filter for all reports whose names began with the letter D.

To create a new report:1. In the Task pane as shown in Figure 37, click on ‘Create New Report.’

The reporting wizard steps you through five pages, ‘Report Type,’ ‘Criteria,’ ‘Columns,’ ‘Column Ordering,’ and ‘Format/Execute.’

2. In the Report Type page, select the type of report you wish to create from the drop-down list. In Figure 39 ‘Document’ is selected.

Figure 39: Reporting wizard page 1: Report Type

3. Click on the ‘Next’ button.

The ‘Criteria’ wizard page allows you to create filters either global or specific, with as many dimensions as you wish. In theory the criteria definition could be highly complex, but for most purposes a single state-ment is enough.

Figure 40 shows the page with no criteria yet defined.

page 30 D002114 rev 1.0, oct 09


Figure 40: Reporting wizard page 2: Criteria (blank)

4. Enter any global class filter in the top edit box (this box is not present for all report types.)5. Create the first criterion statement using the two drop-down lists provided.

For economy and clarity, Figure 41 shows both lists expanded, with Properties > Date effective in the process of being selected. In practice, these lists are cascaded — the content of the second list dependent on the selection made in the first.

Figure 41: Reporting wizard page 2: Twin drop-down lists

6. Click on the + button to move your selected criterion into the criterion list.7. Complete the statement with an operator and value. In the case illustrated, the date can have oper-

ators such as ‘equals,’ ‘less than,’ etc., and the value set with a calendar-picker to any desired date.

In Figure 42, the date filter has been set.

D002114 rev 1.0, oct 09 page 31


Figure 42: Effective date criterion completed

8. Check that your statement is meaningful by clicking on the ‘Execute Report’ green arrow button. You may do this at any time as you build a complex set of criteria.

9. ‘Group’ drop-downs are used in complex multi-line criteria to specify the logical order in which criteria are applied, using nested parentheses. The ‘Boolean’ column allows logical operators such as AND, OR.

10. Multi-line criteria may be re-arranged using the small up/down buttons to the left end of the line. Check the ‘Mod’ checkbox in any line you wish to move.

11. When satisfied, click on the ‘Next’ button.

Figure 43 below shows Page 3 of the reporting wizard. All possible column headings are displayed, with checkboxes allowing you to select or deselect them at will. There may be many other topics not shown in the figure.

Figure 43: Reporting wizard page 3: Columns

12. Select the column headings you wish to include. Again, you may test your selection using the ‘Exe-cute Report’ green arrow button.

13. When satisfied, click on the ‘Next’ button.

Figure 44 below shows Page 4 of the reporting wizard. This screen allows you to determine the list sort order with high precision. The list is eventually sorted by the criterion at the top of this page, then the next and so on.

page 32 D002114 rev 1.0, oct 09


Figure 44: Reporting wizard page 4: Column Ordering

14. Add each column heading to the list using the drop-down and the + button, in whatever order you choose (this step has been completed in the illustration, sorting first on Category ascending and then on Class ascending.)

15. Select Ascending or Descending sort order for each column.16. Re-order the list at any time, checking ‘Modify’ for the list item you need to move, then using the

small up/down arrows at left.17. When satisfied, click on the ‘Next’ button.

Figure 45 below shows Page 5 of the reporting wizard. This page allows you to specify the display order of columns in the report, as distinct from the columns used for sorting. In the example, Category is the pri-mary sort criterion but the fifth column in list display order.

Figure 45: Reporting wizard page 5: Format/Execute

18. Make any needed final adjustments to the report and click on the ‘Finish’ button.

D002114 rev 1.0, oct 09 page 33


A finished report is shown below as Figure 46. A full range of typical follow-up procedures is found in the Task pane.

Figure 46: Example of finished report

eQL QueriesIn the Task pane of the Reports overview (see Figure 37) there is an option ‘Create eQL Query.’ eQL is an eB query language like SQL, and is a quick way of writing criteria statements for users adept at the lan-guage. The syntax is beyond the scope of this quick-start User Guide. Contact eB Product Support for more information about this.

ObjectsThe ‘Objects’ section of the Reports menu exposes a set of graphical aids providing summary data about eB objects. An example is shown as Figure 47.

page 34 D002114 rev 1.0, oct 09


Figure 47: Example of an eB system object presentation

All report types may be printed and/or downloaded.

Folder ReportsA different type of report may be generated if you need to see and/or print a summary of folder contents. To make use of this feature, list all folders in the Navigation pane using the Explorer (see “Explorer” on page 7.) Click on the folder whose content you wish to summarise. Now click on the ‘Display Folder Report’ icon and link in the Task pane.

Figure 48: Folder reporting link in the Task pane

The following options appear in the Content pane:

Figure 49: Folder reporting options, Content pane

To display the report, click on ‘Run Report.’ Figure 50 below shows a typical Folder Report — in this case, a set of disposition orders relating to a specific File Plan. ‘Documents Ready for Release’ and ‘Documents Added in Last 24 Hours’ are grouped in the report. These are saved searches, and could be omitted by unchecking the ‘Include saved searches’ checkbox.

D002114 rev 1.0, oct 09 page 35


Figure 50: Example folder report

The options shown in Figure 49 remain available on screen, above the report, so you may print or save the Folder Report after inspecting it. When you save a report, you are asked to choose a standardized format from a pop-up list of templates.

Figure 51: Template selection for Folder Reporting

page 36 D002114 rev 1.0, oct 09

Searches eB Web

Searches

A search is initiated by clicking on the search button in the header of the Navigator pane. Searches are initiated from the Navigator pane, using a dialog box. Figure 52 shows the dialog for a document search, set to find all documents modified between two given dates.

Figure 52: Document search options

Note that in this setup documents may be searched by title, number, full text, effective and modified date, class, and status. Search results display in the Content pane and any document in the results list may be shown in detail (by clicking on its number).

D002114 rev 1.0, oct 09 page 37

eB Web Searches

Figure 53: Search results table (partial)

Note that, in the Task pane, options for printing and downloading the results table are offered. The down-load file is in .csv format, suitable for importing into, say, a spreadsheet.

The Full Text Search is only applicable to document classes that have the FTR capability enabled, and it searches the content of the electronic files in the eB system. Naturally it can take some time to come up with results.

Based on your eB System, additional searches may be available for other object types. Whatever object types are available are in the drop-down selector at the head of the dialog (Figure 54). An appropriate set of fields is presented for each search. Options available in the task pane include printing or e-mailing a copy of the result list. The list may also be added to a folder or to your basket.

Figure 54: Search object type selector

Search result reportingClicking on the ‘Create Report’ link in the Navigation pane (see Figure 52) is a short-cut to the report cre-ation wizard described on page 28.

page 38 D002114 rev 1.0, oct 09

Preferences eB Web

PreferenceseB Web offers many options for individual users wishing to ‘tailor’ the application to suit themselves. These are grouped in a Preferences dialog.

To access the Preferences dialog: Click on the eB logo at extreme top left of the eB screen, in the header of the Navigation pane.

Figure 55 depicts the main part of the editor that displays in the Page pane. There is no Task pane.

Figure 55: Preference Editor, unexpanded

The first option is for changing your password. Click on the text to expose a standard new-password dialog. Click on the ‘Change >’ button when done.

Click on the text to the right to force use of a password at login, or to change system preferences.

Click on ‘About this Web Application’ to pop up an information window summarizing the parameters cur-rently in force and listing your plug-ins. Part of this listing is shown below.

D002114 rev 1.0, oct 09 page 39

eB Web Preferences

Figure 56: Sample of part of an ‘about’ window

Options in the seven main topics are described below. Click on the up-arrow, as usual in topics, to expand hiden information.

Important: Click on the ‘Save’ button to confirm any change you make.

Document DistributionThis topic gives you an opportunity to set up a default distribution pattern for your documents — address-ees, comments, etc. See “To distribute basket contents:” on page 13.

eB WebIn this topic you can set or reset defaults such as Navigator, Search Type, et.

File OptionsSet your default document checkout path here.

FiltersFour toggle options are available for configuration of the Explorer tree, and provision is made for excluding irrelevant documents if your database becomes cluttered with historic data versions that you never need to see.

Figure 57 shows the filter options, with the Status Filter expanded.

page 40 D002114 rev 1.0, oct 09

Preferences eB Web

Figure 57: Filter preferences dialog

Publish OptionsIn this topic you can set the default destination for files to be published. Your administrator may have set up other options.

Search OptionsDefault and maximum search result lists, and possibly other options, may be set here.

System DefaultE-mail triggering is one typical option in this topic. Your administrator may have set up other options.

D002114 rev 1.0, oct 09 page 41

eB Web Preferences

page 42 D002114 rev 1.0, oct 09

Preferences eB Web

SECTION 2: WORK EXCHANGEThe Work Exchange plug-in feature of eB Web is a sophisticated task manager, presenting assigned tasks to users and assisting them in workflow management, presented as a familiar tree-structured naviga-tor. Reach it by clicking on the Navigator button in the Navigation pane.

Figure 58: Unexpanded work exchange tree

Figure 58 depicts a typical Work Exchange navigator, in its simplest form. The folders serve as work stor-age space. Tasks move from folder to folder as the user accepts, works on (or delegates) and completes the assigned items. Once all tasks for a specific work order are completed, all reference to that work order is removed from the user's Work Exchange tree.

The ‘Approvals’ folder only applies to those users labeled as "Approvers." Work orders or other objects awaiting their approval are placed in the folder at the bottom of the tree.

ForthcomingThis folder contains all tasks that have been assigned to a specific person for future action. The work orders of these tasks have already been authorized, but a predecessor has to first complete their task before the current user will be able to accept the task from their inbox. This feature allows users to look ahead at the tasks that have already been allocated to them.

InboxThe Inbox contains all tasks that have become the responsibility of the current user. These tasks are ready to be performed. Tasks in this folder can either be accepted or sent for rework. Once accepted, the task moves to the Work In progress folder.

Work in progressThe Work in Progress folder contains all tasks that have been accepted by the user. Actions available in this area include adding notes and documents to a parent work order, viewing physical items, projects, serialized items and virtual items that are associated with the work order as well as viewing the work order itself, delegating or sending the work order for rework and completing the work order.

CompletedThe Completed folder contains all tasks that have been completed by the user. These tasks stay in the Completed folder until the whole work order has been completed. Once the work order has been com-pleted, the tasks are removed from the various Completed folders. Users are only allowed to view detail in the completed folder.

Delegated WorkThe Delegated folder contains details of tasks that the user has delegated to others. The user first assigned the task is still responsible for the work being completed, and all delegated tasks remain in the user's Dele-gated folder until each one has been marked "Complete".

D002114 rev 1.0, oct 09 page 43

eB Web Preferences

ApprovalsThe Approval folder, only visible to ‘Approvers,’ contains all objects that have been submitted for approval or authorization. Detail in this folder may be viewed, approved and/or rejected.

Frequent Work Exchange OperationsTasks do not necessarily start in the ‘Forthcoming’ area. They may be placed directly in your Inbox by a supervisor, in which case you should receive e-mail notification.

Figure 59: E-mail notification of an incoming task To examine forthcoming tasks:

1. Expand the ‘Forthcoming’ folder in your Work Exchange tree.2. Expand further, if necessary, to drill down to the task you wish to examine.

Figure 60: Forthcoming task folder, expanded

3. Click on the task. Details flow into the Content pane.

page 44 D002114 rev 1.0, oct 09

Preferences eB Web

Figure 61: Typical forthcoming task details

Possible manipulations, exposed in the Task pane, are as shown in Figure 62.

Figure 62: Task pane options for forthcoming work

You may attach a note to the task, or place a copy of it in any accessible folder including ‘My eB.’ Clicking on ‘Work Order’ exposes the parent work order in the Content pane and leads to two further options: Can-cel or Suspend.

To accept a task:1. Expand the ‘Inbox’ folder in your Work Exchange tree.2. Click on the task to be accepted. Details flow into the Content pane. The Task pane offers links to

Accept or examine the parent work order. ‘Rework’ is a further option for completed tasks.3. Click on the ‘Accept’ link.

The task now moves to the ‘Work in progress’ folder. The task stays in this folder while you work on it, and no new task is moved into the Inbox until the current task has been marked ’Complete.’

You may also:1. Click on the top-level ‘Inbox’ folder. A summary table of tasks flows into the Content pane (Figure

63).2. Check any tasks you wish to accept, or check the checkbox in the table header for ‘All.’3. Click on ‘Accept’ in the task pane.

D002114 rev 1.0, oct 09 page 45

eB Web Preferences

Figure 63: Summary table of inbox tasks

To delegate a task:1. Expand the ‘Work in progress’ folder in your Work Exchange tree.2. Click on the task to be delegated. Details flow into the Content pane. 3. Click on the ‘Accept’ link in the Task pane. A ‘Delegate’ link is now added in that pane.4. Click on ‘Delegate.’ A delegate dialog (Figure 64) opens in the Page pane.5. Enter the skill area to delegate to.6. OR: Type the code for a user in the Responsible Person field. 7. Add any instructions that should accompany the task and click on OK.

The task moves from the ‘Work in progress’ folder to the ‘Delegated Work’ folder. It is also placed in the ‘Work in progress’ folder of the person to whom it was delegated.

Once the delegated party has completed work on the task, the system sends it back to the ‘Work in prog-ress’ folder of the person originally assigned the task to mark as completed.

Figure 64: The ‘Delegate Task’ dialog

To mark a task as completed:1. Expand the ‘Work in progress’ folder in your Work Exchange tree.2. Click on the completed task. Details show in the Content pane.3. Click on the ‘Complete’ link in the task pane.

The task moves to the ‘Completed’ folder.

page 46 D002114 rev 1.0, oct 09

Change Management in eB Web eB Web

SECTION 3: CHANGE MANAGEMENTIn the section “Editing Document Information” on page 17, the procedure for routine document revision is described. Refer again to Figure 20, and note that the checkbox indicating ‘Change Controlled’ is unchecked. This allows new revisions to be added from 'Approved' eB objects without capturing the Change History (Reason for change). Once the new version is approved, status on the prior version changes to ‘Historic.’

Your corporate policy may require a much more formal process for tracking changes to critical data objects, and eB facilitates this with its Change Management plug-in.

Change Management in eB Web

Declaration that a data object is change-controlledAn object such as a document, a physical item, or a virtual item group, is normally flagged as change-con-trolled at the time it is first added to eB. This is done by simply checking the change-control checkbox in the edit screen, as seen in Figure 65 (which is identical to Figure 27 other than the change-control flag.)

Figure 65: Edit screen of a change-controlled object

Approved objects so flagged can only be edited through a formal change request process. The object’s Change Status goes from ‘Current’ to ‘Change Pending’ to ‘Under Change’ in the course of the approval pro-cess.

Initiating a change requestA change request is initiated by clicking on the ‘Add Change Request’ icon or link in the task pane, when a change-controlled item is displayed.

D002114 rev 1.0, oct 09 page 47

eB Web Change Management in eB Web

Figure 66: Change request icon/link

Change requests can only be implemented using pre-defined templates. If more than one template exists for this class of object, you must make a selection using a radio button before clicking on the ‘Create’ but-ton. The change request form is now called into the Content pane, as illustrated in Figure 67 below.

Figure 67: Required fields in a change request form

The required fields are as follows:

Table 1: Required change request fields

Field Notes

Number Unique tracking number. Defaults to the next num-ber in sequence based on the defined mask of the template, but may be entered freely

Requestor Person making the request. Defaults to the identity of the user currently logged in

Organization Affiliation of the requestor

Date Requested Defaults to the current date

Description Free-form descriptive text of the change

Reason Free-form explanation of the need for change

page 48 D002114 rev 1.0, oct 09


In addition to these required fields, the change request form may have many additional fields, as defined by the template. These typically include estimated recurring and non-recurring costs of the proposed change, technical review comments, etc.

There may also be further dialogs for such related topics as affected documents, keywords, responsibilities, and so on. Click on the expansion buttons to expose these.

As soon as the new change request has been added, the 'Affected' object that was selected to be changed appears either in the 'Affected Documents', 'Affected Physical items' or 'Affected Virtual Item Groups' top-ics.

Figure 68: Example of an Affected Document

Change Request TrackingAll change requests, regardless of status, are exposed in a ‘Class’ navigator that may be selected in the Nav-igator pane. Figure 69 below shows part of one, arranged to look like a file structure.

Figure 69: Part of a change request navigator

Clicking on an item in the tree retrieves its details in the Content pane, which are the same as on the change request form plus the current status of the request.

Priority User-defined drop-down menu of priority levels, used for searching, sorting and reporting

Category Pre-defined drop-down menu, also used for search-ing, sorting and reporting

Table 1: Required change request fields

Field Notes

D002114 rev 1.0, oct 09 page 49


Change requests may also be the subject of searches. Fields that may be searched on are Description, Num-ber, Status, Class, and By date. The wild-card character % may be used in any field. With all fields blank and Status set to Any, the search returns the complete set of change requests that exist. Clicking on an item in the search results list displays the same details in the Content pane as described above.

Change Request StatusWhen a change request is first initiated, its status is listed as ‘Draft.’ As the request moves through the approval process, its status can become any of the following:

Any time a change request is exposed in the Content pane, an administrator or other user having the required permission may change the CR status by clicking on a link in the Status list at the bottom of the Task pane. In all status changes except a change from ‘Draft’ to ‘Proposed,’ a supplementary dialog pops up to record the date and reason for the change, and other details. Figure 70 below shows a dialog for Expedit-ing a change request.

Figure 70: Dialog for recording a status change

Table 2: Change request status, interpretation

Draft Initial status

Proposed Elevated status, reflecting a judg-ment that the CR will likely result in actual change

Cancelled Request not a valid change

Expedited Indicates that data objects need to be released for change before the change analysis is complete

Approved Releases all affected objects for change implementation and locks the change record

Rejected Indicates a judgment that the pro-posed change is too high a risk

Completed All affected objects have completed the change cycle

page 50 D002114 rev 1.0, oct 09


Also of interest in terms of change request tracking is the topic labeled ‘Progress,’ found by scrolling down the Content pane when a Change Request form is present. An information table can be exposed that shows the past and present labeling of all affected items, in ‘From’ and ‘To’ columns.

Change Effects AnalysisIn a complex interlinked data system such as exists in most technical corporations today, it is not always possible to calculate the implications of a change in a deterministic way. eB is quite capable of displaying all data objects with primary links to the object under change, but allowance is made for a human knowl-edge worker to determine whether those objects are in fact impacted by the change, and whether perhaps impacted objects with secondary or tertiary relationships are not listed. This process is known as Change Effects Analysis.

To carry out a Change Effects Analysis:1. Expose the Change Request in the Content pane, either by selecting it in the navigator or by

searching for it.2. Click on the ‘Effect Analysis’ link in the Report section of the task pane.

Figure 71 shows a fairly simple Change Effects Analysis as it appears in the Content pane. There is no Task pane associated with it. This type of report can potentially be much more complex than this example.

Figure 71: Example change effects analysis report

In this example, a remote controller has been reported as unreliable and a replacement is suggested. Data objects that are potentially impacted by the change are grouped as physical items, responsibilities, parent documents, virtual items and work orders. Every element seen here can be inspected in more detail simply by clicking on its link.

D002114 rev 1.0, oct 09 page 51


To refine this analysis:1. Check any items you have reason to believe will be impacted by the same change, or that may have

secondarily-related objects that will be impacted.2. Click on ‘Add As Affected Object.’3. Click on ‘Calculate.’ Secondary objects are added.4. Iterate steps 1) and 2), if necessary, until you are convinced that the list is complete.

The report may be hard-copy printed, using the link in the list header.

Implementing a Change RequestWhen a Change Request reaches the status of ‘Expedited’ or ‘Approved,’ a link and icon for ‘Implement Change Request’ appears as an Action option in the Task pane. The same option appears on eB objects that carry the status ‘Under Change.’

Note: It is possible that a Change Request has been completed without its status having been amended to reflect that fact. In such a case, the icon and link do not appear. The ‘Progress’ topic in the Content pane shows at all times which components of the change have in fact been implemented.

To implement a Change Request:1. Click on the ‘Implement Change Request’ icon or link.2. Select the object to implement from the dialog (by checking a radio button).3. Click on the ‘Next >’ button. The main Implement dialog is displayed (ref. Figure 72).4. Review the 12-checkbox field under ‘Document Relationships.’

These 12 items are related topics that you may or may not wish to clone along with the new version. eB has a default condition, allowing cloning of most of them, assuming that you will normally wish to clone these and possibly edit some of them in the new version. The default condition may be changed by an adminis-trator.

5. If this is just one of several items involved in a Change Request, set the radio buttons at lower right appropriately.

The ‘Implement’ and ‘Discard’ options need no explanation. ‘Carry over’ means to withhold implementa-tion at this time but keep this item as part of the Change Request, with its current status.

6. Click on the ‘Finish >’ button to complete the implementation cycle.

page 52 D002114 rev 1.0, oct 09


Figure 72: The main Implement dialog

Editing a Change RequestUsers having the required permission may edit a Change Request whose status is Draft, Proposed, or Expedited.

To edit a Change Request:1. Expose the Change Request in the Content pane, either by selecting it in the navigator or by

searching for it.2. Ensure that ‘Details’ is shown in the Edit drop-down menu in the Task pane.3. Click on the ‘Edit’ button in the Task pane.

The editable Change Request form is displayed in the Content pane. Make your edits and click on either ‘Update’ or ‘Update and Close.’

Copying a Change RequestUsers having the required permission may make a copy of a Change Request.

To copy a Change Request:1. Expose the Change Request in the Content pane, either by selecting it in the navigator or by

searching for it.2. Click on the ‘Copy’ icon or link in the Task pane.

A Copy Change Request dialog is displayed in the Content pane (see Figure 73).

3. Edit the Number field. The copy will not be accepted using the same number as the original.4. Review the checkbox field and edit as necessary.5. Click on the ‘Copy >’ button.

D002114 rev 1.0, oct 09 page 53


Figure 73: Dialog for copying a Change Request

Deleting a Change RequestUsers having the required permission may delete a Change Request, so long as it is free of all relationships to other eB data objects.

To delete a Change Request:1. Expose the Change Request in the Content pane, either by selecting it in the navigator or by

searching for it.2. Click on the ‘Delete’ icon or link in the Task pane.

Since the delete action is irrevocable, a confirmation dialog will be displayed. Click on the ‘Yes >’ button to confirm.

Important: The action of deleting a Change Request might destroy valuable historical informa-tion. Consider whether changing the Change Request’s status to ‘Cancelled’ might be more appropri-ate.

page 54 D002114 rev 1.0, oct 09

Physical Item Management in eB eB Web

SECTION 4: PHYSICAL ITEM MANAGEMENTeB Web manages information in its database in an object-oriented way. Real life objects are identified with key identifiers; these are associated with a number of attributes or descriptors, providing more infor-mation about each object. The objects are then related to each other in hierarchical assemblies, or in one-to-one, one-to-many or many-to-many relationships, depending on the nature of the associated object.

Physical Item Management in eBPhysical items are things that form part of a tangible system, either as single components, complete items or systems, or sub-sets of these. Such items are either procured, designed, fabricated, warehoused, assem-bled, distributed or maintained by the enterprise. In eB, a physical item may be hardware, software or firmware, which is used, built, operated or maintained as part of the Enterprise process. An Item Manager plug-in is needed for the purpose of managing physical items, lists, and baselines.

A dedicated ‘Items’ explorer may be selected in the Navigation pane to expose all physical items in a tree structure, as illustrated in Figure 74.

Figure 74: The Physical item explorer

Physical items may also be exposed in the Content pane as a result of a search for that type of eB object. Fields that may be searched on are Description, Number and Approval status. The wild-card character % may be used in any field. With all fields blank and Status set to Any, the search returns the complete set of physical items that exist.

Note: A checkbox in the search dialog may be checked to exclude obsolete items.

Figure 75 below shows the detail sheet that is called into the Content pane by clicking on one of the Turbine Rotor items in the Navigation pane.

D002114 rev 1.0, oct 09 page 55

eB Web Physical Item Management in eB

Figure 75: Typical physical item detail sheet

In addition to the tabulated details shown, many additional topics may be appended. If the physical item exposed is classed as a component, the ‘Where Used’ topic may be expanded to show all structures contain-ing this component.

Editing physical itemsUsers having the required permission may edit a physical item, by clicking on the ‘Edit’ button in the Task pane. The same fields as shown in Figure 75 are called into the Content pane in an editable form. As usual, mandatory fields are clearly flagged (Figure 76.)

Most of the edit fields are self-explanatory, but some need a little explanation:

Number (required):Item numbers are not constrained to a particular format, but they must be unique.

Configuration Item:This yes/no toggle, if checked, indicates that the item is designed in-house, as opposed to procured. Any item that has a breakdown (children in a Physical Item List) must be flagged as a Configuration Item.

Class:This field is not free-form. It auto-completes, and is restricted to classes that have already been created to facilitate searches.

Serialized:A serialized item is one that has many instances, but the instances are not as interchangeable as paper clips. Each instance is allocated a serial number so that it may be tracked individually, and documents may be associated with it.

Main Equipment:If toggled on, flags the item as the top parent item in a structure or assembly.

page 56 D002114 rev 1.0, oct 09


Figure 76: Physical item edit form

Phantom:A phantom is a procured item that appears on a bill of materials but is not, or not yet, actually purchased.

Build or buy (required):This drop-down can have the values ‘Sub-contracted,’ ‘Fabricated,’ or ‘Procured’ only.

All of the topics in the pane below this main edit form are potentially editable, also, by expanding them and adding information.

When editing is complete, click on the ‘Save’ or ‘Save and Close’ button.

Copying a Physical ItemUsers having the required permission may make a copy of a Physical Item.

To copy a Physical Item:1. Expose the item in the Content pane, either by selecting it in the navigator or by searching for it.2. Click on the ‘Copy’ icon or link in the Task pane.

A Copy Physical Item dialog is displayed in the Content pane (see Figure 77).

3. Edit the Number field. The copy will not be accepted using the same number as the original.4. Review the checkbox field and edit as necessary.5. Click on the ‘Copy >’ button.

D002114 rev 1.0, oct 09 page 57

eB Web Physical Item Management in eB

Figure 77: Copy Physical Item dialog

Baseline managementA baseline is like a snapshot of a physical item’s configuration, including all supporting documentation, stored for use at some future date for the purpose of comparing the baseline with the item’s then-current configuration.

eB recognizes two types of baseline:

A physical item baseline, containing all approved documents relating to the item A product baseline, encompassing all physical item baselines in a defined structure

An item baseline is automatically created on approval of the item, but either type may be created manually.

To create a baseline:1. Click on the ‘Create Baseline’ icon or link in the Task pane. A dialog (Figure 78) is displayed.2. For a physical item baseline, click on the ‘Create’ button.3. For a product baseline, check the radio button for ‘Product Baseline’ and then set the Product

Structure Type drop-down menu as needed.The checkbox ‘Approve Physical Items if needed’ should be checked only if you wish to proceed without monitoring whether all physical items in the structure are in fact approved.

4. Click on the ‘Create’ button.

Figure 78: Baseline creation dialog

Baselines appear as a topic in the Content pane. Expanding the topic, you should see that a new baseline with document status ‘Current’ has been created. Previous baselines are flagged ‘Historic.’

page 58 D002114 rev 1.0, oct 09


The baseline itself can now be called into the Content pane by clicking on its underlined reference number link. All baselines in the system are also accessible in a tree structure from the Document navigator, with child documents listed under the ‘Structure’ topic.

Note: A Product baseline is created as an unapproved document, to allow editing before final approval.

Item List ManagementItem Lists are also a topic in the Content pane of a physical item. By exposing the full list of child items, you can inspect each individual item by clicking on its underlined Item No.

To create a physical item list:1. Click on the ‘Create Physical Item List’ icon or link in the Task pane. A dialog (Figure 79) is dis-

played.2. Set the Item List type drop-down menu as required.3. Click on the ‘Create’ button.

Figure 79: Physical Item List dialog

Serialized Item List ManagementSerialized item lists are managed the same as individual item lists.

Creating a New Physical ItemNew physical items in eB Web can only be created from an existing template.

To create a new physical item:

1. In the Navigation pane, select the ‘Add Object’ button. 2. Expand the ‘Items’ folder, and then the ‘Templates’ folder one level down.3. Select the template to be used for the new item. The template format is displayed in the Content

pane.4. Click on the ‘Create instance’ icon or link in the task pane. A complete item definition form, similar

to the edit form in Figure 76, is displayed.5. Complete all necessary information and click on the ‘Update’ or ‘Update and Close’ button.

D002114 rev 1.0, oct 09 page 59