export

This configuration element, which can be found in the instance-specific config/export.xml file, defines the export of files by the Content Management Server. The subelements have the following meaning:

  • abortOnError: Using this key (value false or true) you determine whether an export is aborted when an error occurs (if, for example, nonexistent fields are queried using NPSOBJ).
  • absoluteFsPathPrefix: This option is only effective if links are exported with absolute paths (subentry exportAbsolutePaths). absoluteFsPathPrefix defines the character string that is used as a prefix for all file paths in links. Therefore, this option allows you to place the exported files into directories located somewhere below the webserver's document root directory.
  • absoluteUrlPrefix: same as absoluteFsPathPrefix, but applied to the path in URLs.
  • charset: The character set and its encoding of the exported documents. The value can be one of the element names in the charsetMap subentry.
  • charsetMap: The element name corresponds to the name of the character set in Tcl, whereas the element's content is the name used in HTML and XML. One of the element names listed here can be specified as the value of the charset subentry. If charsetMap has not been defined, then <utf-8>UTF-8</utf-8> is used.
  • convertNpspm: The value of this entry controls how the CMS handles npspm elements during the export. The element has the following subelements.
    • isActive: Determines by means of the value true or false whether npspm tags (with which Portal Manager functions can be included in exported documents), are converted to the Velocity template language or not.
    • hideForbiddenLinks: Controls by means of the values true or false whether links to documents under access control can even be clicked (no = true) if the website visitor is not allowed to access the target document. If so, the corresponding error page configured in the web.xml file in the instance-specific directory webapps/PM/WEB-INF as the value of an error-page element is displayed (see the examples in this file). By this means, the website visitor can be directed to a login page, for example.
    • mapping: With this entry, file name extensions are associated with the language into which npspm tags are translated in exported pages. Example:
      <mapping>
        <htm>velocity</htm>
        <html>velocity</html>
        <jsp>jsp</jsp>
      </mapping>
      
  • defaultDocType: The value of this entry can be either HTML or XML sein, depending on the desired format of the tags generated by the CMS.
  • exportAbsolutePaths: defines whether links to files are to be exported with absolute (true) or relative (false) paths. This option must be switched on if files that are included with the NPSOBJ-insertvalue-dynamiclink instruction contain links to files. In this case, relative links in the files included would fail to work properly since the location of the originally exported files is not predictable.
  • exportBaseDir: Determines the directory, into which the Template Engine places the exportierted files creates subdirectories if required. The default value is export.
  • guiUrl: The value of this entry determines the URL up to the web application of the GUI. The supplied systemExecute command editLink uses this entry. Furthermore, the HTML editor (edit on pro) uses this URL to determine the URL of preview images displayed in WYSIWYG mode. Therefore a URL must be specified as guiUrl that can be resolved externally. Example:
    <guiUrl>http://localhost:8080/NPS</guiUrl>
  • incrementalUpdate: defines whether the Content Management Server sends data for the incremental update to the Template Engine. Furthermore it defines how the Template Engine can be reached.
    • isActive: activates (true) or deactivates (false) the incremental update
    • login: login under which the Content Management Server can log-in to the Template Engine.
    • password: The password for logging-in.
  • referenceAttributes: Under this entry a list of version fields can be specified that are to trigger a reference type dependency instead of a content change dependency. This has the effect that files depending on such a field are not invalidated when the value of the field changes. Add a field to this list if it is used exclusively for creating links to the files concerned, for example in automatically generated navigations. Do not specify fields of the linklist type here. Example:
    <export>
      ...
      <referenceAttributes type="list">
        <referenceAttribute>showInNav</referenceAttribute>
        <referenceAttribute>hideInNav</referenceAttribute>
      </referenceAttributes>
    </export>
    
  • tclDynamicLinkFormatterCommands: This dictionary defines the alias names of the formatting procedures that can be called when NPSOBJ insertvalue-dynamiclink instructions are evaluated. The corresponding formatter routines are defined in the file dynamicLinkFormatters.tcl located in the script/cm/serverCmds directory below the instance directory (i. e., for example below instance/default). This directory is also used by the Template Engine. Please note that the web pages on the live server must be exported again if Tcl procedures affecting the export results are modified. For this purpose, the obj touchAll command can be used. Example:
    <tclDynamicLinkFormatterCommands>
      <phpInclude>formatter:phpInclude</phpInclude>
      <phpIncludeOnce>formatter:phpIncludeOnce</phpIncludeOnce>
      <phpRequire>formatter:phpRequire</phpRequire>
      <phpRequireOnce>formatter:phpRequireOnce</phpRequireOnce>
      <include>formatter:include</include>
    </tclDynamicLinkFormatterCommands>
    
  • tclFormatterCommands: The dictionary contains procedure alias names, which can be used as formatter attribute values of NPSOBJ-insertvalue-var instructions. Here, the names of the procedures which are to be called when the NPSOBJ instructions are evaluated are assigned to the alias names. Example:
    <tclFormatterCommands>
      <phpVardef>phpVardef</phpVardef>
    </tclFormatterCommands>
    
  • tclSystemExecuteCommands: This dictionary defines the NPSOBJ systemExecute commands that can be used in layouts. The commands must have been made available as server commands (as with tclDynamicLinkFormatterCommands). Example:
    <export>
      ...
      <tclSystemExecuteCommands>
        <procedureAliasName>trueProcedureName</procedureAliasName>
      </tclSystemExecuteCommands>
    </export>
    
  • toclistSortLanguage: Specifies the local language setting to be used for sorting file lists alpabetically (npsobj list="toclist"). The language setting consists of two lowercase letters for the language followed by two uppercase letters for the country (for example de_DE for German). If this system configuration entry is not present, the operating system setting is used, i. e. the value is taken from the LC_COLLATE environment variable.
  • validDateTimeOutputFormats: The valid date formats are stored in this dictionary as subelements. These formats can be specified in NPSOBJ elements as values of the format attribute in order to format date values. Example:
    <validDateTimeOutputFormats>
      <dayMonthYear>%d/%m/%Y</dayMonthYear>
    </validDateTimeOutputFormats>
    Date and time formats as they can be defined in this system configuration entry are strings. You can use the following for current system-time parts in these strings:
    Place-Holder  Meaning
    %d day as two-digit number
    %m month as two-digit number
    %y year as two-digit number
    %Y year as 4-digit number (with century)
    %j day of the year as 3-digit number (001-366)
    %H hour as two-digit number (24h format)
    %I hour as two-digit number (12h format)
    %M minutes as two-digit number
    %S seconds as two-digit number
    %p am/pm
    %Z the timezone name
    %z timezone difference to GMT (±HHMM)
    %w weekday as two-digit number (0=Sunday)
    %% a percentage sign
  • wantLinkCallback: Activates or deactivates link callback functions (YES or NO) with which links can be modified during export or preview.
  • writeLiveServerReadPerms: Determines whether the live server read permissions (group names assigned to the files) are transferred to the Template Engine during a content update (true) or not (false).