11 Performing Simple Content Management Tasks

11.1.1 Creating the WWSBR_USER_PAGES View

The modify_folder API takes a page record as a parameter. To populate the page record, you need to query the data from the WWSBR_USER_PAGES view. This view lists all the pages on which the current user has Manage privileges. If the WWSBR_USER_PAGES view does not already exist in your portal schema, you will need to create it.

To create the WWSBR_USER_PAGES view:

1. Log in to SQL*Plus as the portal schema owner, for example:

   sqlplus portal/oracle1
   
   

2. Create the WWSBR_USER_PAGES view:

   create or replace view WWSBR_USER_PAGES as
   select *
   from WWV_USER_OWNED_CORNERS
   /
   
   

3. If the procedures and packages that reference this view exist in a schema other than the portal schema, you need to grant privileges on the view to that schema:

   grant select on WWSBR_USER_PAGES to <schema>
   /
   
   

11.2.1 Setting Item Attributes

If you want to set a particular attribute for an item, use the set_attribute API. This API updates the value of an attribute for a particular version of an item. The values provided are validated against the data type of the attribute. You can use this API to set the value of a base attribute (see Table 11-2) or a custom attribute. You cannot use this API to edit rejected items, items marked for deletion, and rejected items that have been marked for deletion.

begin
  wwsbr_api.set_attribute(
    p_site_id           => 37,
    p_thing_id          => 8056,
    p_attribute_site_id => wwsbr_api.SHARED_OBJECTS,
    p_attribute_id      => wwsbr_api.ATTRIBUTE_TITLE,
    p_attribute_value   => 'New Display Name'
  );
  -- Process cache invalidation messages.
  wwpro_api_invalidation.execute_cache_invalidation;
exception
  ...
end;
/

• p_site_id is the ID of the page group to which the item belongs.

• p_thing_id is the unique item ID. The item ID identifies the particular version of the item that you want to edit.

• p_attribute_site_id is the ID of the page group to which the attribute belongs. For base attributes, use the wwsbr_api.SHARED_OBJECTS constant.

• p_attribute_id is the ID of the attribute. For base attributes, use the constants from the WWSBR_API package as shown in Table 11-2.

• p_attribute_value is the new value that you want to assign to the attribute. For base attributes, see Table 11-2.

For information about how to obtain an object ID, for example a page group ID or item ID, refer to Section 10.3, "Finding an Object ID".

Table 11-2 provides guidelines for setting the values of base attributes.

http://portalcenter.oracle.com

11.2.2 Editing an Item

To edit an existing item, use the modify_item API. As well as setting the properties of the item, this API also enables you to:

• Add new versions of the item (if item versioning is enabled for the page). See Section 11.2.4, "Using Version Control".

• Enable item level security for the item (if item level security (ILS) is enabled for the page). See Section 15.3, "Setting Item Level Privileges" for an alternative way of doing this.

• Upload files that are associated with the item. If the file that you want to associate with the item has already been uploaded, use the modify_item_post_upload API instead.

You should use this API to edit only those items with an ACTIVE value of 1. That is, do not use it to edit pending, rejected, or deleted items.

You must pass both the item's master ID to identify the item and its ID to identify the specific version of the item that you want to update. The specified ID does not have to be the current version of the item. For information about obtaining an object ID, refer to Section 10.3, "Finding an Object ID".

The modify_item API modifies the value of every attribute, even if the attribute is not passed in the parameter list. If an attribute is not passed, its value will revert to the default value of the parameter. If you want to preserve the current value of attributes, you must retrieve those values for the item and pass them to the API. The value of attributes can be retrieved from the following views and APIs:

• WWSBR_ALL_ITEMS for built-in attributes

• WWSBR_ITEM_ATTRIBUTES for custom attributes

• WWSBR_ITEM_TYPE_ATTRIBUTES for a list of attributes for an item type

• WWSBR_ITEM_PERSPECTIVES for perspectives

• wwsec_api.grantee.list for a list of privileges on the item type. See Section 15.3, "Setting Item Level Privileges" for more information on using this API.

Example 11-3 updates the display name and text of a text item.

declare
  l_item_master_id number;
begin
  l_item_master_id := wwsbr_api.modify_item(
    p_master_item_id => 453,
    p_item_id        => 454,
    p_caid           => 33,
    p_folder_id      => 45,
    p_display_name   => 'Movie Review',
    p_text           => 'This is the text of the review.'
  );
  -- Process cache invalidation messages.
  wwpro_api_invalidation.execute_cache_invalidation;
exception
  ...
end;
/

• p_master_item_id is the master ID of the item. You can look up this value in the MASTERID column of the WWSBR_ALL_ITEMS view.

