LN:DI MSS Tools
---------------

Disclaimer
==========

This utility program is NOT a Lotus product nor is it supported
as such.  Extreme care should be taken to backup all data prior
to running this program.

Overview
========

This utility program provides various capabilities for analyzing
and/or manipulating LN:DI objects.  This file contains
descriptions of each option and instructions for using it.

This utility can do the following:

- Convert embedded objects to objects stored in a MSS and vice
versa

- Convert DDE objects to OLE objects

- Import LN:DI files from an MSS into new Notes documents

- Scan a Notes database for MSS objects and verify their validity

- Change the storage profile of all objects in a particular
storage profile


Installing the LINKSCAN utility
===============================

This is a Windows 3.1 program and consist of the following files:

	LINKSCAN.EXE
	OLEEMBD.CD
	OLEMSS.CD
	EMBDICON.CD
	LINKICON.CD

These files must be copied to a directory where one of the
following products is installed:

- LN:DI Professional 2.6
- Lotus Image Viewer 1.0
- LN:DI Client 2.0

In addition, the Windows workstation must have access to the
Notes database containing the LN:DI objects to be analyzed and
access to the MSS where objects are stored, if applicable.

This utility can run on Windows 95 as long as the Notes R3
client software for Windows is installed.


Running the Program
===================

1.  From the Program Manager, choose File - Run

2.  Type drive:\path\linkscan.exe and press Enter

    where drive:\path is the drive and directory where
    LINKSCAN.EXE located.


Moving Embedded Objects to the MSS (or vice versa)
==================================================

This option moves LN:DI objects embedded in a Notes database to
the MSS and vice versa.

User Access must be enabled on the MSS in order to use this
option.

To use this option, choose File - Convert Storage...

Complete the dialog and press Start.

Notes DB Server - Select the Notes server where the database
containing the LN:DI objects resides.

Notes DB Name - Enter the name of the Notes database

Selection Formula - By default, LINKSCAN will look for LN:DI
objects in every document in the database.  If you want to
restrict the documents, you can enter any valid Notes selection
formula in this field.  

View Title - If the Selection Formula contains @ViewTitle, enter
the name of the view to search in this field.  This capability
is not supported in this release.

Conversion Direction - Select Embedded Documents => MSS to move
objects to the MSS.  You must then select the MSS storage
profile for the objects.  Select MSS => Embedded Documents to
move the objects from the MSS to the Notes database.

Note:  When moving objects from the MSS to Embedded documents,
the image files are not deleted from the MSS.

Important:  This option will modify the specified Notes
database.  Be sure to backup the database before running this
option.	


Converting DDE object to OLE objects
====================================

This option converts DDE objects to OLE objects.  This option
works equally with objects embedded in the Notes database and
with objects stored in the MSS.  Since LN:DI Professional 2.6
and the Lotus Image Viewer to not support DDE objects, this
option can be used to convert existing DDE objects to OLE so
they can be accessed with either LN:DI Professional 2.6 or the
Lotus Image Viewer.

This option does not require access to the MSS even if the DDE
objects are stored in the MSS.

To use this option, select File - Convert DDE <=> OLE...

Complete the dialog and press Start.

Notes DB Server - Select the Notes server where the database
containing the LN:DI objects resides.

Notes DB Name - Enter the name of the Notes database

Selection Formula - By default, LINKSCAN will look for LN:DI
objects in every document in the database.  If you want to
restrict the documents, you can enter any valid Notes selection
formula in this field.  

View Title - If the Selection Formula contains @ViewTitle, enter
the name of the view to search in this field.  This capability
is not supported in this release.

Conversion Direction - Select DDE => OLE.  Converting OLE
objects to DDE is not recommended.

Important:  This option will modify the specified Notes
database.  Be sure to backup the database before running this
option.	


Importing MSS Image Files
=========================

This option can be used to import image files that are stored
into the MSS into new Notes documents.  This would typically
only be done if the MSS database were lost or no longer usable
or, if an old backup copy of the MSS database needs to be
restored.  A new Notes document will be created for each image
file and will contain the LN:DI object, file name and file
creation date.

User Access must be enabled on the MSS in order to use this
option.

Before using this option you must create a text file that
contains a list of all files to be imported.

To use this option, choose File - Import LN:DI Files...

