Public Access Catalog


The OpenProdoc Public Access Catalog (sometimes refered in this documentation with the traditional term OPAC ), allows people external to the company institution to look for in an easy way the documents (or folders) stored in OpenProdoc without the need of an user. Public Access Catalog allows to select the document (or folder) type to search for, to key in the search criteria and select the format to list the results.

The use of the OPAC requires to adjust parameters for and easy use and also for adding security,because we are allowing access to unkown people that could access to confidential documentation or damage something by error or intentionally. The parameters are defined by means of a properties file with the elements defined in the next list. At the end of the page it's include an example (The lines starting by # are comments and are ignored, as the blank lines) :

With the "OPAC" functionality it's possible to create forms as:

OPAC Example

OPAC Example2

This file follows the standard format of the properties files (label/element+"="+Value), with comments ( the lines starting wiith the character '#'). The meaning of each entry (that can't be repeated) is:

The process of parameterizing the OPAC is to create a text file with the indicated parameters (you can use as base the included example and modify it), entering the appropriate values to the installation of OpenProdoc.

It's necessary to modify the configuration file (Prodoc.properties or the name used) and add two lines:

User=User1

Pass=PassUsr1

Where User1 y PassUsr1 would be the data of a user with access to the configuration documents (OPAC y OPAC_CS) described in the next point. It's recommended that the user used had a limited rol and a mimimum of permissions, becaue it's only needed read access to the configuration files. As any other change in the configuration file (Prodoc.properties), dthe server MUST be restarted so it can read the new configuration.

Next, you must create (or modify the included example) the CSS to adapt it to the style of the corresponding institution or company. Then add the CSS to the OpenProdoc repository and note the generated PdId. That PdId is the one that should be referenced as parameter FormSearchCSS in the OPAC configuration file. You should then upload that query configuration file.

With the generated ID, the OpenProdoc url (eg http://localhost:8080/ProdocWeb2/OPAC?Id= + the new document ID uploaded, for example http://localhost:8080/ProdocWeb2/OPAC?Id=566b6464a654-9696e68d686)

For searching folders use the OpenProdoc url (eg http://localhost:8080/ProdocWeb2/OPACf?Id= + the new document ID uploaded, for example http://localhost:8080/ProdocWeb2/OPACf?Id=566b6464a654-9696e68d686)

OpenProdoc will present a page according to the parameters defined in that file, including style sheet, literals, document types, etc. In that page the users, without entering access data (user / password), can choose one of the document types they want to search for, enter words from the content or known metadata, choose the format of the results and search. When the search button is clicked, Openprodoc will connect using the user indicated in the parameterization, will search according to the included criteria and return the results in the chosen format. The format can be html to present with a more aesthetic format, txt or csv for an automatic treatment, or xml to be able to interchange or to process.

Since all appearance is parametrizable, including typologies of documents, metadata, etc., and is aimed at sporadic users, it is reasonable to assume that a personalized help is needed. For that you have a button that will open the html page whose url is indicated in a configuration. It could be an external page or an html document stored in OpenProdoc.

It should be noted that the configuration file, like any Openprodoc document can be edited and versioned, always being used to compose the OPAC the last published version. However the upgrade may take some time, because to improve performance the configuration is not updated immediately.

Since the parameterization is based on one Openprodoc document and the style in another, it is possible to have several parameterizations simultaneously, presenting different document sets, different interface language, different style or different query user. Providing each group of users with the appropriate url (which will only differ in the Document Identifier) many different OPACSs can be simultaneously offered with very little effort.

OPAC Configuration File Example:

#############################################
####                                OPAC                               ####
#############################################
# Names of the types of documents a user could search for
DocTipesList=Article|ECM_Standards|InternetProfile|MusicRecords|Picture
# Metadata/Fields (of any of the document types) internal names that a user can search for
FieldsToInclude=Author|Authors|Keywords|Player|Title|Country|CreativeCommons
# Search / comparison operators. 1 for each metadata. Default is EQ equality
# Possible values = EQ, <> NE, > GT, >= GE, < LT, <= LE, Contains CT
FieldsComp=EQ|EQ|EQ|EQ|CT|EQ|EQ
# Folder below which searches will be performed
BaseFolder=/Examples - Ejemplos
# Search Extended to subtypes of selected document types
Inheritance=1
# Identification codes (PDId) of documents of type PD_REPORTS that will be used to display the results. Must be at least 1.
ResultForm=150c9be080c-3fe46f69eb1b2cb7|150c9be8462-3fd76612bb72fece|15dc854acbf-3fedc1977572a008
# Maximum number of results to be returned. (0 = unlimited)
MaxResults=0
# Code identifier (PDId) of the style sheet (CSS) to be used for the OPAC
FormSearchCSS=15db73b6628-3fee99cd40e27fee
# Url (internal or external) of the image used as logo
FormSearchLogo=img/LogoProdoc.jpg
# User with whom the query will be made
User=Invitado
# Login password of the user with whom the query will be made
Pass=PassInvit
# Search Form Header
Title=OpenProdoc OPAC Example
# Label of the drop-down list of document types to search
DTLabel=Select document type for search
# Full text search field label for documents.
FTLabel=Key in some words for search documents
# Label from the drop-down list of output formats.
FormatLabel=Select results format
# Text of the pop-up help that will be displayed when you are in the document type selection combo box. Can contain html control characters.
HelpForDocType=List of document types you can look for
# Text of the pop-up help that will be displayed when you are in the fulltext search field. Can contain html control characters.
HelpForFullText=Help FullText<br>Please, wriet any word(s) that you now are included in the docuemnts you are lookin for.
# Text of the pop-up help that will be displayed when you are in the report type selection combo box. Can contain html control characters.
HelpForFormatType=Select the tormat you want to receive the results of the search.
# Url pf the complete help page for the configured OPAC
UrlHelp=help/EN/HelpIndex.html

OpenProdoc Help Index