Setting up the tutorials
Perform the following setup tasks before working through the service management profile tutorials.
- Download the tutorial sample files in the following compressed file: GEP_Tutorials.zip. Extract the
contents of the compressed file to a location of your choice. This file contains the
following resources:
- A WSDL file that defines the Eligibility service
- A charter document that describes the requirements for the Eligibility service
- WSDL and XSD files that define the Account creation service
- A charter document that describes the requirements for the Account creation service
- An SCA module for the Address Formatter service
- A document representing the business capability charter for the provider service
- A document representing the business capability charter for the consumer application
- A definition document for a REST-based catalog search service
- A document representing the charter for a catalog search service
- A Swagger YAML document that defines a REST-based catalog search service
Note: Some of these files are not required for the service management profile tutorials. - Ensure that the service management profile is active.
- Open the WebSphere® Service Registry and Repository web user interface.
- If you have security enabled, log in with a user ID that is assigned to the Administrator J2EE role, otherwise go to the next step. (For details of the J2EE roles, and assigning users to the roles, see J2EE role mappings).
- Switch to the Configuration perspective, if necessary, by selecting Configuration from the Perspective list; the Perspective list is located in the WebSphere Service Registry and Repository banner at the top of the page.
- Click Manage Profiles > Configuration Profiles.
- If the service management profile has already been loaded, check
that the status of the profile is Active. If it is not, select
the check box alongside the profile and click Make Active (the
displayed name for the profile will depend on the name that was entered when the
profile was loaded).
If the service management profile has not been loaded, load it by following the instructions in Loading a configuration profile. Then, activate the profile.
- Ensure that you have the following views in the WSRR dashboard:
- A view called Business, based on the Business template.
- A view called Development, based on the Development template.
- A view called Operations, based on the Operations template.
- A view called SOA Governance, based on the SOA Governance template.
You can check for these views by logging in to the dashboard and then expanding the Select a View drop-down list in the Service Registry Dashboard title bar (alternatively referred to as a banner). For more information, see Starting the WSRR dashboard, and the Dashboard views section in Tour of the Service Registry dashboard.
If you do not have these views, you must create them. For details about how to create a view from a template, see Creating dashboard views based on templates.
- Ensure that the enhanced detail view is enabled in the WSRR dashboard, as described in Enabling the enhanced detail view. The enhanced detail view provides a simplified view of a service, application, or process version within the Detail widget, and displays the service information in a set of tabs. (This enhanced view is enabled by default only in new installations of WSRR that use the default service management profile.)
- Ensure that the Detail widget in the WSRR dashboard is configured to display links to
Swagger documents that are attached to REST service interface items. (This configuration
option is enabled by default only in new installations of WSRR that use the default
service management profile and enhanced detail view.)
- From the Browse page of one of the dashboard views, open the Detail Display Settings window by switching to edit mode while viewing any Detail widget. For more information, see Configuring the Detail widget.
- In the navigation pane, click Capability Version to edit the settings for that entry in the display pane.
- Click the Relationships tab in the display pane to configure display settings for relationships.
- Click the Interface tab and ensure that the Enable
a link to the Swagger document viewer (when a Swagger document is
available) check box is selected. For more information, see Relationships for capability versions.

