test

Sun Java System Portal Server 7.1 Technical Reference

Part I Attributes

Chapter 1 Desktop Service

This chapter contains the following sections:

Introduction

The Desktop Service consists of global and dynamic attributes. The values applied to the global attributes are applied across the Sun Java System Sun Java System Access Manager configuration and are inherited by every configured organization. They cannot be applied directly to roles or organizations as the goal of global attributes is to customize the Sun Java System Access Manager application. Values applied to the dynamic attributes are assigned to a role or organization. When the role is assigned to a user or a user is created in an organization, the dynamic attribute then becomes a characteristic of the user.

Desktop Global Attributes

This section describes the global attributes for the Desktop Service.

The table below describes the desktop service global attributes and their description.

Table 1–1 Desktop Service - Global Attributes

Attribute 

Default Value 

Description 

XML Parsing Validation 

Enable (selected) 

Specifies whether to enforce validation while parsing the display profile XML document. Not selecting this attribute can improve system performance. However, this can potentially introduce corruption in the display profile document because the resulting XML document might include some fragments that do not conform to the DTD (Document Type Definition). 

Federation 

Disable (not selected) 

Enables Identity Federation so that a user can associate, connect or bind multiple internet service providers’ local identities, enabling them to have one network identity. 

Hosted Provider ID 

None 

Specifies the unique identifier of the host that provides the network identity of a user. 

Session Reap Interval 

1800 

Defines in seconds the time interval between checks for removing inactive client sessions. 

Session Idle Time 

3600 

Specifies the maximum number of seconds a client session can be idle before it is considered inactive. If a session is idle for more than this value, it is made a candidate for session reaping and can be removed the next time the client session times out. 

Maximum number of Sessions 

1000000 

Number of authless users can be supported by the Portal Server deployment. 

DisplayProfile Priority 

The default value depends on the type of installation performed. If the sample portal is installed, the DisplayProfile contains the definitions for the built-in providers (the basic providers of Portal Server), such as bookmark and notes. If the sample portal was not installed, the global DisplayProfile value is blank or zero. 

Displays several controls for manipulating the global display profile, an XML document that defines the container management, channel attributes, and provider definitions for the organization. The controls include: 

  • Disable Authentication-less Access for Federated Users--Prevents a user with a federated network identity to access the portal without entering a user name and password.

  • Upload XML--Allows you to upload an XML file containing display profile information to the Portal Server.

  • Download XML--?Allows you to download the display profile to your local drive.

  • Parent and Edit Container Management--Provides a graphical user interface to manage container channels and channels without the need to edit the XML file.

    These links are not attributes. Selecting these links allows you to manipulate the display profile.

    Display profile elements defined in the global display profile are inherited by all users on the system, regardless of the organization or role to which they belong.

Anonymous Desktop 

Enable (selected) 

If this value is Enabled, it lists the valid UID's and their passwords for the Anonymous Desktop. Displays several controls for configuring authentication-less configuration of the portal desktop. The controls are: 

  • Add-Click the Add button to add a User DN (Distinguished Name) to the existing list.

  • Delete-From the list of available DNs, select the User DN. Click the Delete button to delete the selected User DN from the list.

  • Set as Default-Select a User DN from the list by selecting the corresponding checkbox. Click the set as Default button to make the selected User DN as a default.

Desktop Dynamic Attributes

This section describes the dynamic attributes for the Desktop Service.

The table below describes the desktop service dynamic attributes and their description.

Table 1–2 Desktop Service - Dynamic Attributes

Attribute 

Default Value 

Description 

COS Priority 

Highest 

Sets the conflict resolution level for the Desktop service template used to resolve conflicts when multiple Desktop templates are merged. There are seven conflict resolution settings available ranging from Highest to Lowest. 

Do not confuse this setting with the display profile document priority. The display profile document priority is a numeric value that is set in the XML file with the priority= syntax tag. When a merge occurs, it starts with the lowest display profile priority document (lowest number) and proceeds in increasing priority number, until it arrives at the user (base), the highest priority display profile. 

When an attribute conflict occurs, the attribute on the template set with the highest conflict resolution level is returned. 

Parent Container 

DefaultChannel 

Identifies which default channel is rendered when the Desktop is called with an unspecified provider. 

Edit Container 

JSPEditContainer 

Specifies which default edit channel to use to wrap the content when one is not specified in the URL. When a channel is edited, an “Edit” request URL is sent to the Desktop Servlet. The URL generated for the “Edit” of each of the channels inside a container depends on the property “editContainerName” defined in the display profile. 

If you have migrated containers from iPlanet™ Portal Server 3.0, you must specify the default edit channel with which to wrap the content using this attribute because the URL format has changed. 

Desktop Type 

default 

Retrieves template files for the specified Desktop type when different Desktop configurations are needed and when different sets of templates and JSPs are required for those configurations. 

The Desktop type attribute of the Desktop service is a comma-separated string type, that the Portal Desktop uses as an ordered list. The list is used by the Desktop lookup operation when searching for templates and JSPs. The lookup starts at the first element in the list and each element represents a subdirectory under the Desktop template base directory. If a template is not found in the first directory, then it proceeds to the next one in the list. This continues until the item is found (or not), for all Desktop type elements in the list. 

If the default directory is not included in the list, it will be added at the end of the list implicitly. For example, if the Desktop type is sampleportal, the target template will be searched in the sampleportal subdirectory, then the default subdirectory. By default, if the sample portal is installed, then the Desktop type attribute, sunPortalDesktopType, is set to sampleportal. If the sample portal is not installed, then the Desktop type attribute value is set to default.

Most sites will not use the default Desktop type, as they will have different channels, different logo, different look and feel, and the like. 

Desktop Attributes 

Show (selected) 

Specifies whether the Desktop Service attributes are displayed to the users associated with the role. This dynamic attribute is mainly used for role-based delegated administration, Values applied to this attribute are only in effect for a role. 

When the role is assigned to a user and the value of this attribute is false, users (usually delegated administrators) cannot see any Desktop Service attributes except the Channel and Container Management link when they navigate into all the roles within the organization.

DisplayProfile Priority 

The default value depends on the type of installation performed. If the sample portal was installed, a sample display profile document is installed at the organization level that contains channels that display the built-in providers defined in the global display profile. 

Displays several links for manipulating the display profile, an XML document that defines the container management, channel attributes, and provider definitions for this specific node (role, organization, suborganization). Links are: 

  • Edit XML--Allows you to edit the entire display profile XML file.

  • Upload XML--Allows you to upload an XML file containing display profile information to the Portal Server.

  • Download XML--Allows you to download the display profile to your local drive.

    These links are not attributes. Selecting these links allows you to manipulate the display profile.

Chapter 2 Rewriter Service

The Rewriter service provides a Java class library for rewriting URI (Uniform Resource Identifier) references in Web languages such as HTML, JavaScript, and WML (Wireless Markup Language), and in HTTP Location headers (redirections). For example, the Rewriter rewrites relative URIs of image tags so that the browser requests the images from the appropriate server. The Rewriter also functions in the Portal Gateway. For example, the Rewriter rewrites HTML links to provide access to an internal server. The Rewriter service is available as a Rewriter Rulesets tab listed in the Secure Remote Access (SRA) feature in the Portal Server Administration console.

The topics in this chapter that describe the Rewriter Service are:

