Version

Configuration File Reference

SharePlus can centrally configure default behaviors and feature trimming using a configuration file with a specific structure. This is an XML file that can be previously established by the user or even updated remotely from a repository.

Structure and XML Details

The configuration file has a plist extension, which internally is just an XML with a pre-define structure that it’s needed for the application in order to correctly recognize and process the information.

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
   <dict>
      <key>ConfigManager</key>
      <dict>...</dict>
      <key>Features</key>
      <dict>...</dict>
      <key>Pages</key>
      <dict>...</dict>
      <key>Accounts</key>
      <dict>...</dict>
      <key>Sites</key>
      <dict>...</dict>
      <key>Variables</key>
      <dict>...</dict>
   </dict>
</plist>

This file has six root items

  • ConfigManager: Attributes related to the remote configuration setup.

  • Features: Attributes related to the application’s features.

  • Pages: Attributes that define pages (or view containers) that can be used when first accessing the application, sites, and/or sub-sites.

  • Accounts: Attributes that define site’s accounts.

  • Sites: Attributes that define possible connection configurations.

  • Variables: Attributes for custom behaviors.

Configuration File - Required Keys

In order for the application to launch, there are certain keys that always need to be present in the configuration file. The “Key is Required” specification in each key will let you know if it is required or not.

Note

In remote configuration scenarios, it is not mandatory to fill all of the items in the file. This means that the application will merge the data to the local settings automatically if a remote configuration URL is provided.