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 the Engagement number. |
EngagementName (*) | Enter the name of the Engagement. |
Description | Enter a brief description of the Engagement. |
EngagementMgrEngagementname (*) | Enter the Engagementname of the internal Client manager. Must match an existing Engagementname. |
SupplierName (*) | Enter the name of the supplier associated to the Engagement. Must match an existing supplier name. |
AccountMgrEngagementname (*) | Enter the name of external (supplier) account manager associated to the Engagement. Must match an existing supplier employee name. |
Organizations (*) | Enter the name of organizations associated to the 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 activate the Engagement. |
ContractNumber | Enter the contract number of the Engagement. |
ContractAmount | Enter the contract amount of the Engagement. |
CurrencyCode |
Enter the currency code.
|
StartDate (*) | Enter the start effective date of the Engagement. |
ExpirationDate | Enter the end date of the Engagement. |
ContractDocumentFileName | Enter the document filename to attach as the contract. Must send actual file to Hiperos Support to be loaded on the server and linked to the Engagement. |
RiskRating | Enter the risk rating of the Engagement. Must match an existing risk rating defined under Setup Data Management. |
Geography | Enter the name of the country. Must match an existing geography defined under Setup Data Management. Multiple values must be separated with the @ symbol. |
Classification (*) | Enter the name of the classification. Must match an existing classification defined under Setup Data Management. |
Category (*) | Enter the name of the category. Must match an existing category defined under Setup Data Management. |
SubCategory | Enter the subcategory of the Engagement. |
HiperosFamily | Enter the name of the Hiperos category family. Must match an existing Hiperos category family type. Contact Hiperos 3PM Support (support@hiperos.com |
HiperosCategory | Enter the name of the Hiperos category. Must match an existing Hiperos category type. Contact Hiperos 3PM Support (support@hiperos.com ) or the assigned Client Services representative for a complete list. |
HiperosSubCategory | Enter the name of the Hiperos subcategory. Must match an existing Hiperos subcategory type. Contact Hiperos 3PM Support (support@hiperos.com |
ClientAccess |
Enter the access of the internal Engagement. Multiple values must be separated with the pipe character (|).
|
SupplierAccess |
Enter the access of the external Engagement. Multiple values must be separated with the pipe character (|).
|
EngagementGroupAccess | Enter the name of the group that has access to the Engagement. Must match an existing group name defined under Group Management. Multiple values must be separated with the pipe character (|). |
AtRiskFee | Enter the at risk fee of the Engagement. |
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-SupplierIdentifiers' group. The QuickIntegration group allows an account to access all Quick Integration resources. The QuickIntegration-SupplierIdentifiers group limits access to only the Quick Integration SupplierIdentifiers 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. |