How to… Install and Use the PCD Inspector Tool - Archive€¦ · Choose Import and wait until the...

How to…

Install and Use the PCD Inspector Tool

ENTERPRISE PORTAL 6.0 SP2

PUBLIC

VERSION 1.0

ASAP “How to…” Paper

Applicable Releases: EP 6.0 SP2 March 2004

.

PCD INSPECTOR DOCUMENTATION PUBLIC

TABLE OF CONTENTS

0 DISCLAIMER ......................................................................................................................................2

1 INTRODUCTION:................................................................................................................................2

2 INSTALLATION OF PCD INSPECTOR (READ-ONLY VERSION)...................................................3

2.1 Installation: Step 1.........................................................................................................................3





3 GENERAL CAPABILITIES OF THE PCD INSPECTOR..................................................................10

3.1 Browsing through Portal Content Directory (PCD)..................................................................10

3.2 Displaying or Editing Object Properties....................................................................................11 3.2.1 Toolbar or Menu Entry Actions...............................................................................................12

4 OVERVIEW OF TOOLBAR ACTIONS.............................................................................................15

4.1 Delete Selected Object(s) ...........................................................................................................17

4.2 Visualizing Delta Link Dependencies as a Tree .......................................................................19 4.2.1 First Example of Delta Link Visualization: ..............................................................................19 4.2.2 Second Example of Delta Link Visualization:.........................................................................21

4.3 Visualizing Delta Links with Icons.............................................................................................23

4.4 Displaying the Where-Used List for Selected Objects.............................................................29

5 QUESTIONS, PROBLEMS, FEEDBACK ........................................................................................32

©2004 SAP AG 1


0 Disclaimer This documentation contains a description of the installation and the most important functions of the PCD Inspector tool.

This documentation also contains descriptions of functions which are not available in the read-only version of the PCD Inspector. If a function is not available there will be a note in the text.

1 Introduction: What are the benefits of the PCD Inspector tool? This document describes the benefits of the PCD Inspector tool and how it can be installed.

If the PCD Inspector tool is already installed and running on your system, you can skip Section 1 of this document. If you need to install the tool, read through the step-by-step installation instructions in Section 1. Yiou can then start the tool with the following URL:

http://[host]:[port]/irj/servlet/prt/portal/prtroot/com.sap.pct.tools.dev_studio.default

The following screenshot shows the first screen of the PCD Inspector:

©2004 SAP AG 2



2 Installation of PCD Inspector (READ-ONLY Version)

This section describes how to install the read-only version of the PCD Inspector.

Prerequisites: You are working on an EP6.0 SP2 portal (Patch 2 is required!! ):

2.1 Installation: Step 1

Move the com.sap.pct.tools.pcd_inspector.epa file (which is part of the EP60SP2_MinimumPatch2_PcdInspectorTool_[version].zip you downloaded from SDN) to any location on your local machine e.g. C:/temp.

Start the portal server and call the portal application for importing (replace [host] and [port] in the following url with the one you are working with, e.g.: [host]==localhost, [port]==50000):

http://[host]:[port]/irj/servlet/prt/portal/prtroot/com.sap.portal.pcd.admintools.import.default

Screenshot of the portal application for importing:

©2004 SAP AG 3

http://[host]:[port]/irj/servlet/prt/portal/prtroot/com.sap.portal.pcd.admintools.import.default



Select Client as the “Source for Package Files” and browse to the location to which you moved the com.sap.pct.tools.pcd_inspector.epa file (e.g.: C:/temp/com.sap.pct.tools.pcd_inspector.epa).

©2004 SAP AG 4



Choose Upload:

©2004 SAP AG 5



Choose Import and wait until the following message appears in the upper left corner of the screen: “Import finished in seconds”.

You can now start the PCD Inspector tool from the URL (replace [host] and [port] in the following url with the one your are working with, e.g.: [host]==localhost, [port]==50000):


©2004 SAP AG 6