- Repeat step b to step d for the Capability Version subclasses that are shown in the navigation pane.
- (Optional) Configure promotion.
Although you do not have to complete this task to complete the tutorials, it adds further realism if you configure the WSRR promotion feature, so that the service is promoted to a staging registry when it is approved for staging deployment, and to a production registry when it is approved for production deployment. For the purposes of the tutorials, the manual promotion mechanism is used; this means that the service is not actually promoted directly to a target registry, but instead an export file is created in a directory location that you specify. You can then import the file into another registry, that also has the service management profile active, if you have one available, or, on completion of the tutorials, you can delete the objects that you created during the tutorial and then import the file into the same registry.
- Open the WebSphere Service Registry and Repository web user interface.
- Switch to the Configuration perspective if necessary, by selecting Configuration from the Perspective list.
- Click Active Profile > Promotion, then click PromotionProperties.
- Enter the following in the Content pane, replacing the default
C:/Promotion path, in the two <filepath> elements, with
the location, on the WSRR server, to which you want the promotion export file to be
written. The format of the file path must be valid for the operating system you are
using, and it must specify an existing directory; for example,
C:\promotion\tutorial on a Windows platform, or
/promotion/tutorial on a UNIX platform. Note that if you are
working on a client workstation that is separate from the WSRR server, the file path
refers to a location on the WSRR
server:
<?xml version="1.0" encoding="UTF-8"?> <!-- begin_generated_IBM_copyright_prolog --> <!-- Licensed Materials - Property of IBM --> <!-- 5724-N72 5655-R41 --> <!-- (c) Copyright IBM Corp. 2007, 2009 All Rights Reserved --> <!-- US Government Users Restricted Rights - Use, duplication or --> <!-- disclosure restricted by GSA ADP Schedule Contract with --> <!-- IBM Corp. --> <!-- end_generated_IBM_copyright_prolog --> <promotion-configuration xmlns="http://www.ibm.com/xmlns/prod/serviceregistry/6/1/PromotionProperties" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <environments> <!-- This environments section needs to be updated to define the correct promotion environments that you have/will be using in your WSRR Governance topology. These sample environments (Staging and Production) will write the promotion data to a file on the WSRR system, which can later be imported into the target WSRR system. --> <environment name="http://www.ibm.com/xmlns/prod/serviceregistry/6/1/GovernanceProfileTaxonomy#Staging" > <promotion> <type>manual</type> <filepath>C:/Promotion/</filepath> <filename>StagingPromotion%TS%.zip</filename> </promotion> </environment> <environment name="http://www.ibm.com/xmlns/prod/serviceregistry/6/1/GovernanceProfileTaxonomy#Production" > <promotion> <type>manual</type> <filepath>C:/Promotion/</filepath> <filename>ProductionPromotion%TS%.zip</filename> </promotion> </environment> </environments> <transitions> <!-- The transitions section needs to be uncommented once valid environments have been defined above, in order for the promotions to occur on these transitions. --> <!-- The Deployed_On_Application_Server and Runs_On_Computer_System ignore-relationships prevent CCMDB entities from being promoted --> <!-- <transition name="http://www.ibm.com/xmlns/prod/serviceregistry/lifecycle/v6r3/LifecycleDefinition#ApproveStagingDeployment"> <target-environments> <name>http://www.ibm.com/xmlns/prod/serviceregistry/6/1/GovernanceProfileTaxonomy#Staging</name> </target-environments> <ignore-relationships> <name>Deployed_On_Application_Server</name> <name>Runs_On_Computer_System</name> </ignore-relationships> <include-policies> <applies-to>http://www.ibm.com/xmlns/prod/serviceregistry/profile/v6r3/GovernanceEnablementModel#ServiceLevelDefinition</applies-to> <applies-to>http://www.ibm.com/xmlns/prod/serviceregistry/profile/v6r3/GovernanceEnablementModel#ServiceLevelAgreement</applies-to> <applies-to>http://www.ibm.com/xmlns/prod/serviceregistry/profile/v6r3/GovernanceProfileExtensions#ServiceLevelDefinition</applies-to> <applies-to>http://www.ibm.com/xmlns/prod/serviceregistry/profile/v6r3/GovernanceProfileExtensions#ServiceLevelAgreement</applies-to> </include-policies> </transition> <transition name="http://www.ibm.com/xmlns/prod/serviceregistry/lifecycle/v6r3/LifecycleDefinition#ApproveProductionDeployment"> <target-environments> <name>http://www.ibm.com/xmlns/prod/serviceregistry/6/1/GovernanceProfileTaxonomy#Production</name> </target-environments> <ignore-relationships> <name>Deployed_On_Application_Server</name> <name>Runs_On_Computer_System</name> </ignore-relationships> <include-policies> <applies-to>http://www.ibm.com/xmlns/prod/serviceregistry/profile/v6r3/GovernanceEnablementModel#ServiceLevelDefinition</applies-to> <applies-to>http://www.ibm.com/xmlns/prod/serviceregistry/profile/v6r3/GovernanceEnablementModel#ServiceLevelAgreement</applies-to> <applies-to>http://www.ibm.com/xmlns/prod/serviceregistry/profile/v6r3/GovernanceProfileExtensions#ServiceLevelDefinition</applies-to> <applies-to>http://www.ibm.com/xmlns/prod/serviceregistry/profile/v6r3/GovernanceProfileExtensions#ServiceLevelAgreement</applies-to> <allowed-state>http://www.ibm.com/xmlns/prod/serviceregistry/lifecycle/v6r3/LifecycleDefinition#SOAPolicyLifecycle_Approved</allowed-state> <allowed-state>http://www.ibm.com/xmlns/prod/serviceregistry/lifecycle/v6r3/LifecycleDefinition#SOAPolicyLifecycle_Superceded</allowed-state> <allowed-state>http://www.ibm.com/xmlns/prod/serviceregistry/lifecycle/v6r3/LifecycleDefinition#SOAPolicyLifecycle_Deprecated</allowed-state> <allowed-state>http://www.ibm.com/xmlns/prod/serviceregistry/lifecycle/v6r3/LifecycleDefinition#SOAPolicyLifecycle_Retired</allowed-state> </include-policies> </transition> --> </transitions> </promotion-configuration> - You must also define the transitions that activate promotions. The recommended transitions, and the definitions associated with them, are contained in the promotions configuration file. To activate promotion, you must remove the comment characters. Delete <!–-before the first transition definition, and -–> after the last transition definition. The transition definition also specifies how policies are promoted, in terms of which object types are considered for policy attachments, and what state the promoted policies should be in. For more information on policy promotion, see Policy promotion.
- Click OK to save your changes.
- If security is enabled, ensure that the user ID that is assigned to the Administrator
RunAs role, for the ServiceRegistry application in WebSphere Application Server, is also assigned to the WSRRAdmin role. This step is
required so that you can use the custom buttons provided in the service management
profile.To verify which user ID is assigned to the Administrator RunAs role, perform the following actions:
- Open the WebSphere Application Server administrative console.
- Click Applications > Application Types > WebSphere enterprise applications, then click ServiceRegistry.
- Click User RunAs roles. The user ID that is assigned to the Administrator RunAs role is displayed in the User name column.
For details about assigning users to WSRR roles, see Add and remove principals for a role.