2024 Update Rollup 2

Fabasoft Folio Portlet ConfigurationPermanent link for this heading

The following chapters describe the Fabasoft Folio Portlet configuration.

How to Change Configuration FilesPermanent link for this heading

All the following configurations need to be done in the unpacked fscportlet.war. After you unzip the file and completed your changes, you need to create a new WAR file and copy it into the deploy folder.

To create a WAR file with the Java Development Kit, perform the following steps:

  1. Open a command prompt.
  2. Navigate to the folder containing the unpacked WAR file.
  3. Execute the following command to create a new WAR file (make sure that the JDK jar command is available in the path or use the fully-qualified path for the command):
    jar -cvf fscportlet.war *
  4. Copy the created WAR file into the deploy folder of the Tomcat installation.
  5. After deploying the new portlet, all existing portlet instances have to be removed and re-added.

Anonymous Access (Proxy User / Concurrent User License)Permanent link for this heading

If write access is required, and a concurrent user license is in use, a proxy user can be configured by means of a Login Name (COOSYSTEM@1.1:userlogname). A single specific user can be configured in the portlet.xml.

<portlet>
  <portlet-preferences>
    <preference>
      <name>fabasoft.server.anonymoususerlogname</name>
      <value>projectspecificlogname</value>
    </preferences>
  </portlet-preferences>
</portlet>

The user with this Login Name (COOSYSTEM@1.1:userlogname) must have a user environment (COOSYSTEM@1.1:userenvirons) assigned. All requests originating from a Fabasoft Folio Portlet are being processed in the context of this domain user if the portal user is not logged in to the portal server.

Note:

  • As this user has write access to the system any persistent changes may affect all other anonymous users.
  • A concurrent user license is required (for details see the license agreement).
  • Virtual applications like the desk require a defined proxy user for anonymous access. Otherwise an error message “java.io.IOException: Server returned HTTP response code: 500” is displayed.

Group Login NamePermanent link for this heading

By default, the Fabasoft Folio Portlet searches for a group in the Fabasoft Folio Domain with a group login name matching the host and port component of the URL the portal was accessed with (e.g. in case of http://host:port/path, the group login name is host:port). The group represents the given portal, all users created via user synchronization are members of the group.

To enforce a static group login name independent from the request URL, the group login name can be configured in the portlet.xml.

<portlet>
  <portlet-preferences>
    <preferences>
      <name>fabasoft.liferay.identifier</name>
      <value>projectspecificgrouplogname</value>
    </preferences>
  </portlet-preferences>
</portlet>

CertificatesPermanent link for this heading

The <cacertificate> file, the certificate of the certification authority, is required.

In a Linux environment the cert.pem and the key.pem files are required. cert.pem is the certificate for the web server. key.pem is the private key for the certificate.

In a Microsoft Windows environment a X.509 server certificate is necessary.

To see how to create a truststore.jks file refer to the documentation of Sun Microsystems http://java.sun.com/j2se/1.3/docs/tooldocs/win32/keytool.html: new window.

In the portlet.xml file the following changes have to be taken:

  • Under <portlet-app><portlet><portlet-preferences><preference> <name>fabasoft.auth.keystorepath</name> type the path of the certificate in the <value> tag.
  • Under <portlet-app><portlet><portlet-preferences><preference> <name>fabasoft.auth.keystorepass</name> type the password of the certificate in the <value> tag.
  • Under <portlet-app><portlet><portlet-preferences><preference> <name>fabasoft.auth.truststorepath</name> type the path of the truststore.jks file in the <value> tag.
  • Under <portlet-app><portlet><portlet-preferences><preference> <name>fabasoft. .auth.truststorepass</name> type the password of the truststore.jks file in the <value> tag.

Note:

  • The path must not end with “/”.
  • The settings in portlet.xml are read once when a Fabasoft Folio Portlet is added to a web page. So if you change settings in portlet.xml (e.g. the certificate) you have to remove the portlet from the page and add it again.

Portlet TitlePermanent link for this heading

By default, the title is “Fabasoft Folio Portlet”. It can be configured in the portlet.xml by changing the portlet-info tag.

<portlet>
  <portlet-info>
    <title>Fabasoft Folio Portlet</title>
  </portlet-info>
</portlet>

Error MessagePermanent link for this heading

If no connection to the Fabasoft Server can be established, by default the error message “<portlet title> is temporarily unavailable.” (e.g. “Fabasoft Folio Portlet is temporarily unavailable.”) is displayed. This message can be also configured in portlet.xml. The key of the related preference is called fabasoft.portlet.errormsg  or fabasoft.portlet.errormsg.<language> (e.g. fabasoft.portlet.errormsg.en) for a language specific message.

<portlet>
  <portlet-preferences>
    <preference>
      <name>fabasoft.portlet.errormsg.en</name>
      <value>This e-service is not available.</value>
    </preferences>

    <preference>
      <name>fabasoft.portlet.errormsg.de</name>
      <value>Dieses E-Service ist nicht verfügbar.</value>
    </preferences>
  </portlet-preferences>
</portlet>

Settings of the Fabasoft Folio PortletPermanent link for this heading

The following settings can be configured via the “Preferences” of a Fabasoft Folio portlet.

  • Host
    In this field the URL of the Fabasoft Folio web server has to be defined. For example, http://webserver/fsc.
  • Parameters
    In this field the virtual application, which should be displayed in the Fabasoft Folio portlet, has to be specified. For example, ax=COO.1.1001.1.240419.
  • Portlet Width
    In this field the width of the portlet can be defined in pixels. By default, the portlet is 600 pixels wide.
  • Portlet Height
    In this field the height of the portlet can be defined in pixels. By default, the portlet is 300 pixels high.
  • CSS Class
    In this field an own CSS class can be defined for the portlet. So, it is possible to define portlet specific CSS styles.
  • Use Anonymous User
    Select this check box, if the portlet should be executed as anonymous user, even for logged in users.
  • Display error on session expiration
    Select this check box, if the portlet should only be accessible for logged in users. Make sure that the “Use Anonymous User” check box is not selected.

Session ReplicationPermanent link for this heading

To enable session replication for the Fabasoft Folio Portlet make sure that the web.xml of the portlet contains the <distributable/> tag.

Configure a Special User for Calling a Friendly URL in Fabasoft FolioPermanent link for this heading

The user who is used to call a friendly URL in Fabasoft Folio via the FscHttpServlet can be configured with an XML file. The path to the configuration XML file is specified in web.xml.

<servlet>
  <servlet-name>FscHttpServlet</servlet-name>
  <servlet-class>com.fabasoft.portlet.tools.FscHttpServlet</servlet-class>
  <load-on-startup>1</load-on-startup>
  <init-param>
    <param-name>config</param-name>
    <param-value>/WEB-INF/servlet-fschttpservlet.xml</param-value>
  </init-param>
</servlet>

The XML configuration (servlet-fschttpservlet.xml) defines entries for the friendly URLs that should be executed in context of the defined user.

In the following example the friendly URLs *./cmis$ and .*/demo$ are executed with the users who have the login strings 890@liferay and demo.

Example:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd">
<properties>
  <entry key=".*/cmis$">890@liferay</entry>
  <entry key=".*/demo$">demo</entry>
</properties>

Download PDF

Download PDF