• p_item_id is the ID of the item. This identifies the version of the item and does not have to be the item's current version.

  
  

  Tip: To identify the item's current version, use the following query: select id from wwsbr_all_items where master_id = 453 and is_current_version = 1;

  
  

• p_caid is the ID of the page group to which the item belongs.

• p_folder_id is the ID of the page on which the item appears.

• p_display_name is the display name (title) of the item.

• p_text is the text for the item (the item in this example is a text item).

11.2.3 Checking Items Out and In

If an item is enabled for check-out, before editing it, you should check the item out so that other users cannot make changes at the same time (Example 11-4).

begin
  -- Check out the item.
  wwsbr_api.check_out_item(
    p_master_item_id => 12345, -- Master ID is the same for all versions.
    p_caid           => 33
  );
  -- Update the display name of the item.
  wwsbr_api.set_attribute(
    p_site_id => 33,
    p_thing_id => 8056, -- Unique item ID.
    p_attribute_site_id => wwsbr_api.SHARED_OBJECTS,
    p_attribute_id      => wwsbr_api.ATTRIBUTE_TITLE,
    p_attribute_value   => 'New Display Name'
  );
  -- Check the item back in.
  wwsbr_api.check_in_item(
    p_master_item_id => 12345, -- Master ID is the same for all versions.
    p_caid           => 33
  );
  -- Process cache invalidation messages.
  wwpro_api_invalidation.execute_ache_invalidation;
exception
  ...
end;
/

• p_master_item_id is the master ID of the item being checked out or in.

• p_caid is the ID of the page group to which the item belongs.

For information about the set_attribute API used in Example 11-4, refer to Section 11.2.1, "Setting Item Attributes".

11.2.4 Using Version Control

When you edit an item using the modify_item API, if you set p_addnewversion = TRUE, a new version is created for the item. The new version is given a new ID (the master ID stays the same). If you do not want the new version of the item to be immediately published as the current version, set p_add_as_current_version = FALSE.

declare
  l_item_master_id number;
begin
  l_item_master_id := wwsbr_api.modify_item(
    p_master_item_id => 453,
    p_item_id        => 454,
    p_caid           => 33,
    p_folder_id      => 45,
    p_display_name   => 'Movie Review',
    p_text           => 'This is the text of the review.',
    p_addnewversion  => true
  );
  -- Process cache invalidation messages.
  wwpro_api_invalidation.execute_cache_invalidation;
exception
  ...
end;
/

For a description of the parameters used here, see Example 11-3.

11.3.1 Moving an Item to a Different Page

You can use the move_item API to move an item to a different page in the same page group or to a page in a different page group. Moving an item preserves the item's metadata. To move an item to a different page group, the item must not be:

• based on a local item type.

• associated with a local category.

• associated with any local perspectives.

Example 11-6 moves an item from one page group to a page in a different page group.

begin
  wwsbr_api.move_item(
    p_caid           => 33,
    p_master_item_id => 12345,
    p_dest_caid      => 53,
    p_dest_page_id   => 1,
    p_dest_region_id => 5
  );
  -- Process cache invalidation messages.
  wwpro_api_invalidation.execute_cache_invalidation;
exception
  ...
end;
/

• p_caid is the ID of the page group to which the item currently belongs.

• p_master_item_id is the master ID of the item that you want to move.

• p_dest_caid is the ID of the page group to which you want to move the item.

• p_dest_page_id is the ID of the page to which you want to move the item.

• p_dest_region_id is the ID of the item region of the page in which you want to move the item. If you do not specify a region ID, the item is moved to the page's default item region, which may not be desirable.

11.3.2 Moving Pages

You can use the move_folder API to move a page within the same page group. You cannot move a page to a different page group.

To move a page, users must have Manage privileges on the page being moved and the page under which the page is being moved.

Example 11-7 shows how to move a page.

begin
  wwsbr_api.move_folder(
    p_id        => 12345,
    p_siteid    => 33,
    p_parent_id => 10000
  );
  -- Process cache invalidation messages.
  wwpro_api_invalidation.execute_cache_invalidation;
exception
  ...
end;
/

• p_id is the ID of the page that you want to move.

• p_siteid is the ID of the page group to which the page belongs.

• p_parent_id is the ID of the page under which you want to move the page.

11.3.3 Moving Categories and Perspectives

You can, if necessary, move categories and perspectives around within a page group. You cannot move a category or perspective to a different page group.

To move a category or perspective, a user must have Manage Classifications privileges or higher on the owning page group.

To move a category, use the move_category API.

begin
  wwsbr_api.move_category(
    p_src_id => 2000,
    p_dest_id => 3000,
    p_siteid  => 33
  );
exception
  ...
end;
/

To move a perspective, use the move_perspective API.

begin
  wwsbr_api.move_perspective(
    p_src_id => 2000,
    p_dest_id => 3000,
    p_siteid  => 33
  );
