Description of the Sub-Menu Countries
From Metis Documentation
| Line 1: | Line 1: | ||
| - | In Metis Smart Suite, all location data is managed in the '''Countries''' sub-menu. The location data consists of countries, states, and cities which are presented to the user in this menu divided into the three different tables linked to | + | In Metis Smart Suite, all location data is managed in the '''Countries''' sub-menu. The location data consists of countries, states, and cities which are presented to the user in this menu. The screen is divided into the three different tables linked to each other. Location data is used in many different places throughout Metis Smart Suite. Whether creating a new user or version, or when creating a new address or contact person; location data is always important to be define and helps setting up other information in the application. |
| - | |||
| - | * '''First column''' : | + | [[File:MSM-Data-Management-Countries.png|center|600x400px]] |
| + | |||
| + | |||
| + | When on the '''Countries''' sub-menu, a collection of three tables is shown. Each of the three tables displays three columns in the following format: | ||
| + | |||
| + | * '''First column''' : padlock icon which signifies that the item cannot be edited from the version currently logged into. | ||
* '''Code''' : used as additional information about the Country, State, or City created by the user (for example ISO codes for countries or ZIP codes for cities). | * '''Code''' : used as additional information about the Country, State, or City created by the user (for example ISO codes for countries or ZIP codes for cities). | ||
* '''Country, State, or City''' : The name of the Country, State, or City. | * '''Country, State, or City''' : The name of the Country, State, or City. | ||
| Line 10: | Line 14: | ||
| - | |||
| - | + | ==Creating new countries, states or cities== | |
| + | |||
| + | In the '''Countries''' sub-menu, the "Add" button [[File:MetisSmartModelingAddButton.PNG|link=]] located above the main tables allows the user/administrator to create a new country, state or city. When it is clicked, a window appears letting the user chose which type of data object (Country, State or City) to create. | ||
| + | |||
| + | |||
| + | [[File:MSM_Data_Management_Countries_Add.png|center]] | ||
| + | |||
The window contains the following radio buttons: | The window contains the following radio buttons: | ||
| - | *State | + | * Country |
| - | *City | + | * State |
| + | * City | ||
| + | |||
| + | |||
| + | Once a selection has been made and validated, a window specific to the choice made opens. | ||
| - | |||
| Line 26: | Line 38: | ||
Selecting the '''Country''' radio button opens the '''Country''' window. In this window the user must fill in the following fields: | Selecting the '''Country''' radio button opens the '''Country''' window. In this window the user must fill in the following fields: | ||
| - | *Code: | + | * '''Code''' : an additional reference to the country. |
| - | *Description: | + | * '''Description''' : name of the country for each of the available languages. |
| + | |||
| + | |||
| + | [[File:MSM_Data_Management_Countries_Add_Country.png|center|600x400px]] | ||
| + | |||
{{Note | {{Note | ||
| - | | It is highly recommended that the user use the ISO country code when filling in the code field. | + | | It is highly recommended that the user use the ISO country code when filling in the code field, has it may be used by the application. |
}} | }} | ||
| + | |||
| + | |||
| + | Once all related mandatory and optional information have been set, the new Country can be saved by validating the '''Country''' window using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window. | ||
| + | |||
| Line 38: | Line 58: | ||
Selecting the '''State''' radio button opens the '''State''' window. In this window the user must fill in the following fields: | Selecting the '''State''' radio button opens the '''State''' window. In this window the user must fill in the following fields: | ||
| - | *Country: | + | * '''Country''' : country in which lies the state. |
| - | *Code: | + | * '''Code''' : an additional reference to the state ( for example an abbreviation of the name). |
| - | *Description: | + | * '''Description''' : name of the state for each of the available languages. |
| + | |||
| + | |||
| + | [[File:MSM_Data_Management_Countries_Add_State.png|center|600x400px]] | ||
| + | |||
| + | |||
| + | Once all related mandatory and optional information have been set, the new State can be saved by validating the '''State''' window using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window. | ||
| + | |||
| Line 47: | Line 74: | ||
Selecting the '''City''' radio button opens the '''City''' window. In this window the user must fill in the following fields: | Selecting the '''City''' radio button opens the '''City''' window. In this window the user must fill in the following fields: | ||
| - | * | + | * '''Country''' : The country in which lies the city. Selecting the country will then list the states linked to it in the next drop-down list. |
| - | + | * '''State''' : The state in which lies the city. | |
| - | *State: The state in which lies the city. | + | * '''Code''' : an additional reference to the city (for example, the ZIP code of the city or location). |
| - | *Description: | + | * '''Description''' : name of the city or location for each of the available languages. |
| + | |||
| + | |||
| + | [[File:MSM_Data_Management_Countries_Add_City.png|center|600x400px]] | ||
| + | |||
| + | |||
| + | Once all related mandatory and optional information have been set, the new City can be saved by validating the '''City''' window using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window. | ||
| + | |||
| + | |||
| + | |||
| + | {{Video | ||
| + | | <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/5/58/VID_CreatingCityState.PNG'>File:Creating_State_City_OK.mp4</mediaplayer> | ||
| + | | Defining a State and a City. | ||
| + | }} | ||
| + | |||
| + | |||
| + | |||
| + | ==Deleting countries, states or cities== | ||
| + | |||
| + | The "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] allows the user to delete an existing country, state or city. | ||
| + | |||
| + | The user selects the country, state, or city to delete and clicks the '''Delete''' button. A selection window opens where the user must confirm their choice by selecting the appropriate radio button, based on the type of information which needs to be deleted. | ||
| + | |||
| + | |||
| + | [[File:MSM_Data_Management_Countries_Delete.png|center]] | ||
| + | |||
| + | |||
| + | {{Note | ||
| + | | The available options (country, state or city) is based on the selection done in the main window. If no city is displayed in this window, the city option will not be available as no city is selected. | ||
| + | }} | ||
| + | |||
| + | |||
| + | {{Warning | ||
| + | | Countries, states, and cities with a lock icon before them cannot be deleted. | ||
| + | }} | ||
| + | |||
| - | == | + | ==Editing countries, states or cities== |
| - | The | + | The "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] allows the user to see and modify the properties of a country, state or city. |
| - | + | Selecting a country, state or city and clicking on the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] opens a selection window where the user must confirm their choice by selecting the appropriate radio button. | |
| - | |||
| - | [ | + | [[File:MSM_Data_Management_Countries_Add.png|center]] |
| - | + | After validation the corresponding edition window opens up with the selected information displayed in it. All the properties of the item may be modified. However, if a lock icon is found before the selected item, only the description may be modified. | |
| - | |||
| - | + | [[File:MSM_Data_Management_Countries_Edit_State.png|center|600x400px]] | |
| - | |||
| + | ==Previewing countries, states or cities== | ||
| + | The "Preview" button [[File:MetisSmartModelingPreviewButton.PNG|link=]] allows the user to see the properties of the selected country, state or city. Selecting a country, state or city and clicking on it opens the selection window where the user must confirm their choice by selecting the appropriate radio button. Once validated the appropriate preview window is displayed. The name of the country, state or city is presented in the description field for each of the available languages as well as the code. | ||
| - | |||
| - | + | [[File:MSM_Data_Management_Countries_Preview_City.png|center|600x400px]] | |
| - | |||
| - | |||
{{Note | {{Note | ||
| - | | It is not possible to edit the properties of a country, state or city in the '''Preview''' window. This must be done | + | | It is not possible to edit the properties of a country, state or city in the '''Preview''' window. This must be done in edition mode. |
}} | }} | ||