# $ K + Vss Data Manager
This Help file describe how to use the MngData utility which provide simple interface to obtain / update data from a vss data base. 

{bmc Ico_open.bmp} Requirements
{bmc Ico_open.bmp} Ini File

{bmc Ico_open.bmp} Starting with Vss Data Manager
{bmc Ico_How2.bmp} How to obtain data
{bmc Ico_How2.bmp} How to update data

{bmc Ico_open.bmp} Interface

{bmc Ico_Mark.BMP} Frequently Asked Questions
{bmc Ico_Mark.BMP} Questions and Request
{bmc Ico_Bugs.BMP} Reported bugs

{bmc Logo_1.bmp}

# $ K + Requirements
First thing you must be connected to the network.

Time server
For updating data it is very important that time on all computer is the same. To be sure of that each time you obtain or update data the program synchronize your computer time with time given by a time server. The time server is a little program that run on only a computer and that respond to request done by the Data Manager. If error with time server appears contact administrator.

Local path
In order to obtain data you must define a target local path were obtained data should be written. It’s just a directory in your computer hard disk. It’s name appear in interface window and could be changed.

Vss database
You must have access to the VSS database that contains all data you need. So VSS (version 5) must be installed in your personal computer and must have been run at least one time. 
Data files are stored in a VSS project, this project is the same for everyone using the same database. Before the utility’s main window appears a login window appear, the database ini file is displayed and you can browse to a different Vss database.
You must have right to log to database. Ask your administrator to create to you a login with your name.
By default, when you obtain data all files located in this project and recursively in all sub projects are copied in your hard disk, in the local path you’ve defined.

# $ K + Ini File
All initialization data are saved in a file located in same directory than the program and which name is MngData.ini. If you open this file you can read in it VSS parameters and other user defined data. If this file is deleted first you loose all your own configuration and most important, you loose system configuration.

