Skip to content

Component types in the Universal directory

octoplant supports the management of documents created with the most commonly used editors for documentation. You can find the following component types with an integrated comparator in the _Universal folder.

  • ASCII: The comparator of the ASCII component type (text comparator) supports all file formats. Supported file encodings include Utf8, Utf16LE, Utf16BE, Ansi and ASCII.
  • Binary: The comparator of the Binary component type supports all file formats.
  • Json: The comparator of the Json component type supports valid JSON files with Utf8 encoding.
  • WindowsINI: The comparator of the WindowsINI component type supports the file format INI.
  • XML: The comparator of the XML component type supports valid files in the XML format.

If you want to store several different documents in one component, you have the following component types with several integrated comparators to choose from:

  • Documentation: The comparator of the Documentation component type supports the file formats htm, htm?, log, txt, csv, xls, xls?, xlt, xlt?, pdf, doc, doc?, dot, dot? and rtf. The question mark ? stands for all possible endings of the respective file format (Existing comparators: Binary, ASCII, Excel, PDF and Winword).
  • Software: The comparator of the component type Software supports all file formats and additionally txt and pdf (Existing comparators: Binary, ASCII and PDF).

Example: Comparator configuration of the JSON SmartCompares

Example document for Json:

Figure: Example document for JSON

Procedure for the entry under Exclude lines from comparison for the sample document:

  • Absolute exclusion: The beginning of the path is checked, all subordinate elements are ignored.

  • .os: The os object is ignored with all properties (architecture, system_drive, programs). The os2 is not ignored.

  • .os.architecture: The architecture property of the os object is ignored. The architecture property of os2 is not ignored.

  • Relative exclusion: The end of the path is checked.

  • architecture: The architecture property is ignored globally (here for os and os2).

  • products.install_data: The install_data properties of all objects under products are ignored globally (in this case, of objects os and os2).

Configuration

To get the basic workflow for integrating a document, open General workflow.

FAQ

Unversioned changes are noted during the Check-In of a component of the type Documentation

During the Check-In of a component of type Documentation, it is noted that there are unversioned changes in the working directory and that unversioned changes are not copied to the server. What changes are meant here and how should I deal with this note?

Specific scenario
You want to version and check in a component of component type Documentation. The component was provided with a file whose name contains a hyphen with the key combination (ALT + 0150). When versioning the component, a message appears about unversioned changes that are not copied to the server.

Explanation
This happens because the hyphen with the key combination ALT + 0150 is not recognized and when saving this character is replaced by another one.

Solution
If you click on Continue, the component will be saved on the server. Nevertheless, we recommend that you do not use the key combination ALT + 0150 when entering the names of files of the component type Documentation.

Excluded lines in the configuration of the ASCII configuration are still displayed during comparison

Situation: I have precisely specified the lines to be excluded through their line numbers, they are still displayed during the comparison. What could be the reason for this?

Lines excluded from comparison are not specified through the line numbers, but with the help of a character string. To exclude rows from the comparison, please proceed as follows:

  1. Open the UserClient.
  2. Go to the Project tree.
  3. Right-click the component from which you want to exclude rows from the comparison.
  4. Select Edit component configuration in the context menu.
  5. The Component configuration dialog is displayed.
  6. Select Comparator configuration
  7. The Comparison configuration dialog is displayed.
  8. Extend the list of Lines excluded from comparison with corresponding entries (either the entire line or using placeholders)

If the list of excluded character string(s) contains an entry, every line that contains EXACTLY this character string is excluded from the comparison.

Placeholder

*a -> excludes all lines that end with the character a.

a* -> excludes all lines that begin with the character a.

*a* -> excludes all lines that contain an a at any position.

{Space}* -> excludes all lines that begin with the value specified in {Space}.

<TAB>* -> excludes all lines that begin with a tab.

Example

Current value*

*alarm*

The entries mean that every line in which a change occurs with the character string alarm and every line in in which a change begins with the character string Current value is excluded from the comparison.