Client preferences

This article describes the setup of the client preferences.

Merge policy

The attribute merge-policy is responsible for merging the client preferences of a given XML element with the corresponding preferences in the server side.

Example

In the example below, we can see that the preferences of the first and second levels are treated differently. All attributes that appear in the indesignmanager element are merged, where:

1. if the attribute exists in the preferences on the client and the server, they are overwritten with the values of the preferences from the server
2. if the attribute exists only on the server, it is passed on to the client
3. if the attribute is only available on the client, it will not be overwritten and will remain

and all second level element preferences (e.g. element create_textpreview) are always overwritten by the server.

• From a user level:

If attributes are stored in the Client Preferences (modules/client/javaclient/javaclient-preferences.xml) on the server, the local attributes are always overwritten upon user login. Any settings made by the user are thus removed, if the attribute is also set on the server.

<indesignmanager merge-policy="false"  mimetype_text="application/x-incopy-interchange" check_picture_filepath="true" message_timeout_seconds="120" enabled="true" actual_asset_element_frame_color="" actual_asset_element_frame_border_width="2" actual_asset_element_frame_border_color="Cyan" actual_asset_element_frame_shade="" actual_asset_element_rel_frame_color="Cyan" target_asset_element_rel_frame_shade="10" target_asset_element_rel_frame_color="Cyan" actual_asset_element_rel_frame_shade="10" new_sub_text_enabled="false" dissolve_option_enabled="true" detach_option_enabled="true" new_sub_incopy_text_enabled="true" placeholder-date-format="dd.MM.yyyy" create_placeholder_elements="false" placeholder-time-format="HH:mm &apos;Uhr&apos;">
    <create_textpreview>
      <allow domain=""/>
    </create_textpreview>
    <create_preview>
      <allow domain=""/>
    </create_preview>
    <create_eps>
      <allow asset_type="ad"/>
    </create_eps>
    <create_pdf>
      <!--
      <allow domain=""/>
      -->
    </create_pdf>
</indesignmanager>

Options

The merge-policy can accept the following options:

• overwrite - this option can behave differently based on the location that is set:

  1. Set in the preferences of the client and on the server: The preferences will be overwritten with the corresponding values set on the server
  2. Set only on the server: The preferences will be passed on to the client
  3. Set only on the client: The preferences will not be overwritten and will remain as set from the server

• initial - with this option the preferences are accepted by the server only if the relevant XML element is not already present locally on the client. If the element is set locally, then only the local settings will be used.

• false - with this option the preferences are accepted once from the server. Afterwards, the settings made in the server preferences are no longer accepted by the client.
• check-version - this option compares the values of attribute merge-version from the client preferences and the local preferences. If those values are not equal, then the entire section of the local preferences will be replaced.

Disadvantages:

• When new attributes (e.g. new release) are introduced, are automatically adopted into the client preferences.
• Any configuration changes in the client preferences on the server are not accepted by the client.