exception
  ...
end;
/

• p_src_id is the ID of the category or perspective that you want to move.

• p_dest_id is the ID of the category or perspective under which you want to move the category or perspective.

• p_siteid is the ID of the page group to which the category or perspective belongs.

11.4.1 Copying Items

You can use the copy_item API to copy an item to a different page in the same page group or to a page in a different page group. To copy an item to a different page group, the item must not be:

• based on a local item type

• associated with a local category

• associated with any local perspectives

Copying an item preserves the item's metadata.

Example 11-10 copies an item to a page in a different page group:

begin
  wwsbr_api.copy_item(
    p_caid           => 33,
    p_master_item_id => 12345,
    p_dest_caid      => 53,
    p_dest_page_id   => 1,
    p_dest_region_id => 5
  );
  -- Process cache invalidation messages.
  wwpro_api_invalidation.execute_cache_invalidation;
exception
  ...
end;
/

• p_caid is the ID of the page group to which the item currently belongs.

• p_master_item_id is the master ID of the item that you want to copy.

• p_dest_caid is the ID of the page group to which you want to copy the item.

• p_dest_page_id is the ID of the page to which you want to copy the item.

• p_dest_region_id is the ID of the item region of the page in which you want to copy the item. If you do not specify a region ID, the item is copied to the page's default item region, which may not be desirable.

11.4.2 Copying Pages

You can use the copy_folder API to copy a page within the same page group. You cannot copy a page to a different page group.

To copy a page, users must have View privileges on the page being copied and Manage privileges on the page under which the page is being copied.

Example 11-11 shows how to copy a page.

declare
  l_new_pageid number;
begin
  l_new_pageid := wwsbr_api.copy_folder(
    p_id        => 12345,
    p_siteid    => 33,
    p_parent_id => 10000
    p_name      => 'page1',
    p_title     => 'page1'
  );
  -- Process cache invalidation messages.
  wwpro_api_invalidation.execute_cache_invalidation;
exception
  ...
end;
/

• p_id is the ID of the page that you want to copy.

• p_siteid is the ID of the page group to which the page belongs.

• p_parent_id is the ID of the page under which you want to copy the page.

• p_name is the name for the new page created by the copy operation.

• p_title is the display name for the new page created by the copy operation.

11.5.1 Deleting Items

You can use the delete_item API to delete all versions of an item or just a single specific version. This API also deletes all sub items associated with the versions being deleted. When you delete an item using this API, you can choose to accept the default delete mode for the page group or override this setting.

Example 11-12 deletes version 1 of an item permanently from the page group. The item version is permanently removed, even if the page group is set up to retain deleted items.

begin
  procedure delete_item(
    p_master_item_id => 48037,
    p_caid           => 54,
    p_version_number => 1,
    p_mode           => wwsbr_api.DELETE_ITEM_PURGE
  );
  -- Process cache invalidation messages.
  wwpro_api_invalidation.execute_cache_invalidation;
exception
  ...
end;
/

• p_master_item_id is the master ID of the item that you want to delete.

• p_caid is the ID of the page group to which the item belongs.

• p_version_number is the version of the item that you want to delete. If you attempt to delete the current version of the item, the ITEM_ACTIVE_VERSION exception is raised. If you do not specify an item version, all versions of the item are deleted.

  
  

  Tip: If you want to delete the current version of the item, you must either delete all versions, or use the OracleAS Portal user interface to revert to a previous version.

  
  

• p_mode is the mode to use when deleting the item:

  • wwsbr_api.DELETE_ITEM_DEFAULT uses the page group setting.

  • wwsbr_api.DELETE_ITEM_PURGE deletes the item immediately, regardless of the page group setting.

  • wwsbr_api.DELETE_ITEM_LAZYDELETE marks the item as deleted, regardless of the page group setting.

To restore a previously deleted item, use the undelete_item API. If the item had any sub-items, those sub-items are also restored.

begin
  wwsbr_api.undelete_item(
    p_thing_id => 12345,
    p_caid     => 33
  );
  -- Process cache invalidation messages.
  wwpro_api_invalidation.execute_cache_invalidation;
exception
  ...
end;
/

• p_thing_id is the unique ID of the deleted item that you want to restore.

• p_caid is the ID of the page group to which the item belongs.

11.5.2 Deleting Pages

Use the delete_folder API to delete a page. Users need to have Manage privileges on the page to be able to delete it.

The following example shows how to delete a page.

begin
  wwsbr_api.delete_folder(
    p_id     => 12345,
    p_siteid => 33
  );
  -- Process cache invalidation messages.
  wwpro_api_invalidation.execute_cache_invalidation;
exception
  ...
end;
/

• p_id is the ID of the page that you want to delete.

• p_siteid is the ID of the page group to which the page belongs.