Rewriter Tab Tasks

You can perform the following tasks from the Rewriter tab in the Gateway Profile menu bar:

ProcedureTo Enable Rewriting of All URIs

  1. Select the Enable option in the Rewriting of All URIs attribute to enable the Gateway and to rewrite all URIs.

  2. Click Save to record the change.

ProcedureTo Specify the URIs Not to Rewrite

Before You Begin

The prerequisite to map a URI to a Ruleset, to specify MIME (Multi Purpose Internet Mail Extensions) mappings, to specify the URIs not to rewrite, and to configure Rewriter proxies, specify one or more configuration attributes. See the http://docs.sun.com/app/docs/coll/1303.1 for more information on configuration attributes.

  1. Navigate to the URIs Not to Rewrite attribute, and specify the URI in the text box.

  2. Click Add to add the URI in the URIs Not to Rewrite list.

  3. Click Save to record the change.

ProcedureTo Map a URI to a Ruleset

  1. Navigate to the Map URIs to RuleSets attribute and map a URI to the appropriate RuleSet.

  2. Click Save to record the change.

ProcedureTo Specify MIME Mappings

  1. Navigate to the Map Parser to MIME Types field, and map a Parser to the appropriate MIME type.

  2. Click Save to record the change.

ProcedureTo Configure Rewriter Proxies

  1. Select the Enable option in the Rewriter Proxy attribute to enable the Rewriter proxy.

  2. Specify the Rewriter Proxy value in the Rewriter Proxy List attribute text box.

  3. Click Add to add the value in the Rewriter Proxy List.

    Note –

    The Rewriter Proxy attribute is available in the Rewriter Proxy and Netlet Proxy option in the Deployment tab of Gateway Profile.

  4. Click Save to record the change.

Rewriter Rulesets

Rewriter Rulesets is a service, which is available as the Rewriter Rulesets tab in the Secure Remote Access tab of Portal Server Administration console. When you click the tab, the Rewriter Rulesets page is displayed. The Rewriter Rulesets page lists the available rulesets in the Gateway. Each ruleset is a file that defines how the contents in a Web page should be rewritten by the Rewriter attributes. You can download an existing ruleset, upload a new ruleset to the list, and delete an available ruleset from the list. You can perform these tasks as follows:

ProcedureTo Download a Ruleset

Before You Begin

The prerequisite to perform these tasks is to specify one or more configuration attributes . See the http://docs.sun.com/app/docs/coll/1303.1 for more information on configuration attributes.

  1. Select a ruleset from the Gateway Rulesets list.

  2. Click Download.

    You can save the ruleset or open and view in the default Web browser.

ProcedureTo Upload a Ruleset

  1. Click Upload New.

    The Upload New Ruleset page displays.

  2. Click Browse to choose the ruleset to upload.

  3. Click Upload.

ProcedureTo Delete a Ruleset

  1. Select a ruleset from the Gateway Rulesets list.

  2. Click Delete.

Chapter 3 Search Attributes: Server

This chapter explains the attributes listed in the Search Servers page. The following section introduces the Search Server attributes and describes the attributes in Search Server Settings.

Introduction

When you select Search Servers tab in the Portal Server console, the Search Servers page appears. This page lists the existing Search Servers. To view an existing Search Server, click on the search server name. The Search Server Settings page for the selected Search Server is displayed.

Table 3–1 Server Settings Attributes

Attribute 

Default Value 

Description 

Root 

 
/var/opt/SUNWportal/
searchservers/search1

Houses the configuration, log, database, and robot information files. Also it is the root directory for all of the search files that are generated and updated when conducting a search. This is not configurable. 

Document-Level Security 

off 

Controls who can access documents. 

When this setting is changed, the server must be restarted. 

Values: 

  • off (default) — all users have access to the RDs (Resource Description).

  • on — the ReadACL field in an RD is selected to see if the user asking for the RD has permission because the user is in an acceptable organization or role, or is an acceptable individual user. The ReadACL field is set in the Edit page for a Resource Description.

ID 

ID of the selected search server 

Displays the ID of the search server that you selected. 

URL 

http://HOST:PORT/search server name

Displays the URL of the search server that you selected. 

Chapter 4 Search Attributes: Robot

This chapter explains about the attributes available in the Search Robot. The properties for the robot are quite complex. You can select the sites to be searched, check to see if a site is valid, define what types of documents should be picked up, and schedule when the searches take place.

This chapter contains the following sections:

Status and Control

The Robot Overview panel is where you can see what the robot is doing. If it is Off, Idle, Running, or Paused; and if it is Running, what progress it is making in the search since the panel is refreshed about every 30 seconds. The refresh rate is defined using the robot-refresh parameter in the search.conf file.

If the robot is Off, the buttons are Start and Clear Robot Database . The Start button is at the top and the Clear Robot Database button is at the bottom of the panel. If the robot is Running or Idle, the two buttons are Stop and Pause. If it is Paused, the two buttons are Stop and Resume. By selecting on any of the Attributes, you go to the Reports section where you can get a detailed up-to-the-minute report of that Attribute.

The table below lists the Robot Overview attributes and their description.

Table 4–1 Robot Overview Attributes

Attribute 

Default Value 

Description 

The Robot is 

Current activity 

The Robot’s state. Value can be Idle, Running, Paused, or Off 

Last Updated at 

Date and time last refreshed. 

This page is refreshed to keep you aware of what progress the robot is making. 

Starting Points 

Number defined 

Displays the sites that the robot crawls to generate resource descriptions. The robot does not index resources from disabled sites. 

URL Pool 

Number URLs waiting 

Number of URLs (Uniform Resource Locator) yet to be investigated. When you begin a search, the starting point URLs are entered into the URL pool. As the search progresses, the robot discovers links to other URLs. These URLs get added to the pool. After all the URLs in the pool have been processed, the URL pool is empty and the robot is idle. 

Extracting 

Number connections per second 

Number of resources looked at in a second. 

Extracting is the process of discovering or locating resources, documents or hyperlinks to be included in the database and filtering out unwanted items. 

Filtering 

Number URLs rejected 

Total number of URLs that are excluded. 

Indexing 

Number URLs per second 

Number of resources or documents turned into a resource description in a second. 

Indexing is the phase when all the information that has been gathered on a document is turned into a resource description for inclusion in the search database. 

Excluded URLs 

Number URLs excluded by filters 

Number of URLs that did not meet the filtering criteria. 
 

Number URLs excluded by errors 

Number of URLs where the robot encountered errors as file not found. 

Resource Descriptions 

Number RDs contributed 

Number of resource descriptions added to the database. 
 

Number Bytes of RDs contributed 

Number of bytes added to the database. 

General Stats 

Number URLs retrieved 

Number of URLs retrieved during run. 
 

Number Bytes average size of RDs 

Average number of bytes per resource description.

 

Time in days, hours, minutes, and seconds running 

The amount of time the robot has been running. 

Sites

When you click the Sites tab, the Manage Sites page is displayed. This page displays the list of Site Names and the Status of each site (enabled or disabled) that the robot crawls to generate resource descriptions. When you select the checkbox, the Delete, Enable, and Disable buttons become active. Select the Delete button to delete a selected site. You can enable or disable the selected site by clicking the Enable or Disable buttons. A disabled site is not searched when the robot is run.

