Viewpoint Archive and Restore#

This document describes the process of archiving a Viewpoint Project and the process of restoring an archived Viewpoint Project. In this context, “archive” means to completely take a project offline and be placed into a cold storage (for example, on a tape). If your goal is to migrate a live Viewpoint Project from one live environment to another, refer the Viewpoint Project Migration Guide.

To use this guide, it is assumed that you are familiar with the general IT terminology and are familiar with MS SQL Management Studio.

Ensure you have access to the Viewpoint PMC and Review applications. The user should know how to log into these applications and perform basic actions in these applications.

Viewpoint Project Assets#

Limitations of the Process#

The following items are outside the scope of the archive / restore process. If you archive a project and then restore it back to the same environment, then this information will not be lost. However, if you restore the project to a new / different environment, the information will not be retained.

• Viewpoint security entities – Companies, Users, Roles, Permissions
• User screen layouts, User preferences
• The Environment Log (LDControl.Log). This log does not contain work product logs – that information is in the Review database and will be retained by the archive / restore process
• Delivery Templates
• Import Templates
• User View Types
• File Type, File Category settings
• Customized string resources
• Customized maintenance scripts
• Worker link information (lists of workers and their settings)

Archiving a Viewpoint Project#

The user has to perform the following steps to archive a Viewpoint Project. When this process is completed, the Viewpoint Project will no longer be accessible from within the application; it needs to be restored to be accessible again.

It is assumed that you have administrative rights to all Viewpoint Assets (source and target file stores and database servers). During this process, the users will be able to access all of the other Viewpoint Projects in this environment – there is no need to kick everyone out.

Perform the following steps to archive a Viewpoint project:

1. Locate the source file store. If you have not altered the default for the project, then the file store root location can be seen in the PMC, Project tab, and “File Server” column for your project. Note this location and also note how much space will be required to archive the file store.
2. Log into the PMC MSSQL instance using MS SQL Management studio. Locate the LDControl database. Open the Project table and locate your project.
3. Copy the information in the Project table for this project to a text file for later use. You need some of this information to restore the project. Call the file “Processing Project Info.txt” once this is completed. Set the ProjectStatusCode column to three and commit your change to the record.
4. Repeat the previous step, this time on the Review server… call the file “Review Project Info.txt”
5. Eject all users from this project, if any are present. Using MS SQL Management Studio, take the Viewpoint Processing Project database and the Viewpoint Review Project database offline to ensure that no users are logged into the Viewpoint application.
6. Detach the Review and Processing databases. Move these databases to the archive file store.
7. Navigate to the root of the file store and determine how much space will be required in the archive file store.
8. Move the entire contents of the Viewpoint file store to the archive file store.
9. The Viewpoint Project is now archived.

Restoring a Viewpoint Project#

Assuming that the Viewpoint Project was archived using the method described earlier in this document, perform the following steps to restore the Viewpoint Project.

Prerequisites#

• The user needs to have administrative rights to the MS SQL Server instances and the file store.
• You must have a copy of the latest version of the Viewpoint Upgrade Tool; the same version that your current Viewpoint environment is running, so you can upgrade the Project to match the version you are running today.

Perform the following steps:

1. Locate the “Processing Project Info.txt” and “Review Project Info.txt” text files which were created during the archive process.
2. Identify the target location in the viewpoint file store for your archived file store. Note the folder name as it will be used later. Copy the files from the archive store to the Viewpoint file store. This process may take hours / days depending on data volume. You may continue with the rest of this process while the files are being copied.
3. Open MS SQL Management Studio and attach the Processing databases to the Processing MS SQL instance.
4. The following steps need to be performed for the first time on the Processing server / database and second time on the Review.
   1. Locate the model database, right-click it, select Properties, click “Permissions”. Note which logins have access to the model database (take a screenshot, etc.).
   2. Close this dialog and select the newly attached database and apply the same user permissions to the newly attached database – users of Viewpoint will need to be given CONNECT rights and be assigned the VP_USER role. To do this locate the Security | Logins node in MSSQL Management Studio… for each login you wish to grant rights to right-click the login, select “Properties”, click “User Mapping”. Locate the database, checkmark the database (this establishes CONNECT rights) and checkmark the VP_USER role in the bottom grid. Click OK to commit.
   3. Locate the LDControl database and open the Project table. If you are restoring a project which was previously on this instance then this project should still have an entry in the Project table. If this is the case then simply change the ProjectStatusCode value to 1. Otherwise, create a new record, using the information in the appropriate “Project Info” file (created during the archive process).
   4. Note the value in the “*RootPath” columns (you will be using this value later). Change the “*RootPath” values to point to the new root path values for the newly restored files. Note what you changed these values from / to.
   5. At the end of this document are two queries – one is to be run on Processing, one is to be run on Review. These queries will point the file store from where it used to be to where it is now. If you are sure that you have restored the files to exactly the same location that they were archived from you can skip the scripts. Otherwise, run the appropriate script – you will need to change the @OldValue and @NewValue parameters from the old file store root path to the new file store root path. The scripts are to be run in the respective project databases (not LDControl).
