Customizing the information displayed for remote artifacts

When a remote artifact is displayed in the Rhapsody® model browser, specific pieces of information are displayed for the artifact, depending on the type of artifact. For example, when a remote requirement is displayed in the browser, the ID and title of the requirement are displayed by default. You can customize the information that is displayed by editing the relevant property in the Architecture Management configuration file.

Procedure

  1. On the server that hosts the Architecture Management application, open the file ../Jazz Team Server/server/conf/ccm/am.properties
  2. Locate the property com.ibm.team.rmm.oslc.rm_app_config, and modify the JSON code for the entry of one or more of the supported tools, for example, the entry Default DOORS Next:
    "Default DOORS Next":{"tool":{"path":"rm"},"attributes":{"Title":{"format":{"format":"%1$s: %2$s","limit":"50","values":
    [{"property":"Identifier"},{"property":"Title"}]}},"ArtifactId":{"property":"Identifier"},
    "Specification":{"property":"Primary Text"},"Description":{"property":"Description"}},"tags":{}}
    • The attributes section is used to map the four types of information that can be defined for a requirement in Rhapsody: Title (name of the requirement, displayed also in the browser), RequirementId (ID field in the Features window), Specification, and Description. (For test cases and work items, only Title, RequirementId, and Description can be mapped.)
    • The tags section can be used to define additional fields that will be displayed as tags for the artifact in Rhapsody.
    Note: The referenced field names from the remote tool are the strings that appear after "property". So in the example that is given here, the DOORS Next fields that are referenced are Identifier, Title, Primary Text, Description. When modifying the contents of the property, you can use any of the fields from the "instance shape" of the remote tool.
  3. Save the modified file and restart the server.
    Note: If any Rhapsody models are currently open, the models must be closed and reopened in order to reflect the changes that were made in the configuration file.
    Note: When customizing the information displayed for remote artifacts, it may be convenient to try out these changes on a single user's version of Rhapsody before deploying the changes to the server. To use this approach, follow these steps:
    1. Locate the file ...\UserShare\Profiles\RhapsodyModelManager\CustomOslcArtifactAppearance.txt. This file contains the same JSON code as the server property.

      The location of the UserShare directory depends on the type of installation you chose for Rhapsody. If you selected the "install in one location" option, UserShare is in the Rhapsody installation directory. If you chose a "split" installation for "all users", UserShare is below C:\ProgramData\IBM\Rhapsody\[release number]. If you chose a "split" installation for a single user, UserShare is below [User Directory]\ProgramData.

    2. Make the changes to the text file and save it.
    3. For the model you are testing with, change the value of the property UseCustomOslcArtifactAppearance to True.
    4. Close and re-open Rhapsody.
    5. Open the model where you changed the property value.

Modifying displayed artifact information temporarily with GET/POST

Procedure

  1. Issue a GET request using the url: https://<fully qualified hostname>:9443/ccm/oslc-am/rmappconfig
  2. After modifying the configuration data, issue a POST request using the following information:
    • url: https://<fully qualified hostname>:9443/ccm/oslc-am/rmappconfig
    • header: x-com-ibm-team-large-ids-request: true
    • content type: text/plain
    Note: You need Admin rights to issue a POST request.

Feedback