This chapter lists commands associated with OMU commands in alphabetical order.
Invoke the editing GUI from OWB for the specified object.
Must be in the parent context of the object.
parseAlterCommand = OMUALTER "objectType" "QUOTED_STRING" objectType = "UNQUOTED_STRING"
parseAlterCommand
Invoke the corresponding editing GUI for the object. This command returns
the type and name of the object being altered, or empty string if the GUI
is cancelled.
objectType
The type of object to be edited. This can be any component or folder type.
For example, TABLE, VIEW, or MAPPING.
OMUCREATE
Invoke the generation GUI from OWB for the specified object.
Must be in the parent context of the object.
parseCompileCommand = OMUCOMPILE "objectType" "QUOTED_STRING" objectType = "UNQUOTED_STRING"
parseCompileCommand
Invoke the generation GUI for the specified object.
QUOTED_STRING
The object name.
objectType
The type of object to be compiled. For example, TABLE, VIEW, or MAPPING.
To launch the graphical version of the configuration inspector.
The object specified must be configurable within the current project.
parseConfigureCommand = OMUCONFIGURE "objectType" "QUOTED_STRING" objectType = "UNQUOTED_STRING"
To connect to repository using a graphical interface.
Must not be connected to a repository.
parseConnectCommand = OMUCONNECT
parseConnectCommand
Provides a graphical interface to connect to repository.
To show jobs running in the Control Center.
A Control Center connection. Note, a Design Repository connection is not
required.
parseControlCenterJobsCommand = OMUCONTROLCENTERJOBS [ "QUOTED_STRING" ]
OMUALTER
Invoke the creation GUI from OWB for the specified object type.
Must be in the parent context for the object type.
parseCreateCommand = OMUCREATE "objectType" [ SET "setPropertiesClause" ] objectType = "UNQUOTED_STRING" setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "(" "propertyValueList" ")" propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" } propertyValueList = "propertyValue" { "," "propertyValue" } propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" | "FLOATING_POINT_LITERAL" )
parseCreateCommand
Invoke the corresponding creation GUI for the object type. This command
returns the type and name of the object(s) being created, or empty string
if the GUI is cancelled.
objectType
The type of object to be created. This can be any component or folder.
For examples, TABLE, VIEW, MAPPING, etc.
setPropertiesClause
This clause sets the properties needed for launching the GUI.
propertyNameList
The list of property names to set.
Properties for LOCATION:
Name: TYPE
Type: STRING
Valid Values: See OMBCREATE LOCATION for valid values.
Default: 'ORACLE_DATABASE'
The type of system the location represents.
Properties for CONNECTOR:
Name: TYPE
Type: STRING
Valid Values: 'DB_CONNECTOR', 'DIRECTORY'
Default: 'DB_CONNECTOR'
The type of connector to create.
Properties for GATEWAY_MODULE:
Name: GATEWAY_TYPE
Type: STRING
Valid Values: See OMBCREATE GATEWAY_MODULE for valid values.
Default: N/A
The type of gateway module to create.
propertyValueList
The list of property values.
propertyValue
The value of a property.
OMUALTER
To display Dataviewer for relational and dimensional objects to business definition objects.
A relational object or dimensional object must exist.
parseDataviewerCommand = OMUDATAVIEWER ( DIMENSION | CUBE | TABLE | VIEW ) "QUOTED_STRING"
To Deploy Action Plans to Control Centers.
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.
parseDeployCommand = OMUDEPLOY "objectType" "QUOTED_STRING" objectType = "UNQUOTED_STRING"
OMUALTER
To derive relational and dimensional objects to business definition objects.
A relational object or dimensional object must exist.
parseDeriveCommand = OMUDERIVE ( ORACLE_MODULE | DIMENSION | CUBE | TABLE | VIEW | EXTERNAL_TABLE | FUNCTION | COLLECTION ) "QUOTED_STRING"
parseDeriveCommand
To derive relational and dimensional objects to business definition
objects.
Exports the metadata from the repository based on the metadata loader action plan.
Connection must be established to workspace to be exported from.
parseMDLExportCommand = OMUEXPORT MDL_FILE [ "QUOTED_STRING" ] MDL_ACTION_PLAN "QUOTED_STRING"
parseMDLExportCommand
Exports the metadata from the repository
QUOTED_STRING
Enclose the name of the export metadata file in single quotes.
MDL_ACTION_PLAN
Specify the MDL_ACTION_PLAN to be used by the export. Enclose the
metadataloader action plan in single quotes.
OMBCREATE MDL_ACTION_PLAN, OMBALTER MDL_ACTION_PLAN, OMBDROP MDL_ACTION_PLAN, OMBRETRIEVE MDL_ACTION_PLAN, OMUIMPORT MDL_FILE
To perform impact analysis on the specified object. Metadata Dependency Manager will show up with an impact graph of the specified
object.
The object specified can be source or target object.
parseShowImpactCommand = OMUIMPACT "objectType" "QUOTED_STRING" objectType = "UNQUOTED_STRING"
parseShowImpactCommand
Shows the impact of an object.
objectType
Type of the object whose impact graph needs to be shown.
To launch the graphical version of the import wizard.
Must be in the context of a module.
parseDatabaseImportCommand = METADATA_LOCATION [ "objectType" [ ( MINIMAL_MODE | FULL_MODE ) ] ] objectType = "UNQUOTED_STRING"
Imports the metadata from a file into the workspace
Must be connected to the workspace where the import is to be performed.
parseMDLImportCommand = MDL_FILE [ "QUOTED_STRING" ]
parseMDLImportCommand
Import metadata from a file.
QUOTED_STRING
Enclose the name of the import metadata file in single quotes.
OMUEXPORT MDL_FILE
To perform lineage analysis on the specified object. Metadata Dependency Manager will show up with a lineage graph of the specified
object.
The object specified can be source or target object.
parseShowLineageCommand = OMULINEAGE "objectType" "QUOTED_STRING" objectType = "UNQUOTED_STRING"
parseShowLineageCommand
Shows the linage of an object.
objectType
Type of the object whose lineage graph needs to be shown.
Run the object selector dialog for selecting some objects.
Connect to the workspace and in the parent context.
parseListCommand = OMULIST "objectType" objectType = "UNQUOTED_STRING"
parseListCommand
Show an object selector dialog for choosing the specified object type.
objectType
Specify the object type that the object selector dialog should show. This
object type can be any component or folder object type name in plural. For
example, TABLES, VIEWS, MAPPINGS, etc.
To construct a custom UI in order to prompt for some information from the end user.
None.
parsePromptCommand = OMUPROMPT "type" "name" [ "setPropertiesClause" ] { "addComponentClause" } type = "UNQUOTED_STRING" name = "QUOTED_STRING" setPropertiesClause = SET PROPERTIES "(" "propertyNameList" ")" VALUES "(" "propertyValueList" ")" addComponentClause = ADD "type" "name" [ "setPropertiesClause" ] propertyNameList = PROPERTY_NAME { "," PROPERTY_NAME } propertyValueList = "propertyValue" { "," "propertyValue" } propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" | "FLOATING_POINT_LITERAL" )
parsePromptCommand
Construct a custom UI to prompt for information. This clause specifies the
name of the dialog and the properties for the dialog.
type
The type of custom dialog or its component. Currently only DIALOG is valid
custom UI type. For the type of a component UI, the valid types include
CHECK_BOX, CHOICE_BOX, COMBO_BOX, FILE_CHOOSER, HYPERLINK, LABEL, LIST_BOX,
PASSWORD_FIELD, RADIO_BUTTONS, SEPARATOR, TEXT_FIELD.
name
The name of the custom UI or UI component.
setPropertiesClause
This clause sets the properties for the custom UI or the UI component.
Basic properties for CHECK_BOX :
Name: RETURN_VALUE
Type: STRING
Valid Values: N/A
Default: ''
The return value for this component.
Name: CONTENT
Type: STRING
Valid Values: N/A
Default: ''
The text to be displayed by the side of the check box.
Name: SELECTION
Type: BOOLEAN
Valid Values: true, false
Default: false
Whether the check box should be selected by default.
Basic properties for CHOICE_BOX :
Name: RETURN_VALUE
Type: STRING
Valid Values: N/A
Default: ''
The return value for this component.
Name: MESSAGE_TEXT
Type: STRING
Valid Values: N/A
Default: ''
The message text to be displayed by the side of the choice box that
describes what the selection is about.
Name: CONTENT
Type: STRING
Valid Values: N/A
Default: ''
The different choices shown in the choice box. Needs to be a
comma-separated list.
Name: SELECTION
Type: STRING
Valid Values: N/A
Default: ''
The default selection of the choices.
Basic properties for COMBO_BOX :
Name: RETURN_VALUE
Type: STRING
Valid Values: N/A
Default: ''
The return value for this component.
Name: MESSAGE_TEXT
Type: STRING
Valid Values: N/A
Default: ''
The message text to be displayed by the side of the combo box that
describes what the selection is about.
Name: CONTENT
Type: STRING
Valid Values: N/A
Default: ''
The different choices shown in the combo box. Needs to be a
comma-separated list.
Name: SELECTION
Type: STRING
Valid Values: N/A
Default: ''
The default selection of the choices.
Basic properties for DIALOG :
Name: RETURN_VALUE
Type: STRING
Valid Values: N/A
Default: ''
The return value for this component.
Name: TITLE
Type: STRING
Valid Values: N/A
Default: ''
Title of the custom dialog.
Name: WIDTH
Type: NUMBER
Valid Values: N/A
Default: ''
The width of the custom dialog. If either the height or the width is
unspecified or set to 0, then the dialog will be auto-sized.
Name: HEIGHT
Type: NUMBER
Valid Values: N/A
Default: ''
The height of the custom dialog. If either the height or the width is
unspecified or set to 0, then the dialog will be auto-sized.
Name: LINE_WRAP
Type: NUMBER
Valid Values: N/A
Default: 2
CUSTOMUI_DIALOG_LINE_WRAP_DESC??
Name: OPTIONS
Type: STRING
Valid Values: N/A
Default: ''
The options for the dialog. These translate into buttons at the bottom of
the dialog. A comma-separated list of values is expected here. For
example, a dialog with a YES and No button will need an OPTION of 'YES,NO'.
Name: DEFAULT_OPTION
Type: STRING
Valid Values: N/A
Default: ''
The default option of the dialog. This means the default button that will
be pressed when the ENTER key is pressed.
Name: CANCEL_OPTION
Type: STRING
Valid Values: N/A
Default: ''
The option that represents cancellation of the dialog.
Basic properties for FILE_CHOOSER :
Name: RETURN_VALUE
Type: STRING
Valid Values: N/A
Default: ''
The return value for this component.
Name: CONTENT
Type: STRING
Valid Values: N/A
Default: .
The default directory to be shown in the file chooser.
Name: SELECTION
Type: STRING
Valid Values: DIRECTORIES_ONLY, FILES_ONLY, FILES_AND_DIRECTORIES
Default: FILES_AND_DIRECTORIES
Tells whether the file chooser should allow selection of files only,
directories only, or both files and directories.
Basic properties for HYPERLINK :
Name: RETURN_VALUE
Type: STRING
Valid Values: N/A
Default: ''
The return value for this component.
Name: MESSAGE_TEXT
Type: STRING
Valid Values: N/A
Default: ''
The message text to be displayed as text for the link.
Name: CONTENT
Type: STRING
Valid Values: N/A
Default: ''
The URL of the link target location.
Basic properties for LABEL :
Name: RETURN_VALUE
Type: STRING
Valid Values: N/A
Default: ''
The return value for this component.
Name: CONTENT
Type: STRING
Valid Values: N/A
Default: ''
The content of the label. This can be HTML-formatted text.
Basic properties for LIST_BOX :
Name: RETURN_VALUE
Type: STRING
Valid Values: N/A
Default: ''
The return value for this component.
Name: MESSAGE_TEXT
Type: STRING
Valid Values: N/A
Default: ''
The message text to be displayed on top of the list box that describes what
the selection is about.
Name: CONTENT
Type: STRING
Valid Values: N/A
Default: ''
The different choices shown in the list box. Needs to be a comma-separated
list.
Name: SELECTION
Type: STRING
Valid Values: N/A
Default: ''
The default selection of the choices.
Basic properties for PASSWORD_FIELD :
Name: RETURN_VALUE
Type: STRING
Valid Values: N/A
Default: ''
The return value for this component.
Name: MESSAGE_TEXT
Type: STRING
Valid Values: N/A
Default: ''
The message text to be displayed by the side of the password field that
describes what the field is about.
Name: CONTENT
Type: STRING
Valid Values: N/A
Default: ''
The default content of the password field.
Basic properties for RADIO_BUTTONS :
Name: RETURN_VALUE
Type: STRING
Valid Values: N/A
Default: ''
The return value for this component.
Name: MESSAGE_TEXT
Type: STRING
Valid Values: N/A
Default: ''
The message text to be displayed on top of the radio buttons that describes
what the selection is about.
Name: CONTENT
Type: STRING
Valid Values: N/A
Default: ''
The different choices shown for the radio buttons. Needs to be a
comma-separated list.
Name: SELECTION
Type: STRING
Valid Values: N/A
Default: ''
The default selection of the choices.
Basic properties for SEPARATOR :
Basic properties for TEXT_FIELD :
Name: RETURN_VALUE
Type: STRING
Valid Values: N/A
Default: ''
The return value for this component.
Name: MESSAGE_TEXT
Type: STRING
Valid Values: N/A
Default: ''
The message text to be displayed by the side of the text field that
describes what the field is about.
Name: CONTENT
Type: STRING
Valid Values: N/A
Default: ''
The default content of the text field.
addComponentClause
Add a UI component to the custom UI.
propertyNameList
The list of property names.
propertyValueList
The list of property values to set.
propertyValue
The value of the property.
To launch the graphical version of the object property inspector.
The object specified must be within the current project.
parsePropertiesCommand = OMUPROPERTIES "objectType" "QUOTED_STRING" objectType = "UNQUOTED_STRING"
To select the source where data is going to move from: type (oracle, gateway or file) and location.
Must be in the context of a project.
parseSelectSrcCommand = OMUSELECTSOURCE
To select the target where data is going to move to: type (oracle only) and location.
Must be in the context of a project.
parseSelectTgtCommand = OMUSELECTTARGET
To show the console containing all snapshots.
Must be connected to the repository.
parseShowChangeConsoleCommand = OMUSHOWCHANGECONSOLE
parseShowChangeConsoleCommand
Shows the console containing all snapshots.
To start running the expert assistant.
Connect to a repository.
parseStartExpertCommand = OMUSTART EXPERT "QUOTED_STRING" [ "parameterClause" ] parameterClause = WITH PARAMETERS "(" "parameterNameList" ")" VALUES "(" "parameterValueList" ")" parameterNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" } parameterValueList = "parameterValue" { "," "parameterValue" } parameterValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" | "FLOATING_POINT_LITERAL" )
parseStartExpertCommand
Start an expert.
parameterClause
Supply a list of input parameter values to be passed into the expert.
parameterNameList
The list of input parmater names.
parameterValueList
The list of parameter values to be passed in.
parameterValue
A parameter value in quoted string, can be STRING, NUMBER, BOOLEAN or
ARRAY.
OMBCREATE EXPERT, OMBALTER EXPERT, OMUCREATE, OMUALTER
To launch the graphical version of object execution .
'Best Practice' usage requires a Design Repository workspace connection and
the context to be set to that of executable object. The 'Control Center
Only' usage does not require a Design Repository workspace connection and
therefore no context.
parseStartJobCommand = OMUSTARTJOB "objectType" "QUOTED_STRING" objectType = "UNQUOTED_STRING"
To start running the expert assistant.
Connect to a repository.
parseStartExpertCommand = OMUSTART EXPERT "QUOTED_STRING" [ "parameterClause" ] parameterClause = WITH PARAMETERS "(" "parameterNameList" ")" VALUES "(" "parameterValueList" ")" parameterNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" } parameterValueList = "parameterValue" { "," "parameterValue" } parameterValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" | "FLOATING_POINT_LITERAL" )
parseStartExpertCommand
Start an expert.
parameterClause
Supply a list of input parameter values to be passed into the expert.
parameterNameList
The list of input parmater names.
parameterValueList
The list of parameter values to be passed in.
parameterValue
A parameter value in quoted string, can be STRING, NUMBER, BOOLEAN or
ARRAY.
OMBCREATE EXPERT, OMBALTER EXPERT, OMUCREATE, OMUALTER
Invoke the validation GUI from OWB for the specified object.
Must be in the parent context of the object.
parseValidateCommand = OMUVALIDATE "objectType" "QUOTED_STRING" objectType = "UNQUOTED_STRING"
parseValidateCommand
Invoke the validation GUI for the specified object.
QUOTED_STRING
The object name.
objectType
The type of object to be validated. For example, TABLE, VIEW, or MAPPING.