| Oracle® Warehouse Builder API and Scripting Reference 11g Release 1 (11.1) Part Number B31279-01 |
|
|
View PDF |
| Oracle® Warehouse Builder API and Scripting Reference 11g Release 1 (11.1) Part Number B31279-01 |
|
|
View PDF |
This chapter contains an alphabetical listing of the navigation, service, administrative, and shell commands you can use in OMB Plus. Commands for metadata manipulation are contained in separate chapters.
Purpose
Change Active Configuration command allows users to set as active another Configuration in a Project.
Prerequisites
Must be in a Project context.
Syntax
parseChangeActiveConfigurationCommand = OMBCAC quoted_string
See Also
OMBDAC
Purpose
Change Context command allows users to change the current context to the desired location in OWB tree. The target context can be specified
either as an absolute path starting from the root ('/') or as a relative
path starting from the current context. Also, the path can contain '..',
which allows to navigate "up" to the parent context.
Prerequisites
Must be connected to a OWB workspace of the repository.
Syntax
parseChangeContextCommand = OMBCC "QUOTED_STRING"
Keywords And Parameters
parseChangeContextCommand
Specify change context command.
QUOTED_STRING
The target context to switch to.
See Also
OMBDCC
Purpose
Perform commit action on the repository.
Prerequisites
Must be connected to a OWB workspace of the repository.
Syntax
parseCommitCommand = OMBCOMMIT
Keywords And Parameters
parseCommitCommand
Specify commit command.
See Also
OMBROLLBACK
Purpose
Change management is a key piece of metadata management. This comand provides comparison services of any complex object
model in the workspace. This command writes the diff between
snapshot/component to XML file.
Prerequisites
Snapshots can be compared from any context and either with another snapshot
or the current workspace objects.
Syntax
parseCompareCommand = OMBCOMPARE "compareSnapshotCommand"
compareSnapshotCommand = ( ( SNAPSHOT "QUOTED_STRING" ) WITH
"getCompareWith" OUTPUT TO "QUOTED_STRING" WRITE ( ALL |
FOUND_IN_TARGET | FOUND_IN_SOURCE | UPDATED | CHANGED | UNCHANGED ) )
getCompareWith = SNAPSHOT "QUOTED_STRING" [ FOR ( "UNQUOTED_STRING"
"QUOTED_STRING" ) ] | ( CURRENT FOR ( "UNQUOTED_STRING"
"QUOTED_STRING" ) )
Keywords And Parameters
parseCompareCommand
Root production of OMBCOMPARE SNAPSHOT.
compareSnapshotCommand
To compare components of snapshots.
QUOTED_STRING
Name of source snapshot which needs to be compared with the target
snapshot.
OUTPUT
Specifies output filename where the XML comparison result will written.
WRITE
Specifies filter clause which will make the diff engine only write
specified objects of a certain diff state.
getCompareWith
Target of the comparison.
SNAPSHOT
Target snapshot which will be compared with the source snapshot.
FOR
Specifies component which exists in the current workspace.
CURRENT
Indicates current component's definition as the target of compare action.
See Also
OMBCREATE SNAPSHOT, OMBALTER SNAPSHOT, OMBDROP SNAPSHOT, OMBRESTORE SNAPSHOT, OMBLIST SNAPSHOT, OMBRETRIEVE SNAPSHOT
Purpose
This command compiles an repository object. The results are generated in a file in a user defined directory.
Prerequisites
In the context of a Oracle Module.
Syntax
parseCompileCommand = OMBCOMPILE ( ( EXPERT | EXPERT_MODULE | TABLE | VIEW
| SEQUENCE | MATERIALIZED_VIEW | DIMENSION | CUBE | DATA_AUDITOR |
MAPPING | REAL_TIME_MAPPING | TRANSPORTABLE_MODULE |
BUSINESS_DEFINITION_MODULE | EXTERNAL_TABLE | OBJECT_TYPE |
NESTED_TABLE | VARYING_ARRAY | COLLECTION | CONNECTOR |
ALTERNATIVE_SORT_ORDER | LIST_OF_VALUES | DRILL_TO_DETAIL |
BUSINESS_AREA | DRILL_PATH | ITEM_FOLDER | REGISTERED_FUNCTION |
PACKAGE | FUNCTION | PROCEDURE | TABLE_FUNCTION | PLSQL_RECORD_TYPE |
PLSQL_TABLE_TYPE | PLSQL_REF_CURSOR_TYPE PROCESS_FLOW_PACKAGE |
ADVANCED_QUEUE | STREAMS_QUEUE | QUEUE_TABLE | QUEUE_PROPAGATION |
STREAMS_CAPTURE_PROCESS | PROCESS_FLOW_PACKAGE | PROCESS_FLOW_MODULE |
CALENDAR | CALENDAR_MODULE ) "QUOTED_STRING" [
"getOutputValidationResults" ] [ "getOutputGeneratedScripts" ] )
getOutputValidationResults = OUTPUT [ VALIDATION_RESULT ] TO (
"QUOTED_STRING" | ( FILE "QUOTED_STRING" ) ) WRITE ( ( "(" ( ( SUCCESS
| WARNING | ERROR ) [ "," ] )+ ")" ) | ALL | SUCCESS | WARNING |
ERROR )
getOutputGeneratedScripts = OUTPUT GENERATION_SCRIPTS TO ( "QUOTED_STRING"
| ( FILE "QUOTED_STRING" ) )
Keywords And Parameters
parseCompileCommand
This command compiles a repository object.
QUOTED_STRING
The name of the object.
getOutputValidationResults
This clause outputs the validation results to one or more files in the
specified folder.
QUOTED_STRING
A file or directory where validation results are stored.
getOutputGeneratedScripts
This clause outputs the generated scripts for an object to one or more
files in specified folder.
QUOTED_STRING
A file or directory where generated scripts are stored.
See Also
OMBVALIDATE
Purpose
To connect to a OWB workspace.
Prerequisites
Must not be connected to another OWB workspace. If connected to another
workspace, use OMBDISCONNECT to disconnect first.
Syntax
parseConnectCommand = ( ( OMBCONNECT | OMBCONN ) "UNQUOTED_STRING" [ USE (
REPOSITORY | REPOS | WORKSPACE ) "QUOTED_STRING" ] [ USE (
SINGLE_USER_MODE | MULTIPLE_USER_MODE ) ] )
Keywords And Parameters
parseConnectCommand
Specify connect command.
UNQUOTED_STRING
Specify the connection string to the database, in the format:
username/password@host:port:service name
QUOTED_STRING
Optionally, specify the name of a workspace to work on. If not provided,
the default workspace will be used.
SINGLE_USER_MODE
If specified, the user will use the workspace exclusively.
MULTIPLE_USER_MODE
If specified, more than one session can work on the same workspace at the
same time. This is the default mode.
See Also
OMBDISCONNECT
Purpose
To connect to a OWB workspace.
Prerequisites
Must not be connected to another OWB workspace. If connected to another
workspace, use OMBDISCONNECT to disconnect first.
Syntax
parseConnectCommand = ( ( OMBCONNECT | OMBCONN ) "UNQUOTED_STRING" [ USE (
REPOSITORY | REPOS | WORKSPACE ) "QUOTED_STRING" ] [ USE (
SINGLE_USER_MODE | MULTIPLE_USER_MODE ) ] )
Keywords And Parameters
parseConnectCommand
Specify connect command.
UNQUOTED_STRING
Specify the connection string to the database, in the format:
username/password@host:port:service name
QUOTED_STRING
Optionally, specify the name of a workspace to work on. If not provided,
the default workspace will be used.
SINGLE_USER_MODE
If specified, the user will use the workspace exclusively.
MULTIPLE_USER_MODE
If specified, more than one session can work on the same workspace at the
same time. This is the default mode.
See Also
OMBDISCONNECT
Purpose
To connect to a Control Center.
This command can either be used when you are already connected to a
workspace on the Design Repository or it can be used independently of a
workspace on the Design Repository.
With Design Repository connection:
This command will connect you to the Control Center that is associated with
the current Active Configuration.
If this is the DEFAULT_CONTROL_CENTER and it does not have a user and
password specified, then you will be connected to the Control Center as the
currently connected Design Repository User. This is the typical
out-of-the-box scenario. If the DEFAULT_CONTROL_CENTER has a user specified
then you will be connected as that user. Note in this case you may have to
provide a password.
If this is not the DEFAULT_CONTROL_CENTER, then you will either connect as
the user specified against the Control Center or you will have to provide a
user with this command. Note that in this situation you will probably have
to supply a password.
Without Design Repository connection:
This command can be used to connect to a Control Center independently of a
workspace on Design Repository. For example, you may want to OMBDEPLOY a
deployment specification that had been previously deployed to the file
system or OMBSTART a job. In this case you will have to provide the
complete connection details.
Prerequisites
With Design Repository connection:
A Design Repository connection, at least a PROJECT context and the Active
Configuration's Selected CONTROL_CENTER must be defined.
Without Design Repository connection:
There must not be a Design Repository connection whenever this method is
used.
Syntax
parseConnectRuntimeCommand = ( ( OMBCONNECT | OMBCONN ) CONTROL_CENTER [ (
USE "QUOTED_STRING" ) | ( "UNQUOTED_STRING" USE ( REPOSITORY | REPOS
| WORKSPACE ) "QUOTED_STRING" ) ] )
Keywords And Parameters
parseConnectRuntimeCommand
Specify Control Center connect command.
QUOTED_STRING
Specific Control Center:
OMBCONNECT CONTROL_CENTER USE 'scott/tiger'
OMBCONNECT CONTROL_CENTER
Control Center Only:
OMBCONNECT CONTROL_CENTER
RepositoryUserName/RepositoryUserPassword@HostName:PortNumber:OracleServiceName'
USE REPOSITORY 'RepositorySchema'
See Also
OMBDISCONNECT CONTROL_CENTER
Purpose
To connect to a Control Center.
This command can either be used when you are already connected to a
workspace on the Design Repository or it can be used independently of a
workspace on the Design Repository.
With Design Repository connection:
This command will connect you to the Control Center that is associated with
the current Active Configuration.
If this is the DEFAULT_CONTROL_CENTER and it does not have a user and
password specified, then you will be connected to the Control Center as the
currently connected Design Repository User. This is the typical
out-of-the-box scenario. If the DEFAULT_CONTROL_CENTER has a user specified
then you will be connected as that user. Note in this case you may have to
provide a password.
If this is not the DEFAULT_CONTROL_CENTER, then you will either connect as
the user specified against the Control Center or you will have to provide a
user with this command. Note that in this situation you will probably have
to supply a password.
Without Design Repository connection:
This command can be used to connect to a Control Center independently of a
workspace on Design Repository. For example, you may want to OMBDEPLOY a
deployment specification that had been previously deployed to the file
system or OMBSTART a job. In this case you will have to provide the
complete connection details.
Prerequisites
With Design Repository connection:
A Design Repository connection, at least a PROJECT context and the Active
Configuration's Selected CONTROL_CENTER must be defined.
Without Design Repository connection:
There must not be a Design Repository connection whenever this method is
used.
Syntax
parseConnectRuntimeCommand = ( ( OMBCONNECT | OMBCONN ) CONTROL_CENTER [ (
USE "QUOTED_STRING" ) | ( "UNQUOTED_STRING" USE ( REPOSITORY | REPOS
| WORKSPACE ) "QUOTED_STRING" ) ] )
Keywords And Parameters
parseConnectRuntimeCommand
Specify Control Center connect command.
QUOTED_STRING
Specific Control Center:
OMBCONNECT CONTROL_CENTER USE 'scott/tiger'
OMBCONNECT CONTROL_CENTER
Control Center Only:
OMBCONNECT CONTROL_CENTER
RepositoryUserName/RepositoryUserPassword@HostName:PortNumber:OracleServiceName'
USE REPOSITORY 'RepositorySchema'
See Also
OMBDISCONNECT CONTROL_CENTER
Purpose
Copy one or more objects of the same object type. The replace option allows you to overwrite.
Prerequisites
Use of relative path specifications requires awareness of the current
context.
Syntax
parseCopyCommand = OMBCOPY "copyObjectType" "QUOTED_STRING" TO
"QUOTED_STRING" [ USE REPLACE_MODE ]
copyObjectType = ( "UNQUOTED_STRING" )
Keywords And Parameters
parseCopyCommand
Specifies the source object type, source path, and target path for the
object to copy. Copying objects is subject to the following restrictions:
1. You cannot copy an entire project. 2. When copying objects between
projects, you can only copy objects into the current project; you cannot
copy objects out to other projects.
QUOTED_STRING
Source and target path specifications can be absolute or relative. To copy
multiple objects, include a regular expression as the final step of the
source path. If you are copying multiple objects, the final step of the
target path must be the folder to which the objects are being copied. If
you are only copying one object, you can specify the object's original name
or a new name as the final step of the target path.
REPLACE_MODE
Use this option to overwrite existing target objects.
copyObjectType
The type of the object(s) to be copied. Valid types are: PROJECT,
ORACLE_MODULE, FLAT_FILE_MODULE, BUSINESS_DEFINITION_MODULE,
BUSINESS_PRESENTATION_MODULE, SAP_MODULE, CMI_MODULE, PROCESS_FLOW_MODULE,
PROCESS_FLOW_PACKAGE, PROCESS_FLOW, EXPERT_MODULE, EXPERT, LOCATION,
CONTROL_CENTER, CONFIGURATION, FLAT_FILE, ADVANCED_QUEUE, STREAMS_QUEUE,
QUEUE_TABLE, QUEUE_PROPAGATION, STREAMS_CAPTURE_PROCESS, OBJECT_TYPE,
VARYING_ARRAY, NESTED_TABLE, TABLE, VIEW, MATERIALIZED_VIEW, SEQUENCE,
DIMENSION, CUBE, DATA_AUDITOR, DATA_PROFILE, DATA_RULE, DATA_RULE_MODULE,
MAPPING, REAL_TIME_MAPPING, PACKAGE, FUNCTION, PROCEDURE, BUSINESS_AREA,
COLLECTION, EXTERNAL_TABLE, REGISTERED_FUNCTION, ITEM_FOLDER, DRILL_PATH,
LIST_OF_VALUES, DRILL_TO_DETAIL, ALTERNATIVE_SORT_ORDER,
PRESENTATION_TEMPLATE and any user defined object types.
See Also
OMBMOVE
Purpose
Display the name of the active configuration of a project.
Prerequisites
Must be in the context of a project.
Syntax
parseDisplayActiveConfigurationCommand = OMBDAC
Keywords And Parameters
parseDisplayActiveConfigurationCommand
Specify Display Active Configuration command.
See Also
OMBCAC
Purpose
Display Current Context command displays the current context (location) and, for contexts other than the root ('/'), the type of the
current folder.
Prerequisites
Must be connected to a OWB workspace of the repository.
Syntax
parseDisplayCurrentContextCommand = OMBDCC
Keywords And Parameters
parseDisplayCurrentContextCommand
Specify display current context command.
See Also
OMBCC
Purpose
Debug a mapping by stepping through map execution one operator at a time.
Prerequisites
The current context must be in an Oracle module which contains at least one
map.
Syntax
debugMappingCommand = OMBDEBUG MAPPING "mappingName" "debugClause"+
mappingName = "QUOTED_STRING"
debugClause = START [ DEBUG ] SESSION | END [ DEBUG ] SESSION | STEP | SKP
| RESUME | DISPLAY ( [ "INTEGER_LITERAL" ROWS OF ] [
"dataDisplayGroupDirection" ] DEBUG_DATA [ FOR "groupBottomUpLocator"
] | CURRENT_STEP_GROUP ) | SET ( BREAKPOINT AT
"operatorBottomUpLocator" | STARTING_POINT AT
"operatorBottomUpLocator" ) | CLEAR ( BREAKPOINT AT
"operatorBottomUpLocator" | STARTING_POINT AT
"operatorBottomUpLocator" ) | REINITIALIZE | RESET
dataDisplayGroupDirection = INPUT | OUTPUT
groupBottomUpLocator = GROUP "groupName" OF "operatorBottomUpLocator"
operatorBottomUpLocator = OPERATOR "operatorName" [
"pluggableMapBottomUpLocator" ]
groupName = "QUOTED_STRING"
operatorName = "QUOTED_STRING"
pluggableMapBottomUpLocator = ( OF PLUGGABLE_MAPPING "pluggableMapName" [
"pluggableMapBottomUpLocator" ] )
pluggableMapName = "QUOTED_STRING"
Keywords And Parameters
mappingName
Name of the mapping.
groupBottomUpLocator
Location of a mapping group.
operatorBottomUpLocator
Location of a mapping operator.
groupName
Name of a mapping group.
operatorName
Name of a mapping operator.
pluggableMapBottomUpLocator
Location of a child pluggable mapping within a mapping or another pluggable
mapping.
pluggableMapName
Name of the pluggable map.
Purpose
To define an association between two classes (types).
Prerequisites
Association definition to be defined should not already exist. User must
have CREATE_EXTENSIONMODEL system privilege and has to be connected in
single user mode to run this command.
Syntax
parseDefineAssociationCommand = OMBDEFINE ASSOCIATION_DEFINITION
"QUOTED_STRING" "setAssociationDefinitionPropertiesClause" {
"addDependencyDefinitionClause" }
setAssociationDefinitionPropertiesClause = SET PROPERTIES "("
"propertyNameList" ")" VALUES "(" "propertyValueList" ")"
addDependencyDefinitionClause = ADD DEPENDENCY_DEFINITION "QUOTED_STRING"
[ "setDependencyDefinitionPropertiesClause" ]
propertyNameList = "propertyNameClause" { "," "propertyNameClause" }
propertyValueList = "propertyValue" { "," "propertyValue" }
setDependencyDefinitionPropertiesClause = SET PROPERTIES "("
"propertyNameList" ")" VALUES "(" "propertyValueList" ")"
propertyNameClause = ( "UNQUOTED_STRING" )
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
parseDefineAssociationCommand
Define an association between two classes..
setAssociationDefinitionPropertiesClause
Basic properties for ASSOCIATION_DEFINITION:
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: N/A
A descriptive text for this association.
Name: CLASS_1
Type: STRING(200)
Valid Values: N/A
Default: N/A
Class on one side of the association.
NAME: CLASS_2
Type: STRING(200)
Value Values: N/A
Default: N/A
Class on the other side of the association.
Name: ROLE_1
Type: STRING(200)
Valid Values: N/A
Default: N/A
Role on one side of the association.
Name: ROLE_2
Type: STRING(200)
Valid Values: N/A
Default: N/A
Role on the other side of the association.
Name: ROLE_1_MIN_CARDINALITY
Type: STRING(200)
Valid Values: N/A
Default: N/A
Minimum cardinality of role 1. Value can be positive integer.
Name: ROLE_1_MAX_CARDINALITY
Type: STRING(200)
Valid Values: N/A
Default: N/A
Maximum cardinality of role 1. Value can be positive integer or 'INFINITE'.
Name: ROLE_1_NAVIGABLE
Type: BOOLEAN
Valid Values: true, false
Default: From user defined class side default is true. From OWB class side
default is false.
Navigability of role 1.
Name: ROLE_2_MIN_CARDINALITY
Type: STRING(200)
Valid Values: N/A
Default: N/A
Minimum cardinality of role 2. Value can be positive integer.
Name: ROLE_2_MAX_CARDINALITY
Type: STRING(200)
Valid Values: N/A
Default: N/A
Maximum cardinality of role 2. Value can be positive integer or 'INFINITE'.
Name: ROLE_2_NAVIGABLE
Type: BOOLEAN
Valid Values: true, false
Default: From user defined class side default is true. From OWB class side
default is false.
Navigability of role 2.
addDependencyDefinitionClause
Mark this association so that the dependency engine will consider it when
computing the lineage and impact dependencies. The only dependency type
allowed here for now is 'DATAFLOW'.
propertyNameList
The list of property names.
propertyValueList
The list of property values being set.
setDependencyDefinitionPropertiesClause
Basic dependency-related properties for this association:
Name: SOURCE_ROLE_ID
Type: STRING(200)
Valid Values: ROLE_1, ROLE_2
Default: If one of the ends is a OWB class, then that is the default
source. If both ends are user defined classes, then the association is
default bidirectional.
Identifies the role (end) of the association which serves as the source for
the dependency flow.
Name: BIDIRECTIONAL
Type: BOOLEAN
Valid Values: true, false
Default: If one of the ends is a OWB class, then default is false. If both
ends are user defined classes, then default is true.
Specifies whether the association is bi-directional for the dependency
flow.
propertyNameClause
Name of a property.
propertyValue
Value of a property.
See Also
OMBDESCRIBE ASSOCIATION_DEFINITION
Purpose
To define a class (user defined object type).
Prerequisites
Class definition to be defined should not already exist.
Syntax
parseDefineClassCommand = OMBDEFINE [ ( FIRST_CLASS_OBJECT |
SECOND_CLASS_OBJECT | FOLDER | MODULE ) ] CLASS_DEFINITION
"QUOTED_STRING" [ ( "setClassDefinitionPropertiesClause" |
"setClassDefinitionIconSetClause" ) ] [ "addSubDefinitionsClause" ]
setClassDefinitionPropertiesClause = SET PROPERTIES "(" "propertyNameList"
")" VALUES "(" "propertyValueList" ")"
setClassDefinitionIconSetClause = SET REF ICONSET "QUOTED_STRING"
addSubDefinitionsClause = ( "addPropertyDefinitionClause" |
"addPropertyGroupDefinitionClause" | "addChildTypeClause" )+
propertyNameList = "propertyNameClause" { "," "propertyNameClause" }
propertyValueList = "propertyValue" { "," "propertyValue" }
addPropertyDefinitionClause = ( ADD [ ( ( CONFIGURATION |
PHYSICAL_CONFIGURATION ) | LOGICAL | USER_DEFINED ) ]
PROPERTY_DEFINITION "QUOTED_STRING"
"setPropertyDefinitionPropertiesClause" )
addPropertyGroupDefinitionClause = ADD PROPERTY_GROUP_DEFINITION
"QUOTED_STRING" "setPropertyGroupDefinitionPropertiesClause"
addChildTypeClause = ( ADD CHILD_TYPE "QUOTED_STRING" )
propertyNameClause = ( "UNQUOTED_STRING" )
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
setPropertyDefinitionPropertiesClause = SET PROPERTIES "("
"propertyNameList" ")" VALUES "(" "propertyValueList" ")"
setPropertyGroupDefinitionPropertiesClause = SET PROPERTIES "("
"propertyNameList" ")" VALUES "(" "propertyValueList" ")"
Keywords And Parameters
parseDefineClassCommand
Define a class.
FOLDER
Class definition is folder.
MODULE
Class definition is module.
QUOTED_STRING
Name of the class.
setClassDefinitionPropertiesClause
Set the properties on the class definition. Valid properties are
BUSINESS_NAME, DESCRIPTION, DISPLAY_NAME, PLURAL_NAME.
setClassDefinitionIconSetClause
Assign an icon to the class definition.
propertyNameList
The list of property names.
propertyValueList
The list of values.
addPropertyDefinitionClause
Add a property definition to the class definition.
addPropertyGroupDefinitionClause
Add a property group definition to the class definition.
addChildTypeClause
Add a aggregate child type to the class definition.
propertyNameClause
The name of the property.
UNQUOTED_STRING
The name of the property for the class definition.
propertyValue
The value of the property.
QUOTED_STRING
The value in string format of the property for the class definition.
INTEGER_LITERAL
The integer value of the property for the class definition.
FLOATING_POINT_LITERAL
The float value of the property for the class definition.
setPropertyDefinitionPropertiesClause
Set the properties for the property definition. Valid properties are TYPE,
DEFAULT_VALUE, POSITION, HIDDEN.
See Also
OMBDESCRIBE CLASS_DEFINITION
Purpose
To define a component definition.
Prerequisites
The class definition for the component should already exist. The class must
be a first class object.
Syntax
parseDefineComponentCommand = OMBDEFINE COMPONENT_DEFINITION
"QUOTED_STRING" [ "addChildClassesClause" ]
addChildClassesClause = "addChildClassClause"+
addChildClassClause = ( ADD "QUOTED_STRING" )
Purpose
To define a domain.
Prerequisites
Domain is a type with constraints on some other type. For example, you can
define a domain which contains a list of valid values of some existing
type, or you can define a domain which contains ranges of some existing
type.
Syntax
parseDefineDomainCommand = OMBDEFINE DOMAIN_DEFINITION "QUOTED_STRING"
"setDomainPropertiesClause" { "addRangeClause" | "addValueClause" }
setDomainPropertiesClause = SET PROPERTIES "(" "propertyNameList" ")"
VALUES "(" "propertyValueList" ")"
addRangeClause = ADD RANGE_DEFINITION "QUOTED_STRING"
"setRangePropertiesClause"
addValueClause = ADD DOMAIN_VALUE "QUOTED_STRING"
propertyNameList = "propertyNameClause" { "," "propertyNameClause" }
propertyValueList = "propertyValue" { "," "propertyValue" }
setRangePropertiesClause = SET PROPERTIES "(" "propertyNameList" ")"
VALUES "(" "propertyValueList" ")"
propertyNameClause = ( "UNQUOTED_STRING" )
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
parseDefineDomainCommand
Define a domain.
QUOTED_STRING
Name of the domain.
setDomainPropertiesClause
Set the properties on the domain. Valid properties are BASE_TYPE,
DESCRIPTION.
addRangeClause
Add range to the domain.
addValueClause
Add value to the domain.
propertyNameList
The list of property names.
propertyValueList
The list of values.
setRangePropertiesClause
Set the properties on the range. Valid properties are MIN_VALUE_STRING,
MIN_VALUE_INCLUSIVE, MAX_VALUE_STRING, MAX_VALUE_INCLUSIVE, DESCRIPTION.
MIN_VALUE_STRING is the minimum value for this range. MIN_VALUE_INCLUSIVE
equal to true means the minimum value is in the range. MAX_VALUE_STRING is
the maximum for this range. MAX_VALUE_INCLUSIVE equal to true means the
maximum value is in the range.
propertyNameClause
The name of the property.
UNQUOTED_STRING
The name of the property for the class definition.
propertyValue
The value of the property.
QUOTED_STRING
The value in string format of the property for the class definition.
INTEGER_LITERAL
The integer value of the property for the class definition.
FLOATING_POINT_LITERAL
The float value of the property for the class definition.
See Also
OMBDESCRIBE DOMAIN_DEFINITION
Purpose
To define a folder definition.
Prerequisites
The class definition for the folder should already exist. The class must be
a folder.
Syntax
parseDefineFolderCommand = OMBDEFINE FOLDER_DEFINITION "QUOTED_STRING" [
"addChildClassesClause" ]
addChildClassesClause = "addChildClassClause"+
addChildClassClause = ( ADD "QUOTED_STRING" )
Purpose
Drop a workspace in the OWB repository schema OWBSYS.
Prerequisites
To drop a workspace, within the same OMBPlus session, no other OMB commands
should be issued before or after the OMBDEINSTALL WORKSPACE command. The
workspace name must exist for the specified owning db user.
Syntax
parseDeinstallOWBRepositoryCommand = OMBDEINSTALL ( OWB_REPOSITORY |
WORKSPACE ) "QUOTED_STRING" USING CREDENTIAL "UNQUOTED_STRING"
Keywords And Parameters
parseDeinstallOWBRepositoryCommand
Specify an OMBDEINSTALL WORKSPACE command.
QUOTED_STRING
Specify the workspace name and, optionally, the workspace owner. If not
provided, owner defaults to the user supplied in the connection string.
UNQUOTED_STRING
Specify the connection string to the database using this format:
username/password@host:port:service name.
Purpose
Drop a workspace in the OWB repository schema OWBSYS.
Prerequisites
To drop a workspace, within the same OMBPlus session, no other OMB commands
should be issued before or after the OMBDEINSTALL WORKSPACE command. The
workspace name must exist for the specified owning db user.
Syntax
parseDeinstallOWBRepositoryCommand = OMBDEINSTALL ( OWB_REPOSITORY |
WORKSPACE ) "QUOTED_STRING" USING CREDENTIAL "UNQUOTED_STRING"
Keywords And Parameters
parseDeinstallOWBRepositoryCommand
Specify an OMBDEINSTALL WORKSPACE command.
QUOTED_STRING
Specify the workspace name and, optionally, the workspace owner. If not
provided, owner defaults to the user supplied in the connection string.
UNQUOTED_STRING
Specify the connection string to the database using this format:
username/password@host:port:service name.
Purpose
To Deploy Action Plans to Control Centers or File Systems.
Prerequisites
If the Deployment is NOT from a Deployment Specification XML file then the
following are true. A Control Center connection and a named Deployment
Action Plan are required. Also, the current Context must be either an
Oracle Module, a Process Flow Module or a Location.
Syntax
parseDeployCommand = OMBDEPLOY ( ( DEPLOYMENT_ACTION_PLAN "QUOTED_STRING"
[ ( AS ( SPECIFICATION | SCRIPT ) TO "QUOTED_STRING" ) |
CONTROL_CENTER_ONLY ] ) | ( SPECIFICATION FROM "QUOTED_STRING" ) ) [
ASYNCHRONOUS ]
Keywords And Parameters
parseDeployCommand
Specify Deploy command.
DEPLOYMENT_ACTION_PLAN
Deploy a Deployment Action Plan.
QUOTED_STRING
The Deployment Action Plan name. Or, the directory (if AS SCRIPT) or file
name (if AS SPECIFICATION) into which the deployment is performed. Or, the
source XML filename (if SPECIFICATION FROM).
AS
Perform the Deployment to a File System.
SPECIFICATION
Deploy as a Deployment Specification XML file.
SCRIPT
Deploy as a set of Oracle Script files.
CONTROL_CENTER_ONLY
Do not perform a Deployment but only update the Control Center Audit.
FROM
Perform the Deployment from a file on a File System.
ASYNCHRONOUS
Deploy in an asynchronous mode.
Purpose
Derives business definition objects from OWB design objects.
Prerequisites
Should be in an appropriate context for the design object or use the full
path for the design object.
The Business Definition Module named in the TO clause should already exist
within the current project.
Any Business Areas named should already exist within the Business
Definition Module.
Syntax
parseDeriveCommand = OMBDERIVE ( ORACLE_MODULE | DIMENSION | CUBE | TABLE
| VIEW | EXTERNAL_TABLE | FUNCTION | COLLECTION ) "QUOTED_STRING" TO
BUSINESS_DEFINITION_MODULE "QUOTED_STRING" [ BUSINESS_AREAS "("
"BANameList" ")" ] [ "parseDeriveCommandParams" ]
BANameList = "QUOTED_STRING" { "," "QUOTED_STRING" }
parseDeriveCommandParams = "parseRuleParameters" { "parseRuleParameters" }
parseRuleParameters = SET [ ( ORACLE_MODULE | DIMENSION | CUBE | TABLE |
VIEW | EXTERNAL_TABLE | FUNCTION | COLLECTION ) ] "("
"parameterNameList" ")" VALUES "(" "parameterValueList" ")"
parameterNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
parameterValueList = "parameterValue" { "," "parameterValue" }
parameterValue = ( "QUOTED_STRING" )
Keywords And Parameters
parseDeriveCommand
Derives business definition objects from OWB design objects.
The quoted string following TO should be the name of a Business Definition
Module in the current project, into which the business definition objects
are derived.
Purpose
To describe an association definition.
Prerequisites
Association definition must be already exist. This command can be executed
for any association definition regardless of current context.
Syntax
parseDescribeAssociationCommand = OMBDESCRIBE ASSOCIATION_DEFINITION
"QUOTED_STRING" ( GET ( "getAssociationPropertiesClause" |
DEPENDENCY_DEFINITIONS ) | ( DEPENDENCY_DEFINITION "QUOTED_STRING" GET
"getDependencyPropertiesClause" ) )
getAssociationPropertiesClause = PROPERTIES "(" "propertyNameList" ")"
getDependencyPropertiesClause = PROPERTIES "(" "propertyNameList" ")"
propertyNameList = "propertyNameClause" { "," "propertyNameClause" }
propertyNameClause = ( "UNQUOTED_STRING" )
Keywords And Parameters
parseDescribeAssociationCommand
Describe an association definition.
getAssociationPropertiesClause
Basic properties for ASSOCIATION_DEFINITION:
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: N/A
A descriptive text for this association.
Name: CLASS_1
Type: STRING(200)
Valid Values: N/A
Default: N/A
Class on one side of the association.
NAME: CLASS_2
Type: STRING(200)
Value Values: N/A
Default: N/A
Class on the other side of the association.
Name: ROLE_1
Type: STRING(200)
Valid Values: N/A
Default: N/A
Role on one side of the association.
Name: ROLE_2
Type: STRING(200)
Valid Values: N/A
Default: N/A
Role on the other side of the association.
Name: ROLE_1_MIN_CARDINALITY
Type: STRING(200)
Valid Values: N/A
Default: N/A
Minimum cardinality of role 1. Value can be positive integer.
Name: ROLE_1_MAX_CARDINALITY
Type: STRING(200)
Valid Values: N/A
Default: N/A
Maximum cardinality of role 1. Value can be positive integer or 'INFINITE'.
Name: ROLE_1_NAVIGABLE
Type: BOOLEAN
Valid Values: true, false
Default: From user defined class side default is true. From OWB class side
default is false.
Navigability of role 1.
Name: ROLE_2_MIN_CARDINALITY
Type: STRING(200)
Valid Values: N/A
Default: N/A
Minimum cardinality of role 2. Value can be positive integer.
Name: ROLE_2_MAX_CARDINALITY
Type: STRING(200)
Valid Values: N/A
Default: N/A
Maximum cardinality of role 2. Value can be positive integer or 'INFINITE'.
Name: ROLE_2_NAVIGABLE
Type: BOOLEAN
Valid Values: true, false
Default: From user defined class side default is true. From OWB class side
default is false.
Navigability of role 2.
getDependencyPropertiesClause
Basic dependency-related properties for this association:
Name: SOURCE_ROLE_ID
Type: STRING(200)
Valid Values: ROLE_1, ROLE_2
Default: If one of the ends is a OWB class, then that is the default
source. If both ends are user defined classes, then the association is
default bidirectional.
Identifies the role (end) of the association which serves as the source for
the dependency flow.
Name: BIDIRECTIONAL
Type: BOOLEAN
Valid Values: true, false
Default: If one of the ends is a OWB class, then default is false. If both
ends are user defined classes, then default is true.
Specifies whether the association is bi-directional for the dependency
flow.
propertyNameList
The list of property names.
propertyNameClause
Name of a property.
See Also
OMBDEFINE ASSOCIATION_DEFINITION
Purpose
To describe a class definition or its property definitions.
Prerequisites
Class definition must be already exist. This command can be executed for
any class definition regardless of current context.
Syntax
parseDescribeClassCommand = OMBDESCRIBE CLASS_DEFINITION "QUOTED_STRING" (
( PROPERTY_DEFINITION "QUOTED_STRING" GET
"getPropertyDefinitionPropertiesClause" ) | ( GET ( [ USER_DEFINED |
CORE | LOGICAL | ( CONFIGURATION | PHYSICAL_CONFIGURATION ) ]
PROPERTY_DEFINITIONS ) ) | GET "getClassDefinitionPropertiesClause" |
GET CHILD_TYPES | GET ASSOCIATION_DEFINITIONS )
getPropertyDefinitionPropertiesClause = PROPERTIES "(" "propertyNameList"
")"
getClassDefinitionPropertiesClause = PROPERTIES "(" "propertyNameList" ")"
propertyNameList = "propertyNameClause" { "," "propertyNameClause" }
propertyNameClause = ( "UNQUOTED_STRING" )
Keywords And Parameters
parseDescribeClassCommand
Describe a class definition.
QUOTED_STRING
Name of the class definition.
PROPERTY_DEFINITIONS
Get the list of property definitions for the class definition.
propertyNameList
List of the names of the properties.
propertyNameClause
Name of the property.
UNQUOTED_STRING
Name of the property.
See Also
OMBDEFINE CLASS_DEFINITION, OMBREDEFINE CLASS_DEFINITION
Purpose
To describe a model. A model is usually composed of types and relationships among them. The only model currently supported is
'OWB'. Using this command you can introspect 'OWB' model to list classes
and other type definitions, association definitions and domain definitions.
Prerequisites
Must be connected to a workspace.
Syntax
parseDescribeModelCommand = OMBDESCRIBE MODEL "QUOTED_STRING" GET ( [
USER_DEFINED ] ( [ FIRST_CLASS_OBJECT | SECOND_CLASS_OBJECT | FOLDER |
MODULE ] CLASS_DEFINITIONS | ( COMPONENT_DEFINITIONS |
FOLDER_DEFINITIONS ) ) | TYPE_DEFINITIONS | DOMAIN_DEFINITIONS |
ASSOCIATION_DEFINITIONS | PRIMITIVE_TYPES )
Keywords And Parameters
parseDescribeModelCommand
Describe a model. The only model currently supported is 'OWB'.
Purpose
To disconnect from a OWB workspace or the named Control Center.
Prerequisites
Currently need to be connected to a OWB workspace on the repository or the
named Control Center.
Syntax
parseDisconnectCommand = ( ( OMBDISCONNECT | OMBDISC ) [ CONTROL_CENTER ]
)
Keywords And Parameters
parseDisconnectCommand
Specify disconnect command.
See Also
OMBCONNECT
Purpose
To disconnect from a OWB workspace or the named Control Center.
Prerequisites
Currently need to be connected to a OWB workspace on the repository or the
named Control Center.
Syntax
parseDisconnectCommand = ( ( OMBDISCONNECT | OMBDISC ) [ CONTROL_CENTER ]
)
Keywords And Parameters
parseDisconnectCommand
Specify disconnect command.
See Also
OMBCONNECT
Purpose
To disconnect from a OWB workspace or the named Control Center.
Prerequisites
Currently need to be connected to a OWB workspace on the repository or the
named Control Center.
Syntax
parseDisconnectCommand = ( ( OMBDISCONNECT | OMBDISC ) [ CONTROL_CENTER ]
)
Keywords And Parameters
parseDisconnectCommand
Specify disconnect command.
See Also
OMBCONNECT
Purpose
To disconnect from a OWB workspace or the named Control Center.
Prerequisites
Currently need to be connected to a OWB workspace on the repository or the
named Control Center.
Syntax
parseDisconnectCommand = ( ( OMBDISCONNECT | OMBDISC ) [ CONTROL_CENTER ]
)
Keywords And Parameters
parseDisconnectCommand
Specify disconnect command.
See Also
OMBCONNECT
Purpose
Displays the current connection mode to the workspace. Returns either SINGLE_USER_MODE (i.e. exclusive) or
MULTIPLE_USER_MODE.
Prerequisites
Must be connected to an OWB workspace. If not already connected, use
OMBCONNECT first.
Syntax
parseDisplayModeCommand = ( OMBDISPLAYCURRENTMODE | OMBDCM )
Keywords And Parameters
parseDisplayModeCommand
Specify display mode command.
See Also
OMBSWITCHMODE, OMBCONNECT, OMBSAVE, OMBREVERT
Purpose
This command will list the values for all set OMBPlus environment variables. OMBPlus environment variables are regular Tcl variables, so they
can be set using standard Tcl "set" command, and unset using standard
"unset" command.
Prerequisites
None.
Syntax
parseEnvironmentCommand = OMBENV
Keywords And Parameters
parseEnvironmentCommand
Specify environment command. The environment variables recognized by
OMBPlus are:
OMBPROMPT if set, will display the current context as the prompt
OMBLOG if set with a file name, will log the output to that file
OMBTIMER if set, will display the time taken by the executed command.
Note that the elapsed time will be appended to the command result,
therefore the user should not set this variable when the result of the
command is expected to be processed
OMBCONTINUE_ON_ERROR if set, will continue the execution of the
script, even when some OMB commands fail. Note that if this variable is
set, OMB commands no longer return Tcl errors, so any enclosing 'catch'
command will not be effective.
Purpose
Exports current metadata, metadata definitions, or snapshot metadata to a metadata loader file.
Prerequisites
Connection must be established to repository to be exported from.
Syntax
ExportCommand = OMBEXPORT ( ( [ TO ] MDL_FILE "QUOTED_STRING" [ FROM ] [
"projectClause" ] [ "componentsClause" ] [ ( "classesClause" |
ALL_CLASS_DEFINITIONS ) ] [ WITH ] [ "dependeeDepthClause" ] [
"includeGrantsClause" ] [ "includeCMIDefsClause" ] [
"useFieldSeparatorClause" ] [ "controlFileClause" ] [
"includeUserDefsClause" ] [ "supportedLangsClause" ] [
"outputLogClause" ] ) )
projectClause = PROJECT "QUOTED_STRING"
componentsClause = COMPONENTS "(" "componentsList" ")"
classesClause = CLASS_DEFINITIONS "(" "QUOTED_STRING" { ","
"QUOTED_STRING" } ")"
dependeeDepthClause = DEPENDEE_DEPTH ( MAX | "INTEGER_LITERAL" )
includeGrantsClause = INCLUDE_GRANTS
includeCMIDefsClause = INCLUDE_CMI_DEFINITIONS
useFieldSeparatorClause = [ USE ] FIELD_SEPARATOR "UNQUOTED_STRING"
controlFileClause = CONTROL_FILE "QUOTED_STRING"
includeUserDefsClause = INCLUDE_USER_DEFINITIONS
supportedLangsClause = SUPPORTED_LANGUAGES "(" "supportedLangsList" ")"
outputLogClause = OUTPUT LOG [ TO ] "QUOTED_STRING"
componentsList = "newObjectTypeValue" "QUOTED_STRING" { ","
"newObjectTypeValue" "QUOTED_STRING" }
supportedLangsList = "QUOTED_STRING" { "," "QUOTED_STRING" }
newObjectTypeValue = "UNQUOTED_STRING"
Keywords And Parameters
ExportCommand
Export metadata and optionally metadata definitions to a file.
QUOTED_STRING
Enclose the name of the export metadata file in single quotes.
projectClause
Specify the project to be exported.
QUOTED_STRING
Enclose the name of the project to be exported in single quotes.
componentsClause
List components to be exported.
dependeeDepthClause
Specify how many levels of dependent objects should be exported for
components specified for export. Use MAX for all dependents, 0 for no
dependents, 1 for one level of dependents. The default is 0.
includeGrantsClause
Use to request that security related metadata be included in the export.
includeCMIDefsClause
Use to request that related CMI Definitions for CMI Modules be included in
the export.
useFieldSeparatorClause
Do not use this option. It is an obsolete option that was used to specify
character to be used as the field separator in the old metadata file
format.
UNQUOTED_STRING
Do not use this option. Obsolete metadata file field separator for old MDL
file format. Use BAR or CARAT. The default is BAR.
controlFileClause
Specify a control file with export options not directly supported by
OMBEXPORT command.
QUOTED_STRING
Enclose the control file name in single quotes.
includeUserDefsClause
Use to request that metadata definitions be included in the export.
supportedLangsClause
List supported languages to be exported.
outputLogClause
Export log file for export messages and statistics.
QUOTED_STRING
Enclose the log file name in single quotes.
componentsList
Comma separated list of components to be exported.
QUOTED_STRING
Enclose in single quotes the absolute or relative path name of an object
(e.g. 'MODULE_X/TABLE_Y').
supportedLangsList
Comma separated list of supported languages to be exported.
QUOTED_STRING
Language name or ISO id of supported language (e.g. 'German' or 'de_DE').
See Also
OMBIMPORT
Purpose
Exports current metadata, metadata definitions, or snapshot metadata to a metadata loader file.
Prerequisites
Connection must be established to repository to be exported from.
Syntax
ExportCommand = OMBEXPORT ( ( [ TO ] MDL_FILE "QUOTED_STRING" [ FROM ] [
"projectClause" ] [ "componentsClause" ] [ ( "classesClause" |
ALL_CLASS_DEFINITIONS ) ] [ WITH ] [ "dependeeDepthClause" ] [
"includeGrantsClause" ] [ "includeCMIDefsClause" ] [
"useFieldSeparatorClause" ] [ "controlFileClause" ] [
"includeUserDefsClause" ] [ "supportedLangsClause" ] [
"outputLogClause" ] ) )
projectClause = PROJECT "QUOTED_STRING"
componentsClause = COMPONENTS "(" "componentsList" ")"
classesClause = CLASS_DEFINITIONS "(" "QUOTED_STRING" { ","
"QUOTED_STRING" } ")"
dependeeDepthClause = DEPENDEE_DEPTH ( MAX | "INTEGER_LITERAL" )
includeGrantsClause = INCLUDE_GRANTS
includeCMIDefsClause = INCLUDE_CMI_DEFINITIONS
useFieldSeparatorClause = [ USE ] FIELD_SEPARATOR "UNQUOTED_STRING"
controlFileClause = CONTROL_FILE "QUOTED_STRING"
includeUserDefsClause = INCLUDE_USER_DEFINITIONS
supportedLangsClause = SUPPORTED_LANGUAGES "(" "supportedLangsList" ")"
outputLogClause = OUTPUT LOG [ TO ] "QUOTED_STRING"
componentsList = "newObjectTypeValue" "QUOTED_STRING" { ","
"newObjectTypeValue" "QUOTED_STRING" }
supportedLangsList = "QUOTED_STRING" { "," "QUOTED_STRING" }
newObjectTypeValue = "UNQUOTED_STRING"
Keywords And Parameters
ExportCommand
Export metadata and optionally metadata definitions to a file.
QUOTED_STRING
Enclose the name of the export metadata file in single quotes.
projectClause
Specify the project to be exported.
QUOTED_STRING
Enclose the name of the project to be exported in single quotes.
componentsClause
List components to be exported.
dependeeDepthClause
Specify how many levels of dependent objects should be exported for
components specified for export. Use MAX for all dependents, 0 for no
dependents, 1 for one level of dependents. The default is 0.
includeGrantsClause
Use to request that security related metadata be included in the export.
includeCMIDefsClause
Use to request that related CMI Definitions for CMI Modules be included in
the export.
useFieldSeparatorClause
Do not use this option. It is an obsolete option that was used to specify
character to be used as the field separator in the old metadata file
format.
UNQUOTED_STRING
Do not use this option. Obsolete metadata file field separator for old MDL
file format. Use BAR or CARAT. The default is BAR.
controlFileClause
Specify a control file with export options not directly supported by
OMBEXPORT command.
QUOTED_STRING
Enclose the control file name in single quotes.
includeUserDefsClause
Use to request that metadata definitions be included in the export.
supportedLangsClause
List supported languages to be exported.
outputLogClause
Export log file for export messages and statistics.
QUOTED_STRING
Enclose the log file name in single quotes.
componentsList
Comma separated list of components to be exported.
QUOTED_STRING
Enclose in single quotes the absolute or relative path name of an object
(e.g. 'MODULE_X/TABLE_Y').
supportedLangsList
Comma separated list of supported languages to be exported.
QUOTED_STRING
Language name or ISO id of supported language (e.g. 'German' or 'de_DE').
See Also
OMBIMPORT MDL_FILE
Purpose
To change the default object privilege setting property of a user, basically it will grant a list of default object
privileges to a list of users or roles. These object privileges will really
be granted to the specified user or role on the new objects whenever the
owner creates them.
Prerequisites
Must be connected to a workspace on OWB repository.
Syntax
parseGrantDefObjPrivCommand = OMBGRANT DEFAULT ( OBJ_PRIV |
OBJECT_PRIVILEGE ) "objPrivNameList" TO ( USER "userOrRoleNameList" |
ROLE "userOrRoleNameList" ) [ FOR USER "QUOTED_STRING" ]
objPrivNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
userOrRoleNameList = "QUOTED_STRING" { "," "QUOTED_STRING" }
Keywords And Parameters
parseGrantDefObjPrivCommand
This clause change the default object privilege setting property of a user
through granting a list of default object privileges to a list of users or
roles.
objPrivNameList
Object privileges. Valid object privileges are: READ, COMPILE, EDIT,
FULL_CONTROL.
See Also
OMBREVOKE DEFAULT OBJ_PRIV, OMBLIST DEFAULT OBJ_PRIVS
Purpose
To grant a list of object privileges on the specified objects to a list of users or roles.
Prerequisites
Must be connected to a workspace on OWB repository.
Syntax
parseGrantObjPrivCommand = OMBGRANT ( OBJ_PRIV | OBJECT_PRIVILEGE )
"objPrivNameList" ON "UNQUOTED_STRING" "QUOTED_STRING" [ CASCADE ] TO
( USER "userOrRoleNameList" | ROLE "userOrRoleNameList" )
objPrivNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
userOrRoleNameList = "QUOTED_STRING" { "," "QUOTED_STRING" }
Keywords And Parameters
parseGrantObjPrivCommand
This clause grants a list of object privileges on the specified objects to
a list of users or roles.
UNQUOTED_STRING
The type of the objects to be listed.Valid object types are: PROJECT,
ORACLE_MODULE, FLAT_FILE_MODULE, PROCESS_FLOW_MODULE, SAP_MODULE,
BUSINESS_DEFINITION_MODULE, BUSINESS_PRESENTATION_MODULE,
TRANSFORMATION_MODULE, PACKAGE, ADVANCED_QUEUE, BUSINESS_AREA, COLLECTION,
CONNECTOR, CUBE, DIMENSION, EXTERNAL_TABLE, FLAT_FILE, FUNCTION,
REGISTERED_FUNCTION, MAPPING, MATERIALIZED_VIEW, OBJECT_TYPE, PROCEDURE,
ITEM_FOLDER, DRILL_PATH, DRILLS_TO_DETAIL, ALTERNATIVE_SORT_ORDER,
LISTS_OF_VALUE, PRESENTATION_TEMPLATE, SEQUENCE, TABLE, PROCESS_FLOW,
PROCESS_FLOW_PACKAGE, LOCATION, CONTROL_CENTER, CONFIGURATION, DEPLOYMENT,
VIEW.
QUOTED_STRING
an object name or a regular expression refers to a list of objects whose
name matches the regular expression.
CASCADE
grant the specified object privileges on a folder object and all its child
objects cascade down. Note: if CASCADE is used, the string used to specify
the object can only refer to one object and not be a regular experssion .
objPrivNameList
Object privileges. Valid object privileges are: READ, COMPILE, EDIT,
FULL_CONTROL.
See Also
OMBREVOKE OBJ_PRIV, OMBLIST OBJ_PRIVS
Purpose
To grant a list of Warehouse Builder roles to a list of Warehouse Builder users. Note role can not be granted to another role.
Prerequisites
Must be connected to a workspace on OWB repository.
Syntax
parseGrantRoleCommand = OMBGRANT ROLE "userOrRoleNameList" TO USER
"userOrRoleNameList"
userOrRoleNameList = "QUOTED_STRING" { "," "QUOTED_STRING" }
Keywords And Parameters
parseGrantRoleCommand
This clause grants a list of Warehouse Builder roles to a list of Warehouse
Builder users.
See Also
OMBREVOKE ROLE, OMBLIST ROLES
Purpose
To grant a list of system privileges to a list of users or roles.
Prerequisites
Must be connected to a workspace on OWB repository.
Syntax
parseGrantSysPrivCommand = OMBGRANT ( SYS_PRIV | SYSTEM_PRIVILEGE )
"sysPrivNameList" TO ( USER "userOrRoleNameList" | ROLE
"userOrRoleNameList" )
sysPrivNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
userOrRoleNameList = "QUOTED_STRING" { "," "QUOTED_STRING" }
Keywords And Parameters
parseGrantSysPrivCommand
This clause grants a list of system privileges to a list of users or roles.
sysPrivNameList
List of system privileges. Valid system privileges
are:ACCESS_PUBLICVIEW_BROWSER, CONTROL_CENTER_DEPLOYMENT,
CONTROL_CENTER_EXECUTION,CONTROL_CENTER_VIEW,CREATE_EXTENSIONMODEL,CREATE_PROJECT,
CREATE_SNAPSHOT
See Also
OMBREVOKE SYS_PRIV, OMBLIST SYS_PRIVS
Purpose
Displays the manual page for OMB commands.
Prerequisites
None.
Syntax
parseHelpCommand = OMBHELP [ HELPID ] [ DETAIL ]
Keywords And Parameters
parseHelpCommand
Specifies the command for which to invoke help.
HELPID
An unquoted string that represents either the command name and the optional
additional parameter on the command.
DETAIL
Use this keyword to display the manual page in long format.
Purpose
To fetch the impact of a change for an object.
Prerequisites
In the context of an object's parent module.
Syntax
parseImpactCommand = OMBIMPACT DEPENDENCYTYPE "parseType" "parseFCO" [
"parseSCO" ] [ "parseDetail" ]
parseType = "QUOTED_STRING"
parseFCO = ( ADVANCED_QUEUE | ALTERNATIVE_SORT_ORDER | CUBE | DATA_RULE |
DIMENSION | DRILL_PATH | DRILL_TO_DETAIL | EXTERNAL_TABLE | FLAT_FILE
| FUNCTION | ITEM_FOLDER | LIST_OF_VALUES | MATERIALIZED_VIEW |
NESTED_TABLE | OBJECT_TYPE | PLUGGABLE_MAPPING | PROCEDURE |
QUEUE_TABLE | REGISTERED_FUNCTION | SEQUENCE | TABLE | TIME_DIMENSION
| VARYING_ARRAY | VIEW ) "QUOTED_STRING"
parseSCO = "UNQUOTED_STRING" "QUOTED_STRING" { "UNQUOTED_STRING"
"QUOTED_STRING" }
parseDetail = GET MAPPING CONTENTS
Keywords And Parameters
parseImpactCommand
Specify OMBIMPACT command.
parseType
The type of impact. Allowable values are: DATAFLOW or DEPLOYMENT.
parseFCO
The object whose impact needs to be fetched.
parseSCO
The second class object whose impact needs to be fetched, specified in the
form: SCO_type SCO_name. The second class object has to belong to the first
class object specified by the previous clause. If the second class object
is not direct child of the first class object, then the whole hierarchy
path has to be listed (for example: parent_SCO_type parent_SCO_name
child_SCO_type child_SCO_name).
parseDetail
Expands mappings and show operators involved in the impact.
Purpose
Imports metadata from a Metadata Loader file, or from the default metadata location specified in the module.
Please refer to OMBHELP OMBIMPORT MDL_FILE or OMBHELP OMBIMPORT
METADATA_LOCATION.
Prerequisites
Must be connected to the workspace where the import is to be performed.
Syntax
ImportCommand = OMBIMPORT [ FROM ] ( "mdlImportCommand" |
"oracleDBImportCommand" )
mdlImportCommand = ( MDL_FILE "QUOTED_STRING" [ "noUpgradeClause" ] [
"includeUserDefsClause" ] [ "useModeClause" | "asSnapshotClause" ] [
"matchByClause" ] [ "includeGrantsClause" ] [ "includeCMIDefsClause" ]
[ "controlFileClause" ] [ "supportedLangsClause" ] [
"allowDiffBaseLangClause" ] [ "outputLogClause" ] )
oracleDBImportCommand = ( METADATA_LOCATION [ FOR ] IMPORT_ACTION_PLAN
"QUOTED_STRING" [ "setImportOptions" ] )
noUpgradeClause = NO_UPGRADE
includeUserDefsClause = INCLUDE_USER_DEFINITIONS
useModeClause = USE "modeValue"
asSnapshotClause = AS SNAPSHOT "QUOTED_STRING"
matchByClause = MATCH_BY "matchByValue"
includeGrantsClause = INCLUDE_GRANTS
includeCMIDefsClause = INCLUDE_CMI_DEFINITIONS
controlFileClause = CONTROL_FILE "QUOTED_STRING"
supportedLangsClause = SUPPORTED_LANGUAGES "(" "supportedLangsList" ")"
allowDiffBaseLangClause = ALLOW_DIFFERENT_BASE_LANGUAGE
outputLogClause = OUTPUT LOG [ TO ] "QUOTED_STRING"
setImportOptions = SET OPTIONS "(" "optionNameList" ")" VALUES "("
"optionValueList" ")"
modeValue = ( CREATE_MODE | REPLACE_MODE | UPDATE_MODE | MERGE_MODE |
TRANSLATION_DIRECT_LOAD_MODE )
matchByValue = ( UNIVERSAL_IDENTIFIER | NAMES )
supportedLangsList = "QUOTED_STRING" { "," "QUOTED_STRING" }
optionNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
optionValueList = "optionValue" { "," "optionValue" }
optionValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
ImportCommand
Import metadata from a Metadata Loader file, or from the default metadata
location specified in the module.
mdlImportCommand
Import metadata from a file.
oracleDBImportCommand
To import from the default metadata location based on the import action
plan.
QUOTED_STRING
The name of the transient action plan.
noUpgradeClause
Specify that MDL files that are not compatible with current repository
version should not be automatically upgraded. The default is to
automatically upgrade unless this clause is used.
includeUserDefsClause
Use to request that any metadata definitions in the MDL file be imported.
useModeClause
Specify import mode for importing metadata file.
asSnapshotClause
Specify a new snapshot name into which the contents of the MDL file are to
be imported. Use this option to import old archive files as snapshots.
QUOTED_STRING
Enclose the new snapshot name in single quotes.
matchByClause
Specify whether import should search for already existing objects using
universal identifiers or physical names.
includeGrantsClause
Use to request that security related metadata be imported.
includeCMIDefsClause
Use to request that related CMI Definitions for CMI Modules be imported.
controlFileClause
Specify a control file with import options not directly supported by the
OMBIMPORT command.
QUOTED_STRING
Enclose the control file name in single quotes.
supportedLangsClause
List supported languages to be imported.
allowDiffBaseLangClause
Use to specify that MDL files with a different base langugae than that of
the import target repository can be imported.
outputLogClause
Log file for import messages and statistics.
QUOTED_STRING
Enclose the log file name in single quotes.
setImportOptions
Currently no import options are available to be set.
modeValue
Import mode. Use CREATE_MODE, REPLACE_MODE, UPDATE_MODE, MERGE_MODE, or
TRANSLATION_DIRECT_LOAD_MODE. The default is CREATE_MODE.
CREATE_MODE: create new metadata only
REPLACE_MODE: replace existing objects only
UPDATE_MODE: replace existing objects and create new metadata
MERGE_MODE: merge existing objects and create new metadata
TRANSLATION_DIRECT_LOAD_MODE: import language translation metadata only
matchByValue
Use UNIVERSAL_IDENTIFIER or NAMES. The default is UNIVERSAL_IDENTIFIER.
supportedLangsList
Comma separated list of supported languages to be imported.
QUOTED_STRING
Language name or ISO id of supported language (e.g. 'German' or 'de_DE').
See Also
OMBIMPORT MDL_FILE, OMBIMPORT METADATA_LOCATION
Purpose
Imports metadata and metadata definitions from a Metadata Loader file.
Prerequisites
Must be connected to the workspace where the import is to be performed.
Syntax
mdlImportCommand = ( MDL_FILE "QUOTED_STRING" [ "noUpgradeClause" ] [
"includeUserDefsClause" ] [ "useModeClause" | "asSnapshotClause" ] [
"matchByClause" ] [ "includeGrantsClause" ] [ "includeCMIDefsClause" ]
[ "controlFileClause" ] [ "supportedLangsClause" ] [
"allowDiffBaseLangClause" ] [ "outputLogClause" ] )
noUpgradeClause = NO_UPGRADE
includeUserDefsClause = INCLUDE_USER_DEFINITIONS
useModeClause = USE "modeValue"
asSnapshotClause = AS SNAPSHOT "QUOTED_STRING"
matchByClause = MATCH_BY "matchByValue"
includeGrantsClause = INCLUDE_GRANTS
includeCMIDefsClause = INCLUDE_CMI_DEFINITIONS
controlFileClause = CONTROL_FILE "QUOTED_STRING"
supportedLangsClause = SUPPORTED_LANGUAGES "(" "supportedLangsList" ")"
allowDiffBaseLangClause = ALLOW_DIFFERENT_BASE_LANGUAGE
outputLogClause = OUTPUT LOG [ TO ] "QUOTED_STRING"
modeValue = ( CREATE_MODE | REPLACE_MODE | UPDATE_MODE | MERGE_MODE |
TRANSLATION_DIRECT_LOAD_MODE )
matchByValue = ( UNIVERSAL_IDENTIFIER | NAMES )
supportedLangsList = "QUOTED_STRING" { "," "QUOTED_STRING" }
Keywords And Parameters
mdlImportCommand
Import metadata from a file.
noUpgradeClause
Specify that MDL files that are not compatible with current repository
version should not be automatically upgraded. The default is to
automatically upgrade unless this clause is used.
includeUserDefsClause
Use to request that any metadata definitions in the MDL file be imported.
useModeClause
Specify import mode for importing metadata file.
asSnapshotClause
Specify a new snapshot name into which the contents of the MDL file are to
be imported. Use this option to import old archive files as snapshots.
QUOTED_STRING
Enclose the new snapshot name in single quotes.
matchByClause
Specify whether import should search for already existing objects using
universal identifiers or physical names.
includeGrantsClause
Use to request that security related metadata be imported.
includeCMIDefsClause
Use to request that related CMI Definitions for CMI Modules be imported.
controlFileClause
Specify a control file with import options not directly supported by the
OMBIMPORT command.
QUOTED_STRING
Enclose the control file name in single quotes.
supportedLangsClause
List supported languages to be imported.
allowDiffBaseLangClause
Use to specify that MDL files with a different base langugae than that of
the import target repository can be imported.
outputLogClause
Log file for import messages and statistics.
QUOTED_STRING
Enclose the log file name in single quotes.
modeValue
Import mode. Use CREATE_MODE, REPLACE_MODE, UPDATE_MODE, MERGE_MODE, or
TRANSLATION_DIRECT_LOAD_MODE. The default is CREATE_MODE.
CREATE_MODE: create new metadata only
REPLACE_MODE: replace existing objects only
UPDATE_MODE: replace existing objects and create new metadata
MERGE_MODE: merge existing objects and create new metadata
TRANSLATION_DIRECT_LOAD_MODE: import language translation metadata only
matchByValue
Use UNIVERSAL_IDENTIFIER or NAMES. The default is UNIVERSAL_IDENTIFIER.
supportedLangsList
Comma separated list of supported languages to be imported.
QUOTED_STRING
Language name or ISO id of supported language (e.g. 'German' or 'de_DE').
See Also
OMBEXPORT MDL_FILE
Purpose
Import metadata from the default metadata location specified in the module. Currently we only support
tables/views/sequences for Oracle/Gateway/SAP/MIV modules.
Prerequisites
Must be connected to the repository where the import is to be performed.
Syntax
oracleDBImportCommand = ( METADATA_LOCATION [ FOR ] IMPORT_ACTION_PLAN
"QUOTED_STRING" [ "setImportOptions" ] )
setImportOptions = SET OPTIONS "(" "optionNameList" ")" VALUES "("
"optionValueList" ")"
optionNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
optionValueList = "optionValue" { "," "optionValue" }
optionValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
oracleDBImportCommand
To import from the default metadata location based on the import action
plan.
QUOTED_STRING
The name of the transient action plan.
setImportOptions
Currently no import options are available to be set.
See Also
OMBCREATE TRANSIENT IMPORT_ACTION_PLAN
Purpose
Register RAC instance (only for RAC 's second instance onwards).
Prerequisites
This command should be run locally on the database server. The value of
USING CREDENTIAL must be OWBSYS' database user credential.
Syntax
parseRegisterRACCommand = OMBINSTALL OWB_RAC USING CREDENTIAL
"UNQUOTED_STRING" [ NET_SERVICE_NAME "QUOTED_STRING" ]
Keywords And Parameters
parseRegisterRACCommand
Specify OMBINSTALL OWB_RAC command.
UNQUOTED_STRING
Specify the connection string to the database using this format:
owbsys/owbsys_password@host:port:service name OR specify the user name and
password using this format username/password.
Purpose
Create a workspace in the OWB repository schema OWBSYS.
Prerequisites
To create a workspace, within the same OMBPlus session, no other OMB
commands should be issued before or after the OMBINSTALL WORKSPACE command.
Each workspace name must be unique for a specified owning db user.
Syntax
parseInstallOWBRepositoryCommand = OMBINSTALL ( OWB_REPOSITORY | WORKSPACE
) "QUOTED_STRING" USING CREDENTIAL "UNQUOTED_STRING"
Keywords And Parameters
parseInstallOWBRepositoryCommand
Specify an OMBINSTALL WORKSPACE command.
QUOTED_STRING
Specify the workspace name and, optionally, the workspace owner. If not
provided, owner defaults to the user supplied in the connection string.
UNQUOTED_STRING
Specify the connection string to the database using this format:
username/password@host:port:service name.
Purpose
Create a workspace in the OWB repository schema OWBSYS.
Prerequisites
To create a workspace, within the same OMBPlus session, no other OMB
commands should be issued before or after the OMBINSTALL WORKSPACE command.
Each workspace name must be unique for a specified owning db user.
Syntax
parseInstallOWBRepositoryCommand = OMBINSTALL ( OWB_REPOSITORY | WORKSPACE
) "QUOTED_STRING" USING CREDENTIAL "UNQUOTED_STRING"
Keywords And Parameters
parseInstallOWBRepositoryCommand
Specify an OMBINSTALL WORKSPACE command.
QUOTED_STRING
Specify the workspace name and, optionally, the workspace owner. If not
provided, owner defaults to the user supplied in the connection string.
UNQUOTED_STRING
Specify the connection string to the database using this format:
username/password@host:port:service name.
Purpose
To fetch the data lineage.
Prerequisites
In the context of an object's parent module.
Syntax
parseLineageCommand = OMBLINEAGE DEPENDENCYTYPE "parseType" "parseFCO" [
"parseSCO" ] [ "parseDetail" ]
parseType = "QUOTED_STRING"
parseFCO = ( ADVANCED_QUEUE | ALTERNATIVE_SORT_ORDER | CUBE | DATA_RULE |
DIMENSION | DRILL_PATH | DRILL_TO_DETAIL | EXTERNAL_TABLE | FLAT_FILE
| FUNCTION | ITEM_FOLDER | LIST_OF_VALUES | MATERIALIZED_VIEW |
NESTED_TABLE | OBJECT_TYPE | PLUGGABLE_MAPPING | PROCEDURE |
QUEUE_TABLE | REGISTERED_FUNCTION | SEQUENCE | TABLE | TIME_DIMENSION
| VARYING_ARRAY | VIEW ) "QUOTED_STRING"
parseSCO = "UNQUOTED_STRING" "QUOTED_STRING" { "UNQUOTED_STRING"
"QUOTED_STRING" }
parseDetail = GET MAPPING CONTENTS
Keywords And Parameters
parseLineageCommand
Specify OMBLINEAGE command.
parseType
The type of lineage. Allowable values are: DATAFLOW or DEPLOYMENT.
parseFCO
The object whose lineage needs to be fetched.
parseSCO
The second class object whose lineage needs to be fetched, specified in the
form: SCO_type SCO_name. The second class object has to belong to the first
class object specified by the previous clause. If the second class object
is not direct child of the first class object, then the whole hierarchy
path has to be listed (for example: parent_SCO_type parent_SCO_name
child_SCO_type child_SCO_name).
parseDetail
Expands mappings and show operators involved in the lineage.
Purpose
This command lists the specified Warehouse Builder objects under the current folder. You can also provide a regular expression to list
objects in a different folder and/or to list objects with names matching a
pattern. Before displaying the objects, this command first refreshes the
object list from the repository. This means that the list of objects
returned also reflects any additions or deletions by other users.
Prerequisites
Must be connected to a OWB workspace of the repository.
Syntax
parseListCommand = "listActionPlans" | "listGeneral" listActionPlans = OMBLIST DEPLOYMENT_ACTION_PLANS [ "QUOTED_STRING" ] listGeneral = OMBLIST "UNQUOTED_STRING" [ "QUOTED_STRING" ]
Keywords And Parameters
parseListCommand
Specify the list command.
listActionPlans
Deployment action plans are listed.
listGeneral
OWB objects of the specified type are listed.
UNQUOTED_STRING
The type (plural) of the objects to be listed. Valid object types are:
ACTIVITY_TEMPLATES, ACTIVITY_TEMPLATE_FOLDERS, ADVANCED_QUEUES,
ALTERNATIVE_SORT_ORDERS, BUSINESS_AREAS, BUSINESS_DEFINITION_MODULES,
BUSINESS_PRESENTATION_MODULES, CALENDARS, CALENDAR_MODULES,
CMI_DEFINITIONS, CMI_MODULES, COLLECTIONS, CONFIGURATIONS, CONNECTORS,
CONTROL_CENTERS, CUBES, DATA_AUDITORS, DATA_PROFILES, DATA_RULES,
DATA_RULE_MODULES, DEPLOYMENTS, DEPLOYMENT_ACTION_PLANS, DIMENSIONS,
DRILL_PATHS, DRILLS_TO_DETAIL, EXPERTS, EXPERT_MODULES, EXTERNAL_TABLES,
FLAT_FILES, FLAT_FILE_MODULES, FUNCTIONS, GATEWAY_MODULES, ICONSETS,
ITEM_FOLDERS, LISTS_OF_VALUES, LOCATIONS, MAPPINGS, MATERIALIZED_VIEWS,
NESTED_TABLES, OBJECT_TYPES, ORACLE_MODULES, PACKAGES, PLSQL_RECORD_TYPES,
PLSQL_REF_CURSOR_TYPES, PLSQL_TABLE_TYPES, PLUGGABLE_MAPPINGS,
PLUGGABLE_MAPPING_FOLDERS, PRESENTATION_TEMPLATES, PROCEDURES,
PROCESS_FLOWS, PROCESS_FLOW_MODULES, PROCESS_FLOW_PACKAGES, PROJECTS,
QUEUE_PROPAGATIONS, QUEUE_TABLES, REAL_TIME_MAPPINGS, REGISTERED_FUNCTIONS,
ROLES, SAP_MODULES, SEQUENCES, SNAPSHOTS, STREAMS_CAPTURE_PROCESSES,
STREAMS_QUEUES, TABLES, TABLE_FUNCTIONS, TIME_DIMENSIONS,
TRANSFORMATION_MODULES, TRANSPORTABLE_MODULES, USERS, VARYING_ARRAYS,
VIEWS.
QUOTED_STRING
Mandatory for CONNECTORS, specify a location name; optionally for all other
objects, specify a regular expression, which is used to filter the results.
The syntax of the regular expressions follow the syntax from TCL.
Here are some of the quantifiers:
* -- represents a sequence of 0 or more matches of the atom.
+ -- represents a sequence of 1 or more matches of the atom.
? -- represents a sequence of 0 or 1 matches of the atom.
Here are some of the atoms:
. -- matches any single character
k -- (where k is a non-alphanumeric character) matches that character taken
as an ordinary character,
e.g. \\ matches a backslash character.
c -- where c is alphanumeric(possibly followed by other characters), an
escape.
(re) -- (where re is any regular expression) matches a match for re, with
the match noted for possible reporting.
[char] -- a bracket expression, matching any one of the chars.
Further documentation on the syntax can be found at the TCL manual page
under the command 'regexp'.
Purpose
To list all the object privileges granted to a specified user on a specified object, some of which my be inherited from
granted roles. Note: A role will not be granted to another role, so OMBLIST
OBJ_PRIVS and OMBLIST ALL OBJ_PRIVS actually will list the same result for
roles.
Prerequisites
Must be connected to a workspace on OWB repository.
Syntax
parseListAllObjPrivs = OMBLIST ALL ( OBJ_PRIVS | OBJECT_PRIVILEGES ) ON
"UNQUOTED_STRING" "QUOTED_STRING" ( OF ( USER | ROLE ) "QUOTED_STRING"
)
Keywords And Parameters
parseListAllObjPrivs
This clause lists all the object privileges granted to a specified user on
a specified object, some of which my be inherited from granted roles. Note:
A role will not be granted to another role, so OMBLIST OBJ_PRIVS and
OMBLIST ALL OBJ_PRIVS actually will list the same result for roles.
Purpose
To list all the system privileges granted to a user or a role, some of the privileges may be inherited from the granted roles.
Note: A role will not be granted to another role, so OMBLIST SYS_PRIVS and
OMBLIST ALL SYS_PRIVS actually will list the same result for roles.
Prerequisites
All System privileges granted to a user or a role can be listed from any
context.
Syntax
parseListAllSysPrivs = OMBLIST ALL ( SYS_PRIVS | SYSTEM_PRIVILEGES ) ( OF
USER "QUOTED_STRING" )
Keywords And Parameters
parseListAllSysPrivs
This clause lists the overall system privileges granted to a user or a
role. Some of the privileges may inherited from granted roles. Note: A role
will not be granted to another role, so OMBLIST SYS_PRIVS and OMBLIST ALL
SYS_PRIVS actually will list the same result for roles.
Purpose
To list all the default object privileges granted to a specified role or user from the owner, some of which may be
inherited from the granted roles. These object privileges will really be
granted to the specified user or role on the new object whenever the owner
creates it.
Prerequisites
The default object privileges can be listed from any context.
Syntax
parseListAllDefObjPrivs = OMBLIST ALL DEFAULT ( OBJ_PRIVS |
OBJECT_PRIVILEGES ) ( OF ( USER | ROLE ) "QUOTED_STRING" ) [ FOR USER
"QUOTED_STRING" ]
Keywords And Parameters
parseListAllDefObjPrivs
This clause will show the default object privilege setting property of a
user, basically will list all the default object privileges granted to a
specified role or user from the owner. The list result includes the default
object privileges granted directly to a user and the default object
privileges inherited by the user. Note: A role will not be granted to
another role, so OMBLIST DEFAULT OBJ_PRIVS and OMBLIST ALL DEFAULT
OBJ_PRIVS actually will list the same result for roles. The default object
privileges will be really ganted to the specified user or role on the newly
created object by the owner.
Purpose
To list the icon sets in the current workspace.
Prerequisites
Must be connected to a workspace, in any context.
Syntax
listIconSetCommand = OMBLIST ICONSETS [ "QUOTED_STRING" ] [ OF
"QUOTED_STRING" ]
Keywords And Parameters
listIconSetCommand
This command lists the iconsets in a workspace.
QUOTED_STRING
A regular expression that describes the name of the icon set. Or the name
of the group to which iconsets belong.
See Also
OMBCREATE ICONSET
Purpose
To list the object privileges directly granted to a specified user on a specified object, which do not include the object
privileges inherited from the granted roles.
Prerequisites
Must be connected to a workspace on OWB repository.
Syntax
parseListObjPrivs = OMBLIST ( OBJ_PRIVS | OBJECT_PRIVILEGES ) ON
"UNQUOTED_STRING" "QUOTED_STRING" ( OF ( USER | ROLE ) "QUOTED_STRING"
)
Keywords And Parameters
parseListObjPrivs
This clause lists the object privileges directly granted to a specified
user on a specified object, which do not include the object privileges
inherited from the granted roles.
UNQUOTED_STRING
The type of the objects to be listed.Valid object types are: PROJECT,
ORACLE_MODULE, FLAT_FILE_MODULE, PROCESS_FLOW_MODULE, SAP_MODULE,
BUSINESS_DEFINITION_MODULE, BUSINESS_PRESENTATION_MODULE,
TRANSFORMATION_MODULE, PACKAGE, ADVANCED_QUEUE, BUSINESS_AREA, COLLECTION,
CONNECTOR, CUBE, DIMENSION, EXTERNAL_TABLE, FLAT_FILE, FUNCTION,
REGISTERED_FUNCTION, MAPPING, MATERIALIZED_VIEW, OBJECT_TYPE, PROCEDURE,
ITEM_FOLDER, DRILL_PATH, DRILLS_TO_DETAIL, ALTERNATIVE_SORT_ORDER,
LISTS_OF_VALUE, PRESENTATION_TEMPLATE, SEQUENCE, TABLE, PROCESS_FLOW,
PROCESS_FLOW_PACKAGE, LOCATION, CONTROL_CENTER, CONFIGURATION, DEPLOYMENT,
VIEW.
Purpose
parseListRolePurposeTag??
Prerequisites
Warehouse Builder users can be list from any context.
Syntax
parseListRole = OMBLIST ROLES ( [ "QUOTED_STRING" | ( OF USER
"QUOTED_STRING" ) ] )
Keywords And Parameters
parseListRole
This clause lists existing roles or lists existing roles whose names match
the given regular expression or lists the granted roles of a given user.
Purpose
This command lists all the snapshots existing or all snapshots for a specific component.
Prerequisites
Snapshots can be listed from any context.
Syntax
parseListCommand = OMBLIST "listSnapshotCommand"
listSnapshotCommand = SNAPSHOTS [ FOR ( "UNQUOTED_STRING" "QUOTED_STRING"
) ]
Keywords And Parameters
parseListCommand
Root production of OMBLIST SNAPSHOT.
listSnapshotCommand
To list existing snapshots.
SNAPSHOTS
Lists all the snapshots existing in the workspace.
FOR
Lists all the snapshots existing for a specific component or folder.
See Also
OMBCREATE SNAPSHOT, OMBALTER SNAPSHOT, OMBDROP SNAPSHOT, OMBRESTORE SNAPSHOT, OMBCOMPARE SNAPSHOT, OMBRETRIEVE SNAPSHOT
Purpose
To list the system privileges directly granted to a user or a role, which do not include the system privileges inherited from
the granted roles.
Prerequisites
System privileges granted to a user or a role can be listed from any
context.
Syntax
parseListSysPrivs = OMBLIST ( SYS_PRIVS | SYSTEM_PRIVILEGES ) ( OF ( USER
| ROLE ) "QUOTED_STRING" )
Keywords And Parameters
parseListSysPrivs
This clause only lists the system privileges directly granted to a user or
a role, which do not include the system privileges inherited from the
granted roles.
Purpose
To list existing roles or list existing roles whose names match the given regular expression or list the granted roles of a given
user.
Prerequisites
Warehouse Builder users can be list from any context.
Syntax
parseListUser = OMBLIST USERS ( [ "QUOTED_STRING" | ( OF ROLE
"QUOTED_STRING" ) ] )
Keywords And Parameters
parseListUser
This clause lists existing Warehouse Builder users or list existing users
matches the given regular expression or list granted users of a given role.
Purpose
Lock one or more objects. If a list of objects is specified, the objects will be locked one by one in the given order. The command will
behave atomically, i.e. if it fails to lock any of the objects in the list,
then it will lock none of them.
Prerequisites
No other user should have a lock on any of the objects.
Syntax
parseLockCommand = OMBLOCK "parseTypeNameList"
parseTypeNameList = "objectType" "QUOTED_STRING" { "," "objectType"
"QUOTED_STRING" }
objectType = ( ADVANCED_QUEUE | STREAMS_QUEUE | BUSINESS_AREA | COLLECTION
| CONNECTOR | CONFIGURATION | DEPLOYMENT | CUBE | DIMENSION | EXPERT
| EXPERT_MODULE | EXTERNAL_TABLE | FLAT_FILE_MODULE | FLAT_FILE |
FUNCTION | TABLE_FUNCTION | GATEWAY_MODULE |
BUSINESS_DEFINITION_MODULE | REGISTERED_FUNCTION | LOCATION | MAPPING
| MATERIALIZED_VIEW | OBJECT_TYPE | VARYING_ARRAY | NESTED_TABLE |
ORACLE_MODULE | PACKAGE | PROCEDURE | PROCESS_FLOW |
PROCESS_FLOW_MODULE | PROCESS_FLOW_PACKAGE | PROJECT | ITEM_FOLDER |
DRILL_PATH | LIST_OF_VALUES | DRILL_TO_DETAIL | ALTERNATIVE_SORT_ORDER
| CONTROL_CENTER | SAP_MODULE | CMI_MODULE | SEQUENCE | TABLE | VIEW
| CMI_DEFINITION | PLSQL_RECORD_TYPE | "UNQUOTED_STRING" )
Keywords And Parameters
parseLockCommand
Specify lock command.
parseTypeNameList
Specify the object or the list of objects to be locked.
QUOTED_STRING
Name of the object to be locked. Can be specified as an absolute path or as
a path relative to the current context. However, there is the restriction
that all objects to be locked must be in the current project.
objectType
Type of the object to be locked.
See Also
OMBUNLOCK
Purpose
Add more languages into an existing OWB repository to support the object translation.
Prerequisites
OWB repository schema OWBSYS should already exists in the database. The
value of USING CREDENTIAL must be OWBSYS' database user credential.
Syntax
parseUpdateMlsOWBRepositoryCommand = OMBMLSUPDATE [ SUPPORTED_LANGUAGES
"(" "QUOTED_STRING" { "," "QUOTED_STRING" } ")" ] USING CREDENTIAL
"UNQUOTED_STRING" [ NET_SERVICE_NAME "QUOTED_STRING" ]
Keywords And Parameters
parseUpdateMlsOWBRepositoryCommand
Specify an OMBMLSUPDATE command.
QUOTED_STRING
Specify the language name.
UNQUOTED_STRING
Specify the connection string to the database using this format:
owbsys/owbsys_password@host:port:service name.
Purpose
Move one or more objects of the same object type. The replace option allows you to overwrite.
Prerequisites
Use of relative path specifications requires awareness of the current
context.
Syntax
parseMoveCommand = OMBMOVE "moveObjectType" "QUOTED_STRING" TO
"QUOTED_STRING" [ USE REPLACE_MODE ]
moveObjectType = ( "UNQUOTED_STRING" )
Keywords And Parameters
parseMoveCommand
Specifies the source object type, source path, and target path for the
object to move. Moving objects is subject to the following restrictions: 1.
You can only move objects within the current project; you cannot move
objects between projects. 2. You cannot move an object within the same
parent folder; if your purpose is to rename the object, use the
'OMBALTER...RENAME TO...' command.
QUOTED_STRING
Source and target path specifications can be absolute or relative. To move
multiple objects, include a regular expression as the final step of the
source path. If you are moving multiple objects, the final step of the
target path must be the folder to which the objects are being copied. If
you are only moving one object, you can specify the object's original name
or a new name as the final step of the target path.
REPLACE_MODE
Use this option to overwrite existing target objects.
moveObjectType
The type of the object(s) to be copied. Valid types are: PROJECT,
ORACLE_MODULE, FLAT_FILE_MODULE, BUSINESS_DEFINITION_MODULE,
BUSINESS_PRESENTATION_MODULE, SAP_MODULE, CMI_MODULE, PROCESS_FLOW_MODULE,
PROCESS_FLOW_PACKAGE, PROCESS_FLOW, EXPERT_MODULE, EXPERT, FLAT_FILE,
ADVANCED_QUEUE, STREAMS_QUEUE, QUEUE_TABLE, QUEUE_PROPAGATION,
STREAMS_CAPTURE_PROCESS, OBJECT_TYPE, VARYING_ARRAY, NESTED_TABLE, TABLE,
VIEW, MATERIALIZED_VIEW, SEQUENCE, DIMENSION, CUBE, DATA_AUDITOR,
DATA_PROFILE, DATA_RULE, DATA_RULE_MODULE, MAPPING, REAL_TIME_MAPPING,
PACKAGE, FUNCTION, PROCEDURE, BUSINESS_AREA, COLLECTION, EXTERNAL_TABLE,
REGISTERED_FUNCTION, ITEM_FOLDER, DRILL_PATH, LIST_OF_VALUES,
DRILL_TO_DETAIL, ALTERNATIVE_SORT_ORDER, PRESENTATION_TEMPLATE and any user
defined object types.
See Also
OMBCOPY
Purpose
To execute the action plans associated with profiling. You can do profiling, correction schema generation and correction map generation
with this command.
Prerequisites
This command must be done in the context of a Data Profile. Furthermore,
the corresponding transient action plans need to have been created before
invoking this command.
Syntax
parseProfileCommand = OMBPROFILE ( ( ANALYZE_ACTION_PLAN "QUOTED_STRING" )
| ( ( CORRECTION_SCHEMA_ACTION_PLAN "QUOTED_STRING" IN ORACLE_MODULE
"QUOTED_STRING" ) [ ( DROP PREVIOUS CORRECTIONS ) ] ) | ( (
CORRECTION_MAPS_ACTION_PLAN "QUOTED_STRING" IN ORACLE_MODULE
"QUOTED_STRING" ) [ ( DROP PREVIOUS CORRECTIONS ) ] ) )
Keywords And Parameters
parseProfileCommand
Executes the analyze action plan.
Purpose
To redefine an association between two classes (types).
Prerequisites
Association definition to be redefined should already exist. This command
can be executed for any association definition regardless of current
context. User must have CREATE_EXTENSIONMODEL system privilege and has to
be connected in single user mode to run this command.
Syntax
parseRedefineAssociationCommand = OMBREDEFINE ASSOCIATION_DEFINITION
"QUOTED_STRING" ( RENAME TO "QUOTED_STRING" |
"setAssociationDefinitionPropertiesClause" | (
"modifyDependencyDefinitionClause" |
"deleteDependencyDefinitionClause" | "addDependencyDefinitionClause"
)+ )
setAssociationDefinitionPropertiesClause = SET PROPERTIES "("
"propertyNameList" ")" VALUES "(" "propertyValueList" ")"
modifyDependencyDefinitionClause = MODIFY DEPENDENCY_DEFINITION
"QUOTED_STRING" "setDependencyDefinitionPropertiesClause"
deleteDependencyDefinitionClause = DELETE DEPENDENCY_DEFINITION
"QUOTED_STRING"
addDependencyDefinitionClause = ADD DEPENDENCY_DEFINITION "QUOTED_STRING"
[ "setDependencyDefinitionPropertiesClause" ]
propertyNameList = "propertyNameClause" { "," "propertyNameClause" }
propertyValueList = "propertyValue" { "," "propertyValue" }
setDependencyDefinitionPropertiesClause = SET PROPERTIES "("
"propertyNameList" ")" VALUES "(" "propertyValueList" ")"
propertyNameClause = ( "UNQUOTED_STRING" )
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
parseRedefineAssociationCommand
Redefine an association between two classes..
setAssociationDefinitionPropertiesClause
Basic properties for re-defining ASSOCIATION_DEFINITION:
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: N/A
A descriptive text for this association.
Name: ROLE_1_MIN_CARDINALITY
Type: STRING(200)
Valid Values: N/A
Default: N/A
Minimum cardinality of role 1. Value can be positive integer.
Name: ROLE_1_MAX_CARDINALITY
Type: STRING(200)
Valid Values: N/A
Default: N/A
Maximum cardinality of role 1. Value can be positive integer or 'INFINITE'.
Name: ROLE_1_NAVIGABLE
Type: BOOLEAN
Valid Values: true, false
Default: From user defined class side default is true. From OWB class side
default is false.
Navigability of role 1.
Name: ROLE_2_MIN_CARDINALITY
Type: STRING(200)
Valid Values: N/A
Default: N/A
Minimum cardinality of role 2. Value can be positive integer.
Name: ROLE_2_MAX_CARDINALITY
Type: STRING(200)
Valid Values: N/A
Default: N/A
Maximum cardinality of role 2. Value can be positive integer or 'INFINITE'.
Name: ROLE_2_NAVIGABLE
Type: BOOLEAN
Valid Values: true, false
Default: From user defined class side default is true. From OWB class side
default is false.
Navigability of role 2.
modifyDependencyDefinitionClause
Modifies the properties of the specified dependency for this association.
deleteDependencyDefinitionClause
Un-mark this association so that the dependency engine will ignore it when
computing the lineage and impact dependencies of that type.
addDependencyDefinitionClause
Mark this association so that the dependency engine will consider it when
computing the lineage and impact dependencies of the specified type. The
only dependency type allowed here for now is 'DATAFLOW'.
propertyNameList
The list of property names.
propertyValueList
The list of property values being set.
setDependencyDefinitionPropertiesClause
Basic dependency-related properties for this association:
Name: SOURCE_ROLE_ID
Type: STRING(200)
Valid Values: ROLE_1, ROLE_2
Default: If one of the ends is a OWB class, then that is the default
source. If both ends are user defined classes, then the association is
default bidirectional.
Identifies the role (end) of the association which serves as the source for
the dependency flow.
Name: BIDIRECTIONAL
Type: BOOLEAN
Valid Values: true, false
Default: If one of the ends is a OWB class, then default is false. If both
ends are user defined classes, then default is true.
Specifies whether the association is bi-directional for the dependency
flow.
propertyNameClause
Name of a property.
propertyValue
Value of a property.
See Also
OMBDEFINE ASSOCIATION_DEFINITION, OMBDESCRIBE ASSOCIATION_DEFINITION
Purpose
To redefine a class.
Prerequisites
Class definition to be redefined should already exist. This command can be
executed for any class definition regardless of current context. User must
have CREATE_EXTENSIONMODEL system privilege, and user has to connect in
single user mode.
The valid types to define user defined properties are: INTEGER, STRING,
FLOAT, DOUBLE, DATE, TIMESTAMP, BOOLEAN, LONG, FILE, URL
Syntax
parseRedefineClassCommand = OMBREDEFINE CLASS_DEFINITION "QUOTED_STRING" (
( "setClassDefinitionPropertiesClause" |
"setClassDefinitionIconSetClause" |
"unsetClassDefinitionIconSetClause" ) [ "modifySubDefinitionsClause" ]
| "modifySubDefinitionsClause" )
setClassDefinitionPropertiesClause = SET PROPERTIES "(" "propertyNameList"
")" VALUES "(" "propertyValueList" ")"
setClassDefinitionIconSetClause = SET REF ICONSET "QUOTED_STRING"
unsetClassDefinitionIconSetClause = UNSET REF ICONSET
modifySubDefinitionsClause = ( "addPropertyDefinitionClause" |
"modifyPropertyDefinitionClause" | "deletePropertyDefinitionClause" |
"addPropertyGroupDefinitionClause" |
"modifyPropertyGroupDefinitionClause" |
"deletePropertyGroupDefinitionClause" | "addChildTypeClause" |
"deleteChildTypeClause" )+
propertyNameList = "propertyNameClause" { "," "propertyNameClause" }
propertyValueList = "propertyValue" { "," "propertyValue" }
addPropertyDefinitionClause = ( ADD [ ( ( CONFIGURATION |
PHYSICAL_CONFIGURATION ) | LOGICAL | USER_DEFINED ) ]
PROPERTY_DEFINITION "QUOTED_STRING"
"setPropertyDefinitionPropertiesClause" )
modifyPropertyDefinitionClause = ( MODIFY PROPERTY_DEFINITION
"QUOTED_STRING" ( RENAME TO "QUOTED_STRING" |
"setPropertyDefinitionPropertiesClause" ) )
deletePropertyDefinitionClause = ( DELETE PROPERTY_DEFINITION
"QUOTED_STRING" )
addPropertyGroupDefinitionClause = ADD PROPERTY_GROUP_DEFINITION
"QUOTED_STRING" "setPropertyGroupDefinitionPropertiesClause"
modifyPropertyGroupDefinitionClause = ( MODIFY PROPERTY_GROUP_DEFINITION
"QUOTED_STRING" ( RENAME TO "QUOTED_STRING" |
"setPropertyGroupDefinitionPropertiesClause" ) )
deletePropertyGroupDefinitionClause = ( DELETE PROPERTY_GROUP_DEFINITION
"QUOTED_STRING" )
addChildTypeClause = ( ADD CHILD_TYPE "QUOTED_STRING" )
deleteChildTypeClause = ( DELETE CHILD_TYPE "QUOTED_STRING" )
propertyNameClause = ( "UNQUOTED_STRING" )
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
setPropertyDefinitionPropertiesClause = SET PROPERTIES "("
"propertyNameList" ")" VALUES "(" "propertyValueList" ")"
setPropertyGroupDefinitionPropertiesClause = SET PROPERTIES "("
"propertyNameList" ")" VALUES "(" "propertyValueList" ")"
Keywords And Parameters
parseRedefineClassCommand
Redefine a class definition.
CLASS_DEFINITION
Redefine a class definition.
QUOTED_STRING
Name of the class definition.
propertyNameList
The list of properties for the class definition.
propertyValueList
The list of values provided for the class definition.
propertyNameClause
The name of the property.
UNQUOTED_STRING
The name of the property for the class definition.
propertyValue
The value of the property.
QUOTED_STRING
The value in string format of the property for the class definition.
INTEGER_LITERAL
The integer value of the property for the class definition.
FLOATING_POINT_LITERAL
The float value of the property for the class definition.
See Also
OMBDESCRIBE CLASS_DEFINITION
Purpose
Register a location with a Control Center.
Prerequisites
Must be in the context of a project and connected to a Control Center.
Syntax
registerLocationCommand = OMBREGISTER LOCATION "QUOTED_STRING" [ REUSE ]
Keywords And Parameters
registerLocationCommand
Register a location.
QUOTED_STRING
The name of the location to register.
Purpose
To register a database user as a Warehouse Builder user.
Prerequisites
Commit or Rollback is needed if there is any change.
Syntax
parseRegisterUserCommand = ( OMBREGISTER USER "QUOTED_STRING" [ SET
PROPERTIES "(" "propertyNameList" ")" VALUES "(" "propertyValueList"
")" ] [ WITH CREATE DBUSER OPTION IDENTIFIED BY "QUOTED_STRING" [
DEFAULT_TABLESPACE2 "QUOTED_STRING" ] [ TEMPORARY_TABLESPACE
"QUOTED_STRING" ] THROUGH SYSDBA CONNECTION "UNQUOTED_STRING" ] )
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
parseRegisterUserCommand
This command registers a Warehouse Builder user.
propertyNameList
A list of valid properties are shown below.
Basic properties for USER:
Name: PROMPT_FOR_COMMIT
Type: BOOLEAN
Valid Values: true, false
Default: false
Name: PROMPT_FOR_JOB_NAME
Type: BOOLEAN
Valid Values: true, false
Default: false
Name: PROMPT_FOR_EXECUTION_PARAMS
Type: BOOLEAN
Valid Values: true, false
Default: false
Name: SHOW_MONITOR
Type: BOOLEAN
Valid Values: true, false
Default: false
Name: SHOW_DEPLOYMENT_COMPLETION
Type: BOOLEAN
Valid Values: true, false
Default: false
Name: SHOW_DEPLOYMENT_DEPENDENCIES
Type: BOOLEAN
Valid Values: true, false
Default: false
Name: SHOW_MONITOR_RESULTS
Type: BOOLEAN
Valid Values: true, false
Default: true
Name: SHOW_MONITOR_LOGFILE
Type: BOOLEAN
Valid Values: true, false
Default: true
Name: PERSONALITY
Type: STRING
Valid Values: N/A
Default: Default
Name: SHOW_GUIDED_ASSISTANCE
Type: BOOLEAN
Valid Values: true, false
Default: false
Name: HIDE_WIZARD_WELCOME_PAGES
Type: BOOLEAN
Valid Values: true, false
Default: false
Name: SHOW_DELETE_CONFIRMATION
Type: BOOLEAN
Valid Values: true, false
Default: true
Name: RECYCLE_DELETED_OBJECTS
Type: BOOLEAN
Valid Values: true, false
Default: true
Name: EMPTY_RECYCLE_BIN
Type: BOOLEAN
Valid Values: true, false
Default: false
Name: CLEAR_CLIPBOARD
Type: BOOLEAN
Valid Values: true, false
Default: true
Name: SHOW_GENERATION_PROJECT
Type: BOOLEAN
Valid Values: true, false
Default: true
Name: SHOW_GENERATION_MODULE
Type: BOOLEAN
Valid Values: true, false
Default: true
Name: SHOW_GENERATION_LOCATION
Type: BOOLEAN
Valid Values: true, false
Default: false
Name: SHOW_GENERATION_ACTION
Type: BOOLEAN
Valid Values: true, false
Default: false
Name: SHOW_GENERATION_TYPE
Type: BOOLEAN
Valid Values: true, false
Default: true
Name: LOG_FILE_PATH
Type: STRING(1000)
Valid Values: N/A
Default: ''
Name: LOG_FILE_NAME
Type: STRING(1000)
Valid Values: N/A
Default: log
Name: LOG_FILE_MAX_SIZE
Type: STRING
Valid Values: 1-10000000
Default: 100
Name: LOG_ERROR_MESSAGES
Type: BOOLEAN
Valid Values: true, false
Default: true
Name: LOG_WARNING_MESSAGES
Type: BOOLEAN
Valid Values: true, false
Default: true
Name: LOG_INFORMATION_MESSAGES
Type: BOOLEAN
Valid Values: true, false
Default: false
Name: NAMING_MODE
Type: STRING
Valid Values: PHYSICAL_NAMING_MODE, BUSINESS_NAMING_MODE
Default: PHYSICAL_NAMING_MODE
Name: PROPAGATE_NAME_CHANGES
Type: BOOLEAN
Valid Values: true, false
Default: false
Name: DESIGNREPOS_PWD_PERSIST
Type: BOOLEAN
Valid Values: true, false
Default: true
Name: RUNTIMEREPOS_PWD_SHARE
Type: BOOLEAN
Valid Values: true, false
Default: true
Name: DEFAULT_SEC_POLICY
Type: STRING
Valid Values: MINIMUM_SECURITY, MAXIMUM_SECURITY
Default: MINIMUM_SECURITY
See Also
OMBUNREGISTER USER, OMBALTER USER, OMBRETRIEVE USER
Purpose
A snapshot is a history point of individual or group of components. The user can recover the components' previously captured
states by using the snapshot restore functionality.
Prerequisites
A component can be restored from a snapshot into the current workspace.
Syntax
parseRestoreCommand = OMBRESTORE "restoreSnapshotCommand"
restoreSnapshotCommand = ( SNAPSHOT "QUOTED_STRING" [ CASCADE UP ] [
IGNORE CLASS_DEFINITION ( DIFFERENCES | DIFF ) ] [ FOR (
"UNQUOTED_STRING" "QUOTED_STRING" ) ] )
Keywords And Parameters
parseRestoreCommand
Root production for OMBRESTORE SNAPSHOT.
restoreSnapshotCommand
To restore snapshot components into the workspace.
QUOTED_STRING
Name of the snapshot from which components are to be restored.
CASCADE
CASCADE UP - Optional clause for letting the user restore a component even
if its parent does not exist in the current workspace.
CLASS_DEFINITION
IGNORE CLASS_DEFINITION DIFF - Optional clause for letting the user restore
a snapshot whether or not the meta-model of the snapshot is different from
that of the current workspace.
FOR
Optional component clause for partial restore. This can be used to specify
which components of a snapshot are to be restored.
See Also
OMBCREATE SNAPSHOT, OMBALTER SNAPSHOT, OMBDROP SNAPSHOT, OMBCOMPARE SNAPSHOT, OMBLIST SNAPSHOT, OMBRETRIEVE SNAPSHOT
Purpose
Perform revert action on the repository (all objects are reverted to the last saved state).
Prerequisites
Must be connected to a OWB workspace of the repository.
Syntax
parseRevertCommand = OMBREVERT
Keywords And Parameters
parseRevertCommand
Specify revert command.
See Also
OMBSAVE
Purpose
To change the default object privilege setting property of a user, basically it will revoke a list of default object
privileges from a list of users or roles. These object privileges will not
be granted to the specified user or role on the new objects whenever the
owner creates them.
Prerequisites
Must be connected to a workspace on OWB repository.
Syntax
parseRevokeDefObjPrivCommand = OMBREVOKE DEFAULT ( OBJ_PRIV |
OBJECT_PRIVILEGE ) "objPrivNameList" FROM ( USER "userOrRoleNameList"
| ROLE "userOrRoleNameList" ) [ FOR USER "QUOTED_STRING" ]
objPrivNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
userOrRoleNameList = "QUOTED_STRING" { "," "QUOTED_STRING" }
Keywords And Parameters
parseRevokeDefObjPrivCommand
This clause changes the default object privilege setting property of a user
through revoking a list of default object privileges from a list of users
or roles.
objPrivNameList
Object privileges. Valid object privileges are: READ, COMPILE, EDIT,
FULL_CONTROL.
See Also
OMBGRANT DEFAULT OBJ_PRIV, OMBLIST DEFAULT OBJ_PRIVS
Purpose
To revoke a list of object privileges on the specified objects from a list of users or roles.
Prerequisites
Must be connected to a workspace on OWB repository.
Syntax
parseRevokeObjPrivCommand = OMBREVOKE ( OBJ_PRIV | OBJECT_PRIVILEGE )
"objPrivNameList" ON "UNQUOTED_STRING" "QUOTED_STRING" [ CASCADE ]
FROM ( USER "userOrRoleNameList" | ROLE "userOrRoleNameList" )
objPrivNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
userOrRoleNameList = "QUOTED_STRING" { "," "QUOTED_STRING" }
Keywords And Parameters
parseRevokeObjPrivCommand
This clause revokes a list of object privileges on the specified objects
from a list of users or roles.
UNQUOTED_STRING
The type of the objects to be listed.Valid object types are: PROJECT,
ORACLE_MODULE, FLAT_FILE_MODULE, PROCESS_FLOW_MODULE, SAP_MODULE,
BUSINESS_DEFINITION_MODULE, BUSINESS_PRESENTATION_MODULE,
TRANSFORMATION_MODULE, PACKAGE, ADVANCED_QUEUE, BUSINESS_AREA, COLLECTION,
CONNECTOR, CUBE, DIMENSION, EXTERNAL_TABLE, FLAT_FILE, FUNCTION,
REGISTERED_FUNCTION, MAPPING, MATERIALIZED_VIEW, OBJECT_TYPE, PROCEDURE,
ITEM_FOLDER, DRILL_PATH, DRILLS_TO_DETAIL, ALTERNATIVE_SORT_ORDER,
LISTS_OF_VALUE, PRESENTATION_TEMPLATE, SEQUENCE, TABLE, PROCESS_FLOW,
PROCESS_FLOW_PACKAGE, LOCATION, CONTROL_CENTER, CONFIGURATION, DEPLOYMENT,
VIEW.
objPrivNameList
Object privileges. Valid object privileges are: READ, COMPILE, EDIT,
FULL_CONTROL.
See Also
OMBGRANT OBJ_PRIV, OMBLIST OBJ_PRIVS
Purpose
To revoke a list of Warehouse Builder roles from a list of Warehouse Builder users.
Prerequisites
Must be connected to a workspace on OWB repository.
Syntax
parseRevokeRoleCommand = OMBREVOKE ROLE "userOrRoleNameList" FROM USER
"userOrRoleNameList"
userOrRoleNameList = "QUOTED_STRING" { "," "QUOTED_STRING" }
Keywords And Parameters
parseRevokeRoleCommand
This clause revokes a list of Warehouse Builder roles from a list of
Warehouse Builder users.
See Also
OMBGRANT ROLE, OMBLIST ROLES
Purpose
To revoke a list of system privileges from a list of users or roles.
Prerequisites
Must be connected to a workspace on OWB repository.
Syntax
parseRevokeSysPrivCommand = OMBREVOKE ( SYS_PRIV | SYSTEM_PRIVILEGE )
"sysPrivNameList" FROM ( USER "userOrRoleNameList" | ROLE
"userOrRoleNameList" )
sysPrivNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
userOrRoleNameList = "QUOTED_STRING" { "," "QUOTED_STRING" }
Keywords And Parameters
parseRevokeSysPrivCommand
This clause revokes a list of system privileges from a list of users or
roles.
sysPrivNameList
List of system privileges. Valid system privileges
are:ACCESS_PUBLICVIEW_BROWSER, CONTROL_CENTER_DEPLOYMENT,
CONTROL_CENTER_EXECUTION,CONTROL_CENTER_VIEW,CREATE_EXTENSIONMODEL,CREATE_PROJECT,
CREATE_SNAPSHOT
See Also
OMBGRANT SYS_PRIV, OMBLIST SYS_PRIVS
Purpose
Perform rollback action on the repository.
Prerequisites
Must be connected to a OWB workspace of the repository.
Syntax
parseRollbackCommand = OMBROLLBACK
Keywords And Parameters
parseRollbackCommand
Specify rollback command.
See Also
OMBCOMMIT
Purpose
Perform save action on the repository (all objects are saved).
Prerequisites
Must be connected to a OWB workspace of the repository.
Syntax
parseSaveCommand = OMBSAVE
Keywords And Parameters
parseSaveCommand
Specify save command.
See Also
OMBREVERT
Purpose
Seed OWB repository schema OWBSYS.
Prerequisites
To seed OWB repository schema OWBSYS, within the same OMBPlus session, no
other OMB commands should be issued before or after the OMBSEED command.
Also, before issuing this command, OWBSYS user schema needs to be created
either through 11g database installation or by executing script
'cat_owb.sql' manually. The value of OWB_SERVER_HOME_CHECK_FLAG can be set
to either TRUE or FALSE. If OWB_SERVER_HOME_CHECK_FLAG is set to TRUE,
OWB_SERVER_ORACLE_HOME must be provided as a valid path which OWB software
is installed. The value of USING CREDENTIAL must be OWBSYS' database user
credential.
Syntax
parseSeedWBRepositoryCommand = OMBSEED [ DATA_TABLESPACE "QUOTED_STRING" ]
[ INDEX_TABLESPACE "QUOTED_STRING" ] [ TEMPORARY_TABLESPACE
"QUOTED_STRING" ] [ SNAPSHOT_TABLESPACE "QUOTED_STRING" ] [
BASE_LANGUAGE "QUOTED_STRING" ] [ SUPPORTED_LANGUAGES "("
"QUOTED_STRING" { "," "QUOTED_STRING" } ")" ] [ OWB_SERVER_ORACLE_HOME
"QUOTED_STRING" ] [ OWB_SERVER_HOME_CHECK_FLAG "UNQUOTED_STRING" ]
USING CREDENTIAL "UNQUOTED_STRING" [ NET_SERVICE_NAME "QUOTED_STRING"
]
Keywords And Parameters
parseSeedWBRepositoryCommand
Specify an OMBSEED command.
QUOTED_STRING
Specify the tablespace name, language name, OWB Oracle Home, or NET SERVICE
NAME. For example: DATA_TABLESPACE 'USERS'
UNQUOTED_STRING
Specify the connection string to the database using this format:
OWBSYS/OWBSYS_PASSWORD@HOST:PORT:SERVICE_NAME
Purpose
To show the session or system parameter information.
Prerequisites
Need to connect to a workspace on the repository.
Syntax
parseShowCommand = ( OMBSHOW "UNQUOTED_STRING" )
Keywords And Parameters
parseShowCommand
Show the session or system parameters.The Valid session or system parameter
names are: USER, REPOSITORY, CONNECTION, REPOSITORY_VERSION,
CLIENT_VERSION, WORKSPACE.
UNQUOTED_STRING
Specify the session or system parameter name.
The Valid session or system parameter names are: USER, REPOSITORY,
CONNECTION, REPOSITORY_VERSION, CLIENT_VERSION.
Purpose
To execute objects from the Control Center. If the ASYNCHRONOUS keyword is specified then this command will return the Execution Job
Identifier. Note, this can then be passed to the OMBSTOP command.
The 'Best Practice' usage of this command is within the context of a Design
Repository connection. However, advanced users may use this command with a
'Control Center Only' usage. Note, the MAPPING keyword can not be used in
this mode and you must specify the deployed Mapping type.
If it is required to fully specify the Deployed Mapping type then the
possible values are ABAPFILE, DATAAUDITOR, DATAPROFILE, PLSQLMAP,
PROCESSFLOW, SQLLOADERCONTROLFILE and SCHEDULEDJOB.
The Deployment Location of the object is optional if the name of the
executable object is unique in the Control Center. However, please specify
the 'CONTROL_CENTER' location for types that are deployed to the Control
Center (SQL Loader and SAP Mappings).
The System Parameters that can be overriden are
PLSQL Mapping - BULK_SIZE COMMIT_FREQUENCY DEFAULT_AUDIT_LEVEL
DEFAULT_OPERATING_MODE DEFAULT_PURGE_GROUP MAXIMUM_NUMBER_OF_ERRORS
SQL Loader Mapping - AUDIT BIND_SIZE CONTROL_FILE_LOCATION
CONTROL_FILE_NAME DEFAULT_PURGE_GROUP DIRECT_MODE DISCARD_MAX
ERRORS_ALLOWED LOG_FILE_LOCATION LOG_FILE_NAME PERFORM_PARALLEL_LOAD
READ_SIZE RECORDS_TO_LOAD RECORDS_TO_SKIP ROWS_PER_COMMIT
SKIP_INDEX_MAINTENANCE SKIP_UNUSABLE_INDEXES
SAP Mapping - BACKGROUND CONTROL_FILE_NAME DATA_FILE_NAME
FILE_DELIMITER_FOR_STAGING_FILE LOG_FILE_NAME NESTED_LOOP
PRIMARY_FOREIGN_KEY_FOR_JOIN SAP_LOCATION SQL_JOIN_COLLAPSING
STAGING_FILE_DIRECTORY USE_SELECT_SINGLE
Data Auditor - BULK_SIZE COMMIT_FREQUENCY DEFAULT_AUDIT_LEVEL
DEFAULT_OPERATING_MODE DEFAULT_PURGE_GROUP MAXIMUM_NUMBER_OF_ERRORS
Data Profile - There are no System Parameters defined.
Prerequisites
'Best Practice' usage requires a Design Repository connection and the
context to be set to that of executable object. The 'Control Center Only'
usage does not require a Design Repository connection and therefore no
context.
Syntax
parseExecuteCommand = ( OMBSTART | OMBEXECUTE ) ( ( MAPPING | DATA_AUDITOR
| PROCESS_FLOW | SCHEDULABLE | REAL_TIME_MAPPING | "UNQUOTED_STRING"
) "QUOTED_STRING" [ AS "QUOTED_STRING" ] [ IN "QUOTED_STRING" ] ) [
OVERRIDE SYSTEM_PARAMETER "overideParameters" ] [ OVERRIDE
CUSTOM_PARAMETER "overideParameters" ] [ ASYNCHRONOUS ]
overideParameters = "(" "stringList" ")" VALUES "(" "stringList" ")"
stringList = "stringListValue" { "," "stringListValue" }
stringListValue = ( "QUOTED_STRING" )
Keywords And Parameters
parseExecuteCommand
Specify Execute command.
QUOTED_STRING
The name of the object to be executed or the execution's Audit Name.
AS
The execution's Audit Name.
IN
The deployed object's location.
OVERRIDE
Override an Execution Parameter.
SYSTEM_PARAMETER
Specify to override a System Parameter.
CUSTOM_PARAMETER
Specify to override a Custom Parameter.
ASYNCHRONOUS
Execute in an asynchronous mode.
Purpose
This command will display statistical information about the scripting run, such as memory usage, and elapsed time.
Prerequisites
None.
Syntax
parseStatisticsCommand = OMBSTATS
Purpose
To stop jobs running in the Control Center.
Prerequisites
A Control Center connection. Note, a Design Repository connection is not
required.
Syntax
parseStopCommand = OMBSTOP ( "INTEGER_LITERAL" )
Keywords And Parameters
parseStopCommand
Specify Stop command.
INTEGER_LITERAL
The job id.
Purpose
To switch the current workspace connection between SINGLE_USER_MODE (i.e. exclusive) and MULTIPLE_USER_MODE.
Prerequisites
Must be connected to an OWB workspace and not have any outstanding/unsaved
work. If not already connected, use OMBCONNECT first. If there exists work
that is not saved, use either OMBSAVE or OMBREVERT first.
Syntax
parseSwitchModeCommand = OMBSWITCHMODE ( SINGLE_USER_MODE |
MULTIPLE_USER_MODE )
Keywords And Parameters
parseSwitchModeCommand
Specify switch command.
SINGLE_USER_MODE
If specified, the user's current connection will be changed to permit them
to use the workspace exclusively.
MULTIPLE_USER_MODE
If specified, the user's current connection will be changed to permit more
than one session to work on the workspace at the same time.
See Also
OMBDISPLAYCURRENTMODE, OMBCONNECT, OMBSAVE, OMBREVERT
Purpose
Synchronize the target metadata definition with the source metadata definition.
Prerequisites
1. The current context of scripting must be a project atleast.
2. The target and/or source objects should exist in the current project.
3. No concurrent user is operating on the target.
Valid synchronize source types for MAPPING:
MAPPING_ACTIVITY
Valid synchronize source types for CONSTRUCT_OBJECT_OPERATOR:
OBJECT_TYPE PLSQL_RECORD_TYPE PLSQL_REF_CURSOR_TYPE
Valid synchronize source types for CUBE_OPERATOR:
CUBE
Valid synchronize source types for DATA_AUDITOR_ACTIVITY:
DATA_AUDITOR
Valid synchronize source types for DIMENSION_OPERATOR:
DIMENSION
Valid synchronize source types for EXPAND_OBJECT_OPERATOR:
OBJECT_TYPE PLSQL_RECORD_TYPE
Valid synchronize source types for EXTERNAL_TABLE:
EXTERNAL_TABLE_OPERATOR RECORD
Valid synchronize source types for EXTERNAL_TABLE_OPERATOR:
EXTERNAL_TABLE FLAT_FILE
Valid synchronize source types for FLAT_FILE:
FLAT_FILE_OPERATOR
Valid synchronize source types for FLAT_FILE_OPERATOR:
FLAT_FILE MATERIALIZED_VIEW TABLE VIEW
Valid synchronize source types for FUNCTION:
TRANSFORMATION_ACTIVITY
Valid synchronize source types for ITERATOR_OPERATOR:
NESTED_TABLE VARYING_ARRAY
Valid synchronize source types for KEY_LOOKUP_OPERATOR:
DIMENSION LEVEL MATERIALIZED_VIEW TABLE VIEW
Valid synchronize source types for LCRCAST_OPERATOR:
TABLE
Valid synchronize source types for MAPPING_ACTIVITY:
MAPPING
Valid synchronize source types for MATERIALIZED_VIEW:
MATERIALIZED_VIEW_OPERATOR
Valid synchronize source types for MATERIALIZED_VIEW_OPERATOR:
FLAT_FILE MATERIALIZED_VIEW TABLE VIEW
Valid synchronize source types for PLUGGABLE_MAPPING:
PLUGGABLE_MAPPING_OPERATOR
Valid synchronize source types for PLUGGABLE_MAPPING_OPERATOR:
PLUGGABLE_MAPPING
Valid synchronize source types for POSTMAPPING_PROCESS_OPERATOR:
FUNCTION PROCEDURE
Valid synchronize source types for PREMAPPING_PROCESS_OPERATOR:
FUNCTION PROCEDURE
Valid synchronize source types for PROCEDURE:
TRANSFORMATION_ACTIVITY
Valid synchronize source types for PROCESS_FLOW:
SUBPROCESS_ACTIVITY
Valid synchronize source types for REGISTERED_FUNCTION:
TRANSFORMATION_ACTIVITY
Valid synchronize source types for SEQUENCE_OPERATOR:
SEQUENCE
Valid synchronize source types for SUBPROCESS_ACTIVITY:
PROCESS_FLOW
Valid synchronize source types for TABLE:
CUBE DIMENSION LEVEL TABLE_OPERATOR
Valid synchronize source types for TABLE_FUNCTION:
TRANSFORMATION_ACTIVITY
Valid synchronize source types for TABLE_OPERATOR:
FLAT_FILE MATERIALIZED_VIEW PROFILE_REFERENCE TABLE VIEW
Valid synchronize source types for TRANSFORMATION_ACTIVITY:
FUNCTION
Valid synchronize source types for TRANSFORMATION_OPERATOR:
FUNCTION PROCEDURE
Valid synchronize source types for VIEW:
VIEW_OPERATOR
Valid synchronize source types for VIEW_OPERATOR:
FLAT_FILE MATERIALIZED_VIEW TABLE VIEW
Syntax
ReconcileCommand = ( OMBRECONCILE | OMBSYNCHRONIZE ) ( "parseIOObject" |
"parseSourceFCOSCO" TO "parseTargetFCOSCO" USE "(" "setStrategyClause"
"," "setStrategyClause" ")" )
parseIOObject = ITEM_FOLDER "QUOTED_STRING"
parseSourceFCOSCO = ( ( DATA_AUDITOR "QUOTED_STRING" [ OPERATOR
"QUOTED_STRING" ] ) ) | ( ( MAPPING "QUOTED_STRING" [ OPERATOR
"QUOTED_STRING" ] ) ) | ( ( PLUGGABLE_MAPPING "QUOTED_STRING" [
OPERATOR "QUOTED_STRING" ] ) ) | ( ( REAL_TIME_MAPPING "QUOTED_STRING"
[ OPERATOR "QUOTED_STRING" ] ) ) | ( ( FLAT_FILE "QUOTED_STRING" [
RECORD "QUOTED_STRING" ] ) ) | ( PROCESS_FLOW "QUOTED_STRING" [
ACTIVITY "QUOTED_STRING" ] ) | ( TABLE | EXTERNAL_TABLE | VIEW |
MATERIALIZED_VIEW | SEQUENCE | CUBE | DIMENSION | ADVANCED_QUEUE |
OBJECT_TYPE | VARYING_ARRAY | NESTED_TABLE | ACTIVITY_TEMPLATE |
PACKAGE | FUNCTION | TABLE_FUNCTION | PROCEDURE ) "QUOTED_STRING"
parseTargetFCOSCO = ( ( DATA_AUDITOR "QUOTED_STRING" [ OPERATOR
"QUOTED_STRING" ] ) ) | ( ( MAPPING "QUOTED_STRING" [ OPERATOR
"QUOTED_STRING" ] ) ) | ( ( PLUGGABLE_MAPPING "QUOTED_STRING" [
OPERATOR "QUOTED_STRING" ] ) ) | ( ( REAL_TIME_MAPPING "QUOTED_STRING"
[ OPERATOR "QUOTED_STRING" ] ) ) | ( ( FLAT_FILE "QUOTED_STRING" [
RECORD "QUOTED_STRING" ] ) ) | ( ( PROCESS_FLOW "QUOTED_STRING" [
ACTIVITY "QUOTED_STRING" ] ) ) | ( TABLE | EXTERNAL_TABLE | VIEW |
MATERIALIZED_VIEW | SEQUENCE | ADVANCED_QUEUE | VARYING_ARRAY |
NESTED_TABLE | OBJECT_TYPE | ACTIVITY_TEMPLATE | FUNCTION )
"QUOTED_STRING"
setStrategyClause = ( RECONCILE_STRATEGY | SYNCHRONIZE_STRATEGY )
"retrieveReconcileStrategyClause" | MATCHING_STRATEGY
"retrieveMatchingStrategyClause"
retrieveReconcileStrategyClause = "QUOTED_STRING"
retrieveMatchingStrategyClause = "QUOTED_STRING"
Purpose
Extracts business names and descriptions from a metadata loader file to an XLIFF translation file.
Prerequisites
None.
Syntax
mdlExtractCommand = ( EXTRACT [ FROM ] MDL_FILE "QUOTED_STRING" [ TO ]
"extractTranslateFileClause" [ "setExtractOptions" ] [
"componentsClause" ] [ "extractControlFileClause" ] [
"extractOutputLogClause" ] )
extractTranslateFileClause = TRANSLATE_FILE "QUOTED_STRING"
setExtractOptions = SET OPTIONS "(" "extractOptionNameList" ")" VALUES "("
"extractOptionValueList" ")"
componentsClause = COMPONENTS "(" "componentsList" ")"
extractControlFileClause = CONTROL_FILE "QUOTED_STRING"
extractOutputLogClause = OUTPUT LOG [ TO ] "QUOTED_STRING"
extractOptionNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
extractOptionValueList = "extractOptionValue" { "," "extractOptionValue" }
componentsList = "objectTypeValue" "QUOTED_STRING" { "," "objectTypeValue"
"QUOTED_STRING" }
extractOptionValue = ( "QUOTED_STRING" )
objectTypeValue = ( PROJECT | ORACLE_MODULE | TABLE | VIEW | SEQUENCE |
MATERIALIZED_VIEW | FUNCTION | PROCEDURE | PACKAGE | DIMENSION | CUBE
| ADVANCED_QUEUE | STREAMS_QUEUE | MAPPING | REAL_TIME_MAPPING |
PROCESS_FLOW_MODULE | PROCESS_FLOW_PACKAGE | PROCESS_FLOW | SAP_MODULE
| CMI_MODULE | GATEWAY_MODULE | EXTERNAL_TABLE | FLAT_FILE_MODULE |
FLAT_FILE | BUSINESS_DEFINITION_MODULE | ITEM_FOLDER | LIST_OF_VALUES
| DRILL_TO_DETAIL | ALTERNATIVE_SORT_ORDER | DRILL_PATH |
BUSINESS_AREA | LOCATION | CONNECTOR | CONTROL_CENTER | CONFIGURATION
| COLLECTION | SNAPSHOT | ROLE | USER | ICONSET |
TRANSFORMATION_MODULE | CALENDAR_MODULE | CALENDAR_FOLDER | CALENDAR |
EXPERT_MODULE | EXPERT | DATA_RULE_MODULE | DATA_RULE | DATA_AUDITOR
| STREAMS_CAPTURE_PROCESS | QUEUE_TABLE | QUEUE_PROPAGATION |
OBJECT_TYPE | NESTED_TABLE | VARYING_ARRAY | DEPLOYMENT | DATA_PROFILE
| PROFILE_REFERENCE | PLSQL_TABLE_TYPE | PLSQL_RECORD_TYPE |
PLSQL_REF_CURSOR_TYPE | PLUGGABLE_MAPPING | PLUGGABLE_MAPPING_FOLDER |
CMI_DEFINITION | ACTIVITY_TEMPLATE | ACTIVITY_TEMPLATE_FOLDER |
TRANSPORTABLE_MODULE )
Keywords And Parameters
mdlExtractCommand
Extract business names and descriptions from a metadata loader file to an
XLIFF translation file.
QUOTED_STRING
Enclose the name of the source metadata loader file in single quotes.
extractTranslateFileClause
Specify the name of the translation file created by extract.
QUOTED_STRING
Enclose the name of the translation file to be created in single quotes.
setExtractOptions
Set options to be used for extract.
componentsClause
List components to be merged.
extractControlFileClause
Specify a control file with options not directly supported by OMBTRANSLATE
EXTRACT command.
QUOTED_STRING
Enclose the control file name in single quotes.
extractOutputLogClause
Extract log file for messages and statistics.
QUOTED_STRING
Enclose the log file name in single quotes.
extractOptionNameList
Comma separated list of extract option names (e.g. TARGETEQUALSSOURCE,
EXTRACTNULLS).
UNQUOTED_STRING
Valid option names are TARGETEQUALSSOURCE, EXTRACTNULLS, MAPPINGDETAILS,
DTD.
extractOptionValueList
Comma separated list of extract option values (e.g. 'Y', 'Y').
componentsList
Comma separated list of components to be merged.
QUOTED_STRING
Name of an object (e.g. 'TABLE_Y').
extractOptionValue
Value for an option in list (e.g. 'Y').
QUOTED_STRING
Enclose the option value in single quotes.
objectTypeValue
Object type to be merged (e.g. TABLE, VIEW etc.).
See Also
OMBTRANSLATE MERGE
Purpose
Merges translated business names and descriptions from an XLIFF translation file into a metadata loader file.
Prerequisites
None.
Syntax
mdlMergeCommand = ( MERGE [ FROM ] MDL_FILE "QUOTED_STRING"
"mergeTranslateFileClause" [ TO ] "mergedMDLFileClause" [
"setMergeOptions" ] [ "componentsClause" ] [ "mergeControlFileClause"
] [ "mergeOutputLogClause" ] )
mergeTranslateFileClause = TRANSLATE_FILE "QUOTED_STRING"
mergedMDLFileClause = MERGED_MDL_FILE "QUOTED_STRING"
setMergeOptions = SET OPTIONS "(" "extractOptionNameList" ")" VALUES "("
"extractOptionValueList" ")"
componentsClause = COMPONENTS "(" "componentsList" ")"
mergeControlFileClause = CONTROL_FILE "QUOTED_STRING"
mergeOutputLogClause = OUTPUT LOG [ TO ] "QUOTED_STRING"
extractOptionNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
extractOptionValueList = "extractOptionValue" { "," "extractOptionValue" }
componentsList = "objectTypeValue" "QUOTED_STRING" { "," "objectTypeValue"
"QUOTED_STRING" }
extractOptionValue = ( "QUOTED_STRING" )
objectTypeValue = ( PROJECT | ORACLE_MODULE | TABLE | VIEW | SEQUENCE |
MATERIALIZED_VIEW | FUNCTION | PROCEDURE | PACKAGE | DIMENSION | CUBE
| ADVANCED_QUEUE | STREAMS_QUEUE | MAPPING | REAL_TIME_MAPPING |
PROCESS_FLOW_MODULE | PROCESS_FLOW_PACKAGE | PROCESS_FLOW | SAP_MODULE
| CMI_MODULE | GATEWAY_MODULE | EXTERNAL_TABLE | FLAT_FILE_MODULE |
FLAT_FILE | BUSINESS_DEFINITION_MODULE | ITEM_FOLDER | LIST_OF_VALUES
| DRILL_TO_DETAIL | ALTERNATIVE_SORT_ORDER | DRILL_PATH |
BUSINESS_AREA | LOCATION | CONNECTOR | CONTROL_CENTER | CONFIGURATION
| COLLECTION | SNAPSHOT | ROLE | USER | ICONSET |
TRANSFORMATION_MODULE | CALENDAR_MODULE | CALENDAR_FOLDER | CALENDAR |
EXPERT_MODULE | EXPERT | DATA_RULE_MODULE | DATA_RULE | DATA_AUDITOR
| STREAMS_CAPTURE_PROCESS | QUEUE_TABLE | QUEUE_PROPAGATION |
OBJECT_TYPE | NESTED_TABLE | VARYING_ARRAY | DEPLOYMENT | DATA_PROFILE
| PROFILE_REFERENCE | PLSQL_TABLE_TYPE | PLSQL_RECORD_TYPE |
PLSQL_REF_CURSOR_TYPE | PLUGGABLE_MAPPING | PLUGGABLE_MAPPING_FOLDER |
CMI_DEFINITION | ACTIVITY_TEMPLATE | ACTIVITY_TEMPLATE_FOLDER |
TRANSPORTABLE_MODULE )
Keywords And Parameters
mdlMergeCommand
Merge business names and descriptions from an XLIFF translation file into a
metadata loader file.
QUOTED_STRING
Enclose the name of the source metadata loader file in single quotes.
mergeTranslateFileClause
Specify the name of the source translation file.
QUOTED_STRING
Enclose the name of the source translation file in single quotes.
mergedMDLFileClause
Specify the name of the merged metadata loader file which will contain the
translation information.
QUOTED_STRING
Enclose the name of the merged metadata loader file in single quotes.
setMergeOptions
Set options to be used for merge.
componentsClause
List components to be merged.
mergeControlFileClause
Specify a control file with merge options not directly supported by
OMBTRANSLATE EXTRACT command.
QUOTED_STRING
Enclose the control file name in single quotes.
mergeOutputLogClause
Merge log file for merge messages and statistics.
QUOTED_STRING
Enclose the log file name in single quotes.
extractOptionNameList
Comma separated list of extract option names (e.g. TARGETEQUALSSOURCE,
EXTRACTNULLS).
UNQUOTED_STRING
Valid option names are TARGETEQUALSSOURCE, EXTRACTNULLS, MAPPINGDETAILS,
DTD.
extractOptionValueList
Comma separated list of extract option values (e.g. 'Y', 'Y').
componentsList
Comma separated list of components to be merged.
QUOTED_STRING
Name of an object (e.g. 'TABLE_Y').
extractOptionValue
Value for an option in list (e.g. 'Y').
QUOTED_STRING
Enclose the option value in single quotes.
objectTypeValue
Object type to be merged (e.g. TABLE, VIEW etc.).
See Also
OMBTRANSLATE EXTRACT
Purpose
To undefine an association between two classes (types).
Prerequisites
Association definition to be undefined should already exist. This command
can be executed for any association definition regardless of current
context. Only user defined associations can be undefined. User must have
CREATE_EXTENSIONMODEL system privilege and has to be connected in single
user mode to run this command.
Syntax
parseUndefineAssociationCommand = OMBUNDEFINE ASSOCIATION_DEFINITION
"QUOTED_STRING"
Keywords And Parameters
parseUndefineAssociationCommand
Undefine an association.
See Also
OMBDEFINE ASSOCIATION_DEFINITION, OMBDESCRIBE ASSOCIATION_DEFINITION
Purpose
To undefine a class.
Prerequisites
Class definition to be undefined should already exist. This command can be
executed for any class definition regardless of current context. Only user
defined classes can be undefined. User must have CREATE_EXTENSIONMODEL
system privilege and has to be connected in single user mode to run this
command.
Syntax
parseUndefineClassCommand = OMBUNDEFINE CLASS_DEFINITION "QUOTED_STRING" [
CASCADE ]
Keywords And Parameters
parseUndefineClassCommand
Undefine a class.
See Also
OMBDEFINE CLASS_DEFINITION, OMBDESCRIBE CLASS_DEFINITION
Purpose
Unlock one or more objects, previously locked by OMBLOCK command. Note that if the object(s) have been modified, save or revert is
also required in order for the lock(s) to be released.
Prerequisites
The object(s) should have been locked previously using OMBLOCK command.
Syntax
parseUnLockCommand = OMBUNLOCK "parseTypeNameList"
parseTypeNameList = "objectType" "QUOTED_STRING" { "," "objectType"
"QUOTED_STRING" }
objectType = ( ADVANCED_QUEUE | STREAMS_QUEUE | BUSINESS_AREA | COLLECTION
| CONNECTOR | CONFIGURATION | DEPLOYMENT | CUBE | DIMENSION | EXPERT
| EXPERT_MODULE | EXTERNAL_TABLE | FLAT_FILE_MODULE | FLAT_FILE |
FUNCTION | TABLE_FUNCTION | GATEWAY_MODULE |
BUSINESS_DEFINITION_MODULE | REGISTERED_FUNCTION | LOCATION | MAPPING
| MATERIALIZED_VIEW | OBJECT_TYPE | VARYING_ARRAY | NESTED_TABLE |
ORACLE_MODULE | PACKAGE | PROCEDURE | PROCESS_FLOW |
PROCESS_FLOW_MODULE | PROCESS_FLOW_PACKAGE | PROJECT | ITEM_FOLDER |
DRILL_PATH | LIST_OF_VALUES | DRILL_TO_DETAIL | ALTERNATIVE_SORT_ORDER
| CONTROL_CENTER | SAP_MODULE | CMI_MODULE | SEQUENCE | TABLE | VIEW
| CMI_DEFINITION | PLSQL_RECORD_TYPE | "UNQUOTED_STRING" )
Keywords And Parameters
parseUnLockCommand
Specify unlock command.
parseTypeNameList
Specify the object or the list of objects to be unlocked.
QUOTED_STRING
Name of the object to be unlocked. Can be specified as an absolute path or
as a path relative to the current context. However, there is the
restriction that all objects to be unlocked must be in the current project.
objectType
Type of the object to be unlocked.
See Also
OMBLOCK
Purpose
Un-register a control center.
Prerequisites
Must be logged on as the owner of the workspace and connected in a single
user mode.
Syntax
unRegisterControlCenterCommand = OMBUNREGISTER CONTROL_CENTER
"QUOTED_STRING"
Purpose
Un-register a location with a Control Center.
Prerequisites
Must be in the context of a project and connected to a Control Center.
Syntax
unRegisterLocationCommand = OMBUNREGISTER LOCATION "QUOTED_STRING"
Purpose
To unregister a specified Warehouse Builder user. This will not drop the user from database.
Prerequisites
A Warehouse Builder user can be unregistered from any context.
Syntax
parseUnregisterUserCommand = ( OMBUNREGISTER USER "QUOTED_STRING" )
Keywords And Parameters
parseUnregisterUserCommand
This clause unregister a specified Warehouse user.
See Also
OMBREGISTER USER, OMBALTER USER, OMBRETRIEVE USER
Purpose
This command validates an repository object. The results are generated in a file in a user defined directory.
Prerequisites
In the context of a Oracle Module except when validating Project and Oracle
Module. To validate a Project the user needs to be in the Root context. To
validate Oracle Module the user needs to be in Project context.
Syntax
parseValidateCommand = OMBVALIDATE ( ( EXPERT | EXPERT_MODULE | TABLE |
VIEW | SEQUENCE | ORACLE_MODULE | COLLECTION | MATERIALIZED_VIEW |
TRANSPORTABLE_MODULE | BUSINESS_DEFINITION_MODULE | DIMENSION | CUBE |
DATA_AUDITOR | MAPPING | REAL_TIME_MAPPING | PROJECT | OBJECT_TYPE |
VARYING_ARRAY | NESTED_TABLE | PACKAGE | FUNCTION | PROCEDURE |
TABLE_FUNCTION | EXTERNAL_TABLE | FLAT_FILE | FLAT_FILE_MODULE |
ALTERNATIVE_SORT_ORDER | LIST_OF_VALUES | DRILL_TO_DETAIL |
BUSINESS_AREA | DRILL_PATH | ITEM_FOLDER | REGISTERED_FUNCTION |
LOCATION | CONNECTOR | CONTROL_CENTER | CONFIGURATION | DEPLOYMENT |
PROCESS_FLOW_MODULE | PROCESS_FLOW | PROCESS_FLOW_PACKAGE |
ADVANCED_QUEUE | STREAMS_QUEUE | QUEUE_TABLE | QUEUE_PROPAGATION |
STREAMS_CAPTURE_PROCESS | PLSQL_RECORD_TYPE | PLSQL_TABLE_TYPE |
PLSQL_REF_CURSOR_TYPE | CALENDAR | CALENDAR_MODULE ) "QUOTED_STRING" [
"getOutputValidationResults" ] )
getOutputValidationResults = OUTPUT [ VALIDATION_RESULT ] TO (
"QUOTED_STRING" | ( FILE "QUOTED_STRING" ) ) WRITE ( ( "(" ( ( SUCCESS
| WARNING | ERROR ) [ "," ] )+ ")" ) | ALL | SUCCESS | WARNING |
ERROR )
Keywords And Parameters
parseValidateCommand
This command validates a repository object.
QUOTED_STRING
The name of the object.
getOutputValidationResults
This clause outputs the validation results to one or more files in the
specified folder.
QUOTED_STRING
A directory where validation results are stored.
See Also
OMBCOMPILE
