Managing Satellite Server JSON File Properties

23 Managing Satellite Server JSON File Properties

Satellite Server properties are located in the Satellite Server wcs_properties.json file. The Satellite Server wcs_properties.json file is located in the Satellite Server config directory (specified during installation). To manage the properties in the Satellite Server wcs_properties.json file, WebCenter Sites provides the Satellite Server Import/Export Utility.

The following topics provide information and instructions about managing the Satellite Server JSON file properties using the Import/Export Utility:

23.1 About the Satellite Server JSON File

WebCenter Sites provides the Satellite Server wcs_properties.json file which contains all the properties required by Satellite Server. The Satellite Server JSON file is located in the Satellite Server config directory (specified during installation). To manage the properties in the Satellite Server JSON file, WebCenter Sites provides the Satellite Server Import/Export Utility.

To access the Satellite Server Import/Export Utility, you must run a command line prompt by invoking the COM.FutureTense.Properties.Key/ValueStoreImportExport class. For instructions, see Using the Import/Export Utility to Manage Satellite Server Properties.

23.2 Overview of the Satellite Server Import/Export Utility

The Satellite Server Import/Export Utility is used to update property values in the Satellite Server wcs_properties.json file.

The Import/Export Utility enables users to extract the properties from the Satellite Server wcs_properties.json file into a property file format (.ini or .properties) to their local system. Once you update the desired properties, you then run an import command to import your changes into the Satellite Server wcs_properties.json file. When the WebCenter Sites system is restarted, your property changes are updated on all Satellite Server instances.

23.3 Using the Import/Export Utility to Manage Satellite Server Properties

To update Satellite Server properties, invoke the COM.FutureTense.Properties.KeyValueStoreImportExport class to run the import and export commands for Satellite Server properties. The instructions below provide commands for Windows systems only. If you are running the commands on a Unix system, the commands are identical, however, the path separators are colons instead of semicolons.

Note:

The Satellite Server Import/Export Utility does not support the following functions:

Flush flag.
Adding custom properties to the Satellite Server JSON file. For instruction on adding custom properties, see Adding Properties to the Satellite Server JSON File.

Open a command prompt window.
Export the Satellite Server properties with the following command:
```
>java -cp "<SATELLITE_SERVER_PRODUCT_HOME>/lib/*;<SATELLITE_SERVER_PRODUCT_HOME>/lib/oracle/*;<path_to_config_folder>" -Djava.protocol.handler.pkgs="" -Dsites.config="<path_to_config_folder>" COM.FutureTense.Properties.KeyValueStoreImportExport export <path_to_properties_file>
```
Where <path_to_properties_file> is the name of the properties file (.ini or .properties) to which you want to export the Satellite Server properties in a key=value pair format.

The utility creates the property file in the directory you specified in the export command.
Navigate to and then open the property file in a text editor. The properties are listed in a key=value format. Modify the values of the desired properties and then save the property file.

Import the updated properties into the Satellite Server JSON file with the following command:

>java -cp "<SATELLITE_SERVER_PRODUCT_HOME>/lib/*;<SATELLITE_SERVER_PRODUCT_HOME>/lib/oracle/*;<path_to_config_folder>" -Djava.protocol.handler.pkgs="" -Dsites.config="<path_to_config_folder>" COM.FutureTense.Properties.KeyValueStoreImportExport import <path_to_properties_file>

The properties you modified are updated in the Satellite Server wcs_properties.json file.

23.4 Adding Properties to the Satellite Server JSON File

To enable certain Satellite Server features, you must manually add properties to the Satellite Server wcs_properties.json file. For example, if inCache is enabled, you can add the propagatecache property to the wcs_properties.json file to enable page propagation among cluster nodes.

To add properties to the Satellite Server wcs_properties.json file:

Navigate to the Satellite Server config directory (specified during installation), and open the wcs_properties.json file in a text editor.

Add the property to the Satellite Server wcs_properties.json file in the following format:

{
   "key":"<property name>",
   "value":"<property value>",
   "valid_values":[""],
   "defaultValue":"<property value>",
   "category":"Satellite",
   "subcategory":"",
   "global":true,
   "hide":false,
   "readonly":false,
   "deprecated":false,
   "description":"Description of property"
}

Save and close the Satellite Server wcs_properties.json file.
Restart Satellite Server for your changes to take affect.