The table below provides the attributes and their description in the Manage Sites page.

Table 4–2 Manage Sites Attributes

Attribute 

Default Value 

Description 

Lock or cluster graphic 

Status of site 

Lock open means that the URL is accessible. The closed lock means that the site is a secure web server and uses SSL. The cluster means that the site is a domain. 

Enabled/Disabled 

Enabled 

Choose to search this site or not when the robot is run. 

You can create a new site, by clicking the New button. When you click the New button, the New Robot Site page appears. This page allows you to set up a new Robot site. The table below provides the attributes available in the New Robot Site page and their description.

Table 4–3 New Robot Site Attributes

Attribute 

Default Value 

Description 

Type 

URL 

Select URL or Domain from the list box. 

Site 

Blank 

If you have selected the Type as URL, enter the URL of the site you want to create. The URL format is: http://www.sesta.com

If you have selected the Type as Domain, enter the domain of the site you want to create. The Domain format is: *.sesta.com

Depth 

10 

You have a choice of 1 for this URL only, 2 for this URL and first links, 3 - 10, 100 or unlimited. The default value is set in the Robot —> Manage Properties page. 

Destination Database 

Use Internal Default 

Select the database that you want to use from the list box showing the available databases. 

Click on the Site name to navigate to the Edit a Site page. You can use this page to define the search site more completely. You can specify what type of server it is, redefine the depth of the search, and select what type of files to add to the search database. The attributes for URL and Domain sites are mostly the same. The additional column in this table shows which attributes are shared and which are unique.

You can verify the server name for the search site you entered. In the Server Group section, click the New button to add more servers to the server group. In the Starting Points section, click the New button to add more starting points. In the Filter Definition section, you can add or delete, exclude or include certain types of files as well as change the order the filters for these files are applied.

The table below provides the attributes and their description in the Edit a Site page.

Table 4–4 Edit a Site Attributes

Attribute 

URL/ Domain  

Default Value 

Description 

Site Name 

URL/D 

Site entered - www.sesta.com

Name of the web site 

Server Group - Name 

URL 

URL - www.sesta.com

Is either a single server or a part of a single server. The entry must include the full host name. If you specify just a host name, the site is limited to that host. If you provide directory information in addition to the host name, the site is defined as only that directory and any of its subdirectories. 

Checkbox to select Server Group for deletion or verification 

URL 

Unselected 

Unselected — Does not delete or verify the Server Group 

Selected — Deletes or verifies the Server Group 

Port 

URL/D 

80 for URL; blank for Domain 

If the site you are searching uses a different port, enter it here. 

Type 

URL 

Web Server 

Web Server, File Server, FTP Server, Secure Web Server 

Allowed Protocols 

D 

All selected 

Checkboxes for http, file, ftp, https 

Starting Points- Checkbox to select site for deletion 

URL/D 

Unselected 

Unselected 

Selected 

Starting Points- URL 

URL/D 

http://URL:80

URL or domain 

Starting Points - Depth 

URL/D 

10 

1 - this URL only 

2 - this URL and first links 

3-10 

100 

unlimited 

Filter Definition - Checkbox to select file type for deletion 

URL/D 

Unselected 

Unselected 

Selected 

Filter Definitions 

URL/D 

In this order, the defaults are Archive Files; Audio Files; Backup Files; Binary Files; CGI Files; Image Files; Java, JavaScript, Style Sheet Files; Log Files; Revision Control Files; Source Code Files; Temporary Files; Video Files. 

The possible choices are Archive Files; Audio Files; Backup Files; Binary Files; CGI Files; Image Files; Java, JavaScript, Style Sheet Files; Log Files; Power Point Files; Revision Control Files; Source Code Files; Temporary Files; Video Files; Spreadsheet Files; Plug-in Files; Lotus Domino Documents; Lotus Domino OpenViews; System Directories (UNIX); System Directories (NT). 

DNS Translation 

URL/D 

Blank 

The DNS translation modifies the URL and the way it is crawled by replacing a domain name or alias with a cname. Select the available databases that you want to use from the box.

Description 

URL/D 

Blank 

Description for the site that you had created. 

Destination Database 

URL/D 

Use Internal Default 

Select the available databases that you want to use from the list box. 

Domain Group — Name 

D 

Domain entered. For example, *.sests.com

Name of the domain. 

Checkbox to select Domain Group for deletion 

D 

Unselected 

Unselected 

Selected 

Filters

    Under the Filters tab, there is a Manage Filters page, which lists all the defined Filter Rules, Status of each Filter Rule, Default value for New Site, and Used in Sites. Each Filter Rule is preceded by a checkbox. To delete a Filter Rule, you need to select the corresponding checkbox and click the Delete button. To create a new filter:

  1. Click the New button.

    The New Robot Filter Wizard appears. As a first step, the Specify Filter Name and Description page is displayed.

  2. Enter the filter name in the Filter Name text box.

  3. Enter the description for the filter in the Filter Description text box.

  4. Click the Next button.

    The Specify Filter Definition and Behavior page appears. This page provides the Filter Definition — Matching Rules section. The table below lists the attributes and their description provided in the Filter Definition and Behavior section.

  5. Click the Finish button.

Table 4–5 Filter Definition and Behavior Attributes

Attribute 

Default Value 

Description 

Filter Source 

URL 

Choose an option from the list box to specify the source of the filter. The available values are: URL, protocol, host, path, and MIME type. 

Filter By 

is 

Choose an option from the list box to specify the how you want to filter the source. The available values are: is, contains, begins with, ends with, and regular expression. 

Filter String 

Blank 

You can enter the string to define the filter. 

Filter Default 

Selected 

Assign this filer to new sites when they are created. 

Filter Behavior 

Exclude documents that match this filter when Robot runs 

The default option excludes documents that match this filter when robot runs. The other unselected option includes documents that match this filter when Robot runs. 

Click on the Filter Rule to navigate to the Edit a Filter page. The table below lists the attributes and their description in the Edit a Filter page. The default value for these attributes are same as provided in the previous table.

Table 4–6 Edit a Filter Attributes

Attribute 

Description 

Filter Name 

A descriptive name that reflects the type of file the filter applies to. 

Drop down list of Filter Sources 

URL, protocol, host, path, MIME type 

Drop down list of positions 

is, contains, begins with, ends with, regular expression 

Text box for type (directory, protocol, file extensions) specifics 

In this text box, list what you want to match. What would match in this example - http://docs.sesta.com/manual.html

protocol is http; host contains sesta; file ends with html. 

Filter Description 

Describe the filter rule for yourself. The robot does not use it. 

Filter Default 

Use this as one of the default filters when creating new sites. If you do not check this, you can still add this filter to a new site by editing the site on the Robot, Sites page. 

Filter Behavior 

This attribute provides two options: Exclude documents that match this filter when Robot runs. 

Include documents that match this filter when Robot runs. 

By default, the first option is selected. 

Properties

Click the Robot —> Properties tab. The Manage Properties page appears. The settings on this page control the robot’s operational parameters and defaults. It is divided into these sections: Crawling Speed, Completion Actions, Logfile Settings, Standard Compliance, Authentication Parameters, Proxy Settings, Link Following, Advanced Settings, and Indexing Settings.

The table below lists the attributes and their description in the Manage Properties page.

Table 4–7 Manage Properties Attributes

