PortalRegistry Classes

This chapter provides an overview of PortalRegistry classes and discusses how to:

• Use the PortalRegistry API

• Use security

• Work with ValidFrom and ValidTo

• Do error handling

• Understand the life-cycle of a PortalRegistry object

• View the PortalRegistry class hierarchy

• Use content references

• Understand naming conventions

• Delete content considerations

• Save content considerations

• Declare a PortalRegistry object

• Understand the scope of a PortalRegistry object

• Use PortalRegistry (reference section)

• Understand PortalRegistry classes examples

See Also

Understanding Portal Technology

Understanding Portal Registry

The portal registry is a tree structure in which content for a portal is organized, classified, and registered. The PortalRegistry classes (API) are used to update the portal registry. The Portal Administration pages provide a GUI access to the PortalRegistry API. You can also access them using a PeopleCode program you write yourself. How you access the portal registry depends on the type of updates required. Your organization will likely use both methods of updating the portal registry. This chapter focuses on accessing the PortalRegistry classes using PeopleCode.

A portal is a website that helps you navigate to other web-based applications and content. The PeopleSoft Portal is a business portal. It is similar to general purpose portals, except that its main purpose is to help end-users be more effective in accessing information to perform their jobs.

Each PeopleSoft Portal is defined by one PeopleSoft portal registry. The PeopleSoft portal registry consists of a number of system tables and associated data in a PeopleSoft database. The portal registry must reside within one PeopleSoft database. There can be more than one portal registry in a PeopleSoft database, but only one portal registry is associated with a PeopleSoft Portal.

The portal registry consists of the following primary parts:

• Folders

• Content references

• Nodes

Folders and content references make up the majority of the portal registry, and provide a hierarchical tree structure to describe various content that is registered as part of a PeopleSoft portal.

Nodes provide a logical name to a specific webserver and database, so content can be registered independent of specific webservers. It is used when the portal servlet attempts to retrieve content—both internal PeopleSoft content as well as external content—and to assemble pages.

The primary function of the portal is to take a target URL (generally a URL for a PeopleSoft component) that comes in from a user's browser, and assemble a page with that content and any other content. The layout and what content to assemble on the page is defined by the node template, which is composed of HTML. The portal attempts to find the content reference associated (that is, registered) with the target URL to get the template, or uses a series of default templates if it cannot get the template from a content reference.

Folders

Folders are how a hierarchical structure is created within a portal registry. Each folder has a parent, except the root folder, which is the top-level folder in a portal registry. Each folder can also contain child folders and content references. Folders are roughly analogous to directories within a file system. A folder can be further defined by a number of attributes (description, security, when it expires, and so on) that are useful within the portal environment.

See Also

Adding a Folder

Content References

A content reference is simply a reference to a URL. After you create an entry for a content reference in the portal registry, it's considered registered. A content reference can be further defined by a number of attributes (description, security, when it expires, and so on) that are useful within the portal environment.

There are a number of distinct types of content references that can be broken down into the following broad categories:

• Target

• Template

• Component

A target type of content reference describes a registered URL that a user might reference. Typically, these would be a PeopleSoft Pure Internet Architecture component, such as a page in a transaction. When a user references a URL, the URL is looked up in the registry to find the target content reference.

A template type of content reference describes what, if any, other content to put on the page, and where to place that content. The portal attempts to find a template for every URL that is requested.

A component type of content reference describes a component that is typically placed on a target page or homepage.

See Also

Content Reference Links

Nodes

When a content reference is created to register some content (that is, a URL) the specific URI (that is, the scheme, webserver, and so on) can be specified in the content reference. However, this has the drawback that every time the URI for a content reference changes (the webserver name changes, and so on), the content reference must be changed. Nodes are a way to create a logical name for a specific webserver, scheme, and so on. When the content reference is created you can specify a node name.

For example, suppose the name of a webserver changed. If you don't use nodes, you must check all your content references and change them accordingly. If you use nodes, you have to change only the webserver name in one place, and all the content references that use that node now automatically reference the correct webserver.

Nodes can be optional for content where the specified URL is already a complete URL, such as for external content. Nodes can be categorized as:

• default local

• local

• non-local (remote)

See Also

Using Attributes

Security

The same security mechanism is used for folders, content references, content reference links, tab definitions, pagelets, and user homepages. All of these items can be marked as public, owner accessible, or can have explicit PeopleSoft permission values set, including cascading the permissions to its child objects (that is, the child objects have the same permissions as the parent objects, when applicable.)

When marked as public, the item is accessible by any user. Public access cannot be cascaded, that is, passed down, to child objects.

When marked as owner accessible, an item is accessible only by the same user that created that item. Owner accessible cannot be cascaded, that is, passed down, to child objects.

Items can be marked as accessible by PeopleSoft permissions. This means that if a user is a member of a role, and the role contains the permission list that the item is also associated with, the user has access to that item. Additionally, when applied to folder permissions the permission can be cascaded. This means that any child of that folder, including a content reference, automatically has that permission added to its permission list.

Role-based security can applied to the portal objects (folders, content references and content reference links) using the RolePermissions collection.

Note. You can only use role-based security for content references, folders, and content reference links that are not components or iScripts.

You can specify which roles are allowed to access the objects. This works similarly to permission lists. If a user has a specified role, authorization is granted.

A role collection is the same as the PermissionValue collection, though there are additional properties on PermissionValue.

Attributes

Folders, content references, content reference links, PageletCategory objects, and Pagelets can have any number of attributes added to them. Attributes are simply name/value pairs. These name/value pairs are defined and used by many portal-aware applications, such as the search engine, navigational display, and so on.

See Using Attributes.

Additional Portal Objects

Using the PortalRegistry, you can also add and customize other items in your portal, such as tabs, homepages, and favorites.

The TabDefinition is a homepage tab that has been defined to the portal. It is what an administrator creates when they want to define a new homepage tab. The TabDefinition is based on content references.

The User Homepage is a personalized homepage for a user. It contains all the tabs and pagelets the user has selected for their homepage. The User Homepage is based on folders.

A Favorite represents a content reference that the user wants to keep a shortcut to. It contains the name of the content reference, and the label the user wants displayed for this favorite.

A Pagelets is an area on a page that contains content, and the template used to specify the style for that content. Pagelets are a type of content reference.

Using the PortalRegistry API

The PortalRegistry API provides the entry point to a specific portal registry. Common administrative tasks include adding, deleting, and renaming the registry objects (that is, folders, content references, tabs, and so on.) Additionally, there are many properties associated with every registry object, and all of these properties can be accessed and modified.

You can use the PortalRegistry API in batch mode to make many changes to a portal at once. For example, suppose something changed in your security system. You could write your own PeopleCode program, using the PortalRegistry classes, in an Application Engine program and change the access for all your users at once.

You can also use the PortalRegistry API to exchange data with an external system. For example, suppose an external merchant had an area on your company's portal, and the information there must be updated. One way to do this is for the merchant to use an Application Message to send the data to your system, then a subscription program would update the portal using the PortalRegistry API.

Each PortalRegistry object represents one specific PortalRegistry in a system. An empty PortalRegistry object is initially gotten from the PeopleSoft Session object. You can then open an existing PortalRegistry to view or change existing content, create a new PortalRegistry, or delete an existing PortalRegistry.

Using Security

The PermissionValue object associated with a folder, content reference, and so on, as well as specific properties on the object, work together to form the security for an object. In this section, we discuss how to:

• Use object properties.

• Access objects.

Using Object Properties

The properties that set permissions for an object are:

• AuthorAccess

• PublicAccess

The AuthorAccess property determines whether the author of the object has access to the object.

The PublicAccess property determines whether the object is generally accessible or not. If this property is set to True, all users have access to the object.

These properties apply only to an object. They cannot be cascaded, that is, passed down to child objects.

The other object property used with security, the Authorized property, indicates whether a user is authorized to access an object. The value of this property depends on whether the user has access.

Accessing Objects

When you get a folder, content reference, content reference link, PageletCategory or Pagelet collection, only the items that the end-user is authorized to access are in the collection.

An object is contained in a collection is based on the following algorithm.

• If the object is marked as PublicAccess it is automatically accessible.

• If the object is marked as AuthorAccess and the current UserId is the Author it is accessible.

• If the current user is in a permission list (class) that is in the Permissions collection for that object.

• If the current user is in a permission list (class) that is in the CascadedPermissions collection for that object.

• If the current user has the Portal Administrator role.

When you access a content reference or folder using a valid name and one of the Find methods (FindCRefByURL, FindCRefByName, FindCRefForURL, or FindFolderByName) a content reference or folder is returned whether the user is authorized to it. When you use these methods, always check the Authorized property. This is the only property you can view from an object that an end-user isn't authorized to.

In addition, if you know the specific URL for a tab, you could specify that in the FindCRefByURL. The tab is returned whether the user is authorized to it, so you should always check the Authorized property.

Using PermissionValue, RolePermissionValue, Cascading Permissions and CascadingRolePermissions

To set non role-based permissions for a folder, content reference, content reference link, PageletCategory object, or Pagelet, you must access the PermissionValue collection for that object using the Permissions property. The PermissionValue objects refer to permission list values that already exist on the system, such as ALLPANLS, CUSTOMER, EMPLOYEE, and so on.

To set role-based permissions for a folder, content reference, or a content reference link that are not component or iScript, you must access the RolePermissionValue collection for that object using the RolePermissions property. The PermissionValue objects refer to role-based permission values that already exist on the system.

Note. The PORTAL_PAGELETS folder is the parent folder for all PageletCategories. Its security is set to public. PeopleSoft does not recommend cascading any permissions from this folder object. Cascade permissions only from the pagelet category (folder).

Both the PermissionValue collection and the RolePermissionValue collection return PermissionValue objects. Use the PermType property to determin if a particular PermissionValue is role-based or not.

For every PermissionValue object, you can chose whether all the child folders and content references of this folder have the same permissions. This is called cascading. You cascade permissions by setting the Cascade property to True.

There are two types of PermissionList collections you can access. One is returned by the Permissions and RolePermissions properties, the other by the CascadedPermissions and CascadedRolePermissions properties.

Permissions and RolePermissions

The Permissions and RolePermissions properties return a collection containing the permissions set at the current level, that is, set with that folder or content reference. You can add PermissionValues to this list. Use the Cascade property to cascade the permission you add to child folders and content references.

Note. Folders can contain other folders, but the other objects that use the Permissions property can't contain themselves, that is, content references can't contain other content references, and so on. Therefore, the Cascade property is applicable only to folders, not to any other object.

CascadedPermissions and CascadedRolePermissions

The CascadedPermissions and CascadedRolePermissions properties return the a collection for all the permissions for an object. It contains any permission list values set in any parent folder.

Note. You cannot add any PermissionValues to a collection returned by the CascadedPermissions or CascadedRolePermissions property. You can add values only to the collection returned by the Permissions or RolePermissions property.

You can add PermissionValues for a child folder, but you cannot delete any of the existing ones that are cascaded. Permissions are augmented, not overwritten, that is, the permissions are the sum of both the parent permissions and whatever is set at the current level.

Therefore, keep the following in mind when working with PermissionValues:

• Set permissions only at the level where they're needed.

• Cascade permissions only when necessary.

• Generally, don't set cascaded PermissionValues for the root folder.

• Only the values in a PermissionValue object cascade. Properties on the folder itself (such as PublicAccess or AuthorAccess) do not cascade.

For example, suppose your PortalRegistry had the following hierarchy:

PortalRegistry hierarchy example

The following permission list values are assigned to the PermissionValue objects for the Employees folder, and both of them are cascaded:

• EMPLOYEE

• MANAGER

The Homepages and Benefits folders have the exact same permissions as the Employees folder, that is, all users associated with these two permission lists have access to these folders.

Suppose you decide that you don't want the permission list EMPLOYEE to access the Benefits folder. If you delete the EMPLOYEE PermissionValue from the Benefits PermissionValue collection, you have not altered the permissions. The permissions set at the parent folder, that is, at the Employees folder, can't be deleted, they can only be added to.

To make this change, you must:

• Change the Cascaded property for the EMPLOYEES PermissionValue in the Employees folder to False

• Add EMPLOYEES as a PermissionValue object to the Homepages folder.

See Also

Cascade

Setting Permissions Using the PermissionValue Object

Setting Up Permission Lists

Working With ValidFrom and ValidTo

Folders, content references, content reference links, and tab definitions have both ValidFrom and ValidTo dates. What's the difference and how are they used in the PortalRegistry API?

• A ValidFrom date is when something begins.

• A ValidTo date is when something ends.

For example, suppose your HR department has a page describing the benefits for your employees, and that page changed every calendar year. This means the page for the year 2000 has a ValidFrom date of 01/01/2000 and a ValidTo date of 12/31/2000. The benefits page for the year 2001 has a ValidFrom date of 01/01/2001 and a ValidTo date of 12/31/2001.

Folders, content references, content reference links and tab definitions are returned in their collections regardless of the ValidTo and ValidFrom dates. You must take these dates into account and only display to the end-user those values that should be seen.

In addition, a ValidFrom should always come before a ValidTo date. If they are set incorrectly, you receive a runtime error.

For all newly created folders, content references, content reference links and tab definitions, the default value for both these properties is Null (""), that is, they begin immediately and do not expire.

In addition, you can also check the IsVisible property to see if a portal object is viewable. IsVisible verifies if an object is Hidden, as well as if the ValidTo and ValidFrom dates are within the specified dates.

Doing Error Handling

All errors for the PortalRegistry classes, like the other APIs, are logged in the PSMessages collection, instantiated from a session object.

The PortalRegistry classes log errors that occur with methods immediately, and errors that occur with properties only after a method is executed.

For example, suppose you specified an invalid name when you were trying to delete a folder. The method (DeleteItem) returns False, and the error is logged in the PSMessages collection immediately.

Now suppose you created a new folder, and specified an invalid ValidTo date. The error won't be logged in the PSMessages collection until you tried to save your changes.

When you want to check for errors depends on your application. When users are entering data dynamically, and your program is registering their data in the portal, you may want to check for errors often. If you're using a batch program, you may want to check for errors only after the Open, Save, Insert, and Delete methods.

Most methods return a Boolean value indicating success or failure. After the failure of a method, you may want to check the PSMessages collection to determine the exact error.

Local ApiObject &MySession;
Local ApiObject &ErrorCol;
Local ApiObject &FolderCol, &Folder, &Registry;
Local Boolean &Open;/* Access the current session */

&MySession = %Session;
If &MySession Then
   /* connection is good */

&Registry = &MySession.GetRegistry();

&Open = &Registry.Open("CUSTOMER");

If &Open Then
   /* Registry opened successfully */
   /* do processing */
Else
   /* Do error checking */
   
