FCS Synchronization Server Parameters

When you run the FCS Synchronization Server from a script, you must supply the desired command line parameters.

For details on running the scripts, see Running the File Collaboration Server (FCS) Synchronization Server.

This table provides the full list of command-line parameters for the FCS Synchronization Server scripts.

This page discusses:

Parameter Mandatory(M)/ Optional (O) Description
-url MATRIXURL M URL of the 3DEXPERIENCE server or MCS Server: http://host:port/root-uri/
-user USER M 3DEXPERIENCE connection user with system privileges. May contain space characters. See Note below for details.
-password – M Password of the 3DEXPERIENCE connection user, no scrambling.
-role ROLE M Role of the 3DEXPERIENCE connection user. May contain space characters. See Note below for details.
-ruleFiles FILE1 [FILE2 [...]] M Sync Server configuration rules file, full path required.
[-maxRetries NNN] O If business object file synchronization fails more than NNN times it will be discarded from further sync operations. Traces of this issue are in the log file, with the ID of the failing business object. So the VPLM system administrator should look (using MQL) at the business object history to see which file operation went wrong, or apply the checker. The default is 5.
[-maxSyncRunner ?Threads NNN] O Maximum number of threads used by the SyncRunner.
[-rulesCheckSecondElapse NNN] O Seconds elapsed between two checks of sync rule execution. Daily, weekly, monthly rule execution time must not exceed <synctime> value + 2*NNN. The default is 300.
[-logPath ?path_of_the_log_ ?files] O A directory path. This directory will contain log files of the SyncDaemon. Logs are written to three log files, fcssyncd0.out, fcssync1.out and fcssyncd3.out. These logs are rotating logs, only one is active at a time.

This parameter is no longer allowed for the FCS Sync Server. SLF4J/logback is now used for the FCS Sync Server log infrastructure.

[-logSize ?logfile_max_size_ ?in_megabytes ?default 5] O Maximum size of an fcssyncX.out file.

This parameter is no longer allowed for the FCS Sync Server. SLF4J/logback is now used for the FCS Sync Server log infrastructure.

[-proxyHost] O Host name of a proxy server.
[-proxyPort] O Port number of a proxy server.
[-nonProxyHosts] O Indicates the hosts that should be connected to directly and not through the proxy server. The value can be a list of hosts, each separated by a pipe character |, and in addition a wildcard character * can be used for matching. For example: -nonProxyHosts="*.foo.com|localhost"
[-h] [-help] O Displays command line options help.

Arguments That May Contain Spaces

The -user and -role arguments may contain spaces. In this case, the argument value must be enclosed in single or double quotes. For example (on Windows):

CSR\OS\code\bin\ENOFCSSyncServer.bat -url http://cimi4dsy:7023/ematrix -user 'User Agent'
-password XXX -maxRetries 5 -maxSyncRunnerThreads 10 -rulesCheckSecondElapse 10 -logPath E:\tmp\logs\ 
-logSize 3 -ruleFiles %WS%/rules.xml -role 'VPLMAdmin.Company Name.Default'

Quote Characters in Shell Scripts

On UNIX/Linux, if you have created a shell script that calls the ENOFCSSyncServer.sh script, you must backslash-escape the quote characters. For example:

CSR/scripts/ENOFCSSyncServer.sh -url http://cimi4dsy:7023/ematrix -user \'User Agent\' 
-password XXX -maxRetries 5 -maxSyncRunnerThreads 10 -rulesCheckSecondElapse 10 -logPath E:/tmp/logs/
-logSize 3 -ruleFiles %WS%/rules.xml -role \'VPLMAdmin.Company Name.Default\'

Backslash-escaping of quotes must not be used for Windows batch (.bat) scripts.