Description of the Sub-Menu SQL Management
From Metis Documentation
(→Adding an SQL Connections) |
|||
Line 1: | Line 1: | ||
- | As Metis Smart Suite | + | 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 | {{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. | | 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 | + | This destination server must allow network transactions. For any questions regarding SQL Administration. The organization should be contacted! |
}} | }} | ||
+ | |||
Line 13: | Line 14: | ||
* '''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. | * '''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''' : | + | * '''Connection Name''' : name of the connection |
- | * '''Server''' : | + | * '''Server''' : name of the server |
- | * '''Database''' : | + | * '''Database''' : name of the database |
- | * '''User''' : | + | * '''User''' : name of the user used to access the Database |
Line 25: | Line 26: | ||
===Adding an SQL Connections=== | ===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. | |
Line 42: | Line 43: | ||
The second section is a list of all other SQL connections organized into two columns: | The second section is a list of all other SQL connections organized into two columns: | ||
- | * '''Authorized''' : The | + | * '''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 | + | * '''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. | ||
Line 50: | Line 58: | ||
| Enabling an SQL Connection to other databases. | | Enabling an SQL Connection to other databases. | ||
}} | }} | ||
- | |||
{{Note | {{Note | ||
- | | Ticking the | + | | 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. |
}} | }} | ||
- | |||
- | The "Transfer" button [[File:MetisSmartModelingTransferButton.PNG|link=]] allows the user to transfer data from one SQL connection to another. | + | |
+ | ===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. | ||
Line 65: | Line 74: | ||
- | * '''From''' : | + | * '''From''' : drop-down list of the connections to take data from |
- | * '''To''' : | + | * '''To''' : drop-down list of the connections to send data to |
+ | |||
- | The following | + | 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''' | '''CONTENT''' | ||
Line 84: | Line 94: | ||
* '''Users''' : transfer User related data | * '''Users''' : transfer User related data | ||
- | Once the choices have been made, the user must click on the transfer button at the bottom. Once the button has been clicked, a warning message is displayed explaining what will happen if the data transfer is carried out. | + | 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. |
Line 93: | Line 103: | ||
| 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. | | 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. | ||
}} | }} | ||
+ | |||
Line 116: | Line 127: | ||
[[File:MSM-Data-Management-SQL-Access.png|center|600x400px]] | [[File:MSM-Data-Management-SQL-Access.png|center|600x400px]] | ||
+ | |||
===Adding an SQL Access=== | ===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. | |
Line 130: | Line 142: | ||
* '''Smart Quotes''' : define which SQL Connection the new Access will use in Metis Smart Quotes. | * '''Smart Quotes''' : define which SQL Connection the new Access will use in Metis Smart Quotes. | ||
- | Once all | + | |
+ | {{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. | ||
+ | |||
Line 146: | Line 165: | ||
==Modifying an SQL Connection or Access== | ==Modifying an SQL Connection or Access== | ||
- | In both tabs, the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]] allows the user to | + | 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. |
- | + | ||
- | Selecting | + | |
Line 154: | Line 171: | ||
- | + | 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== | ==Deleting an SQL Connection or Access== | ||
- | In both tabs, the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]] allows the user to delete | + | 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. |
Line 168: | Line 186: | ||
- | + | Once the warning is confirmed, the selected SQL Connection or Access is removed from Metis Smart Suite and deleted from the Metis Database. | |
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
Line 180: | Line 192: | ||
==Previewing an SQL Connection or Access== | ==Previewing an SQL Connection or Access== | ||
- | In both tabs, the "Preview" button [[File:MetisSmartModelingPreviewButton.PNG|link=]] allows the user to see | + | 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|600x400px]] | [[File:MSM-Data-Management-SQL-Access-Preview.png|center|600x400px]] | ||
+ | |||
+ | 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 | {{Note | ||
- | | | + | | Edition of the information and properties displayed herein is not possible. If modification are necessary, the edition function described above should be used. |
}} | }} |