Managing Master Data with webMethods OneData
Administering webMethods OneData
About this Guide
Document Conventions
Online Information and Support
Data Protection
Configuring Security
OneData User Security
Logging in to OneData
Managing User Accounts
Creating New User Accounts
Editing User Accounts
Deleting User Accounts
Assigning Backup Users
Assigning Supervisors
Setting Up the Anonymous User Account
Managing Locked and Inactive Accounts
Locking and Deactivating Accounts
Unlocking and Reactivating Accounts
Managing Roles
Configuring Roles
Cloning a Role
Assigning Users to User Roles
Row Filters
Setting Row Filters
User Groups
Managing User Groups
Managing OneData User Sessions
Messaging Active Users
Terminating Active Sessions
User Roles and Hooks
Associating User Roles with Hook Commands
External Security Authentication Using LDAP
Enabling External Authentication in OneData
Configuring External Security Authentication with LDAP
Enabling Retrieval of Deleted Users List from Non-Active Directory Services Database
Adding an LDAP Profile in OneData
Importing Users from LDAP
Single Sign On (SSO)
Configuring the SSO Framework for OneData
Implementing SAML-based SSO with Integrated Windows Authentication
Implementing Kerberos-based SSO with Integrated Windows Authentication
Setting up the Windows Server and Active Directory
Setting up the Server for Kerberos Authentication
Configure the Web Clients to use Kerberos-based SSO
Verifying Internet Options Settings in Internet Explorer
Configuring Mozilla Firefox
Configuring Google Chrome
Enabling SSO with External Authentication
Enabling an External SSO Server
Page-Level Security
Configuring Page-Level Security
Configuring Web Browser Security Header Properties
Protecting Against Cross-Site Scripting
Enforcing Data Validation
Enforcing Validation of Input Data
Enabling External Entities
Configure CSRF Guard
Configuring SSL in OneData
What is SSL?
Certificates and Keystores
Creating a Keystore Having a Self-Signed Certificate
Configuring SSL in OneData Using a Signed Certificate
Creating a CSR for Obtaining a Signed Certificate from CA
Importing Signed Certificate into the Keystore
Configuring Secure SSL Connections
Enabling HTTPS in OneData
Customizing OneData
The OneData Properties Files
Using the User Interface to Configure OneData Properties
Configuring Properties in the onedata.properties File
OneData System Properties
Configuring OneData System Properties
Personalizing the Logo in the Login Page
Personalizing Images and Templates in Screens and Notification Templates
Customizing OneData Menus
Managing Custom Menus
Deleting Custom Menus
Customizing the Home Page
Customizing Standard Portlets
Managing Custom Portlets
Creating a Link to an Object from the Home Page
Changing the Default Java Location for OneData
Internationalization (i18n) Support
Localizing Metadata Elements
The Java Service Wrapper
The Java Service Wrapper Configuration Files
JVM Configuration
JVM Configuration Properties
The Wrapper Log
Logging Properties
Fault Monitoring
Deadlock-Detection Properties
Console Filtering Properties
Generating a Thread Dump
Configuring Connections
Repository Level Properties
Adding Repositories
Configuring OneData Database Connections
Configuring JDBC Connections
Configuring Apache Hive Connections for Big Data
Configuring Integration Server Connections
Working with Database Connection Pools
Monitoring Database Connections
Monitoring Connections through Connection Console
Monitoring Connections through Connection Manager
Managing FTP and SFTP Sites for Import and Export Jobs
Configuring FTP and SFTP Sites
Configuring the Keystore Directory Path
Installing and Configuring Elasticsearch
Overview
Installing Elasticsearch
Configuring and Viewing Service Audit Logs
Service Layer Logging for Inbound Requests
Configuring Service Audit Logging
Overriding OneData Configurations
Viewing Service Audit Logs for Inbound Requests in De-Normalized View
Viewing Service Audit Logs for Individual Inbound Requests
Downloading Service Audit Logs for Inbound Requests
Viewing Service Layer Error Logs for Inbound Requests
Asynchronous Messaging
Asynchronous Messaging
Features of Messaging Support
Working with Messaging Queues
Defining Messaging Objects
Configuring Outbound Messaging Queues
Configuring OneData Properties
Configuring Messaging Jobs
Sample Nova Mode Work Area to Release Area XML Output Formats
Sample Deployment Job Output Formats
Work Area to Release Area (Default Mode)
Sample Messaging Format for Multi-Select Columns
Incoming Messages on the Data Acquisition Layer
Inbound XML Envelope Sample
Defining Inbound Mode
Working with the Inbound XML Envelope for Conceptual Objects
Creating the Inbound XML Envelope for Conceptual Object
Working with XML Envelopes for Self Recursive Objects?
Managing the XML Envelope for Self Recursive Hierarchy
Purging Nodes in Self Recursive Objects
Restoring Hierarchy in Self Recursive Objects
Working with Network Recursive Hierarchies
Creating the XML Envelope for Network Recursive Hierarchy
Purging and Restoring Nodes in Network-Recursive Objects
Viewing Logs of Asynchronous Messaging
Clustering OneData
What is OneData Clustering?
Load Balancing in a Cluster
Types of Clustering
Installing and Setting Up OneData Clustering
Preparing Apache Web Server as a Load Balancer
Configuring Tomcat Workers for Load Balancing
Worker Properties File Reference
Setting up a OneData Cluster
Adding a OneData Instance to the Cluster
Removing a OneData Instance from a Cluster
Working with In-Memory and Caching in OneData
In-Memory Database
Adding a Terracotta License
Verifying Terracotta Configuration in OneData
Configuring Caching Properties for In-Memory
Connecting OneData to Terracotta
Configuration for Null Value Filtering in Terracotta Cache
Viewing the Cache Server Details
Working with Distributed Caching in OneData
Usage Scenarios
Failover servers
Enabling Distributed Caching
Starting and Stopping the Cache Server
Synchronizing Caches of Objects in Default Mode
Working with Metadata
The Metadata Repository
Configuring the Metadata Repository
Monitoring Metadata Repositories
Configuring Metadata Audit Properties
Viewing and Scheduling Archive and Purge Processes
Audit Logs
Viewing DML Logs
Viewing DDL Logs
Viewing Message Logs
Viewing Usage Audit Logs
Viewing Metadata Audit Logs
Viewing Data Audit Logs
Working with Metadata
Configuring Metadata System Properties
Transferring and Importing Metadata
Metadata Core Relationships
Metadata Constraints
Transferring Metadata
Creating a Metadata Transfer Profile
Executing the Profile Transfer
Importing Metadata
Creating a Metadata Import Profile
Executing the Importing Profile
Comparing Metadata
Creating a Metadata Compare Profile
Executing the Compare Profile
Turning Off Scheduler
Transferring DDL Changes
Changing Sequence Numbers for Sequence Declaration
Audit Columns and Triggers
Sample Audit Scripts
Configuring webMethods Locate Address Verification Datasets
Downloading and Setting up Locate Datasets
Using Docker Containers for OneData
Overview of OneData Deployment with Docker Containers
Preparing for Docker Containerization of OneData
Setting Up Your Docker Environment
Docker Command Parameters
Post-Installation Checks for Docker Containerization
Additional Tasks for Docker Containerization of OneData
Configuring Environments
Building Environments from Other Environments
OneData Configuration Properties
OneData Configuration Properties
Properties Not Requiring Restart
OneData Features Not Supported on SQL Server
Features Not Support Supported on SQL Server
Implementing webMethods OneData
About this Guide
Document Conventions
Online Information and Support
Data Protection
Objects in OneData
OneData Objects
Object Subtypes in OneData
Object Configurations in OneData
Conceptual Objects
Security Inheritance Rule in Conceptual Objects
Cardinality In a Conceptual Object
Temporal Objects
Supertype Subtype Structures
Multi-Select Structure and Linkages
Hierarchies in OneData
Managing Hierarchies
Versioned Hierarchy
Creating A Data Object
Creating Data Objects Manually
Creating Data Objects Using Update Schema
Creating Data Objects From Remote Table
Copying An Object
Object Definition Properties
Creating A Conceptual Object
Creating A Conceptual Object Using Add Hierarchy
Changing the Constituent Objects in a Conceptual Object
Setting the Security Inheritance Rule For a Conceptual Object
Setting the Cardinality In a Conceptual Object
Creating A Temporal Object
Skipping Default Value in Show “as of date” records
Creating A Time Bound Object
Creating A Supertype Subtype Structure
Creating A Self Recursive Structure
Configuring to Inherit a Column Value From Parent Record
Creating A Network Recursive Structure
Creating A Multi-Select Structure
Creating Linkages Attribute and Linkages Column
Creating a Versioned Hierarchy
Creating An Object For A View
Best Practices for Creating a View
Using the Consolidated Hierarchy View to Edit Leveled Objects
Deleting An Object
Managing an Object Structure
Oracle Data Types Supported in OneData
SQL Server Data Types Supported in OneData
OneData Specific Data Types
OneData Audit Columns and Triggers
OneData Audit Columns
OneData Audit Triggers
OneData Sequence Triggers
Column Definition Properties
Using Multiple Columns as Descriptions for Related Objects
Configuring a Column in an Object
Configuring BLOB Columns
Changing Column Order in an Object
Setting Default Sort Order for a Column
Organizing Columns into Groups
Viewing Database Triggers
Synchronization of Column Properties and Audit Triggers
Synchronizing Columns in OneData
Synchronizing Audit Triggers in OneData
Exporting DDL of an Object
Deleting a Column in an Object
Configuring Object Properties
Migrating An Object From Default To Nova Mode
Assigning Object Level Privileges to Defined Roles
Configuring Notifications for Object Changes
Triggering Hooks for Object Changes
Managing Object Usage
Enabling Object Caching
Adding Context Help
Specifying Context Help for an Object
Viewing the Context Help of an Object
Managing Folders
Creating A New Folder And Moving Objects To New Folder
Moving a Folder
System Objects in OneData
System Objects
Data Audit Log Objects
OneData Projects
OneData Objects
OneData Object Types
OneData Object Structure
OneData Jobs
OneData Job Steps
OneData Job Log
OneData Users
OneData Workflow Audit Log
Viewing System Objects
Managing Object Constraints
Constraints In Objects
Foreign Key Constraint Caption Display
Passive Constraints
Configuring Primary Key Constraints
Creating Foreign Key Constraints
Changing Foreign Key Property
Restricting the Values in a Foreign Key Column
Disabling A Foreign Key
Creating Unique Constraints
Managing Check Constraints
Creating Passive Constraints
Working with Archive Snapshot Objects
Archive Snapshot Objects
Temporal Objects versus Archive Snapshot Objects
Archive Snapshot for Cloned Data Objects
Creating Archive Snapshot Objects
Setting an Alternate Effective Date for Archive Snapshots
Viewing an Archive Snapshot Object
Deleting an Archive Snapshot Object
Working with Projects
Projects
Enabling Projects in OneData
Creating a Custom Project
Granting Access to a Project
Changing the Default Project
Navigating Between Projects
Copying Objects Between Projects
Editing Project Details
Using Change Request
What are Change Requests?
Using the Change Request Inbox
Change Request Statuses
Enforcing Change Requests for an Object
Requesting a Change
Processing a Change Request
Viewing a Change Request
Creating General Form (Complex View) for Change Request
Starting a Thread in the Discussion Forum
Using Workflow in OneData
Workflow in OneData
Workflow in Data Objects
Workflow in Conceptual Objects
Workflow in Network Recursive Conceptual Objects
Workflow in Supertype Subtype Objects
Nova Workflow
Workflow Rules
Workflow Triggering Modes
Mandatory Column Assignment
Auto Approval
Admin Approval
Data Driven Workflow
Workflow Escalation
Workflow Rewind
Workflow Rule Model
Creating Workflow Rules
Assigning Workflow Rules to Objects
Assigning Workflow Rules within the Rule Definition
Assigning Workflow Rules within the Object Definition
Assigning Workflow Rules to Data Objects
Assigning Workflow Rules to Conceptual Objects
Configuring Mandatory Columns
Managing Workflow Properties
Setting Notification for Approvers
Changing the Workflow Triggering Mode
Disabling a Workflow Rule
Removing a Workflow Rule
Configuring Data Driven Workflow
Mapping Hooks to Workflow
Creating a Workflow Escalation Event
Running a Workflow Escalation Job
Viewing Results of Workflow Escalation Job
Editing a Workflow Escalation Event
Deleting a Workflow Escalation Event
Viewing Workflow Transactions
Viewing Graphical Representation of Workflow
Admin Approval of Workflows
Workflow Dashboard
Workflow Report as Graphs
Workflow Report as Summary Tables
System Objects Used In Workflow Dashboard
Configuring MashZone for Workflow Dashboard
Viewing Workflow Dashboards
Saving the Data Displayed in Dashboard
Using External Workflow in OneData
External Workflow in OneData
Working with Conceptual Objects in an External Workflow
Working with Supertype and Subtype Data Objects in an External Workflow
Tagging External Approvers in a Workflow Rule
Mapping an iHook to a Workflow Rule for External Workflow Invocation
Using iHook and Workflow API Methods in External Workflow
Using HookInput Methods for External Workflow
Using a Workflow API Method for an External Workflow
Data Validation in OneData
Using Regular Expressions for Data Validation and Transformation
Setting a Regular Expression
Data Validation Using the Rules Engine
Validation and Action Rules
Rules Syntax
Configuring Validation and Action Rules in the Rules Engine
Disabling a Rule in Rules Engine
Importing Data into Objects
Importing Data
Creating an Import Job
Managing an Import Job
Job Steps in Import Jobs
Working with Job Steps in Import Jobs
Editing Job Steps
Changing the Order of Import Job Step Execution
Selectively Executing an Import Job Step
Working with Interchange Mappings
Interchange Mappings
Managing Interchange Mapping Profiles
Retrieving the REST Web Service Link of an Interchange Mapping Profile
Using an Interchange Mapping to Manually Import Data
Using an Interchange Mapping in Data Manager
Migrating Existing Import Jobs to ETL Framework
Import Job Exception Queues
Managing Records in the Exception Queue
Scheduling Exception Queue Reports and Notifications
Exporting Data from OneData Objects
Export Jobs
Export Formats
Job Notification Options
Job Date Ranges
Job Log Options
Creating Export Jobs
Creating Conceptual Object Export Jobs
Creating a Database Update Export Job
Creating a File Generation by Object Export Job
Creating a File Generation by Timestamp Export Job
Creating a Hook Execution Export Job
Managing Export Jobs
Adding Job Steps
Adding Job Steps in a Conceptual Object Export Jobs
Adding Job Steps in Database Update Export Jobs
Adding Job Steps in File Generation Export Jobs
Adding a Job Step through an Object Definition
Managing an Export Job Step
Copying an Export Job Step
File Naming Options
Scheduling Jobs through Job Center
Job Center
Jobs Filter Options
Invoking Jobs From External Schedulers
Calling a Java Program
Calling a Servlet Directly
Using Notifications in Work Area To Release Area Transfers
Viewing a Job in the Job Center
Scheduling a Job Through Job Center
Scheduling a Command Hook Job
Viewing Job Execution Logs
Terminating a Job
Translating Data Types
Data Types Translation in OneData
Adding a Data Type Translation
Translating Default Values
Extending Definitions in OneData
System Extensions in OneData
Extending Object Definition
Extending User Account or Subscribing Systems Information
webMethods OneData User’s Guide
About this Guide
Document Conventions
Online Information and Support
Data Protection
Introduction to OneData
What is OneData ?
OneData Functions
Object Types
Objects Types in OneData
Object Subtypes
Temporal Objects Rules and Restrictions
Temporal Objects Frequently Asked Questions
Cardinality
OneData Object Display Modes
Conceptual Object Views
The OneData Interface
Navigating in OneData
Viewing Objects Graphically
Personalizing OneData
Mapping Entities in Multi-Select
OneData Users
Accessing OneData
Managing Your Password
Changing Your Password
Resetting Your Password
Managing User Profiles
Changing An Email Address
Backup Users
Providing Feedback
OneData Object Security
Security Options
Personalizing OneData
OneData Personalization
Defining User-Level Preferences
Defining Session-Level Preferences
Personalizing Objects
Managing Favorites
Adding Selected Objects as Favorites
Adding Favorites Using a Search
Renaming Favorites
Deleting Favorites
Sorting Favorites
Viewing Favorites History
Filtering Data in OneData
Filtering in OneData
SQL And, Or, and Where Queries
Search Operators
Applying a Filter to a Child Object
Sorting Records
Browsing and Searching
Browse, Search, Filter FAQ
Versioned Hierarchy Management in OneData
Versioned Hierarchy
Major and Minor Versions
Scratchpad Versions
Merging Versions
Submitting Versions for Approval
Approving a Version
Manipulating an Approved Version
Creating a Major Version
Creating a Scratchpad Version
Merging Versions
Comparing Versions
Reinstating a Retired Version
Deleting a Version
Working with Data Objects in Default Mode
Default Mode Objects
Inserting Records in Objects
Inserting Records into Temporal Objects
Editing Records
Editing Records
Updating Bulk Records
Performing a Search and Replace in Records
Copying Records
Viewing Records and Object Properties
Viewing the Object Definition
Viewing the Object’s Advanced Definition
Viewing Records
Viewing Filter Settings
Viewing the Audit Details of Records
Importing Records into Objects
Exporting Records from Objects
Deleting Records in Objects
Logically Deleting Records
Purging Records
Restoring Logically Deleted Records
Working with Conceptual Objects in Default Mode
Conceptual Objects
Inserting New Records
Inserting Records into a Object Hierarchy
Inserting a New Record Hierarchy in Conceptual Object Types
Inserting Records into Supertype and Subtype Objects
Inserting a Record in the Supertype Object with a Subtype
Inserting a Record in a Supertype Object
Editing Records
Editing Records in Conceptual Objects
Changing the Relationship of a Record
Performing a Search and Replace in Conceptual Objects
Viewing Records and Data Object Properties
Viewing Records
Viewing Relational Object Hierarchy
Viewing the Audit Details of Relational Records
Deleting Records and Record Hierarchies
Deleting Record Hierarchies
Logically Deleting Records
Purging Records
Restoring Logically Deleted Records
Working with Data Objects in Nova Mode
Nova Mode Objects
Nova Echo Mode
Inserting Records in Objects
Inserting Records in Temporal Objects
Generating a Comparison Report for Temporal Objects
Inserting and Editing Records in the Consolidated Hierarchy View
Editing Records
Editing Records
Bulk Updating Records
Performing a Search and Replace in Records
Copying Records
Viewing Records and Object Properties
Viewing the Object Definition
Viewing Records
Viewing the Audit Details of Records
Importing Records into Objects
Exporting Records from Objects
Deleting Records in Objects
Logically Deleting Records
Purging Records
Restoring Logically Deleted Records
Working with Conceptual Objects in Nova Mode
Conceptual Objects
Inserting New Records
Inserting Records into a Hierarchical Data Object
Inserting a New Record Hierarchy in Conceptual Objects
Creating Relationships Between Records in Network Recursive Conceptual Objects
Inserting Records into Supertype Subtype Objects
Inserting a Record in the Supertype Object with a Subtype
Inserting a Record in a Supertype Object Only
Editing Records
Editing Records
Changing the Relationship of a Record
Changing the Record Relationship for a Network Recursive Object
Changing the record relationship for a self-recursive object
Changing the Record Relationship in the Flat Table View
Performing a Search and Replace in Conceptual Objects
Viewing Records and Data Object Properties
Viewing Object Hierarchy
Viewing the Audit Details of Relational Records
Deleting Records and Record Hierarchies
Deleting Record Hierarchies
Logically Deleting Records
Purging Records
Restoring a Logically Deleted Record
Working with the Data Steward User Interface
Overview of the Data Steward User Interface
Changing Projects in New UI
Toggle between Work and Release Area in New UI
Global Search in the Data Steward user Interface
Performing a Full-Text Global Search for Data
Performing a Data Explorer Search for Data
New UI Preview for Data Manager
The Data Manager Tree Grid in New UI Preview
Controlling the Number of Rows Displayed for a Record in the New UI Preview
Sorting Records in the New UI Preview
Applying Sorting Order to Records
Filtering Records in the New UI Preview
Search Operators
Filtering on Object Records
Inserting and Editing Records
Inserting New Records at the Root Level of the Tree Grid
Inserting New Records at the Child Object Level of the Tree Grid
Editing Records
Deleting, Restoring, Purging Records
Working with Network Recursive Objects
Working with Workflow Items in the Data Steward User Interface
Approving Workflow Items for Objects You Own in the Data Steward User Interface
Approving Workflow Items as Admin Approver in the Data Steward User Interface
Using Objects in Flex Mode
Flex Mode
Functionality Descriptions
Loading Multiple Objects on Same Data Manager Screen
Network Recursive Tree in Flex
Network Recursive Tree Functionalities
Multiple presentation Styles
Filter Options
Drag and Drop
Node Deletion
Data Manager Operations
Right Pane Views
Viewing Orphan Nodes and Association with Another Node
Inserting a Record in the Root Node of a Network Recursive Tree
Importing Data Values into Network Recursive Object
Working with Reports
Reports
Reporting Permissions
Creating Reports
Creating a Published or Personal Report Using the Wizard
Creating a Published or Personal Report Free-Hand
Creating a Summary Report
Editing Reports
Editing Reports Using the Wizard
Editing a Published or Personal Report Using Free-Hand SQL
Running a Published or Personal Report
Running System Reports
Running a Repository Contents Report
Running Customized System Reports
Running Subscribing Systems Reports
Scheduling Published or Personal Reports
Scheduling Specific Reports from the Reports Menu
Scheduling Reports Using the Job Center
Deleting Reports
Managing Workflow
Data Changes in OneData
Managing Workflow
Managing Pending Workflow
Viewing Pending Workflow Transactions
Viewing the Workflow Model
Working with Command Hooks
Managing Change Requests
Approving Change Requests
Requesting Data Changes
Importing Data into Objects
Importing Data
Advanced Object Properties
Advanced Object Properties
Using Clickable Links
OneData Anywhere
Implementing the OneData Anywhere Link
Configuring OneData Anywhere Presentation
Using the Tabbed Browsing in OneData Anywhere
Requesting a Data Change
Using OneData Object Hyperlinks
Verifying the Column Definition
Linking Data to an Object
Linking Data to a Record in Another Object
Linking Data to a Website
Sending Data to an Email Recipient
External Services
Using RESTFUL Links
Using Deep Links
Accessing an Object’s Deep Link
Customizing Deep Links
Deep Link Filter Syntax
Filter Operators in Data Objects
Conceptual Object Filters
Creating Filters for a Child Entity of a Conceptual Object
Creating the Deep Link Filter
Using a Filtered Deep Link
Clearing a Deep Link Filter
Generating Object XSDs
Using Command Hooks
Developing for webMethods OneData
About this Guide
Document Conventions
Online Information and Support
Data Protection
OneData Hooks
How are hooks used in OneData?
Hook Invocation Modes and Triggering Events
Hook Processing Actions
Hook Types
Stored Procedure Hooks
Default Parameters in a Stored Procedure Hook
Java RMI and Java Local Hooks
Process Flow Hooks
Integration Server Hooks
IDATA Structure for Integration Server Services Called from iHooks
OneDataHook Functions and Stored Procedures
iHook Properties and Functions
iHooks Sample Code
Stored Procedure
Java RMI
Hooks Implementation
Process Flow Designer
Model Components
Process Items
Interactive Process Items
Non-Interactive Process Items
Looping Process Items
Non-Interactive Process Items
Looping Process Items
Component Connectors
Compilation and Errors in Process Flow
Validation Rules for Components and Items
Process Flow Example Scenarios
Process Flow Java Code Samples
Building a Process Flow
Defining a Hook
Assigning a Hook to an Object for Pre- or Post-Processing
Assigning Command Hooks to Objects
Defining a Command Hook Job
Managing a Hook
Removing a Hook Associated to an Object
Working In Process Flow Designer
Process Flow Designer
Model Components
Process Items
Interactive Process Items
Non-Interactive Process Items
Looping Process Items
Component Connectors
Compilation and Errors in Process Flow
Validation Rules for Components and Items
Building a Process Flow
Process Flow Example Scenarios
Process Flow Java Code Samples
API Functions and Web Services in OneData
API Functions Overview
Generic API Functions
getStructure
getData
isValidCode
Data Deployment Functions
executeSynchronousDeploymentJob
executeAsynchronousDeploymentJob
getResultForDeploymentJob
terminateDeploymentJob
Generic Job Functions
executeSynchronousJob
executeAsynchronousJob
getJobExecutionResult
terminateJob
Read-Write Web Services
Input XML Specification
Mandatory Tags
Enabling Service Layer Security in OneData
Retrieving Password for Service Layer Security
Enabling and Disabling Web Services in OneData
REST Web Services
REST Web Services in OneData
GET and POST Services
HTTP Request Header Parameters for GET and POST
GET Service Response Data
POST Service Response Data
The Acquisition Layer and REST Services
The Exception Queue and REST Services
Supported Resource Representations
Obtaining the REST URL of a OneData Object
Using Filters in REST Services
REST Object URL Syntax
Using Filter Operators in a REST URL
REST URL Parameters
alternateKey
baseVersion
batchSize
dateFormat
decode
description
enableDQMode
filter
lowVolumeLoad
objectNamePrefixedInXSD
pageNum
partialCommit
processingMode
responseLogLevel
returnColumns
schema_id
skipEmptyColumns
sortColumn&sortOrder
svcLogLevel
sourceSystem
wildCardOP
Request Parameters by HTTP Methods
Using JSON Strings in REST Services
Using REST Web Service URL
Accessing Data with the REST Service URL
Initiating a REST Call with Transaction Context
Ending a REST Call with Transaction Context
Working with REST XSDs
Obtaining the XSD from OneData
Configuring OneData to Skip Empty Columns
XSD Samples by Object Type
Conceptual Objects
Self Recursive Objects
Network Recursive Objects
Supertype and Subtype Object XML
Managing Jobs through REST Web Services
Invoking a Job with the REST Service URL
Viewing Job Status using the Job Log ID in the REST Service URL
Stopping a Job with a REST Service URL
In-Memory Database
In-Memory Database in OneData
Caching
Configuring Caching
Dependent Object Mapping
Creating a Cache Refresh Job
Data Cache Refresh from Work Area to Release Area
Scheduling a Cache Refresh Job
Using Terracotta with webMethods Products
About this Guide
Document Conventions
Online Information and Support
Data Protection
webMethods Products and Terracotta
Overview
Using Terracotta to Create Very Large In-Memory Caches with BigMemory
Using a Terracotta Server Array to Share Cached Data Among Applications
System Caches Used by webMethods Products
How webMethods Products Use Terracotta
Business Process Management
Software AG Common Platform
CentraSite
webMethods CloudStreams
Software AG Command Central
webMethods Event Routing
webMethods eStandards Modules
webMethods Integration Server
webMethods Mediator
webMethods Mobile Support
webMethods OneData
webMethods Optimize
webMethods Trading Networks
Licensing Requirements
Installing the Terracotta License
License Requirements for Integration Server
Installing and Configuring the Terracotta Server Array for Use with webMethods Products
Installing the Terracotta Server Array
Configuring the Terracotta Server Array for Use with webMethods Product
Creating the tc-config File
Using Command Central to Manage Terracotta
Command Central Commands that Terracotta Supports
Configuration Types that Terracotta Supports
Lifecycle Actions for Terracotta
Run-time Monitoring Statuses for Terracotta
Run-time Monitoring Statuses for Terracotta
System Caches Used by the webMethods Product Suite
Overview
Business Process Management
SoftwareAG.IS.PE.FailedProcessAudit
Software AG Common Platform
SSOAssertionsCacheManager.SSOAssertionsCache
CentraSite
SoftwareAG.CentraSite.model.ObjectCache_machine_name_port
SoftwareAG.CentraSite.model.TypeCache_machine_name_port
webMethods CloudStreams
SoftwareAg.IS.CloudStreams.ClusterStatusCache
SoftwareAg.IS.CloudStreams.CollectionKeysCache
SoftwareAg.IS.CloudStreams.ConsumerApplicationsCache
SoftwareAg.IS.CloudStreams.IntervalNotificationCache
SoftwareAg.IS.CloudStreams.MetricAccumulatorCache
SoftwareAg.IS.CloudStreams.RegisteredConsumerNamesCache
SoftwareAg.IS.CloudStreams.RuntimePolicyCache
SoftwareAg.IS.CloudStreams.VirtualServicesCache
Software AG Command Central
com.softwareag.plm.cce.cache.alert
com.softwareag.plm.cce.cache.attributes
com.softwareag.plm.cce.cache.basicmonitoringstatecached
com.softwareag.plm.cce.cache.configurationDataInfo
com.softwareag.plm.cce.cache.configurationInstanceInfo
com.softwareag.plm.cce.cache.configurationTypeInfo
com.softwareag.plm.cce.cache.environment
com.softwareag.plm.cce.cache.fixInfo
com.softwareag.plm.cce.cache.licenseKeyContainer
com.softwareag.plm.cce.cache.licenseMeteringReport
com.softwareag.plm.cce.cache.licenseMeteringAggregateReport
com.softwareag.plm.cce.cache.licenseMeteringConfigurationAggregationStatus
com.softwareag.plm.cce.cache.licenseMeteringRequiredStatus
com.softwareag.plm.cce.cache.manifest
com.softwareag.plm.cce.cache.node
com.softwareag.plm.cce.cache.platformInfo
com.softwareag.plm.cce.cache.productInfo
com.softwareag.plm.cce.cache.repositories
com.softwareag.plm.cce.cache.runtimeComponentInfo
com.softwareag.plm.cce.cache.runtimeMetadata
webMethods Enterprise Gateway
SoftwareAG.IS.Core.NonceCache
webMethods eStandards Modules
webMethods Module for AS4
SoftwareAG.IS.AS4. Duplicate_Detection
SoftwareAG.IS.AS4. MPC_pmode_map
SoftwareAG.IS.AS4. Default_Cache
webMethods Chem eStandards Module
SoftwareAG.IS.Chem.CHEMModelSessionCache
webMethods ebXML Module
SoftwareAG.IS.ebXML.EBXML
webMethods FIX Module
SoftwareAG.IS.FIX.FIXCache
webMethods Module for HIPAA
SoftwareAG.IS.HIPAA.CodeSourceCache
SoftwareAG.IS.HIPAA.DefaultCache
webMethods RosettaNet Module
SoftwareAG.IS.RosettaNet.RNModelSessionCache
webMethods Event Routing
eventTypeQName
webMethods Integration Server
SoftwareAG.IS.Core.ActiveOpenIDRequests
SoftwareAG.IS.Core.ClusterMembers
SoftwareAG.IS.Core.IteratorHandles
SoftwareAG.IS.Core.IteratorResults
SoftwareAG.IS.Core.NonceCache
SoftwareAG.IS.Core.OAuthAccessTokens
SoftwareAG.IS.Core.OAuthAuthCodes
SoftwareAG.IS.Core.OAuthClients
SoftwareAG.IS.Core.OAuthRefreshTokens
SoftwareAG.IS.Core.OAuthScope
SoftwareAG.IS.Core.OAuthTokens
SoftwareAG.IS.Core.SessionStore
SoftwareAG.IS.Core.XMLParser.Partitions
SoftwareAG.IS.Services.ServiceResults
webMethods Mediator
SoftwareAg.IS.Mediator.APIKeysCache
SoftwareAG.IS.Mediator.APIPortalCommunicationCache
SoftwareAG.IS.Mediator.ClusterStatusCache
SoftwareAG.IS.Mediator.ConsumerApplicationsCache
SoftwareAG.IS.Mediator.ESCommunicationCache
SoftwareAG.IS.Mediator.IntervalNotificationCache
SoftwareAG.IS.Mediator.MetricAccumulatorCache
SoftwareAG.IS.Mediator.OAuth2TokensCache
SoftwareAG.IS.Mediator.RegisteredConsumerNamesCache
SoftwareAG.IS.Mediator.RuntimeAliasesCache
SoftwareAG.IS.Mediator.RuntimeAliasesServicesAssociationCache
SoftwareAG.IS.Mediator.RuntimePolicyCache
SoftwareAG.IS.Mediator.VirtualServicesCache
webMethods Mobile Support
SoftwareAG.IS.MobileSupport.RecordLocker
webMethods OneData
SoftwareAG.OneData.core.cacheName
webMethods Optimize
Metadata Caches
sag.opt.clusterable.caches.deployed/dimensiondef
sag.opt.clusterable.caches.deployed/dimensiondef-BASE_TYPE
sag.opt.clusterable.caches.deployed/dimensiondef-DISPLAY_NAME
sag.opt.clusterable.caches.deployed/dimensiondef-ID
sag.opt.clusterable.caches.deployed/dimensiondef-NAME
sag.opt.clusterable.caches.deployed/dimensionfilter
sag.opt.clusterable.caches.deployed/dimensionjoin
sag.opt.clusterable.caches.deployed/dimensionjoin-DISPLAY_NAME
sag.opt.clusterable.caches.deployed/dimensionjoin-ID
sag.opt.clusterable.caches.deployed/dimensionjoin-NAME
sag.opt.clusterable.caches.deployed/dimensionsubscriber
sag.opt.clusterable.caches.deployed/eventmap
sag.opt.clusterable.caches.deployed/eventmap-BASE_TYPE
sag.opt.clusterable.caches.deployed/eventmap-DISPLAY_NAME
sag.opt.clusterable.caches.deployed/eventmap-ID
sag.opt.clusterable.caches.deployed/eventmap-NAME
sag.opt.clusterable.caches.deployed/hierarchydef
sag.opt.clusterable.caches.deployed/hierarchydef-DISPLAY_NAME
sag.opt.clusterable.caches.deployed/hierarchydef-ID
sag.opt.clusterable.caches.deployed/hierarchydef-NAME
sag.opt.clusterable.caches.deployed/ilink
sag.opt.clusterable.caches.deployed/kpidef
sag.opt.clusterable.caches.deployed/kpidef-DISPLAY_NAME
sag.opt.clusterable.caches.deployed/kpidef-EVENT_MAP_NAME
sag.opt.clusterable.caches.deployed/kpidef-ID
sag.opt.clusterable.caches.deployed/kpidef-NAME
sag.opt.clusterable.caches.deployed/rule
sag.opt.clusterable.caches.deployed/rule-DISPLAY_NAME
sag.opt.clusterable.caches.deployed/rule-ID
sag.opt.clusterable.caches.deployed/rule-NAME
sag.opt.clusterable.caches.latest/dimensiondef
sag.opt.clusterable.caches.latest/dimensiondef-BASE_TYPE
sag.opt.clusterable.caches.latest/dimensiondef-DISPLAY_NAME
sag.opt.clusterable.caches.latest/dimensiondef-ID
sag.opt.clusterable.caches.latest/dimensiondef-NAME
sag.opt.clusterable.caches.latest/dimensionfilter
sag.opt.clusterable.caches.latest/dimensionjoin
sag.opt.clusterable.caches.latest/dimensionjoin-DISPLAY_NAME
sag.opt.clusterable.caches.latest/dimensionjoin-ID
sag.opt.clusterable.caches.latest/dimensionjoin-NAME
sag.opt.clusterable.caches.latest/dimensionsubscriber
sag.opt.clusterable.caches.latest/eventmap
sag.opt.clusterable.caches.latest/eventmap-BASE_TYPE
sag.opt.clusterable.caches.latest/eventmap-DISPLAY_NAME
sag.opt.clusterable.caches.latest/eventmap-ID
sag.opt.clusterable.caches.latest/eventmap-NAME
sag.opt.clusterable.caches.latest/hierarchydef
sag.opt.clusterable.caches.latest/hierarchydef-DISPLAY_NAME
sag.opt.clusterable.caches.latest/hierarchydef-ID
sag.opt.clusterable.caches.latest/hierarchydef-NAME
sag.opt.clusterable.caches.latest/ilinkdef
sag.opt.clusterable.caches.latest/kpidef
sag.opt.clusterable.caches.latest/kpidef-DISPLAY_NAME
sag.opt.clusterable.caches.latest/kpidef-EVENT_MAP_NAME
sag.opt.clusterable.caches.latest/kpidef-ID
sag.opt.clusterable.caches.latest/kpidef-NAME
sag.opt.clusterable.caches.latest/rule
sag.opt.clusterable.caches.latest/rule-DISPLAY_NAME
sag.opt.clusterable.caches.latest/rule-ID
sag.opt.clusterable.caches.latest/rule-NAME
Operational Caches
sag.opt.clusterable.caches.AcceptedJMSMessageIdsCache
sag.opt.clusterable.caches.deleteAllKPIsCache
sag.opt.clusterable.caches.kpiCompInstStateCache
sag.opt.clusterable.caches.kpiInstStateCache
sag.opt.clusterable.caches.KPIISID2ID_IndexCache
sag.opt.clusterable.caches.kpiLastProcTimeCache
sag.opt.clusterable.caches.kpiLockCache
sag.opt.clusterable.caches.KPIN2IIDS_IndexCache
sag.opt.clusterable.caches.KPIN2MIDS_IndexCache
sag.opt.clusterable.caches.LIID2CIID_IndexCache
sag.opt.clusterable.caches.lockCache
sag.opt.clusterable.caches.metadataDefinitionLoadLockCache
sag.opt.clusterable.caches.metadataOpsLockCache
sag.opt.clusterable.caches.monitorCache
sag.opt.clusterable.caches.monitorChangeInFlightCache
sag.opt.clusterable.caches.monitorLastReadingTimeCache
sag.opt.clusterable.caches.OptAEClusterMemberCache
sag.opt.clusterable.caches.optimizeAlgorithmStateCache
sag.opt.clusterable.caches.optimizeDiagnosesCache
sag.opt.clusterable.caches.optimizeDimensionEnabledStateCache
sag.opt.clusterable.caches.optimizeDimensionIndexByStringIdCache
sag.opt.clusterable.caches.optimizeDimensionOpsCache
sag.opt.clusterable.caches.optimizeDimensionOpsIndexByDimKeyCache
sag.opt.clusterable.caches.optimizeDimensionOpsIndexByDimNameCache
sag.opt.clusterable.caches.optimizeDimensionOpsIndexByIdentityCache
sag.opt.clusterable.caches.optimizeROStatsOpsCache
sag.opt.clusterable.caches.optimizeStatsAccumulationOpsCache
sag.opt.clusterable.caches.OreEvaluatorCache
sag.opt.clusterable.caches.OreEvaluatorIndex_EMID2RIIDS
sag.opt.clusterable.caches.OreEvaluatorIndex_ET2RIIDS
sag.opt.clusterable.caches.OreEvaluatorIndex_KMID2RIIDS
sag.opt.clusterable.caches.OreStubCache
sag.opt.clusterable.caches.OreStubCache_RDID2RIID
sag.opt.clusterable.caches.OreStubCache_RISID2RIID
sag.opt.clusterable.caches.OreStubIndex_EMID2RIIDS
sag.opt.clusterable.caches.OreStubIndex_KMID2RIIDS
sag.opt.clusterable.caches.pt_cluster_member_cache
sag.opt.clusterable.caches.pt_partitionTableCache
sag.opt.clusterable.caches.ScheduledKPIInstanceDeletionJobs
Locally Persistent Operational Caches
sag.opt.eventhandling.caches.EventsForStorage
sag.opt.eventhandling.caches.PendingEventLists
sag.opt.eventhandling.caches.TaskObserver_MessagesCache
sag.opt.eventhandling.caches.TaskObserver_TasksCache
sag.opt.eventhandling.caches.TempEventsForStorage
sag.opt.jmscommunication.caches.JMSCommunicationResendCache
sag.opt.notifications.caches.dimensionDefNotificationsCache
sag.opt.notifications.caches.dimSubscriberNotificationsCache
sag.opt.notifications.caches.eventMapNotificationsCache
sag.opt.notifications.caches.kpiDefNotificationsCache
sag.opt.notifications.caches.monitorChangeNotificationsCache
sag.opt.notifications.caches.ptRoutingTableNotificationsCache
sag.opt.notifications.caches.ruleDefNotificationsCache
webMethods Trading Networks
SoftwareAG.IS.TN.TNDocAttribute
SoftwareAG.IS.TN.TNDocType
SoftwareAG.IS.TN.TNProfile
SoftwareAG.IS.TN.TNProfileId
SoftwareAG.IS.TN.TNProfileSummary
SoftwareAG.IS.TN.TNProfileSummaryByDispName
SoftwareAG.IS.TN.TNQueryResults
SoftwareAG.IS.TN.TNTPA
SoftwareAG.IS.TN.TNTPAId
webMethods OneData Consolidation MDM Guide
About this Guide
Document Conventions
Online Information and Support
Data Protection
Introduction to OneData MDM
Overview of Customer MDM
Customer Consolidation
Summary of Configuration Steps
Using Trillium
Installing Trillium
Integrating Trillium with OneData
Creating Projects in Trillium
Deploying Trillium V13 Templates
Creating a Cleansing Project in Trillium
Creating a Matching Project in Trillium
Configuring a B2B Template for Trillium
Creating Data Quality Services in Trillium
Creating the Cleanser Service in Trillium
Trillium Cleanser Service
Creating a Matcher Service in Trillium
Trillium Matcher Service
Using Integration Server
Using webMethods Integration Server as the Data Quality Server
The Cleanser Service in Integration Server
The Matcher Service in Integration Server
About Sample Data Quality Services in wmOneData Package
Data Quality Data Objects
The Consolidation Process
The Matching Process
Using Survivorship Rules
Creating a Data Object for the Consolidation Gold Table
Creating a Data Object for Consolidation (Staging)
Disabling the Data Quality Process for Manual Data Entry
Working with Consolidation Projects
Consolidation Projects
Working with Cleansing Projects for Consolidation (Staging) Objects
Creating a Cleansing Project
Defining Attributes in a Cleansing Project
Defining Project-Object Mapping Based on a Cleansing Project
Defining Project-Object Mapping for a Locate Cleansing Project
Configuring a Consolidation (Staging) Object for Cleansed Records Pending Review
Configuring Locate Threshold Mapping Rules for Locate Cleansing Projects
Windowkeys
Working with Matching Projects for Consolidation (Staging) Objects
Creating a Matching Project
Defining Attribute Mappings for Data Quality Matching Projects
Defining Rules and Rule Mappings for a OneData Matching Project
The Default OneData Matcher Rules and Attributes
Adding Windowkeys to OneData Matching Projects
Mapping a Matching Project to Consolidation (Staging) and Consolidation Gold Objects
Deleting a Project
Configuring Matching
Matching Hint Mapping
Defining a Pattern
Configuring the Matching Threshold
Defining the Matching Threshold
Data Interchange Mappings
Interchange Mappings
Defining Interchange Mappings to Load Data from External Sources to the Consolidation (Staging) Object
Defining Interchange Mappings from the Consolidation (Staging) Object to a Gold Object
Pattern Mapping on the Consolidation (Staging) Object
Configuring Pattern Mapping
Cleansing and Matching Projects for the Consolidation Gold Object
The Batch Cleansing and Matching Processes
Setting the Number of Records Processed in Batch Cleansing and Matching
Executing the Batch Cleansing Process in Threaded Mode
Executing a Batch Cleansing Process
Executing the Batch Matching Process in Threaded Mode
Executing a Batch Matching Process
Configuring Country Information for Cleansing Input
Survivorship
What is Survivorship?
Configuring Survivorship Rules in OneData
Default Survivorship Rules
Defining Default Survivorship Rules
Defining Survivorship Rules for Survivorship Type webMethods
Multiple Gold Mapping
The Customer MDM Multiple Gold Model (One-to-Many Mapping)
Mapping Gold Models
Logging
Viewing Audit Logs
Notifications
Data Quality Notification Email
The Data Quality Inbox
Using the Data Quality Inbox
Merging Consolidation Object Columns to Linked Gold Records
Data Quality Hooks
Customer Consolidation in Incremental Mode
Data Quality Server APIs
Using Other Data Quality Servers
Using REST APIs for Data Quality Consolidation
Overview
Data Quality APIs
API to Cleanse External Data
API for Data Match on Single Rule
API for Data Match on Multiple Rules
API for Cleanser
API for Cleanser on Object
API for Cleanser on Project
API for Matcher
API for Matcher on Object
API for Matcher on Project
API for Matcher on Rule
Data Quality Services
WmDataQuality Package pub.dq Services
pub.dq:simpleMultiMatch
pub.dq:singleMatch
pub.dq:weightedMultiMatch
Matching Algorithms and Use Cases
OneData Matching API
Similarity Functions
Character-Based Similarity Functions
Token-Based Similarity Functions
Hybrid Similarity Functions
Use Cases and Similarity Function Recommendations
Legal Notices
Copyright
Managing Master Data with webMethods OneData
Copyright
to-landing_page
to-about_this_guide_ag
to-configuring_security
to-configuring_ssl
to-customizing_onedata
to-configuring_connections
to-installing_and_configuring_elasticsearch
to-configuring_viewing_service_layer_logs
to-asynchronous_messaging
to-clustering
to-configuring_memory
to-working_with_metadata
to-configuring_locate
to-using_docker_containers_for_onedata
to-configuring_environments
to-appendix_onedata_properties
to-appendix_onedata_features_not_supported_on_sql_server
to-about_this_guide_ig
to-creating_objects
to-object_structure
to-configuring_object_properties
to-viewing_system_objects
to-managing_constraints_in_objects
to-working_with_archive_snapshot_object
to-working_with_projects
to-change_request
to-workflow
to-external_workflow
to-data_validation_in_onedata
to-import_jobs
to-interchange_mapping
to-export_jobs
to-scheduling_jobs_through_job_center
to-translating_data_types
to-extending
to-about_this_guide_ug
to-introduction_to_onedata
to-onedata_users
to-personalizing_onedata
to-filtering_data_in_onedata
to-versioning
to-working_with_non-relational_objects_in_default_mode
to-working_with_relational_objects_in_default_mode
to-working_with_non-relational_objects_in_nova_mode
to-working_with_relational_objects_in_nova_mode
to-working_with_the_new_ui
to-working_with_objects_in_flex_mode
to-working_with_reports
to-managing_workflow
to-importing_data_into_objects
to-advanced_object_properties
to-about_this_guide_dg
to-hooks_in_onedata
to-process_flow_designer
to-api_functions
to-rest_services
to-memory
to-about_this_guide
to-webm_products_using_terracotta
to-licensingRequirements
to-installing_terracotta_server_array
to-using_cc_to_manage
to-system_cache
to-about_this_guide_cmdm
re-document_conventions
re-online_information
to-data_protection
to-overview
to-trillium
to-using_integration_server
to-data_objects
to-projects
to-matching
to-data_interchange_mappings
to-survivorship
to-mulitple_gold_mapping
to-dq_server_apis
to-using_rest_apis_for_data_quality_consolidation
to-appendix-data-quality-services
to-appendix-matching-algorithms-and-use-cases
to-online-copyright-page