Microsoft Dynamics AX Support

This blog contains posts by the Microsoft Dynamics AX Support Teams Worldwide

IDMF – How to enable the ByFiscalPeriod template – ShowByFiscalTemplate = True

Consider a scenario where you are using IDMF 2.0, and you want to work with InventTrans and LedgerTrans data, but you cannot find any archive templates for these tables. It is possible to archive InventTrans and LedgerTrans, but the ‘ByFiscalPeriod’ template is not enabled by default, and this blog post will show you how to enable it. In the example below, I am working with IDMF 2.0 running on AX 2009, but the AX version I am using is not really relevant.

1. Documentation links

As mentioned in my previous IDMF blog post, the main online documentation can be found here:

// Main Documentation Link:

Microsoft Dynamics AX Intelligent Data Management Framework (IDMF) [AX 2012]
http://technet.microsoft.com/en-us/library/hh378082.aspx

// Installation Guide:

Installation Guide for the Microsoft Dynamics AX Intelligent Data Management Framework (IDMF) [AX 2012]
http://technet.microsoft.com/EN-US/library/hh389759.aspx  

// Using IDMF:

Using the Microsoft Dynamics AX Intelligent Data Management Framework (IDMF) [AX 2012]
http://technet.microsoft.com/EN-US/library/hh389763.aspx

// Troubleshooting IDMF:

Troubleshoot the Microsoft Dynamics AX Intelligent Data Management Framework (IDMF) [AX 2012]
https://technet.microsoft.com/EN-US/library/hh389765.aspx

2. Enabling the ‘ByFiscalPeriod’ template

As mentioned above, you have to actively turn this functionality ON yourself. Until you’ve done this, you won’t see the ‘ByFiscalPeriod’ template in the list of Archive templates:

You must fully understand the possible consequences of using it before doing so (see the Warning text below, which you can find in the .config file you need to edit):

—————————————————

ShowByFiscalTemplate

<!– Warning: This configuration key controls the ByFiscalPeriod template. ByFiscalPeriod requires substantial preparation and irreversibly archives financial transactions, making them unavailable to your Microsoft Dynamics AX production environment. This template is disabled by default because it is highly complex could severely impact your Microsoft Dynamics AX implementation. Do not enable this template in a production environment without significant preparation and testing. You bear the entire risk of using the ByFiscalPeriod template. You (not Microsoft) will be solely responsible for any costs or damages that result from using this template. –>

1) Go to the IDMF install location:

%systemdrive%\Program Files\Microsoft Dynamics AX Intelligent Data Management Framework\AXDataManagementTool.exe.config

e.g.

C:\Program Files\Microsoft Dynamics AX Intelligent Data Management Framework\AXDataManagementTool.exe.config

2) Open the file in a text editor (e.g. Notepad) and search the file for “ShowByFiscalTemplate”

3) Change the value of “ShowByFiscalTemplate” to “true” (the default is “false”) and save the file
 

4) Restart the IDMF console and the ‘ByFiscalPeriod’ template should appear under Configure / Archive templates

—————————————————

Once you’ve done that, you will see the template in the IDMF console:

You will see a tab for LedgerTrans and one for InventTrans once you’ve selected the ByFiscalPeriod template under Configure / Archive templates:

// LedgerTrans

// InventTrans

3. Summary

It is possible to archive InventTrans and LedgerTrans, but the ‘ByFiscalPeriod’ template is not enabled by default
You have to actively turn this functionality ON yourself’
You must fully understand the possible consequences of using it before doing so
Read the WARNING text in the .config file.
The file you need to edit is called ‘AXDataManagementTool.exe.config’.
The ‘key’ you need to change the ‘value’ of (from ‘false’ to ‘true’) is called ‘ShowByFiscalTemplate’.
You need to restart the IDMF console for the changes to take effect.
You will find the ‘ByFiscalPeriod’ template under ‘Configure / Archive templates’ when you’ve enabled it.