Skip to content

W-19149055: Edit messages for the 10 new "orchestrator" commands #62

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: viera/messageUpdates
Choose a base branch
from
Open

W-19149055: Edit messages for the 10 new "orchestrator" commands #62

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 32 additions & 44 deletions messages/appframework.create.app.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,39 +16,35 @@ You must have Data Cloud and Tableau Next enabled in your org and the AppFramewo

- Create an app from a template by ID:

<%= config.bin %> <%= command.id %> --target-org myOrg --name "my_app" --template-id 01t000000000123
<%= config.bin %> <%= command.id %> --target-org myOrg --name my_app --template-id 01t000000000123

- Create an app from a template by name:

<%= config.bin %> <%= command.id %> --target-org myOrg --name "sales_app" --template-name "Sales_Template"
<%= config.bin %> <%= command.id %> --target-org myOrg --name sales_app --template-name Sales_Template

- Create an app with a custom label and description:

<%= config.bin %> <%= command.id %> --target-org myOrg --name "analytics_app" --template-name "Analytics_Template" --label "My Analytics App" --description "Custom analytics app"
<%= config.bin %> <%= command.id %> --target-org myOrg --name analytics_app --template-name Analytics_Template --label "My Analytics App" --description "Custom analytics app"

- Create an app with specific runtime configuration:

<%= config.bin %> <%= command.id %> --target-org myOrg --name "dashboard_app" --template-id 01t000000000456 --runtime-method async --log-level debug
<%= config.bin %> <%= command.id %> --target-org myOrg --name dashboard_app --template-id 01t000000000456 --runtime-method async --log-level debug

- Create an app using a specific API version:

<%= config.bin %> <%= command.id %> --target-org mySandbox --name "test_app" --template-name "Test Template" --api-version 60.0
<%= config.bin %> <%= command.id %> --target-org mySandbox --name test_app --template-name "Test Template" --api-version 60.0

# flags.target-org.summary

Login username or alias for the target org.

# flags.target-org.description

The target org to connect to for creating the app. This org must have Data Cloud and Tableau Next enabled and you must have the AppFrameworkManageApp user permission to create apps. The template must also exist in this org.
Login username or alias for the target org. Not required if the `target-org` configuration variable is already set.

# flags.api-version.summary

Override the API version used for API requests.
Override the API version used for orchestrator API requests.

# flags.api-version.description

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.
Use this flag to specify a particular API version when the default version doesn't work with your org's configuration.

# flags.name.summary

Expand Down Expand Up @@ -78,33 +74,25 @@ A description of what the app does and its intended use case. This helps users u

ID of the template to use for creating the app.

# flags.template-id.description

The unique identifier of the template to use for generating the new app.

# flags.template-name.summary

Name of the template to use for creating the app.

# flags.template-name.description

The name of the template to use for generating the new app.

# flags.runtime-method.summary

Runtime method for the app.

# flags.runtime-method.description

Specifies the runtime method for the app execution. This affects how the app processes data and handles user interactions. Valid values are 'sync' and 'async'.
Specifies the runtime method for the app execution. This affects how the app processes data and handles user interactions.

# flags.log-level.summary

Log level for the app.

# flags.log-level.description

Sets the logging level for the app. This controls how much diagnostic information is captured during app execution. Valid values are 'debug', 'info', 'warn', and 'error'.
Sets the logging level for the app. This controls how much diagnostic information is captured during app execution.

# noTemplateSpecified

Expand All @@ -120,59 +108,59 @@ Creating app from template...

# createSuccess

Successfully created app with ID: %s
Successfully created app with ID: %s.

# error.MissingRequiredFlag

Either --template-id or --template-name must be provided.

# error.MissingRequiredFlag.Actions

- 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"
- 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.TemplateNotFound

Template not found.

# error.TemplateNotFound.Actions

- Verify the template ID or name is correct
- Use "sf orchestrator template list" to see available templates
- Check your permissions to view templates
- Make sure you're connected to the correct org with --target-org
- Verify the template ID or name is correct.
- Use "sf orchestrator template list" to see available templates.
- Check your permissions to view templates.
- Make sure you're connected to the correct org with --target-org.

# error.AppCreationError

Failed to create app: %s
Failed to create app: %s.

# error.AppCreationError.Actions

- Verify that you have permission to create apps in the target org
- Ensure the app name is unique within your org
- Check that Data Cloud and Tableau Next are enabled in your org
- Verify your authentication and org connection are valid
- Try using a different API version with --api-version
- Verify that you have permission to create apps in the target org.
- Ensure the app name is unique within your org.
- Check that Data Cloud and Tableau Next are enabled in your org.
- Verify your authentication and org connection are valid.
- Try using a different API version with --api-version.

# error.InvalidAppName

App name "%s" is invalid or already exists.

# error.InvalidAppName.Actions

- Choose a unique name that doesn't exist in your org
- Ensure the name follows your org's naming conventions
- Use "sf orchestrator app list" to see existing app names
- Avoid special characters and spaces in app names
- Choose a unique name that doesn't exist in your org.
- Ensure the name follows your org's naming conventions.
- Use "sf orchestrator app list" to see existing app names.
- Avoid special characters and spaces in app names.

# error.InsufficientPermissions

You don't have permission to create apps in this org.

# error.InsufficientPermissions.Actions

