Esko Logo Back to Esko Support

Page History

Choose your language for a machine translation:

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated by Esko.Confluence integration from workflowwiki


 

Description

In WebCenter 16, it is possible to split off Document thumbnails and Document version perspectives into separate folder structures, to address the issue of the FileStore becoming too large, making it harder to backup and maintain. With this change in place, old Document folders will no longer need to be frequently scanned as the only changes will be files cleaned out by the Clean-up tool. The configuration of the different FileStore paths is stored within appconfig.xml. A mechanism is in place to also retain these values during a WebCenter upgrade. In case the same FileStore UNC path is maintained, the Installer reloads previous values when the Application Server is re-installed.

Warning

This procedure involves some risk and should only be performed by trained professionals.


Info
titleVersion support

This mechanism only fully applies to WebCenter 16.0 up to WebCenter 21.03.

Since WebCenter 21.07 WebCenter has a new UI-based support for specifying Storage Configurations - which makes the appconfig.xml-specified locations of the individual parts of the FileStore split obsolete. This applies to all "asset type" files except User Avatar, Icons and View files - those still follow the appconfig.xml specified means of declaring the storage location for.

Since WebCenter 22.03 also User Avatar and Icons are configured via the Storage Configurations feature.

View files storage is planned to be added to Storage Configurations in a future release

Procedure

Following FileStore paths can be set in appconfig.xml since WebCenter 16.0:

  • viewer_data_dir - The folder used to store 2D Viewer data files for individual viewable WebCenter Documents. This node is present in the default version of appconfig.xml and only gets updated during the installation with a custom value – or is kept to the default value if no custom value was set.
  • document_thumbnails_dir - The folder used to store thumbnail files for Documents that support having custom thumbnails generated per Document WebCenter object. Its presence in appconfig.xml is optional. If it is missing, Document Thumbnails are stored in the same folder as the main Document files (as set in Document_dir node).
  • document_perspectives_dir - The folder used to store various default and custom Document Perspective files for individual Documents (set of supported Perspective types varies based on the Document Type). Its presence in appconfig.xml is optional. If it is missing, Document Perspectives are stored in the same folder as the main Document files (as set in Document_dir node).
Tip

Follow the steps described below to safely split your current FileStore onto different shares.

How to: Move Document thumbnails to a separate share

Info

This is an optional step. By default the Document thumbnails will be stored as in previous versions.

  1. Open \\Artios\WebCenter\Config\appconfig.xml in a text editor such as Notepad++.
  2. Add a new element <document_thumbnails_dir>, containing the new UNC path under the main Filestore root. Example: 

    Code Block
    languagexml
    <document_thumbnails_dir value=”\\MyFileServer\\Filestore\\docthumbnails”></document_thumbnails_dir>


    Note

    Only a single UNC path is supported. It is important that the path is not moved to a different share as this will break the automated migration. Avoid changing other fields in this XML file as such manual updates in general are considered unsupported.


  3. Make sure to disable Search crawling upon server startup.
  4. Restart the Application Server. 

    Info

    Upon starting, the Document thumbnails will be moved to a folder structure under the new root. This will take some time if there are many Documents in the system, but since all Document operations are moved within the same share, it should not take hours.


  5. If needed, for example, to move Document thumbnails to a faster SSD drive for better performance, it is possible to now copy the thumbnails folder to a different share.
    1. Copy the new docthumbnails folder to the alternate share. 

      Note

      This can be a time consuming operation so for production it should be scheduled (as a copy with later delete of the source) to run at low usage hours to not interfere with server performance. We have good experience from using RoboCopy for this kind of large scale copy operations. It should be ensured that the correct access rights are set up on the new share (same effective rights as current folder).


    2. Edit \\Artios\WebCenter\Config\appconfig.xml to reconfigure WebCenter to use the new share. The element <document_thumbnails_dir> contains the new UNC path under the alternate Filestore root. Example (same server, but different share):

      Code Block
      languagexml
      <document_thumbnails_dir value=”\\MyFileServer\\Filestore2\\docthumbnails”></document_thumbnails_dir>


  6. Restart the Application Server. After a restart, WebCenter will use the new Document thumbnails folder and the old one can be removed once good working is ensured.

How to: Move Document perspectives to a separate share

Info

This is an optional step. By default the Document perspectives will be stored as in previous versions.

  1. Open \\Artios\WebCenter\Config\appconfig.xml in a text editor such as Notepad++.
  2. Add a new element <document_perspectives_dir>, containing the new UNC path under the main Filestore root. Example: 

    Code Block
    languagexml
    <document_perspectives_dir value=”\\MyFileServer\\Filestore\\perspectives” ></document_perspectives_dir>


    Note

    Only a single UNC path is supported. It is important that the path is not moved to a different share as this will break the automated migration. Avoid changing other fields in this XML file as such manual updates in general are considered unsupported.


  3. Make sure to disable Search crawling upon server startup.
  4. Restart the Application Server. 

    Info

    Upon starting, the Document perspectives will be moved to a folder structure under the new root. This will take some time if there are many Documents in the system, but since all Document operations are moved within the same share, it should not take hours.


  5. If needed, for example, to move Document perspectives to a faster SSD drive for better performance, it is possible to now copy the perspectives folder to a different share.
    1. Copy the new perspectives folder to the alternate share. 

      Note

      This can be a time consuming operation so for production it should be scheduled (as a copy with later delete of the source) to run at low usage hours to not interfere with server performance. We have good experience from using RoboCopy for this kind of large scale copy operations. It should be ensured that the correct access rights are set up on the new share (same effective rights as current folder).


    2. Edit \\Artios\WebCenter\Config\appconfig.xml to reconfigure WebCenter to use the new share. The element <document_perspectives_dir> contains the new UNC path under the alternate Filestore root. Example (same server, but different share):

      Code Block
      languagexml
      <document_perspectives_dir value=”\\MySecondFileServer\Filestore2\perspectives”></document_perspectives_dir>


  6. Restart the Application Server. After a restart, WebCenter will use the new Document perspectives folder and the old one can be removed once good working is ensured.


Article information
Applies to

from WebCenter 16.0 to WebCenter 21.03

Created29-Jun-16
Last revised
 
 17-Jan-22
AuthorDEKE
Case Number
 


Panel
titleContents

Table of Contents
classinline-toc