MQL Commands for Compressed Synchronization

You can use the set system fcssettings zipsync command to enable or disable FCS compressed synchronization.

To enable FCS compressed synchronization, use the command:

set system fcssettings zipsync on;

To disable FCS compressed synchronization, use the command:

set system fcssettings zipsync off;

The table below summarizes MQL compressed synchronization commands for the inter-site case:

sync store

sync buslist

sync bus

sync bus with zip

zipsync on

cond zip

cond zip

cond zip

force zip

zipsync off

no zip

no zip

no zip

force zip

• cond zip means that the synchronization stream depends on the synchronized file extension.
• force zip means that the synchronization stream is always compressed.
• no zip means that the synchronization stream is not compressed.

The table below summarizes MQL compressed synchronization commands for the intra-site case:

sync store

sync buslist

sync bus

sync bus with zip

zipsync on

no zip

no zip

no zip

force zip

zipsync off

no zip

no zip

no zip

force zip

You can print the FCS compressed synchronization feature activation state using the following commands.

To print the FCS compressed synchronization feature activitation state, use the command:

print system fcssettings;

The result is:

zipsync on|off

A result of on means the compressed synchronization feature is enabled, off means that it is disabled.

For an abbreviated form of the output, you can use the command:

print system fcssettings zipsync;

For this command the result is simply the following, with the same meanings as above:

on|off

You can configure FCS compressed synchronization settings using the following commands.

To configure file extensions for compressed files, use the command:

set system fcsextensions [FILE_EXTENSION{,FILE_EXTENSION}];

File extensions are expressed using alphanumeric ASCII characters, avoiding control characters and punctuation characters. Each extension comprises one to five characters, where each character must match the pattern:

[a-z]|[A-Z]|[0-9]

The keyword fcsextensions is a system property whose value is a comma-separated list of file extensions that identify files that are considered to be compressed. For example:

lzw,giff,ar,bz2,jpg

The fcsextensions list can contain a maximum of 16 extensions, which are stored in lower case.

FCS considers any file with one of these extensions to be compressed. For example, if FCS detects a file with an extension of .jpg (for example, a file named picture.jpg) during the synchronization process, it considers this file to be already compressed and will not try to compress it again as this would cause a performance loss. Compressed file format detection through the file extension is not case sensitive.

The fcsextensions property complements an FCS-internal list of compressed-file extensions, which includes the most commonly encountered and used compressed file format extensions:

gz,tgz,zip,rar,z,bz,bz2,tbz,png,gif,jpg,tif,mp4,mpg,avi,wmv,aac,mp3,

mpa,wma

This list is "hard-coded" into the FCS server and cannot be altered, but you can extend it by using the set system fcsextensions command, as described above.

You can print all file extensions that are configured in FCS to indicate compressed files.

To print FCS compressed file extensions, use the command:

print system fcsextensions;

The result is the list of file extensions indicating compressed files, for example:

jpg,giff,tiff

Beware of the following limitations with regard to the compressed synchronization function:

• File extensions can include only alphanumeric ASCII characters, and must not include control characters or punctuation characters.
• The CATIA 3DEXPERIENCE and VPLM Solutions use the file extensions '1' and '2' extensively. Therefore, it is strongly recommended not to add these extensions to the fcsextensions list.
• If a file has several extensions (for example, file.tar.gz), only the trailing one is effective for FCS compressed file detection. In the example cited, FCS would consider this file to have an extension of gz and therefore to be compressed.
• Regarding the set system fcsextensions command:
  • The maximum number of extensions that can be added with this command is 16. This limit has been set with the intention of maximizing synchronization process performance.
  • Each extension comprises a string of one to five characters, where each character must match the pattern [a-z]|[A-Z]|[0-9].
  • This command automatically converts all characters in the string to lower case.