Contents

List of Examples

Title and Copyright Information

Preface

• Audience
• Documentation Accessibility
• Finding Information and Patches on My Oracle Support
• Finding Oracle Documentation
• Related Documents
• Conventions

Part I Essential Information

1 Using Application Programming Interfaces

• About APIs
• Calling APIs from Outside the Oracle Life Sciences Data Hub
  • Security Setup Required
  • Calling the Security API Package
  • Calling APIs from SAS
  • Using a Permanent Schema for Deploying Programs that Call APIs
• Calling APIs from Defined Programs
• Code Example Using Security and Error Message APIs

2 Reference Information

• CDR Naming Version Object Type
• CDR Base Object Type
• CDR Object-Specific Database Object Types
• Retrieving Reference Codelist Names and Values
• Retrieving the Instance Domain ID
• Standard Parameters

Part II Object APIs

3 Application Areas

• Define and Modify Application Areas
  • Create an Application Area
  • Modify an Application Area
  • Remove an Application Area
  • Copy Objects into an Application Area
  • Move Objects into an Application Area

4 Business Areas

• Define and Modify Business Areas
  • Create a Business Area
  • Modify a Business Area
  • Check Out a Business Area
  • Undo a Business Area Checkout
  • Check In a Business Area
  • Remove a Business Area
• Create and Modify Business Area Hierarchies
  • Create a Business Area Hierarchy
  • Modify a Hierarchy and a Hierarchy Column
  • Reorder a Hierarchy Column
  • Remove a Hierarchy Column
  • Remove a Business Area Hierarchy
• Create and Modify Business Area Joins
  • Create a Join
  • Modify a Join and a Join Column
  • Remove a Join Column
  • Remove a Join
• Public APIs and Naming Views for Generic Visualization Adapter (GVA)
  • Initialize a Generic Visualization Business Area Instance
  • Reset a Generic Visualization Business Area
  • Get Possible Blinding Types of a Business Area Instance
  • Get Snapshot Labels Common to all Tables in a BA Instance for a Given Blinding AccessType
  • Naming Views

5 Data Marts

• Define and Modify Work Areas
  • Create a Data Mart
  • Check In a DataMart Definition
  • Modify a Data Mart
  • Check Out a Data Mart
  • Remove a Data Mart

6 Domains

• Define and Modify Domains
  • Create a Domain
  • Modify a Domain
  • Copy a Domain
  • Move Objects into a Domain
  • Copy Objects into a Domain
  • Copy Objects into a Domain and Check In
  • Remove a Domain

7 Load Sets

• Define and Modify Load Sets
  • Create a Load Set
  • Check Out a Load Set Definition
  • Modify a Load Set
  • Check In a Load Set Definition
  • Remove a Load Set
  • Synchronize Table Descriptors in a Load Set

8 Parameter Sets

• Create and Modify Parameter Sets
  • Create a Parameter Set Definition
  • Check Out a Parameter Set Definition
  • Modify a Parameter Set Definition
  • Modify a Parameter Set Detail
  • Check In a Parameter Set Definition
  • Remove a Parameter Set Definition

9 Planned Outputs

• Create and Modify Planned Outputs
  • Create a Planned Output
  • Get a New Position Number
  • Get a Planned Output Object
  • Modify a Planned Output
  • Identify whether a SAS Object
  • Remove a Planned Output Object

10 Programs

• Create and Modify Programs
  • Create a Program
  • Copy Objects Into a Program
  • Modify a Program
  • Check In a Program Definition
  • Check Out a Program Definition
  • Remove a Program
  • Create a Planned Output for a Log File
  • Assign a Planned Output
  • Modify a Manual Validation Flag Value

11 Report Sets