Attribute 

Default Value 

Description 

Server Delay 

No Delay 

No Delay (default), 1 second, 2 seconds, 5 seconds, 10 seconds, 30 seconds, 1 minute, 5 minutes. 

Maximum Connections - Max concurrent retrieval URLs 

8 

1, 2, 4, 8 (default), 10, 12, 16, 20. 

Maximum Connections per Site 

2 

(no limit), 1, 2, 4, 8, 10, 12, 16, 20. 

Send RDs to Indexing every 

30 minutes 

3 minutes, 5 minutes, 10 minutes, 15 minutes, 30 minutes (default), 1 hour, 2 hours, 4 hours, 8 hours. 

Script to Launch 

nothing 

nothing (default). For sample files, see the cmdHook files in the /opt/SUNWportal/samples/robot directory (for the default installation).

After Processing all URLs 

go idle 

go idle (default), shut down, start over. 

Contact Email 

Blank 

Enter your own. 

Log Level 

1 Generation 

0 Errors only; 1 Generation (default); 2 Enumeration, Conversion; 3 Filtering; 4 Spawning; 5 Retrieval 

User Agent 

SunONERobot/6.2 

Version of the search server. 

Ignore robots.txt protocol 

No 

Some servers have a robot.txt file that says robots do not come here. If your search robot encounters this file on a site and this attribute is false, it does not search the site. If this attribute is true, the robot ignores the file and searches the site.

Perform Authentication? 

Yes 

Yes 

No 

Robot Username 

Blank 

Robot uses the anonymous user name to gain access to a site. 

Password 

Blank 

Frequently a site that allows anonymous users requires a email address as a password. This address is in plain text. 

Proxy Username 

Blank 

Robot uses the anonymous user name to gain access to a site. 

Password 

Blank 

Frequently a site that allows anonymous users requires an email address as a password. This address is in plain text. 

Proxy Connection Type 

Proxy — Manual Configuration 

Direct Internet Connection, Proxy--Auto Configuration, Proxy--Manual Configuration 

Auto Proxy Configuration Type 

Local Proxy File 

Local Proxy File, Remote Proxy File 

Auto Proxy Configuration Location 

Blank 

The auto proxy has a file that lists all the proxy information needed. 

An example of a local proxy file is robot.pac. An example of a emote proxy file is http://proxy.sesta.com:8080/proxy.pac

Manual Proxy Configuration HTTP Proxy 

Host Name:Port 

Format: server1.sesta.com:8080. These three manual configuration values are put in the robot.pac file in the 

/var/opt/SUNWportal/searchservers/
search1/config

directory. 

Manual Proxy Configuration HTTPS Proxy 

Host Name:Port 

This manual configuration value is put in the robot.pac file.

Format: server1.sesta.com:8080

Manual Proxy Configuration FTP Proxy 

Host Name:Port 

This manual configuration value is put in the robot.pac file.

Format: server1.sesta.com:8080

Follow Links in HTML 

Yes 

Extract hyperlinks from HTML 

maximum links 

1024 

Limits the number of links the robot can extract from any one HTML resource. As the robot searches sites and discovers links to other resources, it could conceivably end up following huge numbers of links a great distance from its original starting point. 

Follow Links in Plain Text 

No 

Extract hyperlinks from plain text. 

maximum links 

1024 

Limits the number of links the robot can extract from any one text resource. 

Use Cookies 

No 

If checked, the robot uses cookies when it crawls. Some sites require the use of cookies in order for them to be navigated correctly. The robot keeps its cookies in a file called cookies.txt in the robot state directory. The format of cookies.txt is the same format as used by the Netscape™ Communicator browser.

Use IP as Source 

Yes 

In most cases, the robot operates only on the domain name of a resource. In some cases, you might want to be able to filter or classify resources based on subnets by Internet Protocol (IP) address. In that case, you must explicitly allow the robot to retrieve the IP address in addition to the domain name. Retrieving IP addresses requires an extra DNS lookup, which can slow the operation of the robot. If you do not need this option, you can turn it off to improve performance. 

Enable Smart Host Heuristics 

No 

If checked, the robot converts common alternate host names used by a server to a single name. This is most useful in cases where a site has a number of servers all aliased to the same address, such as www.sesta.com, which often have names such as www1.sesta.com, www2.sesta.com, and so on.

When you select this option, the robot will internally translate all host names starting with wwwn to www, where n is any integer. This attribute only operates on host names starting with wwwn.

This attribute cannot be used when CNAME resolution is OFF (No). 

Resolve Host Names to CNAMEs 

No 

If checked, the robot validates and resolves any host name it encounters into a canonical host name. This allows the robot to accurately track unique RDs. If unchecked, the robot validates host names without converting them to the canonical form. So you may get duplicate RDs listed with the different host names found by the robot. 

For example, devedge.sesta.com is an alias for developer.sesta.com. With CNAME resolution on, a URL referenced as devedge.sesta.com is listed as being found on developer.sesta.com. With CNAME resolution off, the RD retains the original reference to devedge.sesta.com.

Smart Host Heuristics cannot be enabled when CNAME resolution is OFF (No). 

Accepts Commands from any Host 

No 

Most robot control functions operate through a TCP/IP port. This attribute controls whether commands to the robot must come from the local host system (No), or whether they can come from anywhere on the network (Yes). 

It is recommended that you restrict direct robot control to the local host (No). You can still administer the robot remotely through the Administration Console. 

Default Starting Point Depth 

10 

1- starting points only, 2- bookmark style, 3-10, unlimited. 

Default value for the levels of hyperlinks the robot traverses from any starting point. You can set the depth for any given starting point by editing the site on the Robot, Sites page. 

Work Directory 

 
/var/opt/SUNWportal/
searchservers/search1/tmp

Full pathname of a temporary working directory the robot can use to store data. The robot retrieves the entire contents of documents into this directory, often many at a time, so this space should be large enough to handle all of those at once. 

State Directory 

 
/var/opt/SUNWportal/
searchservers/search1/robot

Full pathname of a temporary directory the robot uses to store its state information, including the list of URLs it has visited, the URL pool, and so on. This database can be quite large, so you might want to locate it in a separate partition from the Work Directory.

Page Extraction Index 

Partial Text 

Full Text uses the complete document in the resource description. Partial text only uses the specified number of bytes in the resource description. 

extract first # bytes 

4096 

Enter the number of bytes. 

Extract Table Of Contents 

Yes 

Yes includes the Table of Contents in the resource description. 

Extract data in META tags 

Yes 

Yes includes the META tags in the resource description. 

Allow No Existing Classifications 

Yes 

Yes allows none of the existing classifications in the resource description. 

Document Converters 

All selected; if unselected, that type of document cannot be indexed. 

Adobe PDF 

Corel Presentations 

Corel Quattro Pro 

FrameMaker 

Lotus Ami Pro 

Lotus Freelance 

Lotus Word Pro 

Lotus 1-2-3 

Microsoft Excel 

Microsoft Powerpoint 

Microsoft RTF 

Microsoft Word 

Microsoft Works 

Microsoft Write 

WordPerfect 

StarOffice™ Calc 

StarOffice Impress 

StarOffice Writer 

XyWrite 

Converter Timeout 

600 

Time in seconds allowed for one document to be converted to HTML. If this time is exceeded, the URL is excluded. 