&ErrorCol = &MySession.PSMessages;
For &I = 1 to &ErrorCol.Count
   /* do processing */
End-For;

   End-If;
Else
   /* do processing for no connection */
End-If;

See Also

Error Handling

Understanding the Life-Cycle of a PortalRegistry Object

At runtime, there are certain things you want to do with a PortalRegistry object, like getting an instance of it, adding tabs, editing content references, and so on. The following is an overview of this process. These steps are expanded in other sections.

1. Perform one of these steps.

   1. Execute the GetPortalRegistry method on the PeopleSoft session object to get a PortalRegistry object, or

   2. Use the FindPortalRegistries method on a session object to get a collection of all PortalRegistries. Select a PortalRegistry from the collection.

2. Open the PortalRegistry, using the portal name.

3. After you have an open PortalRegistry object, you can do various actions such as:

   • Add content references to the existing folders.

   • Add folders and the content references for them.

   • Add or change Nodes.

   • Modify the PortalRegistry properties.

   • Modify the existing content references, folders, tabs, homepages, and so on.

4. After you make your changes, you must save your work. The Save method must be executed at the appropriate level, such as at the folder level for changes to a folder, at the PortalRegistry level for changes to the default template, and so on.

   A property value change isn't committed to the database until the parent object is saved.

   Some methods commit data to the database only when the parent object is saved. However, other methods cause data to be committed to the database as soon as they are executed, like DeleteItem on a folder. Methods that automatically make database changes are noted as such in their description.

   See Saving Content Considerations.

5. When you finish all operations for a PortalRegistry, close the object.

   Note. PeopleSoft recommends that you open and close every PortalRegistry in a single PeopleCode event. You shouldn't open a PortalRegistry object and keep it open across multiple events. You should also keep only one PortalRegistry object open at a time.

Life cycle of a PortalRegistry object

Examples of using the PortalRegistry objects are provided at the end of this chapter.

See Also

PortalRegistry Classes Example

Viewing the PortalRegistry Class Hierarchy

There are many different classes used with the PortalRegistry API. The following flowchart shows the different classes, and how they are interrelated.

Hierarchy Considerations

The following are considerations for the representation of the hierarchy:

• The flowchart shows only two levels of folders. In reality, you can embed as many levels of folders as you need.

• From a PortalRegistry object, you must access the root folder before you can access the sub-folders for that PortalRegistry.

PortalRegistry class hierarchy (part 1 of 4)

PortalRegistry class hierarchy (part 2 of 4)

PortalRegistry class hierarchy (part 3 of 4)

PortalRegistry class hierarchy (part 4 of 4)

Using Content References

Content references have a number of properties, but several properties work together to define the type of Content reference. The values of these properties are interdependent, that is, the value of one indicates the values of others. The properties are:

• UsageType

• TemplateType

• URLType

• Nodes and URL

UsageType

This is the primary specifier for the type of content reference. There are a number of different types of content references, but all content references can be categorized into the following major types:

• Target

• Template

• Portal Component

Target

The target is the page referenced by a URL in the user's browser. This is the main transaction or page that the user wants, and the portal may place other content around this target page based on the template. The template describes any other content, and where to place it, on the page. The template is either gotten from the content reference or a set of default templates.

Content reference links can only be created for content references that have a type of target.

Template

A portal template defines how the portal creates a user's page. It's an HTML document that describes the content and where the content is placed. The template specifies one target and zero or more portal components.

The portal template in the following example is comprised of four separate template components: one for the navigation and search header, one for related links, one for the target content region, and one for the overall template which specifies where the other components should be placed. At runtime, the target content region would be filled by the HTML returned by the target page, as would the other template component regions.

A portal template

See Working with Portal Templates.

Portal Component

A portal component is an HTML document, or something that produces an HTML document. The portal component must be defined within a template.

A portal component could be one of a Homepage tab, component reference, or Homepage Pagelet.

UsageType Values

The following table matches the general types of target, template, and portal component to the actual values of the UsageType property.

More specifically:

• A UsageType value of TARG specifies a content reference that is a target.

• A UsageType value of FRMT specifies a content reference that is an HTML frame template.

• A UsageType value of HTMP specifies a content reference that is an HTML template.

• A UsageType value of HPGC specifies a content reference that is a PeopleSoft homepage component (pagelet).

• A UsageType value of HPGT specifies a Homepage tab.

• A UsageType value of LINK specifies a content reference link.

TemplateType

This property is valid only when the UsageType property is a target. For target type content references (TARG) this controls whether the portal looks for and uses a template to wrap the target.

URLType

This property gives information about what format the URL is in.

