SouthWare SQLTools · 2012. 6. 5. · See the introduction to the appropriate section of this...

SouthWare®

SQLTools™

NOTICE

The information in this document is subject to change without notice. SouthW are

Innovations, Inc. assumes no responsibility for any errors that may appear in this

documentation.

COPYRIGHT NOTICE

Copyright © 2008 by SouthW are Innovations, Inc. All rights reserved.

Printed in the United States of America. No part of this publication may be

reproduced or transmitted in any form or by any means without the written

permission of SouthW are Innovations, Inc. Auburn, Alabama. Violations of the

copyright law may result in substantial civil and criminal damages and penalties.

TRADEMARK NOTICE

SouthW are® , SalesMark® and TaskW ise® are registered trademarks of

SouthW are Innovations, Inc. SwiftDataTools™, SouthW are Excellence Series™,

SwiftGen, DocTransfer™, ExcelAssist™, ExcelReport™, ExecuMate II™,

Extended Data™, ImportMate II™, International Transactions™, ReportMate™,

SwiftGen™, SwiftMate™, SouthW are Forms™, SouthW are NetLink™,

SouthW are W orkFlow™, StopCheck™, and AnswerReady™ are trademarks of

SouthW are Innovations, Inc.

Acucorp® and ACUCOBOL-GT® are registered trademarks of Acucorp, Inc.

U/SQL is a trademark of Transoft, Inc.

Other products and company names used in this publication are for identification

purposes only and may be trademarks or registered trademarks of their

respective owners.

SouthW are SQL Tools Table of Contents

1

Table of Contents

Table of Contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

SouthW are SQL Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

SouthW are ODBC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Status - (status) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Change Server Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Data Dictionary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Set Operator Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Reset Single Operator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Reset All Operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Sample Uses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

SouthW are SQLView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Launch Viewer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Review Saved Views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

Related Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

Operator Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Launch Via Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

SouthW are SQLSync . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Update Server (Status) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

Replicated Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

Rebuild Replicated SQL Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

Select Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

Launch Rebuild . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

Replication Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

MS-SQL Interface Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

Acu4GL Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

Select Files to Replicate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

Scheduled Server Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

Installation Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

Installing SouthW are ODBC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

Installing SouthW are SQLView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

Installing SouthW are SQLSync . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

SouthW are SQL Tools Introduction

2

SouthWare SQL Tools

SouthW are SQL Tools is a collection of SQL-related technology designed for

SouthW are users. W ith SQL Tools you have the option to utilize SQL features as

you need them while retaining the flexibility resulting from SouthW are’s use of a

SQL-independent software platform. See the table “Comparing SQL

Approaches” at the end of this section for a comparison of the SouthW are SQL

Tools approach with other SQL-dependent software architectures.

SouthW are’s SQL Tools technology includes the following components:

• SouthWare ODBC (using Transoft U/SQL technology)

• SouthWare SQLView

• SouthWare SQLSync

W ith these tools you can:

i Access SouthW are data with SQL technology

i Create, save, and retrieve SQL queries from within SouthW are

i Store SouthW are data in SQL tables

Below is a brief overview of each tool. See the introduction to the appropriate

section of this document for more details on each tool.

SouthWare ODBC

SouthWare ODBC provides controlled ODBC access (including SQL

queries) to your SouthWare data from any ODBC-capable software.

SouthW are ODBC is a special software “wrapper” built around Transoft U/SQL, a

leading ODBC connectivity software solution. SouthW are ODBC is provided as a

standard function of the SouthW are platform and is tightly integrated with

SouthW are features.

SouthWare SQLView

SouthWare SQLView allows you to access SouthWare data via SQL

statements and review/analyze the data in a SouthWare grid.

SouthW are SQLView can be used for ad hoc (one-time) SQL reporting or for

storing SQL-oriented “views” that may be used whenever needed. SouthW are

ODBC provides the SQL statement processing via SouthW are’s grid technology.


3

SouthWare SQLSync

With SouthWare SQLSync you can interactively replicate the data from

SouthWare files into corresponding MS-SQL tables. This add-on module lets

you review, report, and analyze your data using the many tools available for MS-

SQL data tables.

W ith SouthW are SQLSync your SouthW are system will continue to update its

standard Vision file format, but the data will also be updated into corresponding

MS-SQL tables. This keeps the MS-SQL tables synchronized with the Vision

files. If an error occurs in updating the MS-SQL database then the MS-SQL table

can be rebuilt from the corresponding Vision data file.


4

Comparing SQL Approaches

SQL-Dependent

Approach

SouthWare’s

SQL-Independent

Approach

Data is accessible for

SQL queries via

common SQL tools?

Yes Yes

• Via ODBC

• Via replicated

relational database

tables

Built-In SQL Query

Function?Yes Yes

Via SQLView

Data is stored in

relational database

tables?

Yes Optionally, as

Replicated Data

iiOption to use

software without

relational database

software and

administration?

No Yes

Primary processing is

done directly to

relational database?

Yes No - secondary

replicate

iiData is safe from

unauthorized access

(particularly financial

data is safe from

change)?

Requires that a

knowledgeable system

administrator properly

sets up and monitors

security - database is

designed to be “open”

Non-replicated data is

fairly safe and can also

be encrypted -

replicated data has

same issues as Typical

SQL

Data access is fast? Yes, if database is

structured properly and

SQL is optimized

Yes, if

processing/querying by

a key field

iiBusiness logic uses

mature code that has

been improved for over

20 years?

?? Yes


SQL-Dependent

Approach

SouthWare’s

SQL-Independent

Approach

5

Database can be

extended with new

fields?

Yes

Programs must be

changed to reference

added fields

Yes

Extended Data

technology

Database can be

distributed over multiple

servers?

Yes

Typically a configurable

database software

function

Yes

Data files can be

distributed to different

servers

Network traffic can be

limited by performing

data functions at the

server?

Yes

SQL commands

typically pre-process

data on data server

Yes, with Thin Client

Thin Client option allows

processing on data

server

Software uses stored

database procedures

available for use by

other database

programmers?

Possibly?

Depends on the coding

for the application

No

Has re-usable

subroutines, but not as

stored procedures

Software is portable

across different

operating systems?

Typically Not Yes

Data is accessible for

Internet applicationsYes

Via SQL commands or

other technology

Yes

• Via ODBC or

replicate data

• Via SouthW are

NetLink

SouthW are SQL Tools SQL Manager

6

SouthWare SQL Manager

The SouthW are SQL Manager (XX-08-09-06) provides an integrated environment

for access to the tools in the SouthW are SQL Tools suite of components. The

tabs in this manager organize the available tools into the following areas:

• SouthWare ODBC (using Transoft U/SQL technology) - To access native

SouthW are data via SQL statements using ODBC technology

• SQLView - To create, save, and retrieve SQL queries of SouthW are data (via

SouthW are ODBC) using SouthW are grid technology

• SQLSync - To store SouthW are data in SQL tables

Using the Manager

L To access a SQL component simply click on its related tab. The options

within the tool are organized via an interactive tree view outline.

L As you highlight options in the tree, a preview pane to the right of the tree

provides automatic documentation and explanation for the highlighted

option.

L For options that have a Zoom or Edit option simply double-click on the

item or highlight the item and then click on the related button to launch

the feature.

W hat You Need Before You Start

Here is an overview of the steps to take before you start to use SouthW are SQL

SouthW are SQL Tools SQL Manager

7

Tools:

T Install the SouthWare environment (with the SouthW are runtime version)

and license/register the SouthW are modules you will be using.

T For SouthWare ODBC and SouthWare SQLView make sure the ODBC

