template Commands

Create and manage Analytics templates.

• analytics template create

  Creates Analytics templates.

• analytics template delete

  Deletes Analytics templates.

• analytics template display

  Displays an Analytics template’s details.

• analytics template lint

  Performs a lint check on an Analytics template. Requires either the ID or API name of template.

• analytics template list

  Lists Analytics templates in the specified folder or target org.

• analytics template update

  Updates Analytics templates.

• analytics template validate

  Performs an org readiness check for an Analytics template. Requires either the ID or API name of template.

Creates Analytics templates.

sf analytics template create

[--json]

[--api-version APIVERSION]

-o TARGETORG

-f FOLDERID

[-r RECIPEIDS]

[-l LABEL]

[-d DATATRANSFORMIDS]

[--description DESCRIPTION]

--json

Optional

Format output as JSON.

Type: boolean

--api-version APIVERSION

Optional

Override the API version used for API requests made by this command.

Type: string

-o TARGETORG

Required

Username or alias of the target org. Not required if the target-org configuration variable is set.

Type: string

-f | --folderid FOLDERID

Required

The ID of the folder that contains the template data.

Type: id

-r | --recipeids RECIPEIDS

Optional

A comma-separated list of recipe IDs to include with the template.

Type: array

-l | --label LABEL

Optional

The label for the Analytics template (defaults to the app label).

Type: string

-d | --datatransformids DATATRANSFORMIDS

Optional

A comma-separated list of data transform IDs to include with the template.

Type: array

--description DESCRIPTION

Optional

The description for the Analytics template (defaults to the app description).

Type: string

Deletes Analytics templates.

sf analytics template delete

[--json]

[--api-version APIVERSION]

-o TARGETORG

-t TEMPLATEID

[--forcedelete]

[--decouple]

[-p]

--json

Optional

Format output as JSON.

Type: boolean

--api-version APIVERSION

Optional

Override the API version used for API requests made by this command.

Type: string

-o TARGETORG

Required

Username or alias of the target org. Not required if the target-org configuration variable is set.

Type: string

-t | --templateid TEMPLATEID

Required

The ID of the Analytics template.

Type: id

--forcedelete FORCEDELETE

Optional

Force deletes the Analytics template and all linked Analytics apps.

Type: boolean

--decouple DECOUPLE

Optional

Decouple all linked Analytics apps.

Type: boolean

-p | --noprompt NOPROMPT

Optional

Do not prompt to confirm force delete.

Type: boolean

Displays an Analytics template’s details.

sf analytics template display

[--json]

[--api-version APIVERSION]

-o TARGETORG

[-t TEMPLATEID]

[-n TEMPLATENAME]

--json

Optional

Format output as JSON.

Type: boolean

--api-version APIVERSION

Optional

Override the API version used for API requests made by this command.

Type: string

-o TARGETORG

Required

Username or alias of the target org. Not required if the target-org configuration variable is set.

Type: string

-t | --templateid TEMPLATEID

Optional

The ID of the Analytics template.

Type: id

-n | --templatename TEMPLATENAME

Optional

The name of the Analytics template.

Type: string

Performs a lint check on an Analytics template. Requires either the ID or API name of template.

sf analytics template lint

[--json]

[--api-version APIVERSION]

-o TARGETORG

[-n TEMPLATENAME]

[-t TEMPLATEID]

--json

Optional

Format output as JSON.

Type: boolean

--api-version APIVERSION

Optional

Override the API version used for API requests made by this command.

Type: string

-o TARGETORG

Required

Username or alias of the target org. Not required if the target-org configuration variable is set.

Type: string

-n | --templatename TEMPLATENAME

Optional

API name of the template to submit for lint check.

Type: string

-t | --templateid TEMPLATEID

Optional

ID of the template to submit for lint check.

Type: string

Lists Analytics templates in the specified folder or target org.

sf analytics template list

[--json]

[--api-version APIVERSION]

-o TARGETORG

[-a]

[-e]

--json

Optional

Format output as JSON.

Type: boolean

--api-version APIVERSION

Optional

Override the API version used for API requests made by this command.

Type: string

-o TARGETORG

Required

Username or alias of the target org. Not required if the target-org configuration variable is set.

Type: string

-a | --includesalesforcetemplates INCLUDESALESFORCETEMPLATES

Optional

Include Salesforce templates.

Type: boolean

-e | --includembeddedtemplates INCLUDEEMBEDDEDTEMPLATES

Optional

Include EmbeddedApp templates.

Type: boolean

Updates Analytics templates.

sf analytics template update

[--json]

[--api-version APIVERSION]

-o TARGETORG

[-t TEMPLATEID]

[-n TEMPLATENAME]

[-f FOLDERID]

[-r RECIPEIDS]

[-d DATATRANSFORMIDS]

[-v ASSETVERSION]

--json

Optional

Format output as JSON.

Type: boolean

--api-version APIVERSION

Optional

Override the API version used for API requests made by this command.

Type: string

-o TARGETORG

Required

Username or alias of the target org. Not required if the target-org configuration variable is set.

Type: string

-t | --templateid TEMPLATEID

Optional

The ID of the Analytics template.

Type: id

-n | --templatename TEMPLATENAME

Optional

The name of the Analytics template.

Type: string

-f | --folderid FOLDERID

Optional

The ID of the folder that contains the template data.

Type: id

-r | --recipeids RECIPEIDS

Optional

A comma-separated list of recipe IDs to include with the template.

Type: array

-d | --datatransformids DATATRANSFORMIDS

Optional

A comma-separated list of data transform IDs to include with the template.

Type: array

-v | --assetversion ASSETVERSION

Optional

Version number for upgrading the template.

Type: integer

Performs an org readiness check for an Analytics template. Requires either the ID or API name of template.

sf analytics template validate

[--json]

[--api-version APIVERSION]

-o TARGETORG

[-n TEMPLATENAME]

[-t TEMPLATEID]

[-f VALUESFILE]

--json

Optional

Format output as JSON.

Type: boolean

--api-version APIVERSION

Optional

Override the API version used for API requests made by this command.

Type: string

-o TARGETORG

Required

Username or alias of the target org. Not required if the target-org configuration variable is set.

Type: string

-n | --templatename TEMPLATENAME

Optional

API name of the template to run an org readiness check on.

Type: string

-t | --templateid TEMPLATEID

Optional

ID of the template to run an org readiness check on.

Type: string

-f | --valuesfile VALUESFILE

Optional

The file with values to override the template defaults with.

Type: filepath