The first screen of the PCD Inspector tool should look like the following screenshot:

©2004 SAP AG 7



This step decribes how to use the PCD Inspector in the portal environment.

You have to assign the role com.sap.pct.tools.pcd_inspector_role to your user in the User Administration section of the portal (choose User Administration -> Roles). The role com.sap.pct.tools.pcd_inspector_role is part of your portal system after Step 4 of the installation has finished.

Search for the role in the role user assignment tool of the portal. Then add the role (in this case com.sap.pct.tools.pcd_inspector_role) to your user, and save the user role assignment.

©2004 SAP AG 8


An additional entry point, called PCD Tools, is included in the top-level navigation for the assigned user. The PCD Inspector (READ-ONLY) appears on the second level of top-level navigation as shown in the following screenshot:

©2004 SAP AG 9


3 General Capabilities of the PCD Inspector

3.1 Browsing through Portal Content Directory (PCD)

The PCD Inspector tool allows you to browse through the PCD, containing most of the objects (such as iViews, pages, roles, worksets, and systems) that are relevant for the portal.

To browse to a folder such as portal_content (see above screenshot), click on the ‘browse into’ link, which results in the following screenshot:

The browsed portal_content folder is shown indented under the Pcd folder (stepwise breadcrumb). All the objects in the folder portal_content are shown in a flat list.

©2004 SAP AG 10


You can always browse to any object (folder, role, iView, etc. ) by clicking on its ‘browse into’ link. The object itself is then indented under the last object of the stepwise breadcrumb. The child objects of this ‘browsed into object’ are displayed as a flat list. If no child object is available, nothing is displayed under the stepwise breadcrumb.

To browse upwards, you can use the links of the stepwise breadcrumb. For example, if you click on the ‘Pcd’ link of the breadcrumb in the below screenshot, the Pcd folder again becomes the root of the breadcrumb, and its child objects are displayed again as a flat list (in this case the ‘portal_content’ object is displayed bold so that you know where you came from when you browse up the Portal Content Directory).

3.2 Displaying or Editing Object Properties

The are two ways to display or edit PCD object properties:

1. Toolbar or menu entry actions

Browse to the object that you want to edit, and mark it as bold. Then use the toolbar icons or the menu entries to perform the select action (described in more detail below).

2. Property Editor or page for editing all properties

Browse to the object that you want to edit and use either the ‘propEditor’ link to open the Property Editor in a new window, or click on the ‘AllProps’ link to open a page to edit the properties in the same window.

You can edit (modify, delete, create) single properties and display/edit meta attributes of properties with both the Property Editor and the page for editing properties.

Note: In the read-only version of the PCD Inspector you cannot edit (modify, delete, create) an object but only use the display functions.

©2004 SAP AG 11


3.2.1 Toolbar or Menu Entry Actions

In the following screenshot, select the checkbox or click the label ‘role1’ to display the object role1 (with url: pcd:portal_content/role1) in bold (red arrow) .

©2004 SAP AG 12


In the following screenshot you can see the toolbar icons (toolbar actions are described in detail in Section 4.):

©2004 SAP AG 13


The menu entries are visualized in the next screenshot. You get the menu entry by clicking on the menu icon.

The toolbar and menu entry actions are performed on the selected object or objects (multi-selection).

©2004 SAP AG 14


4 Overview of Toolbar Actions Here you see a screenshot of the toolbar:

If you hover over the toolbar icons, you get a quick info of what clicking this icon will do.

Delete selected object(s)

(described in more detail in subsection 4.1)

Note: You cannot delete objects in the read-only version of the PCD Inspector.

Refresh page

Refreshes the current displayed browse page

Copy or move object(s)

Clicking this icon opens a second browser (on the right) so that you can copy or move selected object(s) from the browser on left side under the last object of the stepwise breadcrumb of the browser on the right side.

Note: You cannot copy and move in the read-only version of the PCD Inspector.

Rename selected object

Opens a dialog so that you can rename the selected object

