Differences

This shows you the differences between two versions of the page.

--- bw:global_connections [2019/09/10 11:38]
runger [DI Server Connections]
+++ bw:global_connections [2021/05/10 14:21] (current)
akoehler [SAP Service Layer Connections]
@@ Line 2: / Line 2: @@
 This document describes to the process to create Bizweaver global connections. Global connections define connection information to allow other Bizweaver tools to interact with SQL Server databases, SAP HANA databases, SAP Business One DI Server, SAP Business One DI API, SMTP (Email), Exchange, and REST web services (including SAP Service Layer). These connections are defined once in this function and then can be used in any workflow.
-====== Audience ======
-This document is intended for developers of Bizweaver workflows.
-====== Related Documents ======
-The following documents contain additional information that may be helpful with the development of Bizweaver workflows.
-  * [[bw:application_introduction|Application Introduction]]
-  * [[bw:sql_command_tool|SQL Command Tool]]
-  * [[bw:sap_business_one_integration|SAP Business Integration Tools]]
-  * [[bw:email_tool|Email Tool]]
-  * Exchange Tool (Coming soon)
-  * Webservice Tools (Coming soon)
 ====== Before You Begin ======
@@ Line 38: / Line 23: @@
         * SMTP_MailServer (SMTP to server MailServer)
         * REST_BigCommerce (REST connection to Big Commerce webstore)
+        * SL_SBODEMOUS (SAP HANA Service Layer to database SBODEMOUS)
   * **Description** is used to capture additional information about the connection. Including a description is optional.
@@ Line 44: / Line 30: @@
 The Global Configurations function is started by clicking on the appropriate icon in the toolbar as shown below.
-{{:bw:gcimage1.png?223x47}}
+{{  :bw:gcimage1.png?223x47  }}
 ===== Connection Listing =====
-{{:bw:gcimage2.png?384x417}}
+{{  :bw:gcimage2.png?384x417  }}
   - The area at the top of the page lists all connections that are currently defined.
@@ Line 57: / Line 43: @@
       - The existing configuration information is displayed.
       - You will need to re-enter user/password information when making a change.
