| provider_record record structure and table

Related topics
In the wwpro_api_provider_registry API package, the provider_record contains the properties of a portlet provider. It is used by the register_provider and edit_provider methods. The provider_record record structure is: type provider_record is record ( id number(9), name varchar2(200), display_name long, node_id number, timeout number, timeout_msg_id number, timeout_msg long implementation_style number, implementation_owner varchar2(30), implementation_name varchar2(2000), language varchar2(30), enable_distribution boolean, login_frequency char(1), http_url varchar2(1024), same_cookie_domain Boolean, require_proxy Boolean, require_session_data Boolean, is_offline Boolean, http_app_type varchar2(30), http_app_id varchar2(80), provider_key varchar2(80), encryption_key varchar2(80), existing_provider_id number(9), created_on date, created_by varchar2(256), last_updated_on date, last_updated_by varchar2(256), provider_group_id varchar2(32), service_id varchar2(1000), midtier_proxy_hostname varchar2(2000), midtier_proxy_portnumber number, dbtier_proxy_hostname varchar2(2000), dbtier_proxy_portnumber number );
Version: Oracle9iAS Portal 3.0.6.6.5 or later
Field names and definitions
id | This identifier for the provider is allocated by Oracle Portal and is unique for each provider. Note: A null value is not permitted. Datatype: integer
name | A name for the provider. This provider name is not translated, can be used during searching, and is presented in the UI when Oracle Portal is required to list providers. Note:The name returned is not sensitive to the language and a null value is not permitted. Datatype: varchar2
display_name | A translatable string for the provider name. This string is sensitive to the language parameter. Oracle Portal can use this name when displaying provider information. Datatype:
node_id | A unique identifier for the Oracle Portal installation. Notes: Only the local node ID can be passed. If null, node_id defaults to the local installation. Datatype: integer
timeout | The default number of seconds that Oracle Portal should try to connect to this provider before displaying the timeout message. Note: Oracle Portal first tries to retrieve a timeout value from the portlet, then from the provider. If both attempts fail, it uses the Oracle Portal default timeout value. Datatype: number
timeout_msg_id | The NLS message ID for the provider's timeout message. Note: Oracle Portal first tries to retrieve a timeout message ID from the portlet, then from the provider. If both attempts fail, it uses the Oracle Portal default timeout message ID. Datatype: number
timeout_msg | The message string to be presented when the execution timeout occurs. The timeout message may not contain mobile (mobileMXL) or desktop (HTML) markup. Note: If the timeout_msg_id is null, this string is added to the NLS tables and its NLS ID is used as the value for the timeout_msg_id. Datatype: long
implementation_style | The implementation style used by the provider. The supported styles are database providers and Web providers. Database providers are represented by wwpro_api_provider_registry. DATABASE_IMPL and wwpro_api_provider_registry. PLSQL_IMPL. Web providers are represented by wwpro_api_provider_registry.WEB_IMPL and wwpro_api_provider_registry.HTTP_IMPL. Note: A null value is not permitted. Datatype: number
implementation_owner | The database schema that contains the provider's implementation packages. This field is only valid for database providers. Note: A null value is not permitted. Datatype: varchar2
implementation_name | The name of the provider's implementation package. If the implementation_style is PLSQL_IMPL, this represents the name of the PL/SQL package that implements the provider methods. This field is only valid for database providers. Note: A null value is not permitted. Datatype: varchar2
language | A constant that specifies the language for the returned translatable strings. Note: A null value is not permitted. Datatype: varchar2
enable_distribution | Not used, Oracle9iAS Portal 9.0.2 or later.
login_frequency | How often Oracle Portal should login with the provider. For database providers, this flag determines the frequency of calls made to the do_login API. For Web providers, this flag determines the frequency of calls made to initSession. Notes: If the login frequency is wwpro_api_provider_registry.LOGIN_FREQUENCY_ALWAYS, Oracle Portal performs a login operation every time a portlet, from this provider, is requested to be viewed. If the login frequency is wwpro_api_provider_registry.LOGIN_FREQUENCY_ONCE, Oracle Portal performs a login operation only the first time a portlet, from this provider, is requested to be viewed in the same user session. If the login frequency is wwpro_api_provider_registry.LOGIN_FREQUENCY_NEVER, Oracle Portal does not perform any login with the provider. (Web providers only) If the login frequency is wwpro_api_provider_registry.LOGIN_FREQUENCY_PUBLIC it indicates that the initSession method is not called. In addition, no user information is passed to any of the provider calls. Datatype: varchar2
http_url | The URL Oracle Portal uses to make calls to the Web provider, as defined during provider registration. This field is only valid for Web providers, i.e. the implementation_style is HTTP_IMPL (or WEB_IMPL). Datatype: varchar2
same_cookie_domain | Indicates whether the Web provider is in the same cookie domain as Oracle Portal. Datatype: boolean
require_proxy | Indicates if a proxy server is required to make a URL connection. This field is only valid for Web providers. Notes: A proxy server provides access to content from servers outside a firewall. If a proxy server is required, you can identify the proxy server in the Services portlet by clicking Global Settings. Datatype: boolean
require_session_data | Indicates whether session information is to be sent to the provider. This field is only valid for Web providers. Datatype: Boolean
is_offline | Indicates whether the provider is off-line. Note: A provider must be online during registration. Therefore, if is_offline is set to 'true' an will error occur. Datatype: Boolean
http_app_type | A value provided by one of two constants that indicates if the Web provider being registered requires its own ID for the user to be communicated to it from the Single Sign-On Server or the Oracle Portal's ID for the user. Valid http_app_type values are: EXTERNAL_SECURED - the Web provider requires its own ID for the user PORTAL - the Web provider accepts the Oracle Portal's ID for the user Datatype: varchar2
http_app_id | The ID used to register the external application with the Single Sign-On Server. Note: If the http_app_type is EXTERNAL_SECURED, this field stores the external application ID, otherwise this field is null. Datatype: varchar2
existing_provider_id | The current provider ID. Notes: Use this value with the edit_provider procedure to identify the provider that will have its ID changed. When existing_provider_id contains an ID, edit_provider updates the provider ID to match the value in the ID field of the provider_record. When existing_provider_id is null, the value in the provider_record ID field is used to determine which provider should be updated. Datatype: varchar2
provider_key | A key passed to the Web provider. The provider uses it to look up and track the use of the provider's encryption key, and to track Oracle Portal when using their system. Datatype: varchar2
encryption_key | An encryption key that is shared with the Web provider. This key is used to encrypt and decrypt data communicated to the provider. Note: If an encryption key value exists, a provider key value also must exist. Datatype: varchar2
created_on | The date the provider was registered with Oracle Portal. Note: This value is used by functions returning a provider_record. Datatype: date
created_by | The user who registered this provider with Oracle Portal. Note: This value is filled in by functions returning a provider_record. Datatype: varchar2
last_updated_on | The date the provider was last updated by Oracle Portal . Note: This value is used by functions returning a provider_record. Datatype: date
last_updated_by | The user who last updated the provider. Note: This value is filled in by functions returning a provider_record. Datatype: varchar2
provider_group_id | The ID of the provider group (if any) to which this provider belongs. Datatype: varchar2
service_id | The service ID for the provider. This uniquely identifies the provider within a portal when the provider is accessed via the PL/SQL HTTP Adapter. Datatype: varchar2
midtier_proxy_hostname | The host name of the proxy to be used for calls to the provider originating from the middle tier. Datatype: varchar2
midtier_proxy_portnumber | The port number of the proxy to be used for calls to the provider originating from the middle tier. Datatype: number
dbtier_proxy_hostname | The host name of the proxy to be used for calls to the provider originating from the database. Datatype: varchar2
dbtier_proxy_portnumber | The port number of the proxy to be used for calls to the provider originating from the database. Datatype: number
Provider table: type provider_table is table of provider_record index by binary_integer; Provider ID table: type provider_id_table is table of number index by binary_integer;

Related topics
Provider registry API package | PDK PL/SQL API Reference - Home

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