Indexing

The robot searches sites and collects documents based on the filters you have selected. The documents collected are in many different formats. To make them uniform and easily readable they need to be in one format, which is HTML. This page controls some of the parts that go into each resource description.

Simulator

You can find the simulator attributes in the Robot Utilities page under the Utilities tab. The Robot Utilities page is a debugging tool that performs a partial simulation of robot filtering on a URL. You can type in a new URL to check. It checks the URL, DNS translations (including Smart Host Heuristics), and site redirections. It does not check the contents of the document specified by the URL, so it does not detect duplications, MIME types, network errors, permissions, and the like. The simulator indicates whether the listed sites would be accepted by the robot (ACCEPTED) or not (WARNING).

The table below provides the attributes and their description in the Simulator section in the Robot Utilities page.

Table 4–8 Robot Simulator Attributes

Attribute 

Default Value 

Description 

Run Simulator on 

URLs you have already defined and one blank text box. 

You can check access to a new site by typing its URL in the blank text box. This checks to see if the new site accepts crawling. 

Format http://www.sesta.com:80/

Show advanced DNS information 

Unselected 

Selected displays more information about the site. 

Check for server redirects 

Selected 

Selected checks for any server redirects. 

Site Probe

The site probe attributes are also available in the Robot Utilities page. This page is a debugging tool that checks for DNS aliases, server redirects, and virtual servers. This tool returns information about site but does not test its acceptance of crawling.

The table below provides the site Probe attributes and their description.

Table 4–9 Robot Site Probe Attributes

Attribute 

Default Value 

Description 

Run Site Probe on 

Blank 

Type in URL in format http://www.sesta.com:80

Show advanced DNS information 

Unselected 

Selected displays more information about the site including IP addresses. 

Chapter 5 Search Attributes: Database

This chapter explains the attributes provided for the search database. The Database attributes are divided as follows:

Management

Before knowing about the Search database, you need to know how to partition the database. To partition the database, use the run-cs-cli rdmgr -G command, because stopping the search server is required.

The initial Manage Databases page lists the available databases. You can select a database by selecting the checkbox preceding to it. Click the New, Reindex, Purge, Analyze, Manage, or Expire resource descriptions button to perform the necessary action on the selected database.

You should reindex the database if you have edited the schema to add or remove an indexed field (as author), or if a disk error has corrupted the index. You need to restart the server after you change the schema.

Because the time required to reindex the database is proportional to the number of RDs in the database, a large database should be reindexed when the server is not in high demand.

When you purge the contents of the database, disk space used for indexes will be recovered, but disk space used by the main database will not be recovered; instead, it is reused as new data is added to the database.

Expiring a database deletes all RDs that are deemed out-of-date. It does not decrease the size of the database. By default, an RD is scheduled to expire in 90 days from the time of creation.

The table below lists the Database Management attributes and their description.

Table 5–1 Database Management Attributes

Attribute 

Default Value 

Description 

Name 

True or False 

Name for the database used by Search. 

Federated 

True or False 

For a Federated database, this value is True. Otherwise, the value is False. 

Import Agents

Import agents are the processes that bring resource descriptions from other servers or databases and merge them into your search database.

The initial Manage Import Agents page lists the available import agents. You can select an import agent by selecting the checkbox preceding to it. Click the New, Enable, Disable, Delete, or Run All Enabled Import Agents to perform the necessary action on the selected import agent. To schedule the import agents, select Scheduling on the lower menu bar.

If you choose to create a new import agent or edit or modify an existing import agent, the following database import agent attributes are displayed.

The table below lists the Database Import Agent attributes and their description.

Table 5–2 Database Import Agent Attributes

Attribute 

Default Value 

Description 

Import agent source 

Local File 

Select either Local File or Remote Server (if one is enabled). 

Local File Path 

Blank for new 

Gives the full path name of local file that contains valid resource descriptions in search result (Summary Object Interchange Format). This can be a file on another server, as long as the path is addressable as if it were locally mounted. 

Destination Database 

Blank 

Name of the destination database. 

Remote Server Host 

Blank for new 

Gives the URL of the search server to retrieve resource descriptions from; the format is: www.sesta.com

Remote Server Port 

Blank for new 

Specify the port number for the given remote server host. For example, 8080

Search URI 

Blank for new 

Enter full path and file names. Use /search1/search.

Enable SSL 

False 

If this is a server-to-server transaction, select if the servers should use the SSL (Secure Sockets Layer) protocol. 

User 

Blank for new or none 

If you selected Use User/Password, enter a user. 

Password 

Blank for new or none 

If you selected Use User/Password, enter a password (shown as *). 

Content Transfer 

All 

By default, an import agent asks for all resource descriptions added or changed since its last import from the same source. 

The search query specifies that the import agent should request only certain resource descriptions from the source. This is much the same way that users request listings of resources from the search database. 

Use Scope, View-Attributes and View-Hits fields to specify the query. 

Scope 

Blank for new 

The text of the query. The query syntax is identical to that used for end-user queries from the server. 

View-Attributes 

Blank for new 

Lists which fields (not case sensitive) you want to import in each resource description. For example, title and author. The default is all. 

View-Hits 

Blank for new 

The maximum number of matching resource descriptions to import. If no hits are specified, it defaults to 20. 

Network Timeout in seconds 

Blank for new 

Specifies the number of seconds the import agent will allow before timing out the connection over the network. You can adjust this to allow for varying network traffic and quality.

Title 

Blank for new 

Title of the import agent. 

Remote Database 

Blank 

Name of the database on the remote server. 

Resource Descriptions

The initial Resource Descriptions page allows you to search the Resource Descriptions in the database. For example, you can correct a typographical error in an RD or manually assign RDs discovered by the robot to categories.

The table below lists the Resource Descriptions attributes and their description.

Table 5–3 Resource Descriptions Attributes

Attribute 

Default Value 

Description 

New 

 

Opens up the New Resource Description page where you can enter the URL to create a new search RD. 

Edit 

 

Opens up the Edit URL page where you can modify only the attributes of a search RD, which can be edited. 

Edit All 

 

Opens up the Edit Resource Descriptions page where you can modify a group of search RD. 

Delete 

 

Deletes the selected search RD. 

Filter 

All 

The options available are Categorized (to list Categorized RDs), Uncategorized (to list Uncategorized RDs), and Custom Filter. 

Custom Filter 

 

This attribute provides the following options: 

Query (Selected by default) 

URL 

Category 

Text box — To enter the search string. 

On selecting the Category option, the Choose button appears. Click the Choose button to go to the Select a Category page where you cab select the category. 

A successful search displays the Number of RDs found and a list box with the RDs found. If you navigate to the Edit page for a resource description, you can modify only the attributes of a resource description, which can be edited. By default, you cannot edit some of the RD attributes listed in the table below. To edit all these attributes except the Classification attribute, change the settings in the Database/Schema/Edit schema attribute page.

The table below lists the Database RD Editable attributes and their description. The default value for these attributes depends on the selected RD.

Table 5–4 Database RD Editable Attributes

Attribute 

Description 

Author 

Author(s) of the document. 

Author e-mail 

Email address to contact the Author(s) of the document. 

Classification 

Category name if classified; No Classification if not classified. 

ReadACL 

Related to document level security. 

Content-Charset 

Content-Charset information from HTTP Server. 

