How to access Project object via XML worksheet

Last updated
Save as PDF

This article provides the information about how to access the Project object via XML worksheet.

For Project, you can use XML request for the following:

Inserting Projects
Updating Projects
Deleting Projects
Changing Project Phases
1. Changing Phases with a Tag - Data Conversion Example
2. Changing Phases with an Action - Integration Example
Modifying project’s user rights
Adding groups to matter

Project

Inserting Projects

Here is an example XML request to add a new Project in TeamConnect via XML worksheet:

<TeamConnectRequest>
<Authentication>
    <Username>george</Username>
    <Password>password</Password>
</Authentication>
<Project op="insert">
    <Application>PLCY</Application>
    <Name>Amy MacDonald Auto Policy</Name>
    <NumberString>AP-053214</NumberString>
    <OpenedOn>2005-11-18T06:30</OpenedOn>
    <Contact keymap="SsOrTaxNumberString">635-24-6521</Contact>
</Project>
<Project op="insert">
    <Application>CLAM</Application>
    <Parent keymap="NumberString">AP-053214</Parent>
    <Contact keymap="SsOrTaxNumberString">241-58-6214</Contact>
    <NumberString>03-15-2005</NumberString>
    <OpenedOn>2005-03-15T12:30</OpenedOn>
    <Detail key="CLAM">
        <LossDate>2005-03-15T16:40</LossDate>
        <BodyPart>BOPA_ROOT_LTAR</BodyPart>
        <Insured entity="Contact" keymap="SsOrTaxNumberString">352-65-3214</Insured>
        <ClaimEstimate>3500</ClaimEstimate>
        <PastClaims entity="Project" keymap="NumberString">04-02-0018</PastClaims>
    </Detail>
    <Detail key="CLAM_AUTO">
        <InsuredState>true</InsuredState>
        <VIN>326513256214586</VIN>
        <LossLocation>The incident occurred on Broadway, where the insured resides.</LossLocation>
    </Detail>
    <Assignee>
        <User>jessica</User>
        <Type>PLCY_SUPR</Type>
        <IsActive>1</IsActive>
        <AssignedOn>2005-11-20</AssignedOn>
    </Assignee>
    <Assignee>
        <User>jake</User>
        <Type>PLCY_SUPR</Type>
        <IsActive>1</IsActive>
        <AssignedOn>2005-11-22</AssignedOn>
    </Assignee>
    <Assignee>
        <User>jane</User>
        <Type>PLCY_SUPR</Type>
        <IsActive>1</IsActive>
        <AssignedOn>2005-11-20</AssignedOn>
    </Assignee>
    <Assignee>
        <User>charlotte</User>
        <Type>PLCY_SUPR</Type>
        <IsActive>0</IsActive>
        <AssignedOn>2005-11-20</AssignedOn>
        <UnassignedOn>2005-12-31</UnassignedOn>
    </Assignee>
    <MainAssigneeUser>jane</MainAssigneeUser>
    <Relation>
        <Project keymap="NumberString">05-02-0045</Project>
        <Type>PRJR_RELA</Type>
        <LeftRightIID>Left</LeftRightIID>
    </Relation>
</Project>
</TeamConnectRequest>

Updating Projects

Here is an example XML request to update a Project in TeamConnect via XML worksheet:

<TeamConnectRequest>
<Authentication>
    <Username>george</Username>
    <Password>password</Password>
</Authentication>
<Project op="update" NumberString="05-02-0051">
    <Detail key="CLAM_AUTO" op="delete" />
    <Assignee op="insert">
        <User>charlotte</User>
        <Type>CLAM_ADST</Type>
        <IsActive>1</IsActive>
        <AssignedOn>2005-05-29</AssignedOn>
    </Assignee>
    <MainAssigneeUser>charlotte</MainAssigneeUser>
    <History op="insert">
        <ArchivedOn>2005-05-17</ArchivedOn>
        <ShortDescription>Called claimant body shop</ShortDescription>
        <DefaultCategory>HIST_CALL</DefaultCategory>
        <EnteredBy>jake</EnteredBy>
        <Text>Discussed necessary repairs with body shop. The total will be about $3000. They will send me an invoice and 
        as soon as they do I will close the claim.</Text>
    </History>
</Project>
</TeamConnectRequest>

Deleting Projects

Here is an example XML request to delete a Project in TeamConnect via XML worksheet:

<TeamConnectRequest>
<Authentication>
    <Username>george</Username>
    <Password>password</Password>
</Authentication>
<Project op="delete" NumberString="03-15-2005" />
<Project op="delete" NumberString="05-05-0049" />
</TeamConnectRequest>

Changing Project Phases

The following examples demonstrate the two different methods of changing phases. The example you should reference depends on whether you are:

Performing a database conversion.
Integrating with a third-party product

Changing Phases with a Tag - Data Conversion Example

<TeamConnectRequest>
<Authentication>
    <Username>george</Username>
    <Password>password</Password>
</Authentication>
<Project op="update" PrimaryKey="109">
    <Application>PLCY</Application>
    <ChangePhase>
        <Type>OPEN</Type>
        <TransitionedBy>charlotte</TransitionedBy>
        <TransitionedOn>2005-11-18T06:30</TransitionedOn>
    </ChangePhase>
    <ChangePhase>
        <Type>CLOS</Type>
        <TransitionedBy>jane</TransitionedBy>
        <TransitionedOn>2006-02-05T11:20</TransitionedOn>
    </ChangePhase>
    <ChangePhase>
        <Type>OPEN</Type>
        <TransitionedBy>jessica</TransitionedBy>
        <TransitionedOn>2006-02-15T16:12</TransitionedOn>
    </ChangePhase>
</Project>
</TeamConnectRequest>

Changing Phases with a Tag - Data Conversion Example

<TeamConnectRequest>
<Authentication>
    <Username>george</Username>
    <Password>password</Password>
</Authentication>
<Project op="update" NumberString="05-02-0051" action="changePhase:8" />
</TeamConnectRequest>

Modifying Project's user rights

Here is an example XML request to modify a project’s user rights using XML worksheet:

<TeamConnectRequest>
<Authentication>
    <Username>george</Username>
    <Password>password</Password>
</Authentication>
<Project op="update" Application="TRAN"  NumberString="TRAN-000001" action="addUserAccess:tylerc:d:YES:NO:NO:NO"/>
<Project op="update" Application="TRAN"  NumberString="TRAN-000001" action="addUserAccess:jessica:a:YES:NO:YES:NO"/>
</TeamConnectRequest>

Parameters added in the action are

addUserAccess: Predefined code for adding user access
User ID: In this example, user id's used are tylerc and jessica
Rights: "d" is to deny the rights & "a" is to add the rights.
Permissions: For example, the yes:no:no:no section gives the permissions to read, update, delete and change respectively

Adding groups to a matter

Here is an example XML request to add groups to a matter via XML worksheet:

<TeamConnectRequest>
<Authentication>
    <Username>george</Username>
    <Password>password</Password>
</Authentication>
<Project op="update" Application="ADCO" PrimaryKey="7018" action="addGroupAccess:206:a:YES:YES:YES:YES"/>
</TeamConnectRequest>

Parameters added in the action are

addGroupAccess: Predefined code for adding group access
Primary key of the group: In this example, primary key of the group is '206'
Rights: "d" is to deny the rights & "a" is to add the rights.
Permissions: For example, the yes:no:no:no section gives the permissions to read, update, delete and change respectively