HelpConsole 2008 SP1 - ReportsDNA Manual HelpConsole 2008 SP1 - ReportsDNA Manual HelpConsole 2008 SP1 - ReportsDNA Manual HelpConsole 2008 SP1 - ReportsDNA Manual HelpConsole 2008 SP1 - ReportsDNA Manual

Home > Extensions > How to Create an Extension > Function RNA_PROPERTIES

Function RNA_PROPERTIES

PUBLIC Function RNA_PROPERTIES()

Remarks

 ReportsDNA gathers information about each extension by calling this function.  RNA_Properties is the mandatory name for the function.  The function must return a Dictionary object that contains the following keys and values.


Key Value Example
name The Add-in's filename must begin with the letters RNA-

"Hello World"

uuid A 32 byte hexadecimal number that uniquely identifies the extension.

You can find free uuid generators on the web.  Search for uuid generator.
"923E8682-706F-42bb-B5EC-B0E86CCFF59E"
form The name of the function which displays the input configuration form.

ReportsDNA calls this function when the name of the extension is clicked in the source listbox to allow the user to enter report configuration information specific to the extension.
"SHOW_CONFIG"
data  The name of the function that populates the report with the raw source data.

ReportsDNA calls this function when either the Generate Report or Generate All Reports button is clicked and the source of the report is defined as an extension.
"GET_DATA"
rnaversion
The version of ReportsDNA with which the extension works. "1.0"

Example

Download RNA-Example Addin

Public Function RNA_PROPERTIES()
'MANDATORY FUNCTION called by ReportsDNA to obtain information about the extension
'Return a dictionary object that extension information
'name - the name of the extension that will be displayed in the source list box
'uuid - a unique identifier to distinguish this extension from all other extensions
'form - the name of the macro in this extension that ReportsDNA will call to display the extension's configuration form
'data - the name of the macro in this extension that ReportsDNA will call when a report is generated using the extension as the data source
'rnaversion - version of ReportsDNA that this extension is compatible with
    Dim iProperties
    Set iProperties = CreateObject("Scripting.Dictionary")
    iProperties.Add "name", "Template"                    'name of the extension displayed in the source listbox
    iProperties.Add "uuid", "923E8682-706F-42bb-B5EC-B0E86CCFF59E"  'unique id used to id the extension
    iProperties.Add "form", "SHOW_FORM"                             'name of the extension subroutine that displays the configuration form
    iProperties.Add "data", "GET_DATA"                              'name of the extension subroutine that returns report data
    iProperties.Add "rnaversion", "1.0.1"                           'version of ReportsDNA that this extension is compatible with
   
    Set RNA_PROPERTIES = iProperties                                'return the dictionary object
End Function


 

See also

Reference to ReportsDNA
Function SHOW_CONFIG
SUB SUBMIT_CONFIG
Function GET_DATA