Content-Encoding 

Content-Encoding information from HTTP Server. 

Content-Language 

Content-Language information from HTTP Server. 

Content-Length 

Content-Length information from HTTP Server. 

Content-Type 

Content-Type information from HTTP Server. 

Description 

Description from RD. 

Expires 

Date on which resource description is no longer valid. 

Full-Text 

Entire contents of the document. 

Keywords 

Keywords taken from meta- tags. 

Last-Modified 

Date when the document was last modified. 

Partial-text 

Partial selection of text from the document 

Phone 

Phone number for Author contact 

Title 

Title of RD 

URL 

Uniform Resource Locator for the document

virtual-db 

Used to implement virtual database. 

Schema

When you click the Schema tab under Databases, you will get the Manage Search Schema page. This page lists the available Search Schema attributes. The schema determines what information is in a resource description and what form that information is in. You can add new attributes or fields to an RD and set which ones can be edited and which ones can be indexed. When importing new RDs, you can convert schemas embedded in new RDs into your own schema.

The table below lists the Search Schema attributes and their description.

Table 5–5 Search Schema Attributes

Attribute 

Description 

Author 

Author(s) of the document. 

Author-EMail 

Email address to contact the Author(s) of the document. 

Content-Charset 

Content-Charset information from HTTP Server. 

Content-Encoding 

Content-Encoding information from HTTP Server. 

Content-Language 

Content-Language information from HTTP Server. 

Content-Length 

Content-Length information from HTTP Server. 

Content-Type 

Content-Type information from HTTP Server. 

Description 

Brief one-line description for document. 

Expires 

Date on which resource description is no longer valid. 

Full-Text 

Entire contents of the document. 

Keywords 

Keywords that best describe the document. 

Last-modified 

Date when the document was last modified. 

Partial-Text 

Partial selection of text from the document. 

Phone 

Phone number for Author contact. 

ReadACL 

Used by Search servers to enforce security. 

Title 

Title of the document. 

URL 

Uniform Resource Locator for the document 

virtual-db 

Used to implement virtual database. 

When you select the checkbox preceding to a search schema attribute and click on it, the Edit search schema name page appears. This page displays all the attributes to edit a search schema attribute. The table below lists the attributes and their description to edit a search schema attribute.

Table 5–6 Edit Search Schema Attribute Attributes

Attribute 

Default Value 

Description 

Name 

Description 

Aliases 

Author 

Author(s) of the document 

Blank 

When you import new RDs, you can convert schemas embedded in new RDs into your own schema. You would use this conversion when there are discrepancies between the names used for fields in the import database schema and the schema used for RDs in your database. 

An example would be if you imported RDs that used Writer as a field for the author and you used Author in your RDs as the field for the author. The conversion would be Writer to Author, so you would enter Writer in this text box. 

Editable 

false 

If true (checked), the selected attribute (field) appears as Editable attribute in the Edit page for a resource description. 

Description, Keywords, Title and ReadACL are editable. 

Indexable 

true 

If true (checked), the selected attribute (field) can be used as a basis for indexing. 

Author, Title and URL appear in the menu in the Advanced Search screen 

for the end user. This allows end users to search for values in those  

particular fields. 

Author, Expires, Keywords, Last Modified, Title, URL and ReadACL  

can be used as the basis for indexing. 

Score Multiplier 

Blank 

A weighting field for scoring a particular element. Any positive value is valid. 

Data Type 

String 

Defines the data type. You need to choose the data type from the list box. 

Analysis

The Analysis page shows a sorted list of all sites and the number of resources from that site currently in the search database. Select Update Analysis to update the analysis on file.

The table below lists the Database Analysis attributes and their description.

Table 5–7 Database Analysis Attributes

Attribute 

Default Value 

Description 

Number of RDs 

Current number of RDs retrieved from the URL. 

Lists current number of RDs from that URL. 

URL 

URL that the robot has successfully searched. 

A URL that has added. 

Protocol 

Protocol it uses to retrieve the RDs from that URL. 

Lists the protocol used while collecting the RDs from a web site. 

Chapter 6 Search Attributes: Categories

This chapter explains the attributes available for Search Categories. This chapter contains the following sections:

Overview

End users interact with the search database in two distinct ways: They can type direct queries to search the database, or they can browse through the database contents using a set of categories you design. You assign resources in a search database to categories to clarify complexity. If a large number of items are in the database, it is helpful to group related items together. Your primary concern in setting up your categories should be usability so that end users can more quickly locate specific kinds of items.

The search server uses a hierarchy of categories called a taxonomy. The term taxonomy in general describes any system of categories. In the context of a networked resource database such as the search server database, it describes any method you choose of categorizing network resources to facilitate retrieval.

Manage Categories

When you click the Browse/Search tab under Categories, you will get the Manage Categories page. This page displays the categories in the taxonomy allowing you to browse the categories. You can also use this page to search for a category.

The attributes present in the Manage Categories page are shown in two tables. The first table lists the Manage Categories Attributes and the second table lists the Edit Category Attributes.

Table 6–1 Manage Categories Attributes

Attribute 

Default Value 

Description 

New 

 

Opens up the New Search Category page which you can use to create a new category. 

Edit 

 

Opens up the Edit Category page for that category where you can modify attributes of a Category. 

Delete 

 

Deletes the selected Category. 

Reindex 

 

Reindexes the database. If you have just created your taxonomy, you need to index the database to make category search available to your end users. If you have changed your categories, you need to reindex the database to make it up-to-date. Save the categories tree before you reindex the database. Load the new taxonomy. 

Search 

Blank 

Used to search for a Category. 

When you select the checkbox preceding to a Category and click the Edit button, the Edit selected Category name page appears. You can use the attributes in this page to edit a Category. The following table lists the attributes available in the Edit page and their description.

Table 6–2 Edit Category Attributes

Attribute 

Description 

Category 

Displays the Category name. 

Description 

Displays the description of the selected category. 

Matching Rule 

Displays the matching rule to use with the selected category. 

Manage Classification Rules

After you set up the categories for your database, Click New to set or change the rules the robot for selected categories to assign resources to categories.The table below lists the Classification Rules attributes and their description.

Table 6–3 Classification Rules Attributes

Attribute 

Default Value 

Description 

Source 

Author 

The valid attributes include: 

  • Author

  • Author-EMail

  • Content-Charset

  • Content-Encoding

  • Content-Language

  • Content-Length

  • Content-Type

  • Description

  • Expires

  • Full-Text

  • Keywords

  • Last-modified

  • Partial-Text

  • Phone

  • ReadACL

  • Title

  • URL

  • Host

  • Protocol

  • IP

  • Path

  • Type

Method 

is 

is, contains, begins with, ends with, regular expression 

Criteria 

Blank 

Specifies the criteria for the rule. 

Classification 

Blank 

Category to in which to classify the RD if the rule conditions are met. Type the category or use the Select a Category page to browse to it.

Chapter 7 Search Attributes: Scheduling

This chapter describes how you can schedule the Robot and Import Agents in Portal server 7.1 console application. This chapter contains the following sections:

Scheduling Robot

In the Sun Java System Portal Server 7.1 Administration console, click the Scheduling tab. By default, the Robot tab is enabled and shows the Scheduling Robot page. This page is where you set up the automatic search schedule for the robot. Use the attributes in the page to start and stop the robot at the times you specify.The table below lists the robot schedule attributes and their description.

