Skip to main content
Skip table of contents

Property Extraction

The Property Extraction configuration enables automatic extraction of metadata from interface raw data and maps it to structured properties for reporting and analysis. This feature allows you to capture technical details like web proxies, communication users and identifiers directly from interface configurations.

Purpose: Configure automated extraction rules that parse interface raw data and populate property fields, enabling consistent metadata capture across integration platforms without manual enrichment workflows.

Navigate to SettingsConfigurationProperty Extraction to manage your extraction rules using regex patterns and field mapping techniques.


Property Extraction Overview

image-20250829-085433.png

Property Extraction interface with ID, Copy tabs and columns for Interface Type, Search & Extract Patterns and Target Property

What you see in the interface:

  • Extraction method tabs (ID from Description/Name, Copy from Field) for different extraction approaches

  • Interface Type column with dropdown selection for supported interface types

  • Pattern configuration fields for regex-based extraction rules

  • Target Property mapping to assign extracted values to configured properties

  • Add/Remove controls (+ and - buttons) for managing extraction rules


Configuration and Management

ID from Description/Name

  • Search Pattern (Regex) - Define pattern to locate data in interface names/descriptions

  • Extract Pattern (Regex) - Specify extraction pattern to capture specific values

  • Target Property - Map extracted data to configured property fields

image-20250829-085531.png

ID from Description/Name configuration showing Interface Types (SAP_IS_CI, SAP_IDOC) with regex patterns like GLIF, BEE and extraction patterns \b\d{8}\b targeting Global Interface ID and BeeID properties


Common Extraction Patterns

Interface Identifiers
NONE
# Extract 8-digit numeric IDs (like Global Interface IDs)
\b\d{8}\b
# Example: "SAP_ORDER_12345678_PROCESS" → extracts "12345678"

# Extract 6-digit BeeIDs  
\b\d{6}\b
# Example: "BEE_FINANCE_654321" → extracts "654321"

# Extract alphanumeric codes with prefix
[A-Z]{2,4}-\d{4,8}
# Example: "API-2024-001" → extracts "API-2024"

# Extract GUID patterns
[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}
# Example: "Interface_a1b2c3d4-e5f6-7g8h-9i0j-k1l2m3n4o5p6" → extracts "a1b2c3d4-e5f6-7g8h-9i0j-k1l2m3n4o5p6"
Business Identifiers
CODE
# Extract domain/business area from interface names
(Finance|HR|Sales|Logistics|CRM|ERP)
# Example: "Finance_CustomerData_API" → extracts "Finance"

# Extract environment indicators
(DEV|TEST|PROD|QAS|STAGING)
# Example: "SAP_CRM_PROD_Interface" → extracts "PROD"

# Extract version numbers
v?\d+\.\d+(\.\d+)?
# Example: "PaymentAPI_v2.1.3" → extracts "v2.1.3"
Search Pattern
CODE
# Find interfaces containing specific keywords
.*(GLIF|BEE|SAP|API).*
# Example: Matches "HR_SAP_Employee_Interface", "BEE_Finance_Export", "Customer_API_Gateway"

# Find interfaces with ID patterns
.*\b\d{6,8}\b.*
# Example: Matches "Process_123456_Daily", "Export_12345678_Batch"

# Find interfaces by naming convention
^[A-Z]{2,4}_.*
# Example: Matches "SAP_OrderProcess", "API_CustomerSync", "ERP_InventoryUpdate"

Copy from Field

  • Source Field - Specify exact field path in interface raw data

  • Target Property - Map field content to configured property

image-20250829-085517.png

Copy from Field configuration showing Interface Types with Source Field paths like RFCdest:GATEWAYHOST mapping to Web Proxy


Common Source Field Syntax

SAP_SOAP Interfaces
  • Syntax: Fieldname:Type:Subject

  • Authentication Examples:

    • AuthenticationMethod.Basic.Username:PROPERTY:BINDING → Extract basic auth username

    • AuthenticationMethod.OAuth2.ClientId:PROPERTY:BINDING → Extract OAuth client ID

    • AuthenticationMethod.Certificate.Subject:PROPERTY:BINDING → Extract certificate subject

  • Proxy Configuration Examples:

    • ProxyHost:PROPERTY:BINDING → Extract proxy server hostname

    • ProxyPort:PROPERTY:BINDING → Extract proxy port number

    • ProxyCredentials.Username:PROPERTY:BINDING → Extract proxy username

  • Service Configuration Examples:

    • ServiceEndpoint.URL:PROPERTY:BINDING → Extract service endpoint URL

    • ServiceTimeout:PROPERTY:BINDING → Extract timeout configuration

    • MessageFormat:PROPERTY:BINDING → Extract message format (XML/JSON)

