Wiki

Scale Your Enterprise

User Tools

Site Tools

mbstring extension must be loaded in order to run mPDF

versago:database_connection_configuration

This is an old revision of the document!


Introduction (Database Connections)

This document describes the steps to create database connections to allow Versago to retrieve information for reporting and save information captured in Versago forms.

Audience

This document is intended for Versago administrators. End-users do not have access to this function.

Related Documents

The following documents contain additional information that may be helpful with understanding these processes.

Special Terminology

  • Some images may refer to “Company” in database connections. This is an older term for database connections and can be used interchangeably.

Before You Begin

The complete the configurations described in this document you will need the following information. You may need to work with your system or database administrator to get this information.

  1. The name of the database server where the information resides.
  2. The name of the databases where the information resides.
  3. A user and password for each database to which you will want to make a connection.
    1. Best practice indicates that this should not be the default “super-user” (sa for SQL Server). A specific user that can both read and write to the various databases should be created. This same user can be used for Bizweaver as well.
  4. A valid SAP Business One user and password if you plan to use SAP Business One Saved Queries as a data source.

To Begin

This document is intended for Versago administrators. End-users do not have access to this function.

  • Click on the Admin link in the profile section of the Versago home page to access the Administration console.
  • Database connections are found under the Settings category of the menu.

Database Setup

Database setup is the process used to define connections to the various databases that will serve as data sources for Versago reports and where the data tables used for Versago forms will reside. Definition of database connections is not related to any other “security” components such as Users, Roles, and Profiles, so they can be created and updated at any time.

There is no limit on the number of database connections can be defined. However, there are three databases that should always have a connection defined. These are:

  • At least one database that holds the actual data to be reported through Versago
    • For SAP Business One installations a connection to the production database should be created, since this will be the source of most data being reported. If you have multiple company databases, both for production and test, connections should be created for these as well.
  • Other databases that may hold pertinent data can be connected as well.
  • Versago Form Data
    • This is the database that will be used for Versago forms.
    • It may also be used for other Versago-related tables such as data consolidation & summarization for reporting.
    • It may also be used for intermediate processing tables used by Bizweaver (the associated Third Wave data integration tool).
    • Check with your administrator for the proper database name.
  • Versago Common
    • This will be used for some Versago-related reports.
    • This connection is not required but is highly recommended.
    • In Versago installations prior to v2.1 this will be TWBS_SBO-Common. For new installations for v2.1 and higher, check with your administrator for the proper database name.

Database Connection Maintenance

  • Click on the “Database Setup” link in the Admin console to begin.

The database connection maintenance tool consists of two functions: creation of new connections and maintenance of existing connections.

  1. A listing of existing connections is displayed when the function is opened.
  2. Click the [Add New Database] button to create a new connection.
  3. Click the link for the connection in the Database column to edit an existing connection.
  4. Click the [Delete] button to remove a connection.
    1. When a connection is deleted the application will check to see if the connection is in use in other objects. If it is in use it cannot be deleted.

Basic Connection Information

The following image includes connection information specific to SAP Business One. Not all connections will need the information in the items in the red box.

Values marked with * are required. All values can be changed at any time unless noted otherwise.

  1. Company Name is the description that the user sees when selecting a database connection in the setup process for reports and forms.
    1. A suggested structure for this value is {DatabaseName} on {ServerName} as shown in the example above. This is not required but it does help the user quickly understand the elements of the connection.
  2. Company Description is an additional informational description of the connection. It is only displayed in the list of connections in the database connection setup function.
    1. This value can be the same as “Company Name” if desired.
  3. Server Name is the network name of the server where the database resides.
    1. This value cannot be changed once the connection entry has been created.
    2. This identification can be either the UNC name (e.g. Server1) or the IP address of the server.
    3. In some cases, this name may also need to include the SQL Server instance name; e.g. Server1\SQL2014.
    4. Contact your network administrator if you have any questions regarding this value.
  4. Database is the name of the database to be used.
    1. This value cannot be changed once the connection entry has been created.
  5. User ID is the database user name to be used for the connection.
    1. Using the default ‘sa’ user is not recommended. A different database user with appropriate security should be created for this purpose.
    2. Windows Authentication is not supported for this process.
  6. Password is the password for the user specified in the previous step.
    1. The password for this user should be set to “never expire.” If the password does expire it will prevent access to the database via Versago and reporting will not be possible. Further, troubleshooting an expired password can be very time consuming.
  7. SQL Server type indicates the version of the database engine in use for this connection.
    1. A value in this field is required but is only significant for SQL vs. HANA. The actual SQL version is not significant.
    2. Although the field label reads “SQL Server,” access to SAP HANA databases for reporting is also supported and can be selected from the drop-down.

SAP Business One Specific Information

The following items are used only when the connection pertains to an SAP Business One database AND you may want to use B1 Saved Queries as a data source. See Report Configuration for more information on using B1 Saved Queries.

If you do not plan to use B1 Saved Queries as a data source these items can be left blank. If you do plan to use B1 Saved Queries, all items are required. These values can be changed at any time.

  1. B1 Username is the SAP Business One user to be used to connect to the database
    1. This is different from the database “User ID” described above.
  2. B1 Password is the password for the SAP Business One user specified in the previous step.
  3. B1 Language is the primary language of the target SAP Business One database.
  4. License Server is the network name of the server where the SAP Business One License Manager application is found.
  5. License Server Port is the “listener” port used by the SAP Business One License Manager application.
    1. The default port value is 30000. This will be different only in very specific situations. Contact your network administrator or SAP Business One Administrator if you have any questions.
versago/database_connection_configuration.1573663081.txt.gz · Last modified: 2019/11/13 11:38 by akoehler