Table 7–1 Robot Schedule Attributes

Attribute 

Default Value 

Description 

Start Robot Time in hours and minutes 

none selected  

This is the time that the robot starts to search. You need to specify the robot start time to schedule. The format is hh : mm : am or pm. For example, 12 : 00 : am. 

Days 

none selected 

Sun, Mon, Tue, Wed, Thu, Fri, or Sat 

Select at least one day. 

Stop Robot Time in hours and minutes 

none selected 

If you plan to run the robot continuously, it is recommended that you stop and restart it at least once per day. This gives the robot a chance to release resources and re-initialize itself. 

You need to specify the time in the format: hh : mm : am or pm. For example, 12 : 00 : am. 

Days 

none selected 

Sun, Mon, Tue, Wed, Thu, Fri, or Sat

Scheduling Import Agents

The Import Agents tab is located under the Scheduling tab. When you click the Import Agents tab, the Scheduling Import Agents page appears. This page is where you set up the schedule for running the import agents. The table below lists the database import schedule attributes and their description.

Table 7–2 Database Import Schedule Attributes

Attribute 

Default Value 

Description 

Start Import Time in hours and minutes 

none selected 

Time that the import agent starts to import. You need to specify the start import time to schedule. The format is hh : mm : am or pm. For example, 12 : 00 : am. 

Days 

none selected 

Sun -Sat 

Select at least one day. 

Scheduling Autoclassify

When you click the Autoclassify tab under Scheduling, the Scheduling Autoclassify page appears. This page lists the available Start Autoclassify attributes, which you can use to schedule autoclassify to start at the times you specify. The table below lists the attributes Start Autoclassify attributes and their description.

Table 7–3 Scheduling Autoclassify Attributes

Attributes 

Default Value 

Description 

Day of the Week 

None selected 

You need to choose the particular day in a week to schedule autoclassify. The listed days are Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, and Saturday. 

Time 

None selected 

You need to specify the time to schedule autoclassify. The format is hh : mm : am or pm. For example, 12 : 00 : am. 

Chapter 8 Search Attributes: Reports

This chapter explains the attributes available for Search Reports. This chapter contains the following sections:

Introduction

The Reports section allows you to monitor your search server. You can see a summary of its activity: what sites were searched, what URLs were excluded and why, detailed information about URLs visited by the robot, and what your end users are interested in.

Excluded URLs

This page shows a list of robot runs. To display a list of reasons URLs were excluded, set a date, select Show, then select one of the Reasons for Exclusion. Displayed is a list of the excluded URLs for that reason. Duplicate and warning exclusions have been removed.

The table below lists Reports Excluded URLs attributes and their description.

Table 8–1 Reports Excluded URLs Attributes

Attribute 

Default Value 

Description 

Count 

Numbers 

List of numbers with reasons for exclusion. 

Reason for Exclusion 

List of reasons sites have not been allowed. Each reason is linked to a list of all the URLs that were excluded for that reason. 

Filter rules, file not found, site not allowed, protocol not allowed, errors, duplication are some of the reasons URLs were excluded. 

Advanced Robot Reports

When you click the Advanced Robot Reports tab under Reports, you will get the Robot Report Files page. This page gives you access to a number of different reports from the robot. Select from a drop down list to get information for chosen report to show up. The Refresh button gets the current information.

The table below lists the Reports Robot Report Files attributes and their description.

Table 8–2 Robot Report Files Attributes

Attribute 

Default Value 

Description 

Reports 

Blank 

Overview, Version, Configuration, Performance, Database, Libnet, Modules, DNS Cache Dump, All Servers Found, URLs-Ready For Extraction, URLs-Ready For Indexing, URLs- Waiting For Filtering (URL pool), URLs- Waiting for Indexing. 

Log Files

This page allows you to view the entries or specific lines from a log file. Drop down list of log files. Enter the number of lines you want to be displayed when you select Show button.

The table below lists the Reports View Log Files attributes and their description.

Table 8–3 Reports —> Log Files Attributes

Attribute 

Default Value 

Description 

Log File 

Blank 

Excluded URLs (filter), RD Manager (rdmgr), RDM Server (rdmsvr), Robot Activities (robot), Search Engine (searchengine), User Queries (rdm). 

Lines to show 

25 

A number you can enter to display the most current entries in the log file. 

Popular Searches

When you click the Popular Searches tab under Reports, you will get the Manage Popular Searches page. This page lists the information on your popular searches. This page allows you to see what users are searching for. The most frequent searches appear first in the report. The table lists the Popular Searches attributes and their description.

Table 8–4 Popular Searches Attributes

Attribute 

Default Value 

Description 

Filter 

All Items 

All Items includes what categories users browse in. Exclude Browse excludes browsing statistics. 

Search Server Log Settings

You can set the log level for all the server log settings attributes listed in the table below in the /var/opt/SUNWportal/searchservers/search1/config/SearchLogConfig.properties file.The table lists the Search Server Log Settings attributes and their description.

Table 8–5 Search Server Log Settings Attributes

Attribute 

Default Value 

Description 

Search (rdm) 

 
/var/opt/SUNWportal/searchservers/search1/
logs/rdm.log

Logs the queries end users make of the database.  

Index Maintenance 

 
/var/opt/SUNWportal/searchservers/search1/
logs/searchengine.log

Logs the transactions involving the search engine, except for not registration of resource descriptions. 

RD Manager 

 
/var/opt/SUNWportal/searchservers/search1/
logs/rdmgr.log

Logs the registration of resource descriptions from the robot or import agents into the database. You can view this log as a RD Manager (rdmgr) report.

RDM Server 

 
/var/opt/SUNWportal/searchservers/search1/
logs/rdmserver.log

Logs debugging information on RDM transactions. The level of detail is controlled by the Log Level. You can view this log as a RDM Server (rdmsvr) report.

The possible levels of all the above logs are SEVERE, WARNING, INFO, FINE, FINER, and FINEST.

Chapter 9 Subscriptions Attributes

A Subscription is a profile of interest covering many sources of information such as categories, discussions, and searchable documents. The Subscriptions Service consists of root level, organization and user attributes. These attributes are available in the Sun Java System Portal Server Console. This chapter explains the following Subscriptions Service attributes:

Root Level Attributes

This section describes the root level attributes for the Subscriptions Service with which you can set the system-wide default maximum number of subscriptions for each type, categories, discussion, and saved searches. You can find these root level attributes in the Subscriptions page, which is in the Subscriptions Settings tab, when you select the TopLevel (Global) DN from the Select DNs drop down list. You can use this Subscriptions page to edit the subscription service attributes at root level.

The table below lists the subscription service attributes at root level and their description.

Table 9–1 Subscriptions Service - Root Level Attributes

Attribute 

Default Value 

Description 

Maximum Category Subscriptions 

5 

Specifies the maximum number of subscriptions on categories that can be defined and stored in the Sun Java System Access Manager. 

Maximum Discussion Subscriptions 

5 

Specifies the maximum number of subscriptions on discussions that can be defined and stored in the Sun Java System Access Manager. 

Maximum Saved Search 

5 

Specifies the maximum number of saved search subscriptions that can be defined and stored in the Sun Java System Access Manager. 

Organization Attributes

