FRAMES NO FRAMES |
com.ibm.rpm.framework.RPMObjectcom.ibm.rpm.resource.containers.Resource
Related scope: com.ibm.rpm.resource.scope.ResourceScope
A Resource can include as little or as much information as required to identify a resource and assign them to projects. However, the minimum information required to allow a resource to logon to IBM Rational Portfolio Manager, and to assign resources to projects are Username, Password, Resource Calendar, and Effective Start Date.
Supported API Calls:Related code samples :
Java
C#
Field Summary | |
xsd:boolean
|
active
This field is true if the resource is active, and is false if the resource is not. For the resource to be allowed to log on to IBM Rational Portfolio Manager, this value must be set to true. |
xsd:string
|
address1
The first address line of the resource. |
xsd:string
|
address2
The second address line of the resource. |
AdministrativeTaskAssignment[]
|
administrativeTaskAssignments
The administrative task assignments associated with the resource. |
xsd:string
|
alternativePhone
The alternative phone number of the resource |
AssignedScorecard
|
assignedScorecard
A reference to the scorecard assigned to this asset. To set this value, API users must use the assignScorecard method and specify a valid asset and a valid asset scorecard. |
RPMCalendar
|
calendar
The calendar of the resource. For the resource to be allowed to logon to IBM Rational Portfolio Manager, this value must be specified. |
xsd:string
|
companyCode
The company code of the resource. |
ResourceAttributeAssignment[]
|
competencyAttributeAssignments
Each instance of ResourceAttributeAssignment keeps a pointer to an assigned AttributeAssignment for competency. |
ContactGroupAssignment[]
|
contactGroupAssignments
Each instance of ContactGroupAssignment keeps a pointer to an associated ContactGroup. |
xsd:string
|
countryCode
The country code of the resource. |
Currency
|
currency
The currency in which the resource's rates are entered. |
xsd:string
|
custom1
An employee information field. The field name is configured through the Application Administration |
xsd:string
|
custom2
This field is an employee information field. The field name is configured through the Application Administration |
xsd:string
|
custom3
This field is an employee information field. The field name is configured through the Application Administration |
xsd:string
|
custom4
This field is an employee information field. The field name is configured through the Application Administration |
xsd:string
|
custom5
This field is an employee information field. The field name is configured through the Application Administration |
CustomFieldAssignment[]
|
customFieldAssignments
The list of custom fields assigned to this resource. If a particular custom field isn't assigned, it contains the default value. |
xsd:string
|
dashboard
The dashboard for the resource. |
xsd:string
|
departmentCode
The department code of the resource. |
xsd:dateTime
|
discontinueDate
The discontinued employment date of a resource. |
xsd:string
|
divisionCode
The division code of the resource. |
DocumentFolder
|
documentFolder
The documents that belong to the resource. |
Education[]
|
educations
The resource's education. |
xsd:dateTime
|
effectiveStartDate
The effective start date of the resource. In order for the resource to be allowed to logon to IBM Rational Portfolio Manager. |
xsd:string
|
emailAddress
The e-mail address of the resource. |
xsd:string
|
employeeCode
The employee code of the resource. |
EmployeeStatus
|
employeeStatus
The status of the employee. |
EmploymentHistory[]
|
employmentHistories
The employment history of a resource. |
AttributeAssignment[]
|
executiveAttributeClassifications
Each instance of AttributeClassificationAssignment keeps a pointer to the assigned AttributeClassification for executive attribute classification. |
AttributeAssignment[]
|
executiveAttributes
Each instance of AttributeAssignment keeps a pointer to the assigned Attribute. |
ProjectSecurityRole
|
executiveSecurityRole
The executive security role of a resource on every project. |
Experience
|
experience
The experience level of a resource. |
xsd:string
|
externalID
The external identifier of a resource. |
xsd:string
|
familyName
The family name of the resource. |
xsd:string
|
fax
The fax number of the resource. |
xsd:string
|
fullName
The full name of the resource. |
GeographicalAssignment
|
geographicalAssignment
The resource's assignment to a geographical position. |
xsd:string
|
givenName
The resource's given name. |
xsd:string
|
homePhone
The home phone number of the resource. |
IndustryExperience[]
|
industryExperiences
The industry experience of the resource. |
xsd:string
|
interviewExperience
The resource's experience as described during an interview. |
LanguageProficiency[]
|
languageProficiencies
The known languages and proficiency levels of the resource. |
LocationPreferences
|
locationPreferences
The location preferences of the resource. |
xsd:string
|
logonReminder
The resource's logon reminder. |
xsd:string
|
middleName
The middle name of the resource. |
xsd:string
|
mobile
The mobile number of the resource. |
xsd:string
|
myAchievements
The resource's achievements as described during an interview. |
xsd:string
|
myPersonalPassions
The resource's personal passions as described during an interview. |
xsd:string
|
myPortalURL1
The first URL displayed to the resource when in IBM Rational Portfolio Manager's My Portal window. |
xsd:string
|
myPortalURL2
The second URL displayed to the resource when in IBM Rational Portfolio Manager's My Portal window. |
xsd:string
|
myPortalURL3
The third URL displayed to the resource when in IBM Rational Portfolio Manager's My Portal window. |
xsd:string
|
myPortalURL4
The fourth URL displayed to the resource when in IBM Rational Portfolio Manager's My Portal window. |
xsd:string
|
myPortalURL5
The fifth URL displayed to the resource when in IBM Rational Portfolio Manager's My Portal window. |
xsd:string
|
mySummaryOfSkills
The skills of a resource as described during an interview. |
xsd:string
|
myWebsite
The web site of the resource. |
xsd:string
|
nickName
The nick name of the resource. |
OrganizationalAssignment
|
organizationalAssignment
The resource's assignment to an organizational. |
xsd:boolean
|
overrideOriginalDocumentOnCheckout
This field is true if the system should override the original document of a resource on a checkout, and is false if otherwise. |
xsd:string
|
pager
The pager number of the resource. |
Passport
|
passport
The passport and visa information of the resource. |
xsd:string
|
password
The password of the resource. This value is never sent back through the API. During a resource update, if the field is null, the password won't be changed. Otherwise the new password will be applied to resource. |
PersonalProject
|
personalProject
The personal project of the resource. |
PersonalTaskAssignment[]
|
personalTaskAssignments
The personal task assignments of the resource. |
ProjectHistory[]
|
projectHistories
The project history of the resource. |
ResourceRates
|
rates
The rates of the resource. |
ResourceCostCenterAssignment[]
|
resourceCostCenterAssignments
Each instance of ClientCostCenterAssignment keeps a pointer to the assigned ResourceCostCenter. |
ResourceSecurityRights
|
resourceSecurityRights
The security rights of the resource. |
Resource
|
reVerifiedBy
A reference to the resource who reverified this resource. |
SecurityGroup
|
securityGroup
The security group of the resource. |
ResourceAttributeAssignment[]
|
skillAttributeAssignments
Each instance of ResourceAttributeAssignment keeps a pointer to an assigned AttributeAssignment for skills. |
xsd:string
|
title
The title of the resource. |
xsd:string
|
userName
The user name of the resource. In order for the resource to have permission to logon to IBM Rational Portfolio Manager, this value must be specified. |
Resource
|
verifiedBy
The Resource Manager or Project Manager that has verified the resource's personal information. |
xsd:int
|
weeklyMaxHours
The maximum amount of hours that can be billed by the resource. |
xsd:int
|
weeklyMinHours
The minimum amount of hours that can be billed by the resource. |
xsd:string
|
whatIDoReallyWell
The resource's superior abilities, as described during an interview. |
WorkingStatus
|
workingStatus
The working status of the resource. |
WorkLocation
|
workLocation
The work location of the resource. |
xsd:string
|
workPhone
The work phone number of the resource. |
xsd:string
|
zipPostalCode
The zip or postal code of the resource. |
Inherited Field Summary | |
xsd:string
|
contextName
The context name identifies which section of the Web Services API the object belongs to. This value of this field is generated automatically when creating the RPMObject. |
xsd:boolean
|
deleted
If the value of this field is set to true, then the RPMObject will be deleted when performing a save. |
xsd:string
|
ID
The unique ID of the RPMObject. If the value of this field is set to null, the save operation will generate the ID automatically when creating the RPMObject. If an ID is specified, then the save operation will attempt to update an existing RPMObject. |
RPMObject
|
parent
The parent of the RPMObject. |
Field Detail |
Default value: This default value is true.
Maximum: The maximum length for this field is 50 characters.
Maximum: The maximum length for this field is 50 characters.
Scoping: This field will be used by the API if the scope field administrativeTaskAssignments is enabled.
Read-only behavior: The value of this field is read only.
Relationship: This field is a reference relationship.
Maximum: The maximum length for this field is 50 characters.
Validation: The field must contain a valid telephone number.
Scoping: This field will be used by the API if the scope field assignedScorecard is enabled.
Relationship: This field is a composite relationship. Deleting the current object will delete the object stored in this field.
Scoping: This field will be used by the API if the scope field calendar is enabled.
Relationship: This field is a reference relationship.
Validation: The year, month and day values will be used by this field.
Maximum: The maximum length for this field is 10 characters.
Scoping: This field will be used by the API if the scope field competencyAttributeAssignments is enabled.
Relationship: This field is a composite relationship. Deleting the current object will delete the object stored in this field.
Scoping: This field will be used by the API if the scope field contactGroupAssignments is enabled.
Relationship: This field is a composite relationship. Deleting the current object will delete the object stored in this field.
Maximum: The maximum length for this field is 10 characters.
Null value: This field may never be null during updates.
Scoping: This field will be used by the API if the scope field currency is enabled.
Relationship: This field is a reference relationship.
Default value: The default currency selected when the IBM Rational Portfolio Manager client is first configured by the administrator.
Maximum: The maximum length for this field is 50 characters.
Maximum: The maximum length for this field is 50 characters.
Maximum: The maximum length for this field is 50 characters.
Maximum: The maximum length for this field is 50 characters.
Maximum: The maximum length for this field is 50 characters.
Scoping: This field will be used by the API if the scope field customFieldAssignments is enabled.
Relationship: This field is a composite relationship. Deleting the current object will delete the object stored in this field.
Maximum: The maximum length for this field is 2048 characters.
Maximum: The maximum length for this field is 10 characters.
Validation: The year, month and day values will be used by this field.
Initialization: The field effectiveStartDate must be less than or equal to the field discontinueDate.
Maximum: The maximum length for this field is 10 characters.
Scoping: This field will be used by the API if the scope field documentFolder is enabled.
Relationship: This field is a composite relationship. Deleting the current object will delete the object stored in this field.
Scoping: This field will be used by the API if the scope field educations is enabled.
Relationship: This field is a composite relationship. Deleting the current object will delete the object stored in this field.
Validation: The year, month and day values will be used by this field.
Initialization: The field effectiveStartDate must be less than or equal to the field discontinueDate.
Maximum: The maximum length for this field is 100 characters.
Validation: The field must contain a valid e-mail address.
Maximum: The maximum length for this field is 10 characters.
Scoping: This field will be used by the API if the scope field employeeStatus is enabled.
Relationship: This field is a reference relationship.
Scoping: This field will be used by the API if the scope field employmentHistories is enabled.
Relationship: This field is a composite relationship. Deleting the current object will delete the object stored in this field.
Scoping: This field will be used by the API if the scope field executiveAttributeClassifications is enabled.
Relationship: This field is a composite relationship. Deleting the current object will delete the object stored in this field.
Scoping: This field will be used by the API if the scope field executiveAttributes is enabled.
Relationship: This field is a composite relationship. Deleting the current object will delete the object stored in this field.
Scoping: This field will be used by the API if the scope field executiveSecurityRole is enabled.
Relationship: This field is a reference relationship.
Scoping: This field will be used by the API if the scope field experience is enabled.
Relationship: This field is a reference relationship.
Default value:
The
member value of the Application Administration
Maximum: The maximum length for this field is 50 characters.
Maximum: The maximum length for this field is 35 characters.
Maximum: The maximum length for this field is 17 characters.
Validation: The field must contain a valid telephone number.
Maximum: The maximum length for this field is 35 characters.
Null value: This field may never be null.
Validation: The following special characters are not to be included in the value of this field: ", %, (, ), *, /, :, <, >, ?, \, |, €.
Scoping: This field will be used by the API if the scope field geographicalAssignment is enabled.
Relationship: This field is a composite relationship. Deleting the current object will delete the object stored in this field.
Maximum: The maximum length for this field is 35 characters.
Maximum: The maximum length for this field is 50 characters.
Validation: The field must contain a valid telephone number.
Scoping: This field will be used by the API if the scope field industryExperiences is enabled.
Relationship: This field is a composite relationship. Deleting the current object will delete the object stored in this field.
Maximum: The maximum length for this field is 512 characters.
Scoping: This field will be used by the API if the scope field languageProficiencies is enabled.
Relationship: This field is a composite relationship. Deleting the current object will delete the object stored in this field.
Scoping: This field will be used by the API if the scope field locationPreferences is enabled.
Relationship: This field is a reference relationship.
Maximum: The maximum length for this field is 64 characters.
Maximum: The maximum length for this field is 35 characters.
Maximum: The maximum length for this field is 17 characters.
Validation: The field must contain a valid telephone number.
Maximum: The maximum length for this field is 512 characters.
Maximum: The maximum length for this field is 512 characters.
Maximum: The maximum length for this field is 255 characters.
Validation: The field must contain a valid URL.
Maximum: The maximum length for this field is 255 characters.
Validation: The field must contain a valid URL.
Maximum: The maximum length for this field is 255 characters.
Validation: The field must contain a valid URL.
Maximum: The maximum length for this field is 255 characters.
Validation: The field must contain a valid URL.
Maximum: The maximum length for this field is 255 characters.
Validation: The field must contain a valid URL.
Maximum: The maximum length for this field is 512 characters.
Maximum: The maximum length for this field is 100 characters.
Validation: The field must contain a valid URL.
Maximum: The maximum length for this field is 35 characters.
Validation: The following special characters are not to be included in the value of this field: ", %, (, ), *, /, :, <, >, ?, \, |, €.
Scoping: This field will be used by the API if the scope field organizationalAssignment is enabled.
Relationship: This field is a composite relationship. Deleting the current object will delete the object stored in this field.
Default value: This default value is true.
Maximum: The maximum length for this field is 17 characters.
Validation: The field must contain a valid telephone number.
Scoping: This field will be used by the API if the scope field passport is enabled.
Relationship: This field is a reference relationship.
Maximum: The maximum length for this field is 16 characters.
Validation: The field must contain a valid password according to the application configuration.
Scoping: This field will be used by the API if the scope field personalProject is enabled.
Relationship: This field is a composite relationship. Deleting the current object will delete the object stored in this field.
Scoping: This field will be used by the API if the scope field personalTaskAssignments is enabled.
Read-only behavior: The value of this field is read only.
Relationship: This field is a reference relationship.
Scoping: This field will be used by the API if the scope field projectHistories is enabled.
Relationship: This field is a composite relationship. Deleting the current object will delete the object stored in this field.
Scoping: This field will be used by the API if the scope field rates is enabled.
Relationship: This field is a composite relationship. Deleting the current object will delete the object stored in this field.
Scoping: This field will be used by the API if the scope field resourceCostCenterAssignments is enabled.
Relationship: This field is a composite relationship. Deleting the current object will delete the object stored in this field.
Relationship: This field is a composite relationship. Deleting the current object will delete the object stored in this field.
Scoping: This field will be used by the API if the scope field reVerifiedBy is enabled.
Relationship: This field is a reference relationship.
Scoping: This field will be used by the API if the scope field securityGroup is enabled.
Relationship: This field is a reference relationship.
Scoping: This field will be used by the API if the scope field skillAttributeAssignments is enabled.
Relationship: This field is a composite relationship. Deleting the current object will delete the object stored in this field.
Maximum: The maximum length for this field is 50 characters.
Minimum: The minimum length for this field is 1 characters.
Maximum: The maximum length for this field is 50 characters.
Null value: This field may never be null.
Validation:
The following special characters
are not to be included in the value of
Scoping: This field will be used by the API if the scope field verifiedBy is enabled.
Relationship: This field is a reference relationship.
Minimum: The minimum value for this field is 0.
Maximum: The maximum value for this field is 9999.
Default value: This default value is 40.
Minimum: The minimum value for this field is 0.
Maximum: The maximum value for this field is 9999.
Maximum: The maximum length for this field is 512 characters.
Scoping: This field will be used by the API if the scope field workingStatus is enabled.
Relationship: This field is a reference relationship.
Scoping: This field will be used by the API if the scope field workLocation is enabled.
Relationship: This field is a reference relationship.
Default value:
The
member value of the Application Administration
Maximum: The maximum length for this field is 50 characters.
Validation: The field must contain a valid telephone number.
Maximum: The maximum length for this field is 16 characters.
Validation: The field must contain a valid zip code.
Inherited Field Detail |
Read-only behavior: The value of this field is read only.
X-Path availability: This field doesn't support X-Path queries.
Read-only behavior: The value of this field is read only.
X-Path availability: This field doesn't support X-Path queries.
Read-only behavior: The value of this field is read only.
Null value: This field must have a value at creation time.
Scoping: This field will be used by the API if the scope field parent is enabled.
Read-only behavior: The value of this field is read only after the object was created.
Relationship: This field is a reference relationship.
X-Path availability: This field doesn't support X-Path queries.