Note: You cannot rename objects in the read-only version of the PCD Inspector.

Search for objects

Opens a dialog where you can specify which kind of object (type, atomic name, etc....) you are looking for.

Visualize delta link dependencies

Visualize the delta link dependencies of selected object using a tree dependency view.

(Described in more detail in subsection 4.2)

Visualize delta link dependencies on property level

Visualize the delta link dependencies of the selected object for a specified property using a tree dependency view.

Show the where-used list for a selected object

A list of objects that use the selected object (where-used list) is displayed.


©2004 SAP AG 15


Create a new folder

Note: You cannot create new folders in the read-only version of the PCD Inspector.

Create a new role

Note: You cannot create new roles in the read-only version of the PCD Inspector.

Create a new workset

Note: You cannot create new worksets in the read-only version of the PCD Inspector.

Create a new delta link

Opens a second browser on the right side so that you can create a delta link of the selected object(s) from the browser on the left side under the last object of the stepwise breadcrumb of the browser on the right side.

Note: You cannot create a new delta link in the read-only version of the PCD Inspector.

Create a new link reference

Opens a second browser on the right side so that you can create a link reference (shortcut) of the selected object(s) from the browser on the left side under the last object of the stepwise breadcrumb of the browser on the right side.

Note: You cannot create new link references in the read-only version of the PCD Inspector.

Activate delta link icons

Displays additional delta link icons for objects whose delta link state is not -1.


Activate lock info icons

Displays additional lock info icons for locked objects

Preview selected iView or page

Opens a window that previews the selected iView or page.

Open collector

Opens the collector, where you can collect different objects.

Add selected nodes to collector

Adds the selected objects to your collector.

Open personalization

©2004 SAP AG 16


4.1 Delete Selected Object(s)

Note: You cannot delete objects in the read-only version of the PCD Inspector.

Select the object or objects you want to delete. For example, in the following screenshot “role1” was selected by clicking directly on the checkbox or on the text ‘role1’. Then click the leftmost icon in the toolbar (trash icon):

After clicking the trash icon, you get a delete confirmation page, which tells you whether or not the objects you want to delete are used by other objects (that is, if they are linked to other objects).

If the objects are used by other objects, you can click on the ‘show whereUsedList’ link to find out which objects use the object to be deleted.

©2004 SAP AG 17


The following screenshot shows the delete confirmation page. If you are sure you want to permanently delete the selected objects from the Portal Content Directory, choose ‘Delete’. (This is not possible for the read-only version of the PCD Inspector – in this case a messagae appears explaining that you may not delete objects in read-only mode).

©2004 SAP AG 18


4.2 Visualizing Delta Link Dependencies as a Tree

4.2.1 First Example of Delta Link Visualization:

Assume you have a role and a workset object with the following URLs:

Role: pcd:portal_content/role1

Workset: pcd:portal_content/workset1

You created a delta link of workset1 under role1. This can be visualized as follows:

pcd:portal_content/role1/workset1

|

|- Delta link -> pcd:portal_content/workset1

To analyze this workset delta link with the PCD Inspector tool, browse to the workset1 delta link in role1 and select it as shown in the next screenshot:

Choose the delta link dependency icon on the toolbar. The delta link dependency tree is visualized below.

The delta link object pcd:portal_content/role1/workset1 points to its target object pcd:portal_content/workset1.

©2004 SAP AG 19


The below screenshot shows the following structure:


|


In the PCD, the browse to links introduce both objects. You can easily locate the delta link and its target in the browser by clicking on this link.

If you delete the target (==pcd:portal_content/workset1) of the delta link pcd:portal_content/role1/workset1 and visualize the delta link dependency of the delta link pcd:portal_content/role1/workset1, the result looks like the following screenshot.

©2004 SAP AG 20


You can see that the delta link is broken because the target of the delta link is no longer visible:

A more complex delta link scenario is explained in the next subsection.

4.2.2 Second Example of Delta Link Visualization:

