agorum core Liferay integration Version 6.4.5

Transcription

1 agorum core Liferay integration Version Copyright 2010, agorum Software GmbH , Document version 1.0.0

2 Contents 1 Introduction 3 2 Installation 4 3 Configuration The main configuration The user configuration Using the agorum core portlet As a logged in Liferay user As a guest The search syntax

3 Chapter 1 Introduction With the Liferay portlet for the agorum core you are able to integrate a file list view and the search functionality from agorum core into the Lifray portal. 3

4 Chapter 2 Installation To install the agorum core portlet just uplaod the agorum-search-portlet X.war file in the Plugins Installation mask (Install More Portlets - Upload File). Then you can add the installed portlet at any page you want. 4

5 Chapter 3 Configuration 3.1 The main configuration In the main configuration (Preferences) for the agorum core portlet the following configuration parameters have to be set: Parameter URL to the agorum core Webservice Url to agorum core Server Static agorum core User Password Start folder id Description This defines the URL to the agorum core server from the Liferay host. This defines the URL to the agorum core server from the user. This defines the user that should be used for not logged in Liferay users. This defines the password for the user that should be used for not logged in Liferay users. This defines the folder id of the root folder for the file list. 5

6 Chapter 3 Configuration Figure 3.1: The main configuration 3.2 The user configuration When a logged in Liferay user access the agorum core portlet the first time, he will be ask for his account data to agorum core. The account data for agorum core must be available for the portlet to work. Figure 3.2: The user configuration 6

7 Chapter 4 Using the agorum core portlet 4.1 As a logged in Liferay user A logged in Liferay user has serveral posibilities to use the agorum core portlet. In the file and search list the following actions are available: Action (icon) Description Open this folder in the local Windows Explorer. Open this folder or mail in in the agorum core webportal. Open and edit this document with the corresponding, local application. Open the object info mask for this document in the agorum core webportal. View this document as a PDF. Figure 4.1: The user file list 7

8 Chapter 4 Using the agorum core portlet Figure 4.2: The user search list 4.2 As a guest Figure 4.3: The guest file list A not logged in Liferay user or visitor (Guestuser) will only have the following action: 8

9 Chapter 4 Using the agorum core portlet Action (icon) Description View this document as a PDF. Figure 4.4: The guest search list 4.3 The search syntax Using the search engine is - depending on how detailed you want to search - a little more complex. Here some facts about how to use the search engine: It is not case sensitive. So it doesn t make a difference whether you search for Demo or for demo The AND (capital letters) operator is optional. Example: who are you would give the same results as who AND are AND you You can use the word OR (capital letters) to search for several words, which not necessarily have dependencies to each other. Using the word OR always goes with brackets around the expression. Example: (steve OR philipp) 9

10 Chapter 4 Using the agorum core portlet You are allowed to put parts of the expression into another pair of brackets. Example: ((steve miller) OR (philipp coleman)). In this case you would search for results containing steve and miller or philipp and coleman. There is an operator called NOT (capital letters). You can use NOT to exclude certain search words. Example: ((steve miller) AND NOT (philipp coleman)) Speacial characters such as +, -, &,,!, (, ), {, }, [, ], ^, ~, *,?, :, \ and " have to be masked by using \ with each special character. Example: what are you looking for\? You can do similarity search by using ~ at the end of the word. Example: theater~ to get both theater (American English) and theatre (British English) Search for words in a special order can be done by using the character " around the expression. Example 1: "in this order". The results here would contain the expression exactly in the way it s written. Example 2: "test phase"~5. The results here would contain the words in the order of the expression and the words can have a maximum of 5 other words in between. You can exclude words within the documents you want to find. Example: task -done. This expression would give you all tasks, which are not done yet. The relevance of a search word can be important 10