SAP_RFC/SAP_IDOC Interfaces:
  • Syntax: RFCdest:Fieldname

  • Connection Configuration Examples:

    • RFCdest:GATEWAYHOST → Extract SAP Gateway hostname

    • RFCdest:GATEWAYSERV → Extract SAP Gateway service/port

    • RFCdest:ASHOST → Extract SAP application server hostname

    • RFCdest:SYSNR → Extract SAP system number

  • Authentication Examples:

    • RFCdest:USERNAME → Extract RFC connection username

    • RFCdest:CLIENT → Extract SAP client number

    • RFCdest:LANG → Extract default language setting

  • Load Balancing Examples:

    • RFCdest:MSHOST → Extract message server hostname

    • RFCdest:MSSERV → Extract message server service

    • RFCdest:GROUP → Extract logon group for load balancing

  • Technical Configuration Examples:

    • RFCdest:CODEPAGE → Extract character encoding

    • RFCdest:PCS → Extract partner character set

    • RFCdest:TRACE → Extract RFC trace level setting

  • EDIPHONE Example:

    • EDIPHONE:NAME → Extract IDoc partner number

EDIPHONE refers to the IDoc partner profile in SAP (transaction WE20). The NAME field contains the partner number - typically the logical system name used to route IDocs between systems. Map EDIPHONE:NAME to a property such as Relational Interface ID to capture this value automatically from your IDoc interfaces.


Rule Management

Adding Extraction Rules

  • Select appropriate extraction method tab

  • Click "+" Add button to create new extraction rule

  • Configure Interface Type from supported types dropdown

  • Define extraction criteria using regex patterns or field paths

  • Select Target Property from your configured properties list (dropdown shows all available properties)

  • Click “Save” to apply extraction rules

image-20250829-090256.png

Target Property dropdown showing available configured properties including BeeID, Communication User, Confluence: URL and other defined properties


Removing Extraction Rules

  • Select checkbox next to rules you want to remove

  • Click "-" button to delete selected rules

  • Click Save to confirm changes


Usage and Implementation

Property extraction enables automated metadata capture that flows throughout Integration Cockpit for comprehensive integration governance and reporting.

Implementation Workflow:

  1. Create Properties first in Settings Configuration Properties

  2. Configure extraction rules using the patterns and field paths described above

  3. Run INVENTORY job to apply extraction rules to interface data

  4. Verify extraction in Inventory Interfaces By Property

  5. Use extracted properties for reporting and filtering workflows

Throughout Integration Cockpit, extracted properties support:

  • Reporting and Analytics → Filter interfaces by extracted metadata (web proxies, users)

  • Interface Catalog → Display technical details alongside business metadata

  • Dashboard Organization → Use extracted properties for KPI segmentation

  • Excel Export → Include all properties, tags, and extracted metadata in interface catalogs

  • SharePoint Integration → Export complete interface inventories with extracted properties

Integration with Reporting

After extraction rules process interface data, navigate to Inventory → Interfaces → By Property to filter by extracted values. Export complete catalogs including extracted properties to Excel, or use CPI integration flows to automate interface catalog distribution to SharePoint.

Quick Tip
Test extraction patterns with small interface sets before applying broadly. Use specific regex patterns to avoid false matches, and ensure Target Properties have appropriate formats (STRING for users, URL for endpoints). Run INVENTORY jobs after configuration changes to apply new extraction rules to existing interfaces.


Requirements and Setup

Prerequisites:

  • Properties configured in Settings Configuration Properties before defining extraction rules

  • Supported interface types (SAP_SOAP, SAP_RFC, SAP_IDOC) in your data sources

  • Appropriate property formats matching extracted data types

Technical Requirements:

  • INVENTORY job execution to process extraction rules against interface raw data

  • Data source connectivity for supported interface platforms

  • Regex pattern validation for accurate data extraction

Properties must be configured before they can be used in extraction rule Target Property mappings. The Target Property dropdown will show all available properties from your Properties configuration.


Related Documentation

For comprehensive property extraction and configuration guidance:


Last Updated: March 06, 2026


 

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.