Connect Bridge User Manual

4m ago
33 Views
0 Downloads
2.42 MB
56 Pages
Transcription

Connecting SoftwareConnect Bridge – User ManualSummaryThis guide is designed to enable the reader to effectively work with theConnecting Software Connect Bridge (CB). It will introduce the various tools likethe Connect Bridge Query Analyzer, the CB Administration Tool, the CB SQLLanguage Reference and many others.Document HistoryVersion DateAuthorChanges1.02013-04-12PANDocument creation1.12015-06-18MBEDesign adaptionAll rights reserved. No part of the document may be reproduced or transmitted in any form or byany means, electronic or mechanical, for any purpose, without the written permission ofConnecting Software s.r.o. & Co. KG. Company or product names mentioned in this document maybe trademarks or registered trademarks of their respective companies.

Connect Bridge – User manualConnecting SoftwareTable of Contents1 Overview . 41.1Document Structure . 41.2Operating Principles . 52 CB Administration Tool . 62.1 “Connect To” CB-Server . 72.2 Description of the User InterfaceComponents . 92.3 Managing Logs .102.4 Managing Connectors .112.5 Managing Accounts .152.6 Managing Groups .182.7 Managing Users .213 The CB Service Controller .244 The CB Query Analyzer .264.1 Layout of the CB Query Analyzer.264.2 Working with the CB Query Analyzer .324.2.1 Connect .344.2.2 Execute a CB SQL statement or Stored Procedure.354.2.3 View Results/Errors .385 Workflow Development Tutorial .395.1 Scenario .395.1.1 C# sample .395.1.2 Java sample: .426 CB SQL Reference .456.1 General SQL Syntax Schema .456.2 Supported Data Manipulation Statements: .456.2.1 SELECT .456.2.2 INSERT .476.2.3 UPDATE .476.2.4 DELETE .486.2.5 STORED PROCEDURES .486.2.6 JOINS .496.2.7 CONDITIONS .506.2.8 FUNCTIONS .516.2.9 DATA TYPES .532015-06-18Page 2/56

Connect Bridge – User manualConnecting Software7 Glossary and Abbreviations .547.1 Glossary .547.2 Abbreviations .562015-06-18Page 3/56

Connect Bridge – User manualConnecting Software1 OverviewThis guide is designed to give a more in depth view of the Connect Bridge components(and how to use them) then the Installation & Configuration Guide. The aspects below willbe covered by this manual.WARNING! Former name of the company and product has been modifiedfrom ‘CNS Connect’ “Media Gateway” to ‘Connecting Software’ & “ConnectBridge” respectively. This is why several file-names include the abbreviation“MG” or “MGW”. If you should meet the term “Media Gateway” while usingthe Connect Bridge, please kindly email us a screenshot.Thanks for understanding. Connecting Software documentation team.1.1Document StructureThe CB Administration ToolChapter 2 provides an in depth look into the functionality of the administration toolprovided by Connecting Software. It covers managing of Accounts, Groups, Users,Licenses, Logs, etc.The CB Service ControllerChapter 3 contains a brief introduction to the service controller. A practical little tooldesigned to handle common administrative issues without having to resort to the AdminTool or Windows Administration.The CB Query AnalyzerChapter 4 covers the Query Analyzer. Connecting Software’s main tool to query & testthe functionality of the CB Server by means of the CB SQL Language.A Brief Workflow Development TutorialCan be found in Chapter 5. Designed to give a short introduction into the principles ofdeveloping integration solutions with the Connecting Software Connect Bridge.The CB SQL ReferenceIn Chapter 6, a reference of the CB variation of the SQL Language used to control the CBServer is provided. You will find that it closely matches ANSI-SQL.2015-06-18Page 4/56

Connect Bridge – User manual1.2Connecting SoftwareOperating PrinciplesThe Connect Bridge is a powerful, yet simple-to-use solution to connect standard serverslike Microsoft Exchange, SharePoint or Dynamics CRM either with each other, or withthird- party products.Figure 1 - Server-to-ServerThe principle is simple. As depicted in Figure 1 - Server-to-Server, the CB Serverconnects to standard servers with a proprietary Connector that uses standard interfaceslike WebServices, REST, etc. to access entities of the destination server. The dataintegration is maintained this way. A custom program then accesses the CB Server eithervia CB ODBC, JDBC or Webservices driver and uses CB SQL to control the integration.“SELECT FROM Appointments” or “INSERT INTO Contacts” can then be used instead ofhaving to learn the intricacies of the individual interface.In the second scenario (as depicted in Figure 2 - CB Client-Server Scenario),software vendors of specialised LOB1 or Portal solutions can use the CB to accessfunctionality of Standard Servers quickly, safely and effectively. A typical examplewould be to access Exchange accounts from within the Portal or obtain CRM contactsfrom within an industry specific LOB.2015-06-18Page 5/56