engine is properly installed on the server and your workstation. This occurs as

part of the normal install process but you may confirm that the engine is

installed by checking the SouthW are ODBC status in the SQL Tools Manager.

T For SouthWare SQLSync you must license SQLSync, license and install the

Acucorp Acu4GL version of your runtime, and install Microsoft SQL Server.

The SQLSync server program must be started as a separate background

process on your server.

See the Installation Notes section later in this manual for more information.

SouthW are SQL Tools SouthW are ODBC

8

SouthWare ODBC

SouthWare ODBC provides controlled ODBC access to your SouthWare

data from any ODBC-capable software.

SouthW are ODBC is a special SouthW are-specific software “wrapper” built

around Transoft U/SQL, a leading ODBC connectivity software solution.

SouthW are ODBC is provided as a standard function of the SouthW are platform

and is tightly integrated with SouthW are features:

• Your SouthW are Data is available as a standardized ODBC Data Source

• Bring data into MS Excel, MS W ord, queries, report writers, etc.

• SouthW are Security protects ODBC access to your data

• Access to SouthW are data via ODBC requires login via SouthW are

operator login

• Access to each SouthW are table via ODBC requires SouthW are security

level of 4 for the related application

• Access to each company's data files is secured

• ODBC Data Dictionary

• ODBC data dictionary of tables/fields built from SouthW are Data

Dictionary

• Automatically updates ODBC data dictionary from user-defined fields in

Extended Data

• Automatically updates ODBC data dictionary for location-specific

W arehouse Tracking files

• Automatic Installation

• Automatically installed on server as part of the SouthW are installation

process

• Automatic setup of ODBC DSN on SouthW are client workstations

• Provides optional ODBC access for each licensed SouthW are user

Developer Note:

There is an additional license option that allows the writing of data to

SouthW are files using ODBC writeback. Use of this capability is not normally

recommended since it avoids normal SouthW are data validation, does not

update any related data files, and potentially makes your system data wrong

and unsupportable. However, a SouthW are developer who understands the

implications of writing data to a SouthW are file via ODBC may want to use this

option. This option is licensed separately and has related security options (see

the “ODBC Security” section of this manual).

If you believe you need this additional licensed option please contact your

SouthW are reseller for more information.

SouthW are SQL Tools SouthW are ODBC - Overview

9

SouthWare ODBC L Overview

This option displays an overview page that outlines the benefits and features of

SouthW are ODBC.

How SouthWare ODBC Works

SouthW are ODBC provides a secure ODBC connection to SouthW are’s data files

from any ODBC-capable software. SouthW are ODBC contains the following

components:

On your SouthW are Data Server

• SouthW are ODBC Server software

• U/SQL Data Dictionary for SouthW are files

• Data Source Name (DSN) for each SouthW are company ID that will use

SouthW are ODBC

• Security (Grant/Revoke) Settings for each SouthW are operator and table

(stored in data dictionary)

On each SouthW are Client machine

• SouthW are ODBC Client software

• Data Source Name (DSN) for each SouthW are company ID that uses ODBC

on the workstation

• W in U/SQL

SouthW are SQL Tools SouthW are ODBC - Overview

10

The following diagram illustrates how these components are used:

Process:

On the client machine the user can utilize any ODBC-enabled software product

to access external ODBC data. A DSN for each SouthW are company is shown

as an available Data Source. The user selects a SouthW are DSN. The

system requires an operator login and password to validate that the user can

access this DSN and to determine which tables are available.

The user selects the data to be retrieved and initiates the request. The Client

software issues a request to the Server DSN for the data. The Server extracts

the data and sends it back to the Client DSN to return to the ODBC requestor.

SouthWare ODBC Overview

SouthW are SQL Tools SouthW are ODBC - Status

11

SouthWare ODBC L Status - (status)

This option verifies and displays the installation and setup status of SouthW are

ODBC. The program tries to do a test connection of the ODBC Server to verify

setup.

! If the connection is successful this option will display an “OK” status - this

indicates that the related software and data dictionary has been properly

installed.

! If the manager cannot confirm that these have been properly installed via a test

connection then an “ERROR” status will display.

The display to the right shows verification-related info:

• W hether the test connection was successful

• The Server IP Address and Port #

• The ODBC Connection String for the DSN

• W hether ODBC security for the current operator is set up

• W hether the Client ODBC software is set up on this workstation

• W hether the Client ODBC DSN for the current company is set up

Troubleshooting Notes

• To set up the Client DSN for the current workstation and company - If the

Client ODBC DSN is not set up you may log off and back on. The logon

process will set up the DSN.

SouthW are SQL Tools SouthW are ODBC - Status

12

• To install the Client ODBC software on the current workstation - If the

Client ODBC software is not set up on this workstation you must use the

Operator/W orkstation Manager program to reset the W indows controls for this

workstation. Then you may log off and back on to have the client ODBC

software installed.

• To reset ODBC security for the current operator - If the ODBC security for

the current operator is not set up you may go to the “ODBC Security” option in

the SouthW are ODBC manager. From this option you may set/reset a single

operator or reset the security for all operators.

SouthW are SQL Tools SouthW are ODBC - Status - Change Server Settings

13

SouthWare ODBC L Status L Change Server Settings

This option is available only if you are running on the server machine. On

Unix/Linux machines or in a Terminal Services network you are typically always

“running” on the server machine. If you are on a client machine in a Windows

network you must go to the server machine in order to change these settings.

This option allows you to edit the server IP address and port number that were

assigned during the setup of SouthW are ODBC Server. Normally you do not

need to change these settings, but if they were not properly defined during setup

you may edit them here. Zoom on this selection to display a window with the

following settings:

Server IP Address

Enter the IP address of the server computer. This is the computer on which

the ODBC Server software was loaded and is running. This must be your

SouthW are data server machine.

Server Port

Enter the port number used for accessing the ODBC server on your server

machine. Typically this will default to port 7000. Normally the only reason you

might change this setting is if you are already using port 7000 for some other

purpose.

Stopping and Restarting the Server

IF YOU CHANGE EITHER OF THESE SETTINGS you must stop and then

restart the server.

• On a W indows Server the program asks if you want to automatically

stop/restart the server.

• On a Unix/Linux Server you must manually stop and restart the server

T Changes will not take effect until the server is stopped and restarted

T If you are changing the settings for a functioning server you should do this

when users are not accessing ODBC

T After you restart the server users must log off and back in to SouthW are in

order for the changes to be updated on each workstation

SouthW are SQL Tools SouthW are ODBC - Data Dictionary

14

SouthWare ODBC L Data Dictionary

This option provides overview documentation for the U/SQL Data Dictionary used

by SouthW are ODBC. The data dictionary is installed as part of SouthW are

ODBC and is updated by user-defined fields such as Extended Data.

Overview

W hen you access your SouthW are data via ODBC from other software a DSN is

used to access your data. To define the data you want to retrieve you refer to

data tables and then fields in tables.

SouthW are provides a U/SQL ODBC Data Dictionary of tables and fields

available via SouthW are ODBC. The tables and columns defined in the U/SQL

Data Dictionary used by SouthW are ODBC is derived from the SouthW are Data

Dictionary used by ReportMate FYI and other SouthW are technologies.

Data Dictionary Differences

There are some important differences that an experienced SouthW are user will

notice when using SouthW are ODBC instead of FYI:

T File IDs versus Table names based on External file name - the SouthW are

vendor file is “AP01" in the SouthW are data dictionary while the Table name in

the ODBC data dictionary is “AVEND”