- Contact your Salesforce admin to request app creation permissions
- Verify you're connected to the correct org with --target-org
- Check that Data Cloud and Tableau Next are enabled in your org
- Check that your user profile has the AppFrameworkManageApp user permission
- Contact your Salesforce admin to request app creation permissions.
- Verify you're connected to the correct org with --target-org.
- Check that Data Cloud and Tableau Next are enabled in your org.
- Check that your user profile has the AppFrameworkManageApp user permission.
58 changes: 27 additions & 31 deletions messages/appframework.create.template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,39 +14,35 @@ You must have Data Cloud and Tableau Next enabled in your org and the AppFramewo

- Create a basic app template:

<%= config.bin %> <%= command.id %> --target-org myOrg --name "my_template"
<%= config.bin %> <%= command.id %> --target-org myOrg --name my_template

- Create a template with a label for better identification:

<%= config.bin %> <%= command.id %> --target-org myOrg --name "sales_template" --label "Sales Analytics Template"
<%= config.bin %> <%= command.id %> --target-org myOrg --name sales_template --label "Sales Analytics Template"

- Create a dashboard template with a specific subtype:

<%= config.bin %> <%= command.id %> --target-org myOrg --name "dashboard_template" --type dashboard --subtype "analytics"
<%= config.bin %> <%= command.id %> --target-org myOrg --name dashboard_template --type dashboard --subtype analytics

- Create a comprehensive template with all metadata:

<%= config.bin %> <%= command.id %> --target-org myOrg --name "analytics_template" --type app --subtype "tableau" --label "Sales Template" --description "Template for sales analytics apps"
<%= config.bin %> <%= command.id %> --target-org myOrg --name analytics_template --type app --subtype tableau --label "Sales Template" --description "Template for sales analytics apps"

- Create a template using a specific API version:

<%= config.bin %> <%= command.id %> --target-org myOrg --name "legacy_template" --api-version 60.0
<%= config.bin %> <%= command.id %> --target-org myOrg --name legacy_template --api-version 60.0

# flags.target-org.summary

Login username or alias for the target org.

# flags.target-org.description

The target org to connect to for creating the template. This org must have Data Cloud and Tableau Next enabled and you must have the AppFrameworkManageApp user permission to create templates.
Login username or alias for the target org. Not required if the `target-org` configuration variable is already set.

# flags.api-version.summary

Override the API version used for API requests.
Override the API version used for orchestrator API requests.

# flags.api-version.description

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.
Use this flag to specify a particular API version when the default version doesn't work with your org's configuration.

# flags.name.summary

Expand All @@ -62,31 +58,31 @@ Type of template to create.

# flags.type.description

Specifies the type of template to create. Valid values are 'app', 'component', 'dashboard', or 'lens'. Defaults to 'app' if not specified. Choose the type that matches your intended use case for the template.
Specifies the type of template to create. Choose the type that matches your intended use case for the template.

# flags.subtype.summary

Subtype for the template.

# flags.subtype.description

An optional subtype categorization for the template (e.g., 'tableau' for app templates). Subtypes help organize templates and provide additional context about their intended use or underlying technology.
An optional subtype categorization for the template, such as 'tableau' for app templates. Subtypes help organize templates and provide additional context about their intended use or underlying technology.

# flags.label.summary

Label for the new template.

# flags.label.description

A human-readable label for the template. This is displayed in Tableau Next and helps users identify the template's purpose. Use clear, descriptive labels that explain what the template does.
A human-readable label for the template. This label is displayed in Tableau Next and helps users identify the template's purpose. Use clear, descriptive labels that explain what the template does.

# flags.description.summary

Description of the new template.

# flags.description.description

A description of what the template does and its intended use case. This is displayed in Tableau Next and helps users understand when to use this template. Include information about the template's purpose, features, and any prerequisites.
A description of what the template does and its intended use case. This description is displayed in Tableau Next and helps users understand when to use this template. Include information about the template's purpose, features, and any prerequisites.

# fetchingApp

Expand All @@ -98,38 +94,38 @@ Creating template from app...

# createSuccess

Successfully created template with ID: %s
Successfully created template with ID: %s.

# error.TemplateCreationError

Error creating template: %s
Error creating template: %s.

# error.TemplateCreationError.Actions

- Verify that you have permission to create templates in the target org
- Ensure the template name is unique within your org
- Check that Data Cloud and Tableau Next are enabled in your org
- Verify your authentication and org connection are valid
- Try using a different API version with --api-version
- Verify that you have permission to create templates in the target org.
- Ensure the template name is unique within your org.
- Check that Data Cloud and Tableau Next are enabled in your org.
- Verify your authentication and org connection are valid.
- Try using a different API version with --api-version.

# error.InvalidTemplateName

Template name "%s" is invalid or already exists.

# error.InvalidTemplateName.Actions

- Choose a unique name that doesn't exist in your org
- Ensure the name follows your org's naming conventions
- Use "sf orchestrator template list" to see existing template names
- Avoid special characters and spaces in template names
- Choose a unique name that doesn't exist in your org.
- Ensure the name follows your org's naming conventions.
- Use "sf orchestrator template list" to see existing template names.
- Avoid special characters and spaces in template names.

# error.InsufficientPermissions

You don't have permission to create templates in this org.

# error.InsufficientPermissions.Actions

- Contact your Salesforce admin to request template creation permissions
- Verify you're connected to the correct org with --target-org
- Check that Data Cloud and Tableau Next are enabled in your org
- Check that your user profile has the AppFrameworkManageApp permission
- Contact your Salesforce admin to request template creation permissions.
- Verify you're connected to the correct org with --target-org.
- Check that Data Cloud and Tableau Next are enabled in your org.
- Check that your user profile has the AppFrameworkManageApp permission.
Loading