Sun Java logo     Previous      Contents      Next     

Sun logo
Sun Java System Identity Installation Pack 2005Q4M3 Release Notes  

4

Documentation Additions and Corrections

The component that displays adjacent to this title is CN Chapter Number.


About the Identity System Software Guides

Identity system software documentation is arranged in multiple guides, which are provided in Acrobat (.pdf) format on the Identity Install Pack CD. The release includes the following guides.

Identity System Software

Install Pack Installation (Identity_Install_Pack_Installation_2005Q4M3.pdf) — Describes how to install and update Identity system software.

Identity Manager

Identity Auditor

Identity Auditor Administration (IDA_Administration_2005Q4M3.pdf) - Provides an introduction to the Identity Auditor Administrator interface.

Identity Manager Service Provider Edition


Navigating the Online Guides

Use the Acrobat Bookmarks feature to navigate the guides. Click a section name in the bookmark panel to jump to that section location in the document.

The Identity Manager documentation set can be seen from any Identity Manager installation by navigating to idm/doc in your web browser.


Install Pack Installation

Additions

Added new information in support of installer enhancements and updates.

Corrections

Because you must install JDK 1.4.2 for this release, the Chapter 5 section For JDK 1.3.x: is no longer applicable. In the same chapter, the section For JDK 1.4 should be changed to For JDK 1.4.2.

In Appendix E a note should appear as follows:


Note  Because you must install JDK 1.4.2 for this release, all supported environments should now have a JCE 1.2 included and information in this appendix is no longer applicable.


Identity Manager Administration Guide

Additions


Identity Manager Technical Deployment Overview

The following discussion of associated workflows, forms, and JSPs belongs to the architectural overview of the Identity Manager Technical Deployment Overview (ID-7332).

Process Execution

When a user enters data into a field on a page and clicks Save, view, workflow and form components work together to execute the processes necessary to process the data.

Each page in Identity Manager has a view, workflow and form associated with it that performs the necessary data processing. These workflow, view, and form associations are listed in the following two tables.

Identity Manager User Interface Processes

The following tables indicate the forms, views and workflows that are involved in processes initiated from the following Identity Manager User Interface pages:

User Interface

Page

 

Form

 

 

View

 

 

Workflow

 

 

Main menu

  endUserMenu

  default End User Menu

User

View is read-only. No modifications can be made on this page

none

Change Password

  endUserChangePassword

  default Change Password Form

Password

  changeUserPassword

  default Change User Password

Change Other Account Attributes

  endUserForm

  default End User Form

User

Update User

Check Process Status

  endUserTaskList

  default End User Task List

List

View includes information on TaskInstance objects launched by the user

none

Process Status

Page is generated by the TaskViewResults class

none

none

none

Available Processes

  endUserLaunchList

  default End User Launch List

List

View includes information on TaskDefinition objects accessible to the user

none

Launch Process

Launches a selected TaskDefinition

Defined by the TaskDefinition

Process

none

Change Answers to Authentication Questions

  changeAnswers

  default Change User Answers Form

ChangeUserAnswers

none

Self Discovery

Can link to existing resource accounts only

  selfDiscovery

  default Self Discovery

User

Update User

Inbox

  endUserWorkItemList

  default End User Work Item List

List

View contains information about WorkItems directly owned by the current user

none

Inbox Item Edit

Specified by WorkItem or auto-generated

WorkItem

none

Administrator Interface Processes

The following tables identify the forms, views, workflows, and JSPs that are involved in processes initiated from these Identity Manager Administrator Interface pages:

Administrator Interface

Page

 

Form

 

 

 

View

 

 

 

Workflow

 

 

 

Create Organization and Edit Organization

System Configuration mapping

Depending upon context, can be one of several forms, including:

  Organization Form

  Organization Rename Form

  Directory Junction Form

  Virtual Organization Form

  Virtual Organization Refresh Form

Org

none

Create User

  userForm

  default Tabbed User Form

User

  createUser

  default Create User

Update User

  userForm

  default Tabbed User Form

User

  updateUser

  default Update User

Disable User’s Resource Accounts

  disableUser

  default Disable User

Disable

  disableUser

  default Disable User

Rename User

  renameUser

  default Rename User Form

RenameUser

  renameUser

  default Rename User

Update User’s Resource Accounts

  reprovisionUser

  default Reprovision Form

Reprovision

  updateUser

  default Update User

Unlock User’s Resource Accounts

  unlockUser

  default Unlock User

Unlock

  unlockUser

  default Unlock User

Delete User’s Resource Accounts

  deprovisionUser

  default Deprovision Form

Deprovision

  deleteUser

  default Delete User

Change User Password

Uses same workflow as end-user GUI, but different form

  changePassword

  default Change User Password Form

ChangeUserPassword

  changeUserPassword

  default Change User Password

Reset User Password

  resetPassword

  default Reset User Password Form

