app get

Available for: Content Management Server, Template Engine, Search Engine Server

Task: Returns the value of the specified parameter. This command is also available in the Tcl-Client.

Syntax:

app get parameter

Function parameters:

  • parameter: the name of the parameter whose value is to be determined. Valid names are:
    • phase (TE only): the partial phase the Template Engine is in. For an explanation of the phases see Functions of the Template Engine.
    • phaseDetails (TE only): in addition to the current partial phase and for debugging purposes, this returns detailed information about the progress of the phase. Depending on the phase (see the phase parameter), the return value is structured as follows:
      • import {objects objectCount recursiveObjectCount}:
        objectCount specifies the number of files that need to be exported. When the import phase begins, this value reflects the number of files that could not be exported during the most recent export phase. recursiveObjectCount specifies the number of files whose subhierarchy must also be exported. When the import phase begins, recursiveObjectCount is 0. During the import phase both values can only increase.
      • export-init {objects objectCount recursiveObjectCount}:
        The values have the same meaning as for the import phase. At the end of the export-init phase, recursiveObjectCount is 0.
      • export-fill {sliceType count percentage} ...:
        sliceType is the type of a section from the list of files to be exported. For each of the following types, a sublist is inserted into the resulting list: available, inProgress, complete, failed, total. The identifiers have the following meaning:
        count: The current number of sections of this type. If sliceType is total, the total number of sections is output.
        percentage: specifies the percentage of all sections of this type. For the total type the percentage is always 100.
      • For the remaining phases, phaseDetails only returns the phase identifier.
    • today: the current date (14 places), 0.00 h, in GMT.
    • version: the version string that can also be queried using the -version command line parameter.
    • appName: the application’s name.
    • rootConfigPath: the path of the main configuration file nps.xml.
    • timeZone: the time zone resulting from the machine’s time.
    • baseDir: The NPS installation directory.
    • binDir: the directory below the instance directory in which the start scripts are located.
    • commonScriptDir: the absolute path of the instance-specific script/common directory.
    • configDir: the directory below the instance directory in which the configuration files are located.
    • dataDir: the directory below the instance directory in which data such as blobs and streaming tickets are located.
    • instanceDir: the instance directory.
    • libDir: the directory below the installation directory in which libraries and executable files are located.
    • logDir: the directory below the instance directory in which the log files are located.
    • scriptDir: the directory below the instance directory in which the scripts are located. The cm directory is used both by the Content Manager and the Template Engine, the ses directory is used by the Search Engine Server.
    • shareDir: the directory below the installation directory containing files used by all instances, for example the documentation.
    • tmpDir: the directory below the installation directory in which temporary files such as PID files are located.

Return value if successful:

  • phase and rank: the value of the parameter (string).
  • phaseDetails: the details for the respective phase (stringlist).
  • timeZone: the time zone (string).
  • *Dir: the absolute path of the directory (string).

Necessary permissions (CM only): no restrictions