T Field Numbers versus Field names - the SouthW are data dictionary refers to

fields by numbers (AP01, field 1) while ODBC refers to table columns by name

(AVEND, VendorNumber)

T No “constructed” fields in ODBC - the data available via ODBC must exist in

the file. SouthW are’s data dictionary includes numerous “fields” that are

calculated or derived from data although the fields don’t actually exist in a file.

T No predefined pathing (“joins”) between tables in ODBC - SouthW are’s

data dictionary includes predefined pathing that automatically helps you retrieve

data from related files. You can reference data from multiple related files in a

single report or web page and the SouthW are data dictionary provides access

to the data. ODBC does not provide this automatic “joining” of tables. To

access data from multiple files with a SQL statement you must manually enter

SQL “join” syntax that references multiple tables.

SouthW are SQL Tools SouthW are ODBC - Security

15

SouthWare ODBC L Security

SouthW are ODBC secures ODBC access to your data using your SouthW are

operator security settings. SouthW are ODBC sets grant/revoke privileges for

each SouthW are file/table using operator security levels.

SouthW are ODBC controls ODBC access to data from 3 -party products byrd

requiring the operator to enter a valid SouthW are login name/password when

accessing the SouthW are DSN. This is a very critical feature in controlling access

to your data. By setting up your SouthW are security levels you are also

controlling access from 3 -party products. For example, when an operator inrd

Microsoft Excel tries to extract data from SouthW are, the ODBC drivers will

require a SouthW are login. This login will control which tables the operator may

access.

This is similar to the security clearance required by ReportMate and FYI.

Enabling Operator ODBC Access

A flag in the SouthW are operator record (XX-03-02, field 8, “Allow ODBC

Access”) controls whether an operator may use SouthW are ODBC.

Allow ODBC Access?

By default this option is enabled for all operators - you may use this field to

permanently or temporarily disable ODBC access.

Enter “Y” to allow this operator to use SouthW are ODBC to access SouthW are

data from other ODBC-capable software. The operator will be able to access

tables for applications to which he has a security level clearance of at least 4.

Enter “N” to disable access to SouthW are ODBC for this operator. The

operator will be removed from the table of ODBC-capable operators.

The easiest way to review/edit this setting for each operator in this company is via

the “Set Operator Access” option described below.

Operator ODBC Access per Table

If an operator who is allowed ODBC access has a security level of '4' or higher for

an application, SouthW are ODBC allows access to all tables for the application. If

an operator does not have a security level of at least '4', SouthW are ODBC will

not allow ODBC access to tables in that application. Each time you add/change

operator security in SouthW are the corresponding changes will be made to

ODBC access privileges.

W hen a user accesses a SouthW are ODBC DSN, he must enter his SouthW are

login and password. This login then controls which tables the user may query.

SouthW are SQL Tools SouthW are ODBC - Security

16

Any operator who has a SouthW are security level of at least 4 for the related

application may access a SouthW are table via ODBC, but an operator who does

not have at least level 4 access for an application will not be allowed to access

tables for that application. For example, an operator may not access SouthW are

Payroll data via ODBC without at least a security level 4 for Payroll.

Notes on usernames and passwords

• Duplicate Usernames - Usernames are not case sensitive. This means that if

you have duplicate SouthW are operator names that differ only in case you will

end up with only one ODBC username. To overcome this situation you should

create unique SouthW are operator names.

The system will update the operator security table in alphabetic sequence

(upper case before lower case). For example, if you have operators “Bill”,

“BILL”, and “bill” the last one processed (bill) will be the one in the security

table. Only the company and security settings for “bill” will be available for use

with ODBC.

• Blank passwords are not allowed. If you have a SouthW are operator with a

blank password the ODBC password will be assigned as the operator name in

all lowercase. For example, if you have an operator “DEMO” with a blank

password the ODBC password will be “demo”.

SouthW are SQL Tools SouthW are ODBC - Security - Reset Single Operator

17

SouthWare ODBC L Security L Set Operator Access

This option allows you to review and edit which operators are allowed access to

SouthW are ODBC from 3 -party software. Zoom on this option to display a gridrd

of operators for this company along with the current setting for the “Allow ODBC

Access?” option (XX-03-02, field 8).

You may click on the checkbox field to toggle the setting for each operator.

DEVELOPERS OPTION FOR WRITEBACK

If you have licensed Writeback capability

If you license ODBC writeback on a user system then the settings for each

operator include writeback options:


18

Allow Write Back?

Check this option if the operator should be allowed to use the ODBC writeback

capability. If this is not checked the operator will not be able to do any ODBC

writeback regardless of other security levels for the operator.

W hen you check this option for an operator the program will display a list of all

tables that this operator could potentially update via ODBC. You may place a

check beside any available table which should allow ODBC writeback by the

operator.

Note:

This list includes only the tables for applications for which the operator

has a SouthW are security level of at least 7. If an operator does not

have a security level of 7 for an application (maintenance security) then

ODBC writeback is not allowed.

Edit Option

If you have already defined writeback tables for an operator and want to edit

the tables selected you may click on the Edit button. This will display the list of

tables and allow you to change the selections.


19

SouthWare ODBC L Security L Reset Single Operator

This option allows you to reset and rebuild the ODBC security settings for a single

operator. Normally you should not need to run this option but it may be used in a

support situation when you believe the grant/revoke privileges for an operator

and/or operator tables needs to be reset.

W hen you zoom on this option the program displays a list of operators with ODBC

access. You may click on the reset button beside the operator to be reset. The

program will then rebuild the ODBC security settings for the operator. This may

take several minutes depending on the speed of your computer.

SouthW are SQL Tools SouthW are ODBC - Security - Reset All Operators

20

SouthWare ODBC L Security L Reset All Operators

This option allows you to reset and rebuild the ODBC security settings for all

operators. Normally you should not need to run this option but it may be used in

a support situation when you believe the grant/revoke privileges for operators

and/or tables needs to be reset.

W hen you zoom on this option the program first confirms that you want to reset

all operators. It will then rebuild the ODBC security settings for all operators.

This may take several minutes depending on the number of operators and the

speed of your computer.

SouthW are SQL Tools SouthW are ODBC - Sample Uses

21

SouthWare ODBC L Sample Uses

This option displays an overview of sample uses of SouthW are ODBC by 3 -rd

party products such as Microsoft Query and Microsoft Excel. You can refer to an

example to help get you started on using SouthW are ODBC to retrieve data into

spreadsheets.

SouthW are SQL Tools SQLView

22

SouthWare SQLView

SouthWare SQLView allows you to access SouthWare data via SQL

statements and review/analyze the data in a SouthWare grid.

SouthW are SQLView can be used for ad hoc (one-time) SQL reporting or for

storing SQL-oriented “views” that may be used whenever needed. SouthW are

ODBC provides the SQL statement processing via SouthW are’s grid technology.

• Flexible SQL Statements

• Enter any valid SQL “select” statement related to SouthW are data

• SQL statements can contain SouthW are variables for “smart” views that

match current link values

• SQL Select W izard to help create SQL statements for SouthW are data

• Speedy Processing

• Data is “bound” to viewing grid to take advantage of fastest data retrieval

• Reusable View IDs

• SQL statements can be saved as View IDs

• SQLView View IDs can be called via SouthW are objects

• Powerful Data Review via Grid Options

• Sort data by any column

• Group data by any column (including multiple levels of grouping)

• Display group totals of numeric data

• Option to Save Layout

• Text search within data view

• Output to MS Excel

• Output to HTML page

• Print

SouthW are SQL Tools SouthW are SQLView - Overview

