HomeThird Party Plug-InsOnTime BridgeConfiguring the OnTime Bridge

2.5. Configuring the OnTime Bridge

To configure the PureCM OnTime Bridge service you need to edit the 'PCMOnTimeBridge.xml' file which has been installed to the location you specified in the installer. For convenience you can select 'All Programs | PureCM OnTime Bridge | Configure OnTime Bridge' from the Start menu to open this file in your default xml editor.

The elements of the xml (PureCMOnTimeSync.xml) are described below. An example file is attached for you to download. 

 

<PureCMConnection> 

This element contains attributes that are used to connect to the PureCM Server. All the attributes of this element are required.

 

The attributes are:

  
Attribute Description

PureCMServer

Name or IP address of the PureCM server

Port

Port number of PureCM server

Username

Username of PureCM server

Password

Password of PureCM server

  

For example:

 <PureCMConnection PureCMServer="dev.purecm.com" Port="2010"      Username="Developer" Password="password"/>

 

 

<Log> 

The Log element is used to set the log level and an optional file path where logging information is recorded.

 

The attributes are:

    
Attribute Description

LogLevel

Level of logging ('debug', 'info', 'warning', 'error' or 'none')

FilePath

Path of file where logging information is written 

   

For example:

 

 <Log LogLevel="info" FilePath="C:\Program Files\PureCM OnTime Bridge\Log.txt"/>

  

 

Both these parameters are optional (if not specified the log level will be 'error'). Note that when the OnTime Bridge is run in the test environment by selecting 'Start | All Programs | PureCM OnTime Bridge | Test OnTime Bridge' then the messages appropriate to the log level selected will appear in the command prompt.

 

We recommend that you begin by setting the LogLevel to 'info' and run the OnTime Bridge in the test environment. When you are satisfied that it is all working and there are no warnings or errors you can set the LogLevel to 'warning' and start the service. 

 

 

 

 <Interval>

 

This element is used to specify the time interval for the service to run. This is the number of seconds between each synchronisation. So if this value is set to 60 then every minute the OnTime Bridge will check to see if any items have been added in OnTime and whether any issues have been changed in PureCM.

  

The attributes are:

 

Attribute

Description

ServiceInterval

Time interval in seconds

 

This attribute is optional (if not specified it will wait 5 minutes)

 

For example:

   <Interval ServiceInterval="60" />  

Will synchronise OnTime with PureCM every minute.

 

<OTConnection> 

In this element the user specifies the details of the OnTime web service. It has the following attributes:

 

Attribute Description

URL 

The URL of the OnTime web service. 

GUID

The security token provided when installing the OnTime web service.

  

For example:

<OTConnection URL="http://ontime.purecm.com/ontime2008sdk/" GUID="{D876CBDB-3777-FFFF-BED2-0CE6370123A5}"/> 

 

<Mappings> 

A Mapping is where you configure which PureCM repository will be synchronised with which OnTime project. You can specify multiple Mapping elements under Mappings so you can synchronise multiple OnTime projects.

 

Each mapping has the following attributes:

 

 

Attribute Description

repos 

The name of the PureCM repository 

project

The name of the OnTime project

 

For example:

 

<Mapping repos="purecm" project="My Project">

 

 

Note that the same PureCM repository and OnTime project can be specified in multiple Mapping elements.

 

 

Within each Mapping you can specify Defects if you want to synchronise OnTime defects, Features if you want to synchronise OnTime features and Incidents if you want to synchronise OnTime incidents. You can include all 3 in one mapping or just include 1 - depending on what OnTime items you want to synchronise.

The <Defects>, <Features> and <Incidents> elements all have the same attributes which are:

Attribute

Description

PCMIssueTypeName

PureCM Issue Type Name

PCMRefField4OTDefect

The name of the field in PureCM which will contain the reference to the OnTime item 

PCMDescField

The name of the field in PureCM which will contain the OnTime description of the item 

OTCreationState

The OnTime state which the item must be in before the corresponding PureCM issue is created 

OTRefField4PCMIssue

The name of the field in OnTime which will contain the reference to the PureCM issue 

 

Note that the PureCM issue is only created if the OnTime item is in the specified state and it has an assigned user which is mapped to a PureCM user (see below). So for example the OTCreationState could be 'Open'. Initially the defect is created and put in the state 'Open' but this will not create the PureCM issue. It is only after the manager assigns the defect to a developer that the PureCM issue is created and assigned to the same developer.

Each mapping will contain one or more actions. Each action associates a PureCM Action with an OnTime workflow step and an OnTime state. So when the specified PureCM action is performed on an issue, the corresponding OnTime defect will be updated to the specified workflow step and state. Equally when the OnTime defect is put into the specified state, the corresponding PureCM issue will have the specified action performed on it.

The Mapping Action attributes are:

Attribute Description

PCMAction

The name of the PureCM action

OTWorkStep

The name of the OnTime workflow step

OTStatus

The name of the OnTime status

OTPercentComplete

A number (0-100) which the percent complete will be set to after the PureCM action has been performed

 

The OTPercentComplete  attribute only applies to Defects and Features. It is not used for Incidents.

For example:

 

<Mapping repos="purecm" project="My Project"> 

    <Defects PCMIssueTypeName="OnTime" PCMRefField4OTDefect="OTRef"  PCMDescField="Summary" OTCreationState="Open" OTRefField4PCMIssue="PCMREF">

        <Actions>         

            <Action PCMAction="Reject" OTWorkStep="Defect Closed - Rejected" OTStatus="Closed" OTPercentComplete="1"/>         

            <Action PCMAction="Complete" OTWorkStep="Defect Closed - Fixed" OTStatus="Closed" OTPercentComplete="100"/>

        </Actions>         

    </Defects>      

</Mapping>  

 

<PCMOTUsers> 

In this element PureCM and OnTime Users are specified. PCMOTUsers element has zero or more sub-elements <User>. The <User> element has the following attributes.

  

Attribute

Description

PCMUser

PureCM user name 

OTUser

OnTime user 'Login Id'

  

If an association between the OnTime user and the PureCM user cannot be found then the OnTime Bridge will see if a user in PureCM exists with the same name as the OnTime user. If there is no user with the same name then the OnTime defect will not be synchronised in PureCM.

For example:

 <PCMOTUsers>

    <User PCMUser="Developer1" OTUser="tonyab"/>   

    <User PCMUser="Developer2" OTUser="davidr"/> 

</PCMOTUsers>  

Downloads

This page was: Helpful | Not Helpful