1. Import and export data
  2. Import Data into Models
  3. Clear the Target for a Module Import

Clearing the target is available for module import. When you start an import, have chosen the source file, and have set any required file options, you are taken to the Mapping tab on the Import dialog. There are two options for how existing items in the target will be updated with respect to the items that are mapped in from the source.

  • Clear target prior to import. This is the default. If you select this option, then target item values will be zeroed prior to import and replaced with the source item values that are mapped in. When you have selected to clear the target prior to import on the Mapping tab, to get the import results you want you must now complete your clearing target setup for the import using the additional clearing options found on the Time mapping tab and any other target dimension mapping tabs.
  • Only update imported cells. If you select this option, then the import process will only update any existing target item values for which there are matching source item values that are mapped in.

The following sections explain how to complete your clearing the target setup to suit your import requirements:

Clearing the Target for Time

When you select to clear the target prior to import on the Mapping tab on the Import dialog, on the Time tab you can select one of two options under What time periods to clear prior to import? Use these options to control exactly how existing target items are cleared by time period prior to import:

  • Matched items only
    This clears for any items found in the source which are matched in the target according to a two-part rule: Where there is a source item which matches with an existing target item, (i) those cells are cleared for the time periods in the target that the matched item contains a value in the source; and (ii) cells for that matched item are also cleared in the target for any other time periods where any other matched source line item contains a value in the source. You can think of this as a "squaring-off" rule across matched line items to clear out time periods in the target prior to import.
  • All items
    This clears for items found in the source which are matched in the target according to the following rule: Where there is a source item which matches with an existing target item, the matched item's cells are cleared in the target for all time periods .

Clearing the Target for Time: Matched items only example

To illustrate how the clearing rule works for Matched items only for time periods, here is a simple example. The Number Target module has a time dimension for months and the Number Source contains two matched line items: one with a data value for Jan 15, and one with a data value for Mar 15. When the import is run, this is the result:

It's easy to see why the cells for Line Item1 Jan 15 and Line Item5 Mar 15 are cleared: we want to bring in the data values in the source for those items matched between source and target. Why are the Line Item1 Mar 15 and Line Item5 Jan 15 (those in red) cells also cleared prior to import? The "squaring-off" rule operates in this way:

  • Line Item1 is matched in the target, so the Jan 15 cell for this line item is cleared, because in the source item this time period contains a value. But the Mar 15 cell is also cleared, because there is another match between source and target items (Line Item5) and this other matched item has a value in the source for the Mar 15 time period.
  • Line Item5 is matched in the target, so the Mar 15 cell for this line item is cleared, because in the source item this time period contains a value. But the Jan 15 cell is also cleared, because there is another match between source and target items (Line Item1) and this other matched item has a value in the source for the Jan 15 time period.

Clearing the Target for Time: All items example

To illustrate how the clearing rule works for All items for time periods, here is a simple example. The Number Target module has a time dimension for months and the Number Source contains two matched line items: one with a data value for Jan 15, and one with a data value for Mar 15. When the import is run, this is the result:

Because there are matched items in the source for Line Item1 Jan 15 time period and Line Item5 Mar 15, those time periods are cleared for the matched line items in the target and the source values imported. The rule for the All items option then clears out all other time periods in the target for matched items.

Clearing the Target for Dimensions other than Time

When you select to clear the target prior to import on the Mapping tab on the Import dialog, you can select different clearing options on mapping tabs for dimensions other than time. The default setting for mapping data by dimensions other than time is to Match on names or codes:

In this example, we have a Number Source module for importing data and the mapping option for line items is set to Match on names or codes. When you select to map by matching names or codes between source and target, the options for clearing target items are:

  • Matched items in source
  • All items

See Clearing the Target for other Dimensions: Matching on Names or Code Options.

If you select to Map items manually by the dimension, then the options for clearing the target items by the dimension change:

In this example, we have a module for importing data called Target and the mapping option for line items is set to Map items manually. When you select to map items manually between source and target, the options for clearing target items are:

  • Mapped items in source
  • All mapped items
  • All items

See Clearing the Target for other Dimensions: Manual Mapping Options

Clearing the Target for other Dimensions: Matching on Names or Codes Options

If you select to Match on names or codes for your import mapping, then the system automatically maps data in by matching items found in the source to items found in the target. The two options for clearing the target for this kind of mapping work in the following way:

  • All items
    All target items are cleared, regardless of whether or not they have a match in the source.
  • Matched items in source
    Only those target items are cleared for which there exists a matching item in the source.

Clearing the Target for other Dimensions: Manual Mapping Options

If you select to Map items manually for your import, then an administrator user must manually define which source items are mapped into which target items as part of the import setup. The three options for clearing the target on this kind of mapping work in the following way:

  • All items
    All target items are cleared, regardless of whether or not they have been mapped or exist in the source.
  • All mapped items
    All and only the mapped items are cleared. Note that in any particular import run, some of the source items manually mapped in the original setup may no longer exist in the source, but these mapped items will still be cleared in the target.
  • Mapped items in source
    All and only the mapped items are cleared, provided they still exist in the source at the time the import is run. (Note the important contrast in clearing behavior with the All mapped items option with respect to what exists in the source at the time the import is run .)