Overview
This web service allows a caller to initiate an import from a Salesforce-like environment. In the standard Projector-Salesforce integration, Projector pulls data from Salesforce. In a web-services based import, this service provides a means to push data into Projector. This service allows one to send XML data to Projector, which Projector then processes by transforming via a pre-configured mapping template. The transformed result is then stored in a staging table which functions like a queue. Later, Projector can read from this queue to create the actual, desired Projector entities.
Request Format
- PwsInitiateSfaImport
- serviceRequest: PwsInitiateSfaImportRq
- RequestId: Int32
- SessionTicket: String
- SourceEntityData: String
- SourceEntityDescription: String
- SourceEntityIdentifier: String
- SourceEntityName: String
- TestFlag: Boolean
- serviceRequest: PwsInitiateSfaImportRq
Request Elements
Element | Data Type | Required? | Default | Description | Sample Data |
|---|---|---|---|---|---|
Int32 | No |
| Click here for more information | ||
String | Yes |
| Click here for more information | ||
SourceEntityData | String | Yes |
| A block of XML that represents that data being sent to Projector. It should contain elements that the mapping template expects. | <MyOpportunity><Id>12345</Id><OpportunityName>Big Sale</OpportunityName><StartDate>6/15/2020</StartDate><EndDate>6/18/2021</EndDate></MyOpportunity> |
SourceEntityDescription | String | No |
| Description of the source entity. It should be meaningful to users but does not play a role in the import process. | [MyAccountName].[MyOpportunityName] |
SourceEntityIdentifier | String | Yes |
| Uniquely identifies the source entity | 1342839000011290083 |
SourceEntityName | String | Yes |
| Type of entity that is being imported from the outside system | Opportunity |
TestFlag | Boolean | No | False | If true, runs the service in test mode. In test mode, the pre-configured mapping template is applied to the SourceEntityData but the result is not saved (i.e. nothing is pushed to the staging table). Use this option to validate the pre-configured mapping template works as expected. | False |
Request Usage Example(s)
Response Format
- PwsInitiateSfaImportResponse
- PwsInitiateSfaImportResult: PwsInitiateSfaImportRs
- Messages: PwsMessage[]
- ResponseId: Int32
- Status: RequestStatus
- ServerTimestampUtc: DateTime
- ProjectorEntityData: String
- SfaStatus: String
- SfaStatusMessage: String
- PwsInitiateSfaImportResult: PwsInitiateSfaImportRs
Response Elements
Element | Data Type | Description | Sample Data |
|---|---|---|---|
Messages | The web service response status and message. Click here for more information. | ||
Int32 | Click here for more information | ||
Status | Click here for more information | ||
DateTime | Click here for more information | ||
ProjectorEntityData | String | A block of XML that represents the Projector entities that will be eventually created in Projector. | <ops:Engagement action="delete" closeIfInUse="true" closedEngagementStageName="Closed Lost" xmlns:ops="ops.projectorpsa.com" /> |
SfaStatus | String | The status of the SFA integration. R - Running P - Pending I - Idle D - Disabled T - Pending Test | R |
SfaStatusMessage | String | The error, if there was one, that occurred while applying the pre-configured mapping template to the input data. |
PwsInitiateSfaImport - Common Errors and Warnings
- For all errors and warnings please refer to the Complete List of Errors and Warnings
ErrorNumber | ErrorCode | ErrorText |
|---|---|---|
| 35001 | SfaIntegrationIsDisabled | SFA integration is currently disabled due to a prior failure. It must be manually re-enabled prior to further integrations. |
| 35002 | SfaIntegrationIsInactive | SFA integration is currently not enabled for this account. It must be enabled before any integrations can be performed. |
| 35003 | SfaProjectorXmlInvalid | SFA integration produced invalid results. |