Sun Java System Portal Server 7.1 Technical Reference

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 

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

Maximum Discussion Subscriptions 

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

Maximum Saved Search 

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 

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 

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

Maximum Discussion Subscriptions 

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

Maximum Saved Search 

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