Connect Bridge – User manualConnecting SoftwareFigure 2 - CB Client-Server ScenarioFor more details on how to connect to the CB Server with custom applications, pleasecheck the Workflow Tutorial in this manual and visit the Developer’s Corner on ourwebpage www.connecting-software.com.2 CB Administration ToolThe CB Server Administration Tool provides functionalities to manage and configure theConnect Bridge. The tool provides a friendly Graphical User Interface (GUI) capable ofmanaging and configuring the entire CB-Server installed on a local PC or on aremote server. It uses simple query statements and specific System Stored Proceduresto provide all management features in the Connect Bridge.It is a client tool which communicates via CB-ODBC Driver with the internal CBAdministration Connector of the CB-Server. The CB Administration Connector is theCB module responsible to communicate with the internal database system, thereforeproviding all mechanisms to interact with it, including security, performance andscalability.2015-06-18Page 6/56

Connect Bridge – User manualConnecting Software2.1 “Connect To” CB-ServerStart the CB Administration Tool by clicking the “Windows” (Start) button, then go to“All Programs”, choose the folder “Connect Bridge”, then choose “Connect Bridge ServerAdministration Tool”.After startup, the following dialog appears (see Figure 3 - Admin Tool: Login Screen).You need to provide the host name (or IP address), where your CB-Server is installed(Server), the User name, its Password and the Port for communication via CB-ODBCDriver (the default is 8087).Figure 3 - Admin Tool: Login ScreenHint: in this case, the CB-Server was installed on the local machine, therefore theServer entry would be localhost or its IP address (127.0.0.1). The Administrator user iscreated automatically during CB installation in the system. The initial password is shownin the note bellow the password box. Upon first login, you will be prompted tochange the password (see Figure 4 - Change Password Dialog).Figure 4 - Change Password Dialog2015-06-18Page 7/56

Connect Bridge – User manualConnecting SoftwareIt is highly recommended to change the password of theAdministrator user after the first login. In order to do that, go to“Manage” then select Users in the left pane, then click on theAdministrator User and click Edit. The dialog screen displayed allowsyou to change the password. Then click Save.Once the connection to CB-Server is established, main window of CB ServerAdministration Tool is shown (see Figure 5 - CB Admin Tool: Main Window).12Figure 5 - CB Admin Tool: Main Window2015-06-18Page 8/56

Connect Bridge – User manual2.2 Description of the User InterfaceConnecting SoftwareComponentsNavigation Panel (1) – refers to the panel on the left side of the main window. Itcontains 2 selection trees: Servers and Manage.Grid Editor (2) – the grid (table) in the middle, shows the names (the column Key)and values (the column Values) of the properties selected in the Navigation Pane.Items in Navigation Panel:Servers – The list of actions you can execute against a connected CB-Server. By the timeof this documentation release, the client is only able to connect to one CB- Server at atime.- Logs– Allows the management of the logging settings of the CB-Server.- Restart Server– Restarts the CB-Server the tool is connected to.- Update Manager– For internal purposes only.Manage– the list of entities you can manage via CB Server Administration Tool.- Connectors – Allows you to manage (install, modify, uninstall) CB-Connectors, whichare installed on the CB-Server.- Groups– Allows you to manage groups of users and their access to accounts- Accounts – Allows you to manage CB-Accounts that access servers via connectors- Users– Allows you to manage Users- Licenses– Allows you to manage Licenses- Data Providers– Allows you to manage Data Providers (local or remote).Description of the Menu Items:Administration- Connect To – Allows you to establish a new connection to a CB-Server (local orremote).- FTP Manager – Offers the possibility to transfer files via ftp to the CB-Server from aclient machine connected to the CB-Server.Help- About Connect Bridge Administration Tool – Provides information about the ConnectBridge Administration Tool and CB- Connectors.- Request new license – Allows you to request a new Connecting Software ConnectBridge license from Connecting Software.- Activate license – Allows you to activate the Connect Bridgelicenseprovided by Connecting Software.2015-06-18Page 9/56

Connect Bridge – User manualConnecting Software2.3 Managing LogsYou can choose the output location of the log files from the Navigation Panel expand Servers, then expand a server you are connected to (e.g. localhost) and click onLogs. Figure 6 - Log Dialogs depicts the two screens available within the Log Dialog.Figure 6 - Log DialogsOn the tab General the group Destination of log events allows to select where the loggedevents should be saved to. Options include either the Windows Event Viewer or a physicalfile that can be found in the MgServerService folder of the CB installation (usually"C:\Program Files\Connecting le.txt".The group Message Types allows to specify what kind of messages should be logged:Log Error Messages– CB errors will be logged.Log Info Messages– All information messages will be logged.Log Warn Messages– All warning messages will be logged.Log Debug Messages – Full debugging info from the CB-Server will be logged. Thischoice produces the most detailed output, but also represents the biggest demand on thecomputer resources.The Users tab allows you to decide for which users these logs should be stored. Allpotential users are shown in the list Available. By selecting one or more and clicking onthe Arrow Right Button, the respective user is chosen and therefore included in thelogging. During the installation of the CB, user Administrator is created andautomatically moved to the list box Selected. Thus, his actions on the server will alwaysbe logged.2015-06-18Page 10/56

Connect Bridge – User manualConnecting SoftwareWhen finished, click on the OK button. You are asked to restart the ConnectingSoftware Connect Bridge-Service in order to apply the new settings. From that point on,the logging behaves according to the new configuration.Warn