Multimap Client Zone V2.2 Documentation - Guidelines for Editing Address Table Structure
Multimap Client Zone V2.2 Documentation - Guidelines for Editing Address Table Structure
This page relates to the procedure described in the section of the Client Zone Implementation Guidelines entitled Reviewing your table structure.
Follow these guidelines when editing fields and changing the structure of the table you will use to upload your addresses through Client Zone.
| In this field | The data you enter... | Values available | Purpose |
|---|---|---|---|
| Field name |
Must contain only letters, numbers and underscores.
Cannot be the same as an existing field. Must not be words reserved for use by Multimap's software. This field is validated so if you inadvertently choose a reserved word, this error message appears with a link to the list of words that are reserved: "You have specified a reserved word for your field name: please try a different name. See the list of reserved words for names to avoid." For examples, please see the list of reserved words below this table. |
none | To uniquely identify the contents of a field or column of data. |
| Data type |
Defines the type of data that go into this field, such as text, numbers, dates and discrete alternatives.
If you need a data type that is not listed, please contact your Multimap account manager. |
varchar |
For short pieces of text (variable-length strings).
Setting this data type requires that you set a size of 0 to 255 characters -
this is the maximum length of string that can be stored.
If a string longer than this size is inserted into your table of addresses, it will be truncated. Note: Trailing spaces are removed when values for this data type are stored. |
| Data type | " | text | For long pieces of text. This stores a string with a maximum length of 65,535 characters. |
| Data type | " | int | For positive and negative integers. Numbers must be in the range from -2147483648 to 2147483647. |
| Data type | " | datetime | A concatenation of date and time. The supported range is '1000-01-01 00:00:00' to '9999-12-31 23:59:59'. |
| Data type | " | float | To specify a positive or negative floating-point number. |
| Data type | " | double | To specify a positive or negative floating point number. This is more precise than a "float". |
| Data type | " | enum |
To ensure that this field only stores one of a number of possible strings.
Each string must be enclosed in single quotes, and be separated by commas.
For example: 'b2c','b2b' In this example, the value entered by the user in a table of addresses can only be "b2c" or "b2b" (the quotes are not required and upper- or lower-case letters are acceptable). |
| Data type | " | set |
Similar to the "enum" data type, except that the value can be any combination of the list of strings.
A string object that can have zero or more values, each of which may be chosen from the list of values 'value1', 'value2', and so on. If you choose this data type you must include the list of possible values. For example: " 'parking','disabled','carwash','recycling' " (including the single-quotation marks, commas and no spaces). In this example, the value entered by the user in a table of addresses can be "disabled,carwash" (the quotes are not required and upper- or lower-case letters are acceptable but spaces are not allowed). |
| Size |
Specifies a size or value depending on your data type.
Data types "enum" and "set" require values using the format 'a', 'b', 'c' and so on. The value entered in this field by default is optional; you can enter a different value if required. |
none | To specify the maximum amount of data allowed in the field. The smaller this is, the closer the size of your table will be to optimal. |
| Position | Changes the position (but not the name) of a field and does not affect how your data is processed. | selectable drop-down list of values | To specify the position of your field in the sequence of fields in the table definition. |
| Display name |
This field is optional.
You can use it to display a name for the current field, such as "house name" for the name field.
|
none | To let you to specify a name for the field to be displayed on the View or change address table structure page. This name does not replace the name of the field in the table itself. |
| Description |
This field is optional and lets you describe the type of information to be entered in the current field,
such as "This field is for entering a postal code" for the pc field.
|
none | To provide Client Zone users with an explanation of the type of information to enter in the field to be edited. |
| Example |
This field is optional and lets you provide an example of the type of information to enter in a field,
such as "W1A 1AA" or "10028" for the pc field.
|
none | To provide Client Zone users with an example of the type of information to enter in the field to be edited. |
These are some examples of the names that you must not specify as field names in your table of addresses:
|
|
|
If you choose a field name that is reserved but is not listed, an error message appears in Client Zone
with a link to the full list of words that you cannot use.
This includes the field names lat and lon for Multimap API services
that offer street-level geocoding of locations in the People's Republic of China,
where these fields are hidden from view.
Also please do not use any words prefixed with "f_", since this is the default prefix for Multimap filters.
If you require further help with your Multimap services, please contact the Multimap Customer Support team:
| London, Great Britain | +44 (0)20 7632 7777 |
| email: | info@multimap.com |
For general account enquiries or further services, please contact the Multimap Sales team:
| London, Great Britain | +44 (0)20 7632 7800 |
| email: | sales@multimap.com |