Skip to content

Create Map Definition#

🔒 MapDefinition.Create

🔒 MapDefinition.CreateTemplate

🔒 MapDefinition.CreateFromTemplate

Overview#

This operation is used to create a Map Definition. A template can also be created using a similar procedure and there is also the possibility of using a template to create the new object as well. This selection can be done in the main entity menu.

Setup#

No specific setup is required other than to meet the preconditions of the transaction.

Preconditions#

  • The Map Definition does not currently exist in the system.

Sequence of Steps#

Step 1: General Data#

  1. Provide a name for the Map Definition.
  2. Optionally, provide a description of the Map Definition.
  3. Select the Map Definition type. The list of possible values is taken from the lookup table MapDefinitionType.

  4. Select the Layout Type:

    • Regular: the map consists of units that are regular rectangles or squares.
    • Irregular: the map consists of units that have irregular shapes and positions. In this case it's necessary to provide a layout file according to the expected format as described in the Map Definition section.

  5. For regular maps, enter the number of Rows of the Map Definition.

  6. For regular maps, enter the number of Columns of the Map Definition.

    Info

    For regular maps, the number of rows and columns will be inferred from the Mask file, if one is provided.

  7. Enter the Height (used for display purposes).

  8. Enter the Width (used for display purposes).

  9. Enter the Dimension Units - the values are taken from the lookup table Units.

    Info

    For irregular maps, if the Height and Width are not defined, the system will use the Height and Width as defined in the Layout file

  10. Optionally, upload a Mask. A Mask is a XML file compliant with the G85 format. The units with the NullBin value are considered as non-existing in the Map Definition. All other values are considered as existing units.

    Info

    The mask applies to all the layers of the map definition.

  11. For irregular maps, a layout definition file must be provided. Each unit in the file must be unique and sequential.

  12. Optionally, select a background image.

  13. Define the colors to apply to empty (unused) units.

  14. Define the color for grid lines.
  15. Select whether the grid lines should be shown by default.
  16. Specify the Notch:
    • None, no notch
    • Bottom, notch at the bottom of the map
    • Left, notch at the left of the map
    • Right, notch at the right of the map
    • Top, notch at the top of the map
  17. Specify the default rotation (counter-clockwise):
    • Rotate0
    • Rotate90
    • Rotate180
    • Rotate270
  18. Optionally, define the units of the Map of this Map Definition. If it's intended to synchronize a Material with a Map, the units of the Map Definition of the Map must match with either the primary or secondary units of the Material.
  19. Define the ruler mode:
    • Absolute, starts with one and continues even in the case of breaks
    • ContinueOnBreak, starts with one and skips breaks
    • ResetOnBreak, starts with one but it's reset whenever there is a break
  20. Select whether the ruler should be shown by default.
  21. Select Next to continue to the Layer configuration of the Map Definition.

create_map_definition_step_one

Step 2: Layers#

This section is used to define the Layers of the Map Definition. You can copy the Layers from another Map Definition by pressing the copy button on the left side panel and selecting the source Map Definition that contains the desired layers. Pressing Copy will copy the Layers to the current Map Definition.

create_map_definition_step_three

To add Layers manually, add as many Layers as desired (press in the top right of the grid to add, and to remove), specifying for each Layer, depending on the type of Map Definition:

  1. Name
  2. Layer Type:
    • Attribute, if intended to store values
    • Bin, if intended to store bin values
    • Loss, if intended to store loss reasons (only one layer of this type is supported per Map Definition)
    • Loss Classification, if intended to store loss classifications
    • Measurement, if intended to store a measurement
  3. If the Layer type is Loss, optionally the Bonus Reason can be defined.
  4. If the Layer type is LossClassification, it's necessary to specify a loss classification name.
  5. Data type (for Loss and Loss Classifications, it's automatically set to String).
  6. If the data type is Decimal, it's necessary to specify the precision.
  7. If the data type is String, it's necessary to define the data type size.
  8. Optionally, define the default value for the layer - every unit of the layer will be initialized with this value.
  9. Define whether the Layer is the default layer (each Map Definition requires one and only one default layer).
  10. Define whether the values should be shown by default.
  11. Define whether the Layer unit information must be displayed on the Unit details information tooltip or not. This tooltip is only shown for irregular Maps.
  12. Define the default background color for the units of the layer.

  13. Define the default foreground color for the units of the layer.

  14. Select Next to continue to the Filters configuration of the Map Definition.

create_map_definition_step_two

Step 3: Filters#

This tab is used to define the filters for the layer.

  1. Define the name of the filter.
  2. Check whether the filter should be pre-selected or not.
  3. Define whether the filter is a filter good filter or not (there can be only one filter good filter per layer)
  4. Define the filter type:
    • Inclusion list: it checks for units matching a list of values
    • Exclusion list: it checks for units not matching a list of values
    • Range: it checks for a range of values
  5. Depending on the filter type, define the inclusion list (semi-colon separated list, e.g.: 1;2;3), the exclusion list (semi-colon separated list. e.g.:1;2;3) or range (a bracket defined interval, e.g.: ]3:5] to specify values from 3 up until, but excluding 5).
  6. Optionally define the pick code, typically used for automation.
  7. Define the background color for the filter.
  8. Optionally, for layers of type Bin and if the filter good is false, define a Loss reason.

  9. Define the foreground color for the filter.

    Info

    The filters must be disjointed, that is, they must never overlap.

  10. Select Create to complete the operation and the new Map Definition will be created.

create_map_definition_step_four