Roadmap: Customize an Existing Practice Configuration
This roadmap describes how to customize an existing practice configuration.
Main Description

It is assumed that the Practice Configuration being customized cannot be modified directly. Thus, all changes must be stored separately from the practice configuration being customized. If you can modify the practice configuration elements directly, you should follow the guidelines described in Roadmap: Author a New Practice Configuration.

In general, customizing a practice configuration involves creating a new practice configuration that includes the elements you want from the original configuration plus customizations.

When customizing a practice configuration, the following are created:

  • A Publish Extend plug-in that includes the customizations to the practice configuration-specific elements. For example, customized cross-practice processes, navigation views and welcome pages.
  • A new method configuration that includes the original plug-ins plus the new Extend plug-ins that contain the customizations.

For more information on the Publish Extend plug-in, see Concept: Practice Library Plug-In Types.

There are a number of different ways that you can customize an existing practice configuration. You can:

  • Add new elements (method content and/or processes from practices and/or core) to the practice configuration. These elements may come from new practices, extensions to existing practices, new core elements, extensions to existing core elements.  See the "Add new elements to the practice configuration" scenario in this guideline.
  • Add a new cross-practice process by assembling existing practice configuration elements (see the "Add a new cross-practice process by assembling existing practice configuration elements " scenario in this guideline.)
  • Change a practice configuration cross-practice process using the elements in the practice configuration. This includes updating an existing process to pick up changes to underlying method content, as well as changes to the flow of the process. For more information, see the "Change an existing cross-practice process using the elements in the practice configuration" scenario in this guideline.
  • Change the practice configuration to use an alternate set of role assignments (see the "Use alternative roles and/or role assignments" scenario in this guideline)
  • Change the practice configuration to use an alternate set of domain or discipline assignments (see the "Use alternative domains and/or disciplines" scenario in this guideline)
  • Customize an existing welcome page (see Guideline: Customizing a Practice Configuration Welcome Page)
  • Add a new navigation view (see the "Add a new navigation view" scenario in this guideline )
  • Customize an existing navigation view (see Guideline: Defining a Practice Configuration Navigation View)

All practice configuration customization work must be performed within the architectural constraints of the Practice Framework.  

As the practice configuration is authored, it is a good idea to publish the practice configuration and make sure the results are what you expect (Guideline: Publishing a Practice Configuration).
Note: To see the customizations, you need to browse or publish a configuration that includes the original practice configuration elements and the customizations.

Specific practice configuration customization scenarios are described in the remaining sections of this guideline.

   

Add new elements to the practice configuration 

New elements (method content and/or process) can be added to a practice configuration by adding a new practice, adding customizations to an existing practice, adding new core elements, or adding customizations to the core. In any case, the practice configuration's cross-practice processes may need to be updated to include the new elements, as well as its navigation views and welcome page.

Perform the following steps to add new elements to a practice configuration:

    

Add a new cross-practice process by assembling existing practice configuration elements

In this scenario a new cross-practice process is created using the method elements that are already part of the practice configuration.

Perform the following steps to add a new cross-practice process by assembling content from existing practice configuration elements :

  • If one does not already exist, create a Publish Extends plug-in that will contain the new process.
  • In the Publish Extends plug-in, create the new cross-practice process, specifying the practice configuration's method configuration as the default configuration for the process. Assemble the process using the elements in the configuration. For more information, see Guideline: Defining a Practice Configuration Cross-Practice Process.
       
  • Do you want the new process to appear on a navigation view?
    • If so, does that navigation view exist?
      • If so, in the new Publish Extends plug-in, you need to customize the existing navigation view to include the new process. For more information, see the "Customize an existing navigation view" scenario in this guideline.
      • If not, in the new Publish Extends plug-in, you need to create a new navigation view that includes the new process and then add that navigation view to the practice configuration's method configuration. For more information, see the "Add a new navigation view" scenario in this guideline.
          
  • Do you want the new process to appear on the practice configuration's welcome page?
    • If so, in the new Publish Extends plug-in, you need to customize the existing welcome page to add a link to the new process. For more information, see the "Customize an existing welcome page " scenario in this guideline. 

       

Change an existing cross-practice process using the elements in the practice configuration 

This scenario includes updating the process to add elements already in the configuration, remove elements, update the process to pick up changes to the underlying method content, and changing the flow of the process.

Perform the following steps to change an existing cross-practice process using the elements in the practice configuration:

  

Add a new navigation view

Perform the following steps to add a new navigation view to an existing practice configuration:

  • If one does not already exist, create a Publish Extends plug-in to contain the new navigation view.
  • Create a new method configuration for the practice configuration by copying the method configuration for the practice configuration being customized.
  • Add the new Publish Extends plug-in to the method configuration.
  • In the new Extends plug-in create the new navigation view and then select that navigation view in the new method configuration. For more information, see Guideline: Defining a Practice Configuration Navigation View.
  • If you want to reference the new navigation view from the practice configuration's welcome page, you need to customize the existing welcome page to add a link to the new navigation view. For more information, see Guideline: Customizing a Practice Configuration Welcome Page.          
       

Use alternative roles and/or role assignments

Note: This scenario assumes that the alternative role definitions and assignments have already been defined.

Perform the following steps to use the alternative role assignments:

  • Create a new method configuration for the customizes practice configuration by copying the original method configuration.
  • In the new configuration, select the Role Definition Base plug-in that contains the alternative role definitions, select the Practice Assign plug-ins that contain the alternative role assignments, and deselect the original role definitions and assignments.
  • If the original practice configuration includes cross-practice processes that are affected by the role assignment changes, then these will need to be customized to use the new role assignments. For more information, Guideline: Customizing a Practice Configuration Cross-Practice Process.
  • If the alternative role assignments affect the practice configuration navigation views, then these will need to be updated to include the new roles and/or assignments. For more information, see Guideline: Customizing a Practice Configuration Navigation View.
  • If the alternative role assignments affect the practice configuration welcome page, then it will need to updated to include the new roles and/or assignments. For more information, see Guideline: Customizing a Practice Configuration Welcome Page.

For more information on the Role Definition, Practice Assign and Publish Extend plug-ins, see Concept: Practice Library Plug-In Types.

  

Use alternative domains and/or disciplines

Note: This scenario assumes that the alternative standard category definitions and assignments have already been defined.

Perform the following steps to use alternative standard categories (what work products are categorized to what domains and what tasks are categorized to that disciplines):

  • Create a new method configuration for the practice configuration by copying the original method configuration.
  • In the new configuration, select the Category Definition Base plug-in that contains the alternative standard category definitions, select the Practice Assign plug-ins that contain the alternative standard category assignments, and deselect the original category definitions and assignments.
  • If the alternative category assignments affect the practice configuration navigation views, then these will need to be updated to include the new category assignments. For more information, see Guideline: Customizing a Practice Configuration Navigation View.
  • If the alternative category assignments affect the practice configuration welcome page, then it will need to updated to include the new category assignments. For more information, see Guideline: Customizing a Practice Configuration Welcome Page.  

For more information on the Category Definition and Practice Assign plug-ins, see Concept: Practice Library Plug-In Types.

More Information