Best practice recommendations for base services customizations

Technote (FAQ)


Question

How do I ensure that base services customizations in Tivoli Provisioning Manager are not lost when the product is upgraded?

Answer

Overview

There are a large number of customization points in the base services applications and artifacts. For example, Security Group configuration, Start Center templates, application presentation XML (User Interface) and many other artifacts can be customized.

Some artifacts such as presentations (application UI) have a built-in “delta” mechanism to ensure that upgrade works properly, even when customized. But some artifacts are more or less atomic units. So if the definitions of these artifacts are modified in a future upgrade of the product, customizations to those artifacts might be replaced.

To avoid loss of customizations during upgrades of products on the base services such as Tivoli Provisioning Manager 7.1, there are some recommended best practices for particular artifact types. These practices should be considered for implementation if you are making a substantial number of customizations in a real product deployment to avoid reconfiguration of customizations and to help ensure integrity of the stock definitions as well as your desired customizations. In addition, following these best practices provides a mechanism to retain a “reference” copy of the base artifact, which can be used to re-create or reference the base definition of the object.


1. General Recommendations

The general guideline for nontrivial customizations in a production (not proof of concept) deployment is to use and edit clones of artifacts when feasible. This avoids loss of those customizations if the artifacts are upgraded/replaced in future versions. This also provides reference copies of the base artifact in case comparison or reverting to the base version becomes necessary.

List of artifacts that can be customized, and best practice recommendations...

This table depicts a brief summary of some of the types of artifacts that can be customized, and the basic recommendations if you customize these in a production deployment (more details on some items are provided later in the document)...

Artifact Type:
Recommendation:
Related Application:
Presentation XML/GUI definitions For minor modifications to applications, modifying the base application definitions is acceptable. But for extensive modifications, duplicate and edit a new copy of the application. Application Designer
Start Center Templates When using the "Modify Existing Template" capability:
  • For the "global" Start Center Templates, create a duplicate and edit the copy
  • For user "instances" of templates, you can modify these templates directly since they are already copies of the global template
Start Center, Modify Existing Template and related functions.
Base Services Workflows Duplicate and Edit

Although there is a mechanism for these to be revision controlled, it's recommended to create a Duplicate Process for the out-of-the-box processes in order to be able to retain a reference copy and support updates of the base definitions.

Workflow Designer
Security Groups (Application Authorization) Duplicate and Edit Security Groups
Conditions Create new conditions. It is strongly recommended to not modify the out-of-the-box Conditions, as these are usually tied to specific UI functionality. Conditional Expression Manager
Web Replay Scenarios Editing particular scenarios as a different user than maxadmin is recommended. This automatically creates another copy of the scenario. Web Replay


2. Notes for customizing particular artifact types...

a. Presentation XML/GUI Definitions

As mentioned above, for minor modifications to applications, changing the base application definitions is acceptable. A delta mechanism is in place for performing application “upgrades” from previous releases. But for extensive modifications, it's recommended to duplicate and edit a new copy of the application.

A complete application can be duplicated from the Application Designer from the Select Action | Duplicate Application Definition menu:

Note that any associated Application Authorization enablement will need to be defined/enabled in the Security Groups application for each appropriate Security Group.

b. Start Center Templates

Creating a duplicate and editing the copy of the Start Center Template is the recommended practice.

Note that this is regarding the “Modify Existing Template” capability to edit the “global” Start Center Templates—not user “instances” of the templates. Editing user instances of Start Center Templates is fine, as these are already copies of the global template.

Currently, there isn't a command available from the user interface to duplicate Start Center templates. But it is fairly simple to create a clone via a SQL command:
DB2 Commands to Clone Start Centers

The following examples show DB2 commands to clone the Tivoli Provisioning Manager start centers. The blue italic text shows the typic parts of the command you would modify.

To Clone the “TPDEPLOYMENTSPECIALIST” Start Center...

insert into sctemplate(sctemplateid, description, name, contentuid, createdon, presentation)

select nextval for SCTEMPLATESEQ, 'My Deployment Specialist', 'Template-MYTPDEPLOYMENTSPECIALIST', 'MYTPDEPLOYMENTSPECIALIST', current date , presentation from sctemplate where contentuid = 'TPDEPLOYMENTSPECIALIST'

To Clone the “TPADMIN” Start Center...

insert into sctemplate(sctemplateid, description, name, contentuid, createdon, presentation)

select nextval for SCTEMPLATESEQ, 'My Provisioning Administrator', 'Template-MYTPADMIN', 'MYTPADMIN', current date , presentation from sctemplate where contentuid = 'TPADMIN'

To Clone the “TPCOMPLIANCEANALYST” Start Center...

insert into sctemplate(sctemplateid, description, name, contentuid, createdon, presentation)

select nextval for SCTEMPLATESEQ, 'My Compliance Analyst', 'Template-MYTPCOMPLIANCEANALYST', 'MYTPCOMPLIANCEANALYST', current date , presentation from sctemplate where contentuid = 'TPCOMPLIANCEANALYST'

To Clone the “TPCONFIGURATIONLIBRARIAN” Start Center...