ResetUserPassword

  changeUserPassword

  default Change User Password

Change My Password

Same view, form, and workflow as End-User Change Password but different JSP

  endUserChangePassword

  default Change Password Form

Password

  changeUserPassword

  default Change User Password

Change My Answers

Same view, form as End-User Change Answers but different JSP

  changeAnswers

  default Change User Answers Form

ChangeUserAnswers

none

Approvals

  workItemList

  default Work Item List

  default form includes Work Item Confirmation

WorkItemList

 

none

Edit WorkItem

Check in of the WorkItem view results in the resumption of the workflow that created it, but no workflow is created just to process the work item checkin

Specified by WorkItem, or auto-generated

WorkItem

none

Launch Task

Launches a selected TaskDefinition

Defined by the TaskDefinition

Process

none

Create and Update Scheduled Tasks

no System Configuration mapping, default Task Schedule Form, merged with TaskDefinition form

This form is generated by combining the TaskDefinition form with Task Schedule Form as a wrapper

TaskSchedule

none

Create Role and Edit Role

no System Configuration mapping

The default Role Form and Role Rename Form depend on context

Role

  manageRole

  default Manage Role

Edit Resource

no System Configuration mapping, depends on context, forms include:

  Change Resource Account Password Form

  Reset Resource Account Password Form

  Edit Resource Policy Form

  Resource Rename Form

  Resource Wizard <resource type>

  Resource Wizard.

Allows type-specific wizard forms, default to Resource Wizard

Resource

  manageResource

  default Manage Resource

Edit Capability

changeCapabilities, default Change User Capabilities Form

ChangeUserCapabilities

none

Java Server Pages (JSPs) and Their Role in Identity Manager

The following tables describe the JSPs that are shipped with the system as well as their Administrator and User Interface pages.

JSPs for Identity Manager User Interface

Page

Associated JSP

Main Menu

user/main.jsp

Change Password

user/changePassword.jsp

Change Other Account Attributes

user/changeAll.jsp

Check Process Status

user/processStatusList.jsp

Process Status

user/processStatus.jsp

Available Processes

user/processList.jsp

Launch Process

user/processLaunch.jsp

Change Answers to Authentication Questions

user/changeAnswers.jsp

Self Discovery

user/selfDiscover.jsp

Inbox

user/workItemList.jsp

Inbox Item Edit

user/workItemEdit.jsp

JSPs for Admin Interface

Page

Associated JSP

Create Organization and Edit Organization

security/orgedit.jsp

Create User

account/modify.jsp

Update User

account/modify.jsp

Disable User’s Resource Accounts

account/resourceDisable.jsp

Rename User

account/renameUser.jsp

Update User’s Resource Accounts

account/resourceReprovision.jsp

Unlock User’s Resource Accounts

admin/resourceUnlock.jsp

Delete User’s Resource Accounts

account/resourceDeprovision.jsp

Change User Password

admin/changeUserPassword.jsp

Reset User Password

admin/resetUserPassword.jsp

Change My Password

admin/changeself.jsp

Change My Answers

admin/changeAnswers.jsp

Approvals

approval/approval.jsp

Edit WorkItem

approval/itemEdit.jsp

Launch Tasks

task/taskLaunch.jsp

Create and Update Scheduled Tasks

task/editSchedule.jsp

Create Role and Edit Role

roles/applicationmodify.jsp

Edit Resource

resources/modify.jsp

Edit Capability

account/modifyCapabilities.jsp


Identity Manager Tuning, Troubleshooting, and Error Messages

Additions

You can now use the standard tracing facility on com.waveset.task.Scheduler to trace the task scheduler if a task is having problems.

See Tracing the Identity Manager Server in Sun Java™ System Identity Manager Tuning, Troubleshooting, and Error Messages for more information.

Corrections

Because you must install JDK 1.4.2 for this release, the instruction to remove the Cryptix jars (cryptix-jceapi.jar and cryptix-jce-provider.jar) from the idm\WEB-INF\lib directory in Chapter 1: Performance Tuning, Optimizing the J2EE Environment, no longer applies (unless you are upgrading from a previous version of Identity Manager).


Using helpTool

With the Identity Manager 6.0 release, a new feature has been added that allows you to search the online help and documentation files, which are in HTML format. The search engine is based on the SunLabs “Nova” search engine technology.

There are two stages to using the Nova engine: indexing and retrieval. During the indexing stage, the input documents are analyzed and an index is created which is used during the retrieval stage. During retrieval, it is possible to pull “passages” that consist of the context in which the query terms were found. The passage retrieval process requires the original HTML files to be present, so these files must exist in a location in the file system accessible by the search engine.

helpTool is a Java program that performs two basic functions:

You execute helpTool from the command line, as follows:

$ java -jar helpTool.jar

usage: HelpTool

-d Destination directory

-h This help information

-i Directory or JAR containing input files, no wildcards

-n Directory for Nova index

-o Output file name