• Create and Modify Report Set Entries
  • Create a Report Set Entry
  • Add and Modify an Entry
  • Copy a Report Set Entry into Another
  • Modify a Report Set Entry
  • Move a Report Set Entry into Another
  • Reorder Report Set Entries in a Parent Report Set
  • Find if a Report Set is Checked Out
  • Check Unique and Strict Numbering in a Report Set
  • Identify if a Report Set Contains Child Entries
  • Find if a User has Modify Permission
  • Remove an Object from a Report Set Entry
  • Remove a Report Set Entry
  • Get a Report Set Name
  • Get a Title
  • Get a Chapter Number
  • Get a Parent Number
  • Get a List of Report Set Entry Titles
  • Get All RSE Titles in a Report Set
  • Get Attribute Values Derived from a Parent
  • Get the Lowest Entry Number
  • Get the Total Number of Report Set Entries
  • Create a Narrative
  • Update a Narrative
  • Delete a Narrative
  • Check if Copying Retains Valid Numbering in a Target Report Set
  • Check if a Move Retains Valid Numbering in a Target Report Set
  • Check if a Move Retains Valid Numbering in the Parent Report Set
  • Check if Removal Retains Valid Numbering in a Parent Report Set
  • Check if Reordering Retains Valid Numbering in a Parent Report Set
  • Unassign a Planned Output
• Create and Modify Report Sets
  • Create a Report Set
  • Check Out a Report Set
  • Undo a Report Set Checkout
  • Copy Objects Into a Report Set
  • Get a Summary Output Validation Status
  • Modify a Report Set
  • Move Objects into a Report Set
  • Remove Objects from a Report Set
  • Check In a Report Set
  • Remove a Report Set Definition
  • Remove a Report Set
• Create and Modify Overlay Template Definitions
  • Create an Overlay Template Definition
  • Modify an Overlay Template Definition File Definition
  • Get an Overlay Template Definition File as a BLOB
  • Remove an Overlay Template Definition File Definition
• Report Set Overlay Template
  • Create an Overlay Template
  • Check Out an Overlay Template
  • Undo an Overlay Template Checkout
  • Copy Objects Into an Overlay Template
  • Modify an Overlay Template
  • Check In an Overlay Template
  • Remove an Overlay Template

12 Software Source Codes

• Create and Modify Source Code
  • Create a Source Code Object
  • Get a Source Code CLOB
  • Modify Source Code
  • Set the Primary Flag to Yes
  • Update a Shareable Flag
  • Remove a Source Code Object

13 Tables

• Create and Modify Tables
  • Create a Table Definition
  • Create a Table Instance
  • Create a Temporary Blob
  • Create a Table Column
  • Create a Table Constraint
  • Modify a Table Definition
  • Modify a Table Descriptor
  • Modify a Table Instance
  • Reorder a Column
  • Upload a Table Descriptor or Column
  • Check In a Table Object
  • Remove a Single Object

14 Parameters

• Define and Modify Parameters
  • Create a Parameter
  • Check Out a Parameter
  • Check In a Parameter
  • Get Displayed Parameter Values
• Define Parameter Relations
  • Create a Parameter Relation Collection
  • Get Parameter Instances for Value Passing
  • Remove Parameter Relations

15 Variables

• Create and Modify Variables
  • Create a Variable
  • Check Out a Variable
  • Modify a Variable
  • Check In a Variable
  • Remove a Variable

16 Work Areas

• Define and Modify Work Areas
  • Create a Work Area
  • Install a Work Area
  • Check In a Work Area
  • Modify a Work Area
  • Clone a Work Area
  • Copy Objects into a Work Area
  • Clone an Object
  • Remove a Work Area
  • Get the Usage Intent RC of a Work Area
  • Update a Work Area's Usage Intent
  • Install a Program

17 Workflows

• Create and Modify Workflows
  • Create a Workflow
  • Check Out a Workflow Definition
  • Create a Workflow Transition
  • Create a Workflow Structure Instance
  • Modify a Workflow
  • Modify a Workflow
  • Check In a Workflow Definition
  • Remove a Transition
  • Remove a Workflow Activity
  • Remove a Workflow Instance
  • Remove a Workflow Definition

18 Workflow Notifications

• Create and Modify Notifications
  • Create a Notification
  • Create a Notification Recipient
  • Create a Notification Link
  • Check Out a Notification Definition
  • Modify a Notification Definition
  • Modify a Notification Instance
  • Send a Notification
  • Check In a Notification Definition
  • Remove a Notification Link
  • Remove a Notification Recipient
  • Remove a Notification

Part III Common APIs

19 Setup Utilities

• Initialize APIs
  • Initialize a Package
  • Verify Whether an API is Enabled
  • Enable an API
  • Disable an API