The Ini File can contain these section
[Target Path] (optional)
[Vss]
[FileList-Config##] (optional / ## is a number)
[Obtaining] (optional)
[WinPref](optional)

To help you understanding the content of this file here is a commented sample. All Ini file line are in blue color if they are optional or in red color if the line must appear in ini file.
Because there is only one parameter that can’t be edited by the Vss Data Manager here is a sample of a minimal MngData.ini file

[Vss]
DataRoot = $\GameData

# The [TargetPath] section contains information about folder where obtained data will be written. If this section doesn’t exist, file will be copied in your system temp directory.
[TargetPath]
DirName=X:\CPA\EXE\MAIN\GAMEDATA

# The [Vss] section contains information about VSS. 
The “DataRoot” entry is the most important because it’s the only parameter you can’t edit. This gives the VSS project that correspond to your local directory. 
For example if 
TargetPath is X:\CPA\EXE\MAIN\GAMEDATA 
and Vss DataRoot is $\GameData 
when obtaining 
$\GameData\Options\Camera.ipt vss file will be obtain in
X:\CPA\EXE\MAIN\GAMEDATA\Options\Camera.ipt
Others entries indicates the last opened database and last user name.
Last parameter which name is FileList indicate your current obtaining file list configuration. It’s automatically manage by the program.
[Vss]
DataRoot=$\GameData
DataBase=\\Serveur\VSS5\srcsafe.ini 
UserName=guest
FileList=FileList-Config00

# The [FileList-Config##] section
.Here is an example of  an obtaining file list configuration. For each configuration there’s a name, the number of files or projects to obtain and description of each file / project to obtain. If name is not prefixed, it’s a project, if name is prefixed by -R it’s also a project but content is obtain recursively. Finnaly if prefixe is -F the name indicate a file that is simply obtain.
There can be as many section [FileList-Config##] as you define File list configuration with Vss Data Manager. These section are automatically written.
[FileList-Config00]
Name=MyConfig
Number=3
File0000=-R $\GameData\World\Levels\_Common\Families
File0001= $\GameData\World\Levels\Cavedoc
File0002= -F $\GameData\Options\Camera.ipt

# The [obtaining] section contains date and time of your last obtaining. This section appear after your first obtaining. It contains also all files you have obtained.
[Obtaining]
Date= 21/07/1997 14:53
Number=1
File0000=-R $\GameData

# The [WinPref] section contains saving of window position and size and some options. All this section is optional and created or rewrite each time you quit the program to save the new configuration. Here is a sample of this section
[WinPref]
Main=( 499, 175, 919, 712)
File=( 489, 247, 899, 691)
Modif=( 384, 396, 679, 521)
Conflict=( 537,  50,1218, 450)
ObtainAfterUpdate=1
ConfirmObtainAfterUpdate=1
ForceUpdate=1
ConfirmForceUpdate=1

# $ K + Starting with Vss Data Manager
Installing Vss Data Manager
At first create a directory to put this utilities (it’s not necessary, MngData5 could be copied anywhere you want.
Copy the 4 following files in the directory you’ve created or anywhere you want
	MngData5.Exe
	MngData.ini
	MngDtBug.msg
	MngData5.hlp
You can create links to MngData5.exe file to access easily the program.
Now you must just change the .ini File to be in order with your database. As explain in topic about Ini File there is only one thing you must write in this .ini file :
[Vss]
DataRoot = <Your data root project>
Ask your administrator to know what you must write in place of <your data root project>.

Executing Vss Data Manager
With explorer go to directory were MngData5 has been installed and double click on MngData5.exe file or use any link you should have created.
A login box appear (select base, enter username and password)
A Wait box appear (wait)
The main window appear

# $ K + Login to Database
When running the MngData5 utility first thing to do is to log to Vss Database. To do this administrator must have created an account for you. Ask him if this is not the case or if you don’t know username and password of your account.

To log to the Vss Database use the first window that appears as following

{bmc Dlg_Log.bmp}

In the picture user name and Vss base name are already set. First time you run program the boxes are empty, type your user name in first white box, password in the second one and database name in the third one. To set database name you can use {bmc Bt_VssBa.bmp} button which offer to browse for the scrsafe.ini file that correspond to the right Vss database.
Next time you run program there’s only the password box that will be empty.
When information are set click OK to log to Vss Database and go forward.

# When login is ok, program must initialize some data from Vss database. This operation can take some times if server is used by several people. During all time of this initialization the following window is deiplayed

{bmc Dlg_Wait.bmp}

the line under the picture indicate which vss project is being analyzed.

# $ K + How to obtain data
Here is the procedure to obtain data

Running obtaining

{bmc Bt_One.bmp} Check local path (where data files will be copied)
	It is displayed in main window
	You can change it by using {bmc Bt_Brows.bmp} button in main window 
and using Local path dialog
{bmc Bt_Two.bmp} Define Vss projects and files you want to obtain
	By default all files and project will be obtained
	To set list use {bmc Bt_More.bmp} button in main window
	and File list configuration dialog box
{bmc Bt_Three.bmp} Click on button {bmc Bt_Obtai.bmp}

The obtaining procedure is launch, look the result window and progress bar to see if there’s a problem. Data obtaining could be a long procedure if there’s many data files to obtain.

Obtaining algorithm summary
{bml Bt_Arrow.bmp} watch if someone is updating (stop if so)
{bml Bt_Arrow.bmp} watch if there still modification in file (if so notify user that obtaining will delete these modification)
{bml Bt_Arrow.bmp} synchronize time with time server
{bml Bt_Arrow.bmp} notify that someone is obtaining
{bml Bt_Arrow.bmp} obtain all wanted data
{bml Bt_Arrow.bmp} notify that obtaining is terminate
{bml Bt_Arrow.bmp} delete modification file
{bml Bt_Arrow.bmp} set obtaining time and files in MngData.ini file

Obtaining problem
Obtaining could be stopped if 
{bml Bt_Empty.bmp} time server doesn’t respond. (see administrator)
{bml Bt_Empty.bmp} someone is updating (wait the end of updating)
{bml Bt_Empty.bmp} you don’t want to delete modification that are still in modification file
{bml Bt_Empty.bmp} vss database could not be reached (see administrator)
Obtaining could be a very long operation so when you work on a little part of data obtain only the project you are working on. It is better to obtain data when no one else obtain data, because obtaining time when two person obtain at same time is increase by 5 or more.

# $ K + How to update data

Here is the procedure to update data

 What is needed

you must have obtain data at least one time
you must have modified some data file with 3DOS editors
Obtaining time and number of modification appear in window interface.

Running updating

Use {bmc Bt_Updat.bmp} button to access Update menu 
{bmc Mnu_Upda.bmp} which allow you 
to set some update options by using {bmc Mnu_UpOp.bmp} menu entry 
or to launch update operation by using {bmc Mnu_UpUp.bmp} menu entry

Updating result appear in result window and progress bar indicates you process progression.
It is recommended to re-obtain data after an updating operation

Updating algorithm summary

{bml Bt_Arrow.bmp} watch if someone is updating or obtaining ( stop if so )
{bml Bt_Arrow.bmp} synchronize time with time server
{bml Bt_Arrow.bmp} notify that someone is updating
{bml Bt_Arrow.bmp} update all modified section
{bml Bt_Arrow.bmp} notify that updating is terminate
{bml Bt_Arrow.bmp} rewrite modification file with modification that generate conflict or error

Updating problem

Updating could be stop if
{bml Bt_Empty.bmp} time server doesn’t respond (see administrator)
{bml Bt_Empty.bmp} someone is updating or obtaining (wait the end of all operation)
Some modification could not be done
this can append when another designer update a section after your last obtaining. This is a case of conflict because you two have modified section in same time and program can’t generally not merge modification. To avoid these delete modification by re-obtaining data, do your modification again under 3DOS editor and update data. There’s no simple solution to conflict problem.

# Update option

The following window allow you to set some update options

{bmc Dlg_UpOp.bmp}

First group of options allow you (if checked) to force updating (with or without confirmation) if a conflict between two files or sections happens.
Second group of options allow you to obtain automatically after an updating operation.

# Update conflict

A conflict appear when you are updating data that was still updated by someone else since last time you have obtained. By default all conflict are considered as error. But you can change options (see behind) to force updating in case of conflict. If you have set this option with the confirmation set, each time a conflict happens the following dialog box appears

{bmc Dlg_conf.bmp}

You also can see the two version of the section and the name of the guy that makes the last modification. 
You must then choose :
{bmc Bt_Arrow.bmp} if you want to keep vss file, use {bmc Bt_Keep.bmp} button
{bmc Bt_Arrow.bmp} if you want to erase last modification on vss database with you own modification. Use {bmc Bt_OverW.bmp}

# $ K + Interface
Here is a description of  utility interface. These interface display the program parameters and some buttons to change parameters or run operation.

Here is a general survey of interface window, show below for a description of each part.

{bmc Dlg_Intf.bmp}

This interface is decomposed in three part,
the first one is composed by text box with informations and parameters
the second one is the result window (the black window)
the third is the command buttons.

# Informations and parameters

{bmc Itf_LaOb.bmp}
this line indicate the date and time you’ve obtained data for the last time.

{bmc Itf_LoPa.bmp}
This line display local path. This is the directory that correspond to the Vss path. When obtaining all files or sub project found in Vss path will be obtained in the define local path. You can change it by using the {bmc Bt_Brows.bmp} button and the local path dialog box

{bmc Itf_VssP.bmp}
You’ll find in this line two information, first one is the Vss project used as root project for data. This information can’t be edited, you must define it when installing the utilities. See description of ini file or Starting with Vss Data Manager topic for more information.
The second information between bracket is the current file list configuration name use {bmc Bt_More.bmp} button to change or create new configuration.

{bmc Itf_InUp.bmp}
This line display name of vss file used as a semaphore to indicate that someone update, i.e. when this file is checked out that means that someone is being updating and nobody else can obtain or update while this updating isn’t finished. This file cannot be changed You can look if someone is being updating by using {bmc Bt_Look.bmp} button

{bmc Itf_InOb.bmp}
This line display name of vss file used as a semaphore to indicate that someone obtain, i.e. when this file is checked out that means that someone is being obtaining data and nobody else update while this obtaining isn’t finished. This file cannot be changed. You can look if someone is being obtaining by using {bmc Bt_Look.bmp} button

{bmc Itf_Modi.bmp}
This two lines indicate the file that contains modification you’ve done since last obtaining with the 3DOS editors ; and number of modifications. You can delete all modifications by using the {bmc Bt_Clear.bmp} button and you can display modification list by using {bmc Bt_View.bmp} button

# Result window

This window (with black background) display result of any updating or obtaining operation. Each line indicate a step in operation. The blue lines indicate what is being done, green line indicate a good result for an operation and red lines indicate errors.

# Command buttons

{bmc Bt_Refre.bmp}
Use this button to refresh information dumping. You can use it for example if you have edited some data without closing MngData5 utility.

{bmc BT_Obtai.bmp}
Use this button to launch an obtaining operation. See How to obtain data topic

{bmc BT_Updat.bmp}
Use this button to display the Update menu that allow you to set some update options or to launch an updating operation. See How To Update data topic

{bmc Bt_Quit.bmp}
To quit Vss data manager.

{bmc Bt_Help.bmp}
To access about dialog box or this help file

# $ K + Changing local path
Use the following dialog box to choose directory where data will be obtained. The directory you choose is the root directory of all data, that means that all data files are in this directory or in sub directory of this directory. It correspond to the Vss dataproject. For example if vss data project is $\acp\Game\Gamedata and local path is c:\ed\Data the file $\acp\game\gamedata\anims\ed\marche.a3d will be obtained and correspond to the file c:\ed\data\anims\ed\marche.a3d

{bmc Dlg_LDir.bmp}

To change local data path choose the directory you want to be your local path and click ok. You cannot create directory with this dialog box, so use explorer or what you want to do that. Click cancel button if you want to avoid this operation.

# $ K + Choosing obtained files list
When you run obtaining operation you obtain recursively all data files that are in the Vss project. This is the default behavior. With the following interface you can specify what sub project you want to obtain for example if you work on level 2 it gains time to obtain only general data file and level 2 file and to avoid all the other level data files.

{bmc Dlg_VssF.bmp}

Step to create a new file list configuration

Choose all files / project you want to obtain
Choose a name for your configuration
Click on {bmc Bt_Ok.bmp} button

Step to modify a file list configuration

Change file you want to obtain
Click on {bmc Bt_Ok.bmp} button

Choosing files/projects to obtain

The tree display all files and projects that are on Vss database. You know if a project or file is obtained according to the color of the icon that prefix the file or project name. The legend panel summarize the signification of icons.
A project could be prefixed by the following icon
{bml Ico_PrNO.bmp} the project will not be obtained
{bml Ico_PrOb.bmp} the project will be obtained (all files of the project are obtained but not the sub projects)
{bml Ico_PrOR.bmp} the project will be obtain recursively ( all files and recursively all sub projects are obtained)
{bml Ico_PrOC.bmp} the project will be obtain because it’s a sub project of a project that will be obtained recursively
A file could be prefixed by the following icon
{bml Ico_FiNO.bmp} the file will not be obtained
{bml Ico_FiOb.bmp} the file will be obtained
{bml Ico_FiOP.bmp} the file will be obtaind because it owns a project that will be obtained
{bml Ico_FIOC.bmp} the file will be obtained because it owns a project that will be obtained recursively

There is several manner to change obtain state of a file/project. 
{bmr Bt_ObSta.bmp}-1- You can select it and use the two bottom left buttons. The text display on these two buttons change following the state of selected item in tree. In the example, the selected item is a project that is not obtain, so you can choose to obtain or to recursively obtain it.
-2- Right clicking on a project or file in the tree makes appear a contextual menu that allow you to change state of the clicked project or file.
-3- You can also use the small button that are on legend panel to change state of currently selected project or file.

There is also two buttons that change all tree obtain state.
{bmc Bt_ObAll.bmp} set all file to be obtained
{bmc Bt_ObNot.bmp} Just clear the tree by setting all project and file to not obtain state.

Choose a name for your configuration

For this use the {bmc Bt_Confi.bmp} button that makes appear the following dialog box
{bmc Dlg_fcfg.bmp}

You create a new configuration by editing a new configuration name in edit box and clicking the {bmc Bt_Ok.bmp} button.

You can also choose an existing configuration. Doing this will reinitialize vss tree with obtained file define in chosen configuration.

# $ K + Viewing modification list
This dialog box list all section that have been modified since your last obtaining. Each line in the list box represent one of these modified section. Each line is made like this
	<filename>[^<sectionid>[:<sectionname>]] (modification type)

were modification type can be
(modified)	the file/section is both in vss data and local data
(added)	the file/section is only in your local data
(deleted)	the file/section is was deleted from your local data

{bmc Dlg_ModL.bmp}

# $ K + Frequently Asked Questions
see also Questions And Requests, Reported Bugs
You could find here the Frequently Asked Questions about Automatic Vss Data Manager.
If you have question contact me

# $ K + Questions And Request
see also Frequently Asked Questions, , Reported Bugs
You could find here last Questions and request. 
If you have question or request contact me

# $ K + Reported bugs
see also Frequently Asked Questions, Questions And Requests
If you find a or several bugs contact me

{bmc ico_abug.bmp} Can’t update because an edit window appear
This happens when you’ve change editor for displaying file in VSS interface. You must delete this option in VSS interface. To do that open VSS, choose tools menu and then options sub menu. In General section delete the editor name written in editor for displaying file

{bmc ico_abug.bmp} Under Windows95 Help button raised an error
It’s another Windows95 mystery. The first time you click on help button an error appear before popup menu is displayed. Close error window, select Help in popup menu another error appear, close again error window, this time program is automatically stopped. Re-launch it and try Help button, it works ... ! ! ! ? ? ?

POPUP - POPUP - POPUP - POPUP - POPUP - POPUP - POPUP - POPUP - POPUP - POPUP  POPUP - POPUP - POPUP - POPUP - POPUP - POPUP - POPUP - POPUP - POPUP - POPUP 

# Local path
In this box is displayed the name of data root directory.
See also requirements, ini file

# Browse button
Click this button to change local root data directory
See also changing local directory, requirements, ini file

# Vss data project
In this box is displayed the name of vss project that contains all data files.
See also requirements, ini file

# More button
Clicking this button allow you to define a list of project you want to obtain. Doing that allow you to obtain only data you work on.
See also Choosing obtaining project, ini file

# Vss program
In this box is displayed the name program used to acess database
See also requirements, ini file

# InUpdate semaphore file
In this box is displayed the name of file used as a semaphore file for updating state.
See also requirements, ini file

# Look Update button
Click this button to see if someone is being updating data.

# InObtain semaphore file
In this box is displayed the name of file used as a semaphore file for obtaining state.
See also requirements, ini file

# Look Obtain button
Click this button to see list of users that are being obtaining data.

# Modification file name
In this box is displayed the name of file that contains list of modification.
See also ini file

# Modification number
In this box is displayed the number of modification found in modification file. You can update only when there’s at least one modification

# View modification button
Click this button to view modification list
See also Viewing list of modification

# Last obtaining time
In this box is displayed the date and time of your last obtaining. If no obtaining has been done the word none appear in place of date/time
See also How to obtain data, ini file

# Result window
This window display some information about obtaining or updating operation. After each operation look at this window content to be sure that’s no error happens.
See also How to obtain data, How to update data

# Refresh button
Click this button to refresh information. If something isn’t good in data you can make change in ini file and then use this button to refresh display.

# Obtain button
Click this button to obtain data

# Update button
Click this button to update data

# Quit button
To quit program

# Help button
Use this button to access this help file or to display about box

# {bmc vlhullier.bmp}
Vincent Lhullier
{bmc Ico_Lett.bmp}	vlhullier@annecy.ubisoft.fr
{bmc Ico_Tel.bmp}	04.50.52.98.84

# $ Mail Erreur
The file ‘MngDtBug.msg’ not found 
in help file directory