Parameter Listing

 

m-Power templates allow you, as a developer, to specify numerous parameters at run-time to control the behavior of your applications. Below you will find a complete listing of available parameters. Parameters listed as "Work Fields" indicate that while m-Power uses these parameters, you do not have control to change them.

Common Parameters — These parameters apply to every template:

Name Possible Values Example Value Description
debug 0: Off
1: On
2: On & Show Import Statements rather than Imported applications
1 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.
init 0: Off
1: On
1 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.
preview 0: Off
1: On
1 Used with m-Painter's "Save and Preview" option. This option tells the page to not use the permanent version of this file, but rather the temporary one from your changes in m-Painter.
FIELD Any value 23 Applications allow you to pass values directly to any field when it is specified as a sequence key.
CALCULA001 Any 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.

Multiple Record Retrieval Parameters

Name Possible Values Example Value Description
slnk 0: Off
1: On
1 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.
max_rows Any number 15 This parameter controls how many rows will be displayed when the page is called.
val_FIELD Any field CUSNO Used in conjunction with rls_FIELD, this is often used when you want to utilize relationships other than EQ & GE, within a retrieval. For instance, specifying val_CNAME=ABC means that your page will use ABC as the value against whatever relationship you specified in rls_CNAME.
rls_FIELD EQ, NE, GE, GT, LE, LT, LS, NS, RG, NR, NG, NL, CT, CA, CO, SW EQ Replace X with any standard two digit relationship. Using the example above, rls_CNAME=CT would show all records where "ABC" existed within the CNAME field.
pageName Any .html page secondary.html This parameter allows you to have multiple screens per application. Often useful when you need to paint outputs differently, yet still use the same application.

Multiple Record Retrieval Work Fields

Name Possible Values Example Value Description
sort_typ ASC, DESC ASC m-Power uses this option to know whether to sort by ASC or DESC.
cur_sort_col Any field within the application CUSNO m-Power uses this option to remember what field the user has chosen to sort by at run-time.
reorder Y, N N m-Power uses this option to inform the server of the sort action, which it changes via JavaScript upon user clicking sort arrows.
pageNum Any numeric value 1 m-Power uses this option to know which page within a multiple record retrieval you are currently on.

Calendar Parameters

Name Possible Values Example Value Description
year Any 4 digit year 2010 Passing the year to an application will cause your calendar to jump to the specified year.
month Any 2 digit month 03 Passing the month to an application will cause your calendar to jump to the specified month.

Report Parameters

Name Possible Values Example Value Description
run 0 = Display prompt page
1 = Display output, and accept other parameters (such as what levels to display and what format)
2 = Display output and assume all application defaults for levels and output
5 = Display output, assume default output, and display only highest level of subtotal
6 = Display output, assume default output, and display highest level of subtotal and grand total.
2 This option tells your report how to behave when deciding how to show its data output.
outfmt 0 = HTML
1 = Print Optimized HTML
4 = XML
5/6 = TAB
11 = PDF
12 = CSV
13 = True-Excel
14 = Text output
0 This option allows you to control the format of your report's output.
RYYY Any value 23 Replacing YYY with your prompted record selection # (For instance, your 1st prompted record selection would be R001). This option allows you to pass record selections directly to this page, thus bypassing the prompt page. If Range, R001 would be first and second variable.
G_TOTAL 0: Off
1: On
1 This option can only be used with the run=1 option. Specifies to display grand total information.
S_FIELD 0: Off
1: On
1 Where FIELD is a Sub-totaled FIELD. This option can only be used with the run=1 option. Specifies to display sub-total information for FIELD.
D_DETAIL 0: Off
1: On
1 This option can only be used with the run=1 option. Specifies to display detail level information.
rptPage Any .html page secondary.html This parameter allows you to have multiple screens per application. Often useful when you need to paint outputs differently, yet still use the same application.
sort_typ 0: Asec
1: Desc
1 Allows you to control the sorting direction of your report.
cur_sort_col Any current field in the application. CUSNO Doing this would allow you to override the default sorting order, instead sorting by the field listed.
top10 Any number 15 Controls how many records will be returned to your report.
email_send 0: Do not send email
1: Send email
1 Controls whether report is emailed
email_to Any email address support@mrc-productivity.com Controls who the report is emailed to
email_cc Any email address support@mrc-productivity.com Controls who will be cc'd in the email.
email_subject Any text Urgent Controls what the subject of the email will be.

Report Work Fields

Name Possible Values Example Value Description
has_total 0, the # of sequence keys selected 0 m-Power uses this option to inform server the subtotal level. If no sub-totals are displayed the value is 0. If any subtotal is showed, the total number of subtotals available will be shown.
reorder Y, N N m-Power uses this option to inform the server of the sort action, which it changes via JavaScript upon user clicking sort arrows.

Single Record Maintenance Parameters

