The first row of the worksheet must include the field names as the column headers. Hiperos 3PM Quick Integration reads this text to import the data to the appropriate fields. NOTE: When importing setup data values, the setup code must be used rather than the display name.
Note: Required fields are marked with an asterisk (*).
Field | Description |
---|---|
EngagementNumber | Enter a reference key that uniquely identifies the engagement record in Hiperos 3PM. |
EngagementName (*) | Enter the name of the engagement. |
Description | Enter a short description of the engagement. |
EngagementMgrUsername (*) | Enter the username of the internal Client manager. Must match an existing username. |
Organizations (*) | Enter the names of the organizations participating in this engagement. Must match an existing organization defined under Organization Unit Management. Multiple values must be separated with the pipe character (|). |
Activated | [Yes or No] Enter Yes to mark the engagement as active. |
ContractNumber | Enter the contract reference number assigned to the contract upon creation. |
ContractAmount | Enter the total (or annual) dollar value assigned to the contract. |
CurrencyCode | Enter the currency code.
|
StartDate (*) | Enter the start date of contract period of performance. |
ExpirationDate | Enter the end date of contract period of performance. |
ContractDocumentFileName | Enter the name of the engagement contract. |
AtRiskFee | Enter the dollar amount that will be used to calculate performance-based compensation for a supplier or relationship based on the final score of an assessment from a performance program. |
RiskRating | Enter the appropriate assessment of overall risk assigned to the engagement. See Setup Data Management on how to create and maintain these values. |
Geography | Enter the location where the contract will be utilized. Must match an existing geography defined under Setup Data Management. |
Classification | Enter the engagement segmentation classification. Classification indicates the type of business relationship the client has with the engagement (e.g., commodity, strategic) and can be populated with any labels the client organization uses to classify suppliers. Must match an existing classification defined under Setup Data Management. |
Category | Enter the services classification for the engagement. Must match an existing category defined under Setup Data Management. |
SubCategory | Enter the services subclassification for the engagement. See Setup Data Management. |
HiperosFamily | Enter the category. Must match an existing Hiperos Category Family type. Refer to Setup Data Management. |
HiperosCategory | Enter the Hiperos category. Must match an existing Hiperos Category type. Refer to Setup Data Management. |
HiperosSubCategory | Enter the Hiperos subcategory for the engagement. |
ClientAccess | Enter the client access to allow viewing and editing of the engagement record.
|
Valid credentials must be supplied for each Hiperos 3PM Quick Integration request issued in order to succeed.
The 3PM user supplied must be a member of either the 'QuickIntegration' group or the 'QuickIntegration-Engagements' group. The QuickIntegration group allows an account to access all Quick Integration resources. The QuickIntegration-Engagements group limits access to only the Quick Integration Engagements resource. If these groups currently do not exist in your Hiperos 3PM instance, please contact your local 3PM administrator or your Hiperos Customer Services representative to have them created.
HTTP Header | Description |
---|---|
username | Valid Hiperos 3PM Username |
password | Valid Hiperos 3PM Password |
The content type header must contain one of the following types listed below. This is used to identify the file format that is being uploaded. Note: If sending data as an octet-stream, filename is required in the Content-Disposition header.
Content Type Header | File Type |
---|---|
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet | Excel 2007 or later versions (xlsx) |
application/vnd.ms-excel | Excel 2003 or earlier versions (xls) |
text/csv | Comma separated values (csv) |
application/octet-stream |
File format determined by filename value in Content-Disposition e.g. Content-Disposition: form-data; name="file"; filename="user_import.xlsx" |
Status Code | Result | Description |
---|---|---|
201 | Created | New objects succesfully created. |
202 | Accepted | Data has been queued for import (system-generated e-mail confirmation to follow). |
204 | No Content | No new or updated data to import was found or the file was not in the correct format. |
400 | Bad Request | Problem rows and/or columns were found. Review returned validation message in response. |
401 | Unauthorized | Username & password http headers were not found in the request. |
403 | Forbidden | Login failed, was not found or not authorized. |
500 | Server Error | Failed to save import data to database. |