In-Memory Summary Template

 

Jump to:

Template Notes
Application Properties
Web Parameters

Summary applications write directly to the Application server's memory, allowing for potentially quicker reads than a traditional database. To read data that has been loaded into memory, end-users would need to run a report over this data set. Like the traditional summary, In-Memory Summaries require they must be subtotaled by one and only one field. Again, like the standard summary template, data will be summarized by the aggregate of the subtotal keys, meaning now detail level information will be loaded into memory.

Template Notes

Application Settings

Description: Allow developers to specify their application's description/name.

Program Name: This will be the application’s number. By default, m-Power uses the letter S (Summary) followed by a five digit number.

Select Only Matching Records: Select either 'No', for a left outer join, or 'Yes' for an inner join. A left outer join will return all records from the primary table along with matching records from the secondary tables. An inner join will return records from the primary and secondary tables only where matching records are found.

Summary Table Name: This will be the name given to the table created by the application.

Summary Table Schema/Library: Specify the schema/library in which your application will be created. This will default to your current data dictionary.

Summary Table Description: Specify a description for your table.

Replace or Add Records: Selecting 'Replace' will clear the table and then add data, whereas selecting 'add' will append the data to the existing table.

Template: You can select a template by scrolling through the available templates. The templates define the general layout and functionality of the resulting application. This section will list all the available maintenance templates; you will see a small screenshot of what that template looks like at runtime. Learn more about templates.

Data Selection

Select the first, or only, table you want your summary to be written over, and then select your fields. After adding your fields, you are brought to the Summary Field Definition screen. Seeing as you are building a summary application, m-Power assumes you would like to Summarize or Average numeric fields. If you would like to do so, select either the "Summary" or "Average" option from the "Sum/Avg" dropdown list. If you do not select either of these options, m-Power will place the last value from the detail level into each subtotal line.

Note: Selecting Average or Summary will create a new field within your Data Dictionary. Because of this, you must specify a new name. Additionally, consider adding a length of two to new fields' lengths to compensate for possible data truncation. If you would like to add a new description, you can do so under the "Text" column.

After finishing, click 'Accept'. You can now join to additional tables, and will be brought back to the Summary Field Definition screen after each subsequent join.

Sequencing

When building a summary application, multiple sequence keys are allowed. However, only one subtotaled field is allowed, and this subtotal will represent the data in the table as no detail information will be included in the new summary table.

Field Settings

Here you will find the settings for all the fields in the application. The options are:

Delete: You can delete fields by clicking the checkbox and clicking Accept. If a field has a red circle with a cross line, that means that the field is being used somewhere else in the application (sequence, calculation, etc.), and, due to this dependency, is not available for deletion. NOTE: Deleting a field will remove the field from the application only, the table will be unchanged.

Field Name: This is the same name the field has in the table.

Table: The name of the table where that field exists.

New Name: This is the new name you gave to your field in the Summary Field Definition screen.

New Description: This is the new description you gave to your field in the Summary Field Definition screen.

Write Field?: Specify whether the field should be written to the database.

Size: This displays the length of a field. If a field has a length consisting of two numbers separated by a comma, the first number will be the integer length and the second the decimal length of the field.

User def: This option has been deprecated.

Record Selections

Record Selections can be created over any database fields. These are the options:

Field: A drop down allows you to select the field you want to filter on.

Relation: A drop down allows you to select a relationship for the filter.

Value: This is the value to compare against. The options are:

Constant Value: A constant value allows you to hard-code any given value into a selection. This value cannot be modified by the end-user at run–time.

Application Field Value: Developers have the option of comparing a value from one field to a value from another field within the same record.

Runtime Value Prompt: This option allows end-users to decide the value of their record selection at runtime.

And/Or: When creating multiple record selections, you have the option to set them as "and" or "or" Example: selection A "and" selection B will display only records that match both selections. Selection A "or" selection B will display records that match one or both selections. Learn more.

Calculations

Calculations are a very powerful feature of m-Power. In summaries, calculations can be written to the database to create a new field. Learn more. As such, developers have the ability to name the field created by the calculation.

Note: If the chosen Calculation Name already exists (either as a field or another summary calculation) with different attributes, an error message will be displayed showing the existing definition. You must either change the Calculation Name to a unique name, or change the attributes to match the existing definition.

External Objects

This feature allows developers to connect m-Power application with their current business logic, or to extend m-Power capabilities by allowing developers to write their own Java, RPG, or SQL programs, and integrating these programs into the applications. m-Power utilizes "locations" to connect the external objects, these locations vary depending on what the external object does and when it should be executed. The following locations are supported in this template:

