How to synchronize with PPM

The following steps describe how to synchronize Service Management with PPM.

Note For more information about downloading, installing, and creating the On-Premise Bridge Agent, see How to use On-Premise Bridge agents on Windows or How to use On-Premise Bridge agents on Linux.

  1. Download and install the On-Premise Bridge Agent.

  2. Create an agent.

  3. Specify the credentials.

  4. Create a PPM endpoint:

    1. From the main menu, select Administration >Utilities > Integration>Endpoints.
    2. Click Add iconAdd.

    3. Enter the endpoint details.

      Field Description
      Endpoint type Select the relevant PPM version.
      Endpoint name Type a name for the endpoint. Use only Latin letters and spaces.
      Running on agent Select the agent (installed in step 1) from the drop-down list.
    4. Click Add.
  5. Configure the endpoint:

    1. Click Configure icon Configure. The Endpoint Configuration dialog box opens.

    2. Enter the endpoint details under Settings.

      Field Description
      End point name

      The name of the endpoint.

      Note This field is read-only.

      Location

      Type the base URL of the PPM server to be synchronized with Service Management.

      Credentials

      Select credentials to be used for the authentication of the PPM server.

      Note If a text field appears, insert the credential ID manually.

      Enable manual sync Select Yes or No. If Yes is selected, the Sync now button appears in each idea and proposal record for you to manually synchronize each record to the PPM server. If No is selected, the record-level synchronization function is disabled.
    3. (Optional) You can click the Test connection button to test the connection to the PPM server.
    4. Enter the field mapping details under Additional field customization.

      • To enable mapping from an idea to a PPM proposal, select Idea from the Service Management drop-down list. By default, the out-of-the-box (OOTB) PPM request type PFM - Proposal is filled in, which means an OOTB PPM proposal is to be created from an idea. The following fields are prefilled.

        Service Management field name PPM token
        DisplayLabel REQ.KNTA_PROJECT_NAME
        Description REQ.DESCRIPTION

        You can customize the predefined mapping fields and add more fields. For descriptions of the PPM tokens, refer to the Project and Portfolio Management Help Center.

        You can change the OOTB PFM - Proposal request type to your customized request type, and then add your own mapping fields.

        If you want to specify a data type for the PPM field, select one from the column highlighted below. This solves the data incompatibility issue between Service Management and PPM.

        The following data types are supported:

        • Constant
        • Date
        • Fiscal period
        • Lookup
        • Number
        • Object
        • Percentage
        • Region
        • Text
        • Time

        You need to specify a value or data format that is supported by PPM for the following data types, so that data can be mapped correctly. To do so, fill in the value in the box next to the data type field:

        • Constant: Specify a value that is to be mapped to PPM.
        • Lookup: Specify how values are to be mapped for enumeration type fields. To do so, click the Value button and set up the value-to-value mapping between the Service Management and PPM fields. Here is an example.

        • Number: Specify a format for the number; for example, ####.##.
        • Percentage: Specify a format for the number; for example, ##.##.
        • Text: Specify the maximal text length that is supported; for example, 200.
      • To enable mapping from a proposal to a PPM project, select Proposal from the Service Management drop-down list. By default, the OOTB PPM project type Enterprise is filled in, which means an OOTB PPM project is to be created from a proposal. The following fields are prefilled.

        Service Management field name PPM token
        (None) Region
        DisplayLabel REQ.KNTA_PROJECT_NAME
        StartDate REQ.KNTA_PLAN_START_DATE
        EndDate REQ.KNTA_PLAN_FINISH_DATE
        Description REQ.DESCRIPTION

        You can customize the predefined mapping fields and add more fields. For descriptions of the PPM tokens, refer to the Project and Portfolio Management Help Center.

        You can change the OOTB Enterprise project type to your customized project type, and then add your own mapping fields.

        Likewise, specify the data types and values for the PPM fields when needed.

      • To map an idea or proposal to multiple PPM request or project types, you can use the Eligible filter field to set the criteria and specify the mapping to different request or project types.

        You can use Service Management's Expression Language to specify the criteria. For example: In PPM, two project types are defined (a large project and a medium project). You want to create a large PPM project from proposals that cost more than $30,000.00, and create a medium PPM project from proposals that cost no more than $30,000.00. When mapping a proposal to a large project, you can set the eligible filter as ${entity.cost>30000.00}. When mapping a proposal to a medium project, you can set the eligible filter as ${entity.cost<=30000.00}.

    5. Click Save.

    After you finish configuring the endpoint, PPM will be automatically synchronized with Service Management once every hour.

  6. (Optional) To start the synchronization immediately, click Sync now.

    By default, PPM proposals and projects are automatically synchronized from Service Management once an hour.

The synchronization job details are displayed on the Endpoints tab. To view the job details, click the job ID.

You can also push an idea or a proposal to PPM on the idea or proposal record page:

Related topics