-p Indexing properties file

Rebuilding/Re-creating the Online Help Index

The HTML files for online help are packaged in a JAR file. You must extract these files to a directory for the search engine. Use the following procedure:

  1. Unpack the helpTool distribution to a temporary directory. (Details TBD)
  2. In this example, we will extract the files to /tmp/helpTool.

  3. In a UNIX shell or Windows command window, change directory to the location where the Identity Manager application was deployed to your web container.
  4. For example, a directory for Sun Java System Application Server might look like the following:

    /opt/SUNWappserver/domains/domain1/applications/j2ee-modules/idm

  5. Change your current working directory to the help/ directory.

  6. Note  It is important to run helpTool from this directory or the index will not build correctly. In addition, you should remove the old index files by deleting the contents of the index/help/ subdirectory.

  7. Gather the following information for your command line arguments:

  Destination directory:

html/help/en_US

Note: Use the locale string appropriate for your installation.

  Input files:

../WEB-INF/lib/idm.jar

  Nova index directory:

index/help

  Output file name:

index_files_help.txt

Note: The name of the file is not important – but the tool will exit if this file already exists.

  Indexing properties file:

index/index.properties

  1. Run the following command:
  2. $ java -jar /tmp/helpTool/helpTool.jar -d html/help/en_US -i ../
    WEB-INF/lib/idm.jar -n index/help -o help_files_help.txt -p index/index.properties

    Extracted 475 files.

    [15/Dec/2005:13:11:38] PM Init index/help AWord 1085803878

    [15/Dec/2005:13:11:38] PM Making meta file: index/help/MF: 0

    [15/Dec/2005:13:11:38] PM Created active file: index/help/AL

    [15/Dec/2005:13:11:40] MP Partition: 1, 475 documents, 5496 terms.

    [15/Dec/2005:13:11:40] MP Finished dumping: 1 index/help 0.266

    [15/Dec/2005:13:11:40] IS 475 documents, 6.56 MB, 2.11 s, 11166.66 MB/h

    [15/Dec/2005:13:11:40] PM Waiting for housekeeper to finish

    [15/Dec/2005:13:11:41] PM Shutdown index/help AWord 1085803878

Rebuilding/Re-creating the Documentation Index

Use the following procedure to rebuild or re-create the documentation index:

  1. Unpack the helpTool distribution to a temporary directory. (Details TBD)
  2. In this example, we will extract the files to /tmp/helpTool.

  3. In a UNIX shell or Windows command window, change directory to the location where the Identity Manager application was deployed to your web container.
  4. For example, a directory for Sun Java System Application Server might look like:

    /opt/SUNWappserver/domains/domain1/applications/j2ee-modules/idm

  5. Change your current working directory to the help/ directory.

  6. Note  You must run helpTool from this directory or the index will not build correctly. In addition you should remove the old index files by deleting the contents of the index/docs/ subdirectory.

  7. Gather the following information for your command line arguments:

  Destination directory:

html/docs

  Input files:

../doc/HTML/en_US

Note: The tool will copy the en_US/ directory and subdirectories to the destination.

  Nova index directory:

index/docs

  Output file name:

index_files_docs.txt

Note: The name of the file is not important – but the tool will exit if this file already exists.

  Indexing properties file:

index/index.properties

  1. Run the following command:
  2. $ java -jar /tmp/helpTool/helpTool.jar -d html/docs -i ../doc/HTML/en_US -n index/docs -o help_files_docs.txt -p index/index.properties

    Copied 84 files.

    Copied 105 files.

    Copied 1 files.

    Copied 15 files.

    Copied 1 files.

    Copied 58 files.

    Copied 134 files.

    Copied 156 files.

    Copied 116 files.

    Copied 136 files.

    Copied 21 files.

    Copied 37 files.

    Copied 1 files.

    Copied 13 files.

    Copied 2 files.

    Copied 19 files.

    Copied 20 files.

    Copied 52 files.

    Copied 3 files.

    Copied 14 files.

    Copied 3 files.

    Copied 3 files.

    Copied 608 files.

    [15/Dec/2005:13:24:25] PM Init index/docs AWord 1252155067

    [15/Dec/2005:13:24:25] PM Making meta file: index/docs/MF: 0

    [15/Dec/2005:13:24:25] PM Created active file: index/docs/AL

    [15/Dec/2005:13:24:28] MP Partition: 1, 192 documents, 38488 terms.

    [15/Dec/2005:13:24:29] MP Finished dumping: 1 index/docs 0.617

    [15/Dec/2005:13:24:29] IS 192 documents, 14.70 MB, 3.81 s, 13900.78 MB/h

    [15/Dec/2005:13:24:29] PM Waiting for housekeeper to finish

    [15/Dec/2005:13:24:30] PM Shutdown index/docs AWord 1252155067



Previous      Contents      Next     


Copyright 2006 Sun Microsystems, Inc. All rights reserved.