Import data from Third-Party App to FSA Work Order Object
• Open the third-party app and sent data to FSA.
• Data received from third-party app to FSA should have the following URI scheme:
svmxSchemeName://update?ParameterName1=ParameterValue1&x;data={
"object": "ObjectAPIName",
"token":"2361792191138122365541172220801236513814919310213715520282368037666",
"processId": "ProcessUniqueId of EditSFMProcess",
"action": "update”,
"source":{
"name": "SourceAppName",
"description": "SourceAppDescription",
},
"record": {
Header record fields
},
"details": [
{
"objectName": “Detail_Line_Object_API_Name1”,
"record": [{
record1
},
{
record2
},]
},
{
"objectName": "Detail_Line_Object_API_Name2”,
"record": [{
record1
},
{
record2
},]
}
]
}
"object": "ObjectAPIName",
"token":"2361792191138122365541172220801236513814919310213715520282368037666",
"processId": "ProcessUniqueId of EditSFMProcess",
"action": "update”,
"source":{
"name": "SourceAppName",
"description": "SourceAppDescription",
},
"record": {
Header record fields
},
"details": [
{
"objectName": “Detail_Line_Object_API_Name1”,
"record": [{
record1
},
{
record2
},]
},
{
"objectName": "Detail_Line_Object_API_Name2”,
"record": [{
record1
},
{
record2
},]
}
]
}
where,
SchemeName is the third-party app scheme name.
ParameterName1 is the account's SFDC Id.
Object (ObjectAPIName) is header record object’s API name
Token is the token value is generated by FSA.
action: "update”
processId is the target Edit SFM process that is launched on FSA.
SourceAppName is the default title shown on the pop-up window for accepting the payload.
SourceAppDescription is the default description shown on the pop-up window for accepting the payload.
Header Record Fields:
{
“field_api_name1”: “field_value1”,
“lookupfield_api_name2”: {
"key": “SFDC Id of the lookup field“,
"value": “Value of the field“,
}
}
“field_api_name1”: “field_value1”,
“lookupfield_api_name2”: {
"key": “SFDC Id of the lookup field“,
"value": “Value of the field“,
}
}
Details:
Object: "SVMXC__Service_Order_Line__c". This is detail line object’s API name
Record 1 and Record 2 are defined in the same way as Header Record fields with the detail line fields
• ProcessId sent in the payload should be unique processId of the Edit SFM process.Third-party app initiates data request to FSA. The data request message has Allow/Don't Allow options. Tap Allow to allow importing data.
• When the incoming data request is allowed, data is successfully imported into the Work Order object using the Edit SFM Process configured. On save the imported data is synced to server successfully. Appropriate error messages are displayed in the following scenarios:
◦ When the import data request is initiated and the authorization key is expired, the following error message is displayed: Invalid authorization key. Data import unsuccessful
◦ When response from third-party app has invalid processId, the following error message is displayed: This process is not found. Please contact your ServiceMax administrator.
◦ When response from third-party app has valid processId, but the Edit SFM process does not exists or is not downloaded to FSA, then the following error message is displayed: This process is not found. Please contact your ServiceMax administrator.
◦ When the imported data has header object or fields or child object or fields that are either invalid or not available in FSA, then the following error message is displayed: Invalid inbound data. Data import unsuccessful.
◦ When invalid data format is imported to FSA, then data will not be imported and the recent View Process is displayed.
• In order to enable Third party apps to format and display record data, the payload includes object describe information containing field types, constraints, etc as mentioned in the above URI scheme.
 |
Importing data is only supported for synced records and not offline records. For successfully importing data from third-party app to FSA, ensure that the mandatory parameters should be accurately defined; svmxSchemeName as svmx, action as update, and processId should be unique Id of th Edit SFM Process. In the above steps, Work Order object is used as an example. The same process can be repeated for other objects as well..
|