Replication Management API Reference, 123 of 179

INSTANTIATE_OFFLINE function

This function generates a file at the master site that is used to create the snapshot environment at the remote snapshot site while offline. This generated file is an offline instantiation file and should be used at remote snapshot sites that are not able to remain connected to the master site for an extended amount of time.

This is an ideal solution where the remote snapshot site is a laptop. Use the packaging tool in Replication Manager to package the generated file and data into a single file that can be posted on an FTP site or loaded to a CD-ROM, floppy disk, and so on.

See Also:
Oracle8i Replication and Replication Manager online help for more information.

The script generated by this function is stored in the USER_REPCAT_TEMP_OUTPUT temporary view and is used by several Oracle tools, including Replication Manager, during the distribution of deployment templates. The number returned by this function is used to retrieve the appropriate information from the USER_REPCAT_TEMP_OUTPUT view.

The user who executes this public function becomes the "registered" user of the instantiated template at the specified site.

Note:
This function is used in performing an offline instantiation of a deployment template.
This function should not be confused with the procedures in the DBMS_OFFLINE_OG package (used for performing an offline instantiation of a master table) or with the procedures in the DBMS_OFFLINE_SNAPSHOT package (used for performing an offline instantiation of a snapshot). See these respective packages for more information on their usage.

Syntax

DBMS_REPCAT_INSTANTIATE.INSTANTIATE_OFFLINE(
     refresh_template_name   IN   VARCHAR2,
     site_name               IN   VARCHAR2, 
     runtime_parm_id         IN   NUMBER    := -1e-130,
     next_date               IN   DATE      := SYSDATE,
     interval                IN   VARCHAR2  := 'SYSDATE + 1',
     use_default_gowner      IN   BOOLEAN   := TRUE)
     return NUMBER;

Table 8-222 INSTANTIATE_OFFLINE Function Parameters

Parameter	Description
refresh_template_name	The name of the deployment template to be instantiated.
site_name	The name of the remote site that is instantiating the deployment template.
runtime_parm_id	If you have defined runtime parameter values using the `INSERT_RUNTIME_PARMS` procedure, specify the ID used when creating the runtime parameters (the ID was retrieved by using the `GET_RUNTIME_PARM_ID` function).
next_date	The next refresh date value to be used when creating the refresh group.
interval	The refresh interval to be used when creating the refresh group.
use_default_gowner	If TRUE, then any snapshot object groups created are owned by the default user PUBLIC. If FALSE, then any snapshot object groups created are owned by the user performing the instantiation.

Table 8-223 INSTANTIATE_OFFLINE Function Exceptions

Exception	Description
miss_refresh_ template	The deployment template name specified is invalid or does not exist.
dupl_template_site	The deployment template has already been instantiated at the snapshot site. A deployment template can be instantiated only once at a particular snapshot site.
not_authorized	The user attempting to instantiate the deployment template is not authorized to do so.

Returns

Table 8-224 INSTANTIATE_OFFLINE Function Returns

Return Value	Description
<system-generated number>	Specifies the generated system number for the `output_id` when you select from the `USER_REPCAT_TEMP_OUTPUT` view to retrieve the generated instantiation script.