-  - See [[bw:global_connections#delete_a_global_configuration|Delete a Global Connection]] for more information on **removing** a global connection.
+  - See **//[[bw:global_connections#delete_a_global_configuration|Delete a Global Connection]]//** for more information on **removing** a global connection.
   - Click [**Validate & Save**] to save new/updated information.
       - The application will try to validate things like server, database, and authentication information by completing the connection.
@@ Line 66: / Line 52: @@
 **SQL connections** are used to connect Bizweaver to Microsoft SQL Server databases.
-{{:bw:gcimage3.png?400}}
+{{  :bw:gcimage3.png?400  }}
   * Enter the **Server** name to which you are connecting.
@@ Line 83: / Line 69: @@
 ===== HANA Connections =====
-HANA connections are used to connect Bizweaver to SAP HANA databases.
+HANA connections are used to connect Bizweaver to SAP HANA databases.  These connections are typically used to __read__ data only, although insert/update/delete can be accomplished as well.
-{{:bw:gcimage4.png?400}}
+In Bizweaver v2.5 there are two options available: Single container (single tenant) and Multi Container (multi-tenant). The setup is very similar for both, and each one is illustrated below.
+====Single Tenant====
+{{ :bw:hana_db_connection_single.png?400 |HANA single tenant}}
   * Enter the **Server name** to which you are connecting.
     * This will typically be a server/IP address & port number.
-    * The standard port number for HANA databases is 30015.
+    * The standard port number for HANA single tenant databases is **30015**.
+    * The server and port are separated by a colon ( : ).
+  * Select the //Single Container// **mode**.
+  * Enter the **HANA Username** and **Password** to access the HANA database.
+    * Creating a database user specifically for Bizweaver connections is recommended (although it is not required) as it can aid in troubleshooting connection issues.
   * Enter the name of the **Database** to which you are connecting.
-  * Enter the **HANA Username** and **Password** to access the SQL Server database.
-    * Creating a HANA user specifically for Bizweaver connections is recommended (although it is not required) as it can aid in troubleshooting connection issues.
   * Enter the **HANA Timeout** period
     * The value is expressed in seconds.
     * The default value of 30 is appropriate for most installations.
       * This value is set on each database connection, so it can be different for each database if needed. The timeout value is used when the workflow is executed on a schedule or using the “Run now” option.
-    * Increase the value if you see SQL timeouts occurring in HANA logs.
+    * Increase the value if you see connection timeouts occurring in HANA logs.
+====Multi-Tenant====
+{{ :bw:hana_db_connection_multi.png?400 |HANA multi-tenant}}
+  * Enter the **Server name** to which you are connecting.
+    * This will typically be a server/IP address & port number.
+    * The standard port number for HANA multi-tenant databases is **30013**.
+    * The server and port are separated by a colon ( : ).
+  * Select the //Multiple Containers// **mode**.
+  * Enter the **Tenant Database** name.
+  * Enter the **HANA Username** and **Password** to access the HANA database.
+    * Creating a database user specifically for Bizweaver connections is recommended (although it is not required) as it can aid in troubleshooting connection issues.
+  * Enter the name of the **Database** to which you are connecting.
+  * Enter the **HANA Timeout** period
+    * The value is expressed in seconds.
+    * The default value of 30 is appropriate for most installations.
+      * This value is set on each database connection, so it can be different for each database if needed. The timeout value is used when the workflow is executed on a schedule or using the “Run now” option.
+    * Increase the value if you see connection timeouts occurring in HANA logs.
 ===== DI Server Connections =====
@@ Line 103: / Line 114: @@
 DI Server connections are only used in SAP Business One environments. They are used to connect Bizweaver to the SAP Business One DI Server application. The DI Server is a tool that interacts with SAP Business One to add and update data in the SAP Business One company database.
-{{:bw:gcimage5.png?400}}
+{{  :bw:gcimage5.png?400  }}
   * **Server** is the server (SQL or HANA) name where the SAP Business One database is found. If named instances are being used (e.g. ServerName\InstanceName) then the full instance name should be entered.
@@ Line 126: / Line 137: @@
 DI API connections are only used in SAP Business One environments. They are used to connect Bizweaver to the SAP Business One DI API. The DI API is a tool that interacts with SAP Business One to add and update data in the SAP Business One company database.
-{{:bw:gcimage6.png?384x287}}
+<WRAP center round important 60%> **Currently SAP DI API Connections starting in Bizweaver version 2.5 will support SAP version 10. Only one connection of a SAP version will be allowed through Bizweaver either a SAP version 9.3 or SAP version 10 connection can be established not both ** </WRAP>
-  - **Server** is the server (SQL or HANA) name where the SAP Business One database is found. If named instances are being used (e.g. ServerName\InstanceName) then the full instance name should be entered.
+{{  :bw:gcimage6.png?400  }}
-      - This information is displayed on the SAP Business One “Choose Company” screen.
-  - **Database** is the specific company database to be accessed by the DI API.
+  * **Server** is the server (SQL or HANA) name where the SAP Business One database is found. If named instances are being used (e.g. ServerName\InstanceName) then the full instance name should be entered.
-      - A given Server may have multiple company databases that are used in Bizweaver workflows. Each database will have its own configuration entry.
+    * This information is displayed on the SAP Business One “Choose Company” screen.
-<WRAP center round tip 60%> **The company database name is case sensitive in this configuration.** </WRAP>
+  * **Database** is the specific company database to be accessed by the DI API.
-  - **Type** is the database version in use. Supported versions can be selected from the drop-down list.
+    * A given Server may have multiple company databases that are used in Bizweaver workflows. Each database will have its own configuration entry.
-  - **SBO Username** and **Password** for the user needed to logon to the SAP Business One company.
+<WRAP center round important 60%> **The company database name is case sensitive in this configuration.** </WRAP>
-      - This user must have a valid license assigned.
+  * **Type** is the database version in use. Supported versions can be selected from the drop-down list.
-      - In most cases the license will be an “Indirect” user license.
+  * **SBO Username** and **Password** for the user needed to logon to the SAP Business One company.
-  - **DB** (database) **Username** and **Password** for the user needed to logon to the SAP Business One company.
+    * This user must have a valid license assigned.
-      - This will typically be the same user defined for SQL and HANA connections
+    * In most cases the license will be an “Indirect” user license.
-  - **Language** is language in use for the SAP Business One company.
+  * **DB** (database) **Username** and **Password** for the user needed to logon to the SAP Business One company.
-  - **License Server** is the server and port where the DI Server will connect to get its license information.
+    * This will typically be the same user defined for SQL and HANA connections
-      - The format is Servername:PortNumber (e.g. Server1:30000).
+  * **Language** is language in use for the SAP Business One company.
-      - The default port for SAP Business One license server is 30000. This should be used unless otherwise advised by Third Wave support.
+  * **License Server** is the server and port where the DI Server will connect to get its license information.
+    * The format is Servername:PortNumber (e.g. Server1:30000).
+    * The default port for SAP Business One license server is 30000. This should be used unless otherwise advised by Third Wave support.
 ===== SMTP Connections =====
@@ Line 148: / Line 161: @@
 SMTP connections are used to provide connection information for the server(s) that handle email. Most installation will only have one SMTP connection. However, there is no technical restriction on the number of connections that are defined.
-{{:bw:gcimage7.png?384x243}}
+{{  :bw:gcimage7.png?384x243  }}
-  - **Server** is the server where your SMTP application is found
+  * **Server** is the server where your SMTP application is found
-  - **Port Number** is the specific communication port used to connect to the SMTP application. Port 25 is the most common when connecting to an internal server. Port 465 or 567 are common when SSL is in use. Contact your system administrator if you are not sure of what value to use.
+  * **Port Number** is the specific communication port used to connect to the SMTP application. Port 25 is the most common when connecting to an internal server. Port 465 or 567 are common when SSL is in use. Contact your system administrator if you are not sure of what value to use.
-  - **Enable SMTP Credentials** (Username & password) \\ <WRAP info round center> Your installation may not require SMTP credentials to send mail from Bizweaver. However, identifying a valid user in this step is required to use the error handling functions of Bizweaver. </WRAP>
+  * **Enable SMTP Credentials** (Username & password) \\ <WRAP info round center> Your installation may not require SMTP credentials to send mail from Bizweaver. However, identifying a valid user in this step is required to use the error handling functions of Bizweaver. </WRAP>
-  - The connection information is saved but is not validated. Any connection errors will only be shown when the connection is used in a workflow.
+  * The connection information is saved but is not validated. Any connection errors will only be shown when the connection is used in a workflow.
+==== Email Setup for Microsoft Office365 ====
+There are three different options for using Microsoft Office365 as your SMTP connector to send email from Bizweaver. Fortunately, the simplest, and recommended, option works quite well. The following information is from Microsoft.
+**Option 1 (recommended): Authenticate your device or application directly with an Office 365 mailbox, and send mail using SMTP client submission**
+This option supports most usage scenarios and it's the easiest to set up. Choose this option when:
+  * You want to send email from a third-party hosted application, service, or device.
+  * You want to send email to people inside and outside your organization.
+To configure your device or application, connect directly to Office 365 using the SMTP client submission endpoint **smtp.office365.com**.
+Each device/application must be able to authenticate with Office 365. It can have its own sender address, or all devices can use one address, such as printer@contoso.com.
+**How to set up SMTP client submission**
+Enter the following settings directly on your device or in the application **as their guide instructs** (it might use different terminology than this article). As long as your scenario meets the requirements for SMTP client submission, the following settings will enable you to send email from your device or application.
+^Device or Application setting      ^Value                                                         ^
+|Server/smart host                  |smtp.office365.com                                            |
+|Port                               |Port 587 (recommended) or port 25                             |
+|TLS/ StartTLS                      |Enabled                                                       |
+|Username/email address and password|Enter the sign in credentials of the hosted mailbox being used|
+The following image shows how this setup is implemented as a Bizweaver Global Connection.
+{{  :bw:gcimage11.png?477x347  }}
 ===== Exchange Connections =====
 Exchange connections are used to access a Microsoft Exchange server directly.  This is different from the SMTP connection, even if you use Exchange as your SMTP server.  This allows you to read incoming email and create appointments (meetings) for other users.  Defining this type of connection does not apply if you do not use an Exchange server.
-{{:bw:gcimage12.png?475x249}}
+{{  :bw:gcimage12.png?475x249  }}
   - Select the **Exchange Version** from the drop-down list.
@@ Line 180: / Line 222: @@
 oAuth **1** is not supported in Bizweaver.
 </WRAP>
 ==== Basic Authentication ====
-{{:bw:gcimage8.png?475x249}}
+{{  :bw:gcimage8.png?475x249  }}
   - Select the **Basic Authentication** radio button.
@@ Line 192: / Line 233: @@
 ==== oAuth 2 Authentication ====
-{{:bw:gcimage9.png?469x331}}
+{{  :bw:gcimage9.png?469x331  }}
   - Select the **oAuth 2 Authentication** radio button.
@@ Line 200: / Line 241: @@
     - Again, the API documentation should provide instructions on how to obtain the various authorization elements.
   - The Redirect URI can generally be anything you like (e.g. https://mysite.com). This function is typically used for a website as opposed to an API. However, some APIs still require a value of some sort. Check with the API author if you have problems with this setting.
+  - The connection information is saved but is not validated. Any connection errors will only be shown when the connection is used in a workflow.
+===== SAP Service Layer Connections =====
+The SAP **Service Layer** is an API connection to Business One company databases.  The Service Layer is available for HANA v9.3 and higher.  It will be available for SQL v10 and higher.  The button to add a new Service Layer connection is labeled **SAP Service**
+{{  :bw:gcimage13.png?400  |Service Layer}}
+  - the **URL** is the pointer to the server where SAP Business One is installed.  The only thing that needs to be changed is the server name.  You can copy/paste this example, replacing <YourServer> (without the < >)with the appropriate value.
+<code>
+https://<YourServer>:50000/b1s/v1
+</code>
+  - **Database** is the SAP Business One company database name.  This value is case sensitive.
+  - **Username** and **Password** are the credentials that will be used to "login" to SAP Business One.  This user should be identified as a "superuser" and should have either a Professional or Indirect Access user license. <WRAP info round center> If  single sign-on user is used to sign in to the service layer an extra backslash is needed to pass it through the Service Layer ex: domain\\user </WRAP>
   - The connection information is saved but is not validated. Any connection errors will only be shown when the connection is used in a workflow.
@@ Line 206: / Line 262: @@
 When a Global Connection is deleted, a consistency check is performed to ensure that any workflows using the connection are updated. A list of associated workflows and steps are listed in the lower area of the window. Replacement connections must be specified or the deletion process will not continue.
-{{:bw:gcimage10.png?472x160}}
+{{  :bw:gcimage10.png?472x160  }}
   - Option 1 is to use the “Replace all” option to update all listed workflow (Task) steps with a new connection.
@@ Line 219: / Line 275: @@
   - Click [**Close**] to exit without saving any changes.
-====== Email Setup for Microsoft Office365 ======
-There are three different options for using Microsoft Office365 as your SMTP connector to send email from Bizweaver. Fortunately, the simplest, and recommended, option works quite well. The following information is from Microsoft.
-**Option 1 (recommended): Authenticate your device or application directly with an Office 365 mailbox, and send mail using SMTP client submission**
-This option supports most usage scenarios and it's the easiest to set up. Choose this option when:
-  * You want to send email from a third-party hosted application, service, or device.
-  * You want to send email to people inside and outside your organization.
-To configure your device or application, connect directly to Office 365 using the SMTP client submission endpoint **smtp.office365.com**.
-Each device/application must be able to authenticate with Office 365. It can have its own sender address, or all devices can use one address, such as printer@contoso.com.
-**How to set up SMTP client submission**
-Enter the following settings directly on your device or in the application **as their guide instructs** (it might use different terminology than this article). As long as your scenario meets the requirements for SMTP client submission, the following settings will enable you to send email from your device or application.
-^Device or Application setting      ^Value                                                         ^
-|Server/smart host                  |smtp.office365.com                                            |
-|Port                               |Port 587 (recommended) or port 25                             |
-|TLS/ StartTLS                      |Enabled                                                       |
-|Username/email address and password|Enter the sign in credentials of the hosted mailbox being used|
-The following image shows how this setup is implemented as a Bizweaver Global Connection.
-{{:bw:gcimage11.png?477x347}}

Wiki

User Tools

Site Tools

Differences

Page Tools