5. At this point, you have performed all of the previous sections actions on the Processing DB and the Review DB. It is time to upgrade the project, which was likely archived when your Viewpoint environment was at an older version. Locate the Viewpoint Upgrade Tool and perform the standard steps to upgrade the databases.
6. At the start of this process, you moved the files from the archive location to their location in the Viewpoint file store. If this process has not yet completed, wait for it to complete.
7. Test the environments. To perform this, log into the PMC and select your project. You should be able to select the Project and receive no error. In the “Process” tab, locate any set of documents known to have files (native files, text files, etc.). Right-click one of these documents and use the “Browse To…” items to browse to the files of various types (native, text, TIFF, html). If you are able to see each of the files of these types, then the root folder change was successful.
8. Open the Review application. Select the project. Click the “Review” button. Select any View which is known to have Documents with file data. Select some Documents, right-click and use the “Open Files…” menu item to open the files from the file store. If you are able to see each of the files of these types, then the root folder change was successful. Using the View Manager perform a search on a set of ten or more documents, looking for a search term such as “office*” or “*doc*” – if the search returns results, then your index folders were migrated properly. If the search does not yield results then it is recommended that you re-index the entire project and update post to Review.
9. The Viewpoint Project has been restored and is ready for use.

Update Processing Paths Script#

--Update Processing Paths--

-- Set the parameter @OldPath and @NewPath before running these queries --

DECLARE @OldPath nvarchar(max)

set @OldPath = '\\OldServer\NewShare\ProjectFolder'

DECLARE @NewPath nvarchar(max)

set @NewPath = '\\NewServer\NewShare\T00001'

--Query 1--

update Media

set EFileRootPath = replace (EFileRootPath,@OldPath, @NewPath),

TextRootPath = replace (TextRootPath,@OldPath, @NewPath),

HTMLRootPath = replace (HTMLRootPath,@OldPath, @NewPath),

--PDFRootPath = replace (PDFRootPath,@OldPath, @NewPath),

--Doublecheck PDFRootPath field is nonexistent

TIFFRootPath = replace (TIFFRootPath,@OldPath, @NewPath),

--XMLRootPath = replace (XMLRootPath,@OldPath, @NewPath),

--Doublecheck XMLRootPath field is nonexistent

SlipsheetRootPath = replace (SlipsheetRootPath,@OldPath, @NewPath),

IndexRootPath = replace (IndexRootPath,@OldPath, @NewPath)

--Query 2--

update [index]

set IndexPath = replace(IndexPath,@OldPath, @NewPath)

Update Review Paths Script#

--Update Review Paths--

-- Set the parameter @OldPath and @NewPath before running this query --

DECLARE @OldPath nvarchar(max)

set @OldPath = '\\OldServer\NewShare\ProjectFolder'

DECLARE @NewPath nvarchar(max)

set @NewPath = '\\NewServer\NewShare\T00001'

update ReviewEDoc

set M_EFileRootPath = replace(M_EFileRootPath,@OldPath, @NewPath),

M_TextRootPath = replace(M_TextRootPath,@OldPath, @NewPath),

M_HTMLRootPath = replace(M_HTMLRootPath,@OldPath, @NewPath),

-- M_PDFRootPath = replace(M_PDFRootPath,@OldPath, @NewPath),

M_TIFFRootPath = replace(M_TIFFRootPath,@OldPath, @NewPath),

-- M_XMLRootPath = replace(M_XMLRootPath,@OldPath, @NewPath),

M_SlipsheetRootPath = replace(M_SlipsheetRootPath,@OldPath, @NewPath),

i_indexpath = replace(i_indexpath,@OldPath, @NewPath)

update Delivery

set FolderRootPath = replace (FolderRootPath, @OldPath, @NewPath)

update DeliveryDoc

set SystemNativePath = replace(SystemNativePath,@OldPath, @NewPath),

SystemTextPath = replace(SystemTextPath,@OldPath, @NewPath),

SystemSlipSheetPath = replace(SystemSlipSheetPath,@OldPath, @NewPath),

SystemTIFFPath = replace(SystemTIFFPath,@OldPath, @NewPath)

update ReviewEDocRedact

set RedactPath = replace (RedactPath, @OldPath, @NewPath)

update ReviewEDocRedactSection

set RedactFileName = replace (RedactFileName, @OldPath, @NewPath)