• Define and Modify Adapters
  • Create an Adapter Domain
  • Modify an Adapter Domain
  • Create an Adapter Area
  • Modify an Adapter Area
  • Populate a Tech Type Table
  • Modify a Tech Type Table
• Host Definition Constants
• Get Factory Support
  • Get a Naming Version Object
  • Get a User ID
  • Get a User Name
• Get Factory Utilities
  • Get a Base Object Type
  • Get a Company ID
• Get Factory Validations
  • Validate a Namespace
  • Validate a Reference
• Get Data from Naming Tables
  • Get the Latest Version
  • Get a Maximum Version
  • Get the Type of a Naming Object
  • Get an Object's Naming Version
  • Get an Object's Subtype ID
  • Get an Object's Checkout Status
  • Get Checkout Properties
  • Get a Naming Object's Parent
  • Get a Parent Naming Object
  • Get the Latest Version of the Parent Object
  • Get the Naming Status of a Parent Object
  • Get the Validation Status of a Parent Object
  • Get a Definition Object
  • Get a Lookup Meaning
  • Find Whether an Object is an Instance
  • Find Whether Checked Out By Current User
  • Find Whether a Checkout is User-Specific
  • Find Whether Checkout is Implicit
• Read Messages
  • Get a Message
  • Get a Message Count
  • Initialize a Message Stack

20 Execution Setups

• Create and Modify Execution Setups
  • Create an Execution Setup
  • Check Out an Execution Setup
  • Modify an Execution Setup
  • Modify a Parameter
  • Modify an Execution Setup Parameter
  • Load Parameter Details
  • Copy an Execution Setup
  • Check In an Execution Setup
  • Submit an Execution Setup
  • Submit an Execution Setup for Instances
  • Submit an Execution Setup for Compound Objects
  • Upgrade an Execution Setup
  • Upgrade All Execution Setups
  • Make an Execution Setup Active
  • Remove an Execution Setup

21 Mappings

• Create and Modify Mappings
  • Map a Column
  • Map a Table Descriptor to a Table Instance
  • Get a Table Instance ID
  • Create a Table Descriptor from a Table Instance
  • Create a Table Instance from a Table Descriptor
  • Modify a Mapping Column
  • Modify a Mapping at the Table Descriptor Level
  • Get a PRREF_ID for an Executable in a Workflow
  • Get a PRREF_ID for an Object in a Work Area
  • Get a PRREF_ID for a Program in a Report Set

22 Outputs

• Generate Outputs
  • Submit a Print Request
  • Get an Output's BLOB
  • Get an Output's CLOB

23 Version Labels

• Modify Version Labels
  • Update a Version Label

24 Classification

• Classify Objects
  • Classify an Object
  • Declassify an Object
• Classify Subtypes
  • Get a Subtype Classification Level
  • Get an Object Classification Value
  • Get a Parent Term
• Create and Modify Classification Hierarchy Values
  • Insert a Classification Value
  • Update a Classification Value
  • Delete a Classification Value

25 Job Execution

• Create and Execute Output Jobs
  • Create a Binary Output
  • Upload an Output BLOB
  • Upload an Output Clob
  • Upload a LOB to a Temporary Table
  • Download a Job Output BLOB
  • Queue a Job
  • Wait for a Job to Complete
  • Generate an XML Payload
• Retrieve Information about Ongoing Jobs
  • Get an Ongoing Job ID
  • Get Currently Executing Parameters
  • Get Information About a Job
  • Get Job Information (Overloaded)
• Set Execution Statuses
  • Set a User-specific Completion Status
  • Set a Customized Output Title
  • Set a Customized Output Subtitle
  • Set an Output Parameter
  • Get a Completion Status
• Submit Messages
  • Submit a Message
• Create Submission Records
  • Start a Job
  • Create a Submission
  • Create a Submission from a Job
  • Add a Job Log

26 Security Policy

