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.

Rate Limiting

In order to protect our servers from inadvertent service overuse or intentional attack, and to fairly distribute services to all our customers, we have implemented a rate limiting algorithm. When fully deployed, this new algorithm will cause services to either succeed with new warnings or fail with new errors when services are consumed at too high a rate. Programs that consume Projector services should be enhanced to handle rate limiting errors so that they can continue functioning properly. For more information please visit: Projector Rate Limiting Behavior.

Request Format

PwsInitiateSfaImport Request

PwsInitiateSfaImport
- serviceRequest: PwsInitiateSfaImportRq
  - RequestId: Int32
  - SessionTicket: String
  - SourceEntityData: String
  - SourceEntityDescription: String
  - SourceEntityIdentifier: String
  - SourceEntityName: String
  - TestFlag: Boolean

Request Elements

Element	Data Type	Required?	Default	Description	Sample Data
RequestId	Int32	No		Click here for more information
SessionTicket	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)

Example 01 - Pushing entity data

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pws="http://projectorpsa.com/PwsProjectorServices/" xmlns:req="http://projectorpsa.com/DataContracts/Requests/">
   <soapenv:Header/>
   <soapenv:Body>
      <pws:PwsInitiateSfaImport>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AQcmVO3fPeBJOx7QmLRCeA==</req:SessionTicket>
            <req:SourceEntityData>&lt;MyOpportunity&gt;&lt;Id&gt;12345&lt;/Id&gt;&lt;OpportunityName&gt;Big Sale&lt;/OpportunityName&gt;&lt;StartDate&gt;6/15/2020&lt;/StartDate&gt;&lt;EndDate&gt;6/18/2021&lt;/EndDate&gt;&lt;/MyOpportunity&gt;</req:SourceEntityData>
            <req:SourceEntityDescription>MyAccount.MyOpportunity</req:SourceEntityDescription>
            <req:SourceEntityIdentifier>12345</req:SourceEntityIdentifier>
            <req:SourceEntityName>Opportunity</req:SourceEntityName>
            <req:TestFlag>0</req:TestFlag>
         </pws:serviceRequest>
      </pws:PwsInitiateSfaImport>
   </soapenv:Body>
</soapenv:Envelope>

Response Format

PwsInitiateSfaImport Response

PwsInitiateSfaImportResponse
- PwsInitiateSfaImportResult: PwsInitiateSfaImportRs
  - Messages: PwsMessage[]
  - ResponseId: Int32
  - Status: RequestStatus
  - ServerTimestampUtc: DateTime
  - ProjectorEntityData: String
  - SfaStatus: String
  - SfaStatusMessage: String

Response Elements

Element	Data Type	Description	Sample Data
Messages	PwsMessage[]	The web service response status and message. Click here for more information.
ResponseId	Int32	Click here for more information
Status	RequestStatus	Click here for more information
ServerTimestampUtc	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. The same status message will be seen from the Projecto

Response Usage Example(s)

Example 01 - Pushing entity data

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsInitiateSfaImportResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsInitiateSfaImportResult xmlns:a="http://projectorpsa.com/DataContracts/Responses/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <Messages xmlns="http://projectorpsa.com/CommonServices/" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/" />
            <ResponseId xmlns="http://projectorpsa.com/CommonServices/">1</ResponseId>
            <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
            <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2021-02-10T20:13:03.8884569Z</ServerTimestampUtc>
            <a:ProjectorEntityData><![CDATA[<?xml version="1.0" encoding="utf-16"?><ops:Import xmlns:ops="urn:ops.projectorpsa.com" xmlns:sf="urn:sobject.partner.soap.sforce.com"><ops:Engagement action="addupdate" xmlns:ops="ops.projectorpsa.com"><ops:engagementName></ops:engagementName><ops:clientName></ops:clientName><ops:costCenterName></ops:costCenterName><ops:engagementTypeName></ops:engagementTypeName><ops:engagementMgrUserDisplayName></ops:engagementMgrUserDisplayName><ops:engagementStageShortName>Open</ops:engagementStageShortName><ops:currencyCode>USD</ops:currencyCode></ops:Engagement></ops:Import>]]></a:ProjectorEntityData>
            <a:SfaStatus>I</a:SfaStatus>
            <a:SfaStatusMessage i:nil="true"/>
         </PwsInitiateSfaImportResult>
      </PwsInitiateSfaImportResponse>
   </s:Body>
</s:Envelope>

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. (Most likely in this case, the pre-configured

API Documentation

PwsInitiateSfaImport

Analytics