23

SouthWare SQLView L Overview


SouthW are SQLView.

How SQLView Works

The grid technology used by SouthW are utilizes SouthW are ODBC to “connect”

to SouthW are as a data source and then access SouthW are data via SQL

statements.

This method of data access does not use standard SouthW are data routines.

You get the advantage of faster access but will not be able to use the features of

SouthW are tools technology such as W orkFlow and link values. This is useful if

you simply want to get to the data quickly via SQL statements (data mining) and

don’t need SouthW are tools features.

Differences between SQLView Data Grids and other SouthWare Data Grids

• W hen you view data in a SQLView grid the data has been retrieved via

SQL/ODBC and the SouthW are program is not “aware” of what has been

retrieved or what data is in each column. This means that you cannot zoom to

related SouthW are programs or show previews of data in the related records.

• W hen you view data in other SouthW are grids such as Lookups and FYI, the

data has been retrieved via SouthW are routines and the SouthW are program

SouthWare SQLView Overview

SouthW are SQL Tools SouthW are SQLView - Overview

24

knows what data is in each column. This allows zooms to related programs

and preview options showing data from the related records.

The table below summarizes some key results of this difference in how the data

is accessed:

SQLView Grid FYI/Lookup Grids

Performance Typically Fast

depending on number of

records loaded

Speed depends on

efficient use of keys and

number of records

Able to filter records

with selection rules

Yes, via SQL “where”

rules

Yes, via record

selection criteria

Able to filter/manipulate

data via W orkFlow

No Yes

Able to zoom on a

column that has a

predefined hyperlink

No Yes

Able to access

“constructed” data not

stored in file (see “Data

Dictionary Differences”

under SouthWare

ODBC)

No, unless able to

construct via SQL

Select statement

Yes

Formatting of data Depends on ODBC Formatted based on

Data Dictionary or FYI

format

SouthW are SQL Tools SQLView - Launch Viewer

25

SouthWare SQLView L Launch Viewer

This option launches the SQLView viewer program. The viewer allows you to use

Structured Query Language (SQL) “Select” statements to retrieve data from

SouthW are data files. The viewer uses SouthW are ODBC technology to process

the SQL statement that retrieves data. The resulting view is displayed using

SouthW are grid technology.

SQL View ID:

To create a new or one-time SQL query view leave this field blank. After you

have created the view you may decide:

• to save it as a permanent SQL format, or

• to discard the view

To access an existing View ID enter the ID or use the Lookup feature to find

the ID. W hen you enter an existing View ID the program executes the query

and displays the retrieved records in the grid.

Description:

This field displays the description and purpose of the query. This is for

reference purposes only.

W hen you are creating a new query this field is skipped. It is applicable only


26

for saved queries. You may edit this description via the Options button.

SQL Select:

In this field you define the SQL Select statement for this query. The statement

you enter here will be sent to SouthW are ODBC to retrieve data from the

SouthW are database. See also the “SQLView W izard” section below.

Overview of SQL Select statements

The syntax of SQL Select statements can be quite sophisticated and is beyond

the scope of this manual. A simply query can be done with a statement format

of:

select (columns) from (table)

where columns correspond to fields and table corresponds to a file. For

example, the statement:

select * from RCUST

will select all fields from the customer file and display them in the view. This

statement will also retrieve all customers.

A further refinement of this statement might be:

select * from RCUST where State = ‘AL’

This statement would result in a query view with all data for the customers with

a state code of “AL”.

One more variation might be:

select CustomerName, AccountBalance, PhoneNumber, City from

RCUST where State = ‘AL’ and AccountBalance > 0

This statement would result in a query view that shows customer name,

balance, phone, and city for customers with a state of “AL” and a balance

greater than zero.

SQL Select statements can be much more complex. Refer to a SQL reference

(one of our favorites is SQL for Dummies by Allen G. Taylor) for more

information. There are also many on-line resources on the W eb to help you

learn SQL Select statement syntax.

SQL Select Statement Validation

Because of the many options available for SQL Select statements the program


27

cannot validate that the statement you enter is valid SQL syntax. However, it

does validate the following characteristics of the statement:

• Statement must start with “select” since SQLView is designed for

retrieving data. This also ensures that someone cannot perform other

possibly destructive SQL functions via a SQLView statement.

• Statement must have “from” table identified - see also security notes

below.

An error is displayed for invalid select statements.

SouthWare Variables

You may insert SouthW are variables (from XX99 fields) into SQL statements.

These variables will be replaced at runtime with the current value for the field.

This is a very powerful feature that allows your SQL statements to be

automatically modified for the current context (record key, date, etc.) each time

a view is run.

The syntax for inserting a SouthW are variable is:

<@XX99nnnn>

where “XX99” is the SouthW are Data Dictionary file and “nnnn” is the field

number. Any field available in XX99 may be used, which includes:

• Current dates

• Current operator ID

• Current link values (customer number, stock number, order number, etc.)

• Constructed variables (such as calculated dates)

• Ulink fields (possibly populated by W orkFlow)

For example, let’s say you want a SQL view that shows you all the invoices in

the last 90 days for the current link customer. Create a constructed variable

