Oracle9iAS Portal Developer Kit

register function

Contained in package wwpro_api_progrp_registry.

Call this function to register a provider group with Oracle Portal.

The 'name' field of the specified provider_group_record must be the same as the name used to identify the provider group on the server.

The 'location' field of the provider_group_record specifies the URL for the provider group location.

function register
(

p_provider_group in provider_group_record,
p_create_flag in boolean default false

)
return varchar2;

Version: Oracle9iAS Portal 9.0.2 or later

Parameters:

 p_provider_group

Identifies the provider group to be registered, i.e. a provider_group_record with 'location' and 'name' fields populated.

Datatype: in provider_group_record

 p_create_flag

For internal use only.

Returns:

This function returns the ID of the newly registered provider group.

Exceptions:

  • If the Portal user executing this function does not have All Provider Manage or All Provider Publish rights, PROGRP_SECURITY_EXCEPTION is raised.

  • If an error occurs whilst trying to register the provider group or the provider group definition is already registered, PROGRP_REGISTRATION_EXCEPTION is raised.

Example:

declare

l_provider_grp wwpro_api_progrp_registry.provider_group_record;
l_id varchar2(32);

begin

l_provider_grp.name := 'MyProviderGroup';
l_provider_grp.location := 'http://my.progrps.com/progrp01';
l_id := wwpro_api_progrp_registry.register(l_provider_grp);

end;

Related topics

The PL/SQL API Reference is part of the Portal Developer Kit on Portal Studio