@salesforce/plugin-orchestrator 1.0.17 → 1.0.20

package/messages/appframework.display.template.md

@@ -1,10 +1,36 @@
 # summary
 
-Display details of an AppFramework template.
+Display details of a template.
 
 # description
 
-Shows detailed information about a specific AppFramework template including its name, label, ID, type, and other properties.
+Display comprehensive information about a specific template including its name, label, ID, type, subtype, description, and other metadata properties. Use this command to inspect templates before using them to create apps or for understanding template configurations.
+
+You can identify a template by either its unique ID or its name. Template IDs are guaranteed to be unique, while template names should be unique within an org. The command displays all available template properties in a formatted, easy-to-read layout.
+
+Template information helps you understand what the template provides, its intended use case, and how to use it effectively when creating orchestrated apps. You must have Data Cloud and Tableau Next enabled in your org and the AppFrameworkViewApp user permission to view templates.
+
+# examples
+
+- Display a template using its ID:
+
+  <%= config.bin %> <%= command.id %> --target-org myOrg --template-id 01RM0000000HwBGMA0
+
+- Display a template using its name:
+
+  <%= config.bin %> <%= command.id %> --target-org myOrg --template-name "MyTemplate"
+
+- Display a template with a name that contains spaces:
+
+  <%= config.bin %> <%= command.id %> --target-org myOrg --template-name "Sales Analytics Template"
+
+- Display a template in a specific org using a particular API version:
+
+  <%= config.bin %> <%= command.id %> --target-org mySandbox --template-id 01RM0000000HwBGMA0 --api-version 60.0
+
+- Display a template by name in your default org:
+
+  <%= config.bin %> <%= command.id %> --template-name "dashboard_template"
 
 # flags.template-id.summary
 
@@ -12,7 +38,7 @@ The ID of the template to display.
 
 # flags.template-id.description
 
-Specify the unique identifier of the template you want to display. Use this flag when you know the template's ID.
+Specify the unique identifier of the template you want to display. Template IDs are guaranteed to be unique within an org. Use this flag when you know the template's ID, which you can get from "sf orchestrator template list" command. Either --template-id or --template-name is required.
 
 # flags.template-name.summary
 
@@ -20,82 +46,99 @@ The name of the template to display.
 
 # flags.template-name.description
 
-Specify the name of the template you want to display. Use this flag when you know the template's name but not its ID.
+Specify the name of the template you want to display. Template names should be unique within an org. Use this flag when you know the template's name but not its ID. If the name contains spaces, enclose it in quotes. Either --template-id or --template-name is required.
 
 # flags.target-org.summary
 
-Login username or alias for the target org
+Login username or alias for the target org.
 
 # flags.target-org.description
 
-The target org to connect to for displaying the template.
+The target org to connect to for displaying the template. This org must have Data Cloud and Tableau Next enabled and you must have the AppFrameworkViewApp user permission to view templates. The template must exist in this org.
 
 # flags.api-version.summary
 
-Override the api version used for api requests
+Override the API version used for API requests.
 
 # flags.api-version.description
 
-Override the api version used for api requests to the app framework.
+Override the API version used for orchestrator API requests. Use this flag to specify a particular API version when the default version doesn't work with your org's configuration.
 
 # fetchingTemplate
 
-Fetching AppFramework template...
+Fetching template...
 
 # error.MissingRequiredFlag
 
-Either --template-id or --template-name must be provided
+Either --template-id or --template-name must be provided.
 
 # error.MissingRequiredFlag.Actions
 
-- Use --template-id to specify a template by ID
-- Use --template-name to specify a template by name
+- Use --template-id to specify a template by its unique ID
+- Use --template-name to specify a template by its name
+- Get template IDs and names using "sf orchestrator template list"
 
 # error.CertificateError
 
