Bi Dev Guide Cli Reference
DOWNLOAD
First things first !
To download this implementation guide, click the download button below.
If you need more information about the implementation guide, you can read the Table of Contents below.
Salesforce Analytics Plugin CLI
Command Reference
Salesforce Spring
salesforcedocs
Last updated November
Copyright Salesforce Inc All rights reserved Salesforce is a registered trademark of Salesforce Inc as are other
names and marks Other marks appearing herein may be trademarks of their respective owners
CONTENTS
Salesforce Analytics CLI Plugin Command Reference
analytics sf Command Reference
analytics sfdx Command Reference
Help for Salesforce CLI Commands
CLI Deprecation Policy
SALESFORCE ANALYTICS CLI PLUGIN COMMAND
REFERENCE
The command reference contains information about the Salesforce CLI commands for the Analytics plugin and their parameters This
version of the command reference includes details about version of Salesforce CLI and the following plugin versions
salesforceanalytics plugin version
For information about installing Salesforce CLI see the Salesforce DX Setup Guide
For information about installing Analytics CLI plugin see Install the Analytics CLI Plugin
For information about Salesforce CLI changes see the Salesforce CLI Release Notes
analytics sf Command Reference
An alphabetized list of sf CLI commands for Analytics developers to use with Salesforce DX
analytics sfdx Command Reference
An alphabetized list of sfdx CLI commands for Analytics developers to use with Salesforce DX
Help for Salesforce CLI Commands
The h help parameter shows details about Salesforce CLI topics and their commands
CLI Deprecation Policy
Salesforce deprecates CLI commands and flags when for example the underlying API changes
analytics sf Command Reference
An alphabetized list of sf CLI commands for Analytics developers to use with Salesforce DX
analytics enable
Enable Analytics
analytics query
Execute an Analytics query
app Commands
Create and manage Analytics apps
asset Commands
Manage Analytics asset publishing
autoinstall Commands
Manage Analytics autoinstall requests
dashboard Commands
Manage Analytics dashboards
dataflow Commands
Manage Analytics dataflows and dataflow jobs
dataset Commands
Manage Analytics datasets
Salesforce Analytics CLI Plugin Command Reference
analytics enable
generate Commands
Generate simple Analytics assets
lens Commands
Manage Analytics lenses
recipe Commands
Manage Analytics recipes
template Commands
Create and manage Analytics templates
analytics enable
Enable Analytics
Examples for analytics enable
sf analytics enable
Command Syntax
sf analytics enable
json
loglevel LOGLEVEL
u TARGETUSERNAME
apiversion APIVERSION
a
w WAIT
p POLLINTERVAL
Parameters
json
Optional
Format output as JSON
Type boolean
loglevel LOGLEVEL
Optional
The logging level for this command invocation Logs are stored in HOMEsfdxsfdxlog
Type enum
Permissible values are trace debug info warn error fatal TRACE DEBUG INFO WARN ERROR FATAL
Default value warn
u targetusername TARGETUSERNAME
Optional
Salesforce Analytics CLI Plugin Command Reference
analytics query
A username or alias for the target org Overrides the default target org
Type string
apiversion APIVERSION
Optional
Override the API version used for API requests made by this command
Type string
a async
Optional
Enable asynchronously
Type boolean
w wait WAIT
Optional
Wait time in minutes for autoinstall request to finish default
Type number
Default value
p pollinterval POLLINTERVAL
Optional
Polling interval in milliseconds for checking autoinstall request status default
Type number
Default value
analytics query
Execute an Analytics query
Examples for analytics query
sf analytics query f querysaql
sf analytics query f querysql t AmericaDenver
sf analytics query q sql limit r csv
Command Syntax
sf analytics query
json
loglevel LOGLEVEL
u TARGETUSERNAME
apiversion APIVERSION
f QUERYFILE
q QUERY
Salesforce Analytics CLI Plugin Command Reference
analytics query
nomapnames
sql
t TIMEZONE
connector CONNECTOR
limit LIMIT
r RESULTFORMAT
Parameters
json
Optional
Format output as JSON
Type boolean
loglevel LOGLEVEL
Optional
The logging level for this command invocation Logs are stored in HOMEsfdxsfdxlog
Type enum
Permissible values are trace debug info warn error fatal TRACE DEBUG INFO WARN ERROR FATAL
Default value warn
u targetusername TARGETUSERNAME
Optional
A username or alias for the target org Overrides the default target org
Type string
apiversion APIVERSION
Optional
Override the API version used for API requests made by this command
Type string
f queryfile QUERYFILE
Optional
Path to the file containing the query to execute
Type filepath
q query QUERY
Optional
The query to execute
Type string
nomapnames
Optional
Skip mapping dataset names in the SAQL query to ids
Type boolean
Salesforce Analytics CLI Plugin Command Reference
app Commands
sql
Optional
Execute the query as SQL
Type boolean
t timezone TIMEZONE
Optional
The timezone for the query
Type string
connector CONNECTOR
Optional
Execute the SQL query against this external data connector id or name
Type string
limit LIMIT
Optional
The maximum number of rows to include
Type number
r resultformat RESULTFORMAT
Optional
Result format emitted to stdout
Type enum
Permissible values are human csv json
Default value human
app Commands
Create and manage Analytics apps
analytics app create
Creates an Analytics app
analytics app decouple
Decouples an Analytics app from an Analytics template
analytics app delete
Delete Analytics apps
analytics app display
Displays an Analytics apps details
analytics app list
Lists Analytics apps in the specified folder or target org
analytics app update
Updates an Analytics app from a template
Salesforce Analytics CLI Plugin Command Reference
app Commands
analytics app create
Creates an Analytics app
Examples for analytics app create
sf analytics app create t templateid n appname
sf analytics app create m templatename
sf analytics app create f pathtojsonfile
Command Syntax
sf analytics app create
json
loglevel LOGLEVEL
u TARGETUSERNAME
apiversion APIVERSION
f DEFINITIONFILE
t TEMPLATEID
m TEMPLATENAME
n APPNAME
a
v
w WAIT
Parameters
json
Optional
Format output as JSON
Type boolean
loglevel LOGLEVEL
Optional
The logging level for this command invocation Logs are stored in HOMEsfdxsfdxlog
Type enum
Permissible values are trace debug info warn error fatal TRACE DEBUG INFO WARN ERROR FATAL
Default value warn
u targetusername TARGETUSERNAME
Optional
A username or alias for the target org Overrides the default target org
Type string
Salesforce Analytics CLI Plugin Command Reference
app Commands
apiversion APIVERSION
Optional
Override the API version used for API requests made by this command
Type string
f definitionfile DEFINITIONFILE
Optional
Analytics template definition file required unless a templateid value is specified
Type filepath
t templateid TEMPLATEID
Optional
Template ID required unless a definitionfile value is specified
Type string
m templatename TEMPLATENAME
Optional
The name of the Analytics template
Type string
n appname APPNAME
Optional
The name of the created app
Type string
a async
Optional
Create app asynchronously
Type boolean
v allevents
Optional
Verbose display of all app create events
Type boolean
w wait WAIT
Optional
Wait time in minutes for streaming app creation events default
Type number
Default value
analytics app decouple
Decouples an Analytics app from an Analytics template
Salesforce Analytics CLI Plugin Command Reference
app Commands
Examples for analytics app decouple
sf analytics app decouple f folderId t templateId
Command Syntax
sf analytics app decouple
json
loglevel LOGLEVEL
u TARGETUSERNAME
apiversion APIVERSION
f FOLDERID
t TEMPLATEID
Parameters
json
Optional
Format output as JSON
Type boolean
loglevel LOGLEVEL
Optional
The logging level for this command invocation Logs are stored in HOMEsfdxsfdxlog
Type enum
Permissible values are trace debug info warn error fatal TRACE DEBUG INFO WARN ERROR FATAL
Default value warn
u targetusername TARGETUSERNAME
Optional
A username or alias for the target org Overrides the default target org
Type string
apiversion APIVERSION
Optional
Override the API version used for API requests made by this command
Type string
f folderid FOLDERID
Required
ID of the folder that contains the app data
Type id
t templateid TEMPLATEID
Required
Template ID
Salesforce Analytics CLI Plugin Command Reference
app Commands
Type id
analytics app delete
Delete Analytics apps
Examples for analytics app delete
sf analytics app delete f folderid
Command Syntax
sf analytics app delete
json
loglevel LOGLEVEL
u TARGETUSERNAME
apiversion APIVERSION
f FOLDERID
p
Parameters
json
Optional
Format output as JSON
Type boolean
loglevel LOGLEVEL
Optional
The logging level for this command invocation Logs are stored in HOMEsfdxsfdxlog
Type enum
Permissible values are trace debug info warn error fatal TRACE DEBUG INFO WARN ERROR FATAL
Default value warn
u targetusername TARGETUSERNAME
Optional
A username or alias for the target org Overrides the default target org
Type string
apiversion APIVERSION
Optional
Override the API version used for API requests made by this command
Type string
f folderid FOLDERID
Required
Salesforce Analytics CLI Plugin Command Reference
app Commands
ID of the folder that contains the app data
Type id
p noprompt
Optional
Do not prompt to confirm delete
Type boolean
analytics app display
Displays an Analytics apps details
Examples for analytics app display
sf analytics app display f folderId a
Command Syntax
sf analytics app display
json
loglevel LOGLEVEL
u TARGETUSERNAME
apiversion APIVERSION
f FOLDERID
a
Parameters
json
Optional
Format output as JSON
Type boolean
loglevel LOGLEVEL
Optional
The logging level for this command invocation Logs are stored in HOMEsfdxsfdxlog
Type enum
Permissible values are trace debug info warn error fatal TRACE DEBUG INFO WARN ERROR FATAL
Default value warn
u targetusername TARGETUSERNAME
Optional
A username or alias for the target org Overrides the default target org
Type string
Salesforce Analytics CLI Plugin Command Reference
app Commands
apiversion APIVERSION
Optional
Override the API version used for API requests made by this command
Type string
f folderid FOLDERID
Required
ID of the folder that contains the app data
Type id
a applog
Optional
Specify to include app creation log details
Type boolean
analytics app list
Lists Analytics apps in the specified folder or target org
Examples for analytics app list
sf analytics app list
Command Syntax
sf analytics app list
json
loglevel LOGLEVEL
u TARGETUSERNAME
apiversion APIVERSION
f FOLDERID
Parameters
json
Optional
Format output as JSON
Type boolean
loglevel LOGLEVEL
Optional
The logging level for this command invocation Logs are stored in HOMEsfdxsfdxlog
Type enum
Permissible values are trace debug info warn error fatal TRACE DEBUG INFO WARN ERROR FATAL
Default value warn