Name Possible Values Example Value Description
action_mode AVK&slnk=1 — Add mode, will wait for user to make changes and press accept.
UVK — Update mode, will wait for user to make changes and press accept.
DVK — Delete mode, will wait for user to make changes and press accept.
AUR&one_step=1 — Add mode, performs automatically. Useful for one-step maintainers.
URD&one_step=1 — Update mode, performs automatically. Useful for one-step maintainers.
DDR&one_step=1 — Delete mode, performs automatically. Useful for one-step maintainers.
UVK Used to switch the mode of the maintainer.
add_redir Any website, using the full address or relative path. http://www.mrc-productivity.com Will add record then redirect to full URL.
upd_redir Any website, using the full address or relative path. MRCWORKLIB.I00010s Will update record then redirect to full URL.
dlt_redir Any website, using the full address or relative path. http://www.mrc-productivity.com Will delete record then redirect to full URL.
all_redir Any website, using the full address or relative path. MRCWORKLIB.I00010s Will perform any action, then redirect to full URL. Only used if above three options are blank.
pageName Any .html page secondary.html This parameter allows you to have multiple screens per application. Often useful when you need to paint outputs differently, yet still use the same application.
slnk=1 0, 1 1 This option is only used in conjunction with action_mode=UVK.

Work-With Maintenance Parameters

Name Possible Values Example Value Description
work_with 0 — Use Update screen only
1 — Place the list and update portion of the maintenance application on the same page.
2 — Place the list and update portion of the maintenance application on different pages.
3 — Use list screen only.
2 This option allows you to control the behavior of your Work-With Maintainer. You can control whether the list and maintain screens are together on the same page or on separate pages.
one_step 0: Prompt (Default)
1: Perform
1 This option tells the maintenance whether to wait or perform user request. Often used in one-step maintenance applications.
add_redir Any website, using the full address or relative path. http://www.mrc-productivity.com Will add record then redirect to full URL.
upd_redir Any website, using the full address or relative path. MRCWORKLIB.I00010s Will update record then redirect to full URL.
dlt_redir Any website, using the full address or relative path. http://www.mrc-productivity.com Will delete record then redirect to full URL.
all_redir Any website, using the full address or relative path. MRCWORKLIB.I00010s Will perform any action, then redirect to full URL. Option is only taken if above three options are blank.
pageName Any .html page secondary.html This parameter allows you to have multiple screens per application. Often useful when you need to paint outputs differently, yet still use the same application.
pageName1 Any .html page secondary.html Similar to the option listed above, this page controls the value for the "Update" screen of the work-with maintenance application.
slnk=1 0, 1 1 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.
max_rows Any number 15 This parameter controls how many rows will be displayed when the page is called.

Work-with Maintenance Work Fields

Name Possible Values Example Value Description
recpos Any number greater than 0 10 m-Power uses this field to keep track of what record you are currently viewing in your work-with maintenance application. This is needed because after you modify a record, it needs to know to return you to the proper record.

Grid Maintenance Parameters

Name Possible Values Example Value Description
slnk 0: Off
1: On
1 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.
max_rows Any number 15 This parameter controls how many rows will be displayed when the page is called.
pageName Any .html page secondary.html This parameter allows you to have multiple screens per application. Often useful when you need to paint outputs differently, yet still use the same application.
upd_redir Any website, using the full address or relative path. MRCWORKLIB.I00010s Will update record then redirect to full URL.
dlt_redir Any website, using the full address or relative path. http://www.mrc-productivity.com Will delete record then redirect to full URL.
all_redir Any website, using the full address or relative path. MRCWORKLIB.I00010s Will perform any action, then redirect to full URL. Option is only taken if above three options are blank.

Grid Maintenance Work Fields

Name Possible Values Example Value Description
total_rows Any positive numeric values 15 m-Power uses this field to assess the number of rows used per page.
sort_typ Any field within the application ASC m-Power uses this option to know whether to sort by ASC or DESC.
cur_sort_col Any field within the application CUSNO m-Power uses this option to remember what field the user has chosen to sort by at run-time.

Re-Order Maintenance Parameters

Name Possible Values Example Value Description
upd_redir Any website, using the full address or relative path. MRCWORKLIB.I00010s Will update record then redirect to full URL.
pageName Any .html page secondary.html This parameter allows you to have multiple screens per application. Often useful when you need to paint outputs differently, yet still use the same application.
slnk 0: Off
1: On
1 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 field CUSNO Used in conjunction with rls_FIELD, this is often used when you want to utilize relationships other than EQ & GE, within a retrieval. For instance, specifying val_CNAME=ABC means that your page will use ABC as the value against whatever relationship you specified in rls_CNAME.
rls_FIELD EQ, NE, GE, GT, LE, LT, LS, NS, RG, NR, NG, NL, CT, CA, CO, SW EQ Replace X with any standard two digit relationship. Using the example above, rls_CNAME=CT would show all records where "ABC" existed within the CNAME field.
max_rows Any number 15 This parameter controls how many rows will be displayed when the page is called.

Created: March 3, 2010 | Modified: July 19, 2016