Documentation Center

Configuring a custom Footprint date field

Users can pick an option from a Footprint date field.

Procedure

  1. Access your Content Manager server and navigate to %TRIDION_HOME%.
  2. Navigate to the subfolder web\WebUI\Models\SiteEdit\Configuration\.
  3. As a precaution, back up the file SiteEditModel.config.
  4. Open the file SiteEditModel.config in a plain-text or XML editor.
  5. Find the customconfiguration section. This section has a subsection called clientconfiguration, which in turn contains a footprints subsection.
    You see the list of footprint elements that represent the Footprints which are currently displayed in the Footprint Set dialogs.
  6. Insert a new footprint element for the custom Footprint field you want to configure, and give it the following attributes:
    ID
    a unique string that identifies this Footprint
    ClaimUri

    the URI of a Claim associated with this Footprint, for example:

    taf:claim:foo
  7. Also give this element a type attribute set to the value date.
  8. Insert a <title> section inside your new footprint element.
  9. For each language that your installation of SDL Web supports, insert a value element inside the title element, and give it a lang attribute set to the four-digit Microsoft locale ID belonging to that language:
    • 1031 for German
    • 1033 for US English
    • 1036 for French
    • 1041 for Japanese
    • 1043 for Dutch
    • 3082 for Spanish
  10. Set the contents of each value element to the localized name of this Footprint, as you want it to appear in the Footprint Settings dialog.
  11. Also insert a value element without a lang attribute. This is used as a fallback if the language is none of the above. (If you do not insert such a value element, the value of the ID attribute of the parent footprint element is displayed.)
    You have now configured a title for your Footprint.
  12. If you want, you can also write a description for your Footprint. The description appears under the title in the content area on the right if the user selects this Footprint. To create a Footprint description, insert a <description> section inside your new footprint element, directly under the <title> section.
  13. For each language that your installation of SDL Web supports, insert a value element inside the description element, and give it a lang attribute set to the four-digit Microsoft locale ID belonging to that language.
  14. Set the contents of each value element to the localized description of this Footprint, as you want it to appear in the Footprint Settings dialog.
  15. Also insert a value element without a lang attribute. This is used as a fallback if the language is none of the above. (If you do not insert such a value element, an empty string is displayed.)
    You have now configured a description for your Footprint.
  16. Insert a <settings> section inside your new footprint element, and inside it, insert an <isMandatory> element containing the value true.
  17. Specify a default value for this Footprint.

    To specify a default value, insert a <values> section inside the footprint element (under the <settings> section, if you created one). Inside <values>, create a value element with the following attributes:

    text
    The value of the field, as it will be submitted. Set this attribute to the empty string (text="") to make the empty value default. To set it to a specific date and time in the format yyyy-MM-ddTHH:mm:ss (for example, 2012-12-29T23:55:00 represents 5 minutes to midnight on 29 December 2012).
    default
    Set this attribute to true.
  18. If you want, repeat steps 5-16 to configure further custom Footprint fields that use a calendar control.
  19. Save and close SiteEditModel.config.
  20. Navigate to the subfolder web\WebUI\Editors\SiteEdit\Configuration\.
  21. As a precaution, back up the file SiteEditEditor.config.
  22. Open SiteEditEditor.config.
  23. Find the customconfiguration section. This section has a subsection called clientconfiguration, which in turn contains a footprints subsection.
    You see the list of footprint elements that represent the Footprints which are currently displayed in the Footprint Set dialogs.
  24. Create an icon for the custom Footprint in the form of a set of PNG files named footprint.<iconname>.16x16.png (16 by 16 pixels), footprint.<iconname>.24x24.png (24 by 24 pixels), footprint.<iconname>.32x32.png (32 by 32 pixels) and footprint.<iconname>.48x48.png (48 by 48 pixes), where <iconname> is a name for your icon. Save these files in the folder %TRIDION_HOME%\web\WebUI\Editors\SiteEdit\Themes\Carbon\Images\Icons\.
  25. Add a new footprint element with the following attributes:
    ID
    The identifier of the Footprint, as set in SiteEditModel.config.
    ControlID
    Set this to FootprintDate.
    Icons
    The name you provided for the icon (<iconname>).
  26. Repeat this step for each new Footprint you configured in SiteEditModel.config.
  27. Save and close SiteEditEditor.config.
  28. In the cd_ambient_conf.xml Ambient Data Framework configuration file, add a new Claim element in the GloballyAcceptedClaims section and set its Uri attribute to the Claim URI of your new Claim.