Data Upload Maintenance Template

 

Jump to:

Template Specific Notes and Instruction
Runtime Walkthrough
Template In-Action
Application Properties
Web Parameters

The Data Upload template can be used to allow end users to upload Excel files directly into the database. End users can either upload data directly from an Excel file, or copy and paste it into an onscreen text area for ease of use. At run-time, users have various options including which datasheet to upload, defining whether the first row of data should be ignored (in case the dataset contains column descriptions), and selecting whether to replace or append records to the dataset. Applications created with this template will display a status window to track the progress of the upload, and these applications will display any errors in the upload process so the end user is aware of what data was not successfully submitted to the database.

Notes on Creating a Data Upload Maintenance Application

Before using this template, the developer will need to create the database table that the template will upload the data (if one does not already exist). This requires that the developer know, ahead of time, the structure that the user will be submitting the data. Additionally, the user will not be able to change either the number of columns or the order of the columns once the table is created.

You can create the table using m-Power or any alternative method way you feel comfortable creating database tables. Once completed, ensure that the table has been registered to m-Power.

Note: Tables created with m-Power can be easily modified within m-Power. For this reason, it is recommended to create your data table with m-Power.

Template Notes

Application Settings

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

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

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. Here you can create or modify joins to other tables as well. When tables are selected, only the primary table can be modified, by default. This is done to protect developers from accidental cascading changes. This behavior can be modified within the application properties.

Sequencing

When building maintenance applications, a developer’s sequencing selection is analogous with selecting a Primary Key. This selection will tell m-Power how this table is unique.

Note: The sequence keys in this template must be the first fields listed in the application. See the Field Settings section for more information.

Field Settings

Note: The sequence keys are required to be listed first in the field settings and the order of the fields listed in field settings must match the order of the fields listed in your Excel file. If the order is not correct, use the re-order tool to fix it.

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.

Type: A drop down list that allows developers to designate whether a field is to be displayed (visible, but not edited on the database), hidden (no action), or updated. There may be situations where a field is needed for calculation purposes, but the field does not need to be displayed at runtime. Note: Sequence keys must be set to update to ensure your application functions properly

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.

Lowercase: This option determines whether or not an alpha field can be submitted to the database with lowercase letters. If this is set to "no," the field will be converted to uppercase when it is submitted.

Record Selections

Record Selections are not supported with the Data Upload Maintenance template.

Calculations

Calculations are not supported with the Data Upload Maintenance template.

External Objects

External Objects are not supported with the Data Upload Maintenance template.

SmartLinks

SmartLinks are not supported with the Data Upload Maintenance template.

Back to the Top

Runtime Walkthrough

Like its name, the Data Upload Maintenance template uploads data to the database. To use this application, begin by selecting whether the data will come from an Excel file, or be entered in spreadsheet format. We will select ‘From File’ for this example, and then browse to locate the file. Then we select which data sheet to upload, and specify whether or not to ignore the first row. This option is often selected when the first row contains header information. Next, we will select the proper ‘Load Data Action’ from the dropdown. The last row in this table, which is display only, identifies the table that the data will be loaded into.

Alternatively, we could have selected to ‘Enter Data’ in spreadsheet format. This forces a text box to open, in which data can be directly pasted. After doing so, select the delimiter for the data, and continue selecting the options as specified earlier.

Now we are ready to upload the data. After clicking upload, a message will show that the data is being uploaded. Once the upload has finished, text will appear that describes whether the upload has been successful.

Back to the Top

Template In-Action

The Data Upload Maintenance template only supports the PC presentation layer.

Back to the Top

Application Properties

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

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.

 

Data Upload Maintenance Specific Parameters:

Name Valid Values Example Value Default Value Description
load_action
  • 0: Add
  • 1: Clear and add
  • 2: Add new and update existing rows
  • 3: Add new and skip existing rows
1 0 This parameter controls how the maintainer will load the data to the table.
run
  • 0: Do not run automatically
  • 2: Run automatically
2 0 This parameter allows your Data Upload template to run automatically (such as on a schedule) using the default_upload_file property.
topLineIsHead
  • 0: Top line is data
  • 1: Top line contains column headers
1 0 This parameter controls whether the spreadsheet you are uploading has data or column headers in the first row.

Back to the Top

Created: September 25, 2013 | Modified: September 28, 2016