insert into sctemplate(sctemplateid, description, name, contentuid, createdon, presentation)

select nextval for SCTEMPLATESEQ, 'My Configuration Librarian', 'Template-MYTPCONFIGURATIONLIBRARIAN', 'MYTPCONFIGURATIONLIBRARIAN', current date , presentation from sctemplate where contentuid = 'TPCONFIGURATIONLIBRARIAN'

To Clone the “TPDEVELOPER” Start Center...

insert into sctemplate(sctemplateid, description, name, contentuid, createdon, presentation)

select nextval for SCTEMPLATESEQ, 'My Automation Package Developer', 'Template-MYTPDEVELOPER', 'MYTPDEVELOPER', current date , presentation from sctemplate where contentuid = 'TPDEVELOPER'



Oracle Commands to Clone Start Centers

The following examples show Oracle commands to clone the Tivoli Provisioning Manager start centers. The blue italic text shows the typic parts of the command you would modify.

To Clone the “TPDEPLOYMENTSPECIALIST” Start Center...

insert into sctemplate(sctemplateid, description, name, contentuid, createdon, presentation)

select SCTEMPLATESEQ.nextval, 'My Deployment Specialist', 'Template-MYTPDEPLOYMENTSPECIALIST', 'MYTPDEPLOYMENTSPECIALIST', CURRENT_DATE, presentation from sctemplate where contentuid = 'TPDEPLOYMENTSPECIALIST'

To Clone the “TPADMIN” Start Center...

insert into sctemplate(sctemplateid, description, name, contentuid, createdon, presentation)

select SCTEMPLATESEQ.nextval, 'My Provisioning Administrator', 'Template-MYTPADMIN', 'MYTPADMIN', CURRENT_DATE , presentation from sctemplate where contentuid = 'TPADMIN'

To Clone the “TPCOMPLIANCEANALYST” Start Center...

insert into sctemplate(sctemplateid, description, name, contentuid, createdon, presentation)

select SCTEMPLATESEQ.nextval, 'My Compliance Analyst', 'Template-MYTPCOMPLIANCEANALYST', 'MYTPCOMPLIANCEANALYST', CURRENT_DATE , presentation from sctemplate where contentuid = 'TPCOMPLIANCEANALYST'

To Clone the “TPCONFIGURATIONLIBRARIAN” Start Center...

insert into sctemplate(sctemplateid, description, name, contentuid, createdon, presentation)

select SCTEMPLATESEQ.nextval, 'My Configuration Librarian', 'Template-MYTPCONFIGURATIONLIBRARIAN', 'MYTPCONFIGURATIONLIBRARIAN', CURRENT_DATE, presentation from sctemplate where contentuid = 'TPCONFIGURATIONLIBRARIAN'

To Clone the “TPDEVELOPER” Start Center...

insert into sctemplate(sctemplateid, description, name, contentuid, createdon, presentation)

select SCTEMPLATESEQ.nextval, 'My Automation Package Developer', 'Template-MYTPDEVELOPER', 'MYTPDEVELOPER', CURRENT_DATE , presentation from sctemplate where contentuid = 'TPDEVELOPER'



c. Base Services Workflows

Creating a Duplicate and Editing the copy of the workflow process is the recommended practice.

Although there is a mechanism for processes to be revision controlled, it's recommended to create a Duplicate Process for the out-of-the-box processes in order to be able to retain a reference copy and support updates of the base definitions.

A complete application can be duplicated from the Workflow Designer from the Select Action | Duplicate Process menu:


d. Security Groups

Depending on your security needs or concerns related to customization, you might be able to edit the out-of-the-box Security Groups or clone and then edit the groups. If you directly modify the out-of-the-box security groups, any new application authorization options corresponding to new functions might be granted to particular Security Groups during product upgrade. So if there are concerns regarding new functionality being made available automatically to particular roles/security groups, you may want to create separate groups to more tightly control this access.

A complete copy of a Security Group can be created from the Security Groups application from the Select Action | Duplicate Group menu:

You will also need to create this Security Group and assign users in your LDAP or corresponding user management system, depending on your deployment configuration.

e. Conditions

Conditions are used in a wide variety of UI control functionality. It is strongly recommended to keep the out-of-the-box Conditions unchanged, as these are usually tied to specific UI behaviors.

A complete copy of a Security Group can be created from the Security Groups application from the Select Action | Duplicate Group menu:

f. Web Replay Scenarios

Editing particular Web Replay scenarios as a different user than maxadmin is recommended. If a user other than the creator edits a Web Replay scenario, it automatically creates another copy of the scenario. All of the stock scenarios were created by “maxadmin”.

In order to grant Web Replay editing access for additional users, you will need to add the user to the WR_ADMIN_PERMISSION or the WR_SYSADMIN_PERMISSION Security Groups. (See the product security documentation for additional details.)


Rate this page:

(0 users)Average rating

Add comments

Document information


More support for:

Tivoli Provisioning Manager

Software version:

7.1, 7.1.1

Operating system(s):

AIX, Linux, Windows

Reference #:

1370269

Modified date:

2009-02-05

Translate my page

Machine Translation

Content navigation