• Create and Modify Security Policies
  • Create a Subtype
  • Copy a Subtype
  • Modify a Subtype
  • Assign Roles to a Subtype Operation
  • Assign Operations to a Subtype Role
  • Remove a Subtype
  • Create a Role
  • Modify a Role
  • Add a Group Role
  • Get Roles for a User
  • Remove a Role
  • Remove a Group Role
  • Create a User Group
  • Add Users to a Group
  • Remove Users from a Role in a User Group
  • Assign a User Group to an Object
  • Copy a User Group
  • Copy a User Group with its Users
  • Modify a User Group
  • Remove All Group Roles from a User Group
  • Remove All Users in a Group
  • Revoke a User Group From an Object
  • Undo a Revoke a User Group Action
  • Remove a User Group
  • Unassign a User Group From an Object
  • Unassign Roles from an Operation on an Object's Subtype
  • Unassign Operations on an Object Subtype's Role

27 Validation

• Validate Objects
  • Update an Object's Validation Status
• Create and Modify Validation Supporting Documents
  • Create a Validation Supporting Document
  • Update a Validation Supporting Document
  • Obsolete a Validation Supporting Document

Part IV Oracle Health Sciences Data Management Workbench APIs

28 Introduction to Oracle DMW APIs

• Set Up Study Environment
  • Initialize a Study and Lifecycle
• Create or Modify an Expression
• Using APIs to Create Custom Programs

29 Flags, Models and Actions

• Flag-Related APIs
  • Set Flag
  • Get Flag
  • Get Flags on Data
  • Delete Flag
• Flag Name-Related APIs
  • Get Flag Name Definition, Version 1
  • Get Flag Name Definition, Version 2
  • Get Flag Name Definitions
  • Get Flag States
• Model Categories-Related APIs
  • Create Model Flag Category Mapping
  • Get Categories for Model
• Action-Related APIs
  • Create Discrepancy Action
  • Get Disc Action, Version 1
  • Get Disc Action, Version 2
  • Update Discrepancy Action
  • Delete Discrepancy Action

30 Code Lists

• Create and Modify Code Lists
  • Create a Code List
  • Modify a Code List
  • Remove a Code List
  • Check In a Code List
  • Check Out a Code List
  • Add Values to a Code List
  • Remove Values from a Code List
  • Get Code List Details for a Given Column

31 Validation Checks

• Create and Modify Validation Checks and Batches
  • Create a Validation Check Batch
  • Modify a Validation Check Batch
  • Remove Validation Check Batch(es)
  • Create a Validation Check
  • Update a Validation Check
  • Install a Validation Check Batch
  • Submit a Validation Check Batch
  • Check In a Validation Check Batch
  • Check Out a Validation Check Batch
  • Undo Checkout For a Validation Check Batch
  • Update Validation Status of a Validation Check Batch
  • Upgrade a Validation Check Batch
  • Remove Validation Check(s)
  • Enable or Disable Validation Checks
  • Reorder Validation Checks

32 Transformations

• Create and Modify Transformation Maps
  • Create Transformation Maps
  • Modify Transformation Maps
  • Mark Table Maps Not Used
  • Mark Column Maps Not Used
  • Check In Transformation Maps
  • Check Out Transformation Maps
  • Undo Checkout Transformation Map
  • Auto Map Tables
  • Accept Table Mappings
  • Auto Map Columns
  • Accept Column Mappings
  • Upgrade Transformation Map
  • Install Transformation Map
  • Remove Transformation Map
  • Validate Transformation Maps
  • Update Validation Status
  • Execute Transformation Map
  • Create Staging Table
  • Validate Expression

Part V Oracle DMW Public Views

33 Public Views

• Code Lists Views
  • DME_PUB_CODELIST_V
  • DME_PUB_CODELIST_VALUES_V
• Validation Checks Views
  • DME_PUB_VC_BATCHES_V
  • DME_PUB_VC_DETAILS_V
• Transformation Views
  • DME_PUB_DF_XFORM_MAP_V
  • DME_PUB_DF_MAP_ENTITY_V
  • DME_PUB_XFM_SOURCE_TABLES_V
  • DME_PUB_XFM_SOURCE_COLUMNS_V
  • DME_ PUB_XFM_TARGET_TABLES_V
  • DME_ PUB_XFM_TARGET_COLUMNS_V
  • DME_ PUB_XFM_AUTOMAPS_V
  • DME_PUB_XFM_COL_AUTOMAPS_V
  • DME_PUB_XFM_CUSTOM_PROGRAMS_V
  • DME_PUB_XFM_EXPR_STDFUNC_V
  • DME_PUB_XFM_EXPR_STATIC_PKGS_V