Fileshare Server Configuration Options

This section describes all of the available Fileshare Server configuration options. The /s option that defines the server-name is compulsory. All other options are optional or have default values that are specified below.

Note:
  • UNIX: In this section, options are shown starting with a forward slash (/). This is how you specify the options on Windows. On UNIX, use the hyphen (-) character instead of the forward slash.
  • UNIX: Filenames are shown using the Windows naming convention. On UNIX, use the UNIX file-naming conventions.
Server Configuration Options Specifying
/s server-name
The name that the Fileshare Server registers on the network. This must be a character string up to 16 characters in length, depending on the CCI protocol that you are using. The name specified must be unique. If a Fileshare Server with the same name is already registered on the network, an error is returned.
/d database-reference-file
The name of the database reference file that the Fileshare Server is to use. The database reference file is used to determine which additional Fileshare features you want to use.
/t timeout-period
Setting the record lock timeout period after which the Fileshare Server releases all record locks held by a Fileshare Client and rolls back any outstanding transactions. The timeout period is specified in seconds. The default value is 60 seconds. Specifying a value of zero disables the timeout and record locks are only released under the control of your application program. Valid values are 0 thru 99999. The timeout only occurs if one Fileshare Client requests a record currently locked by another Fileshare Client.

Setting a value of zero in conjunction with setting the environment variable ES_RLS_FILE_SUPPORT=Y ensures that no information is returned to the record area following a READ operation on a locked record.

/m record-size
The maximum record size that can be processed by the Fileshare Server. Setting a value lower than the default value reduces the amount of memory that the Fileshare Server needs to run. The record size is specified in kilobytes. Valid values are 16 thru 64. If you specify a value less than 16, the Fileshare Server uses a buffer size of 16KB. If you specify a value greater than 64, the Fileshare Server uses a buffer size of 64KB.
/cm cci-protocol
The CCI protocols that the Fileshare Server can use. Repeat this option for every communications protocol that you want to use to contact this Fileshare Server. Valid values for cci-protocol are:

Windows: ccitcp, or ccism UNIX: ccitcp

/pf password-file
The name of the password file that the Fileshare Server uses.
/cf file-name 

Specifies the name of the Fileshare Server configuration file. Use this option only on the command line. When using this option, you must specify the required Fileshare Server options in the configuration file. If you do not specify a name for the configuration file, it defaults to fs.cfg in the Fileshare Server's current directory.

/tr f
Activating the Fileshare Server trace option on start-up. Trace messages are written to the screen and to a file called fsscreen.lst in the Fileshare Server's current directory. This option seriously impacts the Fileshare Server's performance, so you should only use it for problem investigation.
/sc
Use this to get the best performance. Switching Fileshare into synchronous communications mode. This means that when there is nothing for Fileshare to process, it goes into a wait state until interrupted by a message from the communications layer. You need to use a password file, and provide a password for fsview so that you can shut down Fileshare remotely. You can shut it down from the screen, but you might need to wait up to two minutes before it responds to the screen action.
/ev event-emit 
Indicates the types of error messages that are written to fsscreen.lst in order to cause events if you have Fileshare tracing enabled.
event-emit is any combination of IEWS, where
  • I = information
  • E = error
  • W = warning
  • S = severe
-b
You must specify this if the Fileshare Server is to run as a background process. You can use it only on the command line.
/pt time
Writes to fsscreen.lst details of processes that take longer than the time specified to complete. Time can be specified in 10ths of a second.
/fc
Enables flush on commit, which flushes the cached file operations to disk after every COMMIT statement. After which, it runs a disk stats check, to calculate the disk usage and the amount of space remaining, generating a warning if disk space is low. Use /fds to control the frequency of this check.

If the file is unable to be flushed to disk due to low disk space, the operation will be suspended for 30 seconds, and then retried.

Also, use this option in conjunction with /lw if you want to use advanced rollback recovery in the event of a device or operating system failure.
Warning: Setting this option will degrade the performance of Fileshare.
/fds <value>
Controls the frequency of the disk stats check performed after a flush, and so this option only has an effect when /fc is also specified.

By default, this check is performed after every flush, but you can use /fds to change the frequency.

Set this option to a value between 1-65536 to represent the nth flush on which to run the checks. (A value less than 1 equates to 1, and a value greater than 65536 equates to 65536.)

/lw
Enables write through for the transaction log file, so that file operations are written to the cache and disk at the same time. Use this option in conjunction with /fc if you want to use advanced rollback recovery in the event of a device or operating system failure.
Note: Setting this option will degrade the performance of Fileshare.
/sm

Starts Fileshare in sharing mode. It enables files to be shared using the 'Sharing with all other' sharing mode model.

This option is only applicable to stand-alone Fileshare, and only for those files not marked as transactional files (that is, not flagged with advanced logging). Transactional files will still be opened exclusively.

/uv

Instructs Fileshare to use the specified password file that is stored in the Vault Facility.

The password file must have been uploaded to a vault, with a prepended path of microfocus/fh, before you start Fileshare using this option. Upload the file using the mfsecretsadmin command; for example:

mfsecretsadmin write microfocus/fh/pass.dat  -file pass.dat  -vault aesvault
Note: If you update your password file, you must upload the updated version to the vault; see The mfsecretsadmin Utility for more information.
/clp
Upgrades the password file to enable support for long usernames and passwords, up to 100 characters in length. It must be combined with the /pf option to upgrade a specific password file.
Note: Password files that are upgraded to enable long username and password support are no longer compatible with versions of Visual COBOL prior to version 3.0. Once the /clp option has been run, all future password files created on the server now support long usernames and passwords.