The URL property is always required (it's one of the parameters for the InsertItem method.) The format of this parameter (or property) depends on the other properties.

See Also

Understanding Portal Technology

Nodes and URL

Nodes and the URL property work together and are interrelated. The node is how to ‘register’ a logical name for a webserver (the webserver name, on the servlet, and so on) not the actual details. This way, content references don’t change when a webserver changes.

For example, suppose you had content that you referenced on the HRMS webserver. However, the machine name for that server changed. You can change the URI of the Node, instead of changing every content reference that referred to that content.

At least one node must be specified as the default local node. Nodes are also required for PeopleSoft components and iScripts.

Considerations When Using Nodes and the URL Property

When a content reference is created it is ‘registered’ with its URL (the portal, and others, typically find a content reference by its URL). The node is used to create a logical name for the webserver, servlet, and so on, so these details are not included in a content reference’s URL. When details of a webserver change, such as at installation time, only the URI for the content provider must change. You don’t have to change the URL for any content references.

When the node is specified, the content provider’s URI is concatenated with the URL property.

The format of the URL property depends on the content it's pointing to.

Summary

The following table summarizes the interrelations between the different content reference properties.

Naming Conventions

If you create two content references or with the exact same URL, the second one fails.

For example, suppose you create an external content reference with a URL of www.peoplesoft.com. Then you create a second content reference that has a node of PeopleSoft, whose URI is www.peoplesoft.com. The creation of the second content reference fails because the URL already exists.

If you have multiple nodes with the same URI, FindCRefByURL looks for the specified content reference with all those nodes.

If you have multiple nodes with the same URI, but no registered content references, the system uses the template from the alphabetically first node it finds.

Pagelet, node, and portal registry names can consist of any combination of letters, digits and underscores, but they must not contain any spaces or begin with a digit.

Content reference link names cannot have start with numbers, and can not have special characters and spaces.

Deleting Content Considerations

Be extremely careful when you delete any content. There may be more than one object relying on the content you delete.

• If you try to delete a template currently used by a content reference, the node template is set as the default template for the portal, you receive an error when you try to save the item.

• If you delete a homepage template for a user, the system tries to use the default user's template first, before resorting to the portal default template.

• If you try to delete a content provider that is currently used by a content reference, you receive an error and cannot save the PortalRegistry object.

Warning! If you delete a folder, you delete all content in the folder. If you delete a folder that contains other folders, that is, a parent folder, all the child folders, and all the content references are deleted.If you delete a PortalRegistry, you delete everything. Your entire PortalRegistry is gone, all the folders, content references, templates, and so on. Do not delete a PortalRegistry object unless you are absolutely certain you want to.

Saving Content Considerations

The following PortalRegistry classes have Save methods:

• PortalRegistry

• Folder

• Content reference

• Content reference links

• TabDefinition

• PageletCategory

• Pagelet

• Homepage

• Favorites collection

This means if you change a folder, you must save the folder. If you change a folder and only save at the PortalRegistry level, your changes are not saved.

Some classes do not have a Save method. For these classes, you must save the parent object.

• If you change a node, node template, or remote portal, you must use the PortalRegistry Save method.

• If you change an AttributeValue you must use the Save method with the item that contains the AttributeValue (folder, content reference, PageletCategory, or Pagelet).

• If you change a PermissionValue, you must use the Save method with the item that contains the PermissionValue (folder, content reference, PageletCategory or Pagelet).

• If you change a UserTab or a SelectedPagelet, you must use the Homepage Save method.

Data Type of a PortalRegistry Object

PortalRegistry objects, and all objects instantiated from a PortalRegistry object, are declared as data type ApiObject. For example,

Local ApiObject &MyRegistry;
Local ApiObject &MyFolder, &MyAttributeValue;

Note. PortalRegistry objects can only be declared as Local.

Considerations Using Local Variables

When a local variable has a reference to an object and the end-user clicks the Back button on a browser, the local variable is set to NULL. This is always logged in the trace file.

Considerations Using Global Variables

Global variables are not available to a portal or applications on separate databases. They are available only on applications and Portals in the same database.

Scope of a PortalRegistry Object

A PortalRegistry object can be instantiated from the following language environments:

• PeopleCode

• C/C++

• Java

See Also

PortalRegistry Classes Example

PortalRegistry Reference

The following sections provide more detail of the properties, methods, and other objects that you can use with a PortalRegistry object. If you don't want to programmatically change a portal registry, you can use the Portal Administration Tool pages instead.

See Also

Understanding Portal Technology

Session Class Methods

PortalRegistry objects don’t have any built-in functions. They are instantiated from a session object. In this section, we discuss the Session Object methods. The methods are listed in alphabetical order.

See Also

GetSession

%Session

FindPortalRegistries

Syntax

FindPortalRegistries(Name)

Description

The FindPortalRegistries method returns a reference to a PortalRegistry Collection filled with zero or more PortalRegistry objects matching the Name parameter. The Name parameter takes a string value.

You can use a partial key to get a smaller subset of the PortalRegistry collection. For example, to get a collection of all the PortalRegistry objects whose names start with the letter "B", specify just the letter B for Name:

&MyColl = &MySession.FindPortalRegistries("B");

Parameters

Returns

A PortalRegistry Collection object.

Example

The following example returns a collection with references to all PortalRegistry objects.

Local ApiObject &MySession;
Local ApiObject &MyColl;

&MySession = %Session;
&MyColl = &MySession.FindPortalRegistries("");

GetLocalNode

Syntax

GetLocalNode()

Description

Use the GetLocalNode method to return a reference to the node defined as the local node for this session.

Parameters

None.

Returns

A reference to a node object if successful, Null otherwise.

Example

&Node = %Session.GetLocalNode();

See Also

Node Class.

GetNodes

Syntax

GetNodes()

Description

Use the GetNodes method to return a collection of both local and remote nodes for the session.

Parameters

None.

Returns

A reference to a collection of nodes if successful, Null otherwise.

Example

&NodeColl = %Session.GetNodes();

See Also

Node Collection.

GetPortalRegistry

Syntax

GetPortalRegistry()

Description

The GetPortalRegistry method returns an empty PortalRegistry object. You can then open or delete an existing PortalRegistry, or create a new one.

Parameters

None.

Returns

An empty PortalRegistry object.

Example

Local ApiObject &MyPortal;

&MyPortal = %Session.GetPortalRegistry();
&PORTAL_NAME = %Request.GetParameter("PORTAL_NAME");
&Portal.Open(PORTAL_NAME);

GetRemoteNodes

Syntax

GetRemoteNodes()

Description

Use the GetRemoteNodes method to return a collection of nodes for the session.

Note. This method returns both local and remote nodes.

Parameters

None.

Returns

A reference to a collection of nodes if successful, Null otherwise.

Example

&NodeColl = %Session.GetNodes();

See Also

RemoteNode Collection.

PortalRegistry Class

A PortalRegistry object is returned from:

• The GetPortalRegistry session method.

• The PortalRegistry Collection Methods First, ItemByName, or Next.

Note. In addition to the following methods, the PortalRegistry class has methods used with the Search API.

See Also

GetPortalRegistry

PortalRegistry Collection Methods

Changing PortalRegistry Properties

Search Classes

PortalRegistry Class Methods

In this section, we discuss the PortalRegistry class methods. The methods are discussed in alphabetical order.

Close

Syntax

Close()

Description

The Close method closes the PortalRegistry object, that is, this method sets the object to the state it was in immediately after the GetPortalRegistry was done on the PeopleSoft Session object. Any unsaved changes are discarded. The Close method can be used only on an open PortalRegistry, not a closed one. This means you must have opened the PortalRegistry with the Open method before you can close it.

Parameters

None.

Returns

A Boolean value: True if the PortalRegistry object is successfully closed, False otherwise.

Example

&Rslt = &MyRegistry.Close();

If Not &Rslt Then
   /* registry not closed - do error processing */
End-if;

See Also

PortalRegistry class: Open method, Save method.

CopyObject

Syntax

CopyObject(sourcePortalName, sourceRefType, sourceObjName, targetPortalName, targetPrntFldrName, copyChildren)

Description

Use the CopyObject method to copy folders and content references between portal registries.

If the object being copied has related HTML, the HTML is also copied and named according to the current portal naming convention for HTML objects, which is:

PR_<portalname>_<objectname> 

where <portalname> is up to the first 8 characters of the portal name and <objectname> is up to the first 17 characters of the object name.

Considerations Using CopyObject

The source portal name and the target portal name cannot be the same name.

The targetPrntFldrName must be a folder that exists in the portal identified by the target portal name. It cannot be null (or empty). If you need to copy an entire portal, the portal must first be "created" using the Create method, before copying over all the folders and content references.

The copyChildren parameter is ignored for content references. However, it still must be set to "Yes" or "No".

Parameters

Returns

A Boolean value: True if object copied successfully, False otherwise.

Example

&Success = &Portal.CopyObject("PORTAL", "F", "PEOPLETOOLS_QUALITY", "BOGUS", "PORTAL_ROOT_OBJECT", "Yes");
If (&Success = False) Then
   WinMessage("portal copy failed");
   Exit;
End-If;

Create

Syntax

Create(RegistryName)

Description

The Create method creates a new PortalRegistry in the PortalRegistry object called RegistryName. The specified registry must be a new registry. The Create method returns False if the registry already exists.

The new PortalRegistry is immediately committed to the database. If you change any property of a PortalRegistry after you create the object, use the Save method to commit your changes to the database.

When a registry is created, a folder called Root is automatically created. This is the root folder for the registry.

Note. If you're using Visual Basic, you must check that the PortalRegistry is actually created. If you use a duplicate name, a zero is returned, but no error results.

Parameters

Returns

A Boolean value: True if the PortalRegistry object is successfully created, False otherwise.

Example

&PORTAL_NAME = MY_PORTAL_RECORD.PORTALNAME;
&MyPortal = %Session.GetPortalRegistry();

If NOT &MyPortal.Create(&PORTAL_NAME) Then;
   /* portal not created - do error processing */
End-If;

See Also

PortalRegistry class: Open method, Save method, Close method, Delete method.

CreateContentRefLink

Syntax

CreateContentRefLink(LinkName, LinkLabel, LinkParent, CRefPortalName, CRefObjectName)

Description

Use the CreateContentRefLink method to create a link to any content reference in any portal in a local database.

For example, using this method, you can create a link to a content reference in the EMPLOYEE portal, to a content reference in the CUSTOMER portal, or to a content reference in the current portal.

Parameters

Returns

A reference to a newly created CRefLink object.

Example

Local ApiObject &Portal, &CRef, &CReflink;
&Portal = PortalOpen();
&CReflink = &Portal.CreateContentRefLink(<Unique Link Name> , <LinkLable>, "<Link's Parent folder >", "<Cref Portal Name>",
<Cref Object Name>);

/*... Use the link object */

&Portal.Close();

CreateRemote

Syntax

CreateRemote(PortalName, RemoteNodeName)

Description

Use the CreateRemote method to create a remote portal. Although you can have more than one portal on a node, they must all be uniquely named.

Parameters

Returns

A Boolean value: True if the PortalRegistry object is successfully created, False otherwise.

See Also

PortalRegistry class: Create method, Portals property.

Delete

Syntax

Delete(RegistryName)

Description

The Delete method deletes the PortalRegistry from the database, including any data and tables.

Warning! If you delete a PortalRegistry, you delete everything. Your entire PortalRegistry is gone, all the folders, content references, templates, and so on. Do not delete a PortalRegistry object unless you are absolutely certain that you want to.

Note. The PortalRegistry classes execute some methods "interactively", that is, as they happen. The item won't be marked for deletion, then actually deleted later. The item is deleted from the database as soon as the method is executed.

The Delete method can only be used with a closed registry, it cannot be used on an open registry. Before you use the Delete method, you must explicitly close the PortalRegistry object (with the Close method.) The Delete method returns False if you try to delete an open PortalRegistry object.

Parameters

Returns

A Boolean value: True if the PortalRegistry object is successfully deleted, False otherwise.

Example

The following example deletes all PortalRegistry objects that start with HRMS_99.

Local ApiObject &MySession;
Local ApiObject &MyPortal;

&MySession = %Session;

&MyPortal = &MySession.GetPortalRegistry();

&MyPortal.Delete("HRMS_99");

See Also

PortalRegistry class: Close method, Open method.

DeleteHomepage

Syntax

DeleteHomepage()

Description

The DeleteHomepage method deletes the current user's homepage. This method is valid only after a user has opened a PortalRegistry object.

Parameters

None.

Returns

A Boolean value: True if the homepage is successfully deleted, False otherwise.

See Also

UserHomepage Class.

FindCRefByName

Syntax

FindCRefByName(Name)

Description

The FindCRefByName method returns the content reference object corresponding to Name. The name is a unique identifier for each content reference.

Considerations on Returned Content References

This method returns content reference objects that aren't yet valid as well as ones that are no longer valid. When you create your program, you must check for these invalid values if you don't want to use them. You can check using ValidTo, ValidFrom, or IsVisible.

This method returns content reference objects that you aren't authorized to. When you create your program, you should always check the Authorized property. This is the only property you can view from an object that you're not authorized to view.

Parameters

Returns

What this method returns depends on the condition of the content reference:

• If the content reference name is valid and the end-user has access to the content reference, a content reference object is returned.

• If the content reference is valid but the end-user doesn't have access to it a content reference object is returned, however, the only property you can access is the Authorized property.

• If you specified an invalid name this method returns NULL.

Example

The following example returns a GLOBAL_PAYROLL content reference object:

&CRef = &Portal.FindCRefByName("GLOBAL_PAYROLL");

See Also

Content Reference Class.

FindCRefByURL

Syntax

FindCRefByURL(URL)

Description

The FindCRefByURL method returns the content reference object corresponding to URL. The URL specified by URL must be an absolute URL.

Note. The portal registry API needs the current URI of the local node to work. During runtime, it gets this information from the current webserver. For Application Engine programs, there isn't a current webserver, so it has to get this information from the database.

If you have multiple content providers with the same URI, FindCRefByURL looks for the specified content reference with all those content providers.

To access pagelet categories and their associated pagelets, use the PageletCategories collection from the PortalRegistry object, not FindCRefByURL.

Considerations on Returned Content References

This method returns content reference objects that aren't yet valid as well as ones that are no longer valid. When you create your program, check for these properties (ValidTo and ValidFrom) if you don't want to use them.

This method returns content reference objects that the end-user isn't authorized to. When you create your program, always check the Authorized property. This is the only property you can view from an object that the end-user isn't authorized to view.

Parameters

Returns

What this method returns depends on the condition of the content reference:

• If the end-user has access to the URL, a content reference object is returned.

• If the content reference is registered, but the end-user doesn't have access to it, a content reference is returned, but the only property you can access is the Authorized property.

• If a URL isn't registered or is invalid, this method returns NULL.

Example

The following example finds a content reference from a URL:

&UserCRef = &Portal.FindCRefByURL("http://www.PeopleSoft.Com");

See Also

GetQualifiedURL, QualifiedURL.

Content Reference Class

FindCRefForURL

Syntax

FindCRefForURL(URL)

Description

The FindCRefForURL method returns the content reference object corresponding to URL. The URL specified by URL must be an absolute URL.

If the exact content reference is not found, this method tries to look for the content reference again, after stripping off the query portion of the URL.

If you don't want the system searched without the query string, use the FindCRefByURL method.

Note. The portal registry API needs the current URI of the local node to work. During runtime, it gets this information from the current webserver. For Application Engine programs, there isn't a current webserver, so it has to get this information from the database.

If you have multiple content providers with the same URI, FindCRefForURL looks for the specified content reference with all those content providers.

To access pagelet categories and their associated pagelets, use the PageletCategories collection from the PortalRegistry object, not FindCRefForURL.

Considerations on Returned Content References

This method returns content reference objects that aren't yet valid as well as ones that are no longer valid. When you create your program, check for these properties (ValidTo and ValidFrom) if you don't want to use them.

This method returns content reference objects that the end-user isn't authorized to. When you create your program, always check the Authorized property. This is the only property you can view from an object that the end-user isn't authorized to view.

Parameters

Returns

What this method returns depends on the condition of the content reference:

• If the end-user has access to the URL, a content reference object is returned.

• If the content reference is registered, but the end-user doesn't have access to it, a content reference is returned, but the only property you can access is the Authorized property.

• If a URL isn't registered or is invalid, this method returns NULL.

Example

The following example finds a content reference from a URL. If the content reference isn't found from the full URL, the query string is stripped and the system searches again:

&UserCRef = &Portal.FindCRefForURL("http://www.peoplesoft.com/crefs/psportal/technologies/?url=http%3a%2f%2faugust2004%2fipass.html");

See Also

GetQualifiedURL, QualifiedURL, FindCRefByURL.

Content Reference Class

FindCRefLinkByName

Syntax

FindCRefLinkByName(LinkName)

Description

Use the FindCRefLinkByName method to find the existing link in the current portal. If the link is found a reference to CRefLink object is returned. A Null value is returned if the CRefLink is not found in the database, and the error message is added to message collection

Considerations on Returned Links

This method returns links that aren't yet valid as well as ones that are no longer valid. When you create your program, you must check for these properties (ValidTo and ValidFrom) if you don't want to use them. This method may also return objects that you aren't authorized to. When you create your program, you should always check the Authorized property. This is the only property you can view from an object that you're not authorized to view.

Parameters

Returns

A reference to an existing CRefLink object. or a Null value if the CRefLink is not found.

FindFolderByName

Syntax

FindFolderByName(Name)

Description

The FindFolderByName method returns the Folder object corresponding to Name. The name is a unique identifier for each folder.

Considerations on Returned Folders

This method returns Folder objects that aren't yet valid as well as ones that are no longer valid. When you create your program, check for these properties (ValidTo and ValidFrom) if you don't want to use them.

This method returns folder objects that you aren't authorized to. When you create your program, always check the Authorized property. This is the only property you can view from an object that you're not authorized to view.

Parameters

Returns

What this method returns depends on the condition of the folder:

• If the folder name is valid and the end-user has access to the folder, a folder object is returned.

• If the folder is valid but the end-user doesn't have access to it a folder object is returned, however, the only property you can access is the Authorized property.

• If you specified an invalid name this method returns NULL.

Example

The following example returns a folder named ROOT:

&MyFolder = &MyPortal.FindFolderByName("ROOT");

The following example returns the folder object for an already instantiated content reference:

&Folder = &Portal.FindFolderByName(&CRef.ParentName);

See Also

Folder Class.

FindPgltByName

Syntax

FindPgltByName(PageletName)

Description

The FindPgltByName method returns the pagelet object corresponding to PageletName. The name is a unique identifier for each pagelet.

Considerations on Returned Pagelets

This method returns pagelet objects that aren't yet valid as well as ones that are no longer valid. When you create your program, check for these properties (ValidTo and ValidFrom) if you don't want to use them.

This method returns pagelet objects that you aren't authorized to. When you use create your program, always check the Authorized property. This is the only property you can view from an object that you're not authorized to view.

Parameters

Returns

What this method returns depends on the condition of the Pagelet:

• If the Pagelet name is valid and the end-user has access to the Pagelet, a Pagelet object is returned.

• If the Pagelet is valid but the end-user doesn't have access to it a Pagelet object is returned, however, the only property you can access is the Authorized property.

• If you specified an invalid name this method returns NULL.

Example

The following example returns a pagelet named HomePg_Dictionary:

&MyPglt = &MyPortal.FindPgltByName("HomePg_Dictionary");

See Also

Pagelet Class.

GetAbsoluteContentURL

Syntax

GetAbsoluteContentURL(NodeName, URL)

Description

The GetAbsoluteContentURL method returns the absolute unwrapped simple URL of the content, in the context of the current portal. For example, if the PortalRegistry object accessed a portal called Employees, and the method were called like this:

&Registry.getAbsoluteContentURL(Node.CRM,  "/c/SERVICES.ORDERS.GBL");

It would return the following string:

http://crmserver/servlets/psc/crmHome/Employees/CRM/c/SERVICES.ORDERS.GBL

In the returned string, the portion of the string from server name through PS_Home (crmHome in the example) are the ones associated with the content node (CRM in the example). The portal is the current portal, and the rest of the URL is the URL string passed in.

Parameters

Returns

A string containing the absolute URL.

GetDefaultHPTabOID

Syntax

GetDefaultHPTabOID()

Description

Use the GetDefaultHPTabOID method to return the name of the first homepage tab that is found and authorized for the current UserID.

The search order of the tabs depends on Sequence number of the tab name and is sorted alphabetically.

Parameters

None.

Returns

A string

GetQualifiedURL

Syntax

GetQualifiedURL(ContentProvider, RelativeURL)

Description

Note. This method is maintained only for backward compatibility. If your existing code uses this method, it actually returns the value from GetAbsoluteContentURL method. New applications should use the GetAbsoluteContentURL method.

See Also

PortalRegistry class: GetAbsoluteContentURL method.

GrantPermissionForComponent

Syntax

GrantPermissionForComponent(MenuName, ComponentName, Market, PermListName, NodeName)

Description

Use the GrantPermissionForComponent method to grant the specified permission and cascaded upwards on parent folders to the specified component. In addition, the specified permission is granted to any component references that point to the specified component, and any parent folders.

Components that have query strings are also searched and permissions are applied on them.

If you use the string "LOCAL_NODE" as NodeName, the system uses the node name currently defined as local.

All component entries in the portal registry are affected for all the portals. Not just the current portal.

Parameters

Returns

A Boolean value: True if method completed successfully, False otherwise.

Example

The My Profile Component Reference points to the USERMAINT_SELF component. Using the following example, "ALLPANLS" permission is granted to the MY_PROFILE component reference, as well as "MY INFO", the parent folder.

&Portal.GrantPermissionForComponent("MAINTAIN_SECURITY", "USERMAINT_SELF", "GBL", "ALLPANLS", "LOCAL_NODE");

See Also

RevokePermissionForComponent

Setting Up Permission Lists

GrantPermissionForScript

Syntax

GrantPermissionForScript(RecordName, FieldName, EventName, FuncName, PermListName, NodeName)

Description

Use the GrantPermissionForScript method to grant the specified permission to the specified iScript. In addition, the specified permission is granted to any component references that point to the specified iScript, and any parent folders.

If you use the string "LOCAL_NODE" as NodeName, the system uses the node name currently defined as local.

All iScript entries in the portal registry are affected for all the portals. Not just the current portal.

Parameters

Returns

A Boolean value: True if method completed successfully, False otherwise.

Example

&Portal.GrantPermissionForScript("WEBLIB_ALERT", "ALERTCOUNT", "FieldFormula", "Connect_Alert", "ALLPGS", "Local_Node");

See Also

RevokePermissionForComponent

Setting Up Permission Lists

Open

Syntax

Open(RegistryName)

Description

The Open method opens the PortalRegistry specified by the parameters. The registry must already exist. The Open method can be used only with a closed PortalRegistry, it cannot be used on an open registry.

Parameters

Returns

A Boolean value: True if the PortalRegistry object is successfully opened, False otherwise.

Example

In the following example, the name of the portal is stored as the value of a field in a record.

&PORTAL_NAME = EO_PE_REG_AET.PORTAL_NAME;
&Portal = %Session.GetPortalRegistry();

&Portal.Open(&PORTAL_NAME);

See Also

PortalRegistry class: Open method, Save method, Close method, Delete method.

PermissionListDelete

Syntax

PermissionListDelete(PermListName)

Description

Use the PermissionListDelete method to delete the specified permission list from the PortalRegistry.

If you try to delete a permission list that is still in use, you receive an error when you try to save the object.

The permission list is deleted from all the portal objects for all the portal.

Parameters

Returns

A Boolean value: True if the permission list is successfully deleted, False otherwise.

PermissionListSaveAs

Syntax

PermissionListSaveAs(PermListSourceName, PermListTargetName)

Description

Use the PermissionListSaveAs method to copy the specified permission list in the PortalRegistry.

Parameters

Returns

A Boolean value: True if the permission list is successfully copied, False otherwise.

RevokePermissionForComponent

Syntax

RevokePermissionForComponent(MenuName, ComponentName, Market, PermListName, NodeName)

Description

Use the RevokePermissionForComponent method to revoke the specified permission to the specified component. In addition, the specified permission is revoked for any component references that point to the specified component.

If you use the string "LOCAL_NODE" as NodeName, the system uses the node name currently defined as local.

All component entries in the portal registry are affected for all the portals. Not just the current portal.

Parameters

Returns

A Boolean value: True if method completed successfully, False otherwise.

Example

The My Profile Component Reference points to the USERMAINT_SELF component. Using the following example, "ALLPANLS" permission is revoked to the MY_PROFILE component reference.

&Portal.RevokePermissionForComponent("MAINTAIN_SECURITY", "USERMAINT_SELF", "GBL", "ALLPANLS", "LOCAL_NODE");

See Also

PortalRegistry class: GrantPermissionForComponent method.

Setting Up Permission Lists

RevokePermissionForScript

Syntax

RevokePermissionForScript(RecordName, FieldName, EventName, FuncName, PermListName, NodeName)

Description

Use the RevokePermissionForScript method to revoke the specified permission to the specified iScript. In addition, the specified permission is revoked for any component references that point to the specified iScript.

If you use the string "LOCAL_NODE" as NodeName, the system uses the node name currently defined as local.

All component entries in the portal registry are affected for all the portals. Not just the current portal.

Parameters

Returns

A Boolean value: True if method completed successfully, False otherwise.

Example

&Portal.RevokePermissionForScript("WEBLIB_ALERT", "ALERTCOUNT", "FieldFormula", "Connect_Alert", "ALLPGS", "Local_Node");

See Also

GrantPermissionForScript

Setting Up Permission Lists

Save

Syntax

Save()

Description

The Save method saves changes that you made to the PortalRegistry or to a node template. It does not save any changes that you made to a folder, content reference, and so on.

Note. To save changes for a folder or content reference use the save method associated with that object.

Parameters

None.

Returns

A Boolean value: True if the PortalRegistry object is successfully saved, False otherwise.

Example

If Not(&MyPortal.Save()) Then
   /* do error checking */
End-if:

See Also

Save folder method

Save content reference method

PortalRegistry Class Properties

In this section, we discuss the PortalRegistry class properties. The properties are discussed in alphabetical order.

DefaultTemplate

Description

This property returns or sets the name of the default template for this PortalRegistry object as a string.

If you delete a template for a content reference, and none of the other content references on a page have a template, the default template specified with the Node is used. If there's no template for the Node, the template specified with this property is used.

To return a reference to the content reference that contains the template specified by this property, use the TemplateObject property.

Note. If you change the Default Template for a portal, the template won't take effect until you close all the existing browser windows with the session and open a new browser window.

This property takes only the first 30 characters of a value. If you specify a value longer than 30 characters, the remaining characters are ignored.

This property is read-write.

See Also

PortalRegistry class: TemplateObject property.

Description

Description

This property returns or sets the description of this PortalRegistry object as a string

The length of this property is 256 characters.

This property is read-write.

Favorites

Description

This property returns a reference to the Favorites Collection for the current end-user.

This property is read-only.

See Also

Favorite Collection.

FolderNavObject

Description

This property specifies the content reference name to be used for the folder navigation object. When the folder navigation is tunred on, this content reference is displayed as the folder navigation homepage. This property takes a string value.

This property is read-write.

See Also

IsFolderNavigation

Homepage

Description

This property returns a reference to the Homepage for the current end-user.

This property is read-only.

IsFolderNavigation

Description

This property specifies if there is folder navigation. When the folder navigation is turned on, the user can see a folder homepage when clicked on the folder in the lefthand navigation menu. This property takes a boolean value: true if folder navigation is on, false otherwise.

This property is read-write.

See Also

FolderNavObject

Name

Description

This property returns the name of the PortalRegistry object as a string.

The length of this property is 30 characters.

This property is read-only.

NodeTemplates

Description

This property returns a reference to a NodeTemplate Collection. This property can be used with a closed portal registry, that is, before you open it with the Open method.

This property is read-only.

See Also

NodeTemplate Collection.

OwnerId

Description

This property returns or sets the owner ID of the PortalRegistry object as a string.

This property is read-write.

PageletCategories

Description

This property returns a reference to a PageletCategories Collection that contains all the PageletCategories for a portal.

This property is read-only.

See Also

PageletCategory Collection.

Portals

Description

This property returns a reference to a Portal collection that contains references to all the portals in the database.

This property is read-only.

See Also

Portal Collection.

RootFolder

Description

This property returns the root folder object for this PortalRegistry object.

This property is read-only.

TabDefinitions

Description

This property returns reference to a TabDefinitions Collection that contains all the TabDefinitions for a portal.

This property is read-only.

See Also

TabDefinition Collection.

TemplateObject

Description

This property returns a reference to a content reference object that contains the template specified by the DefaultTemplate property. If no template is specified with DefaultTemplate, this property returns Null.

This property is read-only.

See Also

PortalRegistry class: DefaultTemplate property.

PortalRegistry Collection

A PortalRegistry Collection is returned by the FindPortalRegistries session class method.

See Session class: FindPortalRegistries method.

PortalRegistry Collection Methods

In this section, we discuss the PortalRegistry collection methods. The methods are discussed in alphabetical order.

First

Syntax

First()

Description

The First method returns the first PortalRegistry object in the PortalRegistry collection.

Example

&MyRegistry = &MyCollection.First();

Item

Syntax

Item(number)

Description

The Item method returns the PortalRegistry object with the position in the PortalRegistry collection specified by number.

Parameters

Returns

A PortalRegistry object if successful, NULL otherwise.

Example

For &I = 1 to &MyCollection.Count
   &MyRegistry = &MyCollection.Item(&I);
   /* Do processing */
End-For;

Next

Syntax

Next()

Description

The Next method returns the next PortalRegistry object in the PortalRegistry collection. You can use this method only after you have used the First method: otherwise the system doesn’t know where to start.

Example

&MyRegistry = &MyCollection.Next();

PortalRegistry Collection Property

This section discusses the Count property.

Count

Description

This property returns the number of PortalRegistry objects in the PortalRegistry collection, as a number.

This property is read-only.

Example

&COUNT = &MY_COLLECTION.Count;

Node Class

The node indicates the URI of the content server. If the node is a PeopleSoft content server, it has a PeopleSoft server URI. If the node has external content, the URI indicates the external content.

Use the IsLocal or IsDefault to determine if a node from a RemoteNode collection is remote or local.

Node objects are instantiated from the following:

• From a Session object with the GetLocalNode method.

• From a Node Collection with the First, InsertItem, ItemByName, and Next methods.

• From a RemoteNode Collection with the First, InsertItem, ItemByName, and Next methods.

See GetLocalNode, Node Collection, RemoteNode Collection.

Node Class Properties

In this section, we discuss the Node class properties. The properties are discussed in alphabetical order.

ActiveNode

Description

This property indicates whether the node has been specified as an active node. This property returns a Boolean value: True, the node is active, False otherwise.

This property is read-only.

AppsRelease

Description

This property returns the release of the PeopleSoft Applications hosted on this node as a string. This property is valid only when the NodeType property is set to PeopleSoft (PIA).

This property is read-only.

See Also

Node class: NodeType property.

ContentURI

Description

This property returns the URI for the content webserver of this node as a string.

This property is read-only.

DefaultPortalName

Description

This property returns the name of the portal associated with the node as the default portal for the node.

This property is read-only.

Description

Description

This property returns the description for this node as a string.

The length of this property depends on your system database limit for LONG fields.

This property is read-only.

IsDefault

Description

This property indicates whether the node has been specified as the default local node. This property takes a Boolean value: True, this node has been specified as the default local node, False otherwise.

This property is valid only when the NodeType property is set to PeopleSoft (PIA).

This property is read-only.

See Also

Node class: NodeType property.

IsLocal

Description

This property indicates whether this node has been specified as the local PeopleSoft node. This property takes a Boolean value: True, this node has been specified as a local node, False otherwise.

This property is valid only when the NodeType property is set to PeopleSoft (PIA).

This property is read-only.

See Also

Node class: NodeType property.

Name

Description

This property returns the name for this node object as a string. The name is a unique identifier for each node object.

Every node name must be unique in the database.

This property is read-only.

NodePassword

Description

This property returns the password for this node object as a string.

This property is read-only.

NodeType

Description

This property indicates what the node is used for. Nodes can either define PeopleSoft or external systems. PeopleSoft nodes have more capabilities than external nodes, therefore several other properties depend on this property.

Values are:

PIA is the default value on a new Node.

This property is read-only.

PortalURI

Description

This property returns the URI for the portal webserver of this node as a string. This property is valid only when the NodeType property is set to PeopleSoft (PIA).

This property is read-only.

See Also

Node class: NodeType property.

ToolsRelease

Description

This property returns the release of PeopleTools running on this node as a string. This property is valid only when the NodeType property is set to PeopleSoft (PIA).

This property is read-only.

See Also

Node class: NodeType property.

Node Collection

A node collection contains a set of references to all nodes defined in the database.

Node Collection Methods

In this section, we discuss the Node collection methods. The methods are discussed in alphabetical order.

First

Syntax

First()

Description

The First method returns the first Node object in the Node collection.

Parameters

None.

Returns

A Node object.

Example

&MyNode = &MyCollection.First();

ItemByName

Syntax

ItemByName(NodeName)

Description

The ItemByName method returns the Node object with the name specified by NodeName.

Parameters

Returns

A Node object if successful, NULL otherwise.

Example

&MyOldNode = &MyPortal.Nodes.ItemByName("HRMS");

Next

Syntax

Next()

Description

The Next method returns the next Node object in the Node collection. You can use this method only after you have used the First method: otherwise the system doesn’t know where to start.

Parameters

None.

Returns

A Node object.

Example

&MyNode = &MyCollection.Next();

Node Collection Property

In this section, we discuss the Count property.

Count

Description

This property returns the number of Node objects in the Node Collection, as a number.

This property is read-only.

Example

&COUNT = &MY_COLLECTION.Count;

RemoteNode Collection

A remote node collection contains a set of references to all the nodes defined in the database, both local and remote.

Use the IsLocal property of the returned node object to determine if the node is remote or local.

RemoteNode Collection Methods

In this section, we discuss the RemoteNode collection methods. The methods are discussed in alphabetical order.

First

Syntax

First()

Description

The First method returns the first Node object in the RemoteNode collection.

Parameters

None.

Returns

A Node object.

Example

&MyNode = &MyCollection.First();

ItemByName

Syntax

ItemByName(NodeName)

Description

The ItemByName method returns the Node object with the name specified by NodeName.

Parameters

Returns

A Node object if successful, NULL otherwise.

Example

&MyOldNode = &MyPortal.RemoteNodes.ItemByName("HRMS");

Next

Syntax

Next()

Description

The Next method returns the next Node object in the RemoteNode collection. You can use this method only after you have used the First method: otherwise the system doesn’t know where to start.

Parameters

None.

Returns

A Node object.

Example

&MyNode = &MyCollection.Next();

RemoteNode Collection Property

In this section, we discuss the Count property.

Count

Description

This property returns the number of Node objects in the RemoteNode Collection, as a number.

This property is read-only.

Example

&COUNT = &MY_COLLECTION.Count;

Portal Class

The portal class provides access to portals declared in the session.

A portal object is instantiated by the First, InsertItem, ItemByName, and Next Portal Collection methods

See Portal Collection.

Portal Class Method

In this section, we discuss the Portal class methods. The methods are discussed in alphabetical order.

Save

Syntax

Save()

Description

Use the Save method to save changes you made to the portal object.

Parameters

None.

Returns

A Boolean value: True if the portal object is successfully saved, False otherwise.

See Also

Save PortalRegistry method

Portal Class Properties

In this section, we discuss the Portal class properties. The properties are discussed in alphabetical order.

HostNodeName

Description

This property sets or returns the name of the node hosting the portal as a string.

This property is read-write.

IsLocal

Description

This property indicates whether the portal is defined as local or remote. This property returns a Boolean value: True, the portal is defined as local, False otherwise.

This property is read-only.

Name

Description

This property returns the name of this portal as a string. This name exactly matches the portal name of the portal registry defined in the database.

This property is read-only.

Portal Collection

The portal collection contains a set of references to each portal defined in the database.

A portal collection is instantiated by the Portals PortalRegistry property.

See PortalRegistry class: Portals property.

Portal Collection Methods

In this section, we discuss the Portal collection methods. The methods are discussed in alphabetical order.

First

Syntax

First()

Description

The First method returns the first Portal object in the Portal collection.

Parameters

None.

Returns

A Portal object.

Example

&MyPortal = &MyCollection.First();

ItemByName

Syntax

ItemByName(PortalName)

Description

The ItemByName method returns the Portal object with the name PortalName.

Parameters

Returns

A Portal object if successful, NULL otherwise.

Example

&MyPortal = &MyPortal.Portals.ItemByName("HRMS");

Next

Syntax

Next()

Description

The Next method returns the next Portal object in the Portal collection. You can use this method only after you have used the First method: otherwise the system doesn’t know where to start.

Parameters

None.

Returns

A Portal object.

Example

&MyPortal = &MyCollection.Next();

Portal Collection Properties

In this section, we discuss the Count property.

Count

Description

This property returns the number of Portal objects in the Portal Collection, as a number.

This property is read-only.

Example

&COUNT = &MY_COLLECTION.Count;

NodeTemplate Class

The NodeTemplate class provides access to the default template assigned to a node in this portal.

A NodeTemplate object is instantiated by the First, InsertItem, ItemByName, and Next NodeTemplate Collection methods.

See NodeTemplate Collection.

NodeTemplate Class Properties

In this section, we discuss the NodeTemplate class properties. The properties are discussed in alphabetical order.

DefaultTemplate

Description

This property specifies the name of the template to be applied to the node.

This property is read-write.

Name

Description

This property specifies the name of node that the template is to be applied to.

This property is read-write.

TemplateObject

Description

This property returns a reference to the template object associated with this node as a content reference.

This property is read-only.

See Also

Content Reference Class.

NodeTemplate Collection

The NodeTemplate collection contains a set of references to each node template object in a portal.

A NodeTemplate collection is instantiated by the NodeTemplates PortalRegistry property.

See PortalRegistry class: NodeTemplates property.

NodeTemplate Collection Methods

In this section, we discuss the NodeTemplate collection methods. The methods are discussed in alphabetical order.

DeleteItem

Syntax

DeleteItem(NodeName)

Description

The DeleteItem method deletes the NodeTemplate object identified by NodeName from the NodeTemplate Collection.

This method is not executed automatically. It is executed only when the PortalRegistry is saved.

Parameters

Returns

A Boolean value: True if the NodeTemplate was deleted, False otherwise.

Example

If Not &MyNodeTemplates.DeleteItem("HRMS") Then
   /* Do error processing */
End-if

First

Syntax

First()

Description

The First method returns the first NodeTemplate object in the NodeTemplate collection.

Parameters

None.

Returns

A NodeTemplate object.

Example

&MyNodeTemplate = &MyCollection.First();

InsertItem

Syntax

InsertItem(NodeName)

Description

The InsertItem method inserts the NodeTemplate object identified by NodeName into the NodeTemplate Collection.

This method is not executed automatically. It is executed only when the PortalRegistry is saved.

Parameters

Returns

A reference to the new NodeTemplate object if the method executed successfully, NULL otherwise.

Example

&NewNodeTemplate = &MyPortal.NodeTemplates.InsertItem("CRM");

ItemByName

Syntax

ItemByName(NodeName)

Description

The ItemByName method returns the NodeTemplate object with the name NodeName.

Parameters

Returns

A NodeTemplate object if successful, NULL otherwise.

Example

&MyNodeTemplate = &MyPortal.NodeTemplates.ItemByName("HRMS");

Next

Syntax

Next()

Description

The Next method returns the next NodeTemplate object in the NodeTemplate collection. You can use this method only after you have used the First method: otherwise the system doesn’t know where to start.

Parameters

None.

Returns

A NodeTemplate object.

Example

&MyNodeTemplate = &MyCollection.Next();

NodeTemplate Collection Properties

In this section, we discuss the Count property.

Count

Description

This property returns the number of NodeTemplate objects in the NodeTemplate Collection, as a number.

This property is read-only.

Example

&COUNT = &MY_COLLECTION.Count;

Folder Class

Folder objects are instantiated from other classes as follows:

• From a PortalRegistry object with the RootFolder property or the FindFolderByName method.

• From a Folder Collection with the First, ItemByName, or Next methods

See PortalRegistry class: RootFolder property, FindFolderByName method, Folder Collection .

See Adding a Folder.

Folder Class Method

In this section, we discuss the Folder class methods. The methods are discussed in alphabetical order.

Save

Syntax

Save()

Description

The Save method saves any changes you made to the folder, for example, a changed description or ValidFrom date.

Using this method also saves any changes you made to PermissionValue (both role-based and non role-based) and AttributeValue objects associated with this folder. Security permissions added are cascade upward until the root folder or first public folder. Removed security permissions are removed from all the parent folders until root or public folder in folder hierarchy.

Parameters

None.

Returns

A Boolean value: True if the Folder object is successfully saved, False otherwise.

Example

If Not(&MyFolder.Save()) Then
   /* do error checking */
End-If;

See Also

Save PortalRegistry method

Save content reference method

Folder Class Properties

In this section, we discuss the Folder class properties. The properties are discussed in alphabetical order.

Attributes

Description

This property returns an Attribute Collection containing the AttributeValue objects for this folder.

This property is read-only.

See Also

Attribute Collection.

Author

Description

This property returns the author (PeopleSoft user ID) for this folder as a string.

This property is read-only.

AuthorAccess

Description

This property specifies whether the author of the folder has access to the folder. This property takes a Boolean value. The default value for this property for a newly created object is True. This property is not cascaded.

This property is read-write.

Authorized

Description

This property specifies whether the user is authorized to view this Folder.

This property is used when you access a particular Folder using FindFolderByName. If you've specified a valid Folder with this method, a Folder is always returned, whether you are authorized to view it or not. This is the only property you can view from an object that you are not authorized to.

The initial value of this property depends on the other permission properties (PublicAccess and AuthorAccess) and the permission list values in the PermissionValue object associated with this folder.

This property is read-only.

See Also

PortalRegistry class: FindFolderByName method.

CascadedPermissions

Description

This property returns a PermissionValue Collection. This collection contains the value of the non role-based permissions for all the child and parent objects (up to the root folder). To determine only the permissions of the object use the Permission property instead. To determine the role-based permissions of the object use the CascadedRolePermissions property instead.

Note. You cannot add any PermissionValue objects to a collection returned by the CascadedPermissions property. You can add values only to the collection returned by the Permissions or RolePermissions property.

This property is read-only.

See Also

CascadedRolePermissions, PermissionValue Collection, Permissions.

CascadedRolePermissions

Description

This property returns a RolePermissionValue Collection. This collection contains the value of the role-based permissions for all the child and parent objects (up to the root folder). To determine only the role-based permissions of the object use the RolePermission property instead. To determine the non role-based permissions of the object use the CascadedPermissions property.

Note. You cannot add any PermissionValue objects to a collection returned by the CascadedRolePermissions property. You can add values only to the collection returned by the Permissions or RolePermissions property.

This property is read-only.

See Also

CascadedPermissions, RolePermissions, RolePermissionValue Collection.

ContentRefs

Description

This property returns the ContentReference Collection for this folder.

This property is read-only.

See Also

Content Reference Collection.

CreationDate

Description

This property returns the creation date for this folder as a string.

This property is read-only.

Description

Description

This property returns or sets the description for this folder as a string.

The length of this property is 256 characters. This property is translatable.

This property is read-write.

Folders

Description

This property returns a reference to the Folder Collection for this folder.

This property is read-only.

See Also

Folder Collection.

IsMobile

Description

This property returns True if the folder is used with mobile applications, False otherwise.

This property is read-write.

IsVisible

Description

This property returns True if the Hide from Portal Navigation check box is not selected when the folder is created. If the folder is hidden from portal navigation, this property returns False.

Considerations Using IsVisible

If you do not specifically set this property on a new or copied folder, the IsVisible property is set as follows:

• If the ValidFrom date is less then or equal to that day's date, the IsVisible property is set to True.

• If there is no ValidTo date the IsVisible property is set to True.

• If the ValidTo date is greater then or equal to that day's date, the IsVisible property is set to True.

This property is read-only.

See Also

Folder class: ValidFrom property, ValidTo property.

Label

Description

This property returns or sets the label for this folder as a string.

The length of this property is 30 characters.

This property is translatable.

This property is read-write.

Name

Description

This property returns the name for this folder as a sting. The name is a unique identifier for each folder.

Every folder name must be unique across the portal, not just in the parent folder.

This property is not translatable. However, the values for the Label and Description properties are translatable.

This property is read-only.

See Also

Folder class: Description property, Label property.

OwnerId

Description

This property returns the name of the owner for this folder as a string.

This property is read-write.

ParentName

Description

This property returns the parent folder name for this folder as a string. This property is valid only if the folder is contained within another folder. If the folder using this property is the root folder, this property returns an empty string.

This property is read-only.

Path

Description

The Path property returns a path to this folder, with each element of the path separated by a period. The path has the following syntax:

FolderLabel{Name}.[ChildFolderLabel{Name}.]. . .

This property is read-only.

Example

Departments{PORTA_ROOT_OBJECT}.HR{EastCoast}.AdministerWorkforce{Global}

Permissions

Description

This property returns a PermissionValue Collection. This collection contains the value of the non role-based permissions for this folder. To determine the permissions for all the parent objects (up to the root folder) use the CascadedPermissions property. To access the role-based permissions, use the RolePermissions property.

This property is read-only.

See Also

PermissionValue Collection, CascadedPermissions, RolePermissionValue Collection.

Product

Description

This property returns or sets the PeopleSoft product for this folder as a string.

The length of this property is 4 characters.

This property is read-write.

RolePermissions

Description

This property returns a RolePermissionValue Collection. This collection contains the value of the role-based permissions for this folder. To determine the role-based permissions for all the parent objects (up to the root folder) use the CascadedRolePermissions property. To access the non role-based permissions, use the Permissions property.

This property is read-only.

See Also

CascadedRolePermissions, Permissions, RolePermissionValue Collection.

SequenceNumber

Description

The sequence number is used when returning a collection. The default order of the returned folders is based on the sequence number. Use this property to reorder folders.

If there are duplicates in the sequence number, the folders are returned alphabetically.

The length of this property is 4 characters.

This property is read-write.

PublicAccess

Description

This property indicates whether a folder is generally accessible, that is, if this property is set to True, any user can access the folder. This property is not cascaded.

This property takes a Boolean value.

The default value for this property for a newly created object is False.

This property is read-write.

ValidFrom

Description

This property returns or sets the date this folder is valid from as a string.

This property is read-write.

ValidTo

Description

This property returns or sets the date this folder is valid until as a string.

This property is read-write.

Note. The PortalRegistry API never uses the ValidTo and ValidFrom fields to determine what to return in a collection. You must check for these values in your application.

Folder Collection

The Folder Collection provides access to a collection of folders in a Folder object.

The Folder Collection is instantiated from the Folders Folder Class property.

See Folder class: Folders property.

Folder Collection Methods

In this section, we discuss the Folder collection methods. The methods are discussed in alphabetical order.

DeleteItem

Syntax

DeleteItem(FolderName)

Description

The DeleteItem method deletes the folder object identified by FolderName from the database. If the folder contains other folders, all child folders and their contents are also deleted.

Warning! If you delete a folder, you delete all content in the folder. If you delete a folder that contains other folders, that is, a parent folder, all the child folders, and all the content references are deleted.

Note. The PortalRegistry classes execute some methods "interactively", that is, as they happen. The item won't be marked for deletion, then actually deleted later. The item is deleted from the database as soon as the method is executed.

Parameters

Returns

A Boolean value: True if the folder was deleted, False otherwise.

Example

If Not &MyFolderColl.DeleteItem("MYFOLDER") Then
   /* Folder not deleted. Do error checking */
End-If;

First

Syntax

First()

Description

The First method returns the first Folder object in the folder collection.

Parameters

None.

Returns

Folder object.

Example

&MyFolder = &MyCollection.First();

InsertItem

Syntax

InsertItem(FolderName, Label)

Description

The InsertItem method inserts the folder object identified by FolderName from the Folder Collection. You must specify both a name and a label for all folders. This method returns a reference to the new folder object. You must specify a unique FolderName, or you receive an error.

Note. The PortalRegistry classes execute some methods "interactively", that is, as they happen. The item won't be marked for insertion, then actually inserted later. The item is inserted into the database as soon as the method is executed.

Parameters

Returns

A reference to the new Folder object if the method executed successfully, null otherwise.

Example

&DeptHPFldr = &MyPortal.Folders.InsertItem("PORT0145", "HR Folder for Department 0145");

ItemByName

Syntax

ItemByName(Name)

Description

The ItemByName method returns the Folder object with the name Name.

Parameters

Returns

A folder object if successful, NULL otherwise.

Example

&DeptFldr = &MyPortal.RootFolder.Folders.ItemByName(&Dept_Name);

Next

Syntax

Next()

Description

The Next method returns the next Folder object in the Folder collection. You can use this method only after you have used the First method: otherwise the system doesn’t know where to start.

Parameters

None.

Returns

A folder object.

Example

Local ApiObject &MySession, &Root, &Folders, &MyFolder;

&MySession = %Session;
&MyPortal = &MySession.GetPortalRegistry("ADMIN");

&Root = &MyPortal.GetRoot();
&Folders = &Root.Folders;

&MyFolder = &Folders.First();

For &I = 1 to &Folders.Count
   /* Do processing on folders */ 
   If &I <> &Folders.Count
      &MyFolder = &Folders.Next();
   End-If;
End-For;

Folder Collection Property

In this section, we discuss the Count property.

Count

Description

This property returns the number of Folder objects in the Folder Collection, as a number.

This property is read-only.

Example

&COUNT = &MY_COLLECTION.Count;

Content Reference Class

The content reference class provides access to some kind of content. The type of content depends on the content reference.

The content reference objects are instantiated from other classes:

• From a PortalRegistry object with the FindCRefByURL, FindCRefForURL, or FindCRefByName properties.

• From a Content Reference Collection (instantiated from a folder) with the First, ItemByName or Next methods

See PortalRegistry class: FindCRefByURL method, FindCRefByName method, FindCRefForURL method, Content Reference Collection .

See Adding a Content Reference.

Content Reference Class Methods

In this section, we discuss the Content Reference class methods. The methods are discussed in alphabetical order.

CreateLink

Syntax

CreateLink(LinkName, Label)

Description

Use the CreateLink method to create a link quickly to the same content reference executing the method. The link by defaults assumes the parent folder is the same as the content reference's parent.

A CReflink object is returned if there is no error.

After you create a link you must use the Save method to save it to the database.

Parameters

Returns

A reference to a CRefLink object.

Example

&CRef = &Portal.FindCRefByName("MyCRef");
&Link = &CRef.CreateLink("Link Object");
&Link.Save();

See Also

Link Class, Save.

Save

Syntax

Save()

Description

The Save method saves any changes you made to the content reference, for example, a changed description. It also performs some validation.

Using this method also saves any changes you made to PermissionValue or AttributeValue objects associated with this content reference.

Parameters

None.

Returns

A Boolean value: True if the content reference and its associated objects saved successfully, False otherwise.

Example

If NOT(&MyCRef.Save()) Then
   /* save failed, do error processing */
End-If;

See Also

Save PortalRegistry method

Save Folder method

Content Reference Class Properties

In this section, we discuss the Content Reference class properties. The properties are discussed in alphabetical order.

AbsoluteContentURL

Description

This property returns the absolute content URL, that is, the content from the content servlet (psc).

This property is read-only.

Example

The following is an example absolute content URL:

http://serverx/psp/PS84/EMPLOYEEPORTAL/CRM/c/SFA.CUSTOMERINFO.GBL?page=CUST_DATA1&&Action=U&emplid=00001

AbsolutePortalURL

Description

This property returns the absolute content reference portal URL.

This property is read-only.

Example

http://serverx/psp/PS84/EMPLOYEEPORTAL/CRM/c/SFA.CUSTOMERINFO.GBL?page=CUST_DATA1&&Action=U&emplid=00001

AssignedPagelets

Description

This property returns an AssignedPagelet collection.

This property is read-only.

See Also

AssignedPagelet Collection.

Attributes

Description

This property returns an Attribute Collection containing the AttributeValues for this content reference object.

This property is read-only.

See Also

Attribute Collection.

Author

Description

This property returns the author (PeopleSoft user ID) for this content reference object as a string.

This property is read-only.

AuthorAccess

Description

This property specifies whether the author of the content reference has access to the content reference. This property takes a Boolean value. The default value for this property is True.

This property is read-write.

Authorized

Description

This property specifies whether the user is authorized to view this content reference.

This property is used when you access a particular content reference using FindCRefByURL, FindCRefForURL, or FindCRefByName. If you specified a valid content reference with either of these methods, a content reference is always returned, whether you are authorized to view it or not. This is the only property you can view from an object for which you are not authorized.

The initial value of this property depends on the other permission properties (PublicAccess and AuthorAccess) and the permission list values in the PermissionValue object associated with this content reference.

This property is read-only.

See Also

PortalRegistry class: FindCRefByURL method, FindCRefForURL method, FindCRefByName method.

CascadedPermissions

Description

This property returns a PermissionValue Collection. This collection contains the value of the non role-based permissions for all the parent objects (up to the root folder). To determine only the permissions of the object use the Permissions property instead. To access the role-based permissions, use the CascadedRolePermissions property.

Note. You cannot add any PermissionValue objects to a collection returned by the CascadedPermissions property. You can add values only to the collection returned by the Permissions property.

This property is read-only.

See Also

CascadedRolePermissions, PermissionValue Collection, Permissions.

CascadedRolePermissions

Description

This property returns a RolePermissionValue Collection. This collection contains the value of the role-based permissions for all the parent objects (up to the root folder). To determine only the permissions of the object use the RolePermissions property instead. To determine non role-based permissions, use the CascadedPermissions property.

Note. You cannot add any RolePermissionValue objects to a collection returned by the CascadedRolePermissions property. You can add values only to the collection returned by the RolePermissions property.

This property is read-only.

See Also

CascadedRolePermissions, RolePermissions, RolePermissionValue Collection.

ContentProvider

Description

This property returns or sets the name of the node for the content reference as a string.

This property takes the following values:

This property is read-write.

CreationDate

Description

This property returns the creation date for this content reference object as a string.

This property is read-only.

Data

Description

This property returns the data for this content reference. This property is valid only when the StorageType property is LOCL.

The length of this property depends on your system database limit for LONG fields.

This property is read-write.

Example

&MyData = &MyCRef.Data;

See Also

Content Reference class: StorageType property.

Description

Description

This property returns or sets the description for this content reference object as a string.

The length of this property is 256 characters.

This property is translatable.

This property is read-write.

HtmlText

Description

This property returns the HTML text associated with this content reference as a string.

This property is read-only.

IsMobile

Description

This property returns True if this content reference is used with mobile applications, False otherwise.

This property is read-write.

IsVisible

Description

This property returns True if the Hide from Portal Navigation check box is not selected when the content reference is created. If the content reference is hidden from portal navigation, this property returns False.

Considerations Using IsVisible

If you do not specifically set this property on a new or copied content reference object, the IsVisible property is set as follows:

• If the ValidFrom date is less then or equal to that day's date, the IsVisible property is set to True.

• If there is no ValidTo date the IsVisible property is set to True.

• If the ValidTo date is greater then or equal to that day's date, the IsVisible property is set to True.

This property is read-only.

See Also

Content Reference class: ValidFrom property, ValidTo property.

Label

Description

This property returns or sets the label for this content reference object as a string.

The length of this property is 30 characters.

This property is translatable.

This property is read-write.

Links

Description

This property returns a reference to a Link collection. This collection contains all the links that are associated with this content reference.

This property is read-only. However, a link collection is updated in realtime when a new link is created on the object.

See Also

Link Collection

Name

Description

This property returns the name for this content reference object as a string. The name is a unique identifier for each content reference object.

Every content reference name must be unique in the portal, not just in the parent folder.

This property is read-only.

OwnerId

Description

This property returns or sets the owner ID of the content reference object as a string.

This property is read-write.

ParentName

Description

This property returns the parent folder name for this content reference object as a string.

This property is read-only.

Example

The following example uses the ParentName to return a folder object for the content reference.

&Folder = &Portal.FindFolderByName(&CRef.ParentName);

Path

Description

The Path property returns a path to this content reference, with each element of the path separated by a period. The path has the following syntax:

ContentReferenceLabel{Name}.[ChildContentReferenceLabel{Name}.]. . .

This property is read-only.

Permissions

Description

This property returns a PermissionValue Collection. This collection contains the value of the non role-based permissions for this content reference. To determine the permissions for all the parent objects (up to the root folder) use the CascadedPermissions property.

If you want to find role-based permissions for the content reference, use the RolePermission property.

This property is read-only.

See Also

PermissionValue Collection, CascadedPermissions, RolePermissions.

Product

Description

This property returns or sets the PeopleSoft product for this content reference object as a string.

The length of this property is 4 characters.

This property is read-write.

PublicAccess

Description

This property indicates whether a content reference is generally accessible, that is, if it will always be included in the general content reference collection. This property takes a Boolean value.

The default value for this property is False.

This property is read-write.

QualifiedURL

Description

Note. This property is being kept for backward compatibility only. If your code uses this property, the value returned is actually from the AbsoluteContentURL property. New applications should use the AbsoluteContentURL property instead.

See Also

Content Reference class: AbsoluteContentURL property.

RelativeURL

Description

This property returns the relative URL in the following format:

../../../Portal/Node/Content_Type/ContentID

For example, from the following URL:

http://mlee2038/servlets/psp/PS84/e_procurement/fdm/c/E_PRO.CheckOut.GBL?page=view&Setid=110&Custid=99

The RelativeURL returns the following:

e_procurement/fdm/c/E_PRO.CheckOut.GBL?page=view&Setid=110&Custid=99

This property is read-only.

RolePermissions

Description

This property returns a RolePermissionValue Collection. This collection contains the value of the role-based permissions for this content reference. To determine the permissions for all the parent objects (up to the root folder) use the CascadedRolePermissions property.

If you want to find non role-based permissions for the content reference, use the Permission property.

This property is read-only.

See Also

CascadedRolePermissions, Permissions, RolePermissionValue Collection.

SequenceNumber

Description

The sequence number is used when returning a collection. The default order of the returned content references is based on the sequence number. Use this property to reorder content references. This property takes a number value.

If there are duplicates in the sequence number, the content references are returned alphabetically.

The length of this property is 4 characters.

This property is read-write.

StorageType

Description

In general, content references contain information about where to get the content, and do not store the content. However, content references that are template or portal component types can have their content accessible directly from the content reference. In these cases, the Data property is valid and can be read or written, and the data is stored locally in the portal database.

When UsageType is a target this property must be set to RMTE and the URLType property should specify what format the Node and URL are in.

When UsageType is either a template or a portal component this property can be set to either LOCL or RMTE.

Note that when StorageType is LOCL, it specifies a static template or portal component. But, when StorageType is RMTE it can specify either:

• a dynamically generated template or portal component

• a static template or portal component

In both cases, the Node and URL properties specifies how to get the template or portal component.

Only templates and homepage tab content references can have StorageType LOCL. The StorageType is always LOCL for homepage tabs. For templates LOCL means that corresponding URL is stored in database, not retrieved by URL.

The following table indicates the usage type, and what type of storage is available.

RMTE is the default value for a new content reference.

The length of this property is 4 characters.

This property is read-write.

See Also

Content Reference class: Data property.

Template

Description

This property returns or sets the name of the template used with this content reference as a string. You must specify the name of an existing template.

This property uses the name not the label of a content reference.

This property is used only when the UsageType property is specified as Target (TARG) and the TemplateType property is specified as HTML.

To return a reference to the content reference that contains the template specified by this property, use the TemplateObject property.

The length of this property is 30 characters.

This property is read-write.

See Also

Content Reference class: UsageType property, TemplateType property, TemplateObject property.

TemplateObject

Description

This property returns a reference to a content reference object that contains the template specified by the Template property as a content reference. If no template is specified with Template, this property returns NULL.

This property is read-only.

See Also

Content Reference class: Template property.

TemplateType

Description

This property indicates whether a template should be used to wrap the content. This property takes a string value.

Values are:

HTML is the default value on a new content reference.

Use the NONE value if the URL should not appear in the portal. An example is when the content reference is a template itself.

If the homepage template for the user is un-retrievable, the system tries to use the default user's template first, before resorting to the portal default template.

When the content reference describes content, this property should be set to HTML.

This property is read-write.

See Also

Using Content References.

URL

Description

This property returns or sets the URL for this content reference object as a string. The URL returns exactlyas it appears in the database.

If you're setting a URL, you must use a unique URL.

The absolute URL, that is, the URL from the node concatenated with this URL must be unique.

You receive an error if the URL your use is already registered.

To retrieve a qualified URL, that is, one that contains the node URI, use the AbsoluteContentURL property.

The length of this property depends on your system database limit for LONG fields.

This property is read-write.

The format of the value for this property depends on the setting of other properties.

See Also

AbsoluteContentURL, Using Content References.

URLType

Description

This property indicates what kind of URL is used to retreive the content. This property takes a string value.

Note. This property is used only for content that has the StorageType property set as Remote.

Values are:

UPGE is the default value on a new content reference.

This property is read-write.

See Also

Content Reference class: StorageType property.

UsageType

Description

This property indicates what the content reference is used for. Several other properties depend on this property.

This property takes a string value.

The length of this property is 4 characters.

TARG is the default value on a new content reference.

This property is read-write.

See Also

Using Content References.

ValidFrom

Description

This property returns or sets the date this content reference is valid from as a string.

This property is read-write.

ValidTo

Description

This property returns or sets the date this content reference is valid until as a string.

This property is read-write.

Note. The PortalRegistry API never uses the ValidTo and ValidFrom fields to determine what to return in a collection. You must check for these values in your application.

Content Reference Collection

The Content Reference Collection provides access to the collection of content references in a Folder object.

The Content Reference Collection is instantiated from the ContentRefs Folder property.

See Folder class: ContentRefs property.

Content Reference Collection Methods

In this section, we discuss the Content Reference collection methods. The methods are discussed in alphabetical order.

DeleteItem

Syntax

DeleteItem(ContentReferenceName)

Description

The DeleteItem method deletes the content reference object identified by ContentReferenceName from the content reference Collection.

If you delete a template for a content reference, and none of the other content references on a page have a template, the default template specified with the ContentProvider is used. If there's no template for the ContentProvider, the template for the PortalRegistry is used. However, if you delete the template for the content reference, the ContentProvider, and the PortalRegistry, you receive a runtime error.

Note. The PortalRegistry classes execute some methods "interactively", that is, as they happen. The item won't be marked for deletion, then actually deleted later. The item is deleted from the database as soon as the method is executed.

Parameters

Returns

A Boolean value: True if the content reference was deleted, False otherwise.

Example

If Not &MyCRef.DeleteItem("Test_CRef") Then
   /* can't delete test data. Do error processing */
End-if;

First

Syntax

First()

Description

The First method returns the first content reference object in the content reference collection.

Parameters

None.

Returns

A content reference object.

Example

&MyCRef = &MyCollection.First();

InsertItem

Syntax

InsertItem(ContentReferenceName, ContentReferenceLabel, Node, URL)

Description

The InsertItem method inserts the content reference object identified by ContentReferenceName into the content reference Collection.

Note. The PortalRegistry classes execute some methods "interactively", that is, as they happen. The item won't be marked for insertion, then actually inserted later. The item is inserted into the database as soon as the method is executed.

Parameters

Returns

A reference to the new content reference object if the method executed successfully, NULL otherwise.

Example

The following example inserts an external content reference that is a template:

&URL = "t/" | &ITEMNAME;
&MyCRef = &CRefColl.InsertItem(&ITEMNAME, &ITEMLABEL, "", &URL);

The following example inserts a content reference where URLType is iScript (USCR):

&URL = "s/WEBLIB_PORTAL.FieldFormula.Portal_Trans_Dyn"
&MyCRef = &CRefColl.InsertItem(&ITEMNAME, &ITEMLABEL, "HRMS", &URL);

See Also

Using Content References.

ItemByName

Syntax

ItemByName(Name)

Description

The ItemByName method returns the content reference object with the name Name.

Parameters

Returns

A content reference object if successful, NULL otherwise.

Example

&MyCRef = &CRefColl.ItemByName("PORTAL_ADMIN);

Next

Syntax

Next()

Description

The Next method returns the next content reference object in the content reference collection. You can use this method only after you have used the First method: otherwise the system doesn’t know where to start.

Parameters

None.

Returns

content reference object.

Example

&MyCRef = &MyCollection.Next();

Content Reference Collection Property

In this section, we discuss the Count property.

Count

Description

This property returns the number of content reference objects in the content reference Collection, as a number.

This property is read-only.

Example

&COUNT = &MY_COLLECTION.Count;

AttributeValue Class

The AttributeValue class provides access to attributes associated with either folders or content references.

AttributeValue objects are instantiated from an Attribute Collection Methods with the First, InsertItem, ItemByName, or Next methods.

See Attribute Collection Methods.

See Using Attributes.

AttributeValue Class Properties

In this section, we discuss the AttributeValue class properties. The properties are discussed in alphabetical order.

Label

Description

This property returns the label of the AttributeValue as a string. This property works with the Translatable property. If Translatable is set to True, the value of Label can be translated.

The length of this property is 30 characters.

This property is read-write.

See Also

AttributeValue class: Translatable property.

Name

Description

This property returns the name of the AttributeValue as a string.

The length of this property is 30 characters.

This property is read-only.

Example

&AttrColl = &Folder.Attributes;
&Attr = &AttrColl.First();
   
   &Scroll = GetLevel0().GetRow(1).GetRowset(Scroll.PORTAL_FLDR_ATR);
   
   &I = 1;
   While All(&Attr)
      &Record = &Scroll.GetRow(&I).GetRecord(Record.PORTAL_FLDR_ATR);
      &Record.PORTAL_ATTR_NAM.Value = &Attr.Name;
      &Record.PORTAL_ATTR_VAL.Value = &Attr.Value;
      &Attr = &AttrColl.Next();
      /* need this check so we don't insert extra blank row */
      If All(&Attr) Then
         &Scroll.InsertRow(&I);
         &I = &I + 1;
      End-If;
End-While;

Translatable

Description

This property specifies if the AttributeValue is translatable. This property takes a Boolean value: True if the AttributeValue can be translated, False otherwise.

If this property is set to True, the value of the Label property can be translated.

Note. Regardless of the order in which attributes were entered, they are ordered according to their translatable property, that is, attributes that have this property set as True come first, followed by attributes that have this property set as False.

This property is read-write.

See Also

AttributeValue class: Label property.

Value

Description

This property returns the value of the AttributeValue as a string.

The length of this property depends on your system database limit for LONG fields.

This property is read-write.

Example

To specify more than a single value for an AttributeValue, you can specify several values separated by a semicolon. For example:

&MyAtt.value = "401k;benefits;dependants;HR";

Attribute Collection

The Attribute Collection provides access to the collection of Attribute in a Folder or a content reference object.

An Attribute Collection is instantiated from other classes as follows:

• From a content reference object with the Attributes property.

• From a Folder object with the Attributes property.

• From a PageletCategory object with the Attributes property.

• From a Pagelet object with the Attributes property.

See Content Reference class: Attributes property.

See Folder class: Attributes property.

See PageletCategory class: Attributes property.

See Pagelet class: Attributes property.

Attribute Collection Methods

In this section, we discuss the Attribute collection methods. The methods are discussed in alphabetical order.

DeleteItem

Syntax

DeleteItem(AttributeValueName)

Description

The DeleteItem method deletes the AttributeValue object identified by AttributeValueName from the Attribute Collection.

This method is not executed automatically. It is executed only when the parent object is saved.

Parameters

Returns

A Boolean value: True if the AttributeValue was deleted, False otherwise.

First

Syntax

First()

Description

The First method returns the first AttributeValue object in the Attribute Collection.

Parameters

None.

Returns

An AttributeValue object.

Example

&MyAttributeValue = &MyCollection.First();

InsertItem

Syntax

InsertItem(AttributeValueName)

Description

The InsertItem method inserts the AttributeValue object identified by AttributeValueName from the Attribute Collection.

This method is not executed automatically. It is executed only when the parent object is saved.

Parameters

Returns

A reference to the new AttributeValue object if the method executed successfully, NULL otherwise.

Example

For &I = 1 To &Rowset.ActiveRowCount
    If &CompName = "PORTAL_CREF_ADM" Then
       &Record = &Rowset.GetRow(&I).GetRecord(Record.PORTAL_CATR_DV);
    Else
       &Record = &Rowset.GetRow(&I).GetRecord(Record.PORTAL_FATR_DV);
    End-If;

    If &Record.PORTAL_ATTR_NAM.Value <> "" Then
       &Attr = &AttrColl.InsertItem(&Record.PORTAL_ATTR_NAM.Value);
       &Attr.Value = &Record.PORTAL_ATTR_VAL.Value;
    End-If;
End-For;

ItemByName

Syntax

ItemByName(Name)

Description

The ItemByName method returns the AttributeValue object with the name Name.

Parameters

Returns

An AttributeValue object if successful, NULL otherwise.

Example

&Attr = &AttrColl.ItembyName("RELLINK");

Next

Syntax

Next()

Description

The Next method returns the next AttributeValue object in the Attribute Collection. You can use this method only after you have used the First method: otherwise the system doesn’t know where to start.

Parameters

None.

Returns

AttributeValue object.

Example

&MyAttributeValue = &MyCollection.Next();

Attribute Collection Property

In this section, we discuss the Count property.

Count

Description

This property returns the number of AttributeValue objects in the Attribute Collection, as a number.

This property is read-only.

Example

&COUNT = &MY_COLLECTION.Count;

PermissionValue Class

The PermissionValue provides access to permission lists associated with folders, content references, PageletCategory objects, or Pagelets.

Note. You cannot add any PermissionValue objects to a collection returned by the CascadedPermissions or CascadedRolePermissions property. You can add values only to the collection returned by the Permissions or RolePermissions property.

PermissionValue objects are instantiated from the following:

• A PermissionValue Collection with the First, InsertItem, ItemByName, or Next methods.

• A RolePermissionValue Collection with the First, InsertItem, ItemByName, or Next methods.

See PermissionValue Collection.

See Using Security.

See Setting Permissions Using the PermissionValue Object.

PermissionValue Class Properties

In this section we discuss the Cascade and Name properties.

Cascade

Description

This property indicates whether the current permission should be granted to all child folders.

This property is valid only with folders, not with content references.

This property takes a Boolean value. The default value for a new PermissionValue object is False.

This property is read-write.

Name

Description

Specify the name of a permission list as the name of this object. You must specify a permission list that has already been created. This property takes a string value.

The length of this property is 30 characters.

This property is read-write.

PermType

Description

Specify the type of the permission. Values are:

This property is read-write.

See Also

RolePermissionValue Collection, PermissionValue Collection.

PermissionValue Collection

A PermissionValue collection is returned by the following:

• CascadedPermissions and Permissions folder property

• CascadedPermissions and Permissions content reference property

• CascadedPermissions and Permissions PageletCategory object property

• CascadedPermissions and Permissions Pagelet property

What is contained in the PermissionValue collection depends on the property that created it.

See Folder class: CascadedPermissions property, Permissions property.

See Content Reference class: CascadedPermissions property, Permissions property.

See PageletCategory class: CascadedPermissions property, Permissions property.

See Pagelet class: CascadedPermissions property, Permissions property.

See Using Security.

PermissionValue Collection Methods

In this section, we discuss the PermissionValue collection methods. The methods are discussed in alphabetical order.

DeleteItem

Syntax

DeleteItem(PermissionValueName)

Description

The DeleteItem method deletes the PermissionValue object identified by PermissionValueName from the PermissionValue Collection.

This method is not executed automatically. It is executed only when the parent object is saved.

Parameters

Returns

A Boolean value: True if the PermissionValue was deleted, False otherwise.

Example

If Not &MyPValColl.DeleteItem("ALLPNLS") Then 
   /* do error processing */
End-If;

First

Syntax

First()

Description

The First method returns the first PermissionValue object in the PermissionValue collection.

Parameters

None.

Returns

A PermissionValue object.

Example

&MyPermissionValue = &MyCollection.First();

InsertItem

Syntax

InsertItem(PermissionValueName)

Description

The InsertItem method inserts the PermissionValue object identified by PermissionValueName into the PermissionValue Collection.

This method is not executed automatically. It is executed only when the parent object is saved.

Note. You cannot add any PermissionValue objects to a collection returned by the CascadedPermissions property. You can only add values to the collection returned by the Permissions property.

Parameters

Returns

A reference to the new PermissionValue object if the method executed successfully, NULL otherwise.

Example

&MyPermV = &MyPermVColl.InsertItem("ALLPNLS");

If Not &MyPermV Then 
   /* do error processing */
End-If;

ItemByName

Syntax

ItemByName(Name)

Description

The ItemByName method returns the PermissionValue object with the name Name.

Parameters

Returns

A PermissionValue object if successful, NULL otherwise.

Example

&MyPVal = &MyPValColl.ItemByName("CUSTOMER");

Next

Syntax

Next()

Description

The Next method returns the next PermissionValue object in the PermissionValue collection. You can use this method only after you have used the First method: otherwise the system doesn’t know where to start.

Parameters

None.

Returns

PermissionValue object.

Example

&MyPermissionValue = &MyCollection.Next();

PermissionValue Collection Property

In this section, we discuss the Count property.

Count

Description

This property returns the number of PermissionValue objects in the PermissionValue Collection, as a number.

This property is read-only.

Example

&COUNT = &MY_COLLECTION.Count;

RolePermissionValue Collection

A RolePermissionValue collection is returned by the following:

• CascadedRolePermissions and RolePermissions folder property

  See Folder class: CascadedRolePermissions property.

  See Folder class: RolePermissions property.

• CascadedRolePermissions and RolePermissions content reference property

  See Content Reference class: CascadedRolePermissions property.

  See Content Reference class: RolePermissions property.

• CascadedRolePermissions and RolePermissions content reference link property

  See Content Reference Link class: CascadedRolePermissions property.

  See Content Reference Link class: RolePermissions property.

What is contained in the RolePermissionValue collection depends on the property that created it.

RolePermissionValue Collection Methods

In this section, we discuss the RolePermissionValue collection methods. The methods are discussed in alphabetical order.

DeleteItem

Syntax

DeleteItem(RolePermissionValueName)

Description

The DeleteItem method deletes the RolePermissionValue object identified by RolePermissionValueName from the RolePermissionValue Collection.

This method is not executed automatically. It is executed only when the parent object is saved.

Parameters

Returns

A Boolean value: True if the RolePermissionValue was deleted, False otherwise.

Example

If Not &MyPValColl.DeleteItem("ALLPNLS") Then 
   /* do error processing */
End-If;

First

Syntax

First()

Description

The First method returns the first RolePermissionValue object in the RolePermissionValue collection.

Parameters

None.

Returns

A RolePermissionValue object.

Example

&MyRolePermissionValue = &MyCollection.First();

InsertItem

Syntax

InsertItem(RolePermissionValueName)

Description

The InsertItem method inserts the RolePermissionValue object identified by RolePermissionValueName into the RolePermissionValue Collection.

This method is not executed automatically. It is executed only when the parent object is saved.

Note. You cannot add any RolePermissionValue objects to a collection returned by the CascadedRolePermissions property. You can only add values to the collection returned by the RolePermissions property.

Parameters

Returns

A reference to the new RolePermissionValue object if the method executed successfully, NULL otherwise.

Example

&MyPermV = &MyPermVColl.InsertItem("ALLPNLS");

If Not &MyPermV Then 
   /* do error processing */
End-If;

ItemByName

Syntax

ItemByName(Name)

Description

The ItemByName method returns the RolePermissionValue object with the name Name.

Parameters

Returns

A RolePermissionValue object if successful, NULL otherwise.

Example

&MyPVal = &MyPValColl.ItemByName("CUSTOMER");

Next

Syntax

Next()

Description

The Next method returns the next RolePermissionValue object in the RolePermissionValue collection. You can use this method only after you have used the First method: otherwise the system doesn’t know where to start.

Parameters

None.

Returns

RolePermissionValue object.

Example

&MyRolePermissionValue = &MyCollection.Next();

RolePermissionValue Collection Property

In this section, we discuss the Count property.

Count

Description

This property returns the number of RolePermissionValue objects in the RolePermissionValue Collection, as a number.

This property is read-only.

Example

&COUNT = &MY_COLLECTION.Count;

Content Reference Links

A content reference link is a content reference object that delegates most of its properties to another content reference. It has its own separate properties, as well as a reference to the linked cref.

A content reference link is instantiated from the following:

• CreateLink content reference method

• CreateContentRefLink PortalRegistry method

Note. The CreateLink method creates a new link. To instantiate an existing link use the FindLinkByName method.

See Also

CreateContentRefLink

FindCRefLinkByName

CreateLink

Content Reference Link Methods

In this section, we discuss the content reference link methods. The methods are discussed in alphabetical order.

Delete

Syntax

Delete()

Description

Use the delete method to delete the link from the database.

Note. The PortalRegistry classes execute some methods "interactively", that is, as they happen. The link is not marked for deletion, then actually deleted later. The link is deleted from the database as soon as the method is executed.

Parameters

None.

Returns

A Boolean value: True if the content reference link and its associated objects are deleted successfully, False otherwise.

Save

Syntax

Save()

Description

The Save method saves any changes you made to the content reference link, for example, a changed description or ValidFrom date.

After you create a link using either the CreateLink or CreateContentRefLink methods you must use the Save method to save the link to the database.

Using this method also saves any changes you made to PermissionValue or AttributeValue objects associated with this content reference link.

Parameters

None.

Returns

A Boolean value: True if the content reference link and its associated objects saved successfully, False otherwise. If False is returned, a message is also written to the PSMessage collection.

Example

If NOT(&MyCRefLink.Save()) Then
   /* save failed, do error processing */
End-If;

Content Reference Link Properties

In this section, we discuss the content reference link properties. The properties are discussed in alphabetical order.

AbsoluteContentURL

Description

This property returns the absolute content URL, that is, the content from the content servlet (psc). The content is displayed without any portal template.

This property is read-only.

Example

The following is an example absolute content URL:

http://serverx/psc/PS84/EMPLOYEEPORTAL/CRM/c/SFA.CUSTOMERINFO.GBL?page=CUST_DATA1&&Action=U&emplid=00001

AbsolutePortalURL

Description

This property returns the absolute content reference link portal URL. This URL also contains the content in the portal template.

This property is read-only.

Example

http://serverx/psp/PS84/EMPLOYEEPORTAL/CRM/c/SFA.CUSTOMERINFO.GBL?page=CUST_DATA1&&Action=U&emplid=00001

Attributes

Description

This property returns an Attribute Collection containing the AttributeValues for this content reference link object.

This property is read-write.

See Also

Attribute Collection.

Author

Description

This property returns the author (PeopleSoft user ID) for this content reference link as a string.

This property is read-only.

AuthorAccess

Description

This property specifies whether the author of the content reference link has access to the content reference link. This property takes a Boolean value. The default value for this property is true.

This property is read-write.

Authorized

Description

This property specifies whether the user is authorized to view this content reference link.

This property is used when you access a particular content reference link using FindCRefLinkByURL. If you specified a valid content reference link, a content reference link is always returned, whether you are authorized to view it or not. This is the only property you can view from an object that you are not authorized tom and the content reference is empty.

The initial value of this property depends on the other permission properties (PublicAccess and AuthorAccess) and the permission list values in the PermissionValue object associated with this content reference link.

This property is read-only.

See Also

FindCRefLinkByName

CascadedPermissions

Description

This property returns a PermissionValue Collection. This collection contains the value of the permissions for all the parent objects (up to the root folder). To determine only the permissions of the object use the Permissions property instead.

Note. You cannot add any PermissionValue objects to a collection returned by the CascadedPermissions property. You can add values only to the collection returned by the Permissions property.

This property is read-only.

See Also

PermissionValue Collection, Permissions.

CascadedRolePermissions

Description

This property returns a RolePermissionValue Collection. This collection contains the value of the role-based permissions for all the parent objects (up to the root folder). To determine only the permissions of the object use the RolePermissions property instead. To determine the non role-based permissions of the object use the Permissions property instead.

Note. You cannot add any PermissionValue objects to a collection returned by the CascadedRolePermissions property. You can add values only to the collection returned by the RolePermissions property.

This property is read-only.

See Also

CascadedRolePermissions, RolePermissions, RolePermissionValue Collection.

ContentProvider

Description

This property returns the name of the node for the content reference link as a string.

This property is read-only.

CreationDate

Description

This property returns the creation date for this content reference link object as a string.

This property is read-only.

Data

Description

This property returns the data for this content reference link. This property is valid only when the StorageType property is LOCL.

The length of this property depends on your system database limit for LONG fields.

This property is read-write.

Example

&MyData = &MyCReflink.Data;

See Also

Content Reference class: StorageType property.

Description

Description

This property returns or sets the description for this content reference link object as a string.

The length of this property is 256 characters.

This property is translatable.

This property is read-write.

IsMobile

Description

This property returns True if this content reference link is used with mobile applications, False otherwise.

This property is read-write.

IsVisible

Description

This property returns True if the Hide from Portal Navigation check box is not selected when the content reference link is created. If the content reference link is hidden from portal navigation, this property returns False. Also, if the date associated with the link is not valid (is not within the valid to and valid from dates,) this property returns False.

Considerations Using IsVisible

If you do not specifically set this property on a new or copied content reference link, the IsVisible property is set as follows:

• If the ValidFrom date is less then or equal to that day's date, the IsVisible property is set to True.

• If there is no ValidTo date the IsVisible property is set to True.

• If the ValidTo date is greater then or equal to that day's date, the IsVisible property is set to True.

This property is read-only.

See Also

Content Reference class: ValidFrom property, ValidTo property.

Label

Description

This property returns or sets the label for this content reference link object as a string.

The length of this property is 30 characters.

This property is translatable.

This property is read-write.

Name

Description

This property returns the name for this content reference link object as a string. The name is a unique identifier for each content reference link object. The name cannot start with a number, and it cannot have spaces and special characters.

Every content reference link name must be unique in the portal, not just in the parent folder.

This property is read-write.

OwnerId

Description

This property returns or sets the owner ID of the content reference link object as a string.

This property is read-write.

ParentName

Description

This property returns the parent folder name for this content reference link object as a string.

You can use this property to move the content reference link to another folder.

This property is read-write.

Example

The following example uses the ParentName to return a folder object for the content reference link.

&Folder = &Portal.FindFolderByName(&CReflink.ParentName);

Path

Description

The Path property returns a path to this content reference link, with each element of the path separated by a period. The path has the following syntax:

Root{PORTAL_ROOT_OBJECT}.LinkFolder {<Id of links folder>}.CrefLink {<Id of the cref link> }

This property is read-only.

Permissions

Description

This property returns a PermissionValue Collection. This collection contains the value of the non role-based permissions for this content reference link. To access the role-based permissions, use the RolePermissions property.

This property is read-only.

See Also

PermissionValue Collection, CascadedPermissions, RolePermissions.

Product

Description

This property returns or sets the PeopleSoft product for this content reference link object as a string.

The length of this property is 4 characters.

This property is read-write.

PublicAccess

Description

This property specifies whether the link is public or private. This property takes a Boolean value: true if the content reference link is public and there are no permission lists associated with it. If it is false, the link uses permission list control.

For links, this values is same as that of the linked content reference. If the content reference is public, the link is public and can be viewed by anyone logged on to the system.

This property is read-only.

RelativeURL

Description

This property returns the relative URL in the following format:

../../../Portal/Node/Content_Type/ContentID

For example, from the following URL:

http://mlee2038/servlets/psp/PS84/e_procurement/fdm/c/E_PRO.CheckOut.GBL?page=view&Setid=110&Custid=99

The RelativeURL returns the following:

e_procurement/fdm/c/E_PRO.CheckOut.GBL?page=view&Setid=110&Custid=99

This property is read-only.

RolePermissions

Description

This property returns a RolePermissionValue Collection. This collection contains the value of the role-based permissions for this content reference link. To access the non role-based permissions, use the Permissions property.

This property is read-only.

See Also

CascadedRolePermissions, Permissions, RolePermissionValue Collection.

SequenceNumber

Description

The sequence number is used when returning a collection. The default order of the returned content reference links is based on the sequence number. Use this property to reorder content reference links. This property takes a number value.

If there are duplicates in the sequence number, the content reference links are returned alphabetically.

The length of this property is 4 characters.

This property is read-write.

Template

Description

This property returns or sets the name of the template used with this content reference link as a string. You must specify the name of an existing template.

This property uses the name, not the label, of a content reference link.

This property is used only when the UsageType property is specified as Target (TARG) and the TemplateType property is specified as HTML.

To return a reference to the content reference link that contains the template specified by this property, use the TemplateObject property.

The length of this property is 30 characters.

This property is read-write.

See Also

Content Reference class: UsageType property, TemplateType property, TemplateObject property.

TemplateObject

Description

This property returns a reference to a content reference link object that contains the template specified by the Template property as a content reference link. If no template is specified with Template, this property returns a null value.

This property is read-only.

See Also

Content Reference class: Template property.

TemplateType

Description

This property indicates whether a template should be used to wrap the content. This property takes a string value.

Values are:

HTML is the default value on a new content reference.

Use the NONE value if the URL should not appear in the portal. An example is when the content reference link is a template itself.

If the homepage template for the user is un-retrievable, the system tries to use the default user's template first, before resorting to the portal default template.

When the content reference link describes content, this property should be set to HTML.

This property is read-write.

See Also

Using Content References.

URL

Description

This property returns the URL for this content reference link object as a string. The content reference link derives the URL from the content reference it is linked to. The URL of the link is same as that of the linked content reference.

A query string value is added on the content reference URL to make the link unique. If the URL of the linked content reference changes, this URL is changed.

This property is read-only.

See Also

AbsoluteContentURL, Using Content References.

URLType

Description

This property returns what kind of URL is used to retreive the content.

This property is read-only.

See Also

Content Reference class: StorageType property.

UsageType

Description

This property returns what the content reference link is used for.

The value for this property is same as that of the content reference when the link is vieved as a content reference.

The usage type of the link is LINK in the database.

A content reference link can be created only for content references that have a type of TARG.

This property is read-only.

See Also

Using Content References.

ValidFrom

Description

This property returns or sets the date this content reference link is valid from as a string.

This property is read-write.

ValidTo

Description

This property returns or sets the date this content reference link is valid until as a string.

This property is read-write.

Note. The PortalRegistry API never uses the ValidTo and ValidFrom fields to determine what to return in a collection. You must check for these values in your application.

Link Collection

A Links collection is returned by the Links content reference property.

See Also

Links

Link Collection Methods

In this section, we discuss the link collection methods. The methods are discussed in alphabetical order.

First

Syntax

First()

Description

The First method returns the first link object in the link collection.

Parameters

None.

Returns

A link object.

Next

Syntax

Next()

Description

The Next method returns the next link object in the collection. You can use this method only after you have used the First method: otherwise the system doesn’t know where to start.

Parameters

None.

Returns

A link object.

Link Collection Property

In this section, we discuss the link collection property Count.

Count

Description

This property returns the number of link objects in the link collection, as a number.

This property is read-only.

Link Class

A Link object is returned by the First and Next Link collection methods.

See Also

Link Collection Methods

Link Properties

In this section, we discuss the link properties. The properties are discussed in alphabetical order.

LinksObjectName

Description

This property returns the object name of the link as a string.

This property is read-only.

LinksObjectType

Description

This property returns the object type as a string. Valid value is CONTENTREF.

This property is read-only.

LinksPortalName

Description

This property returns the name of the portal from which the link originated.

This property is read-only.

TabDefinition Class

The TabDefinition class provides access to the homepage tab defined for the portal.

TabDefinition objects are instantiated from a TabDefinition Collection with the First, InsertItem, ItemByName, or Next methods.

See TabDefinition Collection.

TabDefinition Class Methods

In this section, we discuss the Save method.

Save

Syntax

Save()

Description

The Save method saves any changes you made to the TabDefinition, for example, a changed description. It also performs some validation.

Using this method also saves any changes you made to DynamicCategories and AssignedPagelets objects associated with this TabDefinition.

Parameters

None.

Returns

A Boolean value: True if the TabDefinition and its associated object saved successfully, False otherwise.

Example

If NOT(&MyTabDefn.Save()) Then
   /* save failed, do error processing */
End-If;

See Also

Save PortalRegistry method

Save Folder method

Save ContentReference method

TabDefinition Class Properties

In this section, we discuss the TabDefinition class properties. The properties are discussed in alphabetical order.

AssignedPagelets

Description

This property returns a reference to an AssignedPagelet Collection for this TabDefinition object.

This property is read-only.

See Also

AssignedPagelet Collection.

AvailableCategories

Description

This property returns a reference to an AvailableCategory Collection for this TabDefinition object.

This property is read-only.

See Also

AvailableCategory Collection.

AvailablePagelets

Description

This property returns a reference to an AvailablePagelet Collection for this TabDefinition object.

This property is read-only.

See Also

AvailablePagelet Collection.

Attributes

Description

This property returns an Attribute Collection containing the AttributeValues for this TabDefinition object.

This property is read-only.

See Also

Attribute Collection.

Author

Description

This property returns the author (PeopleSoft user ID) for this TabDefinition object as a string.

This property is read-only.

AuthorAccess

Description

This property specifies whether the author of the TabDefinition has access to the TabDefinition. This property takes a Boolean value. The default value for this property is True.

This property is read-write.

ColumnLayout

Description

This property indicates whether the tab layout is for two or three columns. This property takes a string value.

The values for this property are:

This property is read-write.

CreationDate

Description

This property returns the creation date for this TabDefinition object as a string.

This property is read-only.

Description

Description

This property returns or sets the description for this TabDefinition object as a string.

The length of this property is 256 characters.

This property is translatable.

This property is read-write.

DynamicCategories

Description

This property returns a reference to a DynamicCategory Collection for this TabDefinition object.

This property is read-only.

See Also

DynamicCategory Collection.

HelpID

Description

This property returns the help system identifier for this tab. It enables the help system to provide tab-specific help. This property takes a string value.

This property is read-write.

HtmlText

Description

This property returns the HTML text associated with this tab definition as a string.

This property is read-only.

IsHideActionBar

Description

This property hides all pagelet action bar images for all pagelets used on this tab. This property overrides any properties for the pagelets used on this tab. This property takes a Boolean value: True, hide images, False, display images

This property is read-write.

IsLayoutLocked

Description

This property indicates whether the user can change the tab's default number of columns. This property takes a Boolean value: True, the user can change the tab columns, False, the columns can't be changed by the user.

This property is read-write.

IsRenameable

Description

This property indicates whether the tab's label can be changed by the user. This property takes a Boolean value: True, the user can change the label, False, the user can't.

This property is read-write.

Label

Description

This property returns or sets the label for this TabDefinition object as a string.

The length of this property is 30 characters.

This property is translatable.

This property is read-write.

LayoutBehavior

Description

This property indicates whether the user can change when and how the tab displays. This property takes a string value.

The values are:

This property is read-write.

Name

Description

This property returns the name for this TabDefinition object as a string. The name is a unique identifier for each TabDefinition object.

Every TabDefinition name must be unique in the portal, not just in the parent folder.

This property is read-only.

OwnerId

Description

This property returns or sets the owner ID of the TabDefinition object as a string.

This property is read-write.

Product

Description

This property returns or sets the PeopleSoft product for this TabDefinition object as a string.

The length of this property is 4 characters.

This property is read-write.

PublicAccess

Description

This property indicates whether a TabDefinition is generally accessible, that is, if it is always included in the general TabDefinition collection. This property takes a Boolean value.

The default value for this property is False.

This property is read-write.

QualifiedURL

Description

This property returns an absolute URL. If the TabDefinition has a ContentProvider associated with it, the URI from the ContentProvider is concatenated with the URL from the TabDefinition. If there is no ContentProvider, this property returns the text in the URL property.

This property is read-only.

See Also

Content Reference class: URL property.

SequenceNumber

Description

The sequence number is used when returning a collection. The default order of the returned TabDefinitions is based on the sequence number. Use this property to reorder TabDefinitions. This property takes a number value.

If there are duplicates in the sequence number, the TabDefinitions are returned alphabetically.

The length of this property is 4 characters.

This property is read-write.

StyleSheet

Description

This property defines the style sheet to use for this tab. This property takes a string value. This property is 30 characters long.

If no style sheet is specified, the default style sheet PSSTYLEDEF is used.

This property is read-write.

ValidFrom

Description

This property returns or sets the date this TabDefinition is valid from as a string.

This property is read-write.

ValidTo

Description

This property returns or sets the date this TabDefinition is valid until as a string.

This property is read-write.

Note. The PortalRegistry API never uses the ValidTo and ValidFrom fields to determine what to return in a collection. You must check for these values in your application.

TabDefinition Collection

A TabDefinition collection is the collection of all TabDefinitions for a portal.

A TabDefinition collection is returned by the TabDefinitions PortalRegistry property.

See PortalRegistry class: TabDefinitions property.

TabDefinition Collection Methods

This section describes the TabDefinition collection methods in alphabetical order.

DeleteItem

Syntax

DeleteItem(TabDefinitionName)

Description

The DeleteItem method deletes the TabDefinition object identified by TabDefinitionName from the TabDefinition Collection.

Note. The PortalRegistry classes execute some methods "interactively", that is, as they happen. The item won't be marked for deletion, then actually deleted later. The item is deleted from the database as soon as the method is executed.

Parameters

Returns

A Boolean value: True if the TabDefinition was deleted, False otherwise.

Example

If Not &MyColl.DeleteItem("TabDefnTest") Then 
   /* do error processing */
End-If;

First

Syntax

First()

Description

The First method returns the first TabDefinition object in the TabDefinition collection.

Parameters

None.

Returns

A TabDefinition object.

Example

&MyTabDefinition = &MyCollection.First();

InsertItem

Syntax

InsertItem(TabDefinitionName)

Description

The InsertItem method inserts the TabDefinition object identified by TabDefinitionName into the TabDefinition Collection.

Note. The PortalRegistry classes execute some methods "interactively", that is, as they happen. The item won't be marked for insertion, then actually inserted later. The item is inserted into the database as soon as the method is executed.

Parameters

Returns

A reference to the new TabDefinition object if the method executed successfully, NULL otherwise.

Example

&MyTabDef = &MyColl.InsertItem("Empl_Homepage");

If Not &MyTabDef Then 
   /* do error processing */
End-If;

ItemByName

Syntax

ItemByName(Name)

Description

The ItemByName method returns the TabDefinition object with the name Name.

Parameters

Returns

A TabDefinition object if successful, NULL otherwise.

Example

&MyTebDefn = &MyColl.ItemByName("Empl_Homepage");

Next

Syntax

Next()

Description

The Next method returns the next TabDefinition object in the TabDefinition collection. You can use this method only after you have used the First method: otherwise the system doesn’t know where to start.

Parameters

None.

Returns

TabDefinition object.

Example

&MyTabDefinition = &MyCollection.Next();

TabDefinition Collection Property

In this section, we discuss the Count property.

Count

Description

This property returns the number of TabDefinition objects in the TabDefinition Collection, as a number.

This property is read-only.

Example

&COUNT = &MY_COLLECTION.Count;

AssignedPagelet Class

An AssignedPagelet is a pagelet object that has been assigned to a particular tab. This pagelet also contains the layout data that is specific to the pagelet and tab.

AssignedPagelet objects are instantiated from an AssignedPagelet Collection with the First, InsertItem, ItemByName, or Next methods.

See AssignedPagelet Collection.

AssignedPagelet Class Properties

In this section, we discuss the AssignedPagelet class properties. The properties are discussed in alphabetical order.

Column

Description

This property returns the column in which this pagelet is displayed, as a number.

This property is read-write.

LayoutBehavior

Description

This property indicates whether the user can change when and how the pagelet displays. This property takes a string value.

The values are:

This property is read-write.

PageletName

Description

This property returns the name for this Pagelet object as a string. The name is a unique identifier for each Pagelet object.

This property is read-only.

Row

Description

This property returns the row in which this pagelet is displayed, as a number.

This property is read-write.

AssignedPagelet Collection

An AssignedPagelet collection is returned by the AssignedPagelet TabDefinition method.

It contains a collection of all the pagelets explicitly assigned to the tab.

See TabDefinition class: AssignedPagelets property.

See AssignedPagelet Class.

AssignedPagelet Collection Methods

In this section, we discuss the AssignedPagelet collection methods. The methods are discussed in alphabetical order.

DeleteItem

Syntax

DeleteItem(PageletName)

Description

The DeleteItem method deletes the AssignedPagelet object identified by PageletName from the AssignedPagelet Collection.

This method is not executed automatically. It is executed only when the parent object is saved.

Parameters

Returns

A Boolean value: True if the AssignedPagelet was deleted, False otherwise.

Example

If Not &MyColl.DeleteItem("Weather_411") Then 
   /* do error processing */
End-If;

First

Syntax

First()

Description

The First method returns the first AssignedPagelet object in the AssignedPagelet collection.

Parameters

None.

Returns

An AssignedPagelet object.

Example

&MyAssignedPagelet = &MyCollection.First();

InsertItem