Installation

Fabasoft Mindbreeze Enterprise

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 Enterprise

The web service based 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 . Be sure to configure a User with Access to Integration Web Service.
3. Prepare a Fabasoft Mindbreeze Enterprise plugin ZIP archive that contains the following files:
   Note: If the installation uses a different category to isolate multiple independent Fabasoft Folio installations that share a Mindbreeze Enterprise installation, the name of the ZIP archive and the IDs of plugins (Plugin/id) must not match that of other Fabasoft Folio installations. Additionally, the default category “Fabasoft Components” must be changed to the configured category in the plugin resources.
   • 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:
     <location>https://<hostname>/<vdir>/mesapi</location>
     Credentials required for connecting to the URL must be registered in Fabasoft Mindbreeze Enterprise (Advanced / Network / Credentials) and assigned to a new endpoint (Advanced / Network / Endpoints) corresponding to the web service.
     The plugin SessionValidationService is not required in case of a Fabasoft Cloud installation.
     
     <?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>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>
   • 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>
   • 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).