-Error retrieving AppFramework template: Certificate validation error
+Error retrieving template: Certificate validation error.
 
 # error.CertificateError.Actions
 
 - This appears to be a certificate validation issue, which is common in dev environments
 - Try specifying the API version with --api-version=64.0 (or your org's version)
-- Make sure you're using the correct org with -o YOUR_ORG_ALIAS
+- Make sure you're using the correct org with --target-org YOUR_ORG_ALIAS
 - If using a sandbox or scratch org, ensure your connection is properly authenticated
 
 # error.AuthenticationError
 
-Error retrieving AppFramework template: Authentication issue
+Error retrieving template: Authentication issue.
 
 # error.AuthenticationError.Actions
 
 - Your session may have expired or you may not have permission to access this resource
-- Try running sf org refresh to update your credentials
-- Ensure you have AppFramework enabled and have permission to view templates
+- Try running "sf org login web" to reauthenticate
+- Ensure you have Tableau Next enabled and have permission to view templates
+- Verify the target org is correct and accessible
 
 # error.TemplateNotFound
 
-Template %s not found
+Template "%s" not found.
 
 # error.TemplateNotFound.Actions
 
 - Verify that you have the correct template ID or name
-- Ensure the template exists in this org
+- Ensure the template exists in this org using "sf orchestrator template list"
 - Check your permissions to view templates
+- Make sure you're connected to the correct org with --target-org
 
 # error.GenericError
 
-Error retrieving AppFramework template: %s
+Error retrieving template: %s
 
 # error.GenericError.Actions
 
-- Verify that you are using an org with AppFramework enabled
+- Verify that you are using an org with Data Cloud and Tableau Next enabled
 - Check that the template ID or name is correct
-- Check your credentials and permissions
-- Try running sf org refresh to update your credentials
+- Ensure you have permission to view templates
+- Try running "sf org login web" to reauthenticate
+- Verify the target org has Data Cloud and Tableau Next properly configured
 
-# examples
+# error.MultipleTemplatesFound
 
-- Display a template using its ID:
-  <%= config.bin %> <%= command.id %> --template-id 01RM0000000HwBGMA0
-- Display a template using its name:
-  <%= config.bin %> <%= command.id %> --template-name MyTemplate
+Multiple templates found with name "%s".
+
+# error.MultipleTemplatesFound.Actions
+
+- Use --template-id instead of --template-name for unique identification
+- Get the specific template ID using "sf orchestrator template list"
+- Template names should be unique, but this org may have duplicates
+
+# error.InvalidTemplateId
+
+Template ID "%s" is not valid.
+
+# error.InvalidTemplateId.Actions
+
+- Verify the template ID format is correct
+- Get valid template IDs using "sf orchestrator template list"
+- Template IDs should be 15 or 18 character Salesforce IDs

package/messages/appframework.list.app.md

@@ -1,74 +1,56 @@
 # summary
 
-List AppFramework apps in your org.
+List all orchestrated apps in the target org.
 
 # description
 
-Lists all AppFramework apps in your org. You can filter the results by template type and other criteria.
+List all orchestrated apps in your org with their key information including name, label, ID, type, and associated template details. This command helps you discover and manage existing apps in your organization.
 
-# flags.target-org.summary
-
-Login username or alias for the target org.
-
-# flags.target-org.description
-
-Overrides your default org.
-
-# flags.api-version.summary
-
-Override the api version used for api requests made by this command.
-
-# flags.api-version.description
-
-Override the api version used for api requests made by this command.
-
-# flags.filter-type.summary
+Apps are displayed in a table format showing their current status, creation details, and template associations. Use this information to understand your app inventory and make informed decisions about app management.
 
-Filter apps by template type.
+You must have Data Cloud and Tableau Next enabled in your org and the AppFrameworkViewApp user permission to view apps. This command works with production orgs, sandboxes, and scratch orgs.
 
-# flags.filter-type.description
-
-Only show apps with the specified template type, such as 'app', 'dashboard', or 'analytics'.
+# examples
 
-# flags.filter-subtype.summary
+- List all orchestrated apps in your default org:
 
-Filter apps by template subtype.
+  <%= config.bin %> <%= command.id %>
 
-# flags.filter-subtype.description
+- List apps in a specific org:
 
-Only show apps with the specified template subtype.
+  <%= config.bin %> <%= command.id %> --target-org myOrg
 
-# flags.json.summary
+- List apps using a specific API version:
 
-Format output as JSON.
+  <%= config.bin %> <%= command.id %> --api-version 64.0
 
-# flags.json.description
+- List apps in a sandbox org with specific API version:
 
-Format output as a JSON array of app records.
+  <%= config.bin %> <%= command.id %> --target-org mySandbox --api-version 60.0
 
-# flags.csv.summary
+# flags.target-org.summary
 
-Format output as CSV.
+Login username or alias for the target org.
 
-# flags.csv.description
+# flags.target-org.description
 
-Format output as CSV on the specified fields.
+The target org to connect to for listing apps. This org must have Data Cloud and Tableau Next enabled and you must have the AppFrameworkViewApp user permission to view apps.
 
-# flags.csv-fields.summary
+# flags.api-version.summary
 
-Fields to include when generating CSV output.
+Override the API version used for API requests.
 
-# flags.csv-fields.description
+# flags.api-version.description
 
-Specify a comma-separated list of field API names to include in the CSV output.
+Override the API version used for orchestrator API requests. Use this flag to specify a particular API version when the default version doesn't work with your org's configuration.
 
 # fetchingApps
 
-Fetching apps from AppFramework. This might take a moment...
+Fetching apps. This might take a moment...
 
 # noAppsFound
 
-No AppFramework apps found in the org.
+No orchestrated apps found in the org.
 
 # emptyFilteredApps
 
@@ -84,16 +66,9 @@ Failed to list apps: %s
 - Ensure your authentication to the org is valid
 - Try running with --debug for more details
 
-# examples
-
-- List all AppFramework apps in your default org:
-  <%= config.bin %> <%= command.id %>
-- List apps with a specific API version:
-  <%= config.bin %> <%= command.id %> --api-version=64.0
-
 # noResultsFound
 
-No AppFramework apps found in the org.
+No apps found in the org.
 
 # error.CertificateError
 
@@ -101,9 +76,10 @@ Certificate error: Unable to connect to the org. This is typically caused by an
 
 # error.CertificateError.Actions
 
-- Check your network connection and try again.
-- Ensure that your network is not blocking or intercepting HTTPS requests.
-- If you are behind a corporate proxy, ensure that your proxy certificates are properly configured.
+- Check your network connection and try again
+- Ensure that your network is not blocking or intercepting HTTPS requests
+- If you are behind a corporate proxy, ensure that your proxy certificates are properly configured
+- Try specifying the API version with --api-version
 
 # error.AuthenticationError
 
@@ -111,9 +87,10 @@ Authentication error: Unable to authenticate with the org. Please check your cre
 
 # error.AuthenticationError.Actions
 
-- Use `sf org login` to log in to the org again.
-- Ensure that your user has the necessary permissions to access the AppFramework API.
-- Check if your authentication token has expired.
+- Use "sf org login web" to log in to the org again
+- Ensure that your user has the necessary permissions to access the orchestration API
+- Check if your authentication token has expired
+- Verify the target org is correct and accessible
 
 # error.GenericError
 
@@ -121,6 +98,7 @@ An error occurred while listing apps: %s
 
 # error.GenericError.Actions
 
-- Check the error message above for more details.
-- Ensure that AppFramework is enabled in your org.
-- Ensure that your user has the necessary permissions.
+- Check the error message above for more details
+- Ensure that Data Cloud and Tableau Next are enabled in your org
+- Ensure that your user has the necessary permissions
+- Try running "sf org login web" to reauthenticate

package/messages/appframework.list.template.md

@@ -1,38 +1,82 @@
 # summary
 
-List all available AppFramework templates in the target org.
+List all available templates in the target org.
 
 # description
 
-Lists AppFramework templates available in the target org. Shows template name, label, ID and other information.
+Templates are reusable configurations that define the structure and settings for creating orchestrated apps. Use this command to discover available templates in your org before creating new apps.
+
+By default, this command only shows custom templates created in your org. Standard Salesforce-provided templates are filtered out to reduce noise. Use the --all flag to include all templates including the standard ones.
+
+Templates are displayed in a table format showing their name, label, ID, type, and other metadata. This information helps you choose the right template for your orchestrated app development.
+
+You must have Data Cloud and Tableau Next enabled in your org and the AppFrameworkViewApp user permission to view templates. This command works with production orgs, sandboxes, and scratch orgs.
+
+# examples
+
+- List all templates in your default org:
+
+  <%= config.bin %> <%= command.id %>
+
+- List templates in a specific org:
+
+  <%= config.bin %> <%= command.id %> --target-org myOrg
+
+- List templates using a specific API version:
+
+  <%= config.bin %> <%= command.id %> --api-version 64.0
+
+- List templates in a sandbox org with a specific API version:
+
+  <%= config.bin %> <%= command.id %> --target-org mySandbox --api-version 60.0
+
+- List all templates including standard Salesforce templates:
+
+  <%= config.bin %> <%= command.id %> --all
+
+- List all templates in a specific org:
+
+  <%= config.bin %> <%= command.id %> --target-org myOrg --all
 
 # flags.target-org.summary
 
-Login username or alias for the target org
+Login username or alias for the target org.
 
 # flags.target-org.description
 
-The target org to connect to for listing templates.
+The target org to connect to for listing templates. This org must have Data Cloud and Tableau Next enabled and you must have the AppFrameworkViewApp user permission to view templates.
 
 # flags.api-version.summary
 
-Override the api version used for api requests
+Override the API version used for API requests.
 
 # flags.api-version.description
 
-Override the api version used for api requests to the app framework.
+Override the API version used for orchestrator API requests. Use this flag to specify a particular API version when the default version doesn't work with your org's configuration.
+
+# flags.all.summary
+
+Show all templates including standard Salesforce templates.
+
+# flags.all.description
+
+By default, this command only shows custom templates created in your org. Use this flag to include the standard Salesforce-provided templates (those starting with 'sfdc_internal\_\_') in the results.
 
 # templatesFound
 
-Found %s AppFramework templates:
+Found %s templates:
 
 # noResultsFound
 
-No AppFramework templates found.
+No templates found.
+
+# noCustomTemplatesFound
+
+No custom templates found. Use --all to include standard Salesforce templates.
 
 # fetchingTemplates
 
-Fetching AppFramework templates...
+Fetching templates...
 
 # templateTypeLegend
 
@@ -40,39 +84,34 @@ Legend: %s, %s, %s - Other template types
 
 # error.CertificateError
 
-Error retrieving AppFramework templates: Certificate validation error
+Error retrieving templates: Certificate validation error.
 
 # error.CertificateError.Actions
 
 - This appears to be a certificate validation issue, which is common in dev environments
 - Try specifying the API version with --api-version=64.0 (or your org's version)
-- Make sure you're using the correct org with -o YOUR_ORG_ALIAS
+- Make sure you're using the correct org with --target-org YOUR_ORG_ALIAS
 - If using a sandbox or scratch org, ensure your connection is properly authenticated
 
 # error.AuthenticationError
 
-Error retrieving AppFramework templates: Authentication issue
+Error retrieving templates: Authentication issue.
 
 # error.AuthenticationError.Actions
 
 - Your session may have expired or you may not have permission to access this resource
-- Try running sf org refresh to update your credentials
-- Ensure you have AppFramework enabled and have permission to view templates
+- Try running "sf org login web" to reauthenticate
+- Ensure you have Data Cloud and Tableau Next enabled and have the AppFrameworkViewApp user permission to view templates
+- Verify the target org is correct and accessible
 
 # error.GenericError
 
-Error retrieving AppFramework templates: %s
+Error retrieving templates: %s
 
 # error.GenericError.Actions
 
-- Verify that you are using an org with AppFramework enabled
+- Verify that you are using an org with Data Cloud and Tableau Next enabled
 - Check that your credentials and permissions are valid
 - Check your internet connection
-- Try running sf org refresh to update your credentials
-
-# examples
-
-- List all AppFramework templates in your default org:
-  <%= config.bin %> <%= command.id %>
-- List templates with a specific API version:
-  <%= config.bin %> <%= command.id %> --api-version=64.0
+- Try running "sf org login web" to reauthenticate
+- Ensure the target org has Data Cloud and Tableau Next properly configured