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:
$ sf svmxc retrieve -o <value> [-d] [-n <value>] [-t <value>] [-p <value>] [-c <value>] [-t <value>]
-p
Specifies the path where the root svmxc folder is to be created to store the retrieved JSON files.
-t
Specifies the ServiceMax Core configuration types to retrieve.
* 
Specify the configuration types in a comma-separated string.
The following configuration type names are supported. Ensure that you enter the names as is.
Checklist: To retrieve checklists
DVR: To retrieve data validation rules
Expression: To retrieve expressions
Mapping: To retrieve mappings
OPDOC: To retrieve output documents
Transaction: To retrieve SFM transactions
Wizard: To retrieve SFM wizards
-o
Specifies the org username or the alias of the org from which configurations are retrieved. This value overrides the default org.
-n
Specifies the developer names of ServiceMax Core configurations to be retrieved from the Source Salesforce org.
-d
Used to specify that the dependent items must be retrieved.
-c
Specifies the configuration file.
The following table lists the available retrieve commands.
Command
Description
Examples
svmxc retrieve
Used to retrieve all the available configurations.
sf svmxc retrieve -o [email protected]
sf svmxc retrieve -o [email protected] -t Expression, Mapping
sf svmxc retrieve checklist
Used to retrieve checklists.
sf svmxc retrieve checklist -o [email protected]
sf svmxc retrieve dvr
Used to retrieve data validation rules.
sf svmxc retrieve dvr -o [email protected]
sf svmxc retrieve expression
Used to retrieve expressions.
sf svmxc retrieve expression -o [email protected]
sf svmxc retrieve mapping
Used to retrieve mappings.
sf svmx retrieve mapping -o [email protected] -n <DEVELOPER_NAME,...>
sf svmxc retrieve opdoc
Used to retrieve output documents.
sf svmxc retrieve opdoc -o [email protected]
sf svmxc retrieve transaction
Used to retrieve transactions.
sf svmxc retrieve transaction -o [email protected]
sf svmxc retrieve wizard
Used to retrieve wizards.
sf svmxc retrieve wizard -o [email protected]
sf svmxc retrieve inventory
Used to retrieve Inventory Process.
sf svmxc retrieve inventory -o [email protected]
sf svmxc retrieve mobilepermission
Used to retrieve the Mobile Permissions
sf svmxc retrieve mobilepermission -o [email protected]
sf svmxc retrieve apppermission
Used to retrieve the SFW SFM App permissions.
sf svmxc retrieve apppermission -o [email protected]
sf svmxc retrieve configprofile
Used to retrieve the Configuration Profiles.
sf svmxc retrieve configprofile -o [email protected]
sf svmxc retrieve mobileconfig
Used to retrieve the Mobile Configuration.
sf svmxc retrieve mobileconfig -o [email protected]
sf svmxc retrieve eventsubjectrule
Used to retrieve the Event Subject Rules.
sf svmxc retrieve eventsubject -o [email protected]
sf svmxc retrieve triggercontrol
Used to retrieve the Trigger Controls.
sf svmxc retrieve triggercontrol -o [email protected]
sf svmxc retrieve featurepermission
Used to retrieve the Feature Permission.
sf svmxc retrieve featurepermission -o [email protected]
sf svmxc retrieve techattr
Used to retrieve the Technical Attributes.
sf svmxc retrieve techattr -o [email protected]
sf svmxc retrieve customactions
Used to retrieve the Custom Actions.
sf svmxc retrieve customactions -o [email protected]
sf svmxc retrieve availableservice
Used to retrieve the Available Services.
sf svmxc retrieve availableservice -o- [email protected]
sf svmxc retrieve territory
Used to retrieve the Territory.
sf svmxc retrieve territory -o [email protected]
sf svmxc retrieve territoryrule
Used to retrieve the Territory Matching Rule.
sf svmxc retrieve territoryrule -o [email protected]
sf svmxc retrieve techrule
Used to retrieve the Technician Rule.
sf svmxc retrieve techrule -o [email protected]
sf svmxc retrieve autoentitlement
Used to retrieve the Auto Entitlement.
sf svmxc retrieve autoentitlement -o [email protected]
sf svmxc retrieve counterrule
Used to retrieve the Counter Rules
sf svmxc retrieve counterrule -o [email protected]
sf svmxc retrieve spm
Used to retrieve the SPM.
sf svmxc retrieve spm -o [email protected]
sf svmxc retrieve iotapex
sf svmxc retrieve iotobject
Used to retrieve the IOT Map To Apex.
Used to retrieve the IOT Map To Object.
sf svmxc retrieve iotapex -o [email protected]
sf svmxc retrieve iotobject -o [email protected]
sf svmxc retrieve ibsetup
Used to retrieve the IB Application Setup.
sf svmxc retrieve ibsetup -o [email protected]
sf svmxc retrieve pmplantemplate
Used to retrieve the PM Plan Template.
sf svmxc retrieve pmplantemplate -o- [email protected]
sf svmxc retrieve serviceteam
Used to retrieve the Service Team.
sf svmxc retrieve serviceteam -o [email protected]
sf svmxc retrieve mttsrule
Used to retrieve the MTTS Rule.
sf svmxc retrieve mttsrule -o [email protected]
sf svmxc retrieve dispatchprocess
Used to retrieve the Dispatch Process.
sf svmxc retrieve dispatchprocess -o [email protected]
sf svmxc retrieve timesheet
Used to retrieve the Timesheet Process.
sf svmxc retrieve timesheet -o [email protected]
sf svmxc retrieve sfa
Used to retrieve the Service Flow Automation.
sf svmxc retrieve sfa -o [email protected]
sf svmxc retrieve pmprocess
Used to retrieve the PM Process.
sf svmxc retrieve pmprocess -o- [email protected]
sf svmxc retrieve sfmsearch
Used to retrieve the SFM Search.
sf svmxc retrieve sfmsearch -o [email protected]
sf svmxc retrieve techrule
Used to retrieve the Technician Rule.
sf svmxc retrieve techrule -o [email protected]
sf svmxc retrieve slaterms
Used to retrieve the SLA Terms.
sf svmxc retrieve slaterms -o [email protected]
sf svmxc retrieve eventhoverrule
Used to retrieve the Event Hover Rule.
sf svmxc retrieve eventhoverrule -o [email protected]
sf svmxc retrieve dcfieldupdate
Used to retrieve the DC Field Update.
sf svmxc retrieve dcfieldupdate -o [email protected]
sf svmxc retrieve fcoconfig
Used to retrieve the FCO Configurations.
sf svmxc retrieve fcoconfig -o [email protected]
sf svmxc retrieve translation
Used to retrieve the Translations.
sf svmxc retrieve translation -o [email protected]
sf svmxc retrieve datalookuprule
Used to retrieve the Data Lookup Rules
sf svmxc retrieve datalookuprule -o [email protected]
sf svmxc retrieve timeline
Used to retrieve the Timelines.
sf svmxc retrieve timeline -o [email protected]
sf svmxc retrieve skillmatchrule
Used to retrieve the Skill Match Rules.
sf svmxc retrieve skillmatchrule -o [email protected]
sf svmxc retrieve dcview
Used to retrieve the DC Views.
sf svmxc retrieve dcview -o [email protected]
sf svmxc retrieve tasktemplate
Used to retrieve the Task Templates.
sf svmxc retrieve tasktemplate -o [email protected]
sf svmxc retrieve invoiceprocess
Used to retrieve the Service Proforma Invoice Processs.
sf svmxc retrieve invoiceprocess -o [email protected]
sf svmxc retrieve sconinvoiceprocess
Used to retrieve the Service Contact Proforma Invoice Process
sf svmxc retrieve sconinvoiceprocess -o [email protected]
sf svmxc retrieve warrantyterms
Used to retrieve the Warranty Terms.
sf svmxc retrieve warrantyterms -o [email protected]
sf svmxc retrieve activitymaster
Used to retrieve the Activity Master.
sf svmxc retrieve activitymaster -o [email protected]
sf svmxc retrieve appointmenttype
Used to retrieve the Ranked Appointment Booking.
sf svmxc retrieve appointmenttype -o [email protected]
sf svmxc retrieve overnightstaypolicy
Used to retrieve the Overnight Policy Setup.
sf svmxc retrieve overnightstaypolicy -o [email protected]
sf svmxc retrieve dchover
Used to retrieve the Dispatch Console Hover.
sf svmxc retrieve dchover -o [email protected]
sf svmxc retrieve scheduledsfm
Used to retrieve the Scheduled SFM.
sf svmxc retrieve scheduledsfm -o- [email protected]
sf svmxc retrieve serviceplan
Used to retrieve the Service Plan.
sf svmxc retrieve serviceplan -o [email protected]
sf svmxc retrieve depotmgmtrule
Used to retrieve the Depot Management Rule.
sf svmxc retrieve depotmgmtrule -o [email protected]
sf svmxc retrieve partusagesetting
Used to retrieve the Part Usage Setting.
sf svmxc retrieve partusagesetting src -o [email protected]
An example of the retrieve command run and the output is displayed in the following screenshot.
You can also pass all the configuration items in the source org in a JSON file for migration and the system will retrieve the configuration items in the JSON file and migrate to the target org. The command is as follows:
sf svmxc retrieve -o src -c <JSON file path>
For example,
sf svmxc retrieve -o src -c /Desktop/configuration.json
The sample JSON configuration file is as follows:
{"expressions":[{"name":"Adv_exp_01","developerName":"ADV_EXP_001","configurationType":"Expression"},{"name":"test_exp_opdoc_4","developerName":"EXP1667550830471451f158006c4ad5ecd67cd64291e852d","configurationType":"Expression"},{"name":"adv exp 05000","developerName":"ADV_EXP_05000","configurationType":"Expression"},{"name":"Copy of ACCOUNT NOT NULL","developerName":"EXP1699434827049927fac4ea36edbedab1b34939b0be67d","configurationType":"Expression"},{"name":"exp_in_pm","developerName":"EXP_PM_01","configurationType":"Expression"},{"name":"SVMX_test02","developerName":"EXP16583923204003e4e60589f67044f68a817aaa9534797","configurationType":"Expression"},{"name":"SVMX_test01","developerName":"EXP1658392200624e13c3df372398b8d971cc29c0e41a036","configurationType":"Expression"},{"name":"childexp_in_trans_01","developerName":"EXP1673426702003fc806176747cd344703e1ef2bcd9ce76","configurationType":"Expression"},{"name":"Copy of test_exp_003","developerName":"EXP169891635442778423c669c9bfae297f31af48d2a7c70","configurationType":"Expression"},{"name":"criteria 001","developerName":"criteria_001","configurationType":"Expression"},{"name":"test Adv Exp","developerName":"test_Adv_Exp","configurationType":"Expression"},{"name":"exp_1_used_in_checklist_01","developerName":"EXP167341114936365518363404f1fd035701d50c0410d4f","configurationType":"Expression"},{"name":"Copy of SVMX_test03","developerName":"EXP1682502343996d69d940b0cb97885a1020ec2ab770c96","configurationType":"Expression"},{"name":"exp_checklist_5","developerName":"EXP16678836281824a87535b36790dec6e5204289dcab80a","configurationType":"Expression"},{"name":"test_child_exp_opdoc_5","developerName":"EXP166779708718474e9b351abf2d8d389205a0a13447769","configurationType":"Expression"},{"name":"global exp in child card trans","developerName":"EXP16947600136194f3f6f22c3faccadc9a3e1acb375cc8a","configurationType":"Expression"},{"name":"servicemax event exp","developerName":"EXP1676609249984c2dbf7d0e1907aa4ef101ccf55197e7a","configurationType":"Expression"},{"name":"test_child_exp_opdoc_4","developerName":"EXP16675509246608212883f1243ffade208627690f9d5db","configurationType":"Expression"},{"name":"global exp in trans","developerName":"EXP169475991812726734991748745af862beb67a4b3d9f5","configurationType":"Expression"},{"name":"SF Sec criteria 001","developerName":"SEC1717499147768f48fab24e010d3947e6f3c928f0a77e6","configurationType":"Expression"}],"objectMappings":[{"name":"SVMX_Account_to_case","developerName":"MAP1658393176855f0104ddf355ed20404913ff5c0033d6e","configurationType":"Mapping"},{"name":"Acc to work order map","developerName":"MAP16765368756665f907c7c9ac04aa5780e2a19fdbef9a6","configurationType":"Mapping"},{"name":"test_map_for_checklist","developerName":"MAP16595203623124d0b36ab4117ad26ce14a95c9545a5ab","configurationType":"Mapping"},{"name":"Task to Time Entry Mapping","developerName":"MAP167566257545146e8b3c5b430dfc7bd8a9043e90130b2","configurationType":"Mapping"},{"name":"global map in trans","developerName":"MAP16947599531851e29c3f1f6acc2a1813015268f661edc","configurationType":"Mapping"},{"name":"Formfill map 001 in WO trans","developerName":"MAP171436853702809f62d753cbaa054c5d31989e6b55126","configurationType":"Mapping"},{"name":"SPM - MTTR. Map Test 00","developerName":"MAP1680344025534ebfc177540b265fbc9c63f2a4c099319","configurationType":"Mapping"},{"name":"Copy of Proforma Invoice Map 01","developerName":"MAP1698916321061e94c0c32921162e7624f80582d59ba6d","configurationType":"Mapping"},{"name":"Time tracker to IL map","developerName":"MAP1700649365413d632feed46f9ac8ed0a2d2bcad568bf4","configurationType":"Mapping"},{"name":"Copy of SVMXSTD: Installed Product To Work Order","developerName":"MAP16754058644000abed5db77e1a92acd3df77ea5868c77","configurationType":"Mapping"},{"name":"Copy of work order to case mapping","developerName":"MAP16917514237175aaf438c6f70fa2ed9f75b826f89b566","configurationType":"Mapping"},{"name":"Work detail to time entry Mapping","developerName":"MAP167566232514238d1e1eed76d7c291deb752caa5be309","configurationType":"Mapping"}],"wizards":[{"name":"check_wizard_runtime","developerName":"check_wizard_runtime","configurationType":"Wizard"}],"transactions":[{"name":"SFM trans for WO object","developerName":"SFM168326803137653f79588efc67c464df8400c543ce44f","configurationType":"Transaction"},{"name":"Custom View WO trans","developerName":"SFM170429075404721ea09fcd6adfa2d2bf6a133bd273f0a","configurationType":"Transaction"}],"inventoryProcesses":[{"name":"Receive Parts for a Work Order","developerName":"test_inv_03","configurationType":"InventoryProcess"},{"name":"Cloned Post to Inventory - Stock Transfer","developerName":"Cloned_SXFR001","configurationType":"InventoryProcess"}],"outputDocs":[{"name":"test_opdoc_4","developerName":"SFM1667550718048f902e4930f6b41d4a083d94b8e3fe9c2","configurationType":"OutputDoc"},{"name":"test_opdoc_5","developerName":"SFM1667796874344a950cb8f065c7cda01771220df54d3e1","configurationType":"OutputDoc"}],"configurationProfiles":[{"name":"Cloned Profile","developerName":"Cloned Profile","configurationType":"ConfigurationProfile"},{"name":"Custom group profile 001","developerName":"Custom group profile 001","configurationType":"ConfigurationProfile"},{"name":"Default Group Profile","developerName":"Default Group Profile","configurationType":"ConfigurationProfile"}],"mobilePermissions":[{"name":"Default Group Profile","developerName":"Default Group Profile","configurationType":"MobilePermission"}],"businessRules":[{"name":"SVMX_dvr03","developerName":"DVR1658916335377ee6cef1736426535249e250d9e033872","configurationType":"BusinessRule"},{"name":"COL dvr 001","developerName":"DVR17143686763618912356179a50a40f896e52964380c81","configurationType":"BusinessRule"}],"checklists":[{"name":"Test_checklist_02","developerName":"SFM1659519880055b47fbd7bdca2c1fe7609abb98a516894","configurationType":"Checklist"},{"name":"test_checklist_3","developerName":"SFM166719914970694293d1356aa6f267849304281faec2d","configurationType":"Checklist"},{"name":"test_checklist_fix_01","developerName":"SFM1673411329691e8684e27c68108e4cf7b8e1110241001","configurationType":"Checklist"},{"name":"Number Checklist","developerName":"SFM170045803282412a3b3677949b30ca79d94530f812292","configurationType":"Checklist"}],"translations":[{"name":"Chinese-translation_wizard_01","developerName":"Chinese-TRANSLATION_WIZARD_01","context":"WIZARD_NAME","configurationType":"Translation"},{"name":"French-Assets Sec title","developerName":"French-ASSETS_SEC_TITLE","context":"SEARCH_RESULT_SECTION_TITLE","configurationType":"Translation"}],"technicalAttributes":[{"name":"00000001","developerName":"tech attr 02","configurationType":"TechnicalAttribute"}],"mobileConfigurations":[{"name":"Custom group profile 001","developerName":"Custom group profile 001","configurationType":"MobileConfiguration"}],"applicationPermissions":[{"name":"Wizard with Opdoc as step","developerName":"Wizard_with_Opdoc_as_step","configurationType":"ApplicationPermission"}],"pmPlanTemplates":[{"name":"check PM Plan template 01","developerName":"check PM Plan template 01","configurationType":"PMPlanTemplate"},{"name":"test Cond based PM template 010","developerName":"test Cond based PM template 010","configurationType":"PMPlanTemplate"}],"fieldInventories":[{"name":"Default Group Profile","developerName":"Default Group Profile","configurationType":"FieldInventory"}],"pmProcesses":[{"name":"Kevin PM Process","developerName":"Kevin_PM_Process","configurationType":"PMProcess"}],"serviceFlowAutomations":[{"name":"Base Org SFA 001","developerName":"BASE_ORG_SFA_001","configurationType":"ServiceFlowAutomation"}],"taskTemplates":[{"name":"tasktemplate_02","developerName":"tasktemplate_02","configurationType":"TaskTemplate"},{"name":"test_task_01","developerName":"test_task_01","configurationType":"TaskTemplate"},{"name":"task_template_3","developerName":"task_template_3","configurationType":"TaskTemplate"}],"mttsRules":[{"name":"test_mtts_01","developerName":"test_mtts_01","configurationType":"MttsRule"}],"territories":[{"name":"test_territory_1","developerName":"test_territory_1","configurationType":"Territory"},{"name":"test_territory_2","developerName":"test_territory_2","configurationType":"Territory"}],"serviceTeams":[{"name":"test_serviceteam_01","developerName":"test_serviceteam_01","configurationType":"ServiceTeam"}],"dispatchProcesses":[{"name":"test_dispatch_process_01","developerName":"test_dispatch_process_01","configurationType":"DispatchProcess"}],"timesheets":[{"name":"Timesheet_02","developerName":"Timeshee1690887025055","configurationType":"Timesheet"},{"name":"test Timesheet","developerName":"test Tim1716972076999","configurationType":"Timesheet"}],"sfmSearches":[{"name":"SFM SEARCH 03","developerName":"SFM_SEARCH_03","configurationType":"SFMSearch"}],"territoryRules":[{"name":"territory_rule_01","developerName":"territory_rule_01","configurationType":"TerritoryRule"}],"technicianRules":[{"name":"technician_rule_01","developerName":"technician_rule_01","configurationType":"TechnicianRule"}],"slaTerms":[{"name":"SLA Terms - 001","developerName":"SLA Terms - 001","configurationType":"SLATerms"},{"name":"test_sla_02","developerName":"test_sla_02","configurationType":"SLATerms"},{"name":"test_sla_01","developerName":"test_sla_01","configurationType":"SLATerms"}],"autoEntitlements":[{"name":"auto_case_rule_03","developerName":"auto_case_rule_03","configurationType":"AutoEntitlement"}],"counterRules":[{"name":"counter_rule_01","developerName":"counter_rule_01","configurationType":"CounterRule"}],"skillMatchRules":[{"name":"PN-0000003952","developerName":"Skill match rule 03","configurationType":"SkillMatchRule"},{"name":"Child Skill mtch rule 03","developerName":"Child Skill mtch rule 03","configurationType":"SkillMatchRule"}],"servicePerformanceMetrics":[{"name":"Mean Time To Repair","developerName":"MeanTimeToRepair","configurationType":"ServicePerformanceMetrics"}],"customActions":[{"name":"Contact_WebService_01","developerName":"Contact_WebService_01","configurationType":"CustomActions"},{"name":"Mobile Activity","developerName":"MA_001","configurationType":"CustomActions"}],"availableServices":[{"name":"Servicename001","developerName":"Servicename001","configurationType":"AvailableService"},{"name":"test_service_01","developerName":"test_service_01","configurationType":"AvailableService"}],"iotMapToApex":[{"name":"VerifyMigrationinPlugin","developerName":"VerifyMigrationinPlugin","configurationType":"IOTMapToApex"}],"eventSubjectRules":[{"name":"event_rule_001","developerName":"event_rule_001","configurationType":"EventSubjectRule"}],"featurePermissions":[{"name":"Custom group profile 001","developerName":"Custom group profile 001","configurationType":"FeaturePermission"}],"triggerControls":[{"name":"SVMXC__Site__c","developerName":"SVMXC__Site__c","configurationType":"TriggerControl"}],"eventHoverRules":[{"name":"Event_hover_rule_01","developerName":"Event_hover_rule_01","configurationType":"EventHoverRule"}],"ibTimelines":[{"name":"timeline001","developerName":"timeline001","configurationType":"Timeline"}],"fcoConfigurations":[{"name":"test FCO template 001","developerName":"test FCO template 001","configurationType":"FCOConfiguration"}],"dcFieldUpdates":[{"name":"DC Field Updates","developerName":"DCFieldUpdates","configurationType":"DCFieldUpdate"}],"dataLookupRules":[{"name":"Acc to Asset rule 001","developerName":"Acc to Asset rule 001","configurationType":"DataLookupRule"},{"name":"Case to WO rule 01","developerName":"Case to WO rule 01","configurationType":"DataLookupRule"}],"dcHovers":[{"name":"Map Hover For Account","developerName":"Map Hover For Account","configurationType":"DCHover"}],"activityMasters":[{"name":"0000000008","developerName":"0000000008","configurationType":"ActivityMaster"}],"warrantyTerms":[{"name":"Warranty Term - 001","developerName":"Warranty Term - 001","configurationType":"WarrantyTerms"}],"pushNotifications":[{"name":"Pulse - 002","developerName":"Pulse - 002","configurationType":"PushNotification"}],"appointmentTypes":[{"name":"Saadat 01","developerName":"Saadat 01","configurationType":"Saadat 01"}],"servicePlans":[{"name":"Service Plan - 001","developerName":"Service Plan - 001","configurationType":"ServicePlan"}],"overNightStayPolicies":[{"name":"Overnight policy 001","developerName":"Overnight policy 001","configurationType":"OverNightStayPolicy"}],"scheduledSFMs":[{"name":"Scheduled SFM 001","developerName":"Scheduled SFM 001","configurationType":"ScheduledSFM"}],"serviceInvoiceProcesses":[{"name":"Proforma for Case","developerName":"Proforma_Case","configurationType":"ServiceInvoiceProcess"}],"sconInvoiceProcesses":[{"name":"Simple SCON Process","developerName":"Simple_SCON_Process","configurationType":"SCONInvoiceProcess"}],"ibApplicationSetups":[{"name":"Custom group profile 001","developerName":"Custom group profile 001","configurationType":"IBApplicationSetup"}],"dispatchConsoleViews":[{"name":"test_DC_view_01","developerName":"DC_VIEW_01","configurationType":"DispatchConsoleView"}],"iotMapToObject":[{"name":"Test_Event_01","developerName":"Test_Event_01","configurationType":"IOTMapToObject"}],"territoryRules":[{"name":"territory_rule_02","developerName":"territory_rule_02","configurationType":"TerritoryRule"}]}
Was this helpful?