You are here: All Help Topics > CaseWare Working Papers > Environments and Electronic Licensing > Adding Publish Folders using a Configuration File

Adding Publish Folders Using a Configuration File

A configuration file can be used instead of the Collection Editor to define publish value keys, simplifying the process of creating and maintaining complex keys.

Create a file named publish.xml in your SmartSync Server folder. Example: C:\inetpub\wwwroot\SmartSync. The configuration file will override collections created in the Collection Editor.

Defining publish folders and custom fields

The configuration file must use the following syntax:

<settings>
- <directory>
  - <label>%%ClientName%%</label>
  - <location>\\SERVER2\FILES\%YearEnd%</location>
- </directory>
- <field>
  - <label>Color</label>
  - <name>Color</name>
  - <type>string</type>
  - <default>None</default>
  - <minimum></minimum>
  - <maximum></maximum>
  - <list>
    - <item>
      - <label>Blue</label>
      - <value>Blue</value>
    - </item>
    - <item>
      - <label>Green</label>
      - <value>Green</value>
    - </item>
  - </list>
- </field>
</settings>

For information on syntax values, see Configuration File Syntax Values.

Tag	Meta-Data	Description
<settings>	N	Configuration file settings opening tag.
<directory>	N	Publish folder settings opening tag.
<label> </label>	Y	Publish folder label tag.
<location> </location>	Y	Publish folder location tag.
</directory>	N	Publish folder settings closing tag.
…		Replace the ... with another <directory></directory> element for additional publish folders.
<field>	N	Tag opening the custom field settings opening tag.
<label> </label>	Y	Custom field description tag.
<name> </name>	N	Field name tag.
<type> </type>	N	Field type tag. Example: string, date, integer, decimal, or boolean.
<default> </default>	N	Field default value tag.
<minimum> </minimum>	Y	Minimum integer range value tag.
<maximum> </maximum>	Y	Maximum integer range value tag.
<list>	N	List settings opening tag.
<item>	N	Item settings opening tag. Encapsulate values in the drop-down list.
<label> </label>	Y	List description opening tag.
<value> </value>	Y	Field values tag. These values are in addition to the default value specified in <default></default>
</item>	N	Item settings closing tag.
</list>	N	List settings closing tag.
</field>	N	Custom field settings closing tag.
…		Replace the ... with another <field></field> element for additional custom fields.
</settings>	N	Configuration file settings closing tag.

Notes

You can add custom meta-data in the publishing path. These custom fields enable you to define directory names specific to your firm. Furthermore, custom fields can be defined to present Working Papers users with a drop-down list of options if displayed on the client side. These options are defined as items in the <list> element
Label tags accept a ‘language’ attribute for localized descriptions of publish folders or fields. For each element, multiple label tags can be added – each with a different language attribute designating the language of the label. Example:
- <label>Default language label</label>
- <label language=”en”>Generic English label</label>
- <label language=”en-US”>English (US) label</label>
- <label language=”fr”>Generic French label</label>