Modify Store Command

After a file store is defined, you can change the definition with the Modify Store command. This command lets you add or remove defining clauses and change the value of clause arguments.

This page discusses:

Syntax

modify store NAME [MOD_ITEM {MOD_ITEM}];
  • NAME is the name of the store you want to modify.
  • MOD_ITEM is the type of modification you want to make. You only need to specify fields to be modified.
Modify Store Clause Specifies
add location LOCATION_NAME The named location is added to the store.
plmx add location PARTNER; Declare location for plmx store from 3DSpace side
remove location LOCATION_NAME The named location is removed from the store.
description VALUE The current description, if any, is changed to the value entered.
icon FILENAME The image is changed to the new image in the field specified.
name NAME The current file store name is changed to that of the new name entered.
add fileindex NAME [thread NUMBER [prefix|any]] Generates the index for the store. If the thread keyword is not set, only one thread is processed and no parallelization is used. The maximum NUMBER of threads is 200. The default value for parallel mode is prefix.

The number of created threads cannot exceed the number of directories that are parallelizable.
filename [not]hashed The file name is either encoded (hashed) or not nothashed). Modifying a captured file store from a hashed to a nothashed file name is not allowed. Attempting to do so will result in this error:

MQL<n>mod store STORE filename nothashed; Error: #1900068: mod store failed Error: #1900618: Store modification from hashed to nothashed filename is not allowed

filter FilterClass The current filter on input and output data stream is changed.
params paramsString | file paramsFile The current parameter file or string (xml file) is changed to the new one entered.
path PATH_NAME The name of path to the file store is changed to the value entered. If you change the path of a store, the files are not accessible. When you change the path, the system assumes you are also going to move the files.
prefix 'PREFIX_NAME(,PREFIX_NAME)' The prefix is changed to the value specified. You can include a comma-separated list of prefixes.

When writing files to disk, the app use the store with the most available disk space. The prefix works with these properties in the FCS side Framework.properties file:

ematrix.fcs.prefix_usage_thresholds: defines the percent threshold over which that prefix will not be used for writing files as long as there is another prefix eligible. The value for this property can be in percentage (default is 80%), absolute value of remaining disk space (measured in mebibytes), or percentage, absolute value . For example: ematrix.fcs.prefix_usage_thresholds=80%,1000

Any prefix that exceeds the threshold is not eligible for writing. If all prefixes have exceeded the threshold, then all of the prefixes become eligible for writing.

ematrix.fcs.prefix_usage_refresh: defines the minimum delay between 2 free disk space computations on prefixes (in seconds, default = 60 seconds).
protocol PROTOCOL_NAME The protocol is changed to the value specified.
port PORT_NUMBER The port is changed to the number specified.
host HOST_NAME The host containing the file store is changed to the host named.
[un]lock The store is either locked from the user for all write activities (lock) or available (unlock).
permission OWNER_ACCESS [,GROUP_ACCESS [,WORLD_ACCESS]] File permissions are no longer supported for captured stores, and have no effect on files and folders that are managed by the FCS.
Warning: Do not directly modify or change folders and files that are managed by the FCS in any way (for example: rights, size, and so on.)
user USER The current DesignSync username is changed to the new name entered.
password PASSWORD The current DesignSync password is changed to the new one entered.
url VALUE The current URL is changed to the new one entered.
fcs FCS_URL The current FCS URL is changed to the new one entered.
hidden The hidden option is changed to specify that the object is hidden.
nothidden The hidden option is changed to specify that the object is not hidden.
property NAME [to ADMINTYPE NAME] [value STRING] The named property is modified.
add property NAME [to ADMINTYPE NAME] [value STRING] The named property is added.
remove property NAME [to ADMINTYPE NAME] [value STRING] The named property is removed.
deletetrigger DELETE_TRIGGER_IMPLEMENTATION Captured File delete behavior is modified. DELETE_TRIGGER_IMPLEMENTATION implements the com.matrixone.fcs.mcs.DeleteTrigger interface. It can be either a JPO or a regular Java class that can be found in the classpath.

The deletetrigger clause is only valid for captured stores and locations. For more information, see DeleteTrigger Clause.

replicatetrigger REPLICATE_TRIGGER_IMPLEMENTATION Captured File replication behavior is modified. REPLICATE_TRIGGER_IMPLEMENTATION implements the com.matrixone.fcs.mcs.ReplicationTrigger interface and provides alternate behavior for the replication transaction. It can be either a JPO or a regular Java class that can be found in the classpath.

The replicatetrigger clause is only valid for captured stores.

checksum [on|off] The checksum computation at checkin and the checksum integrity check at checkout is activated (on) or deactivated (off). The default is off.
checksumwarnonly [on|off] The "exception thrown upon invalid checksum detected at checkout" behavior is modified. When checksumwarnonly is turned off, and an invalid checksum is detected at checkout, the system throws an exception and the checkout fails. When checksumwarnonly is turned on, the invalid checksum is logged and the user is warned, but no exception is thrown, so the checkout succeeds.

The default is off.

Applies only when the checksum parameter is turned on.

As you can see, each modification clause is related to the clauses and arguments that define the file store. The only modifications that you cannot make to a file store definition is a change in the store type or the tablespaces used. To change the store type, you must create a new file store. Once a store type is assigned, it remains in place as long as the file store exists. When you modify a store, you first name the store and then list the modifications. For example, the following command changes the name of the Drawings store and the path:

modify store Drawings
   name "CAD Drawings"
   path ${MATRIXHOME}/CADDrawings;

When this command is executed, the name of the store changes to “CAD Drawings” and the path is changed to ${MATRIXHOME}/CADDrawings.

Multiple Directories in Hashed Captured Stores

When the MQL upgrade command is run, all existing captured and hashed stores and locations are updated to use multiple directories. Files checked into any store from that point on use the multiple-directory algorithm for file storage.

You can disable the setting if required, with one of the following commands:

mod store STORE_NAME [!|not]multipledirectories]; 
mod location LOCATION_NAME [!|not]multipledirectories];

Hashed stores/locations have only one possible setting:

  • multipledirectories generates 16.3 format hashed filenames in a 2-level subdirectory structure.

The notmultipledirectories setting is not supported.