This repo is an open-source project that provides a code for a Dataverse DevTools VS Code Extension that helps you connect to a Dataverse environment, generate TypeScript definitions for entities, create different type of Dataverse-specific projects, upload web-resources right from VS Code and much more.
Table of contents
- 🆕 Recent Updates (v2.2.6)
- ⚙ Features
- Connect to your Dataverse environment
- Remembers the connected environment per workspace
- See connection and entity details (with copy feature)
- Initialize TypeScript project & add TS File
- Generate Typings
- Intellisense for type generated
- Upload Web Resources
- Filter by solution
- Smart Match Web Resources
- ⚒️ Tools
- 🔥 Using Typings
- Generate Typing
- 🎮 Power Platform CLI Commands
- 🎁 Early-Access Preview
- 🧪 Alpha-Testing
- 💭 Planned Features
- ✨ Contributing
- 🔉 Discussions
- 📃 License
- ✍ Credits
- Improved Comparison of files between local and server: The tool now correctly shows file from server on the left-side and compares with the local file on the right-side. This is equivalent to GitHub compare where the incoming files are shown on the left and local changes are shown on the right.
- Automatic Token Expiration Monitoring: Implemented automatic token expiration monitoring with user notifications as well as visual indication on the Connection. Any connection that has a token expired will now been shown in "amber" colored Dataverse icon.
- Stability Improvements:
- Fixed web resource upload issue when connection was timed out (#283)
- Various performance and security enhancements
There are 4 ways you can connect to your Dataverse Environment.
| Connection Type | Description |
|---|---|
| Microsoft Login Prompt (Recommended) | Uses Dataverse Dev Client Id for authentication. This connection will work with MFA-enabled authentication as well. Improved in v2.2.4 with enhanced authentication flow. |
| Username & Password | This works with environments without MFA-enabled and needs no extra configuration. |
| Client Id & Secret | This works with MFA-enabled authentication but needs extra configuration of Azure AD App Registration. To know more on app registration process read here. |
| Azure | If you are already logged in inside VSCode using Az extension, Azure CLI or Azure PowerShell, you can leverage Azure Identity Framework to get authenticated against Dataverse. The developer has to use the same account for both Azure and Power Platform for this work (thanks to Natraj Yegnaraman for this method). This is a single-click authentication method with no prompts. |
Below is one of the way you can create the connection.
Once you connect to your preferred Dataverse Environment; the tool will rememeber the connection for that workspace/folder.
This provides an ability for you to quikly check the details of the connection and also copy certain important information.
You can instantiate a TypeScript project for Dataverse that automatically installs all the prerequisites needed:
Below procecss shows how you can create a TypeScript project for Dataverse with one of the available options and also how you can add a TypeScript file that loads the code-snippet.
Typings help you write early-bound code. And with the help of @types/xrm you can provide types to all of your variables/methods.
Typings are also integrated with @types/xrm
Enhanced in v2.2.3: Typings now include entity attribute metadata, providing more detailed information about entity attributes including attribute type names and relationships.
When you generate typings for entities you are provided with an intellisense; provided you have casted the FormContext into proper Entity type.
Once you build your project you can upload your script directly from the VS Code with the help of Dataverse DevTools.
You can launch your favorite Power Platform tools right from VSCode. Below are the list of currently integrated tools with DVDT.
UI Enhancement (v2.2.5): All tool views now feature modern themed interfaces that automatically adapt to your VS Code theme (light/dark mode).
| Tool Name | Author |
|---|---|
| Dataverse REST Builder | Guido Preite |
| Plugin Registration Tool | Microsoft |
| Configuration Migration | Microsoft |
| Package Deployer | Microsoft |
- Go to Dataverse DevTools from the Activity Side Bar.
- From the list of entities, right-click the entity for which you want to create a typing and choose
Generate Typingsoption. You can also filter the list of entities by clicking the filter button on the Entities panel as shown here.
- Create a onLoad function in your TypeScript file with parameter as
executionContext: Xrm.Events.EventContext. - Initialize your
FormContextglobal variable casting it withXrm.<entity name>.
For example: If you wanted to use Accounts entity typings in your TypeScript file then after the typings are generated the code in your TypeScript file will look as shown below:
export function onLoad(executionContext: Xrm.Events.EventContext) {
const formContext: Xrm.Account = executionContext.getFormContext();
formContext.getAttribute("accountnumber").getValue();
}In the above code snippet, Xrm.Account is a typing generated by Dataverse DevTools to provide intellisense specific to the Account entity.
- Just use by typings the entity name
For example: If you wanted to use Accounts entity typings in your TypeScript file then after the typings are generated the code in your TypeScript file will look as shown below:
let fetchAccount =
`<fetch>
<entity name="${Account.EntityLogicalName}">
<attribute name="${Account.Attribute.accountid}" />
<attribute name="${Account.Attribute.telephone1}" />
</entity>
</fetch>`;All the Power Platform CLI commands are easily categorized in a tree format that enables you to execute them with a button-click. If any command needs a parameter then system will intelligently prompt for the input from you. At this time only required parameters will be prompted by the system. Please see it in action below:
This list showcases the features that are build and ready but not fully tested to be released. You can enable these features by navigating to File > Preferences > Settings and search for Dataverse DevTools and make sure Enable Early Access Preview is checked.
No features in early-access at the moment.
There are different ways in which you can contribute to this open-source project. One of the way is to be part of alpha-testing. In order to perform alpha-testing follow the below steps:
- Fork this project and clone it on your local machine
- Identify the changes in alpha-test mode (list is mentioned below)
- Open the project in VS Code
- Navigate to
Run and Debugfrom Activity Bar - Make sure
Run Extensionis selected; click on▶️ icon. - This will open another VS Code instance, this instance will have Extention Development Host on it's title
- You are ready to perform your tests
No features in alpha-testing at the moment.
Report any issues or feedback on GitHub.
- Integrate with Dataverse-ify.
- Initiate plugin project.
We encourage you to pitch in, join the team and showcase your name on this repo. If you are unsure how you can contribute, please reach out to Power Maverick.
Different ways to contribute:
- Improve the code or fix a bug by creating a Pull Request.
- Get involved in Alpha & Beta tests.
- Provide suggestions, feedback or feature request on GitHub.
- Report issues & bugs on GitHub.
- Answer any open questions on the Discussion Board.
- Join Power Platform LevelUP community on Discord to answer any of the questions that may rise w.r.t. this tool.
Before creating the pull request for contributing, please read the Contributing Guidelines.
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!
If you want to have any discussions on any feature, please use the Discussion Board.
This software is released under MIT License
Icons sourced from - https://icon-sets.iconify.design
JSON to TypeScript conversions - https://quicktype.io/typescript