Assume you have two roles and one iView object with the following URLs:

Roles: pcd:role1

pcd:role2

iView: pcd:example_url_iview

1) You created a delta link of role1 under role2. This can be visualized as follows:

pcd:role2/role1

|

|- Delta link -> pcd:role1

©2004 SAP AG 21


2) You created a delta link of example_url_iview under role1. This can be visualized as follows:

pcd:role1/example_url_iview

|

|- Delta link -> pcd:example_url_iview

Both scenarios can be combined in the following tree structure:

pcd:role2/role1/example_url_iview |

|- Delta link -> pcd:role1

pcd:role1/example_url_iview |

|- Delta link -> pcd:example_url_iview This is the delta link dependency chain that you get in the PCD Inspector when you select the delta link object pcd:role2/role1/example_url_iview and click on the toolbar icon . The next screenshot shows the delta link dependency chain that resembles the below structure tree. The object urls displayed in bold are the objects that directly influence each other with the delta link.

Example: iView object pcd:role1/example_url_iview in the above tree structure has an effect on iView object pcd:role2/role1/example_url_iview via the delta link. This means that if for example the title property for iView object pcd:role1/example_url_iview is set to “Example iView” and this property is not set for iView object pcd:role2/role1/example_url_iview, this object inherits the title “Example iView” from the delta link.

©2004 SAP AG 22


4.3 Visualizing Delta Links with Icons

Beside the tree visualization of delta links with delta link chains, you can also visualize delta links with icons. This means that you already get some information from the additional icon displayed in front of the normal object icon.

To activate delta link icon visualization, click on the icon on the toolbar. To deactivate it, click again on this icon.

The following paragraph presents some standard scenarios for delta link visualization via icons.

Assume you have a role and a workset object with the following urls (the same assumptions as in Section 4.2.1):

Role: pcd:portal_content/role1


You created a delta link of workset1 under role1. This can be visualized as follows:


|


If you do not click on the icon on the toolbar, the browser displays the delta link object pcd:portal_content/role1/workset1 as follows:

©2004 SAP AG 23


If you click on the icon, it is displayed as in the below screenshot.

As you can see, the additional icon is inserted in front of its object icon ( ==workset icon) for delta link pcd:portal_content/role1/workset1 . The icon indicates that the object is a delta link.

©2004 SAP AG 24


There are different kinds of delta link icons:

Modified delta link:

A modified delta link is created if a property of the delta link object pcd:portal_content/role1/workset1 is modified. For example you open the Property Editor by clicking on the PropEditor link, modify the title of the object, and save it. You close the Property Editor and click on the Refresh icon on the toolbar. The delta link object no longer inherits its title from the delta link target object pcd:portal_content/workset1. Instead, it is defined locally so that the delta link icon changes to a modified delta link icon as shown in the following screenshot. As a result you know that any delta link object that shows this icon has at least one property that was changed.

©2004 SAP AG 25


Added delta link object:

If you create for example a workset folder ws_folder1 under the delta link object pcd:portal_content/role1/workset1, the created object pcd:portal_content/role1/workset1/ws_folder1 is not inherited from the delta link target object pcd:portal_content/workset1. Instead, it is added locally under the delta link and a delta link icon is added as shown in the next screenshot:

©2004 SAP AG 26


Inherited delta link object:

Assume that you create a folder ws_target_folder in the delta link target object pcd:portal_content/workset1. The delta link object pcd:portal_content/role1/workset1 inherits this folder from the delta link target. (With the above locally added folder ws_folder the delta link has two workset folders under its root). The inherited object ws_target_folder is displayed with the icon :

©2004 SAP AG 27


Broken delta link:

If the delta link target object pcd:portal_content/workset1 is deleted (as described in Section 4.1), the broken delta link icon is added to the delta link object pcd:portal_content/role1/workset1 as shown in the following screenshot:

©2004 SAP AG 28


4.4 Displaying the Where-Used List for Selected Objects

