Access
2000 / 97 Operational Information
SQL
Server 2000 Operational Information
Checking
Out a File or Project
ODBC
Setup for SQL Server 2000
Product Information
·
Software
Version Control is a software package
that will help developers keep track of software changes of several projects at
once or just one project. This package does not only track software but any
binary file can be loaded in to the project to monitor changes. Retrieve older
version of programs that no longer exist that have been deleted. SVC has
no size limitations of the files that you want SVC
to track. Microsoft Access 2000
(Jet 4.0) is the default installed database; the database (.mdb) is
included with the installation.
- SVC can import any file of any size. exe, bat, cmd, bmp, pcx, jpg... The actual file can be for example 50GB and SVC will have no problem importing and keeping track this file. The only limitation is the back-end database systems used. SVC supports MS Access, MS SQL Server 2000 and Oracle 9i. (Support for more databases will be added when the database manufacturers systems become robust enough).
Ex. Microsoft Access has a physical database limitation of two gigabytes (2GB), while Microsoft SQL Server 2000’s is one terabyte (1TB) and Oracle's limitation is several terabytes.
This would mean that only small operations should use Access while larger ones should use a scalable database. Scalable databases would also help in the protection of the data by providing replication, fail-over clustering, automatic backup and rollback features that can not be done using simple flat file storage.
SVC does not have to manage how much the database could hold; the database would handle this automatically.
- All your data is in one place, no matter how many managers or programmers have used the system.
While “Source Control” systems just copy the imported file to a different location on the computer or network, which can become lost, damaged or worst infected with a virus. Using a database limits that possibility, because once you put the file inside the database viruses cannot get attached to it!
Portability is key to moving your data around in an organization. With a database you move basically one or two files as opposed to the hundred or thousands that you may generate in your SDLC cycle.
Backups are generally done better in an organization using a database than large amounts of files.
- Projects that are imported into SVC can have the added benefit of not allowing all users to see all the projects that SVC holds. So if one user needs access to three projects and another user only needs access to one project, he will not see the other two, they do not even exist to this user.
- Security on the menu level is addressable in SVC. You can lock out certain functions that you would not want everyone to have access to.
Ex. Certain users can copy projects, delete or add new projects while other users can only check in and out files.
- SVC not only handles source code but by being able to import any type file, SVC can put a whole environment back onto a computer (except for registry information). All files and directory structures can be exported back to their original location from which they were imported.
No copying of files to an import directory to get it into the system. The file can be imported from the exact location that it was stored in the first place. This makes getting it back to that location, should you need to, a snap!
This system will not import a file into a project if the file already exists in the project and was not changed. The comparison is done on a binary level not on an ASCII character level.
- All operation can be handled on a transaction basis, so that if a failure occurs a rollback to a stable state can be achieved. This happens automatically.
- Store comments on the project level so that you know what the project contains.
· Check-In and Check-Out whole projects at one time, not one file at a time (Unless you really want to!).
Overview
We will describe the proper
operating environment for SVC to work in. There are a few things that
should be in place for proper operations and they are as follows:
1.
SVC
will work with client/server databases in regular or authentication modes.
Regular mode is that your ODBC driver is connected to the database and has the
user name and password to log on. Authentication mode is where the database
will require each user to put in their user name and password to log onto the
database.
Authentication is setup on
the database server (SQL Server 2000 or Oracle).
2.
To cause SVC to have the user put in his user name and password
for a client/server database that supports authentication, leave the UserName
and Password items in the ini file blank. Ex. UserName=
3.
All users need to have a unique LAN logon ID. The database logon ID can
be the same, but using the LAN logon ID is how SVC does file tracking.
If done this way only the user who checked a file out from a particular
directory in a project will be able to check it back in, all others will be
denied. If any users have the same LAN ID, they will be allowed to overwrite
each other’s files, being that SVC will see them as the same user.
4.
No drive information is kept in SVC. This means that when you
check files in or out, no information about what drive the files came from or
is exported to, will be retained. The only reference to this information is in
the logs.
5.
File check in can be done in two modes, relative and static modes. This
means that if you open a directory named DOC and do not mark Check
in all underlying subdirectories inside a directory structure of C:\TEMP\SVC
TEST\FILE1\SVC\DOC\ with the file named SOFTWARE VERSION CONTROL.DOC selected
for check in. SVC will check the file in under a directory of DOC
as described in the following diagrams; this is static mode.
Product Requirements
SVC needs video set to 1024 x 768 resolution and the following software should be installed in the following order:
1. Windows NT/2000/XP.
2. Windows NT Service Pack 6a / Windows 2000 Service Pack 2 or 3 (Download from Microsoft).
3. We recommend using the AutoOSUpdater to do steps 4 and 5 (MDAC installation). Download from the website.
4. Microsoft Data Access Components 2.6 - (mdac_typ 2.6.exe) - Can be downloaded from website.
5. Microsoft Jet 4.0 Components SP 3 – (Jet40Sp3_Comp.exe) - Can be downloaded from website
6. If using SQL Server 2000 or Oracle 9i you will need those database engines installed.
Basic Installation Procedure
1. Login as user with Administrator privileges
2. Install SVC.
3. Reboot.
4. Login as same user with Administrator privileges.
5. Run SVC.
6. Setup new users and user privileges (In the Security menu you must checkmark active for the users).
7. Logout of Windows.
8. Login as an SVC user.
9. Run SVC.
If you are installing on a
system that has Visual Basic 5.0 on it do not continue with the installation or
VB system files will be overwritten with Visual Basic 6.0 system files and your
Visual Basic 5.0 programs may not work. Your original system files will be
backed up anyway in the common Files directory in a backup directory (Ex.
c:\Program Files\Common Files\SVC VB Backup) and these files can be copied back
to the Windows system directory if there is any problem (Ex.
C:\Windows\System32).
Note: When connecting using ODBC for each users computer, you do not have to install SVC as the administrator. You only need to log in as the user to install and then connect to the ODBC Datasource that you have already set up. All user ID's and privileges will come from the central database that you setup for SVC.
Basic Operational Procedure
1.
Create a project for the software that you plan to track.
2.
Give users access to the project.
3.
Check-In the files into the project that you created.
4.
Check-Out the files from the project that you plan to change.
5.
Check-In the changed files into the same project.
6. SVC Setup Procedure:
Support Information
All Support for this product is done by email (except for registered users). If you have comments or suggestions... Please send us an email at svc@randem.com . We appreciate any detailed responses good or bad so that we may make this a better product.
Access 2000 / 97 Operational Information
SVC defaults to the Microsoft
Access Jet 4.0 engine. The system supports OLE DB Provider Support for Access Jet 3.51,
Access Jet 4.0, OLE DB Provider Support for ODBC for Access 2000, SQL Server
2000 and Oracle 9.0i. Although other versions of these packages will probably work, these
are the ones that were tested. To use a SQL client/server database you must setup
ODBC. This will allow you to connect with the SQL client/server Database
Engine. The Microsoft Access Jet engines are installed when SVC
is installed and there is no other configuration necessary for Microsoft
Access databases other than to select which one that you want to use.
On
the one of the next pages you will find the contents of the ini file that is
used to run the system. It is setup for Microsoft Access to change it to
SQLServer 2000 usage you need to comment out the ActiveDB=ACCESSJET4
line and uncomment the ActiveDB=SQLSERVER line.
If using the Microsoft Access
database you will need to change the ServerName parameter in the ini
file to point to the location of the database on your system. It is set to the
default location of the installation process and will work from there. If you
change the location of the .mdb file you need to change this location also.
This parameter will take the full UNC path name.
Ex.
\\Server\SVC\Access
Database\ as well as C:\Program
Files\SVC\
SQL Server 2000 Operational Information
Included
in this system, in the install directory is a file to aid in the creation of
the SQL Server 2000 database. The name of the file is SVC 3.2 -
SQLServer Database Creation. To use the SQL Server 2000 database run
the
SVC 3.2 – SQLServer Database Creation.sql file in the Query
Analyzer, this will create the SVC 3.2 database.
When
using SQL Server we are assuming that you are running in a client/server
environment with SQL Server installed on a server. If you are running this
script from the client side, the ODBC connection must be setup first. Which
also means that the ODBC connection on the server was created when you
installed SQL Server 2000. To create the database in SQL Server 2000,
a few things need to be done:
1.
Create an empty database named SVC 3.2 in the SQL Server
Enterprise Manager.
2.
Setup a user with permissions as owner of the database, preferably you
since you are going to be running the script.
3.
Exit the Enterprise Manager.
4.
Login to the SQL Query Analyzer (as the user with ownership of the
database).
5.
Run the script in the SQL Query Analyzer to delete then create the
database with all the tables.
6.
Add the permissions of the user that will be allowed to connect to the database.
7.
Run SVC to connect to the database
8.
Add SVC users to SQL Server 2000 (can also be done later).
9.
SQL Server Express 2005 Operational Information
Included
in this system, in the install directory under a folder named SQL is a file to
aid in the creation of the SQL Server Express 2005 database. The name of
the file is SVC 3.2.0 - SQLServerExpress2005 Database Creation.sql.
When
using SQL Server Express 2005 we are assuming that you are running in a
client/server environment with SQL Server installed on a server. If you are
running this script from the client side, the ODBC connection must be setup
first. Which should means that the ODBC connection on the server was created
when you installed SQL Server Express 2005. To create the database in SQL
Express 2005, a few things need to be done:
1.
Open SQL Server Management Studio Express
2.
From the main menu go to File-> Open -> SVC 3.2.0 -
SQLServerExpress2005 Database Creation.sql.
3.
From the main menu g to Query -> Execute.
This will create an empty database.
4.
Add the permissions of the user that will be allowed to connect to the
database.
5.
Run SVC to connect to the database.
6.
Add SVC users to SQL Express 2005.
The first screen that you
encounter is where all transaction will initially take place. Depending on you security
privileges in SVC the menu at the top will differ. The first thing that you
want to do is to add a new project. You need to do this in order to check your
files into. Anytime you want to get to a particular screen just go to
View->(Screen Name) to display the screen.
Adding a New Project Name
To add a new
project to check files into for tracking, choose Operation->Add New
Project from the menu then enter the information for the project.
Project Name - The name that you want to give to the
project.
Major - Version major number.
Minor - Version minor number.
Rev - Version revision number.
Description - Verbiage to explain the project.
Using the drop down selection to select the project, you
can use this screen for modifying the project. If you retrieve a project and
change the information such as Version numbers or project name will generate a
new project in the database. This function is designed so that you can start a
new project version without having to re-enter the information.
Ex. Project A –
Version 1.0.0 was entered and checked in. A developer checked out the software
and wants to check it in as a whole new version. The developer retrieves the
project information, changes the version number and presses the Add button
and now you have two separate tracking package projects. The reason for storing
the software this way is incase you might want to roll back the software one or
two version prior you can easily do this by checking out the prior version.
Checking In a File or Project
To check in a project,
select the Operation->Check-In Files selection from the drop down
menu at the top of the screen. You will get the screen below. Select the name
of the project that you want the files checked into, and then select the directory
and/or files that you want checked in.
Project Name - Select the project name that you want the
files checked into.
Location - Indicates the directory where the
files to be checked in reside.
Version - The version number of the
project name that you selected.
To select the directory where you want the files checked
in from choose the drop down indicator on the right. You will find all
available drives in this selection to choose from. In the box directly under
this one you can select the directories on the selected drive.
If you want to check in a directory with several
underlying sub-directories you may select the Check-In Underlying
Directories check box and click the Check-In button. This will
automatically select all files and directories under the chosen directory to
check-in.
If you want to check-in the files in one directory… choose the directory and you will see all the available files in the left window box. You can either select individual files or you can select all the files in that directory by pressing the Select All button. To unselect the files you can press the De-Select All button.
Upon checking in the files
you will get a pop-up message log that you are done and how many files were
checked-in along with any problems that might have occurred.
Checking Out a File or Project
To check out a file or project, the process to follow is to select the project that the files reside in. This will bring up all the sub-directories in that project of which you can select the whole directory, just one sub-directory or just a few files to check-out.
You can select a sub-directory by clicking on the
directory that you want to view and the contents of that directory will be
displayed. You can either select all the files in that directory or just the
files that you want by selecting the files. When selected, a check will appear
in the checkbox on the left of the file, which indicates that you have selected
this file/folder for check out.
After selecting the files that you want to check
out, select Operations->Check Out from the drop down and begin the
check-out. If you want to get back to the sub-directory screen just select the
back menu on the top of the screen.
When selecting the Operations->Check Out
menu selection you will get a screen that will allow you to select where you
want the files to be placed. If you are selecting a directory for check-out and
you have selected all underlying directories on check-in, the whole directory
structure will be created in the location that you have selected to place the
files. If you did not select to check-in all underlying directories only the
immediate directory will be created.
After check out,
you will get a pop-up message log that shows you all the files that were
checked out.
Security
On the security menu selection you can allow or
disallow users functions contained in SVC. You can even eliminate the menu
option that the user sees so that they won’t even try to do a function. This
way the user will have no idea that the function even exists. The functions are
somewhat self-explanatory, but remember to set the user as active or they will
not have access to the system even though they are in the database.
If you relate
the fields on the security screen and the menu on the main screen, it is very
easy to see which menu selections you can disable and which function under the
menu selections that you can also disable. Care should be used here for you can
unexpectedly lock a user from a menu selection even though you allow them
access inside the menu. Of course the menu selection takes precedence.
ODBC Setup for SQL Server 2000
(In Windows 2000 other OS, Windows NT and
Windows XP may differ slightly)
To configure Software Version Control for use with SQLServer 2000 (regular mode) go to Start->Settings->Control Panel then click on the Data Sources (ODBC) icon. Select the System DSN tab on the ODBC Data Source Administrator window and press the ADD button.
Fill in the following screen
with the information in the window below except for the Server drop down box.
In this box you select the server that you have installed SQL Server 2000
on.
Use Windows NT
authentication to reduce the security risk of unauthorized users.
Click on Client Configuration
and configure for TCP/IP to the server that the SQL Server 2000 software
is installed on. In this example the server name is SQLSERVER.
After configuring the ODBC
driver, you must now test it to insure that you can connect to the server.
If you complete the test,
you are now able to use Software Version Control to access the database.
Included with SVC in the setup directory is a file named SVC 3.2 -
SQLServer Database Creation.Sql, this is the SQL needed to create
the database of which you will need to run this system. The Microsoft Access
database contains the tables needed for the database to operate.
You
must change the ServerName in the ini file to match the name of you
server that is named in the ODBC driver.
ODBC Setup for MS Access
Setting up ODBC for Access is relatively simple. Just press add and select the Microsoft driver in the ODBC Administrator under System DSN. Point to where the database is and you are done. You do not have to worry about too much because SVC can use UNC Path names to connect to the data. In the ODBC driver you however need to use a drive letter to point to the database.
There is one thing that you need to do for Access ODBC. Press the
Advanced button and use the Login name Admin for the ODBC driver to open the
database.
Sample .ini File
Sample ini File
;
ini file for Software Version Control
;---------------------------------------------------------------------------
; Name Area Usage
;
;
ActiveDB - [System] - Current
database and ini section to use
;
Debug - [System] -
(True/False) Write info to the Debug table
;
TraceSQL - [System] -
(True/False) Write SQL info to Debug table
;
;
ODBCSystemName - [ActiveDB] - ODBC
system name
;
Database -
[ActiveDB] - Name of Database for SVC
;
ServerName - [ActiveDB] -
Database location (in Access use UNC Path Location)
;
ServerSideCursor - [ActiveDB] -
(True/False) Use Server side or client side cursor (if supported)
;
UniCode - [ActiveDB]
- (True/False) If database does unicode character processing
;
User -
[ActiveDB] - Default user login ID
;
SqlTimeout - [ActiveDB]
- Max milliseconds before timing out on SQL Query
;
ChunkSize - [ActiveDB]
- Size of Read/Write buffer for Database and Disk transfers
;
ChunkCount - [ActiveDB] -
Number of Read/Write buffers in each table row
;
Transactions - [ActiveDB]
- (True/False) Use transaction processing for Check-in/check-out
;
SystemName - [ActiveDB] -
Title to appear on main selection screen
;
Password - [ActiveDB]
- Password to send to the OLD DB Provider (for log on)
;
;
DeleteAfterImport - [Options] - (True/False) To delete file after it is
imported
;
SelectAll - [Options] -
(True/False) Select all items to export automatically
;
ReportPctSize - [Options] - Use 25
to 400 for default report viewing
;----------------------------------------------------------------------------
[System]
ActiveDB=SQLSERVER
'ActiveDB=ACCESS
'ActiveDB=ACCESSJET351
'ActiveDB=ACCESSJET4
'ActiveDB=ORACLE
'ActiveDB=PERVASIVE
Debug=False
TraceSQL=False
[ACCESS]
ODBCSystemName=SVC
- Access
Database=SVC
- Access.mdb
ServerName=\\sqlserver\svc\access
database\
ServerSideCursor=True
UniCode=False
User=Admin