Configuration

Configuration manual for PageSeeder

External integration

Overview

There are two integration approaches supported by PageSeeder:

  1. PageSeeder accessing documents, metadata and permissions created by external applications.
  2. External applications accessing PageSeeder functionality and data via Ant scripts, Java code or direct HTTP requests.

Accessing externally created data

Following are different ways for PageSeeder to process externally created data.

PageSeeder File System

Uploading documents to the PageSeeder File System is possible via the following methods:

  • native operating systems utilities
  • PageSeeder Upload
  • email

For further information see PageSeeder File System.

Web server

If external documents are accessible via a web server, a PageSeeder external filter can be set up as follows:

  1. PageSeeder must be installed on the same web server as the document (this example assumes PageSeeder is installed on port 8080).
  2. Create a PageSeeder Group for the external documents (select Comments visible and addable by public depending on your security requirements).
  3. Select Group Folders and add the entry: http://[servername]:80/*
  4. When accessing the documents, insert :8080/ps/filter after the server name. (e.g. http://www.mycompany.com/test/mydoc.html would become http://www.mycompany.com:8080/ps/filter/test/mydoc.html)
  5. To view the document via the layout manager, insert :8080/ps/page/filter (e.g. http://www.mycompany.com/test/mydoc.html would become http://www.mycompany.com:8080/ps/page/filter/test/mydoc.html)

PageSeeder assumes that the source website is on port 80, unless a port is specified by adding /:[port] after /ps/filter (e.g. http://www.mycompany.com:8888/test/mydoc.xml would become http://www.mycompany.com:8080/ps/filter/:8888/test/mydoc.xml)

If PageSeeder is installed on port 80, omit the PageSeeder port (e.g. http://www.mycompany.com:8888/test/mydoc.xml would become http://www.mycompany.com/ps/filter/:8888/test/mydoc.xml)

External document management system

If the documents can be accessed via a Java API, the PageSeeder FilterURIFetcher class can be customized.

To do this, extend the com.pageseeder.customizable.FilterURIFetcher class and override the getDocument() method. Make sure the new class has the same name as the original PageSeeder class. All the PageSeeder classes are under: \pageseeder\webapp\WEB-INF\classes

Then, uncomment customPackage in \WEB-INF\config\global.properties and set it to the package containing the new class (e.g. com.yourcompany.ps)

NOTE: If PageSeeder uses a Product Key other than 'eval', obtain a new Product Key which includes a new customPackage.

In a similar way, customize:

  • com.pageseeder.customizable.Permissions class for integrating personalized  security.
  • com.pageseeder.customizable.XLinkChanges class for integrating personalized messaging system or search engine.

Accessing PageSeeder functionality from external applications

HTTP API

Integrators can call any of the PageSeeder user, manager or admin options via their servlet URLs. Adding username and password parameters to the URL will automatically authenticate the caller as long as they have a PageSeeder account with the appropriate access. Adding the parameter xformat=xml will return the results as XML in most cases.

For more details on the parameters for any of the servlets see the Servlets API.

External Java API

PageSeeder functions are also available via the external Java API, see Java API .

Created on , last edited on