Using the Retrieve Command
The retrieve command retrieves ServiceMax Core configurations from ServiceMax-installed Salesforce org and saves them as JSON files in the local file system. The JSON files are stored in an organized folder, differentiating each configuration type.
Administrators can deploy the retrieved configurations to any ServiceMax-installed Salesforce org. This helps migrate the ServiceMax Core configurations to one or more Salesforce org.
The following table provides the svmxc: retrieve command information.
|
Command Options / Arguments
|
Description
|
||
|---|---|---|---|
|
Command:
sfdx svmxc:retrieve [-t <array>] [-p <string>] [-d] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
|
|||
|
-p
|
Used to specify the path where the root svmxc folder is to be created to store the retrieved JSON files.
|
||
|
-t
|
It is used to specify the ServiceMax Core configuration types to retrieve.
|
||
|
-u
|
Used to specify the org username or the alias of the org from which configurations are retrieved. This value overrides the default org.
|
||
|
-d
|
Used to specify that the dependent items must be retrieved.
|
||
|
--apiversion
|
Used to specify the API version. This overrides the API version used for API requests made by this command.
|
||
|
--json
|
Used to specify that the output format is JSON.
|
||
|
--loglevel
|
Used to specify the logging level. The available options are (trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL).
The default logging level is WARN.
|
||
The following table lists the available retrieve commands.
|
Command
|
Description
|
Examples
|
|---|---|---|
|
svmxc: retrieve
|
Used to retrieve all the available configurations.
|
sfdx svmxc: retrieve -u user@salesforce.com
sfdx svmxc: retrieve -u user@salesforce.com -t Expression, Mapping
|
|
svmxc:retrieve:checklist
|
Used to retrieve checklists.
|
sfdx svmxc:retrieve:checklist -u user@salesforce.com
|
|
svmxc:retrieve:dvr
|
Used to retrieve data validation rules.
|
sfdx svmxc:retrieve:dvr -u user@salesforce.com
|
|
svmxc:retrieve:expression
|
Used to retrieve expressions.
|
sfdx svmxc:retrieve:expression -u user@salesforce.com
|
|
svmxc:retrieve:mapping
|
Used to retrieve mappings.
|
sfdx svmx:retrieve:mapping -u user@salesforce.com -n <DEVELOPER_NAME,...>
|
|
svmxc:retrieve:opdoc
|
Used to retrieve output documents.
|
sfdx svmxc:retrieve:opdoc -u user@salesforce.com
|
|
svmxc:retrieve:transaction
|
Used to retrieve transactions.
|
sfdx svmxc:retrieve:transaction -u user@salesforce.com
|
|
svmxc:retrieve:wizard
|
Used to retrieve wizards.
|
sfdx svmxc:retrieve:wizard -u user@salesforce.com
|
|
svmxc:retrieve:inventory
|
Used to retrieve Inventory Process.
|
sfdx svmxc:retrieve: inventory -u user@salesforce.com
|
|
svmxc:retrieve:mobilepermission
|
Used to retrieve the Mobile Permissions
|
sfdx svmxc:retrieve:mobilepermission -u user@salesforce.com
|
|
svmxc:retrieve:apppermission
|
Used to retrieve the SFW SFM App permissions.
|
sfdx svmxc:retrieve:apppermission -u user@salesforce.com
|
|
svmxc:retrieve:configprofile
|
Used to retrieve the Configuration Profiles.
|
sfdx svmxc:retrieve:configprofile -u user@salesforce.com
|
|
svmxc:retrieve:mobileconfig
|
Used to retrieve the Mobile Configuration.
|
sfdx svmxc:retrieve:mobileconfig -u username of user@salesforce.com
|
|
svmxc:retrieve:e
ventsubjectrule
|
Used to retrieve the Event Subject Rules.
|
sfdx svmxc:retrieve:eventsubject -u username of user@salesforce.com
|
|
svmxc:retrieve:triggercontrol
|
Used to retrieve the Trigger Controls.
|
sfdx svmxc:retrieve:triggercontrol -u,username of user@salesforce.com
|
|
svmxc:retrieve:featurepermission
|
Used to retrieve the Feature Permission.
|
sfdx svmxc:retrieve:featurepermission -u,username of user@salesforce.com
|
|
svmxc:retrieve:techattr
|
Used to retrieve the Technical Attributes.
|
sfdx svmxc:retrieve:techattr -u, username of user@salesforce.com
|
|
svmxc:retrieve:customactions
|
Used to retrieve the Custom Actions.
|
sfdx svmxc:retrieve:customactions -u, username of user@salesforce.com
|
|
svmxc:retrieve:availableservice
|
Used to retrieve the Available Services.
|
sfdx svmxc:retrieve:availableservice -u, username of user@salesforce.com
|
|
svmxc:retrieve:territory
|
Used to retrieve the Territory.
|
sfdx svmxc:retrieve:territory - u, username of user@salesforce.com
|
|
svmxc:retrieve:territoryrule
|
Used to retrieve the Territory Matching Rule.
|
sfdx svmxc:retrieve:territoryrule - u, username of user@salesforce.com
|
|
svmxc:retrieve:techrule
|
Used to retrieve the Technician Rule.
|
sfdx svmxc:retrieve:techrule -u, username of user@salesforce.com
|
|
svmxc:retrieve:autoentitlement
|
Used to retrieve the Auto Entitlement.
|
sfdx svmxc:retrieve:autoentitlement -u, username of user@salesforce.com
|
|
svmxc:retrieve:counterrule
|
Used to retrieve the Counter Rules
|
sfdx svmxc:retrieve:counterrule - u, username of user@salesforce.com
|
|
svmxc:retrieve:spm
|
Used to retrieve the SPM.
|
sfdx svmxc:retrieve:spm - u, username of user@salesforce.com
|
|
svmxc:retrieve:iotapex
svmxc:retrieve:iotobject
|
Used to retrieve the IOT Map To Apex.
Used to retrieve the IOT Map To Object.
|
sfdx svmxc:retrieve:iotapex - u, username of user@salesforce.com
sfdx svmxc:retrieve:iotobject - u, username of user@salesforce.com
|
|
svmxc:retrieve:ibsetup
|
Used to retrieve the IB Application Setup.
|
sfdx svmxc:retrieve:ibsetup -u, username of user@salesforce.com
|
|
svmxc:retrieve:pmplantemplate
|
Used to retrieve the PM Plan Template.
|
sfdx svmxc:retrieve:pmplantemplate -u, username of user@salesforce.com
|
|
svmxc:retrieve:serviceteam
|
Used to retrieve the Service Team.
|
sfdx svmxc:retrieve:serviceteam -u, username of user@salesforce.com
|
|
svmxc:retrieve:mttsrule
|
Used to retrieve the MTTS Rule.
|
sfdx svmxc:retrieve:mttsrule -u, username of user@salesforce.com
|
|
svmxc:retrieve:dispatchprocess
|
Used to retrieve the Dispatch Process.
|
sfdx svmxc:retrieve:dispatchprocess -u, username of user@salesforce.com
|
|
svmxc:retrieve:timesheet
|
Used to retrieve the Timesheet Process.
|
sfdx svmxc:retrieve:timesheet -u, username of user@salesforce.com
|
|
svmxc:retrieve:sfa
|
Used to retrieve the Service Flow Automation.
|
sfdx svmxc:retrieve:sfa -u, username of user@salesforce.com
|
|
svmxc:retrieve:fieldinventory
|
Used to retrieve the Field Inventory.
|
sfdx svmxc:retrieve:fieldinventory -u, username of user@salesforce.com
|
|
svmxc:retrieve:pmprocess
|
Used to retrieve the PM Process.
|
sfdx svmxc:retrieve:pmprocess -u, username of user@salesforce.com
|
|
svmxc:retrieve:sfmsearch
|
Used to retrieve the SFM Search.
|
sfdx svmxc:retrieve:sfmsearch -u, username of user@salesforce.com
|
|
svmxc:retrieve:techrule
|
Used to retrieve the Technician Rule.
|
sfdx svmxc:retrieve:techrule -u,username of user@salesforce.com
|
|
svmxc:retrieve:slaterms
|
Used to retrieve the SLA Terms.
|
sfdx svmxc:retrieve:slaterms -u, username of user@salesforce.com
|
|
svmxc:retrieve:eventhoverrule
|
Used to retrieve the Event Hover Rule.
|
sfdx svmxc:retrieve:eventhoverrule -u, username of user@salesforce.com
|
|
sfdx svmxc:retrieve:dcfieldupdate
|
Used to retrieve the DC Field Update.
|
sfdx svmxc:retrieve:dcfieldupdate -u, username of user@salesforce.com
|
|
sfdx svmxc:retrieve:fcoconfig
|
Used to retrieve the FCO Configurations.
|
sfdx svmxc:retrieve:fcoconfig -u, username of user@salesforce.com
|
|
sfdx svmxc:retrieve:translation
|
Used to retrieve the Translations.
|
sfdx svmxc:retrieve:translation-u, username of user@salesforce.com
|
|
sfdx svmxc:retrieve:datalookuprule
|
Used to retrieve the Data Lookup Rules
|
sfdx svmxc:retrieve:datalookuprule -u, username of user@salesforce.com
|
|
sfdx svmxc:retrieve:timeline
|
Used to retrieve the Timelines.
|
sfdx svmxc:retrieve:timeline -u, username of user@salesforce.com
|
|
sfdx svmxc:retrieve:skillmatchrule
|
Used to retrieve the Skill Match Rules.
|
sfdx svmxc:retrieve:skillmatchrule -u, username of user@salesforce.com
|
|
sfdx svmxc:retrieve:dcview
|
Used to retrieve the DC Views.
|
sfdx svmxc:retrieve:dcview -u, username of user@salesforce.com
|
|
sfdx svmxc:retrieve:tasktemplate
|
Used to retrieve the Task Templates.
|
sfdx svmxc:retrieve:tasktemplate -u, username of user@salesforce.com
|
|
sfdx svmxc:retrieve:invoiceprocess
|
Used to retrieve the Service Proforma Invoice Processs.
|
sfdx svmxc:retrieve:invoiceprocess -u, username of user@salesforce.com
|
|
sfdx svmxc:retrieve:sconinvoiceprocess
|
Used to retrieve the Service Contact Proforma Invoice Process
|
sfdx svmxc:retrieve:sconinvoiceprocess -u, username of user@salesforce.com
|
|
sfdx svmxc:retrieve:pulse
|
Used to retrieve the Push Notification.
|
sfdx svmxc:retrieve:pulse -u, username of user@salesforce.com
|
|
sfdx svmxc:retrieve:warrantyterms
|
Used to retrieve the Warranty Terms.
|
sfdx svmxc:retrieve:warrantyterms -u, username of user@salesforce.com
|
|
sfdx svmxc:retrieve:activitymaster
|
Used to retrieve the Activity Master.
|
sfdx svmxc:retrieve:activitymaster -u, username of user@salesforce.com
|
|
sfdx svmxc:retrieve:appointmenttype
|
Used to retrieve the Ranked Appointment Booking.
|
sfdx svmxc:retrieve:appointmenttype -u, username of user@salesforce.com
|
|
sfdx svmxc:retrieve:overnightstaypolicy
|
Used to retrieve the Overnight Policy Setup.
|
sfdx svmxc:retrieve:overnightstaypolicy -u, username of user@salesforce.com
|
|
sfdx svmxc:retrieve:dchover
|
Used to retrieve the Dispatch Console Hover.
|
sfdx svmxc:retrieve:dchover -u, username of user@salesforce.com
|
|
sfdx svmxc:retrieve:scheduledsfm
|
Used to retrieve the Scheduled SFM.
|
sfdx svmxc:retrieve:scheduledsfm -u, username of user@salesforce.com
|
|
sfdx svmxc:retrieve:serviceplan
|
Used to retrieve the Service Plan.
|
sfdx svmxc:retrieve:serviceplan -u, username of user@salesforce.com
|
An example of the retrieve command run and the output is displayed in the following screenshot.
The retrieved configurations are saved as JSON files in the specified path. The following is an example of the folder structure of a JSON bundle.
The following is an example of a JSON file that contains a retrieved SFM transaction.The command to retrieve an SFM transaction is : sfdx svmxc:retrieve:transaction -u source
The JSON file that contains the retrieved SFM transaction is as follows:
{
"validationRules": [
{
"sequence": 0,
"referenceId": "a2O630000011UJFEA2",
"name": "validation1",
"message": "this is a warning",
"id": "a2O630000011UJZEA2"
}
],
"transactionType": "SOURCE TO TARGET ALL",
"tagKeys": "TRANSACTION1;SFM1653546942318750743D7485CE9BC886A49A6538C0F1B_DESC;TEST;CUSTOMIZED_SECTION;TEST_BUTTON;
THIS_IS_A_WARNING;",
"syncMobileOption": "Default",
"status": "Complete",
"sourceUpdateRules": {
"sourceObject": "Asset",
"expressionDetails": [
{
"value": "Installed",
"sourceField": "Status",
"referenceId": "a2O630000011UJFEA2",
"parameterType": "Value",
"action": "Set"
}
]
},
"sorting": [
],
"parentProcessNodes": [
{
"type": "TARGET",
"sourceAPIName": "Asset",
"referenceId": "a2O630000011UJFEA2",
"qualificationCriteriaId": "expression1",
"objectLabel": "Account",
"objectAPIName": "Account",
"mappingId": "mapping1",
"fieldSetApiNames": [
"SM_Service_Board_Fields"
],
"enableOnlineSearch": false,
"allowImages": false,
"allowAttachments": true
},
{
"type": "SOURCE",
"referenceId": "a2O630000011UJGEA2",
"objectAPIName": "Asset",
"enableOnlineSearch": false,
"allowImages": false,
"allowAttachments": false
}
],
"pageLayoutDetails": {
"type": "Header",
"showAllSections": true,
"pageHeader": {
"sections": [
{
"type": "Section",
"sequence": 1,
"referenceId": "a0k63000005lCjzAAE",
"name": "customized section",
"elements": [
{
"type": "STRING",
"sequence": 1,
"row": 1,
"required": false,
"readOnly": false,
"overrideLookupContext": false,
"lookupContextSource": "CURRENT_RECORD",
"lookupConfiguration": {
},
"events": [
],
"eltType": "Field",
"column": 1,
"apiName": "Name"
}
],
"columns": 2
},
{
"type": "Button",
"sequence": 1,
"referenceId": "a0k63000005lCk0AAE",
"name": "test button",
"events": [
{
"type": "Button Click",
"actionType": "URL",
"actionTarget": "https://test.salesforce.com"
}
]
}
],
"objectAPIName": "Account"
},
"objectAPIName": "Account",
"name": "transaction1",
"lines": [
],
"isStandard": false,
"hideSave": false,
"hideQuickSave": true,
"events": [
],
"dependencyExist": true
},
"name": "transaction1",
"linkedProcesses": [
],
"isStandard": false,
"formulas": [
{
"sourceObject": "Account",
"name": "test formula",
"modeOfExecution": "On Save",
"isStandard": false,
"expressionDetails": [
{
"value": "$D.Account.Name",
"sourceFldDtaType": "ID",
"sourceField": "Id",
"processConfig": "[{\"aliasName\":\"Account\",\"objectLabel\":\"Account\",\"sequence\":0}]",
"metaData": "[{\"FLDS\":[{\"name\":\"Name\"}],\"OBJ\":\"Account\"}]",
"actionType": "Set Value"
}
],
"description": "testing"
}
],
"description": "testiing",
"childProcessNodes": [
]
}
"validationRules": [
{
"sequence": 0,
"referenceId": "a2O630000011UJFEA2",
"name": "validation1",
"message": "this is a warning",
"id": "a2O630000011UJZEA2"
}
],
"transactionType": "SOURCE TO TARGET ALL",
"tagKeys": "TRANSACTION1;SFM1653546942318750743D7485CE9BC886A49A6538C0F1B_DESC;TEST;CUSTOMIZED_SECTION;TEST_BUTTON;
THIS_IS_A_WARNING;",
"syncMobileOption": "Default",
"status": "Complete",
"sourceUpdateRules": {
"sourceObject": "Asset",
"expressionDetails": [
{
"value": "Installed",
"sourceField": "Status",
"referenceId": "a2O630000011UJFEA2",
"parameterType": "Value",
"action": "Set"
}
]
},
"sorting": [
],
"parentProcessNodes": [
{
"type": "TARGET",
"sourceAPIName": "Asset",
"referenceId": "a2O630000011UJFEA2",
"qualificationCriteriaId": "expression1",
"objectLabel": "Account",
"objectAPIName": "Account",
"mappingId": "mapping1",
"fieldSetApiNames": [
"SM_Service_Board_Fields"
],
"enableOnlineSearch": false,
"allowImages": false,
"allowAttachments": true
},
{
"type": "SOURCE",
"referenceId": "a2O630000011UJGEA2",
"objectAPIName": "Asset",
"enableOnlineSearch": false,
"allowImages": false,
"allowAttachments": false
}
],
"pageLayoutDetails": {
"type": "Header",
"showAllSections": true,
"pageHeader": {
"sections": [
{
"type": "Section",
"sequence": 1,
"referenceId": "a0k63000005lCjzAAE",
"name": "customized section",
"elements": [
{
"type": "STRING",
"sequence": 1,
"row": 1,
"required": false,
"readOnly": false,
"overrideLookupContext": false,
"lookupContextSource": "CURRENT_RECORD",
"lookupConfiguration": {
},
"events": [
],
"eltType": "Field",
"column": 1,
"apiName": "Name"
}
],
"columns": 2
},
{
"type": "Button",
"sequence": 1,
"referenceId": "a0k63000005lCk0AAE",
"name": "test button",
"events": [
{
"type": "Button Click",
"actionType": "URL",
"actionTarget": "https://test.salesforce.com"
}
]
}
],
"objectAPIName": "Account"
},
"objectAPIName": "Account",
"name": "transaction1",
"lines": [
],
"isStandard": false,
"hideSave": false,
"hideQuickSave": true,
"events": [
],
"dependencyExist": true
},
"name": "transaction1",
"linkedProcesses": [
],
"isStandard": false,
"formulas": [
{
"sourceObject": "Account",
"name": "test formula",
"modeOfExecution": "On Save",
"isStandard": false,
"expressionDetails": [
{
"value": "$D.Account.Name",
"sourceFldDtaType": "ID",
"sourceField": "Id",
"processConfig": "[{\"aliasName\":\"Account\",\"objectLabel\":\"Account\",\"sequence\":0}]",
"metaData": "[{\"FLDS\":[{\"name\":\"Name\"}],\"OBJ\":\"Account\"}]",
"actionType": "Set Value"
}
],
"description": "testing"
}
],
"description": "testiing",
"childProcessNodes": [
]
}