Add documentation

Add more documentation on how to use AOT Browser
arganollc · Jan 23, 2020 · 8c9d9ce · 8c9d9ce
1 parent 5e059ad
commit 8c9d9ce
Show file tree

Hide file tree

Showing 32 changed files with 136 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -1,12 +1,15 @@
 # AOT Browser
+
 Dynamics 365 for Finance and Operations AOT Browser
 
 [![Build status](https://dev.azure.com/ArbelaIP/Arbela%20Accelerators/_apis/build/status/Unified%20Operations%20platform%20-%20Build%20AOT%20Browser)](https://dev.azure.com/ArbelaIP/Arbela%20Accelerators/_build/latest?definitionId=6)
 
 ### Download
+
 [Releases](https://github.com/arbelatech/aotbrowser/releases)
 
 ### What is the AOT Browser?
+
 In Dynamics AX 2012 and earlier it was possible for power users to be able to open and browse the contents of the AOT
 (Application Object Tree) from the UI. This functionality was removed in Dynamics 365 for Finance and Operations as all
 development is now done in Visual Studio. This means that in order to browse the contents of the AOT, one now needs access
@@ -15,7 +18,7 @@ to a development environment with Visual Studio.
 **AOT Browser to save the day!** With the AOT Browser it is now possible to browse the objects in the AOT from the D365FO web interface.
 
 ### How do I get to the AOT Browser?
+
 In the D365FO web interface navigate to Common > Common > AOT browser
 
-### More documentation to come!
-We will be working on creating more documentation to describe all of the features of the AOT browser, but for now you can take it for a spin by going to the above path.
+## [Documentation on GitHub Pages](https://arbelatech.github.io/aotbrowser/)
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -1 +1,3 @@
-theme: jekyll-theme-minimal
+theme: jekyll-theme-minimal
+title: AOT Browser
+description: Dynamics 365 for Finance and Operations AOT Browser
diff --git a/docs/extensionsinline.md b/docs/extensionsinline.md
@@ -0,0 +1,14 @@
+# View Extensions Inline
+
+## Viewing extensions inline
+
+At the top of the AOT browser form is a toggle button to turn on or off the ability to view the extensions inline in the tree. The setting will be remembered in the user's usage data once the form is closed.
+
+When enabled, extensions will be shown in the tree where they belong. They are bolded and have the name of the extension they belong to in parenthesis after the name.
+
+![Select table or view](images/extensionsinline1.png)
+
+## Viewing extensions as separate node
+
+When the toggle is disabled, the extensions show up as a separate node at the bottom of the tree.
+![Select table or view](images/extensionsinline2.png)
diff --git a/docs/images/extensionsinline1.png b/docs/images/extensionsinline1.png
diff --git a/docs/images/extensionsinline2.png b/docs/images/extensionsinline2.png
diff --git a/docs/images/openentity1.png b/docs/images/openentity1.png
diff --git a/docs/images/openentity2.png b/docs/images/openentity2.png
diff --git a/docs/images/openentity3.png b/docs/images/openentity3.png
diff --git a/docs/images/openentity4.png b/docs/images/openentity4.png
diff --git a/docs/images/openform1.png b/docs/images/openform1.png
diff --git a/docs/images/openform2.png b/docs/images/openform2.png
diff --git a/docs/images/openform3.png b/docs/images/openform3.png
diff --git a/docs/images/openform4.png b/docs/images/openform4.png
diff --git a/docs/images/openform5.png b/docs/images/openform5.png
diff --git a/docs/images/search.png b/docs/images/search.png
diff --git a/docs/images/searchaotcusttable.png b/docs/images/searchaotcusttable.png
diff --git a/docs/images/searchaotname.png b/docs/images/searchaotname.png
diff --git a/docs/images/searchfilterbaseenum.png b/docs/images/searchfilterbaseenum.png
diff --git a/docs/images/searchfiltertype.png b/docs/images/searchfiltertype.png
diff --git a/docs/images/searchlabelsalesorders.png b/docs/images/searchlabelsalesorders.png
diff --git a/docs/images/searchobjectlabel.png b/docs/images/searchobjectlabel.png
diff --git a/docs/images/tablebrowser1.png b/docs/images/tablebrowser1.png
diff --git a/docs/images/tablebrowser2.png b/docs/images/tablebrowser2.png
diff --git a/docs/images/viewcodedisabled.png b/docs/images/viewcodedisabled.png
diff --git a/docs/images/viewcodeenabled.png b/docs/images/viewcodeenabled.png
diff --git a/docs/index.md b/docs/index.md
@@ -1,23 +1,44 @@
 # AOT Browser
-Dynamics 365 for Finance and Operations AOT Browser
 
-[![Build status](https://dev.azure.com/ArbelaIP/Arbela%20Accelerators/_apis/build/status/Unified%20Operations%20platform%20-%20Build%20AOT%20Browser)](https://dev.azure.com/ArbelaIP/Arbela%20Accelerators/_build/latest?definitionId=6)
+_Dynamics 365 for Finance and Operations AOT Browser_
 
-### Download
-[Releases](https://github.com/arbelatech/aotbrowser/releases)
+## What is the AOT Browser?
 
-### What is the AOT Browser?
 In Dynamics AX 2012 and earlier it was possible for power users to be able to open and browse the contents of the AOT
 (Application Object Tree) from the UI. This functionality was removed in Dynamics 365 for Finance and Operations as all
 development is now done in Visual Studio. This means that in order to browse the contents of the AOT, one now needs access
 to a development environment with Visual Studio.
 
 **AOT Browser to save the day!** With the AOT Browser it is now possible to browse the objects in the AOT from the D365FO web interface.
+![AOT Browser](images/index.png =600x)
+
+## Getting Started
+
+### Download
+
+Both a deployable package and a model file are available in
+[Releases](https://github.com/arbelatech/aotbrowser/releases)
 
 ### How do I get to the AOT Browser?
+
 In the D365FO web interface navigate to Common > Common > AOT browser
 
-### More documentation to come!
-We will be working on creating more documentation to describe all of the features of the AOT browser, but for now you can take it for a spin by going to the above path.
+### Populate list of AOT objects
+
+It is necessary to populate the list of AOT objects after installing AOT Browser. This is acheived
+by clicking the Populate AOT objects button. It is recommended to run this as a batch job as it can take
+several minutes to complete. It is also recommended to schedule the batch job with recurrance so that the
+list is up-to-date with all of the objects in the AOT.
+
+## Features
 
-![Index Image](images/index.png)
+- [Search/Filter](search.md)
+  - By AOT name or by label name
+  - By object type
+- [Open from form personalization screen](openform.md)
+- [Open from data entities form](openentity.md)
+- [Open in table browser (tables/views)](tablebrowser.md)
+- [View extensions inline](extensionsinline.md)
+- [View source code](viewcode.md)
+- [Jump to references](jumpreferences.md)
+- View label value instead of label id
diff --git a/docs/jumpreferences.md b/docs/jumpreferences.md
@@ -0,0 +1,3 @@
+# Jump to References
+
+In the AOT browser, it is possible to jump to a referenced object to view more in-depth information about that object. One main example would be the ability to jump to an EDT for a field in a table.
diff --git a/docs/openentity.md b/docs/openentity.md
@@ -0,0 +1,17 @@
+# Open from Data Entities Form
+
+## 1. Navigate to System Administration > Workspaces > Data management
+
+![Data management](images/openentity1.png)
+
+## 2. Select the Data entities tile
+
+![Data management](images/openentity2.png)
+
+## 3. Select the entity you want to browse and click "Open in AOT browser" at the top
+
+![Data management](images/openentity3.png)
+
+## 4. The AOT Browser will open and display the data entity
+
+![Data management](images/openentity4.png)
diff --git a/docs/openform.md b/docs/openform.md
@@ -0,0 +1,21 @@
+# Open from Form Personalization
+
+## 1. Open the form in the web UI that you would like to browse
+
+![Open menu item](images/openform1.png)
+
+## 2. Right click on any element of the form and select form information
+
+![Right click](images/openform2.png)
+
+## 3. Click on the form name
+
+![Click form name](images/openform3.png)
+
+## 4. At the bottom of the dialog click "Open in AOT browser"
+
+![Click form name](images/openform4.png)
+
+## 5. The AOT browser will open for the form and select the control that was right-clicked in the calling form
+
+![AOT Browser Form](images/openform5.png)
diff --git a/docs/search.md b/docs/search.md
@@ -0,0 +1,20 @@
+# Search/Filter
+
+![Search](images/search.png)
+
+## Search by object name or label
+
+### Search both by the AOT node name
+
+![AOT Node Search](images/searchaotname.png)\
+![AOT Node Search CustTable](images/searchaotcusttable.png)
+
+### Search by the object label property
+
+![Label Search](images/searchobjectlabel.png)\
+![Label Search Sales Orders](images/searchlabelsalesorders.png)
+
+## Filter by object type
+
+![Filter Object Type](images/searchfiltertype.png)\
+![Filter Base Enum](images/searchfilterbaseenum.png)
diff --git a/docs/tablebrowser.md b/docs/tablebrowser.md
@@ -0,0 +1,9 @@
+# Open Table Browser
+
+## 1. Select the table or view you wish to browse the data for and select "Open table browser"
+
+![Select table or view](images/tablebrowser1.png)
+
+## 2. The table browser form is displayed with the data of the selected table or view
+
+![Select table or view](images/tablebrowser2.png)
diff --git a/docs/viewcode.md b/docs/viewcode.md
@@ -0,0 +1,15 @@
+# View Source Code
+
+At the top of the AOT Browser form is a toggle button enabling the ability to view the source code. Enabling this button is only supported in environments that contain source code, such as Development or Demo OneBoxes.
+
+This feature uses a disk based metadata provider that reads the source code directly from the source XML files in the metadata directory. When disabled, the AOT browser will use a runtime based metadata provider which reads from the DLLs. In the case of objects where the code does not exist (even on a development machine), for exmple ISV product delivered as a deployable package, the AOT Browser will revert to the runtime provider.
+
+The code highlighting is provided by the open source [PygmentSharp.Core](https://github.com/akatakritos/PygmentSharp) project.
+
+## Enabled
+
+![](images/viewcodeenabled.png)
+
+## Disabled
+
+![](images/viewcodedisabled.png)
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Jump to References

		In the AOT browser, it is possible to jump to a referenced object to view more in-depth information about that object. One main example would be the ability to jump to an EDT for a field in a table.