How to edit the MRlocalDefs file

Version 1
    Share This:

    Most configuration in Footprints Service Core can be accomplished via the interface. Some configuration must be done in the MRlocalDefs file. This file is located in the <Footprints root>\cgi directory. It is called MRlocalDefs and has no extension.

     

    It is evaluated every time a script is called in Footprints (which is all the time). In the file is a list of environmental variables that are loaded into memory when perl is executed. Changes to the MRlocalDefs file are instant and nothing needs to be restarted. Each variable will end with a semicolon (statement  terminator) to let perl know the variable ended. Footprints will stop reading the file once it reaches a line with only "1;". This is usually the last line but anything below that line will not be evaluated.

     

    MRlocalDefs variables are hard coded in the product. You may get a variable from support to address an issue or find one on the communities to change a behavior. Please keep in mind that the behavior of these variables may change or be removed in future versions.

     

    A variable can be removed by deleting the line or by adding a # to the front of the line. This will turn the line into a comment and perl will skip the line during evaluation. You can also add a # to the end of the line to note why that variable is in there, who put it there, and when.

     

    Not all variables were manually added to the file. Some are added or removed when interface configuration changes are made.

     

    Use the following steps to edit your MRlocalDefs file:


    1) Make a backup of the cgi\MRlocalDefs file

    2) Open the cgi\MRlocalDefs file (using Wordpad, Notepad, any other text editor)

    3) Add or remove the desired variable(s). Make sure it is above the "1;" line

    4) Save the file. Ensure there is no file extension when you save.

     

    For example, lets say you want to make all CCs on an issue permanent CCs instead of one time CCs (default behavior). Since we don't have a configuration option in the interface we have an MRlocalDefs variable you can use instead:

     

    $ALWAYS_CC=1;


    We can add it by doing the following:

     

    1) Make a backup of the C:\Footprints Service Core\cgi\MRlocalDefs file

    2) Open the C:\Footprints Service Core\cgi\MRlocalDefs file (using Wordpad, Notepad, any other text editor)

    3) Add this line above the "1;"

    $ALWAYS_CC=1; # This changes the behavior when adding CCs so all CCs are permanent. Made by AS on 2014-06-13

    4) Save the file. Ensure there is no file extension when you save.

     

    This will instantly make all CCs added to issues become permanent CCs.

     

    This document is applicable to Footprints Service Core 11.X and earlier.