Description of the Sub-Menu SQL Management
From Metis Documentation
| Line 1: | Line 1: | ||
| - | + | This sub-menu contains the SQL Connections and Accesses. Split between two tabs, the user can add, delete, edit, preview connections and accesses in this menu, as well transfer data from one connection to another using this menu. | |
| - | |||
| - | + | [2 screenshots of the main window, one for connections and one for accesses.] | |
| - | |||
| - | + | {{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 transaction. For any questions regarding this, the SQL Administrator must be contacted. | ||
| + | }} | ||
| - | == Maintenance on Databases | + | |
| + | ==SQL Connections Tab== | ||
| + | |||
| + | On this tab, the SQL connections are presented in a table with the following five columns: | ||
| + | |||
| + | *Red X or Green Checkmark: A red X means that the connection is not available and is currently under maintenance. The green checkmark means that everything is ok with the SQL connection. | ||
| + | *Connection Name: the name of the connection | ||
| + | *Server: the name of the server | ||
| + | *Database: the name of the database | ||
| + | *User: the name of the user | ||
| + | |||
| + | |||
| + | ==Adding an SQL Connections=== | ||
| + | |||
| + | On the SQL Connections tab, the '''Add''' button allows the user to create a new SQL connection. Clicking on '''Add''' button opens the '''SQL Connection''' window. | ||
| + | |||
| + | The window is split into two sections, the first being the properties of the new SQL connection. | ||
| + | |||
| + | The first section contains the following fields: | ||
| + | |||
| + | [Show screenshot of the Add connection window] | ||
| + | |||
| + | *SQL Connection Name | ||
| + | *Server Name | ||
| + | *Database Name | ||
| + | *Username | ||
| + | *Password | ||
| + | *Maintain | ||
| + | |||
| + | The '''Maintain''' field is a checkbox with a Yes or No option. It should be ticked when the SQL Connection needs to be worked on for maintenance. | ||
| + | |||
| + | The second section is a list of all other SQL connections organized into two columns: | ||
| + | |||
| + | *Authorized: The checkbox can be ticked to authorized data transfer. Multiple checkboxes can be ticked. | ||
| + | *Transfer to: The connection to which data transfer can be established. Ticking the checkbox of any of the listed SQL Connections will allow data transfer from the newly created connection to the ticked connections. | ||
| + | |||
| + | {{Note | ||
| + | | Ticking the checkbox 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 checkboxes for mutual data transfer. | ||
| + | }} | ||
| + | |||
| + | [screenshot of add new connection with several connection checkboxes ticked] | ||
| + | |||
| + | ===Transfering an SQL Connection=== | ||
| + | |||
| + | The '''Transfer''' button allows the user to transfer data from one SQL connection to another. Clicking on the button opens the '''Transfer''' window with the following options appearing in the window. | ||
| + | |||
| + | |||
| + | [Show screenshot of the transfer window] | ||
| + | |||
| + | *From: A dropdown list of the connections to take data from | ||
| + | *To: A dropdown list of the connections to send data to | ||
| + | |||
| + | The following checkboxes are displayed and can be individually checked or the user can utilize the ''Select All | None'' option found at the bottom. | ||
| + | |||
| + | *Systems | ||
| + | *Models | ||
| + | *Hierarchies | ||
| + | *Attributes | ||
| + | *Price Categories | ||
| + | *Miscellaneous | ||
| + | |||
| + | '''Main Data''' | ||
| + | *Versions | ||
| + | *Languages | ||
| + | *Rights | ||
| + | *Users | ||
| + | |||
| + | 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. | ||
| + | |||
| + | [screenshot of the warning button] | ||
| + | |||
| + | {{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 defined Databases === | ||
| + | |||
| + | |||
| + | |||
| + | ==SQL Access Tab== | ||
| + | |||
| + | On this tab, the SQL Accesses are presented in a table below in the SQL Access Name column. | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | ===Adding an SQL Access=== | ||
| + | |||
| + | On the SQL Access tab, The '''Add''' button allows the user to create a new SQL access. Clicking on '''Add''' button opens the '''SQL Access''' window. The following fields are presented to the user. | ||
| + | |||
| + | |||
| + | [Show screenshot of the Add access window] | ||
| + | |||
| + | *Designation: The user inputs the name of the access in this field. | ||
| + | *Smart Modeling: The user decides which SQL Connection the new Access will use in Smart Modeling. | ||
| + | *Smart Quotes: The user decides which SQL Connection the new Access will use in Smart Quotes. | ||
| + | |||
| + | |||
| + | ===Transfering an SQL Access=== | ||
| + | |||
| + | The '''Transfer''' button allows the user to transfer data from one SQL connection to another. Clicking on the button opens the '''Transfer''' window with the following options appearing in the window. | ||
| + | |||
| + | |||
| + | [Show screenshot of the transfer window] | ||
| + | |||
| + | *From: A dropdown list of the connections to take data from | ||
| + | *To: A dropdown list of the connections to send data to | ||
| + | |||
| + | The following checkboxes are displayed and can be individually checked or the user can utilize the ''Select All | None'' option found at the bottom. | ||
| + | |||
| + | *Systems | ||
| + | *Models | ||
| + | *Hierarchies | ||
| + | *Attributes | ||
| + | *Price Categories | ||
| + | *Miscellaneous | ||
| + | |||
| + | '''Main Data''' | ||
| + | *Versions | ||
| + | *Languages | ||
| + | *Rights | ||
| + | *Users | ||
| + | |||
| + | 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. | ||
| + | |||
| + | [screenshot of the warning button] | ||
| + | |||
| + | {{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. | ||
| + | }} | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | ==Modifying an SQL Connection or Access== | ||
| + | |||
| + | The '''Edit''' button allows the user to edit the SQL connection or access. | ||
| + | |||
| + | Selecting a connection or access and clicking on '''Edit''' opens the '''SQL Connection''' or '''SQL Access''' window. All the fields, dropdown lists and checkboxes that were available in the '''Add''' window are now editable here. | ||
| + | |||
| + | |||
| + | ==Deleting an SQL Connection or Access== | ||
| + | |||
| + | The '''Delete''' button allows the user to delete an exisiting SQL connection or access. | ||
| + | |||
| + | When deleting a connection or access, the following pop-up window appears: | ||
| + | |||
| + | [Screen shots of the delete connection or access window] | ||
| + | |||
| + | The user must confirm the message before the connection or address can be deleted. | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | ==Previewing an SQL Connection or Access== | ||
| + | |||
| + | The '''Preview''' button allows the user to see the properties of the selected SQL connection or access. | ||
| + | |||
| + | Selecting an SQL connection and clicking on the '''Preview''' button opens the '''SQL Connection''' or '''SQL Access''' window where the properties are displayed. | ||
| + | |||
| + | |||
| + | {{Note | ||
| + | | It is not possible to edit the properties of the SQL connection or accessin the '''Preview''' note window. This must be done with the '''Edit''' button. | ||
| + | }} | ||