@salesforce/analytics

Commands for working with Tableau CRM applications, assets, and services

Usage no npm install needed!

<script type="module">
  import salesforceAnalytics from 'https://cdn.skypack.dev/@salesforce/analytics';
</script>

README

plugin-analytics

NPM CircleCI Downloads/week License

A plugin for working with Tableau CRM analytics applications, assets, and services.

This plugin is used with the Salesforce CLI. For more information on the CLI, read the getting started guide.

See the Salesforce Analytics CLI Plugin Command Reference for more information about this plugin.

Install

We always recommend using the latest version of these commands bundled with the CLI, however, you can install a specific version or tag if needed.

Install the latest version:

sfdx plugins:install @salesforce/analytics

Install a specific version:

sfdx plugins:install @salesforce/analytics@x.y.z

Issues

Please report any issues at https://github.com/forcedotcom/analyticsdx-vscode/issues

Contributing

  1. Please read our Code of Conduct
  2. Create a new issue before starting your project so that we can keep track of what you are trying to add/fix. That way, we can also offer suggestions or let you know if there is already an effort in progress.
  3. Fork this repository.
  4. Build the plugin locally
  5. Create a topic branch in your fork. Note, this step is recommended but technically not required if contributing using a fork.
  6. Edit the code in your fork. It is recommended to use Visual Studio Code, which will be automatically configured for building, linting, and formatting.
  7. Write appropriate tests for your changes. Try to achieve at least 95% code coverage on any new code. No pull request will be accepted without unit tests.
  8. Sign CLA (see CLA below).
  9. Send us a pull request when you are done. We'll review your code, suggest any needed changes, and merge it in.

CLA

External contributors will be required to sign a Contributor's License Agreement. You can do so by going to https://cla.salesforce.com/sign-cla.

Build

To build the plugin locally, make sure to have yarn installed and run the following commands:

# Clone the repository
git clone git@github.com:salesforcecli/plugin-analytics

# Install the dependencies and compile
yarn install
yarn build

To use your plugin, run using the local ./bin/run or ./bin/run.cmd file.

# Run using local run file.
./bin/run analytics

There should be no differences when running via the Salesforce CLI or using the local run file. However, it can be useful to link the plugin to do some additional testing or run your commands from anywhere on your machine.

# Link your plugin to the sfdx cli
sfdx plugins:link .
# To verify
sfdx plugins

Commands

