Address Distribution List Template

 

Jump to:

Template Notes
Application Properties
Video
Web Parameters

The Address Distribution List Template can be used in partnership with the Messaging and Scheduled Task utility to send emails to a table driven list of email recipients. This template has the additional option to map email addresses to an email group.

Note: Applications created with this template are not expected to be run in the browser.

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 I (Inquiry) 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.

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

Here you will see/modify the table you have selected for your application, as well as create or modify joins to other tables as well.

Sequencing

Here you can select the field that your application will sequence by; you can have multiple sequence fields. You can re-order the sequences to fit your application’s needs. For practical purposes, it does not matter what you sequence by in this application, as long as you lick at least on sequence key.

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.

Field Description: This is the text that will appear in the column header for that field, you can modify this field to suit your needs. This field will populate with the field description from the table by default, but it can be customized at the application level.

Display: A radio button allows developers to display or hide the field from the output page. There may be situations where a field is needed for calculation purposes, but the field does not need to be displayed at runtime.

Length: Here you can modify the length of the field. m-Power will only allow developers to shorten the length of the field, shortening a fields length will truncate its data. For example, if a field is 10 alpha and it is changed to 5 alpha, now only the first 5 characters will be displayed. The same principle applies to a numeric field, if a numeric field is 8 digits long; changing it to 4 digits long will only display the first 4 digits, and leave out the rest of digits.

Decimals: For numeric fields, you can modify the amount of decimal digits. A numeric field will have the option of changing its decimal length, alpha fields does not have a decimal option, developers can use this as an indicator to check if a field is a numeric or character type.

Numeric Format Code: For numeric fields, you can modify the way the numbers will display, this includes displaying decimals or not, how to display negative numbers, etc. Multiple formats are built in for developers to use, shall you need a different format code, m-Power allows developers to create their own User Defined Format codes; these codes will add logic for common types of fields such as: Currency, Time, or Dates. Accessing the User Defined Format Codes from the Admin section will also allow developers to modify current codes. Learn more.

Note: Do not confuse the User Defined Format Code with the User Defined Functions (UDF). The latter is a feature that allows developers to create or incorporate programing functions into m-Power. Learn more about UDFs.

User def: This feature 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.

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; with calculations, developers can create logical fields that will apply to the current application only. For example, in the Address Distribution List template, you may want to create a conditional calculation to create your email group field.

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:

*CALCOBJ This location is used when parameter calculations are present in the application. The external object is called after each row is processed.
*READRECRD This location will call the external object after each record is processed.
*STRADVSCH This location has been deprecated.
*ADVRECSEC This location has been deprecated. Learn more about Row Level security.
*SELECTFLT This location has been deprecated.
Learn more

Back to the Top

SmartLinks

SmartLinks are not supported in the Address Distribution List Template.

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

Video

Sending Emails to a Table Drive List of Recipients

Scenario: In this example I want to send a customized email to a list of customers with overdue account balances. I want to send these emails on a schedule, every Sunday night at 2:00am. With the Messaging and Scheduled Task Interface, this is easily accomplished.

Step 1: Create the email message using a retrieval application
I have built a retrieval that will serve as the body of my email. This email is simply a message that lets my customer know that their balance is past due. I have built the retrieval over a customer master file so that I include specific customer information (like account number and customer contact name) in the body of the message.

Step 2: Create an Address Distribution list application
Next, I need to create a retrieval application with the Address Distribution List template that will provide a list of accounts with overdue balances and the email addresses to send the notice to.

Step 3: Create the Message task using the Messaging and Scheduled Task Interface
I will start by creating a new task group. I will call it OVERDUE. Next, I will create my email message task by clicking "Add Task" and select "New Message".
Here I will select the retrieval application that I created in Step 1. This is the actual email body. Next, I will select HTML type Message Format. On the Recipients Tab, I will select the "Send 1 message per recipient" option so that each account receives a customized email, with their account information only. I will select the Address Distribution List that I created in step 2. Again, this application will retrieve the list of overdue accounts and the email addresses to send the email to.
Because my email retrieval message application is keyed by customer account number, I am going to map that field from my distribution list application to my email retrieval application. This will ensure that each email that gets sent contains the correct customer account information.
Finally, I will enter my email FROM address and the email subject.

Step 4: Schedule the email task
I will select the Scheduled Tasks option from the pull down menu. I am going to add a new task and select my OVERDUE task from the drop down. I will select the Every "Week" options which defaults to Sunday and select 2:00 o’clock from the remaining select options. Finally I will reload tomcat so that my scheduled task will be loaded into the scheduler.
This completes the scheduled task and nightly messaging setup.

Back to the Top

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.

 

Address Distribution List Specific Parameters:

Name Valid Values Example Value Default Value Description
max_rows
  • Any positive integer
15 10 This parameter controls how many rows will be displayed when the page is displayed.
rls_FIELD
  • EQ: Equal to
  • NE: Not equal to
  • GE: Greater than or equal to
  • GT: Greater than
  • LE: Less than or equal to
  • LT: Less than
  • LS: in the list
  • NS: not in the list
  • RG: In the range
  • NR: Not in the range
  • NG: Not greater than
  • NL: Not less than
  • CT: Contains
  • CA: Contains all
  • CO: Contains any
  • SW: Starts with
EQ This allows you to set the relationship for FIELD's filtering, and is used in conjunction with val_FIELD. For instance, rls_CNAME=CT would set column CNAME's search relationship to Contains.
slnk
  • 0: Off
  • 1: On
1 0 This parameter tells your retrieval that this page is a SmartLink. This means that the page will only show records that equal the value(s) you pass to it. Without specifying slnk=1, the page assumes a greater than or equal to (GE) relationship.
val_FIELD
  • Any URL-encoded value
23 Used in conjunction with rls_FIELD, this is used to filter apps through the URL. For instance, specifying val_CNAME=ABC means that your page will use ABC as the value to search for in column CNAME.

Back to the Top

Created: October 1, 2013 | Modified: September 28, 2016