UserSolutionData

Description

The UserSolutionData type holds identification information and user settings for a solution (also known as an application) in SBM. The UserSolutionData type parameters are listed below.

Parameters

Name	Type	Description
solution	SolutionIdentifier	Holds the identification information for a solution.
homeReport	ReportIdentifier	Holds the identification information for a report. The report that is returned indicates the user's home page report.
preferredProject	ProjectIdentifier	Holds the identification for a project. One or more projects are returned. The list of projects indicates the user's preferred projects.

Usage

The UserSolutionData type holds the SolutionIdentifier and additional information used to describe the settings for an application that a user has access to. You can use GetUsers to retrieve the user solution data shown here. The GetUsers response contains one or more UserSolutionData elements that comprise an ordered-list of the application tabs that are available to the user in the SBM User Workspace. You can use UpdateUsers to re-establish this order, update the home page report, and designate the user's preferred projects.

XML

The following XML snippet shows UserSolutionData in the <urn:solutionData> element of the UpdateUsers call.

<urn:solutionData>
    <urn:solution>
        <urn:displayName></urn:displayName>
        <urn:id></urn:id>
        <urn:uuid></urn:uuid>
        <urn:uniqueName>ISSUE_DEFECT_MANAGEMENT</urn:uniqueName>
        <urn:tabName>IDM</urn:tabName>
    </urn:solution>
    <urn:homeReport>
        <urn:displayName>Built-In: All Active Items I Own</urn:displayName>
        <urn:id></urn:id>
        <urn:uuid></urn:uuid>
    </urn:homeReport>
    <urn:preferredProject>
        <urn:displayName>Animation Pro</urn:displayName>
        <urn:id>6</urn:id>
        <urn:uuid></urn:uuid>
        <urn:fullyQualifiedName></urn:fullyQualifiedName>
    </urn:preferredProject>
</urn:solutionData>
<urn:solutionData>
    <urn:solution>
        <urn:displayName></urn:displayName>
        <urn:id></urn:id>
        <urn:uuid></urn:uuid>
        <urn:uniqueName>INCIDENT_MANAGEMENT</urn:uniqueName>
        <urn:tabName>Incident Mgmt</urn:tabName>
    </urn:solution>
    <urn:homeReport>
        <urn:displayName>Built-In: All Active Items I Own</urn:displayName>
        <urn:id></urn:id>
        <urn:uuid></urn:uuid>
    </urn:homeReport>
    <urn:preferredProject>
        <urn:displayName>IM Project</urn:displayName>
        <urn:id>3</urn:id>
        <urn:uuid></urn:uuid>
        <urn:fullyQualifiedName></urn:fullyQualifiedName>
    </urn:preferredProject>
</urn:solutionData>

The following XML snippet shows the UserSolutionData type in the return element of the UpdateUsers response.

<ae:solutionData>
  <ae:solution xsi:type="ae:SolutionIdentifier">
     <ae:displayName>Incident Management</ae:displayName>
     <ae:id>2</ae:id>
     <ae:uuid>c6f06a70-4d06-42a4-a3a9-50b2120dca41</ae:uuid>
     <ae:uniqueName>INCIDENT_MANAGEMENT</ae:uniqueName>
     <ae:tabName>Incident Mgmt</ae:tabName>
  </ae:solution>
  <ae:homeReport xsi:type="ae:ReportIdentifier">
     <ae:displayName>Built-In: All Items I Submitted</ae:displayName>
     <ae:id>-11</ae:id>
     <ae:uuid>-11</ae:uuid>
  </ae:homeReport>
</ae:solutionData>
<ae:solutionData>
  <ae:solution xsi:type="ae:SolutionIdentifier">
     <ae:displayName>Change Request Management</ae:displayName>
     <ae:id>3</ae:id>
     <ae:uuid>0ea28a74-6dde-406f-b19a-4c45aec40294</ae:uuid>
     <ae:uniqueName>CHANGE_REQUEST_MANAGEMENT</ae:uniqueName>
     <ae:tabName>Change Requests</ae:tabName>
  </ae:solution>
  <ae:homeReport xsi:type="ae:ReportIdentifier">
     <ae:displayName>Built-In: All Items I Submitted</ae:displayName>
     <ae:id>-11</ae:id>
     <ae:uuid>-11</ae:uuid>
  </ae:homeReport>
</ae:solutionData>