Creating export templates with FastMap

Applies to: All deployment types

You can use an export template to format object data exported into a Microsoft Excel workbook.

By configuring parameters on the Definition worksheet of an export template, you can control the behavior of the export or its subsequent import.

Unless another template is specified, the IBM OpenPages® application uses DefaultTemplate.xlsx as the default export template.

Specifying a FastMap export template

You can create multiple export templates.

You can specify export templates based on one or more of the following criteria:

  • Content Type (object type)
  • Locale
  • Profile
Use the following rules when you are specifying criteria for an export template:
  1. Criteria are specified in the name of the export template.
  2. Each criterion is separated in the template name by a hyphen.
  3. The criteria must be specified in this order: ContentType-Locale-Profile

When users export objects, the system selects the export template to use based on the following precedence: ContentType -> Locale -> Profile.

For example, SOXRisk.xlsx is selected before DefaultTemplate-en_US-ORM Business User.xlsx, and SOXRisk-All-ORM Business User.xlsx is selected before SOXRisk.xlsx.

Note: If no match is found, the DefaultTemplate.xlsx export template is used.
The syntax for the export template name is:
<ContentType>-<Locale>-<Profile>.xlsx
Where:
  • <ContentType> is the system name of an object type (such as SOXRisk), not the localized name. To specify all object types, use DefaultTemplate for the <ContentType>.
  • <Locale> is the language and locale code (for example, en_US). To specify all locales, use All for the <Locale>.
  • <Profile> is the name of a profile in the OpenPages application.

For purposes of illustration, the examples that are listed in the following table use the Risk object type (SOXRisk) in the US English locale (en_US) for users assigned the ORM Business User profile.

Table 1. Example syntax for specifying criteria
If you want to specify... Example syntax...
A specific object type for a specific locale and profile SOXRisk-en_US-ORM Business User.xlsx
All object types (use DefaultTemplate) for a specific locale and profile DefaultTemplate-en_US-ORM Business User.xlsx
All locales (use All) for a specific object type and profile SOXRisk-All-ORM Business User.xlsx
All locales and all profiles for a specific object type SOXRisk.xlsx
All profiles for a specific object type and locale SOXRisk-en_US.xlsx
A specific profile for all object types and locales DefaultTemplate-All-ORM Business User.xlsx
Note: Subsets must honor ordering. For example, the following template names are invalid:
  • ORM Business User.xlsx - This template name is invalid because the profile name must be the third criterion in the list (not the first).
  • en_US-ORM Business User.xlsx - This template name is invalid because the locale must be the second (not the first) and the profile name must be the third (not the second) criterion in the list.

About this task

Your export template must be a valid FastMap export template. Test your export template before you share it with users.

The simplest way to create an export template is to export an object from a grid view for that object type, and then modify the file.

Procedure

  1. Open a grid view for the object type.
  2. Select an object from the grid view.
  3. Click Export icon, and then click Export.
  4. Rename the workbook.
    The syntax for the export template name is:
    <ContentType>-<Locale>-<Profile>.xlsx
  5. Modify the workbook and save it.

    Delete the data row, and then make your changes. Do not delete the header row.

  6. Click Open Administration menu Administration menu > System Configuration > System Files.

    If you do not see the System Files menu item, change to a profile that has access or ask your administrator for assistance.

  7. Select the checkbox for the Templates > FastMap > FLV folder, and then click New.
  8. Select File, and then click OK.
  9. Click Add File and select the export template that you created.
  10. Click Save.

Modifying parameters in the default FastMap export template

To add or modify parameters in the default export template, use the following steps.

Before you begin

To use this procedure, you must have the OpenPages Platform 3 profile that is associated with your username.

About this task

By default, the Definition worksheet in the DefaultTemplate.xlsx file has only the ignoreReadOnlyWarnings parameter set to TRUE. You can modify the template to include other parameters.

Procedure

  1. Click Open Administration menu Administration menu > System Configuration > System Files.
  2. Expand the Templates > FastMap > FLV folder and locate the DefaultTemplate.xlsx file.
  3. Modify the DefaultTemplate.xlsx file, save it, and check it in. For more information about editing Microsoft Office files directly from OpenPages, see Adding and working with files (attachments) on objects .
    Available parameters are listed in Table 2.