Skip to main content
Skip table of contents

Import Mapping File

The Import Mapping File is an XML-based file that describes to the Data Migration Utility how to parse an Excel-based File Plan in order to import its content as Record Classes, Triggers, Retentions, and Lifecycles in Records Management. Because the Import Mapping File describes how the File Plan should be parsed, this allows the File Plan to remain unaltered and in the format of your choosing.

The Import Mapping File is validated during the import process and is required to adhere to the following format:

XML
<?xml
version="1.0" encoding="UTF-8"?>
<import xmlns="http://www.gimmal.com/fileplan/import/v1">
    <recordClasses>

        <root title="Root Record Class Title" code="Root Record Class Code" /><!-- Optional: All Record Classes will be nested under
this node if provided -->
        <level>
          <mapping>
            <![CDATA[
                SELECT
                    [Excel Column] AS [Record Class Property],
                    ...
                FROM
                    [Worksheet$]
                WHERE
                    [Excel Column] some conditions
            ]]>
          </mapping>
          <levels>
            <level>
              <mapping>
                <![CDATA[
                    SELECT
                        [Excel Column] AS [Record Class Property],
                        ...
                    FROM
                        [Worksheet$]
                    WHERE
                        [Excel Column] = '{Title}' AND
                        [Excel Column] some conditions                        
                ]]>
              </mapping>
              <levels>
                <level>...
              </levels>
            </level>
            <level>...
          </levels>
        </level>
        <level>...
    </recordClasses>
    <lifecycles>
        <lifecycle>
            <mapping>
                <![CDATA[
                    SELECT
                        [Excel Column] AS [Lifecycle Property],
                        ...
                    FROM
                        [Worksheet$]
                    WHERE
                        [Excel Column] some conditions                        
                ]]>
            </mapping>

            <phases>

                 <mapping>

                      <![CDATA[
                              SELECT
                                   [Excel Column] AS [Lifecycle Phase Property],
                                   ...
                              FROM
                                  [Worksheet$]
                              WHERE
                                  [Excel Column] some conditions                         
                      ]]>

                 </mapping>

            </phases>
        </lifecycle>
        <lifecycle>...
    </lifecycles>
    <retentions>
        <retention>
            <mapping>
               <![CDATA[
                    SELECT
                        [Excel Column] AS [Retention Property],
                        [Excel Column] AS [TriggerTitle]
                        ...
                    FROM
                        [Worksheet$]
                    WHERE
                        [Excel Column] some conditions
                        
                ]]>
            </mapping>
        </retention>
        <retention>...        
    </retentions>
    <triggers>
        <eventTriggers>
            <eventTrigger>
                <mapping>
                    <![CDATA[
                        SELECT
                            'Event Name' AS [Title],
                            2 AS [AssignmentPosition],
                            4 AS [Recurrence],
                            DateValue('12/31/2000') AS [NextEventDate]
                    ]]>
                </mapping>
            </eventTrigger>
            <eventTrigger>...             
        </eventTriggers>
        <datePropTriggers>
            <datePropTrigger>
                <mapping>
                    <![CDATA[
                        SELECT                             
                            'Created' AS [Title],
                            '@created' AS [PropertyName]
                    ]]>
                </mapping>
            </datePropTrigger>
            <datePropTrigger>...
        </datePropTriggers>

        <ruleTriggers>

            <ruleTrigger>

                 <mapping>

              <![CDATA[
                    SELECT
                        [Excel Column] AS [Rule Trigger Property],
                        ...
                    FROM
                        [Worksheet$]
                    WHERE
                        [Excel Column] some conditions                        
                ]]>

                 </mapping>

                 <rules>

                       <mapping>
                <![CDATA[
                    SELECT
                        [Excel Column] AS [Rule Property],
                        ...
                    FROM
                        [Worksheet$]
                    WHERE
                        [Excel Column] some conditions                        
                ]]>

                       </mapping>

                 </rules>

            </ruleTrigger>

        </ruleTriggers>
    </triggers>
</import>


JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.