The where-used list helps you to find the objects (a1, a2, ..., aN ) that reference another object obj1 if the objects (a1, a2, ..., aN ) are connected to obj1 with a delta link.

Assume you have two roles and one workset object with the following urls (same assumptions as in Section 4.2.1):

Roles: pcd:portal_content/role1

pcd:portal_content/role2


You created a delta link of workset1 under both role1 and role2. This can be visualized as follows:

For role1:


|


For role2:


|


The object pcd:portal_content/workset1 is now used by delta link object pcd:portal_content/role1/workset1 as well as by delta link object pcd:portal_content/role2/workset1.

If someone wants to delete or modify object pcd:portal_content/workset1, you might need to know which objects depend on this object. These objects are the objects in the where-used list.

©2004 SAP AG 29


You can create the where-used list with the PCD Inspector tool by selecting the object for which you want to create the where-used list as in the following screenshot:

Click the where-used list icon to display the where-used list (== objects that reference the selected object).

©2004 SAP AG 30


In the given scenario, these objects are the two workset delta link objects pcd:portal_content/role1/workset1 and pcd:portal_content/role2/workset1, which can be seen in the following screenshot that appears after clicking on the icon :

©2004 SAP AG 31


5 Questions, Problems, Feedback.... Describe your question or problem in SDN PCD Inspector forum and it will be answered very soon.

©2004 SAP AG 32


No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP AG. The information contained herein may be changed without prior notice.

Some software products marketed by SAP AG and its distributors contain proprietary software components of other software vendors.

Microsoft®, WINDOWS®, NT®, EXCEL®, Word®, PowerPoint® and SQL Server® are registered trademarks of Microsoft Corporation.

IBM®, DB2®, DB2 Universal Database, OS/2®, Parallel Sysplex®, MVS/ESA, AIX®, S/390®, AS/400®, OS/390®, OS/400®, iSeries, pSeries, xSeries, zSeries, z/OS, AFP, Intelligent Miner, WebSphere®, Netfinity®, Tivoli®, Informix and Informix® Dynamic ServerTM are trademarks of IBM Corporation in USA and/or other countries.

ORACLE® is a registered trademark of ORACLE Corporation.

UNIX®, X/Open®, OSF/1®, and Motif® are registered trademarks of the Open Group.

Citrix®, the Citrix logo, ICA®, Program Neighborhood®, MetaFrame®, WinFrame®, VideoFrame®, MultiWin® and other Citrix product names referenced herein are trademarks of Citrix Systems, Inc.

HTML, DHTML, XML, XHTML are trademarks or registered trademarks of W3C®, World Wide Web Consortium, Massachusetts Institute of Technology.

JAVA® is a registered trademark of Sun Microsystems, Inc.

JAVASCRIPT® is a registered trademark of Sun Microsystems, Inc., used under license for technology invented and implemented by Netscape.

MarketSet and Enterprise Buyer are jointly owned trademarks of SAP AG and Commerce One.

SAP, SAP Logo, R/2, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are trademarks of their respective companies.

©2004 SAP AG 33

DisclaimerIntroduction:Installation of PCD Inspector (READ-ONLY Version)Installation: Step 1Installation: Step 2Installation: Step 3Installation: Step 4Installation: Step 5

General Capabilities of the PCD InspectorBrowsing through Portal Content Directory (PCD)Displaying or Editing Object PropertiesToolbar or Menu Entry Actions

Overview of Toolbar ActionsDelete Selected Object(s)Visualizing Delta Link Dependencies as a TreeFirst Example of Delta Link Visualization:Second Example of Delta Link Visualization:

Visualizing Delta Links with IconsDisplaying the Where-Used List for Selected Objects

Questions, Problems, Feedback....

How to… Install and Use the PCD Inspector Tool - Archive€¦ · Choose Import and wait until the...

Documents

Transcript of How to… Install and Use the PCD Inspector Tool - Archive€¦ · Choose Import and wait until the...