service-process Commands
Help for sf Commands
IndustriesSettings
Industries Object Access by Community License
Access Industries Features Deployed Using Managed Packages
Previous Versions
service-process CommandsDeploy, retrieve, and list Unified Catalog Service Processes in an org. A Unified Catalog Service Process defines a service automation workflow consisting of attributes, intake flows, fulfillment flows, and preprocessors.
Deploy the Unified Catalog service process packaged as a ZIP file (typically generated by the `service-process retrieve` CLI command) into a target Salesforce org.
List the Unified Catalog Service Process records from the specified org and display their **Name** and **Id** in a human-readable table.
Retrieve a Unified Catalog Service Process from the specified Salesforce org and package it into a ZIP file. You can then deploy this ZIP file into another org.
Deploy the Unified Catalog service process packaged as a ZIP file (typically generated by the `service-process retrieve` CLI command) into a target Salesforce org.
This command deploys supported Service Process metadata, including:
All other dependencies must already exist in the target org. Examples of these dependencies include:
If any required dependency is missing in the org, the deployment fails.
Deploy a Service Process from a ZIP file to an org with alias “prod”:
1sf service-process deploy --input-zip ./service-process.zip --target-org prodDeploy while linking an existing intake flow:
1sf service-process deploy --input-zip ./service-process.zip --target-org prod --link-intakeDeploy while linking existing intake and fulfillment artifacts:
1sf service-process deploy --input-zip ./service-process.zip --target-org prod --link-intake --link-fulfillment--jsonOptional
Format output as json.
Type: boolean
--flags-dir FLAGS-DIROptional
Import flag values from a directory.
Type: option
-o | --target-org TARGET-ORGRequired
Username or alias of the target org. Not required if the `target-org` configuration variable is already set.
Type: option
--api-version API-VERSIONOptional
Override the api version used for api requests made by this command
Type: option
-z | --input-zip INPUT-ZIPRequired
Path to the ZIP file that contains the Service Process metadata to deploy.
You typically generate this ZIP file with the `service-process retrieve` CLI command. The ZIP file contains the Service Process definition and supported metadata.
Type: option
--link-intakeOptional
Link an existing intake flow instead of deploying a new one.
When specified, the command links the existing intake flow in the target org instead of deploying the intake flow from the ZIP file.
Type: boolean
--link-fulfillmentOptional
Link an existing fulfillment artifact instead of deploying one.
When specified, the command links an existing fulfillment artifact (flow or flow orchestrator) in the target org instead of deploying the fulfillment flow from the ZIP file.
Type: boolean
List the Unified Catalog Service Process records from the specified org and display their **Name** and **Id** in a human-readable table.
To ensure predictable performance and avoid excessively large output, the command limits the number of records returned. If the maximum limit is reached, the results are truncated and a warning is displayed.
Use the --limit flag to control the maximum number of Service Processes returned.
List the available Service Processes in the org with alias “devSandbox”; use the default limit:
1sf service-process list --target-org devSandboxList up to 100 Service Processes:
1sf service-process list --target-org devSandbox --limit 100--jsonOptional
Format output as json.
Type: boolean
--flags-dir FLAGS-DIROptional
Import flag values from a directory.
Type: option
-o | --target-org TARGET-ORGRequired
Username or alias of the target org. Not required if the `target-org` configuration variable is already set.
Type: option
--api-version API-VERSIONOptional
Override the api version used for api requests made by this command
Type: option
--limit LIMITOptional
Maximum number of Service Processes to return.
Allowed range is 1–2000. Default is 1000.
Type: option
Default value: 1000
Retrieve a Unified Catalog Service Process from the specified Salesforce org and package it into a ZIP file. You can then deploy this ZIP file into another org.
The command downloads the Service Process definition, identifies supported dependent metadata, retrieves those components, and bundles everything into a deployable artifact.
Supported metadata retrieved by this command includes:
Other dependencies, such as Apex classes used by flows or preprocessors, aren’t retrieved and must already exist in the target org before deployment.
Retrieve a Service Process using its ID from the org with alias “devSandbox”:
1sf service-process retrieve --service-process-id 0SPxx0000008ABC --target-org devSandboxRetrieve a Service Process and write the artifacts to a custom directory:
1sf service-process retrieve --service-process-id 0SPxx0000008ABC --target-org devSandbox --output-dir ./sp-artifacts--jsonOptional
Format output as json.
Type: boolean
--flags-dir FLAGS-DIROptional
Import flag values from a directory.
Type: option
-i | --service-process-id SERVICE-PROCESS-IDRequired
ID of the Unified Catalog Service Process to retrieve from the source org.
Type: option
-d | --output-dir OUTPUT-DIROptional
Directory where the retrieved Service Process artifacts and the generated ZIP file are written. If not specified, artifacts are written to `./service-process`.
Type: option
-o | --target-org TARGET-ORGRequired
Username or alias of the target org. Not required if the `target-org` configuration variable is already set.
Type: option
--api-version API-VERSIONOptional
Override the api version used for api requests made by this command
Type: option