Skip to main content

How to create online help (for non-technical) [AX 2012]

This describes how to create custom Help documentation and how to publish that documentation to the Microsoft Dynamics AX Help server. The Help documentation you create has to work with both the Help server and viewer.

  • The Help server is a centralized Web service that responds to requests for Help documentation. In addition, you put your custom Help documentation files on the Help server.
  • The Help viewer is an application that is deployed with the Microsoft Dynamics AX client. The Help viewer displays documentation when you request Help from the application workspace.

Walk through on publishing help files is here:
http://msdn.microsoft.com/en-us/library/gg882381.aspx

Here is my short walk through:

To add folders to the Help server
  1. Use Windows Explorer and open the Content folder of the Help server. The folder is typically found in the c:\inetpub\wwwroot\DynamicsAX6HelpServer\Content but can be changed during install.
  2. Right-click the Content folder, click New, and then click Folder. A folder is added to Content. Right-click the new folder, click Rename, and then type Contoso for the folder name.
  3. Right-click the Contoso folder, click New, and then click Folder. Right-click the new folder, click Rename, and then type en-us for the folder name.
  4. Double-click the en-us folder. Leave the folder open in Windows Explorer.
  5. Once you have copied the folder. Copy the template file from this location ..\Content\Microsoft\EN-US\Template. 
  6. Edit the content
  7. Edit the meta tags - this is important as it is how the help server will index it and how users will search on it.
  8. Now save the document using "Save as"
  9. This will create 2 new documents. *.htm (which contains the meta tags) and *.mht (which is the html version)


6. This will create 3 files.
 


7. Now open up the help client and search the keywords you typed in the metatag.
 



Advantages:

  • Clients can create their own personalised help (Form help, procedures etc)
  • You have a centralized help files on the server - deployment becomes easy
  • You can place links and images in the help files


Known limitation:
The mht file that is created is a single file html. It embeds everything into this one file including images and links. All relative links in the Web page are remapped and the embedded content is included in the .MHT file. The absolute references or hyperlinks on the Web page remain unchanged and the .MHT file is viewed using Internet Explorer.

You may consider creating your own html help file with the metatags and everything but this then becomes a developer job now. Weigh up the options but I think this is great for clients/partners/ISVs that want to create their own online help.

Reference:
http://msdn.microsoft.com/en-us/library/gg882383.aspx
There is enough detail on the msdn link but it can get technical. I hope this helps. ;-)

Popular posts from this blog

AX - How to use Map and MapEnumerator

Similar to Set class, Map class allows you to associate one value (the key) with another value. Both the key and value can be any valid X++ type, including objects. The types of the key and the value are specified in the declaration of the map. The way in which maps are implemented means that access to the values is very fast. Below is a sample code that sets and retrieves values from a map. static void checkItemNameAliasDuplicate(Args _args) { inventTable inventTable; Map map; MapEnumerator mapEnumerator; NameAlias nameAlias; int counter = 0; ; map = new Map(Types::String, Types::Integer); //store into map while select inventTable { nameAlias = inventTable.NameAlias; if (!map.exists(nameAlias)) { map.insert(nameAlias, 1); } else { map.insert(nameAlias, map.lookup(nameAlias) + 1); } } //retrieve fro

AX - How to use Set and SetEnumerator

The Set class is used for the storage and retrieval of data from a collection in which the values of the elements contained are unique and serve as the key values according to which the data is automatically ordered. You can create a set of primitive data types or complex data types such as a Class, Record or Container. Below is sample of a set of records. static void _Set(Args _args) {     CustTable       custTable;     Set             set = new Set(Types::Record);     SetEnumerator   setEnumerator;     ;     while select custTable     {         if (custTable && !set.in(custTable))         {             set.add(custTable);         }     }     if (!set.empty())     {         setEnumerator = set.getEnumerator();         setEnumerator.reset();         while (setEnumerator.moveNext())         {             custTable = setEnumerator.current();             info(strfmt("Customer: %1",custTable.AccountNum));         }     } } Common mistake when creating a set of recIds

Import document handling (attachment) files #MSDyn365FO

Out of the box you have limited data entities for migrating attachments. If you search what is already in the AOT, you will see a few various examples. I suggest you look at the LedgerJournalAttachmentsEntity as it is the simplest and cleans to copy from. I wont go into detail but I will give a quick run down of what it looks like. Use the DocuRefEntity as your main datasource. It does most of the work for you. Set your table you want to import for as the child datasource Add the Key You will need to add the postLoad method. There is minor code to update the virtual field FileContents. Below is an export I did for the general journal attachments. The import zip structure should be the same way. It will create the usual artifacts such as the excel, manifest and package header xml files. You will see a Resources folder under that. If you drill down to the resources you will see the attachments. This is an export and it used the document GUID for uniqueness. The other thing is the extensi