Add a data map record

Applies to User Roles:

System Administrator

To add a data map record:

  1. Click System Administration > Base System Configuration > Miscellaneous > DataMaps.
  2. Fill in the following fields.

    Field Description
    Desc Type a description of the data map record.
    Filename Type the name of the Service Manager table with the primary key field that you want to query. Service Manager purges or archives records from this table. This is a required field for all data map records.
    Type Service Manager automatically populates this field with the data map type 0, 1, or 2. Do not change the value of this field directly.
    Field Name Type the name of the primary key field for the table to create a Type 0 data map, or type the name of the join field to query for Type 1 and Type 2 data maps. This is a required field for all data map records.
    Array? Type true or false to specify whether the join field to query is an array. By default, this field is false. Choose true if the data map is to check every element in the array for related records in the external file. This field is only for Type 1 data maps.
    Arrayed Structure? Type true or false to specify whether the join field to query is an arrayed structure. By default, this field is false. Choose true if the data map is to check every element in the AS Field No. for related records in the external file. This field is only for Type 1 data maps.
    AS Field No Type the ID number of the join field to query in an Arrayed Structure. This ID number is defined in the dbdict.
    Map Query Type the query to identify source records in the primary table. Adding a query to this field makes the record a Type 0 or Type 2 data map, depending on the Query File value. You must write this query in the Service Manager query format, and you can use the following variables:

    $umapdata — This variable stores the value of the Field Name field of the current record. For example, the Field Name was name, the value could be an operator such as System.Admin or a form name such as contacts depending on the table you are querying.

    $umapfile — This variable reads the value of the Filename field in the purge or archive record.

    $umap.modtime — This variable reads the value of the current modification time in the purge or archive record.

    $umap.mod.date — This variable reads the value of the last modification date in the purge or archive record. If no value is listed, Service Manager displays the current date and time.

    $acntr — This variables reads the value of the element in an array or array of structures in the purge or archive record.
    Query File Type the name of the external file to query for related records. Adding an entry to this field makes the record a Type 1 or Type 2 data map, depending on the Map Query value.
    Override Qry Type the query used to replace the Field Name to identify related records in the external file. If this field is blank, Service Manager uses the Field Name as the join field to query for related records. Adding an entry to this field makes the record a Type 1 or Type 2 data map, depending on the Map Query value.
    Map Cond Type true, false, or a Boolean expression that evaluates to true or false to identify when Service Manager should use this data map record. By default, this field is true meaning that Service Manager should use the data map in all conditions.
    Add to Map List Type true, false, or a Boolean expression that evaluates to true or false to identify when Service Manager should add an entry to the data map list. By default, this field is true meaning that Service Manager should always add an entry to the data map list..

  3. Click Add.

Related topics

Data maps
Alternatives to data maps
Types of data maps
Exporting records
Importing records
Purging and archiving records
Unload script utility
Master data records

Create data maps to related records
Delete a data map record
Update a data map record
View a data map record