sfdx analytics:app:create [-f <filepath> | -m <string> | -t <string>] [-n <string>] [-a] [-v] [-w <number>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

create a Tableau CRM app

USAGE
  $ sfdx analytics:app:create [-f <filepath> | -m <string> | -t <string>] [-n <string>] [-a] [-v] [-w <number>] [-u 
  <string>] [--apiversion <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -a, --async                                                                       create app asynchronously

  -f, --definitionfile=definitionfile                                               Tableau CRM template definition
                                                                                    file; required unless --templateid
                                                                                    is specified

  -m, --templatename=templatename                                                   template name

  -n, --appname=appname                                                             app name

  -t, --templateid=templateid                                                       template ID; required unless
                                                                                    --definitionfile is specified

  -u, --targetusername=targetusername                                               username or alias for the target
                                                                                    org; overrides default target org

  -v, --allevents                                                                   verbose display of all app create
                                                                                    events

  -w, --wait=wait                                                                   [default: 10] wait time in minutes
                                                                                    for streaming app creation events

  --apiversion=apiversion                                                           override the api version used for
                                                                                    api requests made by this command

  --json                                                                            format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this command invocation

EXAMPLES
  $ sfdx analytics:app:create -t templateid -n appname
  $ sfdx analytics:app:create -m templatename
  $ sfdx analytics:app:create -f path_to_json_file

See code: src/commands/analytics/app/create.ts

sfdx analytics:app:decouple -f <id> -t <id> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

decouples a Tableau CRM app from a Tableau CRM template

USAGE
  $ sfdx analytics:app:decouple -f <id> -t <id> [-u <string>] [--apiversion <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -f, --folderid=folderid                                                           (required) folder ID
  -t, --templateid=templateid                                                       (required) template ID

  -u, --targetusername=targetusername                                               username or alias for the target
                                                                                    org; overrides default target org

  --apiversion=apiversion                                                           override the api version used for
                                                                                    api requests made by this command

  --json                                                                            format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this command invocation

EXAMPLE
  $ sfdx analytics:app:decouple -f folderId -t templateId

See code: src/commands/analytics/app/decouple.ts

sfdx analytics:app:delete -f <id> [-p] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

delete Tableau CRM apps

USAGE
  $ sfdx analytics:app:delete -f <id> [-p] [-u <string>] [--apiversion <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -f, --folderid=folderid                                                           (required) folder ID

  -p, --noprompt                                                                    do not prompt to confirm force
                                                                                    delete

  -u, --targetusername=targetusername                                               username or alias for the target
                                                                                    org; overrides default target org

  --apiversion=apiversion                                                           override the api version used for
                                                                                    api requests made by this command

  --json                                                                            format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this command invocation

EXAMPLE
  $ sfdx analytics:app:delete -f folderid

See code: src/commands/analytics/app/delete.ts

sfdx analytics:app:display -f <id> [-a] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

displays a Tableau CRM app's details

USAGE
  $ sfdx analytics:app:display -f <id> [-a] [-u <string>] [--apiversion <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -a, --applog                                                                      specify to include app creation log
                                                                                    details

  -f, --folderid=folderid                                                           (required) folder ID

  -u, --targetusername=targetusername                                               username or alias for the target
                                                                                    org; overrides default target org

  --apiversion=apiversion                                                           override the api version used for
                                                                                    api requests made by this command

  --json                                                                            format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this command invocation

EXAMPLE
  $ sfdx analytics:app:display -f folderId -a

See code: src/commands/analytics/app/display.ts

sfdx analytics:app:list [-f <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

list Tableau CRM apps

USAGE
  $ sfdx analytics:app:list [-f <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -f, --folderid=folderid                                                           folder ID

  -u, --targetusername=targetusername                                               username or alias for the target
                                                                                    org; overrides default target org

  --apiversion=apiversion                                                           override the api version used for
                                                                                    api requests made by this command

  --json                                                                            format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this command invocation

EXAMPLE
  $ sfdx analytics:app:list

See code: src/commands/analytics/app/list.ts

sfdx analytics:app:update -t <id> -f <id> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

updates a Tableau CRM app from a template

USAGE
  $ sfdx analytics:app:update -t <id> -f <id> [-u <string>] [--apiversion <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -f, --folderid=folderid                                                           (required) folder ID
  -t, --templateid=templateid                                                       (required) template ID

  -u, --targetusername=targetusername                                               username or alias for the target
                                                                                    org; overrides default target org

  --apiversion=apiversion                                                           override the api version used for
                                                                                    api requests made by this command

  --json                                                                            format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this command invocation

EXAMPLE
  $ sfdx analytics:app:update -f folderId -t templateId

See code: src/commands/analytics/app/update.ts

sfdx analytics:asset:publisher:create -i <id> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

create a publisher record for the Tableau CRM asset

USAGE
  $ sfdx analytics:asset:publisher:create -i <id> [-u <string>] [--apiversion <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -i, --assetid=assetid                                                             (required) Asset ID under
                                                                                    development

  -u, --targetusername=targetusername                                               username or alias for the target
                                                                                    org; overrides default target org

  --apiversion=apiversion                                                           override the api version used for
                                                                                    api requests made by this command

  --json                                                                            format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this command invocation

EXAMPLE
  $ sfdx analytics:asset:publisher:create -i assetId

See code: src/commands/analytics/asset/publisher/create.ts

sfdx analytics:asset:publisher:delete -i <id> -a <id> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

delete a Tableau CRM asset publisher

USAGE
  $ sfdx analytics:asset:publisher:delete -i <id> -a <id> [-u <string>] [--apiversion <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -a, --assetid=assetid                                                             (required) Asset ID under
                                                                                    development

  -i, --id=id                                                                       (required) Asset Publisher ID under
                                                                                    development

  -u, --targetusername=targetusername                                               username or alias for the target
                                                                                    org; overrides default target org

  --apiversion=apiversion                                                           override the api version used for
                                                                                    api requests made by this command

  --json                                                                            format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this command invocation

EXAMPLE
  $ sfdx analytics:asset:publisher:delete -a assetId -i assetPublisherId

See code: src/commands/analytics/asset/publisher/delete.ts

sfdx analytics:asset:publisher:deleteall -i <id> [-p] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

delete Tableau CRM asset publishers

USAGE
  $ sfdx analytics:asset:publisher:deleteall -i <id> [-p] [-u <string>] [--apiversion <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -i, --assetid=assetid                                                             (required) Asset ID under
                                                                                    development

  -p, --noprompt                                                                    do not prompt to confirm force
                                                                                    delete

  -u, --targetusername=targetusername                                               username or alias for the target
                                                                                    org; overrides default target org

  --apiversion=apiversion                                                           override the api version used for
                                                                                    api requests made by this command

  --json                                                                            format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this command invocation

EXAMPLE
  $ sfdx analytics:asset:publisher:deleteall -i assetId

See code: src/commands/analytics/asset/publisher/deleteall.ts

sfdx analytics:asset:publisher:list -i <id> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

list Tableau CRM asset publishers

USAGE
  $ sfdx analytics:asset:publisher:list -i <id> [-u <string>] [--apiversion <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -i, --assetid=assetid                                                             (required) Asset ID under
                                                                                    development

  -u, --targetusername=targetusername                                               username or alias for the target
                                                                                    org; overrides default target org

  --apiversion=apiversion                                                           override the api version used for
                                                                                    api requests made by this command

  --json                                                                            format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this command invocation

EXAMPLE
  $ sfdx analytics:asset:publisher:list -i assetId

See code: src/commands/analytics/asset/publisher/list.ts

sfdx analytics:autoinstall:app:create [-t <id> | -n <string>] [-a] [-w <number>] [-p <number>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

creates auto-install request to create Tableau CRM app

USAGE
  $ sfdx analytics:autoinstall:app:create [-t <id> | -n <string>] [-a] [-w <number>] [-p <number>] [-u <string>] 
  [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -a, --async                                                                       create app asynchronously
  -n, --templatename=templatename                                                   template api name

  -p, --pollinterval=pollinterval                                                   [default: 5000] polling interval in
                                                                                    milliseconds for checking
                                                                                    auto-install request status

  -t, --templateid=templateid                                                       template ID

  -u, --targetusername=targetusername                                               username or alias for the target
                                                                                    org; overrides default target org

  -w, --wait=wait                                                                   [default: 10] wait time in minutes
                                                                                    for auto-install request to finish

  --apiversion=apiversion                                                           override the api version used for
                                                                                    api requests made by this command

  --json                                                                            format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this command invocation

EXAMPLES
  $ sfdx analytics:autoinstall:app:create -t templateid
  $ sfdx analytics:autoinstall:app:create -n templatename

See code: src/commands/analytics/autoinstall/app/create.ts

sfdx analytics:autoinstall:app:delete -f <id> [-a] [-w <number>] [-p <number>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

creates auto-install request to delete Tableau CRM app

USAGE
  $ sfdx analytics:autoinstall:app:delete -f <id> [-a] [-w <number>] [-p <number>] [-u <string>] [--apiversion <string>]
   [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -a, --async                                                                       delete app asynchronously
  -f, --folderid=folderid                                                           (required) folder ID

  -p, --pollinterval=pollinterval                                                   [default: 5000] polling interval in
                                                                                    milliseconds for checking
                                                                                    auto-install request status

  -u, --targetusername=targetusername                                               username or alias for the target
                                                                                    org; overrides default target org

  -w, --wait=wait                                                                   [default: 10] wait time in minutes
                                                                                    for auto-install request to finish

  --apiversion=apiversion                                                           override the api version used for
                                                                                    api requests made by this command

  --json                                                                            format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this command invocation

EXAMPLE
  $ sfdx analytics:autoinstall:app:delete -f folderid

See code: src/commands/analytics/autoinstall/app/delete.ts

sfdx analytics:autoinstall:app:update -f <id> [-t <id> | -n <string>] [-a] [-w <number>] [-p <number>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

creates auto-install request to update Tableau CRM app

USAGE
  $ sfdx analytics:autoinstall:app:update -f <id> [-t <id> | -n <string>] [-a] [-w <number>] [-p <number>] [-u <string>]
   [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -a, --async                                                                       update app asynchronously
  -f, --folderid=folderid                                                           (required) folder ID
  -n, --templatename=templatename                                                   template api name

  -p, --pollinterval=pollinterval                                                   [default: 5000] polling interval in
                                                                                    milliseconds for checking
                                                                                    auto-install request status

  -t, --templateid=templateid                                                       template ID

  -u, --targetusername=targetusername                                               username or alias for the target
                                                                                    org; overrides default target org

  -w, --wait=wait                                                                   [default: 10] wait time in minutes
                                                                                    for auto-install request to finish

  --apiversion=apiversion                                                           override the api version used for
                                                                                    api requests made by this command

  --json                                                                            format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this command invocation

EXAMPLES
  $ sfdx analytics:autoinstall:app:update -t templateid -f folderid
  $ sfdx analytics:autoinstall:app:update -n templatename -f folderid

See code: src/commands/analytics/autoinstall/app/update.ts

sfdx analytics:autoinstall:display -i <id> [-a] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

displays a Tableau CRM auto-install request details

USAGE
  $ sfdx analytics:autoinstall:display -i <id> [-a] [-u <string>] [--apiversion <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -a, --applog                                                                      specify to include app creation log
                                                                                    details

  -i, --autoinstallid=autoinstallid                                                 (required) auto-install request ID

  -u, --targetusername=targetusername                                               username or alias for the target
                                                                                    org; overrides default target org

  --apiversion=apiversion                                                           override the api version used for
                                                                                    api requests made by this command

  --json                                                                            format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this command invocation

EXAMPLE
  $ sfdx analytics:autoinstall:display -i id

See code: src/commands/analytics/autoinstall/display.ts

sfdx analytics:autoinstall:list [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

list Tableau CRM auto-install requests

USAGE
  $ sfdx analytics:autoinstall:list [-u <string>] [--apiversion <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -u, --targetusername=targetusername                                               username or alias for the target
                                                                                    org; overrides default target org

  --apiversion=apiversion                                                           override the api version used for
                                                                                    api requests made by this command

  --json                                                                            format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this command invocation

EXAMPLE
  $ sfdx analytics:autoinstall:list

See code: src/commands/analytics/autoinstall/list.ts

sfdx analytics:dashboard:history:list -i <id> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

list history records for Tableau CRM dashboards

USAGE
  $ sfdx analytics:dashboard:history:list -i <id> [-u <string>] [--apiversion <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -i, --dashboardid=dashboardid                                                     (required) dashboard ID

  -u, --targetusername=targetusername                                               username or alias for the target
                                                                                    org; overrides default target org

  --apiversion=apiversion                                                           override the api version used for
                                                                                    api requests made by this command

  --json                                                                            format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this command invocation

EXAMPLE
  $ sfdx analytics:dashboard:history:list --dashboardid <dashboardid>

See code: src/commands/analytics/dashboard/history/list.ts

sfdx analytics:dashboard:history:revert -i <id> -y <id> [-l <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

revert to specified history record

USAGE
  $ sfdx analytics:dashboard:history:revert -i <id> -y <id> [-l <string>] [-u <string>] [--apiversion <string>] [--json]
   [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -i, --dashboardid=dashboardid                                                     (required) dashboard ID

  -l, --label=label                                                                 label for new reverted history
                                                                                    record

  -u, --targetusername=targetusername                                               username or alias for the target
                                                                                    org; overrides default target org

  -y, --historyid=historyid                                                         (required) dashboard history ID

  --apiversion=apiversion                                                           override the api version used for
                                                                                    api requests made by this command

  --json                                                                            format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this command invocation

EXAMPLE
  $ sfdx analytics:dashboard:history:revert -i <dashboardid> -y <historyid> -l <historyLabel>

See code: src/commands/analytics/dashboard/history/revert.ts

sfdx analytics:dashboard:list [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

list Tableau CRM dashboards

USAGE
  $ sfdx analytics:dashboard:list [-u <string>] [--apiversion <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -u, --targetusername=targetusername                                               username or alias for the target
                                                                                    org; overrides default target org

  --apiversion=apiversion                                                           override the api version used for
                                                                                    api requests made by this command

  --json                                                                            format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this command invocation

EXAMPLE
  $ sfdx analytics:dashboard:list

See code: src/commands/analytics/dashboard/list.ts

sfdx analytics:dashboard:update -i <id> [-y <id>] [-r] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

updates a Tableau CRM dashboard

USAGE
  $ sfdx analytics:dashboard:update -i <id> [-y <id>] [-r] [-u <string>] [--apiversion <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -i, --dashboardid=dashboardid                                                     (required) Dashboard ID

  -r, --removecurrenthistory                                                        Remove Current History ID from
                                                                                    dashboard

  -u, --targetusername=targetusername                                               username or alias for the target
                                                                                    org; overrides default target org

  -y, --currenthistoryid=currenthistoryid                                           Current History ID to display

  --apiversion=apiversion                                                           override the api version used for
                                                                                    api requests made by this command

  --json                                                                            format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this command invocation

EXAMPLES
  $ sfdx analytics:dashboard:update -i dashboardId -y currentHistoryId
  $ sfdx analytics:dashboard:update -i dashboardId -r

See code: src/commands/analytics/dashboard/update.ts

sfdx analytics:dataflow:history:list -i <id> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

list history records for Tableau CRM dataflows

USAGE
  $ sfdx analytics:dataflow:history:list -i <id> [-u <string>] [--apiversion <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -i, --dataflowid=dataflowid                                                       (required) dataflow ID

  -u, --targetusername=targetusername                                               username or alias for the target
                                                                                    org; overrides default target org

  --apiversion=apiversion                                                           override the api version used for
                                                                                    api requests made by this command

  --json                                                                            format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this command invocation

EXAMPLE
  $ sfdx analytics:dataflow:history:list --dataflowid <dataflowid>

See code: src/commands/analytics/dataflow/history/list.ts

sfdx analytics:dataflow:history:revert -i <id> -y <id> [-l <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

revert to specified history record

USAGE
  $ sfdx analytics:dataflow:history:revert -i <id> -y <id> [-l <string>] [-u <string>] [--apiversion <string>] [--json] 
  [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -i, --dataflowid=dataflowid                                                       (required) dataflow ID

  -l, --label=label                                                                 label for new reverted history
                                                                                    record

  -u, --targetusername=targetusername                                               username or alias for the target
                                                                                    org; overrides default target org

  -y, --historyid=historyid                                                         (required) dataflow history ID

  --apiversion=apiversion                                                           override the api version used for
                                                                                    api requests made by this command

  --json                                                                            format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this command invocation

EXAMPLE
  $ sfdx analytics:dataflow:history:revert -i <dataflowid> -y <historyid> -l <historyLabel>

See code: src/commands/analytics/dataflow/history/revert.ts

sfdx analytics:dataflow:list [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

list Tableau CRM dataflows

USAGE
  $ sfdx analytics:dataflow:list [-u <string>] [--apiversion <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -u, --targetusername=targetusername                                               username or alias for the target
                                                                                    org; overrides default target org

  --apiversion=apiversion                                                           override the api version used for
                                                                                    api requests made by this command

  --json                                                                            format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this command invocation

EXAMPLE
  $ sfdx analytics:dataflow:list

See code: src/commands/analytics/dataflow/list.ts

sfdx analytics:dataset:display [-i <id> | -n <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

displays a Tableau CRM dataset's details

USAGE
  $ sfdx analytics:dataset:display [-i <id> | -n <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -i, --datasetid=datasetid                                                         dataset ID
  -n, --datasetname=datasetname                                                     dataset api name

  -u, --targetusername=targetusername                                               username or alias for the target
                                                                                    org; overrides default target org

  --apiversion=apiversion                                                           override the api version used for
                                                                                    api requests made by this command

  --json                                                                            format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this command invocation

EXAMPLES
  $ sfdx analytics:dataset:display -i datasetId
  $ sfdx analytics:dataset:display -n datasetApiName

See code: src/commands/analytics/dataset/display.ts

sfdx analytics:dataset:list [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

list Tableau CRM datasets

USAGE
  $ sfdx analytics:dataset:list [-u <string>] [--apiversion <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -u, --targetusername=targetusername                                               username or alias for the target
                                                                                    org; overrides default target org

  --apiversion=apiversion                                                           override the api version used for
                                                                                    api requests made by this command

  --json                                                                            format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this command invocation

EXAMPLE
  $ sfdx analytics:dataset:list

See code: src/commands/analytics/dataset/list.ts

sfdx analytics:dataset:rows:fetch [-i <id> | -n <string>] [--limit <number>] [-r human|csv|json] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

fetch the rows of a Tableau CRM dataset

USAGE
  $ sfdx analytics:dataset:rows:fetch [-i <id> | -n <string>] [--limit <number>] [-r human|csv|json] [-u <string>] 
  [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -i, --datasetid=datasetid                                                         dataset ID
  -n, --datasetname=datasetname                                                     dataset api name

  -r, --resultformat=(human|csv|json)                                               [default: human] result format
                                                                                    emitted to stdout

  -u, --targetusername=targetusername                                               username or alias for the target
                                                                                    org; overrides default target org

  --apiversion=apiversion                                                           override the api version used for
                                                                                    api requests made by this command

  --json                                                                            format output as json

  --limit=limit                                                                     maximum number of rows to include

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this command invocation

EXAMPLES
  $ sfdx analytics:dataset:rows:fetch -i datasetId
  $ sfdx analytics:dataset:rows:fetch -n datasetApiName -r csv

See code: src/commands/analytics/dataset/rows/fetch.ts

sfdx analytics:enable [-a] [-w <number>] [-p <number>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

enable Tableau CRM

USAGE
  $ sfdx analytics:enable [-a] [-w <number>] [-p <number>] [-u <string>] [--apiversion <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -a, --async                                                                       enable asynchronously

  -p, --pollinterval=pollinterval                                                   [default: 5000] polling interval in
                                                                                    milliseconds for checking
                                                                                    auto-install request status

  -u, --targetusername=targetusername                                               username or alias for the target
                                                                                    org; overrides default target org

  -w, --wait=wait                                                                   [default: 10] wait time in minutes
                                                                                    for auto-install request to finish

  --apiversion=apiversion                                                           override the api version used for
                                                                                    api requests made by this command

  --json                                                                            format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this command invocation

EXAMPLE
  $ sfdx analytics:enable

See code: src/commands/analytics/enable.ts

sfdx analytics:lens:history:list -i <id> [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

list history records for Tableau CRM lenses

USAGE
  $ sfdx analytics:lens:history:list -i <id> [-u <string>] [--apiversion <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -i, --lensid=lensid                                                               (required) lens ID

  -u, --targetusername=targetusername                                               username or alias for the target
                                                                                    org; overrides default target org

  --apiversion=apiversion                                                           override the api version used for
                                                                                    api requests made by this command

  --json                                                                            format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this co