../E14406-01.epub /> ../E14406-01.mobi />

OMBCREATE TRANSPORTABLE_MODULE

Purpose

To create a transportable module.

Prerequisites

In the context of a project.

Syntax

createTMCommand =  ( OMBCREATE TRANSPORTABLE_MODULE "QUOTED_STRING" { 
          "setPropertiesAndLocationsAndIconSet" } )
     setPropertiesAndLocationsAndIconSet =  SET ( "setPropertiesClause" | 
          "setSourceLocationClause" | "setTargetLocationClause" | 
          "setReferenceIconSetClause" )
     setPropertiesClause =  ( PROPERTIES "(" "propertyNameList" ")" VALUES "(" 
          "propertyValueList" ")" )
     setSourceLocationClause =  SOURCE_LOCATION "QUOTED_STRING"
     setTargetLocationClause =  TARGET_LOCATION "QUOTED_STRING"
     setReferenceIconSetClause =  ( REF | REFERENCE ) ICONSET "QUOTED_STRING"
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" | 
          "FLOATING_POINT_LITERAL" )

Parameters

createTMCommand

This command is for creating a transportable module.

QUOTED_STRING

The name of the transportable module to be created.

setPropertiesAndLocationsAndIconSet

Set properties for the transportable module, and/or specify source and target locations, and/or specify icon set for the newly create transportable module.

setPropertiesClause

Set properties for the transportable module.

setPropertiesClause

Basic properties for TRANSPORTABLE_MODULE:

Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: NAME
Business name of the transportable module

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description for the transportable module

setSourceLocationClause

Specify the source location name.

QUOTED_STRING

The name of an already created transportable module source location.

setTargetLocationClause

Specify the target location name.

QUOTED_STRING

The name of an already created transportable module target location.

setReferenceIconSetClause

Set the icon set for the new transportable module.

QUOTED_STRING

The name of the icon set.

propertyNameList

The list of unquoted property names.

propertyValueList

The list of property values.

propertyValue

A property value can be a single-quoted string, an integer, or a floating point number.

TRANSPORTABLE_MODULE Object

Table 10-1 TRANSPORTABLE_MODULE Object

Property Type Choices Min Max Default Description

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

TARGET_OS_TYPE

STRING

Linux, Unix, Windows

none

none

Unix

The operating system type of the target machine. This is needed for generating shell scripts in correct style required by the OS.

TRANSPORT_TABLESPACE

BOOLEAN

true, false

none

none

true

Specifies whether transportable tablespace (TTS) feature is to be used for deploying tables in the transportable module. If set to true, tablespaces are copied from source to target using the server TTS mechanism. If set to false, tables are individually extracted and deployed using Oracle Data Pump available in Oracle10g or later; but tablespaces are not transported. Since Oracle Data Pump is new in Oracle 10g, setting this parameter to false is only allowed if both source and target databases are with Oracle 10g or a higher versions.

WHAT_TO_DEPLOY

STRING

ALL_OBJECTS, TABLES_ONLY

none

none

ALL_OBJECTS

Specifies whether only tables in the transportable module are deployed or everything in it is deployed.

WORK_DIRECTORY

STRING

none

none

none

empty string

The full path of work directory on target machine, where temporary files, logs and tablespace datafiles may be stored. If left unspecified, OWB's runtime home directory is used as the work directory. It is highly recommended that users specify dedicated directory for transportable module deployment.