Complete the dialog and press OK.

Input File - Enter the name of the text file that contains a
list of files to be imported.  If this file is not in the
current directory, include the full path.

Path to Image files - Enter the fully qualified directory where
the image files to be imported are located.

Notes DB Server - Select the Notes server where the target
database resides.

Notes DB Name - Enter the name of the target Notes database. 
This database must already exist.

Form Name - Enter the name of the form in the target database to
use to create the Notes documents.

LN:DI Object Field - Enter the name of the Notes field where the
LN:DI object will be placed.  This should be a rich text field
that has been defined on the form specified in the previous
field.

File Date Field - (Optional)  Enter the name of the Notes field
to store the date the image file was created.  This should be a
time field that has been define on the form specified in the
previous field.

Select Store in Notes to store the LN:DI object embedded in the
Notes database.  Select Store in MSS if the new LN:DI object
should be stored in the MSS.  If the object is stored in the MSS
you must specify a Storage Profile for the new objects.


Checking the Validity of MSS Links
==================================

This option can be used to verify that each LN:DI MSS object
referenced in a database is valid.  The utility can add a field
to the Notes document if the object is not valid which can then
be used in a view to determine which documents contain bad MSS
links.

This option can also be used to list the MSS objects referenced
in a particular Notes database.

User Access must be enabled on the MSS in order to use this
option.

To use this option, choose File - Scan MSS Links...

Complete the dialog and press Start.

Notes DB Server - Select the Notes server where the database
containing the LN:DI objects resides.

Notes DB Name - Enter the name of the Notes database

Selection Formula - By default, LINKSCAN will look for LN:DI
objects in every document in the database.  If you want to
restrict the documents, you can enter any valid Notes selection
formula in this field.  

Action - Select one of the following choices

	Just scan object handles - This option will simply list the MSS
	object handles referenced in the specified database and will not
	verify that the object exists in the MSS database.

	Verify object exists in MSS database - The MSS will be queried
	to determine if the object handle is valid.  If you choose this
	option you must choose one of the following actions which
	indicate what to do to the Notes document if the object handle
	is bad.

		Tag bad objects - A field called "Bad_Link" will be added to the
		document with a value of 1.

		Do not tag bad objects - The document will not be modified.

		Clear bad object tags - Select this option after any bad links
		have been corrected to re-verify the link and remove the
		Bad_Link field from the document.

Output - Select the logging option

	Do not log object handles - No logging

	Log all found object handles - Every object handle will be
	logged regardless of whether it is good or bad

	Log only bad object handles - Only object handles that do not
	exist in the MSS database will be logged.

	Log File - Enter the name of the log file

	Notes Fields - Not supported in this release.

Important:  If you choose to tag documents with bad object links, this 
option will modify the specified Notes database.  Be sure to backup the 
database before running this option.	


Changing the Storage Profile
============================

This option allows you to change the storage profile for all
objects in a specific storage profile.  Unlike the other options
in this utility, this option does not scan a Notes database
looking for MSS object handles.  Instead, the utility reads an
exported copy of the MSS database that you create.

Note:  This option is not very selective.  All objects in the
selected storage profile will be changed to the new storage
profile.

All objects in the original storage profile will be moved to the
new storage profile.  While the LINKSCAN utility will do this
very quickly, it will take some time before the MSS has actually
moved the objects to the correct volumes.

LINKSCAN simply registers a request to change the storage
profile in the MSS.  If the volume that a particular object is
currently located on is also in the new storage profile, then
the object will not be moved.  If the current volume is not in
the new storage profile, then the MSS will stage the object
(copy it to the staging directory).  The next time stage
cleaning is run, the object will be moved to a volume in the new
storage profile.

For this reason, make sure that there is plenty of room in the
staging directory.  You may also want to run stage cleaning
frequently after the utility has completed so that objects will
continuously be moved out of the staging area while new ones are
being staged.

User access must be enabled on the MSS to use this option.

The input file is generated on the MSS server.  To create this
file:

- Change to the MSS directory
- Type dbexp mss and press Enter
- Copy the OBJECT.TXT file to a directory where it can be
  accessed by the LINKSCAN utility.

To use this option, choose File - Change MSS Storage Profile...

Enter the original storage profile and the new storage profile
and press OK.

