Working with Salesforce Analytics Extension Pack
Salesforce Recently released “Salesforce Analytics Extension Pack” for Analytics users. In this blog post we will the features it offers and how to use them in our regular activities.
Install the extension : https://marketplace.visualstudio.com/items?itemName=salesforce.analyticsdx-vscode which is released on 04/04/2020. As the Extension pack is in preview stage these program might change.
Prerequisites:
- Enable Devhub
- Install the Salesforce CLI
- Install Analytics plugin by executing this command in command prompt : “sfdx plugins:install @salesforce/analytics”
- Once you are done with all the prerequisites, Then install the extension “Salesforce Analytics Extension Pack” from the market place.
How to check whether the installation was successful or not?
Go to command prompt and enter sfdx anlytics –help. If the installation is successful then you will see the all possible Topics/Commands we can use.
In addition to check all the possible commands the Extension pack offers please execute the command
“sfdx commands” which inturn return all the possible commands for the plugins installed on your machine. Look for the analytics plugin offerings.
This extension pack is offering wide variety of option, Includes app,asset,dashboard,dataflow,lens and template.
NOTE: In case if you are not sure how to use the commands then just append with either –help or -h at the end of each command which will give the usage of the command and possible inputs which we need to provide.
Ex: sfdx analytics:app:create –help
Now we will check the commands usage.
1) APP
APP section offering all the below commands.
| analytics:app:create | create an analytics application |
| analytics:app:decouple | decouples an analytics application from an analytics template |
| analytics:app:delete | delete analytics applications |
| analytics:app:display | displays an analytics application’s details |
| analytics:app:list | list analytics applications |
| analytics:app:update | updates an analytics application from a template |
We will see how to use the commands in detail for one command and for the rest of them it applies same.
- sfdx analytics:app:create
This commands requires either definitionfile / templateid as a required argument. Those details we can check once we execute the command sfdx analytics:app:create –help, It will show all the required arguments that we need to pass.
Command: sfdx analytics:app:create -t sfdc_internal__Details_Dashboard -n testingApp here I have used templateid.
Tip: Template id you can find from using the Workbench Rest Call.
/services/data/v48.0/wave/templates/
Collapse any of one of the template to get the id.
Once the App creation started it will be like regular App creation you can monitor from the Data Manager or from the app creation or from the command prompt where we have executed the app creation command.
Data Manager:
Once the App successfully completed you can see the output in command prompt like below.
The verification in UI is same visit the Analytics homepage under all Items go to Apps there you can see the newly created app.
Tip: Don’t forget to mention wait time while executing the command. Some app creations take lot of time.
For the rest of the commands use the Rest endpoint in case of any clarifications.
/services/data/v48.0/wave
I hope you enjoyed reading this. Feel free to drop comments in case any clarification / queries.
Saicharan Reddy K
Hey there,
I am Saicharan working as a Salesforce Support based out of Hyderabad having nearly 5 years of experience in the Information Technology Industry and close to 2 years in Salesforce, Apart from the job I love music and obviously playing cricket. Giving back to the people is what matters most. #Ohana
Cheers !!!
Comments
1 Comment
[…] the previous blog post we have seen how to install Salesforce Analytics Extension Pack and checked the installation. In […]
Leave a Comment