This section describes the organization attributes for the Subscriptions Service.

You can find these organization attributes in the Subscriptions page, which is in the Subscriptions Settings tab, when you select the Organization name [Org] DN from the Select DNs drop down list. You can use this Subscriptions page to edit the organization attributes. The table below lists the subscription service organization attributes and their description.

Table 9–2 Subscriptions Service — Organization Attributes

Attribute 

Default Value 

Description 

Profiler SMTP 

None 

The host system that servers as the SMTP server to route Email notifications to the end user. 

Profiler Email 

None 

This is the Email address, which is in the From header in the Email notification sent to the end user. It should be in the format: id@domain.

Profiler Provider 

The syntax for Profiler Provider should be: 

http://server.domain:PORT/?
provider=Profiler&desktop.suid=
uid=devauthlessanonymous,
ou=People,o=DeveloperSample,
dc=india,dc=sun,dc=com

In the URL, the values of the following attributes for authlessanonymous user defined are: 

  • uid — devauthlessanonymous

  • ou — people

  • o — DeveloperSample

  • dc — india

  • dc — sun

  • dc — com

This is the URL of the Profiler Channel present in the global DP, which is accessible by a valid authlessanonymous user defined for a given organization. 

Profiler Default Search 

This value should be in the format: 

http://HOST:PORT/search1/search

This is the URL for the default search server. 

Profiler Maximum Hits 

5 

This is the maximum number of result hits that any given end user Subscriptions in the organization would see in the Email notification sent to a user 

Maximum Category Subscriptions 

5 

Specifies the maximum number of subscriptions on categories that can be defined and stored in the Sun Java System Access Manager. 

Maximum Discussion Subscriptions 

5 

Specifies the maximum number of subscriptions on discussions that can be defined and stored in the Sun Java System Access Manager. 

Maximum Saved Search 

5 

Specifies the maximum number of saved search subscriptions that can be defined and stored in the Sun Java System Access Manager. 

User Attributes

This section describes the user attributes for Subscriptions Service.

You can find these User attributes in the Subscriptions page, which appears under the Settings tab, when you select the Username [User] DN from the Select DNs drop down list. You can use this Subscriptions page to edit the subscription service user attributes. The table below lists the subscription service user attributes and their description.

Table 9–3 Subscriptions Service - User Attributes

Attribute 

Default Value 

Description 

Profiler Enabled 

Disabled 

Enabled — Evaluates user subscriptions and result in an Email notification. 

Disabled — The user subscriptions are skipped during the subscriptions profiling run. 

Category Subscriptions

  • New value:

  • Current values:

Blank 

Blank 

This field defines the subscriptions details. The format is: 

label | target category | scope | lapsed time | rating | search server | database | status 

where: 

  • label — Refers to a logical reference given to the edited subscriptions and it must be a string. This is a required field.

  • target category — must be the string representation of a target category. For example : ABC:DEF:GHI

  • scope — Refers to a search query and it must be of a string fomat that is valid search string, including search operators.

  • lapsed time — Must be one of the following numbers:

    • 0 = forever

    • 1 = since yesterday

    • 7 = since last week

    • 30 = since last year

    • 180 = since last six months

    • 365 = since last year

  • rating — This is the minimum rating that a matching document should be to be selected as a match for the subscription. The values are:

    • -1 = irrelevant

    • 0 = routine

    • 1 = interesting

    • 2 = important

    • 3 = must read

  • search server — This is the URL of the target search server that will be queried by this subscription to find content matching the criteria of the subscription.

  • database — This is the target search database that the subscription is searching potential matches in. This is a single value database.

  • status — This is boolean value that marks whether the subscriptions is active or inactive. Active implies that the subscriptions is to be evaluated. Inactive implies that the subscriptions is dormant.

Discussion Subscriptions

  • New value:

  • Current values:

Blank 

Blank 

This field defines the subscriptions details. The format is: 

label | target discussion | scope | lapsed time | rating| search server | database | status 

where: 

  • label — Refers to a logical reference given to the edited suscriptions and it must be a string. This is a required field.

  • target discussion — This is the space-separated string representation of the discussion ID.

  • scope — Refers to a search query and it must be of a string fomat that is valid search string, including search operators.

  • lapsed time — Must be one of the following numbers:

    • 0 = forever

    • 1 = since yesterday

    • 7 = since last week

    • 30 = since last year

    • 180 = since last six months

    • 365 = since last year

  • rating — This is the minimum rating that a matching document should be to be selected as a match for the subscription. The numbers are:

    • -1 = irrelevant

    • 0 = routine

    • 1 = interesting

    • 2 = important

    • 3 = must read

  • search server — This is the URL of the target search server that will be queried by this subscription to find content matching the criteria of the subscription.

  • database — This is the target search database that the subscription is searching potential matches in. This is a single value database.

  • status — This is boolean value that marks whether the subscriptions is active or inactive. Active implies that the subscriptions is to be evaluated. Inactive implies that the subscriptions is dormant.

Saved Search

  • New value:

  • Current values:

Blank 

Blank 

This field defines the subscriptions details. The format is: 

label | scope | lapsed time | rating | search server | database | status 

where: 

  • label — Refers to a logical reference given to the edited subscriptions and it must be a string. This is a required field.

  • scope — Refers to a search query and it must be of a string format that is valid search string, including search operators.

  • lapsed time — Must be one of the following numbers:

    • 0 = forever

    • 1 = since yesterday

    • 7 = since last week

    • 30 = since last year

    • 180 = since last six months

    • 365 = since last year

  • rating — This is the minimum rating that a matching document should be to be selected as a match for the subscription. The numbers are:

    • -1 = irrelevant

    • 0 = routine

    • 1 = interesting

    • 2 = important

    • 3 = must read

  • search server — This is the URL of the target search server that will be queried by this subscription to find content matching the criteria of the subscription.

  • database — This is the target search database that the subscription is searching potential matches in. This is a single value database.

  • status — This is boolean value that marks whether the subscriptions is active or inactive. Active implies the subscriptions is to be evaluated. Inactive implies that the subscriptions is dormant.

Scheduling Profiler Attributes

This section describes the scheduling profiler attributes for Subscriptions Service.

You can find the scheduling profiler attributes in the Subscriptions page, which is in the Subscriptions Scheduling Profiler tab. You can use this Subscriptions page to start and stop times for the profiler. The following tables provide attributes for profiler run.

Click the New tab to enable the Start Profiler attributes. You can use these Start Profiler attributes shown in the table to setup the automatic start time for the profiler.

Table 9–4 Attributes for Start Profiler

Attribute 

Default Value 

Description 

Day of the Week 

None Selected 

Sun, Mon, Tue, Wed, Thu, Fri, or Sat 

Time 

None Selected 

This is the time when the profiler starts to search. You need to select the hours : minutes : am or pm. For example, 12 : 00 : pm 

Click the New tab to enable the Stop Profiler attributes. You can use these Stop Profiler attributes shown in the table to setup the automatic stop time for the profiler.

Table 9–5 Attributes for Stop Profiler

Attribute 

Default Value 

Description 

Day of the Week 

None Selected 

Sun, Mon, Tue, Wed, Thu, Fri, or Sat 

Time 

None Selected 

This is the time when the profiler stops. You need to select the hours : minutes : am or pm. For example, 12 : 00 : pm