Think Outside of the Box by Using X++ to Document Your Feature

by | Updated August 15, 2016 | Development, Dynamics AX

One of the extremely import tasks of development is to document what you have created.  This can include things such as comments within the code, but there are times you need more than that.   If you have created a rather complex piece of functionality (this could be anything from changing posting routine code to creating a custom module), you may be tasked with updating it at a later date (or you may inherit the code as well).  If this date is a couple of years AFTER the code has been deployed, will you remember what you were thinking when you designed the code?  Probably not.

Creating this type of documentation can be a bit of a tedious process, especially if you were not given a proper functional design document to create the feature.  Something to consider then is to create tools to help automate the process.

Dynamics AX has had the ability to work with Excel and Word for many versions, so why not utilize that functionality to create a document for your customization?  Utilize the built-in formatting commands to make the document have a standard format.  Here is some example code (it is not complete as it does not contain some macro definition code):

This document will contain (in the very least in the object listing section) a list of objects that exist in the above mentioned project and the above mentioned Model.  Certain types of objects will have additional information.’);

OK, so that gives you a header, but what about the rest?  X++ has a construct called TreeNode().  You can use this to traverse your project, and update your document with any pertinent information you desire to pull from the metadata.   The dict* kernel classes can be a huge help in doing this as you can use those objects to pull property values, X++ code, etc. for your documentation.

A little snippet demonstrating part of this:

Once your tool does the ‘heavy lifting’, you can go in and add additional pertinent information, thoughts, etc. on the specific feature.

It is not a trivial effort to create the toolset to do this, but once created, it can be re-used as a real time saving device.

Related Posts

0 Comments

Submit a Comment

Your email address will not be published. Required fields are marked *

Upcoming Events

september

02sep10:00 am10:30 amThe Modern Manufacturer - Cycle Count Management

02sep12:00 pm12:30 pmBest Practices for Work Order Planning and Routing for Field Service Companies

09sep10:00 am11:00 amWhat is Levridge? An Overview of the Ultimate Ag Solution

09sep12:00 pm12:30 pmOverview of Microsoft Promotion for NAV and GP Clients

10sep11:00 am12:00 pmConfab with Stoneridge - Livestream - Field Service Comparisons

16sep10:00 am10:30 amThe Modern Manufacturer - Product Lifecycle Management

16sep12:00 pm12:30 pmHow to Upgrade to Dynamics 365 Finance and Operations: Examining Custom Code and ISV Implications

16sep2:00 pm2:30 pmScheduling and Dispatching for the Modern Field Service Company

23sep12:00 pm1:00 pmDynamics 365 Business Central Wave 2 Release Preview - An Overview of the Most Exciting New Features Coming in October

24sep11:00 am12:00 pmConfab with Stoneridge - Livestream - The Modern Workplace: Teams, Sharepoint, Outlook, Office, and AI Integration

30sep10:00 am10:30 amThe Modern Manufacturer - Return Management

30sep12:00 pm12:30 pmEmpowering Your Field Service Technicians with a Mobile Solution

october

07oct12:00 pm1:00 pmThe Three Paths to Business Central from Dynamics GP

08oct11:00 am12:00 pmConfab with Stoneridge - Livestream - The Vision and Strategy of Microsoft Business Systems

14oct10:00 am10:30 amThe Modern Manufacturer - Complex Cost Modeling

14oct12:00 pm12:30 pmGenerating Custom Inspection or Process Forms

19octAll Day22Stoneridge Connect Fall 2020

22oct11:00 am12:00 pmConfab with Stoneridge - Livestream - Stoneridge Connect Recap

28oct10:00 am10:30 amThe Modern Manufacturer - Engineering Change Orders

About Stoneridge
Stoneridge Software is a unique Microsoft Gold Partner, with emphasis on partner. With specialties in Microsoft Dynamics 365, Microsoft Dynamics AX, Microsoft Dynamics NAV, Microsoft Dynamics GP and Microsoft Dynamics CRM, we focus on attracting the most knowledgeable experts in the field to our team, and prioritize delivering stellar solutions with maximum impact for your business. At Stoneridge, we are deeply committed to your results. Each engagement is met with a dedicated team, ready to provide thorough, tailored, and expert service. Based in Minnesota, we intentionally “step into your shoes,” wherever you are. We focus on what you care about, and develop trusting, long-term relationships with our clients.

Subscribe To Our Blog

Sign up to get periodic updates on the latest posts.

Thank you for subscribing!

X