Description of the Sub-Menu SQL Management
From Metis Documentation
(Created page with "Description of the different functionalities and their impact on the other windows/menus of Metis.") |
(→Previewing an SQL Connection or Access) |
||
| Line 1: | Line 1: | ||
| - | + | As Metis Smart Suite Databases can be located either locally or remotely from the application and especially that Metis Smart is able to connect different databases from one installation, the application requires all connections to be configured within Metis Smart Suite. The SQL Management sub-menu enables the administrator to define both SQL Connections and Accesses. SQL Access are settings using a combination of Connections to simplify the selection of appropriate Connections when defining a [[Description_of_the_Sub-Menu_Functionalities|functionality profile]]. Split over two tabs, the user can add, delete, edit, preview connections and accesses in this sub-menu, as well as transfer data from one connection to another and prepare databases for maintenance. | |
| + | |||
| + | |||
| + | {{Note | ||
| + | | If the database is located on a different server, this server must be added to the Server Objects\Linked Servers of the SQL server. The Administrator must be sure that correct SQL access rights are defined and that the distributed transaction service (MSDTC) is active and correctly configured on the destination server. | ||
| + | This destination server must allow network transactions. For any questions regarding SQL Administration. The organization should be contacted! | ||
| + | }} | ||
| + | |||
| + | |||
| + | |||
| + | ==SQL Connections Tab== | ||
| + | |||
| + | In this tab, the SQL connections are presented in a table with the following five columns: | ||
| + | |||
| + | * '''Red X''' or '''Green Check-mark''' : A red X means that the connection is not available and is currently under maintenance or not reachable. The green check-mark means that everything is ok with the SQL connection. | ||
| + | * '''Connection Name''' : name of the connection | ||
| + | * '''Server''' : name of the server | ||
| + | * '''Database''' : name of the database | ||
| + | * '''User''' : name of the user used to access the Database | ||
| + | |||
| + | |||
| + | [[File:MSM-Data-Management-SQL-Connections.png|center|600x400px]] | ||
| + | |||
| + | |||
| + | |||
| + | ===Adding an SQL Connections=== | ||
| + | |||
| + | In the '''SQL Connections''' sub-menu, on the SQL Connections tab, the "Add" button [[File:MetisSmartModelingAddButton.PNG|link=]] located above the main table allows the user/administrator to create a new SQL Connection. When it is clicked, the '''SQL Connection''' creation window opens, it allows to define all related information. | ||
| + | |||
| + | |||
| + | [[File:MSM-Data-Management-SQL-Connections-New.png|center|600x400px]] | ||
| + | |||
| + | |||
| + | The first section contains the following fields: | ||
| + | |||
| + | * '''SQL Connection Name''' : internal name given to the connection | ||
| + | * '''Server Name''' : DNS name of the server or IP address | ||
| + | * '''Database Name''' : Name of the database to be accessed on the given server | ||
| + | * '''Username''' : username for accessing the database | ||
| + | * '''Password''' password for this username | ||
| + | |||
| + | |||
| + | The second section is a list of all other SQL connections organized into two columns: | ||
| + | |||
| + | * '''Authorized''' : The check-box can be ticked to authorized data transfers to the selected selected database. Multiple check-boxes can be ticked. | ||
| + | * '''Transfer to''' : The connection to which data transfer can be established. Ticking the check-box of any of the listed SQL Connections will allow data transfer from the newly created connection to the ticked connections. | ||
| + | |||
| + | |||
| + | {{Note | ||
| + | | Mandatory fields are displayed in '''bold''' or with a red triangle in front of the field. | ||
| + | }} | ||
| + | |||
| + | Once all related mandatory and optional information have been set, the new SQL Connection can be saved by validating the '''SQL Connection''' window using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window. | ||
| + | |||
| + | |||
| + | {{Video | ||
| + | | <mediaplayer width='400' height='300' image='http://http://www.xpert-technologies.ch/mediawikidev/images/f/fa/VID_Enable_the_connection_to_other_databases.png'>File:Enable_connection_to_other_databases_OK.mp4</mediaplayer> | ||
| + | | Enabling an SQL Connection to other databases. | ||
| + | }} | ||
| + | |||
| + | |||
| + | {{Note | ||
| + | | Ticking the check-box of an SQL connection in the second section ONLY allows data transfer from the newly created connection to the ticked connection, not both ways. The user must edit both of the connections and tick the corresponding check-boxes for mutual data transfer. | ||
| + | }} | ||
| + | |||
| + | |||
| + | |||
| + | ===Transferring an SQL Connection=== | ||
| + | |||
| + | The "Transfer" button [[File:MetisSmartModelingTransferButton.PNG|link=]] allows the user to transfer data from one SQL connection to another. Selecting a connection and clicking on the button opens the '''Transfer''' window with the following options appearing in the window. | ||
| + | |||
| + | |||
| + | [[File:MSM-Data-Management-SQL-Connections-Transfer.png|center]] | ||
| + | |||
| + | |||
| + | * '''From''' : drop-down list of the connections to take data from | ||
| + | * '''To''' : drop-down list of the connections to send data to | ||
| + | |||
| + | |||
| + | The following check-boxes are displayed and can be individually checked or the user can use the ''Select All | None'' option found at the bottom. These represent Metis objects to be transferred. | ||
| + | |||
| + | '''CONTENT''' | ||
| + | * '''Systems''' : transfer system related data | ||
| + | * '''Models''' : transfer model related data | ||
| + | * '''Hierarchies''' : transfer hierarchy related data | ||
| + | * '''Attributes''' : transfer attribute related data | ||
| + | * '''Price Categories''' : transfer Price Category related data | ||
| + | * '''Miscellaneous | ||
| + | |||
| + | '''MAIN DATA''' | ||
| + | * '''Versions''' : transfer Version related data | ||
| + | * '''Languages''' : transfer Language related data | ||
| + | * '''Rights''' : transfer Right and Profile related data | ||
| + | * '''Users''' : transfer User related data | ||
| + | |||
| + | Once the choices have been made, the user must click on the "Start transfer" button at the bottom of the window. Once the button has been clicked, a warning message is displayed explaining what will happen if the data transfer is carried out. | ||
| + | |||
| + | |||
| + | [[File:MSM-Data-Management-SQL-Connections-Transfer2.png|center]] | ||
| + | |||
| + | |||
| + | {{Note | ||
| + | | Only SQL connections that have been authorized to transfer data appear in the '''From''' dropdown list. Authorization can be granted by editing a connection and ticking the appropriate checkbox. | ||
| + | }} | ||
| + | |||
| + | |||
| + | |||
| + | ===Maintenance on Databases === | ||
| + | |||
| + | The "Maintain" button [[File:MetisSmartModelingMaintainButton.PNG|link=]] allows the administrator to set the selected database in maintenance mode. This disables all access to the selected database. Once clicked, a warning message asks for for confirmation on blocking access to the database. | ||
| + | |||
| + | |||
| + | [[File:MSM-Data-Management-SQL-Connections-Maintain.png|center]] | ||
| + | |||
| + | |||
| + | Once validated, the selected database is shown in the list with a red cross in the leftmost column of the table. To enable back access to the database, the administrator should select it and click on the "Maintain" button [[File:MetisSmartModelingMaintainButton.PNG|link=]] again. This will bring to the screen a warning message asking to confirm the operation. | ||
| + | |||
| + | |||
| + | [[File:MSM-Data-Management-SQL-Connections-Maintain2.png|center]] | ||
| + | |||
| + | |||
| + | |||
| + | ==SQL Access Tab== | ||
| + | |||
| + | On this tab, the SQL Accesses are presented in a table by showing simply the SQL Access Name. All but the maintenance feature are available in this tab. | ||
| + | |||
| + | |||
| + | [[File:MSM-Data-Management-SQL-Access.png|center|600x400px]] | ||
| + | |||
| + | |||
| + | |||
| + | ===Adding an SQL Access=== | ||
| + | |||
| + | In the '''SQL Connections''' sub-menu, on the SQL Accesstab, the "Add" button [[File:MetisSmartModelingAddButton.PNG|link=]] located above the main table allows the user/administrator to create a new SQL Access. When it is clicked, the '''SQL Access''' creation window opens, it allows to define all related information. | ||
| + | |||
| + | |||
| + | [[File:MSM-Data-Management-SQL-Access-Add.png|center]] | ||
| + | |||
| + | |||
| + | * '''Designation''' : name of the SQL access | ||
| + | * '''Smart Modeling''' : define which SQL Connection the new Access will use in Metis Smart Modeling. | ||
| + | * '''Smart Quotes''' : define which SQL Connection the new Access will use in Metis Smart Quotes. | ||
| + | |||
| + | |||
| + | {{Note | ||
| + | | Mandatory fields are displayed in '''bold''' or with a red triangle in front of the field. | ||
| + | }} | ||
| + | |||
| + | |||
| + | Once all related mandatory and optional information have been set, the new SQL Access can be saved by validating the '''SQL Access''' window using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window. | ||
| + | |||
| + | |||
| + | |||
| + | ===Transferring in SQL Access=== | ||
| + | |||
| + | The "Transfer" button [[File:MetisSmartModelingTransferButton.PNG|link=]] allows the user to transfer data from one SQL connection to another. Clicking on the button opens the '''SQL Connection Transfer''' window. The function is the same previously described, as it refers to SQL Connections. | ||
| + | |||
| + | |||
| + | {{Note | ||
| + | | Having this functionality in the SQL Access tab is intended to limit moving back and forth in the two tabs. | ||
| + | }} | ||
| + | |||
| + | |||
| + | |||
| + | ==Modifying an SQL Connection or Access== | ||
| + | |||
| + | In both tabs, the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] located above the main tables allows the user/administrator to apply modifications to all properties related to the selected SQL Connection or SQL Access . Selecting either one and clicking on it opens the corresponding edition window where all related properties and information can be edited. | ||
| + | |||
| + | |||
| + | [[File:MSM-Data-Management-SQL-Connections-Edit.png|center|600x400px]] | ||
| + | |||
| + | |||
| + | For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new SQL Connection or SQL Access. Modifications applied to the selected SQL Connection or SQL Access will only be saved once the SQL Connection or SQL Access edition window is validated using the [[File:MetisSmartModelingOKButton.PNG|link=]] button at the bottom of the window. This will update the tables displayed on the main screen. Using the "Cancel" [[File:MetisSmartModelingCancelButton.PNG|link=]] button discards all changes and closes the window. | ||
| + | |||
| + | |||
| + | |||
| + | ==Deleting an SQL Connection or Access== | ||
| + | |||
| + | In both tabs, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] located above the main tables allows the user/administrator to delete the selected SQL Connection or Access. Selecting one or more SQL Connections or Accesses and clicking on it displays the following confirmation window. | ||
| + | |||
| + | |||
| + | [[File:MSM-Data-Management-SQL-Connections-Del.png|center]] | ||
| + | |||
| + | |||
| + | [[File:MSM-Data-Management-SQL-Access-Del.png|center]] | ||
| + | |||
| + | |||
| + | Once the warning is confirmed, the selected SQL Connection or Access is removed from Metis Smart Suite and deleted from the Metis Database. | ||
| + | |||
| + | |||
| + | |||
| + | ==Previewing an SQL Connection or Access== | ||
| + | |||
| + | In both tabs, the "Preview" button [[File:MetisSmartModelingPreviewButton.PNG|link=]] located above the main table allows the user/administrator to see all properties and information related to the selected SQL Connection or Access. | ||
| + | |||
| + | |||
| + | [[File:MSM-Data-Management-SQL-Access-Preview.png|center]] | ||
| + | |||
| + | |||
| + | Selecting an SQL Connection or Access from the table and clicking on it opens the '''SQL Connection or Access''' preview window. For detailed descriptions of all information available in this window please refer to the section dedicated to the creation of a new SQL Connection or Access. | ||
| + | |||
| + | |||
| + | {{Note | ||
| + | | Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used. | ||
| + | }} | ||