User Tools

Site Tools


advanced:digital-clay_files

Digital-Clay Files

A summary of the files installed by and used by Digital-Clay. Note that this article lists the default locations and filenames although some may have been customized.

Program Files

The program itself is installed by default under C:\Program Files\Digital-Clay\. This folder may contain the following sub-folders:

  • Clients. Contains ClayStation, ClayStudio and ClayIntegrator.
  • Central. Optionally contains ClayCentral if Central was installed. Also contains the Service.exe tool which is used when running ClayCentral and WebClay as a service.
  • Outlook (optional). Contains the add-on for Outlook if ClayStation for Outlook is installed.
  • Web (optional). Contains the Web ClayStation CGI program, support web files, and an optional Apache Web Server if Web ClayStation is installed.
  • Help & Lang: Common support files for all Digital-Clay programs.
  • Updates: Miscellaneous files used by the auto-updater. This does not contain the updates themselves.


Notes:

  • None of these files and folders should ever be deleted.
  • All of these files are automatically removed when uninstalling the program.
  • No data or settings are contained in this folder.
  • Additional support files (dlls, ocxs and update components) are also installed in the Windows System folder.


Data

All data and log files are stored under C:\DigitalClay\ as follows:

  • Log files containing error and debugging information within a sub-folder per application or client (ClayCentral, ClayStudio, etc).
  • Templates folder (clients only): This is the default location for document templates for Digital-Clay clients. By default there is a sub-folder per language in case companies use the same reports in multiple languages.
  • Attachments (ClayCentral only). Sub-folders and sub-sub-folders are created according to tables and item IDs respectively. Attachment filenames are usually identical to the original files unless duplicates are found. Documents stored in the Document Repository are also stored here in the sub-folder named '0'.
  • Images (9.2.x+). This folder contains all built-in images used for customizing tables, toolbar items, buttons, etc, as well as custom images, and the Company image configured in ClayCentral settings.
  • Users (9.2.x+): Profiles are stored here, both private and public. Shared profile objects are stored in the Public folder (for both ClayCentral and clients), and private objects are stored in a sub-folder per User ID (clients only unless the user saves his/her profile using 'Save my Profile'). Each sub-folder contains several sub-sub-folders, one for each type of profile object.
  • Cache: This folder is used for two purposes: By ClayCentral for caching resized Picture fields (thumbnails). And by clients for resized icons and images used throughout the interface.
  • Addons (clients only): Custom HTML addons used in Custom Layouts are stored here. See ClayIntegrator.
  • The ClayStation folder stores:
    • ClayStationMain.mdb which contains user information.
    • ClayStation-XXXXXX.mdb files: one offline database per user that has logged in on this machine.
  • The ClayOutlook folder (ClayStation for Outlook only) stores:
    • ClayOutlook.mdb which contains user information and miscellaneous Outlook data (one table per type of data and Outlook folder). Since Outlook folders are stored in separate tables by their folder ID, this single mdb file can serve multiple Windows users, PST files and Outlook profiles.
    • ClayStation-XXXXXX.mdb files: one offline database per user that has logged in on this machine.
  • The ClayCGI folder stores:
    • ClayCGIStatsXXXX-XX.csv files: These contain basic usage statistics for the Web ClayStation for administration purposes. See the article for details.
  • The Data Injection folder (ClayCentral only) contains:
    • The Succeeded folder with a file for every successful injection.
    • The Failed folder with a file for every failed injection which also contains the error message.
    • The Pending folder if file injection is used. All .XML files placed here are read and deleted.
  • Roles: For ClayCentral only. This folder is used for Role Deployment and files are copied here manually.


Obsolete files/folders for Clay 9.1.x and below:

  • If a company logo is set in ClayCentral settings, both the Clients (ClientCompanyLogo) and Central store a copy of the logo in this folder for document generation.
  • Profiles & Roles folders: For ClayCentral only. When profiles are saved or sent via ClayCentral, a sub-folder per user is created here which contains only the parts of the profile that were saved. See Profile Management


Notes:

  • Some of these files and folders may not exist until the appropriate client or ClayCentral is run.
  • Important files that should be backed up: ClayCentral (if using mdb only), Attachments, Users, Templates, Images, Addons. Everything else isn't critical.
  • None of the files in this folder are removed or uninstalled when Digital-Clay is uninstalled or upgraded. Thus all data is maintained during upgrades and available even after Clay is uninstalled.
  • If huge or many attachments are added, the Attachments folder may need to be relocated to a bigger hard drive. To relocate this folder, simply set the location in ClayCentral settings and manually move the folder.
  • If attachments are deleted manually from the folder structure, they will still appear in Attachment lists but will return a “File not found” message.
  • The whole C:\DigitalClay\ folder structure is automatically recreated as needed by Digital-Clay. Files may be deleted with the following caveats:
    • Obviously all the important files listed above should never be deleted if their data is still needed as they are the originals.
    • All offline databases can be deleted and they will be resynchronized next time the user logs in, but only active records will be retrieved by default.
    • ClayOutlook.mdb should not be deleted: ClayStation for Outlook attempts to rebuild this database as best it can based on current data in Outlook, but some data such as links to recurring appointments may be lost.


Saved Files

All Digital-Clay specific metadata files like lists (.sls files), analysis files (.sgr), dashboards (.sds), import session files, etc. are stored by default under the user's My Documents\DigitalClay\ folder. Note that this excludes document templates.

All other files like exports, pictures, saved attachments, etc. by default go to the user's My Documents folder.

advanced/digital-clay_files.txt · Last modified: 2017/10/26 08:15 by Zev Toledano

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki