Installation
2017 R1 Update Rollup 1

InstallationPermanent link for this heading

Fabasoft Mindbreeze EnterprisePermanent link for this heading

For the integration of Fabasoft Mindbreeze Enterprise the installation of the third-party product Fabasoft Mindbreeze Enterprise is required.

  1. Install Fabasoft Mindbreeze Enterprise as described in the manual of the third-party product.
  2. In a Microsoft Windows system environment the server nodes of Fabasoft Mindbreeze Enterprise that are configured as search service have to be run as a dedicated user.

Note: Following indexing service capabilities are required: aclreferences, startandcountinlegacyxml and fsc:aclobjects.

Fabasoft Integration for Fabasoft Mindbreeze EnterprisePermanent link for this heading

Kernel Based IntegrationPermanent link for this heading

The installation of the software product Fabasoft Integration for Fabasoft Mindbreeze Enterprise is done automatically during installation or updating a Fabasoft Folio Domain.

To install the service for the Fabasoft Integration for Fabasoft Mindbreeze Enterprise, perform the following steps:

  1. Insert the Fabasoft product DVD in the DVD drive of your server running the search service of Fabasoft Mindbreeze Enterprise. The Fabasoft Server Setup dialog will be displayed automatically. Make sure that the user you are logged in on the server node of Fabasoft Mindbreeze Enterprise is a privileged user in the Fabasoft Folio Domain.
    Note: If this dialog is not displayed automatically, run setup.exe in the root directory of the Fabasoft product DVD.
  2. Accept the Fabasoft legal terms and click “Next”.
  3. Select Install additional Fabasoft services and products for existing domain, enter the host and the port and click “Next”.
  4. Clear all checkboxes except for Fabasoft Integration for Fabasoft Mindbreeze Enterprise and click “Next”.
  5. A check on all prerequisites is performed. Ensure that your system complies with all requirements (indicated by a green tick) and then click “Next”.
  6. Enter the Username and Password of the user running the service of Fabasoft Mindbreeze Enterprise. Click “Next”.
  7. Click “Edit” to view or change the settings.

    The index name is displayed in the Mindbreeze Web Client below the category name. If this field is empty, the default name of the edition will be taken.

    “Fabasoft Folio” is the category name defined in the categorydescriptor and “Fabasoft Index” is the name of the index.
    Note: If you install the “Fabasoft Integration of Fabasoft Mindbreeze Enterprise” on multiple Servers you should only check the "Register CA" checkbox on the server where the Fabasoft Mindbreeze Enterprise Management Node is installed and configured.
  8. Click “Finish”.
  9. Note: In case of Linux, the Mindbreeze Integration cannot be installed using the Fabasoft Folio Setup because Fabasoft Mindbreeze Enterprise does not support the version of Linux supported by Fabasoft Folio at this time. The web service based integration must be used instead. The configuration steps executed by the setup must be done manually as outlined in chapter .
    In case of an existing installation, the integration must be uninstalled using the following commands before the web based integration can be configured:

  10. su - fscsrv
  11. /opt/fabasoft/bin/fscmes -d
  12. /opt/fabasoft/sbin/uninstall

Web Service Based IntegrationPermanent link for this heading

In contrast to the Kernel based integration, the web service based integration does not require a Kernel installation on Fabasoft Mindbreeze Enterprise servers. Instead, that type of integration communicates with an existing or dedicated Fabasoft Folio web service for processing Fabasoft Mindbreeze Enterprise search requests.

To install the web service based integration, perform the following steps:

  1. Create index and filter services in Fabasoft Mindbreeze Enterprise (Advanced / Indices, Advanced / Filters).
  2. Configure the integration in Fabasoft Folio as outlined in chapter .
  3. Prepare a Fabasoft Mindbreeze Enterprise plugin ZIP archive that contains the following files:
    1. plugins.xml (plugin description)
      A Fabasoft Mindbreeze Enterprise plugins XML file that describes the web service based integration. In the XML, the element location defines the URL of the target web service:
    2. <location>https://webservice/fsc</location>
    3. Credentials require for connecting to the URL must be registered in Fabasoft Mindbreeze Enterprise (Advanced / Network / Credentials).
    4. <?xml version="1.0"?>
      <Plugins>

        <version>

        </version>

        <id>Fabasoft Components</id>

        <plugins>

          <Plugin>

            <kind>RESOURCE</kind>

            <extension>

              <Extension>

                <point>
      com.mindbreeze.datasource.CategoryDescriptor</point>
              </Extension>

            </extension>

            <
      resource_path>categorydescriptor.xml</resource_path>
          </Plugin>

          <Plugin>

            <kind>RESOURCE</kind>

            <extension>

              <Extension>

                <point>
      com.mindbreeze.datasource.CategoryIcon</point>
              </Extension>

            </extension>

            <
      resource_path>categoryicon.png</resource_path>
          </Plugin>

          <Plugin>

            <kind>CODE</kind>

            <id>Fabasoft Components</id>

            <extension>

              <Extension>

                <point>
      mindbreeze.security.PrincipalResolutionService</point>
              </Extension>

            </extension>

            <code>
              <Code>

                <platform>WEBSERVICE</platform>

                <location></location>

                <
      os>ANY_OS</os>
                <
      cpu>ANY_CPU</cpu>
                <
      exectype>SANDBOX</exectype>
                <properties>

                  <
      KeyValuePair>
                    <key>
      com.mindbreeze.datasource.category</key>
                    <value>Fabasoft Components</value>

                  </
      KeyValuePair>
                  <
      KeyValuePair>
                    <key>
      com.mindbreeze.datasource.categoryinstance</key>
                    <value>Default</value>

                  </
      KeyValuePair>
                </properties>

              </Code>

            </code>

            <version/>

            <properties>

              <
      KeyValuePair>
                <key>
      com.mindbreeze.datasource.category</key>
                <value>Fabasoft Components</value>

              </
      KeyValuePair>
              <
      KeyValuePair>
                <key>
      com.mindbreeze.datasource.categoryinstance</key>
                <value>Default</value>

              </
      KeyValuePair>
            </properties>

            <
      config_option/>
          </Plugin>

          <Plugin>

            <kind>CODE</kind>

            <id>Fabasoft Components</id>

            <extension>

              <Extension>

                <point>
      mindbreeze.query.security.AuthorizationService</point>
              </Extension>

            </extension>

            <code>

              <Code>

                <platform>WEBSERVICE</platform>

                <location></location>

                <
      os>ANY_OS</os>
                <
      cpu>ANY_CPU</cpu>
                <
      exectype>SANDBOX</exectype>
                <properties>

                  <
      KeyValuePair>
                    <key>
      com.mindbreeze.datasource.category</key>
                    <value>Fabasoft Components</value>

                  </
      KeyValuePair>
                  <
      KeyValuePair>
                    <key>
      com.mindbreeze.datasource.categoryinstance</key>
                    <value>Default</value>

                  </
      KeyValuePair>
                </properties>

              </Code>

            </code>

            <version/>

            <properties>

              <
      KeyValuePair>
                <key>
      com.mindbreeze.datasource.category</key>
                <value>Fabasoft Components</value>

              </
      KeyValuePair>
              <
      KeyValuePair>
                <key>
      com.mindbreeze.datasource.categoryinstance</key>
                <value>Default</value>

              </
      KeyValuePair>
            </properties>

            <
      config_option/>
          </Plugin>

          <Plugin>

            <kind>CODE</kind>

            <id>Fabasoft Components</id>

            <extension>

              <Extension>

                <point>
      mindbreeze.query.context.ContextualizationService</point>
              </Extension>

            </extension>

            <code>

              <Code>

                <platform>WEBSERVICE</platform>

                <location></location>

                <
      os>ANY_OS</os>
                <
      cpu>ANY_CPU</cpu>
                <
      exectype>SANDBOX</exectype>
                <properties>

                  <
      KeyValuePair>
                    <key>
      com.mindbreeze.datasource.category</key>
                    <value>Fabasoft Components</value>

                  </
      KeyValuePair>
                  <
      KeyValuePair>
                    <key>
      com.mindbreeze.datasource.categoryinstance</key>
                    <value>Default</value>

                  </
      KeyValuePair>
                </properties>

              </Code>

            </code>

            <version/>

            <properties>
              <
      KeyValuePair>
                <key>
      com.mindbreeze.datasource.category</key>
                <value>Fabasoft Components</value>

              </
      KeyValuePair>
              <
      KeyValuePair>
                <key>
      com.mindbreeze.datasource.categoryinstance</key>
                <value>Default</value>

              </
      KeyValuePair>
            </properties>

            <
      config_option/>
          </Plugin>

          <Plugin>

            <kind>CODE</kind>

            <id>Fabasoft Components</id>

            <extension>

              <Extension>

                <point>mes.ipc.query.datasource.SearchInResolutionService</point>

              </Extension>

            </extension>

            <code>

              <Code>

                <platform>WEBSERVICE</platform>

                <location></location>

                <
      os>ANY_OS</os>
                <
      cpu>ANY_CPU</cpu>
                <
      exectype>SANDBOX</exectype>
                <properties>

                  <
      KeyValuePair>
                    <key>
      com.mindbreeze.datasource.category</key>
                    <value>Fabasoft Components</value>

                  </
      KeyValuePair>
                  <
      KeyValuePair>
                    <key>
      com.mindbreeze.datasource.categoryinstance</key>
                    <value>Default</value>

                  </
      KeyValuePair>
                </properties>

              </Code>

            </code>

            <version/>

            <properties>

              <
      KeyValuePair>
                <key>
      com.mindbreeze.datasource.category</key>
                <value>Fabasoft Components</value>

              </
      KeyValuePair>
              <
      KeyValuePair>
                <key>
      com.mindbreeze.datasource.categoryinstance</key>
                <value>Default</value>

              </
      KeyValuePair>
            </properties>

            <
      config_option/>
          </Plugin>

          <Plugin>

            <kind>CODE</kind>

            <id>
      AppValidationService</id>
            <extension>

              <Extension>

                <point>
      mindbreeze.query.client.AppValidationService</point>
              </Extension>

            </extension>

            <code>

              <Code>

                <platform>WEBSERVICE</platform>

                <location></location>

                <
      os>ANY_OS</os>
                <
      cpu>ANY_CPU</cpu>
                <
      exectype>SANDBOX</exectype>
                <properties/>

              </Code>

            </code>

            <version/>

            <properties/>

            <
      config_option/>
          </Plugin>

          <Plugin>

            <kind>CODE</kind>

            <id>
      SessionAuthenticateService</id>
            <extension>

              <Extension>

                <point>mindbreeze.query.client.SessionAuthenticationService</point>

              </Extension>

            </extension>

            <code>

              <Code>

                <platform>WEBSERVICE</platform>

                <location></location>

                <
      os>ANY_OS</os>
                <
      cpu>ANY_CPU</cpu>
                <
      exectype>SANDBOX</exectype>
                <properties/>

              </Code>

            </code>

            <version/>

            <properties/>

            <
      config_option/>
          </Plugin>

          <Plugin>

            <kind>CODE</kind>

            <id>
      SessionNotificationService</id>
            <extension>

              <Extension>
                <point>mindbreeze.query.client.SessionNotificationService</point>

              </Extension>

            </extension>

            <code>

              <Code>

                <platform>WEBSERVICE</platform>

                <location></location>

                <
      os>ANY_OS</os>
                <
      cpu>ANY_CPU</cpu>
                <
      exectype>SANDBOX</exectype>
                <properties/>

              </Code>

            </code>

            <version/>

            <properties>

              <
      KeyValuePair>
                <key>BEFORE_START</key>

                <value>true</value>

              </
      KeyValuePair>
              <
      KeyValuePair>
                <key>AFTER_START</key>

                <value>true</value>

              </
      KeyValuePair>
              <
      KeyValuePair>
                <key>BEFORE_END</key>

                <value>true</value>

              </
      KeyValuePair>
              <
      KeyValuePair>
                <key>AFTER_END</key>

                <value>true</value>

              </
      KeyValuePair>
            </properties>

            <
      config_option/>
          </Plugin>

          <Plugin>

            <kind>CODE</kind>

            <id>
      SessionTransformationService</id>
            <extension>

              <Extension>

                <point>mindbreeze.query.client.SessionTransformationService</point>

              </Extension>

            </extension>

            <code>

              <Code>

                <platform>WEBSERVICE</platform>

                <location></location>

                <
      os>ANY_OS</os>
                <
      cpu>ANY_CPU</cpu>
                <
      exectype>SANDBOX</exectype>
                <properties/>

              </Code>

            </code>

            <version/>

            <properties/>

            <
      config_option/>
          </Plugin>

          <Plugin>

            <kind>CODE</kind>

            <id>
      SessionValidationService</id>
            <extension>

              <Extension>

                <point>
      mindbreeze.query.client.SessionValidationService</point>
              </Extension>

            </extension>

            <code>

              <Code>

                <platform>WEBSERVICE</platform>

                <location></location>

                <
      os>ANY_OS</os>
                <
      cpu>ANY_CPU</cpu>
                <
      exectype>SANDBOX</exectype>
                <properties/>

              </Code>

            </code>

            <version/>

            <properties/>

            <
      config_option/>
          </Plugin>

        </plugins>

      </Plugins>
    5. categorydescriptor.xml (category descriptor)
      A Fabasoft Mindbreeze Enterprise category descriptor XML file that controls Fabasoft Mindbreeze Enterprise web browser client behavior. For an example, see…

      <?xml version="1.0" encoding="UTF-8"?>
      <category id="Fabasoft Components">

        <name>Fabasoft Folio</name>

        <metadata>

          <
      metadatum id="objcreatedby" selectable="true">
            <name
      xml:lang="en">Created by</name>
            <name
      xml:lang="de">Erzeugt von</name>
          </metadatum>
          <
      metadatum id="objchangedby" selectable="true">
            <name
      xml:lang="en">Changed by</name>
            <name
      xml:lang="de">Geändert von</name>
          </
      metadatum>
          <
      metadatum id="objsubject" selectable="false">
            <name
      xml:lang="en">Subject</name>
            <name
      xml:lang="de">Betreff</name>
          </
      metadatum>
          <
      metadatum id="documentnumber" selectable="false">
            <name
      xml:lang="en">Document Number</name>
            <name
      xml:lang="de">Dokumentnummer</name>
          </
      metadatum>
          <
      metadatum id="surname" selectable="false">
            <name
      xml:lang="en">Surname</name>
            <name
      xml:lang="de">Nachname</name>
          </
      metadatum>
          <
      metadatum id="firstname" selectable="false">
            <name
      xml:lang="en">First Name</name>
            <name
      xml:lang="de">Vorname</name>
          </
      metadatum>
          <
      metadatum id="orgname" selectable="false">
            <name
      xml:lang="en">Organization</name>
            <name
      xml:lang="de">Organisation</name>
          </
      metadatum>
          <
      metadatum id="street" selectable="false">
            <name
      xml:lang="en">Street</name>
            <name
      xml:lang="de">Straße</name>
          </
      metadatum>
          <
      metadatum id="zipcode" selectable="false">
            <name
      xml:lang="en">Zip Code</name>
            <name
      xml:lang="de">PLZ</name>
          </
      metadatum>
          <
      metadatum id="city" selectable="false">
            <name
      xml:lang="en">City</name>
            <name
      xml:lang="de">Ort</name>
          </
      metadatum>
          <
      metadatum id="objclass" selectable="false" aggregatable="true" visible="true">
            <name
      xml:lang="de">Objektklasse</name>
            <name
      xml:lang="en">Object Class</name>
          </
      metadatum>
        </metadata>

      </category>
    6. categoryicon.png (category icon)
      A 16x16 PNG image file that represents the Fabasoft Folio installation in the Fabasoft Mindbreeze Enterprise web browser client.
  4. Install the plugin in Fabasoft Mindbreeze Enterprise (Advanced / Plugins).