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

june

02jun2:00 pm2:30 pmBusiness Intelligence for Batch Manufacturers

16jun10:00 am10:30 amHow AP automation can speed up month-end close in D365 Finance

17jun11:00 am12:00 pmConfab Live with Stoneridge – Real Time Marketing Strategies for Success

23jun10:00 am10:30 amThe Modern Manufacturer: Cost Accounting in D365

30jun10:00 am10:30 amAP Automation Checklist for a 2022 Rebound

30jun2:00 pm2:30 pmAchieving Success: How Technology Is Helping Nonprofits Thrive

july

01jul11:00 am12:00 pmConfab Live with Stoneridge – Dataverse Virtual Entities

14jul12:00 pm12:30 pmBeyond Reporting - What Business Intelligence Can Do For Your Agribusiness

15jul11:00 am12:00 pmConfab Live with Stoneridge – Integration Strategies for End User Success

21jul10:00 am10:30 amThe Modern Manufacturer: Manufacturing Software in the Real World

21jul12:00 pm1:00 pmIs it Worth it to Upgrade to Dynamics 365 Finance and Supply Chain Management? - Everything AX Users Need to Consider

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