(XX-09-13) that computes a date as the current date minus 90 days (let’s say

you assign the computed date a field number of “8010" in XX99). The

statement could be:

select InvoiceNumber, InvoiceDate, TotalPrice from SHST1 where

CustomerNumber = ‘<@XX990051>’ and InvoiceDate < ‘<@XX998010>’

Each time you run this SQLView the program will first replace the variables with

their current values, then execute the SQL statement.

Security Notes:

SQLView uses the security access privileges defined for SouthW are operators

to control which data can be displayed. See the related discussion under

SouthW are ODBC, Security.


28

SQLView Wizard

At the Select statement field you may click on the W izard button to the left of

the field ([F5]) to access the SQLView W izard window. This wizard helps you

quickly construct basic SQL select statements for SouthW are data. The SQL

Select features supported by the wizard are:

• Select a list of fields (or all fields)

• From a single table

• W ith up to five W HERE constraints to control the records selected

Note to Advanced SQL Users

You can enter any SQL-supported Select statements for a SQLView, but

the wizard will support only the features above. Thus if you want to join

multiple tables, ORDER fields for sorting, define BETW EEN values for

ranges, etc., you must enter these statements directly into the SQL

Select field for the SQLView.

If you plan to enter a more complex SQL statement you could use the

wizard to create an initial basic statement and then edit the statement in

the SQLView Select field. If you then add features to the statement that

are not supported by the wizard you will not be able to use the wizard for

any subsequent editing.

To create a new Select statement (the select field is blank) the wizard first asks

for the Table name.

Table Name

Enter either the Table name or the SouthW are Data Dictionary File ID for

the Table from which data will be selected. You may use ([F3]) to lookup

ODBC Table names or use ([F4]) to lookup Data Dictionary File IDs.

For example, if you are selecting records from the Customer File you

may enter either the “RCUST” Table name or the “AR01" Data Dictionary

File ID.


29

After you specify the Table the wizard window will appear. This window defines

the following components of a SQL select statement:

• SELECT (which fields to extract - can be edited)

• FROM (the table being used - display only)

• W HERE (which records to include - can be edited)

• The resulting SQL statement (display only)

Fields to Select

Here you may specify the fields from the table to extract and display in

the grid. By default this parameter will be “*” for all fields.

Select Fields

To choose only specified individual fields you may click on the “Select

Fields” button. This will display a field selection wizard similar to the one

used in SouthW are FYI to select Data Dictionary fields. Since this wizard

is for ODBC access the fields shown are the ones available for the Table

in the ODBC Data Dictionary, not the SouthW are ReportMate Data

Dictionary. You may select as many fields as needed from the tree view

list, then click on the Finish button

From Table

SQLView Wizard


30

This is for display only and shows the table you selected.

Where Constraints

Here you may add SQL “where” constraints that limit the records selected

for this view. This is similar to the Record Selection Parameters for a

SouthW are FYI report.

W hen you click on the button to add a W HERE constraint an entry

window appears.

Here are the parameters you must enter to define a W HERE constraint

Choose ‘AND’ or ‘OR’

(Does not apply to the first WHERE constraint)

Here you must specify whether the additional W HERE constraint

is an AND condition or an OR condition relative to the previous

constraint:

• AND means that the condition must be true and the

previous condition must be true in order for a record/row

to be shown in the view

• OR means that the condition must be true or the

previous condition must be true in order for a record/row

to be shown in the view

Table Name

Display only to show table being used.

Field Name

SQLView Wizard WHERE Definition


31

Select a field/column name for the W HERE test from the list of

available columns for the table.

Test Operation

Specify the test operation:

• LT - Less Than (results in SQL operator of “<“)

• GT - Greater Than (results in SQL operator of “>”)

• EQ - Equal To (results in SQL operator of “=”)

• NE - Not Equal To (results in SQL operator of “<>”)

• GE - GT or EQ (results in SQL operator of “>=”)

• LE - LT or EQ (results in SQL operator of “<=”)

Test Value Type

Specify the source of the test value for this condition. The value

of the field/column specified above will be tested against this

value:

• L - Literal - You will enter the test value in the next field.

• S - SouthW are Variable - You will enter the name of a

SouthW are variable in the next field (see the

“SouthW are Variables” discussion above).

• D - Data Dictionary field - You will specify an available

field for this Table from the ODBC Data Dictionary.

Test Value

Enter the appropriate value:

• For a Literal, enter the value to be tested. For example,

if you are testing customer balance (AccountBalance) to

be greater than (GT) zero, enter “0" here.

• For a SouthW are Variable enter the variable name

(format of “<@XX99nnnn>”) or use the lookup to select a

SouthW are field as described in “SouthW are Variables”

above.

• For a Data Dictionary Field select from the dropdown list

of available columns.

Example W HERE constraints

Let’s say you are creating a view of Sales Orders to review discounts

given and want to show only sales orders with a Total Price greater than

$100 and a discount percent greater than 5.

• Enter a W HERE constraint for TotalPrice GT a literal of “100"

• Enter a W HERE constraint “AND DiscPct GT a literal of “5"

The resulting W HERE SQL statement will be

W HERE TotalPrice > '100.00' AND DiscPct > '5'


32

Toolbar Options

There is a toolbar above the grid that contains special SQLView options. These

options are outlined below:

Save a View

This option lets you save the current SQL statement as a SQLView format.

You may use this to save a new format or to save changes for an existing

format.

If the format has not been previously saved you must enter the View ID

and Description as well as the information described for the Options

function below.

Save As

This option lets you copy the current format to a new View ID name. You

must enter the new View ID and description.

Delete

This option will delete the View ID format. You may not delete the format

unless you have Edit access security.

Options Button

This function provides access to the following options for a SQLView

format:

Description

This is a 30-character description of the view that will display in

Lookup lists to help you identify the purpose of the View.

Security Options:

The options below allow you to control access to this View ID. These are

optional features related to running the SQLView program - they are in

SQLView Options Definition


33

addition to the ODBC security for the data provided by SouthW are ODBC

(see Other Security Notes below).

Access Only Oper/Group

Here you may specify an operator or group that may access and

execute the SQLView but may not edit the SQL statement. If you

leave this blank then any SQLView operator may access this

format.

Edit Oper/Group

Here you may specify an operator or group that may both access

and edit the SQLView format. If you leave this blank then any

SQLView operator may access and edit this format.

Hide Select Statement (View Only)

Here you may specify to hide the Select statement from view-only

operators. The program will hide the Select field from the display

for view-only SQLView operators:

• W ill not appear in SQLView screen

• W ill not appear in SQLView Lookup

• W ill not appear in SQLView tree view list

Extract ID

Here you may specify an Extract ID for this format. This allows

you to dump and build formats for saving/moving to other

systems. See XX-08-06-03 for more information.

Other Security Notes

! General access to SQLView is controlled via an operator option described in

the “Operator Access” section below. An operator may have normal access

(“Y”), view-only access (“V”), or no access (“N”) to the SQLView program.

! An operator must have access to SouthW are ODBC in order to use SQLView.

! Access to a SQLView does NOT automatically give you access to the data.

The SouthW are ODBC security allows access only if your SouthW are operator

has a security level of at least 4 for the related application. An error displays

from SouthW are ODBC if an operator does not have appropriate access to the

file.

SouthW are SQL Tools SQLView - Review Saved Views

34

SouthWare SQLView L Review Saved Views

Expand this option to review a tree list of the current saved SQLView views. As

you highlight each view the information pane to the right displays the parameters

for the view. You may zoom on a highlighted view to run (or edit) the SQLView.

You also have the option to delete a format (if your operator record has Edit

access for the format).

! An operator with SwiftMate security of 7 or higher will see and may delete any

SQLView record (unless SQLView access is disabled in the operator record).

This provides an administrator review capability regardless of the edit/access

operators within the SQLView records.

SQLView List

SouthW are SQL Tools SQLView - Related Options

35

SouthWare SQLView L Related Options

The options in this section document other features of SQLView that you may use

within the SouthW are environment.

SouthW are SQL Tools SQLView - Related Options - Operator Access

36

SouthWare SQLView L Related Options L Operator Access

A SouthW are logon operator option controls whether an operator may use

SQLView. You may use this option to grant/revoke SQLView privileges to each

operator.

Zoom on this selection to display a grid of SouthW are logon operators for the

current company. Beside each operator you may maintain the SQLView Access

option stored in the operator record (XX-03-02, field 8, Access SQLView). Valid

values for this option include:

Y Yes - Allow operator to create and view SQLView views

V View-only - Allow operator to view but not create SQLView views

N No - Do not allow operator to create or view SQLView views

SQLView Operator Access

SouthW are SQL Tools SQLView - Related Options - Launch Via Object

37

SouthWare SQLView L Related Options L Launch Via Object

This option documents the capability to launch a SQLView view via a SouthW are

object. This allows you to use SQLView views from menu view portal links, links

from buttons, breakout, W orkFlow, and other SouthW are technologies.

The syntax for calling a view from an object is:

SW SQLGRD/P [viewname]

where viewname is the View ID for a saved view.

SouthW are SQL Tools SQLSync

38

SouthWare SQLSync

With SouthWare SQLSync you can replicate the data from SouthWare files

into corresponding MS-SQL tables.

This lets you review, report, and analyze your data using the many tools available

for MS-SQL data tables.

W ith SouthW are SQLSync your SouthW are system will continue to update its

standard Vision file format, but the data will also be updated into corresponding

MS-SQL tables. This keeps the MS-SQL tables synchronized with the Vision

files. If an error occurs in updating the MS-SQL database then the MS-SQL table

can be rebuilt from the corresponding Vision data file.

• Simple Implementation

• Load related software

• Reference the MS-SQL database you want to update

• Point and click to set up replication for a file

• Reliable Data Integrity

• Primary data handling is done via SouthW are Vision files

• MS-SQL data is replicated from valid primary data updates

• MS-SQL data can be rebuilt as needed from SouthW are Vision files

• Live or Delayed Update of MS-SQL Tables

• Normal Mode is to Update Replicated tables interactively for each change

to the related Vision file

• Updates can be “suspended” if the MS-SQL database is unavailable,

then be resumed later to “catch up” the MS-SQL tables

• Data Security

• Primary data is stored in Vision files for less exposure to unauthorized

changes

• Changes to MS-SQL data via MS-SQL tools will not impact primary data

• MS-SQL tables can be rebuilt as needed from primary data files

• Minimized Impact on User Productivity

• Separate Server to Offload Replication Updates

• Users can continue to work without waiting on MS-SQL updating

• Automatic Error Recovery

• System can be configured to automatically recreate MS-SQL tables when

update errors occur

• Easy Administration

• Powerful manager program to handle setup, review, and administrative

functions

• Schedule or manually launch recreating of MS-SQL tables from Vision

files

SouthW are SQL Tools SQLSync

39

SouthW are SQL Tools SouthW are SQLSync - Overview

40

SouthWare SQLSync L Overview


SouthW are SQLSync.

How SQLSync Works

W hen you activate data replication for a file the SouthW are programs use a data

transaction logging file to record each change made to SouthW are primary ISAM

data files. The SQLSync server runs as a parallel background process to take

the logged transactions and use Acu4GL to perform the same data operation

(add, delete, change) on the corresponding MS-SQL table.

Automatic Error Recovery

A vital feature of SQLSync is that it is designed to be self-correcting for errors

encountered when updating the SQL tables in MS-SQL. Update errors can occur

for reasons such as:

• hardware problems

• the database being unavailable because it is not running or doing a backup

• other data compatibility issues possibly caused by direct manipulation of the

MS-SQL tables


41

W hen SQLSync encounters any error in updating it flags the table to be rebuilt

and the system continues to create transactions to be updated to the database.

At periodic intervals (specified in configuration) SQLSync will then automatically

rebuild any MS-SQL table that has had errors. This self-correcting mechanism

means that you typically don’t need to do anything to recover from errors during

table updates.

Live or Delayed Update

The SQLSync architecture allows the replication to be “live” or delayed. Normally

the SQLSync server will continually process transactions and the SQL tables will

remain synchronized with the primary ISAM data. If the MS-SQL database is

unavailable (such as for system administration or backup) you may pause the

SQLSync server and let data transactions accumulate in the log file. W hen you

resume the server it will process the accumulated transactions in the sequence

they were recorded until it catches up.

Security Notes

SQLSync is a licensed product and has a system number of 43.

• To access most SQLSync functions through the SQL Tools Portal an operator

needs to have a security level of 7 for system 43.

• To see or edit the Replication Setup settings (including the database login and

password) an operator must have a security level of 9 for system 43.

Multi-Company Notes

SQLSync is set up per company ID. This allows a different configuration per

company.

• You must start a separate SQLSync server process for each company. The

logon operator you use in the startup command line determines the company

for the SQLSync server.

• You must have an Acu4GL-enabled runtime license seat for each SQLSync

server process that you start.

If the MS-SQL Database is Unavailable

Normally you should pause the Transaction Server for scheduled administration

of the MS-SQL database. This prevents SQLSync from receiving errors that will

cause tables to be rebuilt unnecessarily.

If the database is unavailable for other reasons (such as hardware or software

problems) SQLSync will treat this like any other error in updating. The table will

be flagged for rebuilding, and the system will continue to create transactions to be


42

updated to the database. W hen the database returns to available status then the

transactions will be updated.

W hen the server launches the scheduled rebuild of any tables with errors then all

tables that had errors during the “down” time will be rebuilt. If you know that

these do not need to be rebuilt you may use the Manager portal to uncheck the

rebuild status for these tables.

SouthW are SQL Tools SQLSync - Update Server (Status)

43

SouthWare SQLSync L Update Server (Status)

Server Status

This option verifies and displays the status of the SQLSync Update Server. The

Server runs in the background to replicate the SouthW are Vision file changes to

the corresponding MS-SQL table.

The manager program communicates with the server to obtain the current status

of the Update Server. Possible statuses include:

Active

The Update Server program is running and is currently processing SQL

updates.

Paused

The Update Server program is running but has been Paused so that it is

not currently doing SQL updates.

NOT RUNNING

The Update Server program is not running (it did not respond to the

status command). You must start the Server Program as a background

process on the server.

The display to the right shows status-related info:

• Whether Acu4GL is licensed in the runtime on this workstation. Acu4GL

is required for the Update Server program but is optional for client

workstations. If Acu4GL capabilities are available in this runtime:

• You may launch the replication of files from the manager program

• Status of Update Server

• Date/Time of the data shown

SouthW are SQL Tools SQLSync - Update Server (Status)

44

• Total number of files being replicated to MS-SQL tables

• Total number of files flagged to be rebuilt (SQL tables will be totally rebuilt

from Vision data)

• Total number of files with errors (an error was encountered when updating

the MS-SQL table - this is typically flagged for automatic rebuilding)

• Number of records in SQLSync transaction file (file changes waiting to be

updated to MS-SQL tables)

Options to Change Server Status

The current status of the server determines what options are available for

changing server status:

If the Update Server is Active you may expand the Status node to access the

following options:

• Pause SQLSync Update - Select this option to temporarily suspend the

update of the MS-SQL tables with SouthW are files changes. These changes

will be queued so that when you resume the Update Server the changes will be

processed. A typical use of the Pause feature is when you need to do

database maintenance or backup of the MS-SQL database and need to

suspend all updates of the database.

• Terminate SQLSync Server - Select this option if you need to terminate the

program running in the background server process. Typically this option is not

needed except in special support situations or when you need to reload the

server program with a different cblconfig file or operator.

If the Update Server is Paused you may expand the Status node to access the

following options:

• Resume SQLSync Update - Select this option to resume the update of the

MS-SQL tables with SouthW are files changes. Any changes that were queued

during the time the Update Server was paused will be processed when the

Server is Resumed.

• Terminate SQLSync Server - (see description above)

If the Update Server is NOT RUNNING there are no options available for

changing server status. You must start the Server Program as a background

process on the server.

SouthW are SQL Tools SQLSync - Replicated Files

45

SouthWare SQLSync L Replicated Files

Replicated Files

This option allows you to list and review the files that are being replicated to MS-

SQL via SQLSync. Expand this option to show a list of each file being replicated.

The information shown includes information about file names and the Vision

(ISAM) file.

If you are using an Acu4GL enabled for MS-SQL you may choose to rebuild a

highlighted file by clicking on the “Rebuild” button (or double click on the file).

This will remove the corresponding MS-SQL table and rebuild it from the current

Vision file.

SouthW are SQL Tools SQLSync - Rebuild

46

SouthWare SQLSync L Rebuild Replicated SQL Tables

This selection contains options for rebuilding the replicated MS-SQL tables from

the Vision files. This lets you manually rebuild tables when needed.

Typically you will not need to use the options in this section since the SQL Server

will automatically rebuild any tables that report errors while replicating. You might

need to use these options when:

• You have manipulated data in the SQL database and need to rebuild it to

match the standard file(s).

• You have flagged a file not to be rebuilt automatically for errors (see “Error

Recovery?” in the setup section “Select Files to Replicate”). You will need to

manually select the file to be rebuilt if it has an error.

Expand this selection for the following options:

Select Tables to Rebuild

This selection allows you to select which tables to rebuild. See the following

“Select Tables” discussion for more details on the available options.

Launch Rebuild of Selected Tables

This selection launches the rebuild process for the tables that are selected for

rebuilding. See the following “Launch Rebuild” discussion for more details on

this option.

SouthW are SQL Tools SQLSync - Rebuild - Select Tables

47

SouthWare SQLSync L Rebuild L Select Tables

This selection gives you three options for selecting MS-SQL tables to be rebuilt

from their corresponding Vision files. Each option results in “flagging” tables to

be rebuilt so that the rebuild process will create a new version of the table from

the current Vision file.

Select All Replicated Files for Rebuild

This option will automatically select to rebuild all tables that are being

replicated. W hen you choose this option the “Rebuild?” flag will be set to “Y” in

all the tables and a grid will display showing the tables. You may selectively

edit the Rebuild flags if you wish.

Select SQL Tables with Errors to Rebuild

This option will automatically select to rebuild all tables that have been flagged

as having errors (an error condition occurs when a data update of the MS-SQL

table returns an error from the database). W hen you choose this option the

“Rebuild?” flag will be set to “Y” in all the tables that have a “Y” for the Error

field. A grid will display showing the tables. You may selectively edit the

Rebuild flags if you wish.

Select Individual Tables to Rebuild

This option will display a grid of all replicated tables but will not automatically

select any for rebuilding. You may click on the Rebuild column beside any

table to choose it for rebuilding.

SouthW are SQL Tools SQLSync - Rebuild - Launch Rebuild

48

SouthWare SQLSync L Rebuild L Launch Rebuild

This option launches the rebuild process for the tables that are currently selected

to be rebuilt.

Rebuild Selected Tables via Server

Select this option to instruct the SQLSync Server program to launch the rebuild

of the tables for all files flagged to be rebuilt. This will send a command to the

Server so that the rebuilt process will occur on the Server as a background

process.

Rebuild Selected SQL Tables Now

This option will appear only if your workstation is using an Aucobol-GT runtime

that is enabled for Acu4GL for MS-SQL.

If you are running a runtime with Acu4GL for MS-SQL you may run the rebuild

process from your workstation. Choose this option and the rebuild process will

be run for each file flagged to be rebuilt. Your workstation will be used to

rebuild each table.

SouthW are SQL Tools SQLSync - Replication Setup

49

SouthWare SQLSync L Replication Setup

This selection contains options related to setting up the replication process of

SQLSync:

• Set up the MS-SQL Interface Settings

• Review the default Acu4GL Settings

• Select the files to replicate

• Set up the automatic scheduled activities

Security Note

The options in this section require that an operator have a security level of 9 for

system 43, SQLSync.

SouthW are SQL Tools SQLSync - Setup - MS-SQL Interface Settings

50

SouthWare SQLSync L Setup L MS-SQL Interface Settings

W ith this option you define the interface settings for replicating data to your MS-

SQL database. W hen you choose this selection a window lets you define the

following settings:

XFD Directory

This field must specify the directory where the XFDs (file descriptors) for

SouthW are files have been installed. This will automatically default to the

standard “xfds” directory under the SouthW are run directory which is the

default location during installation.

Note: Extended Data file definitions are stored in company ID specific

directories under the xfds directory.

MS-SQL Database Name

Here you must specify the name of the MS-SQL database that you have

created for the replicated data files. You must create this database via MS-

SQL administration before SQLSync can create tables in it.

Database Login ID

Specify the MS-SQL database login to use when connecting to the database.

Typically this login must have administrator privileges in order to be able to

create/update/delete tables and records.

Database Login Password

Specify the login password to use when connecting to the database.

Server Name or IP Address

Here you must specify the network address of the MS-SQL server machine.

W e recommend that you use the IP address of the server, but you may also

use the server name. SQLSync will use this address to connect to the MS-

SQL server database.

If you change any of these settings you will normally need to stop/restart the

SQLSync Server before the new settings will be used.

SouthW are SQL Tools SQLSync - Setup - Acu4GL Variables

51

SouthWare SQLSync L Setup L Acu4GL Variables

This option displays and allows you to maintain other special environment

variables used by Acu4GL. Default values are automatically set up and normally

you will not need to change these.

If you choose to add or change a configuration setting you may zoom on this

selection to display a maintenance program. You may enter up to 15

configuration names and values that will be used by Acu4GL. See the Acucorp

Acu4GL documentation for more information on these variables.

SouthW are SQL Tools SQLSync - Setup - Files to Replicate

52

SouthWare SQLSync L Setup L Select Files to Replicate

Sample List

W ith this option you specify which SouthW are files to replicate to MS-SQL tables.

W hen you select this option you will see a grid of all SouthW are files that are

available for replication. The grid contains the following columns:

File ID

This is the SouthW are Data Dictionary identifier for the file (as used by FYI,

ImportMate, W orkFlow, etc.).

Company ID

For user-defined files such as Extended Data this column will contain the

company ID to indicate that this file is uniquely identified per company.

Description

This shows the description of the file as defined in the SouthW are data

dictionary.

FD Name

This is the name of the File Descriptor definition for this file.

Replicate?

This indicates whether replication is enabled for this file. You may toggle this

value by clicking on the checkbox. See “To Activate Replication for a File”

below for more details on the use of this field.

MSSQL Table Name


53

For files being replicated, this shows the name of the MS-SQL table. This will

be “SW _xxxxx” where “xxxxx” is the SouthW are external file name. You may

edit this if needed.

Error Recovery?

This applies only to files that are replicated.

This flag controls whether the system will automatically flag the table to be

rebuilt whenever an update error occurs. By default this flag is set to “Y” or on

for any file being rebuilt. This tells the system to rebuild the file if there is an

update error that prevents the MS-SQL table from being updated with a

SouthW are file change.

The reason this is an option is to allow you to disable the automatic error

recovery if you want to control W HEN the table is rebuilt. Possible situations

might include:

• The table takes a long time to rebuild and you want to schedule the

rebuild for non-peak times.

• You only use the table for occasional (such as monthly) SQL reporting

and will set up a special rebuild scheduled action for this file prior to your

monthly reporting.

To Activate Replication for a File

To turn on replication for a file you simply click on the “Replicate?” column beside

the file. This toggles on the replicate feature. The system automatically builds a

replication record for the file/table. This replication record causes the system to

set up environment variables so that any update of the SouthW are file by

SouthW are programs will trigger a corresponding update to the related MS-SQL

table.

Logoff/Logon Requirement for Activating a File

W hen you initially turn on replication for a file the system needs to build the initial

MS-SQL table from the Vision file so that the system can start processing

changes to the MS-SQL table. The system will not allow the build of the MS-SQL

table until any operator logged into the system has a login date/time after the

replication has been enabled. If you want to activate replication immediately you

must either request that all operators log off and back on, or you may use the

system administrator function (XX-08-09-01) to automatically log active operators

off of the system.

Explanation:

If there are operators logged on to the system when you activate replication for

a file these operators will not have the appropriate environment variables set

for replication. If the table was built while those operators are still logged on,

any changes made by these operators would not be replicated to the table. To


54

ensure data integrity the system must wait to build the table until all operators

have the correct environment variables.

SouthW are SQL Tools SQLSync - Setup - Scheduled Server Activities

55

SouthWare SQLSync L Setup L Scheduled Server Activities

This option allows you to set up and review the scheduled actions (XX-09-08) that

automatically launch SQLSync functions. These automatic functions are

designed to minimize the need for system administration for SQLSync.

For each of the options below you may define a scheduled action that will launch

the option at a specified recurring interval:

Recurring Rebuilds

This action launches the rebuild of all MS-SQL tables that are flagged for rebuild.

The interval you choose might be every few minutes (to ensure that your

replicated MS-SQL tables are accurate throughout the day) or might be once a

day. The information area to the right shows the current schedule if you have

defined one.

Pause Update

This action sends a command to the SQLSync server to pause the update of

transactions to the MS-SQL database. One intended use of this schedule feature

is to stop the update when you perform a backup of the MS-SQL database. The

backup software may require exclusive use of the database, and pausing the

SQLSync update will prevent you from receiving update errors.

For example, if you have an automated backup of your MS-SQL database at

0100 (1 am) every night you could schedule to pause the SQLSync server at

0055 (12:55 am).

Resume Update

This action sends a command to the SQLSync server to resume the update of

transactions to the MS-SQL database. One intended use of this schedule feature

is to resume the update after a backup of the MS-SQL database. The backup

software may require exclusive use of the database, and pausing the SQLSync

update during backup and then resuming it after backup will prevent you from

receiving update errors.

For example, if you have an automated backup of your MS-SQL database at

0100 (1 am) that runs for approximately 30 minutes you could schedule to

resume the SQLSync server at 0145 (1:45 am). W hen you resume the server

any transactions that have been queued will then be processed.

SouthW are SQL Tools Installation Notes

56

SouthWare SQL Tools - Installation Notes

The following sections provide more details on the process of installing the

software required for the SQL Tools.

Installing SouthWare ODBC

W hen you install SouthW are on your server the standard SouthW are installation

script will automatically install SouthW are ODBC on your server. This will:

• load Transoft U/SQL server software

• load the U/SQL Data Dictionary for SouthW are files

• load the U/SQL Client files that will be needed by client machines

• create some config files based on your server settings

The following configuration process will occur when a SouthW are administrator

(with SwiftMate security level of at least 7) logs onto SouthW are:

1. A message explains that SouthW are ODBC is not set up and asks if you

are ready to configure it.

2. A question asks you to confirm whether you are running on the server

machine (you must be running on the server to configure SouthW are

ODBC).

3. A window lets you confirm the IP address of the server (current machine)

and the port to use for the ODBC server process (normally you should

take the defaults).

i. The program creates the ODBC license on the server.

ii. The program installs the ODBC server software on the server.

4. A window displays a list of the company IDs on the system. By default the

installation process will set up server Data Source Names for each

company you use. You may click the “Active?” column to unselect a

company if you do not want to set up SouthW are ODBC for that company

(e.g. for an obsolete or test company you may not want to set up ODBC).

i. The program sets up a Server Data Source Name (DSN) for

each SouthW are company ID that will use SouthW are ODBC.

ii. The program resets all workstations so that W indows controls

will be re-registered at next logon. This will set up the ODBC

client software needed for each workstation.

iii. The program will reset the W indows control for the current

workstation to set up the client ODBC software and client DSN.

iv. For the current company the program also:

(1) Defines company-specific ODBC tables (if applicable

(a) W arehouse Tracking tables

(b) Extended Data tables

(2) Defines ODBC Security (Grant/Revoke) Settings for

each SouthW are operator and file within the U/SQL

security table


57

On the SouthW are Server machine

After the installation your SouthW are server will contain the following components

of SouthW are ODBC:

• Transoft U/SQL Server software

• U/SQL Data Dictionary for SouthW are files

• Data Source Name (DSN) for each SouthW are company ID that will use

SouthW are ODBC

• Security (Grant/Revoke) Settings for each SouthW are operator and file within

the U/SQL security table

On each SouthW are Client machine

W hen you log in to SouthW are on a client machine the logon process will

automatically install/create the following components on the client machine:

• Transoft U/SQL Client software (loaded from the server)

• Data Source Name (DSN) for the SouthW are company ID (if the company has

a server DSN for SouthW are ODBC)

Security Note

By default ODBC access will be enabled for all operators (subject to their

security levels). If you want to disable ODBC access for one or more operators

you may do this in the operator record (XX-03-02, field 8, “Allow ODBC

Access?”) or via the SouthW are ODBCLSecurityLSet Operator Access option

in the SQL Manager.

Installing SouthWare SQLView

SouthW are SQLView is included in the SwiftMate module that is part of every

SouthW are system. SouthW are ODBC must be installed, configured, and

running as outlined in the previous section. There are no special steps needed to

load SQLView.

Security Note

To activate SQLView access for an operator you must specify “Y” to the option

“Allow SQLView” in the operator Other Security window (XX-03-02, field 8

Special Security). You may use the “Operator Access” grid available under

Related Options for SQLView to quickly set this for all operators.

Installing SouthWare SQLSync

Step 1: Install SQL Server

Microsoft SQL Server, version 6.5 or later, must be installed and configured on

the W indows NT server machine before you install Acu4GL for Microsoft SQL

Server on the client machine. Follow the instructions from your RDBMS vendor.


58

NOTE: If you are running Microsoft SQL Server Version 2005:

SQL Server 2005 client software no longer provides the "ntwdblib.dll" on which

both Acucorp's AcuSQL for MSSQL and Acu4GL for MSSQL rely. To work

around this, there are two options:

• Use the SQL 2005 client software as long as the "ntwdblib.dll" from the

SQL 2000 client software has been placed in the appropriate directory so

that it can be found by the Acu4GL for MSSQL or AcuSQL for MSSQL

runtime. You can download ntwdblib.dll from the internet from several

sites

• Use the SQL Server 2000 client software.

Step 2: Copy the batch file

MS_INST.CMD is a batch file from ACUCOBOL-GT that creates the

MS_INST.SQL file, which is the collection of stored procedures necessary for

executing the Acu4GL product. Copy MS_INST.CMD (located in your

ACUGT\install directory to your server machine into a directory of your choice.

Step 3: Execute the batch file

To execute the batch file, enter

MS_INST LockDatabase (Default name when setting up SouthW are Sync)

where LockDatabase is the database you want to use for the internal

ACUCOBOL-GT lock tables. If this database does not already exist, it will be

created.

Everyone who will use the Acu4GL for Microsoft SQL Server product must have

write access to this database.

This step creates MS_INST.SQL, the collection of stored procedures necessary

for executing Acu4GL for SQL Server.

Step 4: Install the ACUCOBOL-GT stored procedures

To install the ACUCOBOL-GT store procedures in your Microsoft SQL database,

execute the generated MS_INST.SQL file with the SQL Query Analyzer or the

SQL Server Management Studio if you are using Microsoft SQL Server 2005.

By default, the stored procedures are installed into the master database.

However, you may choose another database in which to store them.

To execute this file:

MS_INST.SQL LockDataBase


59

W here LockDataBase is the name of the database where you want to the stored

procedures installed.

Execute SouthWare SYNC Server:

C:\swrun\wrun32.exe -w -c c:\swrun\cblconfi.sw

c:\swrun\programs\SW SYNSVR.OBJ OPER=SYNC TERM=001

where C:\swrun contains the Acu4GL For MS-SQL enabled runtime.

OPER = The SouthW are operator used for the Sync Server process.

NOTE: W e recommend using a specific operator for this process.

TERM = The SouthW are terminal # used for the Sync Server process.

NOTE: You must use a terminal line # that will not be used by any other

operator or any other process.

To Check Acu4GL Enabling

To know if the runtime is Acu4GL enabled, type wrun32.exe -vv in the directory

where the runtime is loaded.

SouthWare SQLTools · 2012. 6. 5. · See the introduction to the appropriate section of this...

Documents

Transcript of SouthWare SQLTools · 2012. 6. 5. · See the introduction to the appropriate section of this...