*JREADRCRD: This location calls the object for each record, after reading the record.
*STRSEARCH: This location has been deprecated for this template.
Learn more

SmartLinks

SmartLinks are not supported in Summary templates since Summaries do not output to the screen, but rather write back to the database in the form of a new table. For testing and debugging purposes, there is a runtime shell that can be run in the browser, but generally end users will never run a Summary since they are most often scheduled to be run at desired intervals using the Scheduled Tasks and Messaging plugin.

Recompiling

Note that unlike other applications, recompiling a summary causes the summary table to be dropped and recreated.

Back to the Top

Application Properties

When accessing the Application Properties, a window will slide open with several tabs; let’s go through each of the tabs:

Back to the Top

Other Notes

In Memory Summaries that have been generated can be found as a zip file within /mrcjava/WEB-INF/classes/DATA_DICTIONARY/TABLE_NAME.zip. This file is useful in the event that Tomcat needs to be restarted. If this occurs, Tomcat will reload the data from this file into memory upon an end-user querying this data set.

Web Parameters

Common Parameters — These parameters apply to every template:

Name Valid Values Example Value Default Value Description
basic
  • 0: Off
  • 1: On
1 0 This parameter allows the app to only display the main content area.
CALCULAXXX
  • Any URL-encoded value
5000 When a calculation is a parameter calc, you can pass its value across the URL to other mrc applications. Use CALCULA001 for your first calculation, CALCULA002 for your second calculation, and so on, for all your parameter calculations.
Custom Parameters
  • Any URL-encoded value
33 Freemarker custom parameters can be passed through the URL.
data
  • 0: Off
  • 1: On
1 0 This parameter allows the app to only display the main data table.
debug
  • 0: Off
  • 1: On
  • 2: On & Show Import URLs
1 0 Loads your application with SQL statement and application logic time listed. This is often useful in determining how your dataset was determined and deciding if indexes should be created for this query.
devicetype
  • pc: Computer
  • tab: Tablet
  • mob: Smartphone
tab pc This parameter sets the current device type mode for the entire session. While device is automatically seen and set, you can use this to manually change it to a different device type.
FIELD
  • Any URL-encoded value
23 Applications allow you to pass values directly to any field when it is specified as a sequence key.
help
  • 0: Off
  • 1: On
1 0 This parameter controls whether the parameter listing screen should be displayed for this application or not.
hide_header_footer
  • 0: Show header/footer
  • 1: Hide header/footer
1 0 This parameter controls whether the header and footer are hidden.
impTags
  • Any positive integer
1 0 This parameter allows the app to only display the HTML inside the associated custom import.
init
  • 0: Off
  • 1: On
1 0 Forces your application to refresh the page from the server. Useful if you are making changes in a development environment but are not seeing your changes.
locale
  • ar: Arabic
  • bg: Bulgarian
  • ca: Catalan
  • zh: Chinese
  • cs: Czech
  • da: Danish
  • nl: Dutch
  • en: English
  • et: Estonian
  • fi: Finnish
  • fr: French
  • de: German
  • el: Greek
  • he: Haitian Creole
  • hi: Hindi
  • ht: Hebrew
  • hu: Hungarian
  • id: Indonesian
  • it: Italian
  • ja: Japanese
  • ko: Korean
  • lv: Latvian
  • lt: Lithuanian
  • no: Norwegian
  • pl: Polish
  • pt: Portuguese
  • ro: Romanian
  • ru: Russian
  • sk: Slovak
  • sl: Slovene
  • es: Spanish
  • sv: Swedish
  • th: Thai
  • tr: Turkish
  • uk: Ukrainian
  • vi: Vietnamese
es en This lets you choose which language layer to view for the entire session. Only available when using the m-Power Translate feature.

 

In-Memory Summary Specific Parameters:

Name Valid Values Example Value Default Value Description
run
  • 0: Display prompt page
  • 1: Display output page with no levels
  • 2: Display output with default levels
  • 5: Display output with only highest subtotal level
  • 6: Display output with highest subtotal and grand total levels
2 0 This option tells your report whether to show a prompt page or not.
RXXX
  • Any URL-encoded value
23 Replacing XXX with your prompted record selection # (i.e. your first runtime value prompt record selection would be R001). If Range or List relation, separate values with a space.

Back to the Top

Created: August 12, 2015 | Modified: September 28, 2016