From 035504fe8b5e28c9a36bca1326f649b3b53545ab Mon Sep 17 00:00:00 2001 From: varun-lakhyani Date: Thu, 23 Apr 2026 15:51:27 +0530 Subject: [PATCH 1/3] sap-sf --- .../database/sapsuccessfactors.json | 21 +++ .../database/sapSuccessFactorsConnection.json | 121 +++++++++++++ .../entity/services/databaseService.json | 7 + .../ui/src/constants/ServiceType.constant.ts | 1 + .../api/automations/createWorkflow.ts | 167 ++++++++---------- .../api/services/createDatabaseService.ts | 72 ++++++-- .../createIngestionPipeline.ts | 137 ++++++-------- .../automations/testServiceConnection.ts | 167 ++++++++---------- .../generated/entity/automations/workflow.ts | 167 ++++++++---------- .../ui/src/generated/entity/data/database.ts | 1 + .../generated/entity/data/databaseSchema.ts | 1 + .../generated/entity/data/storedProcedure.ts | 1 + .../ui/src/generated/entity/data/table.ts | 1 + .../database/sapSuccessFactorsConnection.ts | 150 ++++++++++++++++ .../services/connections/serviceConnection.ts | 133 ++++++-------- .../entity/services/databaseService.ts | 72 ++++++-- .../ingestionPipelines/ingestionPipeline.ts | 137 ++++++-------- .../metadataIngestion/testSuitePipeline.ts | 133 ++++++-------- .../generated/metadataIngestion/workflow.ts | 137 ++++++-------- .../ui/src/utils/ServiceUtilClassBase.ts | 1 + 20 files changed, 906 insertions(+), 721 deletions(-) create mode 100644 openmetadata-service/src/main/resources/json/data/testConnections/database/sapsuccessfactors.json create mode 100644 openmetadata-spec/src/main/resources/json/schema/entity/services/connections/database/sapSuccessFactorsConnection.json create mode 100644 openmetadata-ui/src/main/resources/ui/src/generated/entity/services/connections/database/sapSuccessFactorsConnection.ts diff --git a/openmetadata-service/src/main/resources/json/data/testConnections/database/sapsuccessfactors.json b/openmetadata-service/src/main/resources/json/data/testConnections/database/sapsuccessfactors.json new file mode 100644 index 000000000000..af3a0024ca14 --- /dev/null +++ b/openmetadata-service/src/main/resources/json/data/testConnections/database/sapsuccessfactors.json @@ -0,0 +1,21 @@ +{ + "name": "SapSuccessFactors", + "displayName": "SAP SuccessFactors Test Connection", + "description": "This Test Connection validates the access against the SAP SuccessFactors OData API and basic metadata extraction of entity types.", + "steps": [ + { + "name": "CheckAccess", + "description": "Validate that we can properly reach the SAP SuccessFactors OData API and authenticate with the given credentials by fetching the $metadata endpoint.", + "errorMessage": "Failed to connect to SAP SuccessFactors. Please validate the base URL, company ID, and credentials.", + "shortCircuit": true, + "mandatory": true + }, + { + "name": "GetEntities", + "description": "Validate that we can parse the OData $metadata response and discover at least one EntitySet (table).", + "errorMessage": "Failed to parse SAP SuccessFactors $metadata. The response may be empty or malformed.", + "shortCircuit": false, + "mandatory": true + } + ] +} \ No newline at end of file diff --git a/openmetadata-spec/src/main/resources/json/schema/entity/services/connections/database/sapSuccessFactorsConnection.json b/openmetadata-spec/src/main/resources/json/schema/entity/services/connections/database/sapSuccessFactorsConnection.json new file mode 100644 index 000000000000..effbb1c9c7e0 --- /dev/null +++ b/openmetadata-spec/src/main/resources/json/schema/entity/services/connections/database/sapSuccessFactorsConnection.json @@ -0,0 +1,121 @@ +{ + "$id": "https://open-metadata.org/schema/entity/services/connections/database/sapSuccessFactorsConnection.json", + "$schema": "http://json-schema.org/draft-07/schema#", + "title": "SapSuccessFactorsConnection", + "description": "SAP SuccessFactors Connection Config", + "type": "object", + "javaType": "org.openmetadata.schema.services.connections.database.SapSuccessFactorsConnection", + "definitions": { + "sapSuccessFactorsType": { + "description": "Service type.", + "type": "string", + "enum": [ + "SapSuccessFactors" + ], + "default": "SapSuccessFactors" + }, + "authType": { + "description": "Authentication type to connect to SAP SuccessFactors.", + "type": "string", + "enum": [ + "OAuth2Credentials", + "BasicAuth" + ], + "default": "BasicAuth" + } + }, + "properties": { + "type": { + "title": "Service Type", + "description": "Service Type", + "$ref": "#/definitions/sapSuccessFactorsType", + "default": "SapSuccessFactors" + }, + "baseUrl": { + "title": "Base URL", + "description": "SAP SuccessFactors OData API base URL. For example: https://api4.successfactors.com", + "type": "string", + "format": "uri" + }, + "companyId": { + "title": "Company ID", + "description": "SAP SuccessFactors Company ID (tenant identifier). Required for all API calls.", + "type": "string" + }, + "authType": { + "title": "Authentication Type", + "description": "Choose how to authenticate with SAP SuccessFactors OData API.", + "$ref": "#/definitions/authType", + "default": "BasicAuth" + }, + "username": { + "title": "Username", + "description": "SAP SuccessFactors user login name. For BasicAuth: used as the credential username. For OAuth2Credentials: used as the SAML NameID — the user on whose behalf the token is requested. The user must exist in the SF system and be permitted to use the OAuth2 application.", + "type": "string" + }, + "password": { + "title": "Password", + "description": "Password for BasicAuth authentication. Required when authType is BasicAuth.", + "type": "string", + "format": "password" + }, + "clientId": { + "title": "Client ID", + "description": "OAuth2 Client ID. Required when authType is OAuth2Credentials.", + "type": "string" + }, + "privateKey": { + "title": "Private Key", + "description": "PEM-encoded RSA private key used to sign SAML assertions for OAuth2 SAML Bearer flow. Required when authType is OAuth2Credentials.", + "type": "string", + "format": "password" + }, + "tokenUrl": { + "title": "Token URL", + "description": "OAuth2 Token endpoint URL. Required when authType is OAuth2Credentials. For example: https://api4.successfactors.com/oauth/token", + "type": "string", + "format": "uri" + }, + "apiVersion": { + "title": "API Version", + "description": "SAP SuccessFactors OData API version.", + "type": "string", + "default": "v2" + }, + "databaseName": { + "title": "Database Name", + "description": "Optional name to give to the database in OpenMetadata. If left blank, we will use default as the database name.", + "type": "string" + }, + "verifySSL": { + "title": "Verify SSL", + "description": "Client SSL verification.", + "$ref": "../../../../security/ssl/verifySSLConfig.json#/definitions/verifySSL", + "default": "no-ssl" + }, + "sslConfig": { + "title": "SSL Configuration", + "description": "SSL Configuration details.", + "$ref": "../../../../security/ssl/verifySSLConfig.json#/definitions/sslConfig" + }, + "connectionOptions": { + "title": "Connection Options", + "$ref": "../connectionBasicType.json#/definitions/connectionOptions" + }, + "connectionArguments": { + "title": "Connection Arguments", + "$ref": "../connectionBasicType.json#/definitions/connectionArguments" + }, + "tableFilterPattern": { + "title": "Default Table Filter Pattern", + "description": "Regex to only include/exclude tables that matches the pattern.", + "$ref": "../../../../type/filterPattern.json#/definitions/filterPattern" + }, + "supportsMetadataExtraction": { + "title": "Supports Metadata Extraction", + "$ref": "../connectionBasicType.json#/definitions/supportsMetadataExtraction" + } + }, + "required": ["baseUrl", "companyId"], + "additionalProperties": false +} \ No newline at end of file diff --git a/openmetadata-spec/src/main/resources/json/schema/entity/services/databaseService.json b/openmetadata-spec/src/main/resources/json/schema/entity/services/databaseService.json index 8cef874bd934..1c790e5d5735 100644 --- a/openmetadata-spec/src/main/resources/json/schema/entity/services/databaseService.json +++ b/openmetadata-spec/src/main/resources/json/schema/entity/services/databaseService.json @@ -50,6 +50,7 @@ "CustomDatabase", "Dbt", "SapHana", + "SapSuccessFactors", "MongoDB", "Cassandra", "Couchbase", @@ -178,6 +179,9 @@ { "name": "SapHana" }, + { + "name": "SapSuccessFactors" + }, { "name": "MongoDB" }, @@ -325,6 +329,9 @@ { "$ref": "./connections/database/salesforceConnection.json" }, + { + "$ref": "./connections/database/sapSuccessFactorsConnection.json" + }, { "$ref": "./connections/database/singleStoreConnection.json" }, diff --git a/openmetadata-ui/src/main/resources/ui/src/constants/ServiceType.constant.ts b/openmetadata-ui/src/main/resources/ui/src/constants/ServiceType.constant.ts index 54cc752034ef..4c60fa0323c1 100644 --- a/openmetadata-ui/src/main/resources/ui/src/constants/ServiceType.constant.ts +++ b/openmetadata-ui/src/main/resources/ui/src/constants/ServiceType.constant.ts @@ -180,6 +180,7 @@ export const BETA_SERVICES = [ DatabaseServiceType.Ssas, DatabaseServiceType.Epic, DashboardServiceType.Hex, + DatabaseServiceType.SapSuccessFactors, DatabaseServiceType.ServiceNow, DatabaseServiceType.Dremio, MetadataServiceType.Collibra, diff --git a/openmetadata-ui/src/main/resources/ui/src/generated/api/automations/createWorkflow.ts b/openmetadata-ui/src/main/resources/ui/src/generated/api/automations/createWorkflow.ts index a2e7e1f5522c..7268b81fe550 100644 --- a/openmetadata-ui/src/main/resources/ui/src/generated/api/automations/createWorkflow.ts +++ b/openmetadata-ui/src/main/resources/ui/src/generated/api/automations/createWorkflow.ts @@ -236,6 +236,8 @@ export interface RequestConnection { * * Salesforce Connection Config * + * SAP SuccessFactors Connection Config + * * SingleStore Database Connection Config * * Snowflake Connection Config @@ -340,8 +342,6 @@ export interface RequestConnection { * SQL Server Reporting Services (SSRS) provides a set of on-premises tools and services to * create, deploy, and manage paginated reports * - * SAP S/4HANA Connection Config for Embedded Analytics - * * Kafka Connection Config * * Redpanda Connection Config @@ -480,9 +480,6 @@ export interface ConfigObject { * SSL Configuration details. Provide the CA certificate to validate the Informix server * certificate. Paste the PEM content directly or upload the certificate file. * - * CA certificate, client certificate, and private key for SSL validation. Required when - * verifySSL is 'validate'. - * * SSL Configuration for OpenMetadata Server */ sslConfig?: SSLConfigObject; @@ -533,12 +530,9 @@ export interface ConfigObject { /** * Client SSL verification. Make sure to configure the SSLConfig if enabled. * - * Boolean marking if we need to verify the SSL certs for Grafana. Default to True. - * * Client SSL verification. * - * Client SSL verification. Use 'no-ssl' for plain HTTP, 'ignore' to skip certificate - * validation, 'validate' to verify against a CA certificate. + * Boolean marking if we need to verify the SSL certs for Grafana. Default to True. * * Boolean marking if we need to verify the SSL certs for KafkaConnect REST API. True by * default. @@ -679,8 +673,6 @@ export interface ConfigObject { * * Host and Port of the Ssrs instance. * - * Base URL of the SAP S/4HANA instance (e.g. https://s4hana.example.com). - * * Pub/Sub APIs URL. For local testing with the emulator, use http://localhost:8085. * * Pipeline Service Management/UI URI. @@ -904,6 +896,8 @@ export interface ConfigObject { * * Password to connect to Salesforce. * + * Password for BasicAuth authentication. Required when authType is BasicAuth. + * * Password to connect to SingleStore. * * Password to connect to Snowflake. @@ -1000,6 +994,11 @@ export interface ConfigObject { * Username to connect to Salesforce. This user should have privileges to read all the * metadata in Salesforce. * + * SAP SuccessFactors user login name. For BasicAuth: used as the credential username. For + * OAuth2Credentials: used as the SAML NameID — the user on whose behalf the token is + * requested. The user must exist in the SF system and be permitted to use the OAuth2 + * application. + * * Username to connect to SingleStore. This user should have privileges to read all the * metadata in MySQL. * @@ -1120,13 +1119,12 @@ export interface ConfigObject { * * Choose Auth Configuration Type. * + * Choose how to authenticate with SAP SuccessFactors OData API. + * * Choose between Dremio Cloud (SaaS) or Dremio Software (self-hosted) authentication. * * Types of methods used to authenticate to the tableau instance * - * Choose Basic Auth (username/password) for on-premise or OAuth 2.0 Client Credentials for - * SAP S/4HANA Cloud. - * * Types of methods used to authenticate to the alation instance * * Authentication type to connect to Apache Ranger. @@ -1346,6 +1344,58 @@ export interface ConfigObject { * fetched. Leave empty to fetch all objects (subject to tableFilterPattern). */ sobjectNames?: string[]; + /** + * SAP SuccessFactors OData API version. + * + * Tableau API version. If not provided, the version will be used from the tableau server. + * + * Sigma API version. + * + * ThoughtSpot API version to use + * + * Airbyte API version. + * + * OpenMetadata server API version to use. + */ + apiVersion?: string; + /** + * SAP SuccessFactors OData API base URL. For example: https://api4.successfactors.com + */ + baseUrl?: string; + /** + * OAuth2 Client ID. Required when authType is OAuth2Credentials. + * + * Client ID for DOMO + * + * Azure Application (client) ID for service principal authentication. + * + * Azure Application (client) ID for Service Principal authentication. + * + * User's Client ID. This user should have privileges to read all the metadata in Looker. + * + * client_id for PowerBI. + * + * client_id for Sigma. + * + * Application (client) ID from Azure Active Directory + */ + clientId?: string; + /** + * SAP SuccessFactors Company ID (tenant identifier). Required for all API calls. + */ + companyId?: string; + /** + * PEM-encoded RSA private key used to sign SAML assertions for OAuth2 SAML Bearer flow. + * Required when authType is OAuth2Credentials. + * + * Connection to Snowflake instance via Private Key + */ + privateKey?: string; + /** + * OAuth2 Token endpoint URL. Required when authType is OAuth2Credentials. For example: + * https://api4.successfactors.com/oauth/token + */ + tokenUrl?: string; /** * If the Snowflake URL is https://xyz1234.us-east-1.gcp.snowflakecomputing.com, then the * account is xyz1234.us-east-1.gcp @@ -1382,10 +1432,6 @@ export interface ConfigObject { * TRANSIENT tables. */ includeTransientTables?: boolean; - /** - * Connection to Snowflake instance via Private Key - */ - privateKey?: string; /** * Session query tag used to monitor usage on snowflake. To use a query tag snowflake user * should have enough privileges to alter the session. @@ -1439,22 +1485,6 @@ export interface ConfigObject { * API Host to connect to DOMO instance */ apiHost?: string; - /** - * Client ID for DOMO - * - * Azure Application (client) ID for service principal authentication. - * - * Azure Application (client) ID for Service Principal authentication. - * - * User's Client ID. This user should have privileges to read all the metadata in Looker. - * - * client_id for PowerBI. - * - * client_id for Sigma. - * - * Application (client) ID from Azure Active Directory - */ - clientId?: string; /** * URL of your Domo instance, e.g., https://openmetadata.domo.com */ @@ -1688,18 +1718,6 @@ export interface ConfigObject { * Version of the Redash instance */ redashVersion?: string; - /** - * Tableau API version. If not provided, the version will be used from the tableau server. - * - * Sigma API version. - * - * ThoughtSpot API version to use - * - * Airbyte API version. - * - * OpenMetadata server API version to use. - */ - apiVersion?: string; /** * Proxy URL for the tableau server. If not provided, the hostPort will be used. This is * used to generate the dashboard & Chart URL. @@ -1807,10 +1825,6 @@ export interface ConfigObject { * Type of token to use for authentication */ tokenType?: TokenType; - /** - * SAP client number (Mandant), typically a 3-digit string (e.g. '100'). - */ - clientNumber?: string; /** * basic.auth.user.info schema registry config property, Client HTTP credentials in the form * of username:password. @@ -2553,13 +2567,6 @@ export enum AuthProvider { * * Access Token Auth Credentials * - * Choose Basic Auth (username/password) for on-premise or OAuth 2.0 Client Credentials for - * SAP S/4HANA Cloud. - * - * Username and password credentials for SAP S/4HANA. - * - * OAuth 2.0 client credentials for SAP S/4HANA Cloud. - * * ThoughtSpot authentication configuration * * Types of methods used to authenticate to the alation instance @@ -2597,15 +2604,11 @@ export interface AuthenticationType { /** * Service Principal Application ID created in your Databricks Account Console for OAuth * Machine-to-Machine authentication. - * - * OAuth 2.0 client ID registered in SAP. */ clientId?: string; /** * OAuth Secret generated for the Service Principal in Databricks Account Console. Used for * secure OAuth2 authentication. - * - * OAuth 2.0 client secret. */ clientSecret?: string; /** @@ -2629,8 +2632,6 @@ export interface AuthenticationType { * * Password to access the service. * - * Password to authenticate with SAP S/4HANA. - * * Elastic Search Password for Login * * Ranger password to authenticate to the API. @@ -2682,8 +2683,6 @@ export interface AuthenticationType { * * Username to access the service. * - * Username to authenticate with SAP S/4HANA. - * * Elastic Search Username for Login * * Ranger user to authenticate to the API. @@ -2699,14 +2698,6 @@ export interface AuthenticationType { * Personal Access Token Secret. */ personalAccessTokenSecret?: string; - /** - * Authentication type identifier. - */ - authType?: AuthType; - /** - * OAuth 2.0 token endpoint URL (e.g. /sap/bc/security/oauth2/token). - */ - tokenEndpoint?: string; /** * Access Token for the API */ @@ -2775,14 +2766,6 @@ export interface AuthenticationType { privateKeyPassphrase?: string; } -/** - * Authentication type identifier. - */ -export enum AuthType { - Basic = "basic", - Oauth2 = "oauth2", -} - /** * AWS credentials required to access the S3 file. * @@ -3036,10 +3019,16 @@ export enum CloudRegion { } /** + * Choose how to authenticate with SAP SuccessFactors OData API. + * + * Authentication type to connect to SAP SuccessFactors. + * * Database Authentication types not requiring config. */ export enum NoConfigAuthenticationTypes { + BasicAuth = "BasicAuth", OAuth2 = "OAuth2", + OAuth2Credentials = "OAuth2Credentials", } /** @@ -3250,9 +3239,6 @@ export enum KafkaSecurityProtocol { * SSL Configuration details. Provide the CA certificate to validate the Informix server * certificate. Paste the PEM content directly or upload the certificate file. * - * CA certificate, client certificate, and private key for SSL validation. Required when - * verifySSL is 'validate'. - * * Consumer Config SSL Config. Configuration for enabling SSL for the Consumer Config * connection. * @@ -3996,9 +3982,6 @@ export enum ConnectionScheme { * SSL Configuration details. Provide the CA certificate to validate the Informix server * certificate. Paste the PEM content directly or upload the certificate file. * - * CA certificate, client certificate, and private key for SSL validation. Required when - * verifySSL is 'validate'. - * * Consumer Config SSL Config. Configuration for enabling SSL for the Consumer Config * connection. * @@ -4061,9 +4044,6 @@ export enum ConnectionType { * * Client SSL verification. * - * Client SSL verification. Use 'no-ssl' for plain HTTP, 'ignore' to skip certificate - * validation, 'validate' to verify against a CA certificate. - * * Flag to verify SSL Certificate for OpenMetadata Server. */ export enum VerifySSL { @@ -4762,9 +4742,6 @@ export enum SpaceType { * SSL Configuration details. Provide the CA certificate to validate the Informix server * certificate. Paste the PEM content directly or upload the certificate file. * - * CA certificate, client certificate, and private key for SSL validation. Required when - * verifySSL is 'validate'. - * * Consumer Config SSL Config. Configuration for enabling SSL for the Consumer Config * connection. * @@ -4908,8 +4885,6 @@ export enum TokenType { * * Grafana service type * - * SAP S/4HANA service type - * * Kafka service type * * Redpanda service type @@ -5060,7 +5035,7 @@ export enum ConfigType { Salesforce = "Salesforce", SapERP = "SapErp", SapHana = "SapHana", - SapS4Hana = "SapS4Hana", + SapSuccessFactors = "SapSuccessFactors", ServiceNow = "ServiceNow", SharePoint = "SharePoint", Sigma = "Sigma", diff --git a/openmetadata-ui/src/main/resources/ui/src/generated/api/services/createDatabaseService.ts b/openmetadata-ui/src/main/resources/ui/src/generated/api/services/createDatabaseService.ts index c647ea214c63..fe835dbc0c01 100644 --- a/openmetadata-ui/src/main/resources/ui/src/generated/api/services/createDatabaseService.ts +++ b/openmetadata-ui/src/main/resources/ui/src/generated/api/services/createDatabaseService.ts @@ -107,6 +107,8 @@ export interface DatabaseConnection { * * Salesforce Connection Config * + * SAP SuccessFactors Connection Config + * * SingleStore Database Connection Config * * Snowflake Connection Config @@ -463,6 +465,8 @@ export interface Connection { * * Password to connect to Salesforce. * + * Password for BasicAuth authentication. Required when authType is BasicAuth. + * * Password to connect to SingleStore. * * Password to connect to Snowflake. @@ -545,6 +549,11 @@ export interface Connection { * Username to connect to Salesforce. This user should have privileges to read all the * metadata in Salesforce. * + * SAP SuccessFactors user login name. For BasicAuth: used as the credential username. For + * OAuth2Credentials: used as the SAML NameID — the user on whose behalf the token is + * requested. The user must exist in the SF system and be permitted to use the OAuth2 + * application. + * * Username to connect to SingleStore. This user should have privileges to read all the * metadata in MySQL. * @@ -646,6 +655,8 @@ export interface Connection { * * Choose Auth Configuration Type. * + * Choose how to authenticate with SAP SuccessFactors OData API. + * * Choose between Dremio Cloud (SaaS) or Dremio Software (self-hosted) authentication. */ authType?: AuthenticationType | NoConfigAuthenticationTypes; @@ -853,6 +864,44 @@ export interface Connection { * fetched. Leave empty to fetch all objects (subject to tableFilterPattern). */ sobjectNames?: string[]; + /** + * SAP SuccessFactors OData API version. + */ + apiVersion?: string; + /** + * SAP SuccessFactors OData API base URL. For example: https://api4.successfactors.com + */ + baseUrl?: string; + /** + * OAuth2 Client ID. Required when authType is OAuth2Credentials. + * + * Client ID for DOMO + * + * Azure Application (client) ID for service principal authentication. + * + * Azure Application (client) ID for Service Principal authentication. + */ + clientId?: string; + /** + * SAP SuccessFactors Company ID (tenant identifier). Required for all API calls. + */ + companyId?: string; + /** + * PEM-encoded RSA private key used to sign SAML assertions for OAuth2 SAML Bearer flow. + * Required when authType is OAuth2Credentials. + * + * Connection to Snowflake instance via Private Key + */ + privateKey?: string; + /** + * OAuth2 Token endpoint URL. Required when authType is OAuth2Credentials. For example: + * https://api4.successfactors.com/oauth/token + */ + tokenUrl?: string; + /** + * Client SSL verification. + */ + verifySSL?: VerifySSL; /** * If the Snowflake URL is https://xyz1234.us-east-1.gcp.snowflakecomputing.com, then the * account is xyz1234.us-east-1.gcp @@ -889,10 +938,6 @@ export interface Connection { * TRANSIENT tables. */ includeTransientTables?: boolean; - /** - * Connection to Snowflake instance via Private Key - */ - privateKey?: string; /** * Session query tag used to monitor usage on snowflake. To use a query tag snowflake user * should have enough privileges to alter the session. @@ -944,14 +989,6 @@ export interface Connection { * API Host to connect to DOMO instance */ apiHost?: string; - /** - * Client ID for DOMO - * - * Azure Application (client) ID for service principal authentication. - * - * Azure Application (client) ID for Service Principal authentication. - */ - clientId?: string; /** * URL of your Domo instance, e.g., https://openmetadata.domo.com */ @@ -1023,7 +1060,6 @@ export interface Connection { * Pagination limit used while querying the SAP ERP API for fetching the entities */ paginationLimit?: number; - verifySSL?: VerifySSL; /** * Azure Application client secret for service principal authentication. * @@ -1472,10 +1508,16 @@ export enum CloudRegion { } /** + * Choose how to authenticate with SAP SuccessFactors OData API. + * + * Authentication type to connect to SAP SuccessFactors. + * * Database Authentication types not requiring config. */ export enum NoConfigAuthenticationTypes { + BasicAuth = "BasicAuth", OAuth2 = "OAuth2", + OAuth2Credentials = "OAuth2Credentials", } export interface AuthenticationModeObject { @@ -2267,6 +2309,7 @@ export enum ConfigType { Salesforce = "Salesforce", SapERP = "SapErp", SapHana = "SapHana", + SapSuccessFactors = "SapSuccessFactors", ServiceNow = "ServiceNow", SingleStore = "SingleStore", Snowflake = "Snowflake", @@ -2281,6 +2324,8 @@ export enum ConfigType { } /** + * Client SSL verification. + * * Client SSL verification. Make sure to configure the SSLConfig if enabled. */ export enum VerifySSL { @@ -2397,6 +2442,7 @@ export enum DatabaseServiceType { Salesforce = "Salesforce", SapERP = "SapErp", SapHana = "SapHana", + SapSuccessFactors = "SapSuccessFactors", ServiceNow = "ServiceNow", SingleStore = "SingleStore", Snowflake = "Snowflake", diff --git a/openmetadata-ui/src/main/resources/ui/src/generated/api/services/ingestionPipelines/createIngestionPipeline.ts b/openmetadata-ui/src/main/resources/ui/src/generated/api/services/ingestionPipelines/createIngestionPipeline.ts index a15ca90b2856..61c7022c2745 100644 --- a/openmetadata-ui/src/main/resources/ui/src/generated/api/services/ingestionPipelines/createIngestionPipeline.ts +++ b/openmetadata-ui/src/main/resources/ui/src/generated/api/services/ingestionPipelines/createIngestionPipeline.ts @@ -2300,9 +2300,6 @@ export interface DBTPrefixConfig { * * SSL Configuration details. * - * CA certificate, client certificate, and private key for SSL validation. Required when - * verifySSL is 'validate'. - * * SSL Configuration details for DB2 connection. Provide CA certificate for server * validation, and optionally client certificate and key for mutual TLS authentication. * @@ -2556,9 +2553,6 @@ export interface GCPImpersonateServiceAccountValues { * * Client SSL verification. * - * Client SSL verification. Use 'no-ssl' for plain HTTP, 'ignore' to skip certificate - * validation, 'validate' to verify against a CA certificate. - * * Flag to verify SSL Certificate for OpenMetadata Server. * * SSL/TLS verification mode when fetching dbt artifacts over HTTPS. @@ -2604,10 +2598,6 @@ export interface LineageInformation { * List of Database Service Names for creation of lineage */ dbServiceNames?: string[]; - /** - * List of Messaging Service Names for creation of lineage - */ - messagingServiceNames?: string[]; /** * List of Storage Service Names for creation of lineage */ @@ -3001,8 +2991,6 @@ export interface ServiceConnection { * SQL Server Reporting Services (SSRS) provides a set of on-premises tools and services to * create, deploy, and manage paginated reports * - * SAP S/4HANA Connection Config for Embedded Analytics - * * Google BigQuery Connection Config * * Google BigTable Connection Config @@ -3051,6 +3039,8 @@ export interface ServiceConnection { * * Salesforce Connection Config * + * SAP SuccessFactors Connection Config + * * SingleStore Database Connection Config * * Snowflake Connection Config @@ -3245,9 +3235,6 @@ export interface ConfigObject { /** * SSL Configuration details. * - * CA certificate, client certificate, and private key for SSL validation. Required when - * verifySSL is 'validate'. - * * SSL Configuration details for DB2 connection. Provide CA certificate for server * validation, and optionally client certificate and key for mutual TLS authentication. * @@ -3311,9 +3298,6 @@ export interface ConfigObject { * * Client SSL verification. * - * Client SSL verification. Use 'no-ssl' for plain HTTP, 'ignore' to skip certificate - * validation, 'validate' to verify against a CA certificate. - * * Flag to verify SSL Certificate for OpenMetadata Server. * * Boolean marking if we need to verify the SSL certs for KafkaConnect REST API. True by @@ -3335,6 +3319,8 @@ export interface ConfigObject { * * client_id for Sigma. * + * OAuth2 Client ID. Required when authType is OAuth2Credentials. + * * Azure Application (client) ID for service principal authentication. * * Azure Application (client) ID for Service Principal authentication. @@ -3404,8 +3390,6 @@ export interface ConfigObject { * * Host and Port of the Ssrs instance. * - * Base URL of the SAP S/4HANA instance (e.g. https://s4hana.example.com). - * * BigQuery APIs URL. * * Host and port of the AzureSQL service. @@ -3566,6 +3550,8 @@ export interface ConfigObject { * * Password to connect to Salesforce. * + * Password for BasicAuth authentication. Required when authType is BasicAuth. + * * Password to connect to SingleStore. * * Password to connect to Snowflake. @@ -3665,6 +3651,11 @@ export interface ConfigObject { * Username to connect to Salesforce. This user should have privileges to read all the * metadata in Salesforce. * + * SAP SuccessFactors user login name. For BasicAuth: used as the credential username. For + * OAuth2Credentials: used as the SAML NameID — the user on whose behalf the token is + * requested. The user must exist in the SF system and be permitted to use the OAuth2 + * application. + * * Username to connect to SingleStore. This user should have privileges to read all the * metadata in MySQL. * @@ -3804,6 +3795,8 @@ export interface ConfigObject { * * ThoughtSpot API version to use * + * SAP SuccessFactors OData API version. + * * OpenMetadata server API version to use. * * Airbyte API version. @@ -3812,15 +3805,14 @@ export interface ConfigObject { /** * Types of methods used to authenticate to the tableau instance * - * Choose Basic Auth (username/password) for on-premise or OAuth 2.0 Client Credentials for - * SAP S/4HANA Cloud. - * * Choose between different authentication types for Databricks. * * Choose Auth Config Type. * * Choose Auth Configuration Type. * + * Choose how to authenticate with SAP SuccessFactors OData API. + * * Choose between Dremio Cloud (SaaS) or Dremio Software (self-hosted) authentication. * * Types of methods used to authenticate to the alation instance @@ -3829,7 +3821,7 @@ export interface ConfigObject { * * Authentication method: username/password or SSH private key */ - authType?: AuthenticationType | NoConfigAuthenticationTypes; + authType?: AuthenticationTypeForTableau | NoConfigAuthenticationTypes; /** * Pagination limit used while querying the tableau metadata API for getting data sources * @@ -3971,14 +3963,6 @@ export interface ConfigObject { * Type of token to use for authentication */ tokenType?: TokenType; - /** - * SAP client number (Mandant), typically a 3-digit string (e.g. '100'). - */ - clientNumber?: string; - /** - * Supports Lineage Extraction. - */ - supportsLineageExtraction?: boolean; /** * Billing Project ID */ @@ -4042,9 +4026,13 @@ export interface ConfigObject { supportsDataDiff?: boolean; supportsDBTExtraction?: boolean; supportsIncrementalMetadataExtraction?: boolean; - supportsProfiler?: boolean; - supportsQueryComment?: boolean; - supportsSystemProfile?: boolean; + /** + * Supports Lineage Extraction. + */ + supportsLineageExtraction?: boolean; + supportsProfiler?: boolean; + supportsQueryComment?: boolean; + supportsSystemProfile?: boolean; /** * Supports Usage Extraction. */ @@ -4397,6 +4385,26 @@ export interface ConfigObject { * fetched. Leave empty to fetch all objects (subject to tableFilterPattern). */ sobjectNames?: string[]; + /** + * SAP SuccessFactors OData API base URL. For example: https://api4.successfactors.com + */ + baseUrl?: string; + /** + * SAP SuccessFactors Company ID (tenant identifier). Required for all API calls. + */ + companyId?: string; + /** + * PEM-encoded RSA private key used to sign SAML assertions for OAuth2 SAML Bearer flow. + * Required when authType is OAuth2Credentials. + * + * Connection to Snowflake instance via Private Key + */ + privateKey?: string; + /** + * OAuth2 Token endpoint URL. Required when authType is OAuth2Credentials. For example: + * https://api4.successfactors.com/oauth/token + */ + tokenUrl?: string; /** * If the Snowflake URL is https://xyz1234.us-east-1.gcp.snowflakecomputing.com, then the * account is xyz1234.us-east-1.gcp @@ -4433,10 +4441,6 @@ export interface ConfigObject { * TRANSIENT tables. */ includeTransientTables?: boolean; - /** - * Connection to Snowflake instance via Private Key - */ - privateKey?: string; /** * Session query tag used to monitor usage on snowflake. To use a query tag snowflake user * should have enough privileges to alter the session. @@ -5248,13 +5252,6 @@ export enum AuthProvider { * * Access Token Auth Credentials * - * Choose Basic Auth (username/password) for on-premise or OAuth 2.0 Client Credentials for - * SAP S/4HANA Cloud. - * - * Username and password credentials for SAP S/4HANA. - * - * OAuth 2.0 client credentials for SAP S/4HANA Cloud. - * * Choose between different authentication types for Databricks. * * Personal Access Token authentication for Databricks. @@ -5315,12 +5312,10 @@ export enum AuthProvider { * * SSH private key authentication for SFTP */ -export interface AuthenticationType { +export interface AuthenticationTypeForTableau { /** * Password to access the service. * - * Password to authenticate with SAP S/4HANA. - * * Password to connect to source. * * Database user password. Leave empty if using IAM database authentication. @@ -5337,8 +5332,6 @@ export interface AuthenticationType { /** * Username to access the service. * - * Username to authenticate with SAP S/4HANA. - * * Username for authenticating with Dremio Software. This user should have appropriate * permissions to access metadata. * @@ -5358,32 +5351,20 @@ export interface AuthenticationType { */ personalAccessTokenSecret?: string; /** - * Authentication type identifier. + * Generated Personal Access Token for Databricks workspace authentication. This token is + * created from User Settings -> Developer -> Access Tokens in your Databricks workspace. */ - authType?: AuthType; + token?: string; /** - * OAuth 2.0 client ID registered in SAP. - * * Service Principal Application ID created in your Databricks Account Console for OAuth * Machine-to-Machine authentication. */ clientId?: string; /** - * OAuth 2.0 client secret. - * * OAuth Secret generated for the Service Principal in Databricks Account Console. Used for * secure OAuth2 authentication. */ clientSecret?: string; - /** - * OAuth 2.0 token endpoint URL (e.g. /sap/bc/security/oauth2/token). - */ - tokenEndpoint?: string; - /** - * Generated Personal Access Token for Databricks workspace authentication. This token is - * created from User Settings -> Developer -> Access Tokens in your Databricks workspace. - */ - token?: string; /** * Azure Service Principal Application (client) ID registered in your Azure Active Directory. */ @@ -5502,14 +5483,6 @@ export interface AuthenticationType { privateKeyPassphrase?: string; } -/** - * Authentication type identifier. - */ -export enum AuthType { - Basic = "basic", - Oauth2 = "oauth2", -} - /** * AWS credentials configs. * @@ -5661,10 +5634,16 @@ export enum CloudRegion { } /** + * Choose how to authenticate with SAP SuccessFactors OData API. + * + * Authentication type to connect to SAP SuccessFactors. + * * Database Authentication types not requiring config. */ export enum NoConfigAuthenticationTypes { + BasicAuth = "BasicAuth", OAuth2 = "OAuth2", + OAuth2Credentials = "OAuth2Credentials", } /** @@ -6461,9 +6440,6 @@ export enum ConnectionScheme { * * SSL Configuration details. * - * CA certificate, client certificate, and private key for SSL validation. Required when - * verifySSL is 'validate'. - * * SSL Configuration details for DB2 connection. Provide CA certificate for server * validation, and optionally client certificate and key for mutual TLS authentication. * @@ -7252,9 +7228,6 @@ export enum SpaceType { * * SSL Configuration details. * - * CA certificate, client certificate, and private key for SSL validation. Required when - * verifySSL is 'validate'. - * * SSL Configuration details for DB2 connection. Provide CA certificate for server * validation, and optionally client certificate and key for mutual TLS authentication. * @@ -7408,8 +7381,6 @@ export enum TokenType { * * Service type. * - * SAP S/4HANA service type - * * Custom database service type * * Kafka service type @@ -7565,7 +7536,7 @@ export enum PurpleType { Salesforce = "Salesforce", SapERP = "SapErp", SapHana = "SapHana", - SapS4Hana = "SapS4Hana", + SapSuccessFactors = "SapSuccessFactors", ServiceNow = "ServiceNow", SharePoint = "SharePoint", Sigma = "Sigma", diff --git a/openmetadata-ui/src/main/resources/ui/src/generated/entity/automations/testServiceConnection.ts b/openmetadata-ui/src/main/resources/ui/src/generated/entity/automations/testServiceConnection.ts index 53ae5f5f56aa..23d6de0806a6 100644 --- a/openmetadata-ui/src/main/resources/ui/src/generated/entity/automations/testServiceConnection.ts +++ b/openmetadata-ui/src/main/resources/ui/src/generated/entity/automations/testServiceConnection.ts @@ -118,6 +118,8 @@ export interface TestServiceConnectionConnection { * * Salesforce Connection Config * + * SAP SuccessFactors Connection Config + * * SingleStore Database Connection Config * * Snowflake Connection Config @@ -222,8 +224,6 @@ export interface TestServiceConnectionConnection { * SQL Server Reporting Services (SSRS) provides a set of on-premises tools and services to * create, deploy, and manage paginated reports * - * SAP S/4HANA Connection Config for Embedded Analytics - * * Kafka Connection Config * * Redpanda Connection Config @@ -362,9 +362,6 @@ export interface ConfigObject { * SSL Configuration details. Provide the CA certificate to validate the Informix server * certificate. Paste the PEM content directly or upload the certificate file. * - * CA certificate, client certificate, and private key for SSL validation. Required when - * verifySSL is 'validate'. - * * SSL Configuration for OpenMetadata Server */ sslConfig?: SSLConfigObject; @@ -415,12 +412,9 @@ export interface ConfigObject { /** * Client SSL verification. Make sure to configure the SSLConfig if enabled. * - * Boolean marking if we need to verify the SSL certs for Grafana. Default to True. - * * Client SSL verification. * - * Client SSL verification. Use 'no-ssl' for plain HTTP, 'ignore' to skip certificate - * validation, 'validate' to verify against a CA certificate. + * Boolean marking if we need to verify the SSL certs for Grafana. Default to True. * * Boolean marking if we need to verify the SSL certs for KafkaConnect REST API. True by * default. @@ -561,8 +555,6 @@ export interface ConfigObject { * * Host and Port of the Ssrs instance. * - * Base URL of the SAP S/4HANA instance (e.g. https://s4hana.example.com). - * * Pub/Sub APIs URL. For local testing with the emulator, use http://localhost:8085. * * Pipeline Service Management/UI URI. @@ -786,6 +778,8 @@ export interface ConfigObject { * * Password to connect to Salesforce. * + * Password for BasicAuth authentication. Required when authType is BasicAuth. + * * Password to connect to SingleStore. * * Password to connect to Snowflake. @@ -882,6 +876,11 @@ export interface ConfigObject { * Username to connect to Salesforce. This user should have privileges to read all the * metadata in Salesforce. * + * SAP SuccessFactors user login name. For BasicAuth: used as the credential username. For + * OAuth2Credentials: used as the SAML NameID — the user on whose behalf the token is + * requested. The user must exist in the SF system and be permitted to use the OAuth2 + * application. + * * Username to connect to SingleStore. This user should have privileges to read all the * metadata in MySQL. * @@ -1002,13 +1001,12 @@ export interface ConfigObject { * * Choose Auth Configuration Type. * + * Choose how to authenticate with SAP SuccessFactors OData API. + * * Choose between Dremio Cloud (SaaS) or Dremio Software (self-hosted) authentication. * * Types of methods used to authenticate to the tableau instance * - * Choose Basic Auth (username/password) for on-premise or OAuth 2.0 Client Credentials for - * SAP S/4HANA Cloud. - * * Types of methods used to authenticate to the alation instance * * Authentication type to connect to Apache Ranger. @@ -1228,6 +1226,58 @@ export interface ConfigObject { * fetched. Leave empty to fetch all objects (subject to tableFilterPattern). */ sobjectNames?: string[]; + /** + * SAP SuccessFactors OData API version. + * + * Tableau API version. If not provided, the version will be used from the tableau server. + * + * Sigma API version. + * + * ThoughtSpot API version to use + * + * Airbyte API version. + * + * OpenMetadata server API version to use. + */ + apiVersion?: string; + /** + * SAP SuccessFactors OData API base URL. For example: https://api4.successfactors.com + */ + baseUrl?: string; + /** + * OAuth2 Client ID. Required when authType is OAuth2Credentials. + * + * Client ID for DOMO + * + * Azure Application (client) ID for service principal authentication. + * + * Azure Application (client) ID for Service Principal authentication. + * + * User's Client ID. This user should have privileges to read all the metadata in Looker. + * + * client_id for PowerBI. + * + * client_id for Sigma. + * + * Application (client) ID from Azure Active Directory + */ + clientId?: string; + /** + * SAP SuccessFactors Company ID (tenant identifier). Required for all API calls. + */ + companyId?: string; + /** + * PEM-encoded RSA private key used to sign SAML assertions for OAuth2 SAML Bearer flow. + * Required when authType is OAuth2Credentials. + * + * Connection to Snowflake instance via Private Key + */ + privateKey?: string; + /** + * OAuth2 Token endpoint URL. Required when authType is OAuth2Credentials. For example: + * https://api4.successfactors.com/oauth/token + */ + tokenUrl?: string; /** * If the Snowflake URL is https://xyz1234.us-east-1.gcp.snowflakecomputing.com, then the * account is xyz1234.us-east-1.gcp @@ -1264,10 +1314,6 @@ export interface ConfigObject { * TRANSIENT tables. */ includeTransientTables?: boolean; - /** - * Connection to Snowflake instance via Private Key - */ - privateKey?: string; /** * Session query tag used to monitor usage on snowflake. To use a query tag snowflake user * should have enough privileges to alter the session. @@ -1321,22 +1367,6 @@ export interface ConfigObject { * API Host to connect to DOMO instance */ apiHost?: string; - /** - * Client ID for DOMO - * - * Azure Application (client) ID for service principal authentication. - * - * Azure Application (client) ID for Service Principal authentication. - * - * User's Client ID. This user should have privileges to read all the metadata in Looker. - * - * client_id for PowerBI. - * - * client_id for Sigma. - * - * Application (client) ID from Azure Active Directory - */ - clientId?: string; /** * URL of your Domo instance, e.g., https://openmetadata.domo.com */ @@ -1570,18 +1600,6 @@ export interface ConfigObject { * Version of the Redash instance */ redashVersion?: string; - /** - * Tableau API version. If not provided, the version will be used from the tableau server. - * - * Sigma API version. - * - * ThoughtSpot API version to use - * - * Airbyte API version. - * - * OpenMetadata server API version to use. - */ - apiVersion?: string; /** * Proxy URL for the tableau server. If not provided, the hostPort will be used. This is * used to generate the dashboard & Chart URL. @@ -1689,10 +1707,6 @@ export interface ConfigObject { * Type of token to use for authentication */ tokenType?: TokenType; - /** - * SAP client number (Mandant), typically a 3-digit string (e.g. '100'). - */ - clientNumber?: string; /** * basic.auth.user.info schema registry config property, Client HTTP credentials in the form * of username:password. @@ -2435,13 +2449,6 @@ export enum AuthProvider { * * Access Token Auth Credentials * - * Choose Basic Auth (username/password) for on-premise or OAuth 2.0 Client Credentials for - * SAP S/4HANA Cloud. - * - * Username and password credentials for SAP S/4HANA. - * - * OAuth 2.0 client credentials for SAP S/4HANA Cloud. - * * ThoughtSpot authentication configuration * * Types of methods used to authenticate to the alation instance @@ -2479,15 +2486,11 @@ export interface AuthenticationType { /** * Service Principal Application ID created in your Databricks Account Console for OAuth * Machine-to-Machine authentication. - * - * OAuth 2.0 client ID registered in SAP. */ clientId?: string; /** * OAuth Secret generated for the Service Principal in Databricks Account Console. Used for * secure OAuth2 authentication. - * - * OAuth 2.0 client secret. */ clientSecret?: string; /** @@ -2511,8 +2514,6 @@ export interface AuthenticationType { * * Password to access the service. * - * Password to authenticate with SAP S/4HANA. - * * Elastic Search Password for Login * * Ranger password to authenticate to the API. @@ -2564,8 +2565,6 @@ export interface AuthenticationType { * * Username to access the service. * - * Username to authenticate with SAP S/4HANA. - * * Elastic Search Username for Login * * Ranger user to authenticate to the API. @@ -2581,14 +2580,6 @@ export interface AuthenticationType { * Personal Access Token Secret. */ personalAccessTokenSecret?: string; - /** - * Authentication type identifier. - */ - authType?: AuthType; - /** - * OAuth 2.0 token endpoint URL (e.g. /sap/bc/security/oauth2/token). - */ - tokenEndpoint?: string; /** * Access Token for the API */ @@ -2657,14 +2648,6 @@ export interface AuthenticationType { privateKeyPassphrase?: string; } -/** - * Authentication type identifier. - */ -export enum AuthType { - Basic = "basic", - Oauth2 = "oauth2", -} - /** * AWS credentials required to access the S3 file. * @@ -2918,10 +2901,16 @@ export enum CloudRegion { } /** + * Choose how to authenticate with SAP SuccessFactors OData API. + * + * Authentication type to connect to SAP SuccessFactors. + * * Database Authentication types not requiring config. */ export enum NoConfigAuthenticationTypes { + BasicAuth = "BasicAuth", OAuth2 = "OAuth2", + OAuth2Credentials = "OAuth2Credentials", } /** @@ -3132,9 +3121,6 @@ export enum KafkaSecurityProtocol { * SSL Configuration details. Provide the CA certificate to validate the Informix server * certificate. Paste the PEM content directly or upload the certificate file. * - * CA certificate, client certificate, and private key for SSL validation. Required when - * verifySSL is 'validate'. - * * Consumer Config SSL Config. Configuration for enabling SSL for the Consumer Config * connection. * @@ -3878,9 +3864,6 @@ export enum ConnectionScheme { * SSL Configuration details. Provide the CA certificate to validate the Informix server * certificate. Paste the PEM content directly or upload the certificate file. * - * CA certificate, client certificate, and private key for SSL validation. Required when - * verifySSL is 'validate'. - * * Consumer Config SSL Config. Configuration for enabling SSL for the Consumer Config * connection. * @@ -3943,9 +3926,6 @@ export enum ConnectionType { * * Client SSL verification. * - * Client SSL verification. Use 'no-ssl' for plain HTTP, 'ignore' to skip certificate - * validation, 'validate' to verify against a CA certificate. - * * Flag to verify SSL Certificate for OpenMetadata Server. */ export enum VerifySSL { @@ -4644,9 +4624,6 @@ export enum SpaceType { * SSL Configuration details. Provide the CA certificate to validate the Informix server * certificate. Paste the PEM content directly or upload the certificate file. * - * CA certificate, client certificate, and private key for SSL validation. Required when - * verifySSL is 'validate'. - * * Consumer Config SSL Config. Configuration for enabling SSL for the Consumer Config * connection. * @@ -4790,8 +4767,6 @@ export enum TokenType { * * Grafana service type * - * SAP S/4HANA service type - * * Kafka service type * * Redpanda service type @@ -4942,7 +4917,7 @@ export enum ConfigType { Salesforce = "Salesforce", SapERP = "SapErp", SapHana = "SapHana", - SapS4Hana = "SapS4Hana", + SapSuccessFactors = "SapSuccessFactors", ServiceNow = "ServiceNow", SharePoint = "SharePoint", Sigma = "Sigma", diff --git a/openmetadata-ui/src/main/resources/ui/src/generated/entity/automations/workflow.ts b/openmetadata-ui/src/main/resources/ui/src/generated/entity/automations/workflow.ts index cf3a5dfdf05b..599e6817661b 100644 --- a/openmetadata-ui/src/main/resources/ui/src/generated/entity/automations/workflow.ts +++ b/openmetadata-ui/src/main/resources/ui/src/generated/entity/automations/workflow.ts @@ -540,9 +540,6 @@ export interface OpenMetadataJWTClientConfig { * SSL Configuration details. Provide the CA certificate to validate the Informix server * certificate. Paste the PEM content directly or upload the certificate file. * - * CA certificate, client certificate, and private key for SSL validation. Required when - * verifySSL is 'validate'. - * * Consumer Config SSL Config. Configuration for enabling SSL for the Consumer Config * connection. * @@ -581,9 +578,6 @@ export enum OpenmetadataType { * Client SSL verification. Make sure to configure the SSLConfig if enabled. * * Client SSL verification. - * - * Client SSL verification. Use 'no-ssl' for plain HTTP, 'ignore' to skip certificate - * validation, 'validate' to verify against a CA certificate. */ export enum VerifySSL { Ignore = "ignore", @@ -780,6 +774,8 @@ export interface RequestConnection { * * Salesforce Connection Config * + * SAP SuccessFactors Connection Config + * * SingleStore Database Connection Config * * Snowflake Connection Config @@ -884,8 +880,6 @@ export interface RequestConnection { * SQL Server Reporting Services (SSRS) provides a set of on-premises tools and services to * create, deploy, and manage paginated reports * - * SAP S/4HANA Connection Config for Embedded Analytics - * * Kafka Connection Config * * Redpanda Connection Config @@ -1024,9 +1018,6 @@ export interface ConfigObject { * SSL Configuration details. Provide the CA certificate to validate the Informix server * certificate. Paste the PEM content directly or upload the certificate file. * - * CA certificate, client certificate, and private key for SSL validation. Required when - * verifySSL is 'validate'. - * * SSL Configuration for OpenMetadata Server */ sslConfig?: SSLConfigObject; @@ -1077,12 +1068,9 @@ export interface ConfigObject { /** * Client SSL verification. Make sure to configure the SSLConfig if enabled. * - * Boolean marking if we need to verify the SSL certs for Grafana. Default to True. - * * Client SSL verification. * - * Client SSL verification. Use 'no-ssl' for plain HTTP, 'ignore' to skip certificate - * validation, 'validate' to verify against a CA certificate. + * Boolean marking if we need to verify the SSL certs for Grafana. Default to True. * * Boolean marking if we need to verify the SSL certs for KafkaConnect REST API. True by * default. @@ -1223,8 +1211,6 @@ export interface ConfigObject { * * Host and Port of the Ssrs instance. * - * Base URL of the SAP S/4HANA instance (e.g. https://s4hana.example.com). - * * Pub/Sub APIs URL. For local testing with the emulator, use http://localhost:8085. * * Pipeline Service Management/UI URI. @@ -1448,6 +1434,8 @@ export interface ConfigObject { * * Password to connect to Salesforce. * + * Password for BasicAuth authentication. Required when authType is BasicAuth. + * * Password to connect to SingleStore. * * Password to connect to Snowflake. @@ -1544,6 +1532,11 @@ export interface ConfigObject { * Username to connect to Salesforce. This user should have privileges to read all the * metadata in Salesforce. * + * SAP SuccessFactors user login name. For BasicAuth: used as the credential username. For + * OAuth2Credentials: used as the SAML NameID — the user on whose behalf the token is + * requested. The user must exist in the SF system and be permitted to use the OAuth2 + * application. + * * Username to connect to SingleStore. This user should have privileges to read all the * metadata in MySQL. * @@ -1664,13 +1657,12 @@ export interface ConfigObject { * * Choose Auth Configuration Type. * + * Choose how to authenticate with SAP SuccessFactors OData API. + * * Choose between Dremio Cloud (SaaS) or Dremio Software (self-hosted) authentication. * * Types of methods used to authenticate to the tableau instance * - * Choose Basic Auth (username/password) for on-premise or OAuth 2.0 Client Credentials for - * SAP S/4HANA Cloud. - * * Types of methods used to authenticate to the alation instance * * Authentication type to connect to Apache Ranger. @@ -1890,6 +1882,58 @@ export interface ConfigObject { * fetched. Leave empty to fetch all objects (subject to tableFilterPattern). */ sobjectNames?: string[]; + /** + * SAP SuccessFactors OData API version. + * + * Tableau API version. If not provided, the version will be used from the tableau server. + * + * Sigma API version. + * + * ThoughtSpot API version to use + * + * Airbyte API version. + * + * OpenMetadata server API version to use. + */ + apiVersion?: string; + /** + * SAP SuccessFactors OData API base URL. For example: https://api4.successfactors.com + */ + baseUrl?: string; + /** + * OAuth2 Client ID. Required when authType is OAuth2Credentials. + * + * Client ID for DOMO + * + * Azure Application (client) ID for service principal authentication. + * + * Azure Application (client) ID for Service Principal authentication. + * + * User's Client ID. This user should have privileges to read all the metadata in Looker. + * + * client_id for PowerBI. + * + * client_id for Sigma. + * + * Application (client) ID from Azure Active Directory + */ + clientId?: string; + /** + * SAP SuccessFactors Company ID (tenant identifier). Required for all API calls. + */ + companyId?: string; + /** + * PEM-encoded RSA private key used to sign SAML assertions for OAuth2 SAML Bearer flow. + * Required when authType is OAuth2Credentials. + * + * Connection to Snowflake instance via Private Key + */ + privateKey?: string; + /** + * OAuth2 Token endpoint URL. Required when authType is OAuth2Credentials. For example: + * https://api4.successfactors.com/oauth/token + */ + tokenUrl?: string; /** * If the Snowflake URL is https://xyz1234.us-east-1.gcp.snowflakecomputing.com, then the * account is xyz1234.us-east-1.gcp @@ -1926,10 +1970,6 @@ export interface ConfigObject { * TRANSIENT tables. */ includeTransientTables?: boolean; - /** - * Connection to Snowflake instance via Private Key - */ - privateKey?: string; /** * Session query tag used to monitor usage on snowflake. To use a query tag snowflake user * should have enough privileges to alter the session. @@ -1983,22 +2023,6 @@ export interface ConfigObject { * API Host to connect to DOMO instance */ apiHost?: string; - /** - * Client ID for DOMO - * - * Azure Application (client) ID for service principal authentication. - * - * Azure Application (client) ID for Service Principal authentication. - * - * User's Client ID. This user should have privileges to read all the metadata in Looker. - * - * client_id for PowerBI. - * - * client_id for Sigma. - * - * Application (client) ID from Azure Active Directory - */ - clientId?: string; /** * URL of your Domo instance, e.g., https://openmetadata.domo.com */ @@ -2232,18 +2256,6 @@ export interface ConfigObject { * Version of the Redash instance */ redashVersion?: string; - /** - * Tableau API version. If not provided, the version will be used from the tableau server. - * - * Sigma API version. - * - * ThoughtSpot API version to use - * - * Airbyte API version. - * - * OpenMetadata server API version to use. - */ - apiVersion?: string; /** * Proxy URL for the tableau server. If not provided, the hostPort will be used. This is * used to generate the dashboard & Chart URL. @@ -2351,10 +2363,6 @@ export interface ConfigObject { * Type of token to use for authentication */ tokenType?: TokenType; - /** - * SAP client number (Mandant), typically a 3-digit string (e.g. '100'). - */ - clientNumber?: string; /** * basic.auth.user.info schema registry config property, Client HTTP credentials in the form * of username:password. @@ -2992,13 +3000,6 @@ export enum AuthMechanismEnum { * * Access Token Auth Credentials * - * Choose Basic Auth (username/password) for on-premise or OAuth 2.0 Client Credentials for - * SAP S/4HANA Cloud. - * - * Username and password credentials for SAP S/4HANA. - * - * OAuth 2.0 client credentials for SAP S/4HANA Cloud. - * * ThoughtSpot authentication configuration * * Types of methods used to authenticate to the alation instance @@ -3036,15 +3037,11 @@ export interface AuthenticationType { /** * Service Principal Application ID created in your Databricks Account Console for OAuth * Machine-to-Machine authentication. - * - * OAuth 2.0 client ID registered in SAP. */ clientId?: string; /** * OAuth Secret generated for the Service Principal in Databricks Account Console. Used for * secure OAuth2 authentication. - * - * OAuth 2.0 client secret. */ clientSecret?: string; /** @@ -3068,8 +3065,6 @@ export interface AuthenticationType { * * Password to access the service. * - * Password to authenticate with SAP S/4HANA. - * * Elastic Search Password for Login * * Ranger password to authenticate to the API. @@ -3121,8 +3116,6 @@ export interface AuthenticationType { * * Username to access the service. * - * Username to authenticate with SAP S/4HANA. - * * Elastic Search Username for Login * * Ranger user to authenticate to the API. @@ -3138,14 +3131,6 @@ export interface AuthenticationType { * Personal Access Token Secret. */ personalAccessTokenSecret?: string; - /** - * Authentication type identifier. - */ - authType?: AuthType; - /** - * OAuth 2.0 token endpoint URL (e.g. /sap/bc/security/oauth2/token). - */ - tokenEndpoint?: string; /** * Access Token for the API */ @@ -3214,14 +3199,6 @@ export interface AuthenticationType { privateKeyPassphrase?: string; } -/** - * Authentication type identifier. - */ -export enum AuthType { - Basic = "basic", - Oauth2 = "oauth2", -} - /** * AWS credentials required to access the S3 file. * @@ -3475,10 +3452,16 @@ export enum CloudRegion { } /** + * Choose how to authenticate with SAP SuccessFactors OData API. + * + * Authentication type to connect to SAP SuccessFactors. + * * Database Authentication types not requiring config. */ export enum NoConfigAuthenticationTypes { + BasicAuth = "BasicAuth", OAuth2 = "OAuth2", + OAuth2Credentials = "OAuth2Credentials", } /** @@ -4395,9 +4378,6 @@ export enum ConnectionScheme { * SSL Configuration details. Provide the CA certificate to validate the Informix server * certificate. Paste the PEM content directly or upload the certificate file. * - * CA certificate, client certificate, and private key for SSL validation. Required when - * verifySSL is 'validate'. - * * Consumer Config SSL Config. Configuration for enabling SSL for the Consumer Config * connection. * @@ -5100,9 +5080,6 @@ export enum SpaceType { * SSL Configuration details. Provide the CA certificate to validate the Informix server * certificate. Paste the PEM content directly or upload the certificate file. * - * CA certificate, client certificate, and private key for SSL validation. Required when - * verifySSL is 'validate'. - * * Consumer Config SSL Config. Configuration for enabling SSL for the Consumer Config * connection. * @@ -5244,8 +5221,6 @@ export enum TokenType { * * Grafana service type * - * SAP S/4HANA service type - * * Kafka service type * * Redpanda service type @@ -5396,7 +5371,7 @@ export enum ConfigType { Salesforce = "Salesforce", SapERP = "SapErp", SapHana = "SapHana", - SapS4Hana = "SapS4Hana", + SapSuccessFactors = "SapSuccessFactors", ServiceNow = "ServiceNow", SharePoint = "SharePoint", Sigma = "Sigma", diff --git a/openmetadata-ui/src/main/resources/ui/src/generated/entity/data/database.ts b/openmetadata-ui/src/main/resources/ui/src/generated/entity/data/database.ts index 3706fc757e0c..6efdd5eb6d2b 100644 --- a/openmetadata-ui/src/main/resources/ui/src/generated/entity/data/database.ts +++ b/openmetadata-ui/src/main/resources/ui/src/generated/entity/data/database.ts @@ -781,6 +781,7 @@ export enum DatabaseServiceType { Salesforce = "Salesforce", SapERP = "SapErp", SapHana = "SapHana", + SapSuccessFactors = "SapSuccessFactors", ServiceNow = "ServiceNow", SingleStore = "SingleStore", Snowflake = "Snowflake", diff --git a/openmetadata-ui/src/main/resources/ui/src/generated/entity/data/databaseSchema.ts b/openmetadata-ui/src/main/resources/ui/src/generated/entity/data/databaseSchema.ts index d517dca7882d..d020dfd309f8 100644 --- a/openmetadata-ui/src/main/resources/ui/src/generated/entity/data/databaseSchema.ts +++ b/openmetadata-ui/src/main/resources/ui/src/generated/entity/data/databaseSchema.ts @@ -777,6 +777,7 @@ export enum DatabaseServiceType { Salesforce = "Salesforce", SapERP = "SapErp", SapHana = "SapHana", + SapSuccessFactors = "SapSuccessFactors", ServiceNow = "ServiceNow", SingleStore = "SingleStore", Snowflake = "Snowflake", diff --git a/openmetadata-ui/src/main/resources/ui/src/generated/entity/data/storedProcedure.ts b/openmetadata-ui/src/main/resources/ui/src/generated/entity/data/storedProcedure.ts index ebb3f6769699..4ed6844dcadb 100644 --- a/openmetadata-ui/src/main/resources/ui/src/generated/entity/data/storedProcedure.ts +++ b/openmetadata-ui/src/main/resources/ui/src/generated/entity/data/storedProcedure.ts @@ -609,6 +609,7 @@ export enum DatabaseServiceType { Salesforce = "Salesforce", SapERP = "SapErp", SapHana = "SapHana", + SapSuccessFactors = "SapSuccessFactors", ServiceNow = "ServiceNow", SingleStore = "SingleStore", Snowflake = "Snowflake", diff --git a/openmetadata-ui/src/main/resources/ui/src/generated/entity/data/table.ts b/openmetadata-ui/src/main/resources/ui/src/generated/entity/data/table.ts index 6474688f350d..5878f22aee98 100644 --- a/openmetadata-ui/src/main/resources/ui/src/generated/entity/data/table.ts +++ b/openmetadata-ui/src/main/resources/ui/src/generated/entity/data/table.ts @@ -1395,6 +1395,7 @@ export enum DatabaseServiceType { Salesforce = "Salesforce", SapERP = "SapErp", SapHana = "SapHana", + SapSuccessFactors = "SapSuccessFactors", ServiceNow = "ServiceNow", SingleStore = "SingleStore", Snowflake = "Snowflake", diff --git a/openmetadata-ui/src/main/resources/ui/src/generated/entity/services/connections/database/sapSuccessFactorsConnection.ts b/openmetadata-ui/src/main/resources/ui/src/generated/entity/services/connections/database/sapSuccessFactorsConnection.ts new file mode 100644 index 000000000000..b34e485b4105 --- /dev/null +++ b/openmetadata-ui/src/main/resources/ui/src/generated/entity/services/connections/database/sapSuccessFactorsConnection.ts @@ -0,0 +1,150 @@ +/* + * Copyright 2026 Collate. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +/** + * SAP SuccessFactors Connection Config + */ +export interface SapSuccessFactorsConnection { + /** + * SAP SuccessFactors OData API version. + */ + apiVersion?: string; + /** + * Choose how to authenticate with SAP SuccessFactors OData API. + */ + authType?: AuthType; + /** + * SAP SuccessFactors OData API base URL. For example: https://api4.successfactors.com + */ + baseUrl: string; + /** + * OAuth2 Client ID. Required when authType is OAuth2Credentials. + */ + clientId?: string; + /** + * SAP SuccessFactors Company ID (tenant identifier). Required for all API calls. + */ + companyId: string; + connectionArguments?: { [key: string]: any }; + connectionOptions?: { [key: string]: string }; + /** + * Optional name to give to the database in OpenMetadata. If left blank, we will use default + * as the database name. + */ + databaseName?: string; + /** + * Password for BasicAuth authentication. Required when authType is BasicAuth. + */ + password?: string; + /** + * PEM-encoded RSA private key used to sign SAML assertions for OAuth2 SAML Bearer flow. + * Required when authType is OAuth2Credentials. + */ + privateKey?: string; + /** + * SSL Configuration details. + */ + sslConfig?: Config; + supportsMetadataExtraction?: boolean; + /** + * Regex to only include/exclude tables that matches the pattern. + */ + tableFilterPattern?: FilterPattern; + /** + * OAuth2 Token endpoint URL. Required when authType is OAuth2Credentials. For example: + * https://api4.successfactors.com/oauth/token + */ + tokenUrl?: string; + /** + * Service Type + */ + type?: SapSuccessFactorsType; + /** + * SAP SuccessFactors user login name. For BasicAuth: used as the credential username. For + * OAuth2Credentials: used as the SAML NameID — the user on whose behalf the token is + * requested. The user must exist in the SF system and be permitted to use the OAuth2 + * application. + */ + username?: string; + /** + * Client SSL verification. + */ + verifySSL?: VerifySSL; +} + +/** + * Choose how to authenticate with SAP SuccessFactors OData API. + * + * Authentication type to connect to SAP SuccessFactors. + */ +export enum AuthType { + BasicAuth = "BasicAuth", + OAuth2Credentials = "OAuth2Credentials", +} + +/** + * SSL Configuration details. + * + * Client SSL configuration + * + * OpenMetadata Client configured to validate SSL certificates. + */ +export interface Config { + /** + * The CA certificate used for SSL validation. + */ + caCertificate?: string; + /** + * The SSL certificate used for client authentication. + */ + sslCertificate?: string; + /** + * The private key associated with the SSL certificate. + */ + sslKey?: string; +} + +/** + * Regex to only include/exclude tables that matches the pattern. + * + * Regex to only fetch entities that matches the pattern. + */ +export interface FilterPattern { + /** + * List of strings/regex patterns to match and exclude only database entities that match. + */ + excludes?: string[]; + /** + * List of strings/regex patterns to match and include only database entities that match. + */ + includes?: string[]; +} + +/** + * Service Type + * + * Service type. + */ +export enum SapSuccessFactorsType { + SapSuccessFactors = "SapSuccessFactors", +} + +/** + * Client SSL verification. + * + * Client SSL verification. Make sure to configure the SSLConfig if enabled. + */ +export enum VerifySSL { + Ignore = "ignore", + NoSSL = "no-ssl", + Validate = "validate", +} diff --git a/openmetadata-ui/src/main/resources/ui/src/generated/entity/services/connections/serviceConnection.ts b/openmetadata-ui/src/main/resources/ui/src/generated/entity/services/connections/serviceConnection.ts index eab2cac9348e..59c06b341519 100644 --- a/openmetadata-ui/src/main/resources/ui/src/generated/entity/services/connections/serviceConnection.ts +++ b/openmetadata-ui/src/main/resources/ui/src/generated/entity/services/connections/serviceConnection.ts @@ -97,8 +97,6 @@ export interface ServiceConnectionClass { * SQL Server Reporting Services (SSRS) provides a set of on-premises tools and services to * create, deploy, and manage paginated reports * - * SAP S/4HANA Connection Config for Embedded Analytics - * * Google BigQuery Connection Config * * Google BigTable Connection Config @@ -147,6 +145,8 @@ export interface ServiceConnectionClass { * * Salesforce Connection Config * + * SAP SuccessFactors Connection Config + * * SingleStore Database Connection Config * * Snowflake Connection Config @@ -341,9 +341,6 @@ export interface ConfigObject { /** * SSL Configuration details. * - * CA certificate, client certificate, and private key for SSL validation. Required when - * verifySSL is 'validate'. - * * SSL Configuration details for DB2 connection. Provide CA certificate for server * validation, and optionally client certificate and key for mutual TLS authentication. * @@ -407,9 +404,6 @@ export interface ConfigObject { * * Client SSL verification. * - * Client SSL verification. Use 'no-ssl' for plain HTTP, 'ignore' to skip certificate - * validation, 'validate' to verify against a CA certificate. - * * Flag to verify SSL Certificate for OpenMetadata Server. * * Boolean marking if we need to verify the SSL certs for KafkaConnect REST API. True by @@ -431,6 +425,8 @@ export interface ConfigObject { * * client_id for Sigma. * + * OAuth2 Client ID. Required when authType is OAuth2Credentials. + * * Azure Application (client) ID for service principal authentication. * * Azure Application (client) ID for Service Principal authentication. @@ -500,8 +496,6 @@ export interface ConfigObject { * * Host and Port of the Ssrs instance. * - * Base URL of the SAP S/4HANA instance (e.g. https://s4hana.example.com). - * * BigQuery APIs URL. * * Host and port of the AzureSQL service. @@ -662,6 +656,8 @@ export interface ConfigObject { * * Password to connect to Salesforce. * + * Password for BasicAuth authentication. Required when authType is BasicAuth. + * * Password to connect to SingleStore. * * Password to connect to Snowflake. @@ -761,6 +757,11 @@ export interface ConfigObject { * Username to connect to Salesforce. This user should have privileges to read all the * metadata in Salesforce. * + * SAP SuccessFactors user login name. For BasicAuth: used as the credential username. For + * OAuth2Credentials: used as the SAML NameID — the user on whose behalf the token is + * requested. The user must exist in the SF system and be permitted to use the OAuth2 + * application. + * * Username to connect to SingleStore. This user should have privileges to read all the * metadata in MySQL. * @@ -900,6 +901,8 @@ export interface ConfigObject { * * ThoughtSpot API version to use * + * SAP SuccessFactors OData API version. + * * OpenMetadata server API version to use. * * Airbyte API version. @@ -908,15 +911,14 @@ export interface ConfigObject { /** * Types of methods used to authenticate to the tableau instance * - * Choose Basic Auth (username/password) for on-premise or OAuth 2.0 Client Credentials for - * SAP S/4HANA Cloud. - * * Choose between different authentication types for Databricks. * * Choose Auth Config Type. * * Choose Auth Configuration Type. * + * Choose how to authenticate with SAP SuccessFactors OData API. + * * Choose between Dremio Cloud (SaaS) or Dremio Software (self-hosted) authentication. * * Types of methods used to authenticate to the alation instance @@ -925,7 +927,7 @@ export interface ConfigObject { * * Authentication method: username/password or SSH private key */ - authType?: AuthenticationType | NoConfigAuthenticationTypes; + authType?: AuthenticationTypeForTableau | NoConfigAuthenticationTypes; /** * Pagination limit used while querying the tableau metadata API for getting data sources * @@ -1067,14 +1069,6 @@ export interface ConfigObject { * Type of token to use for authentication */ tokenType?: TokenType; - /** - * SAP client number (Mandant), typically a 3-digit string (e.g. '100'). - */ - clientNumber?: string; - /** - * Supports Lineage Extraction. - */ - supportsLineageExtraction?: boolean; /** * Billing Project ID */ @@ -1138,9 +1132,13 @@ export interface ConfigObject { supportsDataDiff?: boolean; supportsDBTExtraction?: boolean; supportsIncrementalMetadataExtraction?: boolean; - supportsProfiler?: boolean; - supportsQueryComment?: boolean; - supportsSystemProfile?: boolean; + /** + * Supports Lineage Extraction. + */ + supportsLineageExtraction?: boolean; + supportsProfiler?: boolean; + supportsQueryComment?: boolean; + supportsSystemProfile?: boolean; /** * Supports Usage Extraction. */ @@ -1493,6 +1491,26 @@ export interface ConfigObject { * fetched. Leave empty to fetch all objects (subject to tableFilterPattern). */ sobjectNames?: string[]; + /** + * SAP SuccessFactors OData API base URL. For example: https://api4.successfactors.com + */ + baseUrl?: string; + /** + * SAP SuccessFactors Company ID (tenant identifier). Required for all API calls. + */ + companyId?: string; + /** + * PEM-encoded RSA private key used to sign SAML assertions for OAuth2 SAML Bearer flow. + * Required when authType is OAuth2Credentials. + * + * Connection to Snowflake instance via Private Key + */ + privateKey?: string; + /** + * OAuth2 Token endpoint URL. Required when authType is OAuth2Credentials. For example: + * https://api4.successfactors.com/oauth/token + */ + tokenUrl?: string; /** * If the Snowflake URL is https://xyz1234.us-east-1.gcp.snowflakecomputing.com, then the * account is xyz1234.us-east-1.gcp @@ -1529,10 +1547,6 @@ export interface ConfigObject { * TRANSIENT tables. */ includeTransientTables?: boolean; - /** - * Connection to Snowflake instance via Private Key - */ - privateKey?: string; /** * Session query tag used to monitor usage on snowflake. To use a query tag snowflake user * should have enough privileges to alter the session. @@ -2432,13 +2446,6 @@ export enum AuthProvider { * * Access Token Auth Credentials * - * Choose Basic Auth (username/password) for on-premise or OAuth 2.0 Client Credentials for - * SAP S/4HANA Cloud. - * - * Username and password credentials for SAP S/4HANA. - * - * OAuth 2.0 client credentials for SAP S/4HANA Cloud. - * * Choose between different authentication types for Databricks. * * Personal Access Token authentication for Databricks. @@ -2499,12 +2506,10 @@ export enum AuthProvider { * * SSH private key authentication for SFTP */ -export interface AuthenticationType { +export interface AuthenticationTypeForTableau { /** * Password to access the service. * - * Password to authenticate with SAP S/4HANA. - * * Password to connect to source. * * Database user password. Leave empty if using IAM database authentication. @@ -2521,8 +2526,6 @@ export interface AuthenticationType { /** * Username to access the service. * - * Username to authenticate with SAP S/4HANA. - * * Username for authenticating with Dremio Software. This user should have appropriate * permissions to access metadata. * @@ -2542,32 +2545,20 @@ export interface AuthenticationType { */ personalAccessTokenSecret?: string; /** - * Authentication type identifier. + * Generated Personal Access Token for Databricks workspace authentication. This token is + * created from User Settings -> Developer -> Access Tokens in your Databricks workspace. */ - authType?: AuthType; + token?: string; /** - * OAuth 2.0 client ID registered in SAP. - * * Service Principal Application ID created in your Databricks Account Console for OAuth * Machine-to-Machine authentication. */ clientId?: string; /** - * OAuth 2.0 client secret. - * * OAuth Secret generated for the Service Principal in Databricks Account Console. Used for * secure OAuth2 authentication. */ clientSecret?: string; - /** - * OAuth 2.0 token endpoint URL (e.g. /sap/bc/security/oauth2/token). - */ - tokenEndpoint?: string; - /** - * Generated Personal Access Token for Databricks workspace authentication. This token is - * created from User Settings -> Developer -> Access Tokens in your Databricks workspace. - */ - token?: string; /** * Azure Service Principal Application (client) ID registered in your Azure Active Directory. */ @@ -2686,14 +2677,6 @@ export interface AuthenticationType { privateKeyPassphrase?: string; } -/** - * Authentication type identifier. - */ -export enum AuthType { - Basic = "basic", - Oauth2 = "oauth2", -} - /** * AWS credentials required to access the S3 file. * @@ -2947,10 +2930,16 @@ export enum CloudRegion { } /** + * Choose how to authenticate with SAP SuccessFactors OData API. + * + * Authentication type to connect to SAP SuccessFactors. + * * Database Authentication types not requiring config. */ export enum NoConfigAuthenticationTypes { + BasicAuth = "BasicAuth", OAuth2 = "OAuth2", + OAuth2Credentials = "OAuth2Credentials", } /** @@ -3152,9 +3141,6 @@ export enum KafkaSecurityProtocol { * * SSL Configuration details. * - * CA certificate, client certificate, and private key for SSL validation. Required when - * verifySSL is 'validate'. - * * SSL Configuration details for DB2 connection. Provide CA certificate for server * validation, and optionally client certificate and key for mutual TLS authentication. * @@ -3898,9 +3884,6 @@ export enum ConnectionScheme { * * SSL Configuration details. * - * CA certificate, client certificate, and private key for SSL validation. Required when - * verifySSL is 'validate'. - * * SSL Configuration details for DB2 connection. Provide CA certificate for server * validation, and optionally client certificate and key for mutual TLS authentication. * @@ -3972,9 +3955,6 @@ export enum ConnectionType { * * Client SSL verification. * - * Client SSL verification. Use 'no-ssl' for plain HTTP, 'ignore' to skip certificate - * validation, 'validate' to verify against a CA certificate. - * * Flag to verify SSL Certificate for OpenMetadata Server. */ export enum VerifySSL { @@ -4714,9 +4694,6 @@ export enum SpaceType { * * SSL Configuration details. * - * CA certificate, client certificate, and private key for SSL validation. Required when - * verifySSL is 'validate'. - * * SSL Configuration details for DB2 connection. Provide CA certificate for server * validation, and optionally client certificate and key for mutual TLS authentication. * @@ -4867,8 +4844,6 @@ export enum TokenType { * * Service type. * - * SAP S/4HANA service type - * * Custom database service type * * Kafka service type @@ -5024,7 +4999,7 @@ export enum ConfigType { Salesforce = "Salesforce", SapERP = "SapErp", SapHana = "SapHana", - SapS4Hana = "SapS4Hana", + SapSuccessFactors = "SapSuccessFactors", ServiceNow = "ServiceNow", SharePoint = "SharePoint", Sigma = "Sigma", diff --git a/openmetadata-ui/src/main/resources/ui/src/generated/entity/services/databaseService.ts b/openmetadata-ui/src/main/resources/ui/src/generated/entity/services/databaseService.ts index a44ce2540930..f0bb426ff56c 100644 --- a/openmetadata-ui/src/main/resources/ui/src/generated/entity/services/databaseService.ts +++ b/openmetadata-ui/src/main/resources/ui/src/generated/entity/services/databaseService.ts @@ -238,6 +238,8 @@ export interface DatabaseConnection { * * Salesforce Connection Config * + * SAP SuccessFactors Connection Config + * * SingleStore Database Connection Config * * Snowflake Connection Config @@ -594,6 +596,8 @@ export interface Connection { * * Password to connect to Salesforce. * + * Password for BasicAuth authentication. Required when authType is BasicAuth. + * * Password to connect to SingleStore. * * Password to connect to Snowflake. @@ -676,6 +680,11 @@ export interface Connection { * Username to connect to Salesforce. This user should have privileges to read all the * metadata in Salesforce. * + * SAP SuccessFactors user login name. For BasicAuth: used as the credential username. For + * OAuth2Credentials: used as the SAML NameID — the user on whose behalf the token is + * requested. The user must exist in the SF system and be permitted to use the OAuth2 + * application. + * * Username to connect to SingleStore. This user should have privileges to read all the * metadata in MySQL. * @@ -777,6 +786,8 @@ export interface Connection { * * Choose Auth Configuration Type. * + * Choose how to authenticate with SAP SuccessFactors OData API. + * * Choose between Dremio Cloud (SaaS) or Dremio Software (self-hosted) authentication. */ authType?: AuthenticationType | NoConfigAuthenticationTypes; @@ -984,6 +995,44 @@ export interface Connection { * fetched. Leave empty to fetch all objects (subject to tableFilterPattern). */ sobjectNames?: string[]; + /** + * SAP SuccessFactors OData API version. + */ + apiVersion?: string; + /** + * SAP SuccessFactors OData API base URL. For example: https://api4.successfactors.com + */ + baseUrl?: string; + /** + * OAuth2 Client ID. Required when authType is OAuth2Credentials. + * + * Client ID for DOMO + * + * Azure Application (client) ID for service principal authentication. + * + * Azure Application (client) ID for Service Principal authentication. + */ + clientId?: string; + /** + * SAP SuccessFactors Company ID (tenant identifier). Required for all API calls. + */ + companyId?: string; + /** + * PEM-encoded RSA private key used to sign SAML assertions for OAuth2 SAML Bearer flow. + * Required when authType is OAuth2Credentials. + * + * Connection to Snowflake instance via Private Key + */ + privateKey?: string; + /** + * OAuth2 Token endpoint URL. Required when authType is OAuth2Credentials. For example: + * https://api4.successfactors.com/oauth/token + */ + tokenUrl?: string; + /** + * Client SSL verification. + */ + verifySSL?: VerifySSL; /** * If the Snowflake URL is https://xyz1234.us-east-1.gcp.snowflakecomputing.com, then the * account is xyz1234.us-east-1.gcp @@ -1020,10 +1069,6 @@ export interface Connection { * TRANSIENT tables. */ includeTransientTables?: boolean; - /** - * Connection to Snowflake instance via Private Key - */ - privateKey?: string; /** * Session query tag used to monitor usage on snowflake. To use a query tag snowflake user * should have enough privileges to alter the session. @@ -1075,14 +1120,6 @@ export interface Connection { * API Host to connect to DOMO instance */ apiHost?: string; - /** - * Client ID for DOMO - * - * Azure Application (client) ID for service principal authentication. - * - * Azure Application (client) ID for Service Principal authentication. - */ - clientId?: string; /** * URL of your Domo instance, e.g., https://openmetadata.domo.com */ @@ -1154,7 +1191,6 @@ export interface Connection { * Pagination limit used while querying the SAP ERP API for fetching the entities */ paginationLimit?: number; - verifySSL?: VerifySSL; /** * Azure Application client secret for service principal authentication. * @@ -1603,10 +1639,16 @@ export enum CloudRegion { } /** + * Choose how to authenticate with SAP SuccessFactors OData API. + * + * Authentication type to connect to SAP SuccessFactors. + * * Database Authentication types not requiring config. */ export enum NoConfigAuthenticationTypes { + BasicAuth = "BasicAuth", OAuth2 = "OAuth2", + OAuth2Credentials = "OAuth2Credentials", } export interface AuthenticationModeObject { @@ -2398,6 +2440,7 @@ export enum ConfigType { Salesforce = "Salesforce", SapERP = "SapErp", SapHana = "SapHana", + SapSuccessFactors = "SapSuccessFactors", ServiceNow = "ServiceNow", SingleStore = "SingleStore", Snowflake = "Snowflake", @@ -2412,6 +2455,8 @@ export enum ConfigType { } /** + * Client SSL verification. + * * Client SSL verification. Make sure to configure the SSLConfig if enabled. */ export enum VerifySSL { @@ -2545,6 +2590,7 @@ export enum DatabaseServiceType { Salesforce = "Salesforce", SapERP = "SapErp", SapHana = "SapHana", + SapSuccessFactors = "SapSuccessFactors", ServiceNow = "ServiceNow", SingleStore = "SingleStore", Snowflake = "Snowflake", diff --git a/openmetadata-ui/src/main/resources/ui/src/generated/entity/services/ingestionPipelines/ingestionPipeline.ts b/openmetadata-ui/src/main/resources/ui/src/generated/entity/services/ingestionPipelines/ingestionPipeline.ts index 406c685c0ff7..2199ccfaa4b6 100644 --- a/openmetadata-ui/src/main/resources/ui/src/generated/entity/services/ingestionPipelines/ingestionPipeline.ts +++ b/openmetadata-ui/src/main/resources/ui/src/generated/entity/services/ingestionPipelines/ingestionPipeline.ts @@ -662,9 +662,6 @@ export interface OpenMetadataJWTClientConfig { * * SSL Configuration details. * - * CA certificate, client certificate, and private key for SSL validation. Required when - * verifySSL is 'validate'. - * * SSL Configuration details for DB2 connection. Provide CA certificate for server * validation, and optionally client certificate and key for mutual TLS authentication. * @@ -716,9 +713,6 @@ export enum OpenmetadataType { * * Client SSL verification. * - * Client SSL verification. Use 'no-ssl' for plain HTTP, 'ignore' to skip certificate - * validation, 'validate' to verify against a CA certificate. - * * SSL/TLS verification mode when fetching dbt artifacts over HTTPS. */ export enum VerifySSL { @@ -3136,10 +3130,6 @@ export interface LineageInformation { * List of Database Service Names for creation of lineage */ dbServiceNames?: string[]; - /** - * List of Messaging Service Names for creation of lineage - */ - messagingServiceNames?: string[]; /** * List of Storage Service Names for creation of lineage */ @@ -3533,8 +3523,6 @@ export interface ServiceConnection { * SQL Server Reporting Services (SSRS) provides a set of on-premises tools and services to * create, deploy, and manage paginated reports * - * SAP S/4HANA Connection Config for Embedded Analytics - * * Google BigQuery Connection Config * * Google BigTable Connection Config @@ -3583,6 +3571,8 @@ export interface ServiceConnection { * * Salesforce Connection Config * + * SAP SuccessFactors Connection Config + * * SingleStore Database Connection Config * * Snowflake Connection Config @@ -3777,9 +3767,6 @@ export interface ConfigObject { /** * SSL Configuration details. * - * CA certificate, client certificate, and private key for SSL validation. Required when - * verifySSL is 'validate'. - * * SSL Configuration details for DB2 connection. Provide CA certificate for server * validation, and optionally client certificate and key for mutual TLS authentication. * @@ -3843,9 +3830,6 @@ export interface ConfigObject { * * Client SSL verification. * - * Client SSL verification. Use 'no-ssl' for plain HTTP, 'ignore' to skip certificate - * validation, 'validate' to verify against a CA certificate. - * * Flag to verify SSL Certificate for OpenMetadata Server. * * Boolean marking if we need to verify the SSL certs for KafkaConnect REST API. True by @@ -3867,6 +3851,8 @@ export interface ConfigObject { * * client_id for Sigma. * + * OAuth2 Client ID. Required when authType is OAuth2Credentials. + * * Azure Application (client) ID for service principal authentication. * * Azure Application (client) ID for Service Principal authentication. @@ -3936,8 +3922,6 @@ export interface ConfigObject { * * Host and Port of the Ssrs instance. * - * Base URL of the SAP S/4HANA instance (e.g. https://s4hana.example.com). - * * BigQuery APIs URL. * * Host and port of the AzureSQL service. @@ -4098,6 +4082,8 @@ export interface ConfigObject { * * Password to connect to Salesforce. * + * Password for BasicAuth authentication. Required when authType is BasicAuth. + * * Password to connect to SingleStore. * * Password to connect to Snowflake. @@ -4197,6 +4183,11 @@ export interface ConfigObject { * Username to connect to Salesforce. This user should have privileges to read all the * metadata in Salesforce. * + * SAP SuccessFactors user login name. For BasicAuth: used as the credential username. For + * OAuth2Credentials: used as the SAML NameID — the user on whose behalf the token is + * requested. The user must exist in the SF system and be permitted to use the OAuth2 + * application. + * * Username to connect to SingleStore. This user should have privileges to read all the * metadata in MySQL. * @@ -4336,6 +4327,8 @@ export interface ConfigObject { * * ThoughtSpot API version to use * + * SAP SuccessFactors OData API version. + * * OpenMetadata server API version to use. * * Airbyte API version. @@ -4344,15 +4337,14 @@ export interface ConfigObject { /** * Types of methods used to authenticate to the tableau instance * - * Choose Basic Auth (username/password) for on-premise or OAuth 2.0 Client Credentials for - * SAP S/4HANA Cloud. - * * Choose between different authentication types for Databricks. * * Choose Auth Config Type. * * Choose Auth Configuration Type. * + * Choose how to authenticate with SAP SuccessFactors OData API. + * * Choose between Dremio Cloud (SaaS) or Dremio Software (self-hosted) authentication. * * Types of methods used to authenticate to the alation instance @@ -4361,7 +4353,7 @@ export interface ConfigObject { * * Authentication method: username/password or SSH private key */ - authType?: AuthenticationType | NoConfigAuthenticationTypes; + authType?: AuthenticationTypeForTableau | NoConfigAuthenticationTypes; /** * Pagination limit used while querying the tableau metadata API for getting data sources * @@ -4503,14 +4495,6 @@ export interface ConfigObject { * Type of token to use for authentication */ tokenType?: TokenType; - /** - * SAP client number (Mandant), typically a 3-digit string (e.g. '100'). - */ - clientNumber?: string; - /** - * Supports Lineage Extraction. - */ - supportsLineageExtraction?: boolean; /** * Billing Project ID */ @@ -4574,9 +4558,13 @@ export interface ConfigObject { supportsDataDiff?: boolean; supportsDBTExtraction?: boolean; supportsIncrementalMetadataExtraction?: boolean; - supportsProfiler?: boolean; - supportsQueryComment?: boolean; - supportsSystemProfile?: boolean; + /** + * Supports Lineage Extraction. + */ + supportsLineageExtraction?: boolean; + supportsProfiler?: boolean; + supportsQueryComment?: boolean; + supportsSystemProfile?: boolean; /** * Supports Usage Extraction. */ @@ -4929,6 +4917,26 @@ export interface ConfigObject { * fetched. Leave empty to fetch all objects (subject to tableFilterPattern). */ sobjectNames?: string[]; + /** + * SAP SuccessFactors OData API base URL. For example: https://api4.successfactors.com + */ + baseUrl?: string; + /** + * SAP SuccessFactors Company ID (tenant identifier). Required for all API calls. + */ + companyId?: string; + /** + * PEM-encoded RSA private key used to sign SAML assertions for OAuth2 SAML Bearer flow. + * Required when authType is OAuth2Credentials. + * + * Connection to Snowflake instance via Private Key + */ + privateKey?: string; + /** + * OAuth2 Token endpoint URL. Required when authType is OAuth2Credentials. For example: + * https://api4.successfactors.com/oauth/token + */ + tokenUrl?: string; /** * If the Snowflake URL is https://xyz1234.us-east-1.gcp.snowflakecomputing.com, then the * account is xyz1234.us-east-1.gcp @@ -4965,10 +4973,6 @@ export interface ConfigObject { * TRANSIENT tables. */ includeTransientTables?: boolean; - /** - * Connection to Snowflake instance via Private Key - */ - privateKey?: string; /** * Session query tag used to monitor usage on snowflake. To use a query tag snowflake user * should have enough privileges to alter the session. @@ -5761,13 +5765,6 @@ export enum AuthMechanismEnum { * * Access Token Auth Credentials * - * Choose Basic Auth (username/password) for on-premise or OAuth 2.0 Client Credentials for - * SAP S/4HANA Cloud. - * - * Username and password credentials for SAP S/4HANA. - * - * OAuth 2.0 client credentials for SAP S/4HANA Cloud. - * * Choose between different authentication types for Databricks. * * Personal Access Token authentication for Databricks. @@ -5828,12 +5825,10 @@ export enum AuthMechanismEnum { * * SSH private key authentication for SFTP */ -export interface AuthenticationType { +export interface AuthenticationTypeForTableau { /** * Password to access the service. * - * Password to authenticate with SAP S/4HANA. - * * Password to connect to source. * * Database user password. Leave empty if using IAM database authentication. @@ -5850,8 +5845,6 @@ export interface AuthenticationType { /** * Username to access the service. * - * Username to authenticate with SAP S/4HANA. - * * Username for authenticating with Dremio Software. This user should have appropriate * permissions to access metadata. * @@ -5871,32 +5864,20 @@ export interface AuthenticationType { */ personalAccessTokenSecret?: string; /** - * Authentication type identifier. + * Generated Personal Access Token for Databricks workspace authentication. This token is + * created from User Settings -> Developer -> Access Tokens in your Databricks workspace. */ - authType?: AuthType; + token?: string; /** - * OAuth 2.0 client ID registered in SAP. - * * Service Principal Application ID created in your Databricks Account Console for OAuth * Machine-to-Machine authentication. */ clientId?: string; /** - * OAuth 2.0 client secret. - * * OAuth Secret generated for the Service Principal in Databricks Account Console. Used for * secure OAuth2 authentication. */ clientSecret?: string; - /** - * OAuth 2.0 token endpoint URL (e.g. /sap/bc/security/oauth2/token). - */ - tokenEndpoint?: string; - /** - * Generated Personal Access Token for Databricks workspace authentication. This token is - * created from User Settings -> Developer -> Access Tokens in your Databricks workspace. - */ - token?: string; /** * Azure Service Principal Application (client) ID registered in your Azure Active Directory. */ @@ -6015,14 +5996,6 @@ export interface AuthenticationType { privateKeyPassphrase?: string; } -/** - * Authentication type identifier. - */ -export enum AuthType { - Basic = "basic", - Oauth2 = "oauth2", -} - /** * AWS credentials configs. * @@ -6174,10 +6147,16 @@ export enum CloudRegion { } /** + * Choose how to authenticate with SAP SuccessFactors OData API. + * + * Authentication type to connect to SAP SuccessFactors. + * * Database Authentication types not requiring config. */ export enum NoConfigAuthenticationTypes { + BasicAuth = "BasicAuth", OAuth2 = "OAuth2", + OAuth2Credentials = "OAuth2Credentials", } /** @@ -6976,9 +6955,6 @@ export enum ConnectionScheme { * * SSL Configuration details. * - * CA certificate, client certificate, and private key for SSL validation. Required when - * verifySSL is 'validate'. - * * SSL Configuration details for DB2 connection. Provide CA certificate for server * validation, and optionally client certificate and key for mutual TLS authentication. * @@ -7724,9 +7700,6 @@ export enum SpaceType { * * SSL Configuration details. * - * CA certificate, client certificate, and private key for SSL validation. Required when - * verifySSL is 'validate'. - * * SSL Configuration details for DB2 connection. Provide CA certificate for server * validation, and optionally client certificate and key for mutual TLS authentication. * @@ -7878,8 +7851,6 @@ export enum TokenType { * * Service type. * - * SAP S/4HANA service type - * * Custom database service type * * Kafka service type @@ -8035,7 +8006,7 @@ export enum PurpleType { Salesforce = "Salesforce", SapERP = "SapErp", SapHana = "SapHana", - SapS4Hana = "SapS4Hana", + SapSuccessFactors = "SapSuccessFactors", ServiceNow = "ServiceNow", SharePoint = "SharePoint", Sigma = "Sigma", diff --git a/openmetadata-ui/src/main/resources/ui/src/generated/metadataIngestion/testSuitePipeline.ts b/openmetadata-ui/src/main/resources/ui/src/generated/metadataIngestion/testSuitePipeline.ts index b81cfec2f0af..6b6f19146e45 100644 --- a/openmetadata-ui/src/main/resources/ui/src/generated/metadataIngestion/testSuitePipeline.ts +++ b/openmetadata-ui/src/main/resources/ui/src/generated/metadataIngestion/testSuitePipeline.ts @@ -141,8 +141,6 @@ export interface ServiceConnection { * SQL Server Reporting Services (SSRS) provides a set of on-premises tools and services to * create, deploy, and manage paginated reports * - * SAP S/4HANA Connection Config for Embedded Analytics - * * Google BigQuery Connection Config * * Google BigTable Connection Config @@ -191,6 +189,8 @@ export interface ServiceConnection { * * Salesforce Connection Config * + * SAP SuccessFactors Connection Config + * * SingleStore Database Connection Config * * Snowflake Connection Config @@ -385,9 +385,6 @@ export interface ConfigObject { /** * SSL Configuration details. * - * CA certificate, client certificate, and private key for SSL validation. Required when - * verifySSL is 'validate'. - * * SSL Configuration details for DB2 connection. Provide CA certificate for server * validation, and optionally client certificate and key for mutual TLS authentication. * @@ -451,9 +448,6 @@ export interface ConfigObject { * * Client SSL verification. * - * Client SSL verification. Use 'no-ssl' for plain HTTP, 'ignore' to skip certificate - * validation, 'validate' to verify against a CA certificate. - * * Flag to verify SSL Certificate for OpenMetadata Server. * * Boolean marking if we need to verify the SSL certs for KafkaConnect REST API. True by @@ -475,6 +469,8 @@ export interface ConfigObject { * * client_id for Sigma. * + * OAuth2 Client ID. Required when authType is OAuth2Credentials. + * * Azure Application (client) ID for service principal authentication. * * Azure Application (client) ID for Service Principal authentication. @@ -544,8 +540,6 @@ export interface ConfigObject { * * Host and Port of the Ssrs instance. * - * Base URL of the SAP S/4HANA instance (e.g. https://s4hana.example.com). - * * BigQuery APIs URL. * * Host and port of the AzureSQL service. @@ -706,6 +700,8 @@ export interface ConfigObject { * * Password to connect to Salesforce. * + * Password for BasicAuth authentication. Required when authType is BasicAuth. + * * Password to connect to SingleStore. * * Password to connect to Snowflake. @@ -805,6 +801,11 @@ export interface ConfigObject { * Username to connect to Salesforce. This user should have privileges to read all the * metadata in Salesforce. * + * SAP SuccessFactors user login name. For BasicAuth: used as the credential username. For + * OAuth2Credentials: used as the SAML NameID — the user on whose behalf the token is + * requested. The user must exist in the SF system and be permitted to use the OAuth2 + * application. + * * Username to connect to SingleStore. This user should have privileges to read all the * metadata in MySQL. * @@ -944,6 +945,8 @@ export interface ConfigObject { * * ThoughtSpot API version to use * + * SAP SuccessFactors OData API version. + * * OpenMetadata server API version to use. * * Airbyte API version. @@ -952,15 +955,14 @@ export interface ConfigObject { /** * Types of methods used to authenticate to the tableau instance * - * Choose Basic Auth (username/password) for on-premise or OAuth 2.0 Client Credentials for - * SAP S/4HANA Cloud. - * * Choose between different authentication types for Databricks. * * Choose Auth Config Type. * * Choose Auth Configuration Type. * + * Choose how to authenticate with SAP SuccessFactors OData API. + * * Choose between Dremio Cloud (SaaS) or Dremio Software (self-hosted) authentication. * * Types of methods used to authenticate to the alation instance @@ -969,7 +971,7 @@ export interface ConfigObject { * * Authentication method: username/password or SSH private key */ - authType?: AuthenticationType | NoConfigAuthenticationTypes; + authType?: AuthenticationTypeForTableau | NoConfigAuthenticationTypes; /** * Pagination limit used while querying the tableau metadata API for getting data sources * @@ -1111,14 +1113,6 @@ export interface ConfigObject { * Type of token to use for authentication */ tokenType?: TokenType; - /** - * SAP client number (Mandant), typically a 3-digit string (e.g. '100'). - */ - clientNumber?: string; - /** - * Supports Lineage Extraction. - */ - supportsLineageExtraction?: boolean; /** * Billing Project ID */ @@ -1182,9 +1176,13 @@ export interface ConfigObject { supportsDataDiff?: boolean; supportsDBTExtraction?: boolean; supportsIncrementalMetadataExtraction?: boolean; - supportsProfiler?: boolean; - supportsQueryComment?: boolean; - supportsSystemProfile?: boolean; + /** + * Supports Lineage Extraction. + */ + supportsLineageExtraction?: boolean; + supportsProfiler?: boolean; + supportsQueryComment?: boolean; + supportsSystemProfile?: boolean; /** * Supports Usage Extraction. */ @@ -1537,6 +1535,26 @@ export interface ConfigObject { * fetched. Leave empty to fetch all objects (subject to tableFilterPattern). */ sobjectNames?: string[]; + /** + * SAP SuccessFactors OData API base URL. For example: https://api4.successfactors.com + */ + baseUrl?: string; + /** + * SAP SuccessFactors Company ID (tenant identifier). Required for all API calls. + */ + companyId?: string; + /** + * PEM-encoded RSA private key used to sign SAML assertions for OAuth2 SAML Bearer flow. + * Required when authType is OAuth2Credentials. + * + * Connection to Snowflake instance via Private Key + */ + privateKey?: string; + /** + * OAuth2 Token endpoint URL. Required when authType is OAuth2Credentials. For example: + * https://api4.successfactors.com/oauth/token + */ + tokenUrl?: string; /** * If the Snowflake URL is https://xyz1234.us-east-1.gcp.snowflakecomputing.com, then the * account is xyz1234.us-east-1.gcp @@ -1573,10 +1591,6 @@ export interface ConfigObject { * TRANSIENT tables. */ includeTransientTables?: boolean; - /** - * Connection to Snowflake instance via Private Key - */ - privateKey?: string; /** * Session query tag used to monitor usage on snowflake. To use a query tag snowflake user * should have enough privileges to alter the session. @@ -2476,13 +2490,6 @@ export enum AuthProvider { * * Access Token Auth Credentials * - * Choose Basic Auth (username/password) for on-premise or OAuth 2.0 Client Credentials for - * SAP S/4HANA Cloud. - * - * Username and password credentials for SAP S/4HANA. - * - * OAuth 2.0 client credentials for SAP S/4HANA Cloud. - * * Choose between different authentication types for Databricks. * * Personal Access Token authentication for Databricks. @@ -2543,12 +2550,10 @@ export enum AuthProvider { * * SSH private key authentication for SFTP */ -export interface AuthenticationType { +export interface AuthenticationTypeForTableau { /** * Password to access the service. * - * Password to authenticate with SAP S/4HANA. - * * Password to connect to source. * * Database user password. Leave empty if using IAM database authentication. @@ -2565,8 +2570,6 @@ export interface AuthenticationType { /** * Username to access the service. * - * Username to authenticate with SAP S/4HANA. - * * Username for authenticating with Dremio Software. This user should have appropriate * permissions to access metadata. * @@ -2586,32 +2589,20 @@ export interface AuthenticationType { */ personalAccessTokenSecret?: string; /** - * Authentication type identifier. + * Generated Personal Access Token for Databricks workspace authentication. This token is + * created from User Settings -> Developer -> Access Tokens in your Databricks workspace. */ - authType?: AuthType; + token?: string; /** - * OAuth 2.0 client ID registered in SAP. - * * Service Principal Application ID created in your Databricks Account Console for OAuth * Machine-to-Machine authentication. */ clientId?: string; /** - * OAuth 2.0 client secret. - * * OAuth Secret generated for the Service Principal in Databricks Account Console. Used for * secure OAuth2 authentication. */ clientSecret?: string; - /** - * OAuth 2.0 token endpoint URL (e.g. /sap/bc/security/oauth2/token). - */ - tokenEndpoint?: string; - /** - * Generated Personal Access Token for Databricks workspace authentication. This token is - * created from User Settings -> Developer -> Access Tokens in your Databricks workspace. - */ - token?: string; /** * Azure Service Principal Application (client) ID registered in your Azure Active Directory. */ @@ -2730,14 +2721,6 @@ export interface AuthenticationType { privateKeyPassphrase?: string; } -/** - * Authentication type identifier. - */ -export enum AuthType { - Basic = "basic", - Oauth2 = "oauth2", -} - /** * AWS credentials required to access the S3 file. * @@ -2991,10 +2974,16 @@ export enum CloudRegion { } /** + * Choose how to authenticate with SAP SuccessFactors OData API. + * + * Authentication type to connect to SAP SuccessFactors. + * * Database Authentication types not requiring config. */ export enum NoConfigAuthenticationTypes { + BasicAuth = "BasicAuth", OAuth2 = "OAuth2", + OAuth2Credentials = "OAuth2Credentials", } /** @@ -3196,9 +3185,6 @@ export enum KafkaSecurityProtocol { * * SSL Configuration details. * - * CA certificate, client certificate, and private key for SSL validation. Required when - * verifySSL is 'validate'. - * * SSL Configuration details for DB2 connection. Provide CA certificate for server * validation, and optionally client certificate and key for mutual TLS authentication. * @@ -3942,9 +3928,6 @@ export enum ConnectionScheme { * * SSL Configuration details. * - * CA certificate, client certificate, and private key for SSL validation. Required when - * verifySSL is 'validate'. - * * SSL Configuration details for DB2 connection. Provide CA certificate for server * validation, and optionally client certificate and key for mutual TLS authentication. * @@ -4016,9 +3999,6 @@ export enum ConnectionType { * * Client SSL verification. * - * Client SSL verification. Use 'no-ssl' for plain HTTP, 'ignore' to skip certificate - * validation, 'validate' to verify against a CA certificate. - * * Flag to verify SSL Certificate for OpenMetadata Server. */ export enum VerifySSL { @@ -4758,9 +4738,6 @@ export enum SpaceType { * * SSL Configuration details. * - * CA certificate, client certificate, and private key for SSL validation. Required when - * verifySSL is 'validate'. - * * SSL Configuration details for DB2 connection. Provide CA certificate for server * validation, and optionally client certificate and key for mutual TLS authentication. * @@ -4911,8 +4888,6 @@ export enum TokenType { * * Service type. * - * SAP S/4HANA service type - * * Custom database service type * * Kafka service type @@ -5068,7 +5043,7 @@ export enum ConfigType { Salesforce = "Salesforce", SapERP = "SapErp", SapHana = "SapHana", - SapS4Hana = "SapS4Hana", + SapSuccessFactors = "SapSuccessFactors", ServiceNow = "ServiceNow", SharePoint = "SharePoint", Sigma = "Sigma", diff --git a/openmetadata-ui/src/main/resources/ui/src/generated/metadataIngestion/workflow.ts b/openmetadata-ui/src/main/resources/ui/src/generated/metadataIngestion/workflow.ts index c2490c28cbb4..b311292a6c2d 100644 --- a/openmetadata-ui/src/main/resources/ui/src/generated/metadataIngestion/workflow.ts +++ b/openmetadata-ui/src/main/resources/ui/src/generated/metadataIngestion/workflow.ts @@ -186,8 +186,6 @@ export interface ServiceConnection { * SQL Server Reporting Services (SSRS) provides a set of on-premises tools and services to * create, deploy, and manage paginated reports * - * SAP S/4HANA Connection Config for Embedded Analytics - * * Google BigQuery Connection Config * * Google BigTable Connection Config @@ -236,6 +234,8 @@ export interface ServiceConnection { * * Salesforce Connection Config * + * SAP SuccessFactors Connection Config + * * SingleStore Database Connection Config * * Snowflake Connection Config @@ -430,9 +430,6 @@ export interface ConfigObject { /** * SSL Configuration details. * - * CA certificate, client certificate, and private key for SSL validation. Required when - * verifySSL is 'validate'. - * * SSL Configuration details for DB2 connection. Provide CA certificate for server * validation, and optionally client certificate and key for mutual TLS authentication. * @@ -496,9 +493,6 @@ export interface ConfigObject { * * Client SSL verification. * - * Client SSL verification. Use 'no-ssl' for plain HTTP, 'ignore' to skip certificate - * validation, 'validate' to verify against a CA certificate. - * * Flag to verify SSL Certificate for OpenMetadata Server. * * Boolean marking if we need to verify the SSL certs for KafkaConnect REST API. True by @@ -520,6 +514,8 @@ export interface ConfigObject { * * client_id for Sigma. * + * OAuth2 Client ID. Required when authType is OAuth2Credentials. + * * Azure Application (client) ID for service principal authentication. * * Azure Application (client) ID for Service Principal authentication. @@ -589,8 +585,6 @@ export interface ConfigObject { * * Host and Port of the Ssrs instance. * - * Base URL of the SAP S/4HANA instance (e.g. https://s4hana.example.com). - * * BigQuery APIs URL. * * Host and port of the AzureSQL service. @@ -751,6 +745,8 @@ export interface ConfigObject { * * Password to connect to Salesforce. * + * Password for BasicAuth authentication. Required when authType is BasicAuth. + * * Password to connect to SingleStore. * * Password to connect to Snowflake. @@ -850,6 +846,11 @@ export interface ConfigObject { * Username to connect to Salesforce. This user should have privileges to read all the * metadata in Salesforce. * + * SAP SuccessFactors user login name. For BasicAuth: used as the credential username. For + * OAuth2Credentials: used as the SAML NameID — the user on whose behalf the token is + * requested. The user must exist in the SF system and be permitted to use the OAuth2 + * application. + * * Username to connect to SingleStore. This user should have privileges to read all the * metadata in MySQL. * @@ -989,6 +990,8 @@ export interface ConfigObject { * * ThoughtSpot API version to use * + * SAP SuccessFactors OData API version. + * * OpenMetadata server API version to use. * * Airbyte API version. @@ -997,15 +1000,14 @@ export interface ConfigObject { /** * Types of methods used to authenticate to the tableau instance * - * Choose Basic Auth (username/password) for on-premise or OAuth 2.0 Client Credentials for - * SAP S/4HANA Cloud. - * * Choose between different authentication types for Databricks. * * Choose Auth Config Type. * * Choose Auth Configuration Type. * + * Choose how to authenticate with SAP SuccessFactors OData API. + * * Choose between Dremio Cloud (SaaS) or Dremio Software (self-hosted) authentication. * * Types of methods used to authenticate to the alation instance @@ -1014,7 +1016,7 @@ export interface ConfigObject { * * Authentication method: username/password or SSH private key */ - authType?: AuthenticationType | NoConfigAuthenticationTypes; + authType?: AuthenticationTypeForTableau | NoConfigAuthenticationTypes; /** * Pagination limit used while querying the tableau metadata API for getting data sources * @@ -1156,14 +1158,6 @@ export interface ConfigObject { * Type of token to use for authentication */ tokenType?: TokenType; - /** - * SAP client number (Mandant), typically a 3-digit string (e.g. '100'). - */ - clientNumber?: string; - /** - * Supports Lineage Extraction. - */ - supportsLineageExtraction?: boolean; /** * Billing Project ID */ @@ -1227,9 +1221,13 @@ export interface ConfigObject { supportsDataDiff?: boolean; supportsDBTExtraction?: boolean; supportsIncrementalMetadataExtraction?: boolean; - supportsProfiler?: boolean; - supportsQueryComment?: boolean; - supportsSystemProfile?: boolean; + /** + * Supports Lineage Extraction. + */ + supportsLineageExtraction?: boolean; + supportsProfiler?: boolean; + supportsQueryComment?: boolean; + supportsSystemProfile?: boolean; /** * Supports Usage Extraction. */ @@ -1582,6 +1580,26 @@ export interface ConfigObject { * fetched. Leave empty to fetch all objects (subject to tableFilterPattern). */ sobjectNames?: string[]; + /** + * SAP SuccessFactors OData API base URL. For example: https://api4.successfactors.com + */ + baseUrl?: string; + /** + * SAP SuccessFactors Company ID (tenant identifier). Required for all API calls. + */ + companyId?: string; + /** + * PEM-encoded RSA private key used to sign SAML assertions for OAuth2 SAML Bearer flow. + * Required when authType is OAuth2Credentials. + * + * Connection to Snowflake instance via Private Key + */ + privateKey?: string; + /** + * OAuth2 Token endpoint URL. Required when authType is OAuth2Credentials. For example: + * https://api4.successfactors.com/oauth/token + */ + tokenUrl?: string; /** * If the Snowflake URL is https://xyz1234.us-east-1.gcp.snowflakecomputing.com, then the * account is xyz1234.us-east-1.gcp @@ -1618,10 +1636,6 @@ export interface ConfigObject { * TRANSIENT tables. */ includeTransientTables?: boolean; - /** - * Connection to Snowflake instance via Private Key - */ - privateKey?: string; /** * Session query tag used to monitor usage on snowflake. To use a query tag snowflake user * should have enough privileges to alter the session. @@ -2536,13 +2550,6 @@ export enum AuthProvider { * * Access Token Auth Credentials * - * Choose Basic Auth (username/password) for on-premise or OAuth 2.0 Client Credentials for - * SAP S/4HANA Cloud. - * - * Username and password credentials for SAP S/4HANA. - * - * OAuth 2.0 client credentials for SAP S/4HANA Cloud. - * * Choose between different authentication types for Databricks. * * Personal Access Token authentication for Databricks. @@ -2603,12 +2610,10 @@ export enum AuthProvider { * * SSH private key authentication for SFTP */ -export interface AuthenticationType { +export interface AuthenticationTypeForTableau { /** * Password to access the service. * - * Password to authenticate with SAP S/4HANA. - * * Password to connect to source. * * Database user password. Leave empty if using IAM database authentication. @@ -2625,8 +2630,6 @@ export interface AuthenticationType { /** * Username to access the service. * - * Username to authenticate with SAP S/4HANA. - * * Username for authenticating with Dremio Software. This user should have appropriate * permissions to access metadata. * @@ -2646,32 +2649,20 @@ export interface AuthenticationType { */ personalAccessTokenSecret?: string; /** - * Authentication type identifier. + * Generated Personal Access Token for Databricks workspace authentication. This token is + * created from User Settings -> Developer -> Access Tokens in your Databricks workspace. */ - authType?: AuthType; + token?: string; /** - * OAuth 2.0 client ID registered in SAP. - * * Service Principal Application ID created in your Databricks Account Console for OAuth * Machine-to-Machine authentication. */ clientId?: string; /** - * OAuth 2.0 client secret. - * * OAuth Secret generated for the Service Principal in Databricks Account Console. Used for * secure OAuth2 authentication. */ clientSecret?: string; - /** - * OAuth 2.0 token endpoint URL (e.g. /sap/bc/security/oauth2/token). - */ - tokenEndpoint?: string; - /** - * Generated Personal Access Token for Databricks workspace authentication. This token is - * created from User Settings -> Developer -> Access Tokens in your Databricks workspace. - */ - token?: string; /** * Azure Service Principal Application (client) ID registered in your Azure Active Directory. */ @@ -2790,14 +2781,6 @@ export interface AuthenticationType { privateKeyPassphrase?: string; } -/** - * Authentication type identifier. - */ -export enum AuthType { - Basic = "basic", - Oauth2 = "oauth2", -} - /** * AWS credentials required to access the S3 file. * @@ -3051,10 +3034,16 @@ export enum CloudRegion { } /** + * Choose how to authenticate with SAP SuccessFactors OData API. + * + * Authentication type to connect to SAP SuccessFactors. + * * Database Authentication types not requiring config. */ export enum NoConfigAuthenticationTypes { + BasicAuth = "BasicAuth", OAuth2 = "OAuth2", + OAuth2Credentials = "OAuth2Credentials", } /** @@ -3256,9 +3245,6 @@ export enum KafkaSecurityProtocol { * * SSL Configuration details. * - * CA certificate, client certificate, and private key for SSL validation. Required when - * verifySSL is 'validate'. - * * SSL Configuration details for DB2 connection. Provide CA certificate for server * validation, and optionally client certificate and key for mutual TLS authentication. * @@ -4005,9 +3991,6 @@ export enum ConnectionScheme { * * SSL Configuration details. * - * CA certificate, client certificate, and private key for SSL validation. Required when - * verifySSL is 'validate'. - * * SSL Configuration details for DB2 connection. Provide CA certificate for server * validation, and optionally client certificate and key for mutual TLS authentication. * @@ -4082,9 +4065,6 @@ export enum ConnectionType { * * Client SSL verification. * - * Client SSL verification. Use 'no-ssl' for plain HTTP, 'ignore' to skip certificate - * validation, 'validate' to verify against a CA certificate. - * * Flag to verify SSL Certificate for OpenMetadata Server. * * SSL/TLS verification mode when fetching dbt artifacts over HTTPS. @@ -4826,9 +4806,6 @@ export enum SpaceType { * * SSL Configuration details. * - * CA certificate, client certificate, and private key for SSL validation. Required when - * verifySSL is 'validate'. - * * SSL Configuration details for DB2 connection. Provide CA certificate for server * validation, and optionally client certificate and key for mutual TLS authentication. * @@ -4982,8 +4959,6 @@ export enum TokenType { * * Service type. * - * SAP S/4HANA service type - * * Custom database service type * * Kafka service type @@ -5139,7 +5114,7 @@ export enum PurpleType { Salesforce = "Salesforce", SapERP = "SapErp", SapHana = "SapHana", - SapS4Hana = "SapS4Hana", + SapSuccessFactors = "SapSuccessFactors", ServiceNow = "ServiceNow", SharePoint = "SharePoint", Sigma = "Sigma", @@ -7210,10 +7185,6 @@ export interface LineageInformation { * List of Database Service Names for creation of lineage */ dbServiceNames?: string[]; - /** - * List of Messaging Service Names for creation of lineage - */ - messagingServiceNames?: string[]; /** * List of Storage Service Names for creation of lineage */ diff --git a/openmetadata-ui/src/main/resources/ui/src/utils/ServiceUtilClassBase.ts b/openmetadata-ui/src/main/resources/ui/src/utils/ServiceUtilClassBase.ts index fc419448aa3b..0a445fb9e5b8 100644 --- a/openmetadata-ui/src/main/resources/ui/src/utils/ServiceUtilClassBase.ts +++ b/openmetadata-ui/src/main/resources/ui/src/utils/ServiceUtilClassBase.ts @@ -107,6 +107,7 @@ class ServiceUtilClassBase { PipelineServiceType.Mulesoft, DatabaseServiceType.MicrosoftAccess, DashboardServiceType.SapS4Hana, + DatabaseServiceType.SapSuccessFactors, ]; DatabaseServiceTypeSmallCase = this.convertEnumToLowerCase< From 6d50a7e9ca1f628065dfe95ec11c58b7bd4a663c Mon Sep 17 00:00:00 2001 From: varun-lakhyani Date: Fri, 24 Apr 2026 14:07:56 +0530 Subject: [PATCH 2/3] resolve-conflict --- .../api/automations/createWorkflow.ts | 63 +++++++++++++ .../createIngestionPipeline.ts | 91 ++++++++++++++++--- .../automations/testServiceConnection.ts | 63 +++++++++++++ .../generated/entity/automations/workflow.ts | 63 +++++++++++++ .../services/connections/serviceConnection.ts | 87 +++++++++++++++--- .../ingestionPipelines/ingestionPipeline.ts | 91 ++++++++++++++++--- .../metadataIngestion/testSuitePipeline.ts | 87 +++++++++++++++--- .../generated/metadataIngestion/workflow.ts | 91 ++++++++++++++++--- 8 files changed, 576 insertions(+), 60 deletions(-) diff --git a/openmetadata-ui/src/main/resources/ui/src/generated/api/automations/createWorkflow.ts b/openmetadata-ui/src/main/resources/ui/src/generated/api/automations/createWorkflow.ts index 7268b81fe550..0e69ff8f6dd4 100644 --- a/openmetadata-ui/src/main/resources/ui/src/generated/api/automations/createWorkflow.ts +++ b/openmetadata-ui/src/main/resources/ui/src/generated/api/automations/createWorkflow.ts @@ -342,6 +342,8 @@ export interface RequestConnection { * SQL Server Reporting Services (SSRS) provides a set of on-premises tools and services to * create, deploy, and manage paginated reports * + * SAP S/4HANA Connection Config for Embedded Analytics + * * Kafka Connection Config * * Redpanda Connection Config @@ -480,6 +482,9 @@ export interface ConfigObject { * SSL Configuration details. Provide the CA certificate to validate the Informix server * certificate. Paste the PEM content directly or upload the certificate file. * + * CA certificate, client certificate, and private key for SSL validation. Required when + * verifySSL is 'validate'. + * * SSL Configuration for OpenMetadata Server */ sslConfig?: SSLConfigObject; @@ -534,6 +539,9 @@ export interface ConfigObject { * * Boolean marking if we need to verify the SSL certs for Grafana. Default to True. * + * Client SSL verification. Use 'no-ssl' for plain HTTP, 'ignore' to skip certificate + * validation, 'validate' to verify against a CA certificate. + * * Boolean marking if we need to verify the SSL certs for KafkaConnect REST API. True by * default. * @@ -673,6 +681,8 @@ export interface ConfigObject { * * Host and Port of the Ssrs instance. * + * Base URL of the SAP S/4HANA instance (e.g. https://s4hana.example.com). + * * Pub/Sub APIs URL. For local testing with the emulator, use http://localhost:8085. * * Pipeline Service Management/UI URI. @@ -1125,6 +1135,9 @@ export interface ConfigObject { * * Types of methods used to authenticate to the tableau instance * + * Choose Basic Auth (username/password) for on-premise or OAuth 2.0 Client Credentials for + * SAP S/4HANA Cloud. + * * Types of methods used to authenticate to the alation instance * * Authentication type to connect to Apache Ranger. @@ -1825,6 +1838,10 @@ export interface ConfigObject { * Type of token to use for authentication */ tokenType?: TokenType; + /** + * SAP client number (Mandant), typically a 3-digit string (e.g. '100'). + */ + clientNumber?: string; /** * basic.auth.user.info schema registry config property, Client HTTP credentials in the form * of username:password. @@ -2567,6 +2584,13 @@ export enum AuthProvider { * * Access Token Auth Credentials * + * Choose Basic Auth (username/password) for on-premise or OAuth 2.0 Client Credentials for + * SAP S/4HANA Cloud. + * + * Username and password credentials for SAP S/4HANA. + * + * OAuth 2.0 client credentials for SAP S/4HANA Cloud. + * * ThoughtSpot authentication configuration * * Types of methods used to authenticate to the alation instance @@ -2604,11 +2628,15 @@ export interface AuthenticationType { /** * Service Principal Application ID created in your Databricks Account Console for OAuth * Machine-to-Machine authentication. + * + * OAuth 2.0 client ID registered in SAP. */ clientId?: string; /** * OAuth Secret generated for the Service Principal in Databricks Account Console. Used for * secure OAuth2 authentication. + * + * OAuth 2.0 client secret. */ clientSecret?: string; /** @@ -2632,6 +2660,8 @@ export interface AuthenticationType { * * Password to access the service. * + * Password to authenticate with SAP S/4HANA. + * * Elastic Search Password for Login * * Ranger password to authenticate to the API. @@ -2683,6 +2713,8 @@ export interface AuthenticationType { * * Username to access the service. * + * Username to authenticate with SAP S/4HANA. + * * Elastic Search Username for Login * * Ranger user to authenticate to the API. @@ -2698,6 +2730,14 @@ export interface AuthenticationType { * Personal Access Token Secret. */ personalAccessTokenSecret?: string; + /** + * Authentication type identifier. + */ + authType?: AuthType; + /** + * OAuth 2.0 token endpoint URL (e.g. /sap/bc/security/oauth2/token). + */ + tokenEndpoint?: string; /** * Access Token for the API */ @@ -2766,6 +2806,14 @@ export interface AuthenticationType { privateKeyPassphrase?: string; } +/** + * Authentication type identifier. + */ +export enum AuthType { + Basic = "basic", + Oauth2 = "oauth2", +} + /** * AWS credentials required to access the S3 file. * @@ -3239,6 +3287,9 @@ export enum KafkaSecurityProtocol { * SSL Configuration details. Provide the CA certificate to validate the Informix server * certificate. Paste the PEM content directly or upload the certificate file. * + * CA certificate, client certificate, and private key for SSL validation. Required when + * verifySSL is 'validate'. + * * Consumer Config SSL Config. Configuration for enabling SSL for the Consumer Config * connection. * @@ -3982,6 +4033,9 @@ export enum ConnectionScheme { * SSL Configuration details. Provide the CA certificate to validate the Informix server * certificate. Paste the PEM content directly or upload the certificate file. * + * CA certificate, client certificate, and private key for SSL validation. Required when + * verifySSL is 'validate'. + * * Consumer Config SSL Config. Configuration for enabling SSL for the Consumer Config * connection. * @@ -4044,6 +4098,9 @@ export enum ConnectionType { * * Client SSL verification. * + * Client SSL verification. Use 'no-ssl' for plain HTTP, 'ignore' to skip certificate + * validation, 'validate' to verify against a CA certificate. + * * Flag to verify SSL Certificate for OpenMetadata Server. */ export enum VerifySSL { @@ -4742,6 +4799,9 @@ export enum SpaceType { * SSL Configuration details. Provide the CA certificate to validate the Informix server * certificate. Paste the PEM content directly or upload the certificate file. * + * CA certificate, client certificate, and private key for SSL validation. Required when + * verifySSL is 'validate'. + * * Consumer Config SSL Config. Configuration for enabling SSL for the Consumer Config * connection. * @@ -4885,6 +4945,8 @@ export enum TokenType { * * Grafana service type * + * SAP S/4HANA service type + * * Kafka service type * * Redpanda service type @@ -5035,6 +5097,7 @@ export enum ConfigType { Salesforce = "Salesforce", SapERP = "SapErp", SapHana = "SapHana", + SapS4Hana = "SapS4Hana", SapSuccessFactors = "SapSuccessFactors", ServiceNow = "ServiceNow", SharePoint = "SharePoint", diff --git a/openmetadata-ui/src/main/resources/ui/src/generated/api/services/ingestionPipelines/createIngestionPipeline.ts b/openmetadata-ui/src/main/resources/ui/src/generated/api/services/ingestionPipelines/createIngestionPipeline.ts index 61c7022c2745..70bc53003886 100644 --- a/openmetadata-ui/src/main/resources/ui/src/generated/api/services/ingestionPipelines/createIngestionPipeline.ts +++ b/openmetadata-ui/src/main/resources/ui/src/generated/api/services/ingestionPipelines/createIngestionPipeline.ts @@ -2300,6 +2300,9 @@ export interface DBTPrefixConfig { * * SSL Configuration details. * + * CA certificate, client certificate, and private key for SSL validation. Required when + * verifySSL is 'validate'. + * * SSL Configuration details for DB2 connection. Provide CA certificate for server * validation, and optionally client certificate and key for mutual TLS authentication. * @@ -2553,6 +2556,9 @@ export interface GCPImpersonateServiceAccountValues { * * Client SSL verification. * + * Client SSL verification. Use 'no-ssl' for plain HTTP, 'ignore' to skip certificate + * validation, 'validate' to verify against a CA certificate. + * * Flag to verify SSL Certificate for OpenMetadata Server. * * SSL/TLS verification mode when fetching dbt artifacts over HTTPS. @@ -2598,6 +2604,10 @@ export interface LineageInformation { * List of Database Service Names for creation of lineage */ dbServiceNames?: string[]; + /** + * List of Messaging Service Names for creation of lineage + */ + messagingServiceNames?: string[]; /** * List of Storage Service Names for creation of lineage */ @@ -2991,6 +3001,8 @@ export interface ServiceConnection { * SQL Server Reporting Services (SSRS) provides a set of on-premises tools and services to * create, deploy, and manage paginated reports * + * SAP S/4HANA Connection Config for Embedded Analytics + * * Google BigQuery Connection Config * * Google BigTable Connection Config @@ -3235,6 +3247,9 @@ export interface ConfigObject { /** * SSL Configuration details. * + * CA certificate, client certificate, and private key for SSL validation. Required when + * verifySSL is 'validate'. + * * SSL Configuration details for DB2 connection. Provide CA certificate for server * validation, and optionally client certificate and key for mutual TLS authentication. * @@ -3298,6 +3313,9 @@ export interface ConfigObject { * * Client SSL verification. * + * Client SSL verification. Use 'no-ssl' for plain HTTP, 'ignore' to skip certificate + * validation, 'validate' to verify against a CA certificate. + * * Flag to verify SSL Certificate for OpenMetadata Server. * * Boolean marking if we need to verify the SSL certs for KafkaConnect REST API. True by @@ -3390,6 +3408,8 @@ export interface ConfigObject { * * Host and Port of the Ssrs instance. * + * Base URL of the SAP S/4HANA instance (e.g. https://s4hana.example.com). + * * BigQuery APIs URL. * * Host and port of the AzureSQL service. @@ -3805,6 +3825,9 @@ export interface ConfigObject { /** * Types of methods used to authenticate to the tableau instance * + * Choose Basic Auth (username/password) for on-premise or OAuth 2.0 Client Credentials for + * SAP S/4HANA Cloud. + * * Choose between different authentication types for Databricks. * * Choose Auth Config Type. @@ -3821,7 +3844,7 @@ export interface ConfigObject { * * Authentication method: username/password or SSH private key */ - authType?: AuthenticationTypeForTableau | NoConfigAuthenticationTypes; + authType?: AuthenticationType | NoConfigAuthenticationTypes; /** * Pagination limit used while querying the tableau metadata API for getting data sources * @@ -3963,6 +3986,14 @@ export interface ConfigObject { * Type of token to use for authentication */ tokenType?: TokenType; + /** + * SAP client number (Mandant), typically a 3-digit string (e.g. '100'). + */ + clientNumber?: string; + /** + * Supports Lineage Extraction. + */ + supportsLineageExtraction?: boolean; /** * Billing Project ID */ @@ -4026,13 +4057,9 @@ export interface ConfigObject { supportsDataDiff?: boolean; supportsDBTExtraction?: boolean; supportsIncrementalMetadataExtraction?: boolean; - /** - * Supports Lineage Extraction. - */ - supportsLineageExtraction?: boolean; - supportsProfiler?: boolean; - supportsQueryComment?: boolean; - supportsSystemProfile?: boolean; + supportsProfiler?: boolean; + supportsQueryComment?: boolean; + supportsSystemProfile?: boolean; /** * Supports Usage Extraction. */ @@ -5252,6 +5279,13 @@ export enum AuthProvider { * * Access Token Auth Credentials * + * Choose Basic Auth (username/password) for on-premise or OAuth 2.0 Client Credentials for + * SAP S/4HANA Cloud. + * + * Username and password credentials for SAP S/4HANA. + * + * OAuth 2.0 client credentials for SAP S/4HANA Cloud. + * * Choose between different authentication types for Databricks. * * Personal Access Token authentication for Databricks. @@ -5312,10 +5346,12 @@ export enum AuthProvider { * * SSH private key authentication for SFTP */ -export interface AuthenticationTypeForTableau { +export interface AuthenticationType { /** * Password to access the service. * + * Password to authenticate with SAP S/4HANA. + * * Password to connect to source. * * Database user password. Leave empty if using IAM database authentication. @@ -5332,6 +5368,8 @@ export interface AuthenticationTypeForTableau { /** * Username to access the service. * + * Username to authenticate with SAP S/4HANA. + * * Username for authenticating with Dremio Software. This user should have appropriate * permissions to access metadata. * @@ -5351,20 +5389,32 @@ export interface AuthenticationTypeForTableau { */ personalAccessTokenSecret?: string; /** - * Generated Personal Access Token for Databricks workspace authentication. This token is - * created from User Settings -> Developer -> Access Tokens in your Databricks workspace. + * Authentication type identifier. */ - token?: string; + authType?: AuthType; /** + * OAuth 2.0 client ID registered in SAP. + * * Service Principal Application ID created in your Databricks Account Console for OAuth * Machine-to-Machine authentication. */ clientId?: string; /** + * OAuth 2.0 client secret. + * * OAuth Secret generated for the Service Principal in Databricks Account Console. Used for * secure OAuth2 authentication. */ clientSecret?: string; + /** + * OAuth 2.0 token endpoint URL (e.g. /sap/bc/security/oauth2/token). + */ + tokenEndpoint?: string; + /** + * Generated Personal Access Token for Databricks workspace authentication. This token is + * created from User Settings -> Developer -> Access Tokens in your Databricks workspace. + */ + token?: string; /** * Azure Service Principal Application (client) ID registered in your Azure Active Directory. */ @@ -5483,6 +5533,14 @@ export interface AuthenticationTypeForTableau { privateKeyPassphrase?: string; } +/** + * Authentication type identifier. + */ +export enum AuthType { + Basic = "basic", + Oauth2 = "oauth2", +} + /** * AWS credentials configs. * @@ -6440,6 +6498,9 @@ export enum ConnectionScheme { * * SSL Configuration details. * + * CA certificate, client certificate, and private key for SSL validation. Required when + * verifySSL is 'validate'. + * * SSL Configuration details for DB2 connection. Provide CA certificate for server * validation, and optionally client certificate and key for mutual TLS authentication. * @@ -7228,6 +7289,9 @@ export enum SpaceType { * * SSL Configuration details. * + * CA certificate, client certificate, and private key for SSL validation. Required when + * verifySSL is 'validate'. + * * SSL Configuration details for DB2 connection. Provide CA certificate for server * validation, and optionally client certificate and key for mutual TLS authentication. * @@ -7381,6 +7445,8 @@ export enum TokenType { * * Service type. * + * SAP S/4HANA service type + * * Custom database service type * * Kafka service type @@ -7536,6 +7602,7 @@ export enum PurpleType { Salesforce = "Salesforce", SapERP = "SapErp", SapHana = "SapHana", + SapS4Hana = "SapS4Hana", SapSuccessFactors = "SapSuccessFactors", ServiceNow = "ServiceNow", SharePoint = "SharePoint", diff --git a/openmetadata-ui/src/main/resources/ui/src/generated/entity/automations/testServiceConnection.ts b/openmetadata-ui/src/main/resources/ui/src/generated/entity/automations/testServiceConnection.ts index 23d6de0806a6..37e72042ebba 100644 --- a/openmetadata-ui/src/main/resources/ui/src/generated/entity/automations/testServiceConnection.ts +++ b/openmetadata-ui/src/main/resources/ui/src/generated/entity/automations/testServiceConnection.ts @@ -224,6 +224,8 @@ export interface TestServiceConnectionConnection { * SQL Server Reporting Services (SSRS) provides a set of on-premises tools and services to * create, deploy, and manage paginated reports * + * SAP S/4HANA Connection Config for Embedded Analytics + * * Kafka Connection Config * * Redpanda Connection Config @@ -362,6 +364,9 @@ export interface ConfigObject { * SSL Configuration details. Provide the CA certificate to validate the Informix server * certificate. Paste the PEM content directly or upload the certificate file. * + * CA certificate, client certificate, and private key for SSL validation. Required when + * verifySSL is 'validate'. + * * SSL Configuration for OpenMetadata Server */ sslConfig?: SSLConfigObject; @@ -416,6 +421,9 @@ export interface ConfigObject { * * Boolean marking if we need to verify the SSL certs for Grafana. Default to True. * + * Client SSL verification. Use 'no-ssl' for plain HTTP, 'ignore' to skip certificate + * validation, 'validate' to verify against a CA certificate. + * * Boolean marking if we need to verify the SSL certs for KafkaConnect REST API. True by * default. * @@ -555,6 +563,8 @@ export interface ConfigObject { * * Host and Port of the Ssrs instance. * + * Base URL of the SAP S/4HANA instance (e.g. https://s4hana.example.com). + * * Pub/Sub APIs URL. For local testing with the emulator, use http://localhost:8085. * * Pipeline Service Management/UI URI. @@ -1007,6 +1017,9 @@ export interface ConfigObject { * * Types of methods used to authenticate to the tableau instance * + * Choose Basic Auth (username/password) for on-premise or OAuth 2.0 Client Credentials for + * SAP S/4HANA Cloud. + * * Types of methods used to authenticate to the alation instance * * Authentication type to connect to Apache Ranger. @@ -1707,6 +1720,10 @@ export interface ConfigObject { * Type of token to use for authentication */ tokenType?: TokenType; + /** + * SAP client number (Mandant), typically a 3-digit string (e.g. '100'). + */ + clientNumber?: string; /** * basic.auth.user.info schema registry config property, Client HTTP credentials in the form * of username:password. @@ -2449,6 +2466,13 @@ export enum AuthProvider { * * Access Token Auth Credentials * + * Choose Basic Auth (username/password) for on-premise or OAuth 2.0 Client Credentials for + * SAP S/4HANA Cloud. + * + * Username and password credentials for SAP S/4HANA. + * + * OAuth 2.0 client credentials for SAP S/4HANA Cloud. + * * ThoughtSpot authentication configuration * * Types of methods used to authenticate to the alation instance @@ -2486,11 +2510,15 @@ export interface AuthenticationType { /** * Service Principal Application ID created in your Databricks Account Console for OAuth * Machine-to-Machine authentication. + * + * OAuth 2.0 client ID registered in SAP. */ clientId?: string; /** * OAuth Secret generated for the Service Principal in Databricks Account Console. Used for * secure OAuth2 authentication. + * + * OAuth 2.0 client secret. */ clientSecret?: string; /** @@ -2514,6 +2542,8 @@ export interface AuthenticationType { * * Password to access the service. * + * Password to authenticate with SAP S/4HANA. + * * Elastic Search Password for Login * * Ranger password to authenticate to the API. @@ -2565,6 +2595,8 @@ export interface AuthenticationType { * * Username to access the service. * + * Username to authenticate with SAP S/4HANA. + * * Elastic Search Username for Login * * Ranger user to authenticate to the API. @@ -2580,6 +2612,14 @@ export interface AuthenticationType { * Personal Access Token Secret. */ personalAccessTokenSecret?: string; + /** + * Authentication type identifier. + */ + authType?: AuthType; + /** + * OAuth 2.0 token endpoint URL (e.g. /sap/bc/security/oauth2/token). + */ + tokenEndpoint?: string; /** * Access Token for the API */ @@ -2648,6 +2688,14 @@ export interface AuthenticationType { privateKeyPassphrase?: string; } +/** + * Authentication type identifier. + */ +export enum AuthType { + Basic = "basic", + Oauth2 = "oauth2", +} + /** * AWS credentials required to access the S3 file. * @@ -3121,6 +3169,9 @@ export enum KafkaSecurityProtocol { * SSL Configuration details. Provide the CA certificate to validate the Informix server * certificate. Paste the PEM content directly or upload the certificate file. * + * CA certificate, client certificate, and private key for SSL validation. Required when + * verifySSL is 'validate'. + * * Consumer Config SSL Config. Configuration for enabling SSL for the Consumer Config * connection. * @@ -3864,6 +3915,9 @@ export enum ConnectionScheme { * SSL Configuration details. Provide the CA certificate to validate the Informix server * certificate. Paste the PEM content directly or upload the certificate file. * + * CA certificate, client certificate, and private key for SSL validation. Required when + * verifySSL is 'validate'. + * * Consumer Config SSL Config. Configuration for enabling SSL for the Consumer Config * connection. * @@ -3926,6 +3980,9 @@ export enum ConnectionType { * * Client SSL verification. * + * Client SSL verification. Use 'no-ssl' for plain HTTP, 'ignore' to skip certificate + * validation, 'validate' to verify against a CA certificate. + * * Flag to verify SSL Certificate for OpenMetadata Server. */ export enum VerifySSL { @@ -4624,6 +4681,9 @@ export enum SpaceType { * SSL Configuration details. Provide the CA certificate to validate the Informix server * certificate. Paste the PEM content directly or upload the certificate file. * + * CA certificate, client certificate, and private key for SSL validation. Required when + * verifySSL is 'validate'. + * * Consumer Config SSL Config. Configuration for enabling SSL for the Consumer Config * connection. * @@ -4767,6 +4827,8 @@ export enum TokenType { * * Grafana service type * + * SAP S/4HANA service type + * * Kafka service type * * Redpanda service type @@ -4917,6 +4979,7 @@ export enum ConfigType { Salesforce = "Salesforce", SapERP = "SapErp", SapHana = "SapHana", + SapS4Hana = "SapS4Hana", SapSuccessFactors = "SapSuccessFactors", ServiceNow = "ServiceNow", SharePoint = "SharePoint", diff --git a/openmetadata-ui/src/main/resources/ui/src/generated/entity/automations/workflow.ts b/openmetadata-ui/src/main/resources/ui/src/generated/entity/automations/workflow.ts index 599e6817661b..011e4da9dce3 100644 --- a/openmetadata-ui/src/main/resources/ui/src/generated/entity/automations/workflow.ts +++ b/openmetadata-ui/src/main/resources/ui/src/generated/entity/automations/workflow.ts @@ -540,6 +540,9 @@ export interface OpenMetadataJWTClientConfig { * SSL Configuration details. Provide the CA certificate to validate the Informix server * certificate. Paste the PEM content directly or upload the certificate file. * + * CA certificate, client certificate, and private key for SSL validation. Required when + * verifySSL is 'validate'. + * * Consumer Config SSL Config. Configuration for enabling SSL for the Consumer Config * connection. * @@ -578,6 +581,9 @@ export enum OpenmetadataType { * Client SSL verification. Make sure to configure the SSLConfig if enabled. * * Client SSL verification. + * + * Client SSL verification. Use 'no-ssl' for plain HTTP, 'ignore' to skip certificate + * validation, 'validate' to verify against a CA certificate. */ export enum VerifySSL { Ignore = "ignore", @@ -880,6 +886,8 @@ export interface RequestConnection { * SQL Server Reporting Services (SSRS) provides a set of on-premises tools and services to * create, deploy, and manage paginated reports * + * SAP S/4HANA Connection Config for Embedded Analytics + * * Kafka Connection Config * * Redpanda Connection Config @@ -1018,6 +1026,9 @@ export interface ConfigObject { * SSL Configuration details. Provide the CA certificate to validate the Informix server * certificate. Paste the PEM content directly or upload the certificate file. * + * CA certificate, client certificate, and private key for SSL validation. Required when + * verifySSL is 'validate'. + * * SSL Configuration for OpenMetadata Server */ sslConfig?: SSLConfigObject; @@ -1072,6 +1083,9 @@ export interface ConfigObject { * * Boolean marking if we need to verify the SSL certs for Grafana. Default to True. * + * Client SSL verification. Use 'no-ssl' for plain HTTP, 'ignore' to skip certificate + * validation, 'validate' to verify against a CA certificate. + * * Boolean marking if we need to verify the SSL certs for KafkaConnect REST API. True by * default. * @@ -1211,6 +1225,8 @@ export interface ConfigObject { * * Host and Port of the Ssrs instance. * + * Base URL of the SAP S/4HANA instance (e.g. https://s4hana.example.com). + * * Pub/Sub APIs URL. For local testing with the emulator, use http://localhost:8085. * * Pipeline Service Management/UI URI. @@ -1663,6 +1679,9 @@ export interface ConfigObject { * * Types of methods used to authenticate to the tableau instance * + * Choose Basic Auth (username/password) for on-premise or OAuth 2.0 Client Credentials for + * SAP S/4HANA Cloud. + * * Types of methods used to authenticate to the alation instance * * Authentication type to connect to Apache Ranger. @@ -2363,6 +2382,10 @@ export interface ConfigObject { * Type of token to use for authentication */ tokenType?: TokenType; + /** + * SAP client number (Mandant), typically a 3-digit string (e.g. '100'). + */ + clientNumber?: string; /** * basic.auth.user.info schema registry config property, Client HTTP credentials in the form * of username:password. @@ -3000,6 +3023,13 @@ export enum AuthMechanismEnum { * * Access Token Auth Credentials * + * Choose Basic Auth (username/password) for on-premise or OAuth 2.0 Client Credentials for + * SAP S/4HANA Cloud. + * + * Username and password credentials for SAP S/4HANA. + * + * OAuth 2.0 client credentials for SAP S/4HANA Cloud. + * * ThoughtSpot authentication configuration * * Types of methods used to authenticate to the alation instance @@ -3037,11 +3067,15 @@ export interface AuthenticationType { /** * Service Principal Application ID created in your Databricks Account Console for OAuth * Machine-to-Machine authentication. + * + * OAuth 2.0 client ID registered in SAP. */ clientId?: string; /** * OAuth Secret generated for the Service Principal in Databricks Account Console. Used for * secure OAuth2 authentication. + * + * OAuth 2.0 client secret. */ clientSecret?: string; /** @@ -3065,6 +3099,8 @@ export interface AuthenticationType { * * Password to access the service. * + * Password to authenticate with SAP S/4HANA. + * * Elastic Search Password for Login * * Ranger password to authenticate to the API. @@ -3116,6 +3152,8 @@ export interface AuthenticationType { * * Username to access the service. * + * Username to authenticate with SAP S/4HANA. + * * Elastic Search Username for Login * * Ranger user to authenticate to the API. @@ -3131,6 +3169,14 @@ export interface AuthenticationType { * Personal Access Token Secret. */ personalAccessTokenSecret?: string; + /** + * Authentication type identifier. + */ + authType?: AuthType; + /** + * OAuth 2.0 token endpoint URL (e.g. /sap/bc/security/oauth2/token). + */ + tokenEndpoint?: string; /** * Access Token for the API */ @@ -3199,6 +3245,14 @@ export interface AuthenticationType { privateKeyPassphrase?: string; } +/** + * Authentication type identifier. + */ +export enum AuthType { + Basic = "basic", + Oauth2 = "oauth2", +} + /** * AWS credentials required to access the S3 file. * @@ -4378,6 +4432,9 @@ export enum ConnectionScheme { * SSL Configuration details. Provide the CA certificate to validate the Informix server * certificate. Paste the PEM content directly or upload the certificate file. * + * CA certificate, client certificate, and private key for SSL validation. Required when + * verifySSL is 'validate'. + * * Consumer Config SSL Config. Configuration for enabling SSL for the Consumer Config * connection. * @@ -5080,6 +5137,9 @@ export enum SpaceType { * SSL Configuration details. Provide the CA certificate to validate the Informix server * certificate. Paste the PEM content directly or upload the certificate file. * + * CA certificate, client certificate, and private key for SSL validation. Required when + * verifySSL is 'validate'. + * * Consumer Config SSL Config. Configuration for enabling SSL for the Consumer Config * connection. * @@ -5221,6 +5281,8 @@ export enum TokenType { * * Grafana service type * + * SAP S/4HANA service type + * * Kafka service type * * Redpanda service type @@ -5371,6 +5433,7 @@ export enum ConfigType { Salesforce = "Salesforce", SapERP = "SapErp", SapHana = "SapHana", + SapS4Hana = "SapS4Hana", SapSuccessFactors = "SapSuccessFactors", ServiceNow = "ServiceNow", SharePoint = "SharePoint", diff --git a/openmetadata-ui/src/main/resources/ui/src/generated/entity/services/connections/serviceConnection.ts b/openmetadata-ui/src/main/resources/ui/src/generated/entity/services/connections/serviceConnection.ts index 59c06b341519..c00b9b0cce78 100644 --- a/openmetadata-ui/src/main/resources/ui/src/generated/entity/services/connections/serviceConnection.ts +++ b/openmetadata-ui/src/main/resources/ui/src/generated/entity/services/connections/serviceConnection.ts @@ -97,6 +97,8 @@ export interface ServiceConnectionClass { * SQL Server Reporting Services (SSRS) provides a set of on-premises tools and services to * create, deploy, and manage paginated reports * + * SAP S/4HANA Connection Config for Embedded Analytics + * * Google BigQuery Connection Config * * Google BigTable Connection Config @@ -341,6 +343,9 @@ export interface ConfigObject { /** * SSL Configuration details. * + * CA certificate, client certificate, and private key for SSL validation. Required when + * verifySSL is 'validate'. + * * SSL Configuration details for DB2 connection. Provide CA certificate for server * validation, and optionally client certificate and key for mutual TLS authentication. * @@ -404,6 +409,9 @@ export interface ConfigObject { * * Client SSL verification. * + * Client SSL verification. Use 'no-ssl' for plain HTTP, 'ignore' to skip certificate + * validation, 'validate' to verify against a CA certificate. + * * Flag to verify SSL Certificate for OpenMetadata Server. * * Boolean marking if we need to verify the SSL certs for KafkaConnect REST API. True by @@ -496,6 +504,8 @@ export interface ConfigObject { * * Host and Port of the Ssrs instance. * + * Base URL of the SAP S/4HANA instance (e.g. https://s4hana.example.com). + * * BigQuery APIs URL. * * Host and port of the AzureSQL service. @@ -911,6 +921,9 @@ export interface ConfigObject { /** * Types of methods used to authenticate to the tableau instance * + * Choose Basic Auth (username/password) for on-premise or OAuth 2.0 Client Credentials for + * SAP S/4HANA Cloud. + * * Choose between different authentication types for Databricks. * * Choose Auth Config Type. @@ -927,7 +940,7 @@ export interface ConfigObject { * * Authentication method: username/password or SSH private key */ - authType?: AuthenticationTypeForTableau | NoConfigAuthenticationTypes; + authType?: AuthenticationType | NoConfigAuthenticationTypes; /** * Pagination limit used while querying the tableau metadata API for getting data sources * @@ -1069,6 +1082,14 @@ export interface ConfigObject { * Type of token to use for authentication */ tokenType?: TokenType; + /** + * SAP client number (Mandant), typically a 3-digit string (e.g. '100'). + */ + clientNumber?: string; + /** + * Supports Lineage Extraction. + */ + supportsLineageExtraction?: boolean; /** * Billing Project ID */ @@ -1132,13 +1153,9 @@ export interface ConfigObject { supportsDataDiff?: boolean; supportsDBTExtraction?: boolean; supportsIncrementalMetadataExtraction?: boolean; - /** - * Supports Lineage Extraction. - */ - supportsLineageExtraction?: boolean; - supportsProfiler?: boolean; - supportsQueryComment?: boolean; - supportsSystemProfile?: boolean; + supportsProfiler?: boolean; + supportsQueryComment?: boolean; + supportsSystemProfile?: boolean; /** * Supports Usage Extraction. */ @@ -2446,6 +2463,13 @@ export enum AuthProvider { * * Access Token Auth Credentials * + * Choose Basic Auth (username/password) for on-premise or OAuth 2.0 Client Credentials for + * SAP S/4HANA Cloud. + * + * Username and password credentials for SAP S/4HANA. + * + * OAuth 2.0 client credentials for SAP S/4HANA Cloud. + * * Choose between different authentication types for Databricks. * * Personal Access Token authentication for Databricks. @@ -2506,10 +2530,12 @@ export enum AuthProvider { * * SSH private key authentication for SFTP */ -export interface AuthenticationTypeForTableau { +export interface AuthenticationType { /** * Password to access the service. * + * Password to authenticate with SAP S/4HANA. + * * Password to connect to source. * * Database user password. Leave empty if using IAM database authentication. @@ -2526,6 +2552,8 @@ export interface AuthenticationTypeForTableau { /** * Username to access the service. * + * Username to authenticate with SAP S/4HANA. + * * Username for authenticating with Dremio Software. This user should have appropriate * permissions to access metadata. * @@ -2545,20 +2573,32 @@ export interface AuthenticationTypeForTableau { */ personalAccessTokenSecret?: string; /** - * Generated Personal Access Token for Databricks workspace authentication. This token is - * created from User Settings -> Developer -> Access Tokens in your Databricks workspace. + * Authentication type identifier. */ - token?: string; + authType?: AuthType; /** + * OAuth 2.0 client ID registered in SAP. + * * Service Principal Application ID created in your Databricks Account Console for OAuth * Machine-to-Machine authentication. */ clientId?: string; /** + * OAuth 2.0 client secret. + * * OAuth Secret generated for the Service Principal in Databricks Account Console. Used for * secure OAuth2 authentication. */ clientSecret?: string; + /** + * OAuth 2.0 token endpoint URL (e.g. /sap/bc/security/oauth2/token). + */ + tokenEndpoint?: string; + /** + * Generated Personal Access Token for Databricks workspace authentication. This token is + * created from User Settings -> Developer -> Access Tokens in your Databricks workspace. + */ + token?: string; /** * Azure Service Principal Application (client) ID registered in your Azure Active Directory. */ @@ -2677,6 +2717,14 @@ export interface AuthenticationTypeForTableau { privateKeyPassphrase?: string; } +/** + * Authentication type identifier. + */ +export enum AuthType { + Basic = "basic", + Oauth2 = "oauth2", +} + /** * AWS credentials required to access the S3 file. * @@ -3141,6 +3189,9 @@ export enum KafkaSecurityProtocol { * * SSL Configuration details. * + * CA certificate, client certificate, and private key for SSL validation. Required when + * verifySSL is 'validate'. + * * SSL Configuration details for DB2 connection. Provide CA certificate for server * validation, and optionally client certificate and key for mutual TLS authentication. * @@ -3884,6 +3935,9 @@ export enum ConnectionScheme { * * SSL Configuration details. * + * CA certificate, client certificate, and private key for SSL validation. Required when + * verifySSL is 'validate'. + * * SSL Configuration details for DB2 connection. Provide CA certificate for server * validation, and optionally client certificate and key for mutual TLS authentication. * @@ -3955,6 +4009,9 @@ export enum ConnectionType { * * Client SSL verification. * + * Client SSL verification. Use 'no-ssl' for plain HTTP, 'ignore' to skip certificate + * validation, 'validate' to verify against a CA certificate. + * * Flag to verify SSL Certificate for OpenMetadata Server. */ export enum VerifySSL { @@ -4694,6 +4751,9 @@ export enum SpaceType { * * SSL Configuration details. * + * CA certificate, client certificate, and private key for SSL validation. Required when + * verifySSL is 'validate'. + * * SSL Configuration details for DB2 connection. Provide CA certificate for server * validation, and optionally client certificate and key for mutual TLS authentication. * @@ -4844,6 +4904,8 @@ export enum TokenType { * * Service type. * + * SAP S/4HANA service type + * * Custom database service type * * Kafka service type @@ -4999,6 +5061,7 @@ export enum ConfigType { Salesforce = "Salesforce", SapERP = "SapErp", SapHana = "SapHana", + SapS4Hana = "SapS4Hana", SapSuccessFactors = "SapSuccessFactors", ServiceNow = "ServiceNow", SharePoint = "SharePoint", diff --git a/openmetadata-ui/src/main/resources/ui/src/generated/entity/services/ingestionPipelines/ingestionPipeline.ts b/openmetadata-ui/src/main/resources/ui/src/generated/entity/services/ingestionPipelines/ingestionPipeline.ts index 2199ccfaa4b6..09e0a00f5bde 100644 --- a/openmetadata-ui/src/main/resources/ui/src/generated/entity/services/ingestionPipelines/ingestionPipeline.ts +++ b/openmetadata-ui/src/main/resources/ui/src/generated/entity/services/ingestionPipelines/ingestionPipeline.ts @@ -662,6 +662,9 @@ export interface OpenMetadataJWTClientConfig { * * SSL Configuration details. * + * CA certificate, client certificate, and private key for SSL validation. Required when + * verifySSL is 'validate'. + * * SSL Configuration details for DB2 connection. Provide CA certificate for server * validation, and optionally client certificate and key for mutual TLS authentication. * @@ -713,6 +716,9 @@ export enum OpenmetadataType { * * Client SSL verification. * + * Client SSL verification. Use 'no-ssl' for plain HTTP, 'ignore' to skip certificate + * validation, 'validate' to verify against a CA certificate. + * * SSL/TLS verification mode when fetching dbt artifacts over HTTPS. */ export enum VerifySSL { @@ -3130,6 +3136,10 @@ export interface LineageInformation { * List of Database Service Names for creation of lineage */ dbServiceNames?: string[]; + /** + * List of Messaging Service Names for creation of lineage + */ + messagingServiceNames?: string[]; /** * List of Storage Service Names for creation of lineage */ @@ -3523,6 +3533,8 @@ export interface ServiceConnection { * SQL Server Reporting Services (SSRS) provides a set of on-premises tools and services to * create, deploy, and manage paginated reports * + * SAP S/4HANA Connection Config for Embedded Analytics + * * Google BigQuery Connection Config * * Google BigTable Connection Config @@ -3767,6 +3779,9 @@ export interface ConfigObject { /** * SSL Configuration details. * + * CA certificate, client certificate, and private key for SSL validation. Required when + * verifySSL is 'validate'. + * * SSL Configuration details for DB2 connection. Provide CA certificate for server * validation, and optionally client certificate and key for mutual TLS authentication. * @@ -3830,6 +3845,9 @@ export interface ConfigObject { * * Client SSL verification. * + * Client SSL verification. Use 'no-ssl' for plain HTTP, 'ignore' to skip certificate + * validation, 'validate' to verify against a CA certificate. + * * Flag to verify SSL Certificate for OpenMetadata Server. * * Boolean marking if we need to verify the SSL certs for KafkaConnect REST API. True by @@ -3922,6 +3940,8 @@ export interface ConfigObject { * * Host and Port of the Ssrs instance. * + * Base URL of the SAP S/4HANA instance (e.g. https://s4hana.example.com). + * * BigQuery APIs URL. * * Host and port of the AzureSQL service. @@ -4337,6 +4357,9 @@ export interface ConfigObject { /** * Types of methods used to authenticate to the tableau instance * + * Choose Basic Auth (username/password) for on-premise or OAuth 2.0 Client Credentials for + * SAP S/4HANA Cloud. + * * Choose between different authentication types for Databricks. * * Choose Auth Config Type. @@ -4353,7 +4376,7 @@ export interface ConfigObject { * * Authentication method: username/password or SSH private key */ - authType?: AuthenticationTypeForTableau | NoConfigAuthenticationTypes; + authType?: AuthenticationType | NoConfigAuthenticationTypes; /** * Pagination limit used while querying the tableau metadata API for getting data sources * @@ -4495,6 +4518,14 @@ export interface ConfigObject { * Type of token to use for authentication */ tokenType?: TokenType; + /** + * SAP client number (Mandant), typically a 3-digit string (e.g. '100'). + */ + clientNumber?: string; + /** + * Supports Lineage Extraction. + */ + supportsLineageExtraction?: boolean; /** * Billing Project ID */ @@ -4558,13 +4589,9 @@ export interface ConfigObject { supportsDataDiff?: boolean; supportsDBTExtraction?: boolean; supportsIncrementalMetadataExtraction?: boolean; - /** - * Supports Lineage Extraction. - */ - supportsLineageExtraction?: boolean; - supportsProfiler?: boolean; - supportsQueryComment?: boolean; - supportsSystemProfile?: boolean; + supportsProfiler?: boolean; + supportsQueryComment?: boolean; + supportsSystemProfile?: boolean; /** * Supports Usage Extraction. */ @@ -5765,6 +5792,13 @@ export enum AuthMechanismEnum { * * Access Token Auth Credentials * + * Choose Basic Auth (username/password) for on-premise or OAuth 2.0 Client Credentials for + * SAP S/4HANA Cloud. + * + * Username and password credentials for SAP S/4HANA. + * + * OAuth 2.0 client credentials for SAP S/4HANA Cloud. + * * Choose between different authentication types for Databricks. * * Personal Access Token authentication for Databricks. @@ -5825,10 +5859,12 @@ export enum AuthMechanismEnum { * * SSH private key authentication for SFTP */ -export interface AuthenticationTypeForTableau { +export interface AuthenticationType { /** * Password to access the service. * + * Password to authenticate with SAP S/4HANA. + * * Password to connect to source. * * Database user password. Leave empty if using IAM database authentication. @@ -5845,6 +5881,8 @@ export interface AuthenticationTypeForTableau { /** * Username to access the service. * + * Username to authenticate with SAP S/4HANA. + * * Username for authenticating with Dremio Software. This user should have appropriate * permissions to access metadata. * @@ -5864,20 +5902,32 @@ export interface AuthenticationTypeForTableau { */ personalAccessTokenSecret?: string; /** - * Generated Personal Access Token for Databricks workspace authentication. This token is - * created from User Settings -> Developer -> Access Tokens in your Databricks workspace. + * Authentication type identifier. */ - token?: string; + authType?: AuthType; /** + * OAuth 2.0 client ID registered in SAP. + * * Service Principal Application ID created in your Databricks Account Console for OAuth * Machine-to-Machine authentication. */ clientId?: string; /** + * OAuth 2.0 client secret. + * * OAuth Secret generated for the Service Principal in Databricks Account Console. Used for * secure OAuth2 authentication. */ clientSecret?: string; + /** + * OAuth 2.0 token endpoint URL (e.g. /sap/bc/security/oauth2/token). + */ + tokenEndpoint?: string; + /** + * Generated Personal Access Token for Databricks workspace authentication. This token is + * created from User Settings -> Developer -> Access Tokens in your Databricks workspace. + */ + token?: string; /** * Azure Service Principal Application (client) ID registered in your Azure Active Directory. */ @@ -5996,6 +6046,14 @@ export interface AuthenticationTypeForTableau { privateKeyPassphrase?: string; } +/** + * Authentication type identifier. + */ +export enum AuthType { + Basic = "basic", + Oauth2 = "oauth2", +} + /** * AWS credentials configs. * @@ -6955,6 +7013,9 @@ export enum ConnectionScheme { * * SSL Configuration details. * + * CA certificate, client certificate, and private key for SSL validation. Required when + * verifySSL is 'validate'. + * * SSL Configuration details for DB2 connection. Provide CA certificate for server * validation, and optionally client certificate and key for mutual TLS authentication. * @@ -7700,6 +7761,9 @@ export enum SpaceType { * * SSL Configuration details. * + * CA certificate, client certificate, and private key for SSL validation. Required when + * verifySSL is 'validate'. + * * SSL Configuration details for DB2 connection. Provide CA certificate for server * validation, and optionally client certificate and key for mutual TLS authentication. * @@ -7851,6 +7915,8 @@ export enum TokenType { * * Service type. * + * SAP S/4HANA service type + * * Custom database service type * * Kafka service type @@ -8006,6 +8072,7 @@ export enum PurpleType { Salesforce = "Salesforce", SapERP = "SapErp", SapHana = "SapHana", + SapS4Hana = "SapS4Hana", SapSuccessFactors = "SapSuccessFactors", ServiceNow = "ServiceNow", SharePoint = "SharePoint", diff --git a/openmetadata-ui/src/main/resources/ui/src/generated/metadataIngestion/testSuitePipeline.ts b/openmetadata-ui/src/main/resources/ui/src/generated/metadataIngestion/testSuitePipeline.ts index 6b6f19146e45..854ca9f97e05 100644 --- a/openmetadata-ui/src/main/resources/ui/src/generated/metadataIngestion/testSuitePipeline.ts +++ b/openmetadata-ui/src/main/resources/ui/src/generated/metadataIngestion/testSuitePipeline.ts @@ -141,6 +141,8 @@ export interface ServiceConnection { * SQL Server Reporting Services (SSRS) provides a set of on-premises tools and services to * create, deploy, and manage paginated reports * + * SAP S/4HANA Connection Config for Embedded Analytics + * * Google BigQuery Connection Config * * Google BigTable Connection Config @@ -385,6 +387,9 @@ export interface ConfigObject { /** * SSL Configuration details. * + * CA certificate, client certificate, and private key for SSL validation. Required when + * verifySSL is 'validate'. + * * SSL Configuration details for DB2 connection. Provide CA certificate for server * validation, and optionally client certificate and key for mutual TLS authentication. * @@ -448,6 +453,9 @@ export interface ConfigObject { * * Client SSL verification. * + * Client SSL verification. Use 'no-ssl' for plain HTTP, 'ignore' to skip certificate + * validation, 'validate' to verify against a CA certificate. + * * Flag to verify SSL Certificate for OpenMetadata Server. * * Boolean marking if we need to verify the SSL certs for KafkaConnect REST API. True by @@ -540,6 +548,8 @@ export interface ConfigObject { * * Host and Port of the Ssrs instance. * + * Base URL of the SAP S/4HANA instance (e.g. https://s4hana.example.com). + * * BigQuery APIs URL. * * Host and port of the AzureSQL service. @@ -955,6 +965,9 @@ export interface ConfigObject { /** * Types of methods used to authenticate to the tableau instance * + * Choose Basic Auth (username/password) for on-premise or OAuth 2.0 Client Credentials for + * SAP S/4HANA Cloud. + * * Choose between different authentication types for Databricks. * * Choose Auth Config Type. @@ -971,7 +984,7 @@ export interface ConfigObject { * * Authentication method: username/password or SSH private key */ - authType?: AuthenticationTypeForTableau | NoConfigAuthenticationTypes; + authType?: AuthenticationType | NoConfigAuthenticationTypes; /** * Pagination limit used while querying the tableau metadata API for getting data sources * @@ -1113,6 +1126,14 @@ export interface ConfigObject { * Type of token to use for authentication */ tokenType?: TokenType; + /** + * SAP client number (Mandant), typically a 3-digit string (e.g. '100'). + */ + clientNumber?: string; + /** + * Supports Lineage Extraction. + */ + supportsLineageExtraction?: boolean; /** * Billing Project ID */ @@ -1176,13 +1197,9 @@ export interface ConfigObject { supportsDataDiff?: boolean; supportsDBTExtraction?: boolean; supportsIncrementalMetadataExtraction?: boolean; - /** - * Supports Lineage Extraction. - */ - supportsLineageExtraction?: boolean; - supportsProfiler?: boolean; - supportsQueryComment?: boolean; - supportsSystemProfile?: boolean; + supportsProfiler?: boolean; + supportsQueryComment?: boolean; + supportsSystemProfile?: boolean; /** * Supports Usage Extraction. */ @@ -2490,6 +2507,13 @@ export enum AuthProvider { * * Access Token Auth Credentials * + * Choose Basic Auth (username/password) for on-premise or OAuth 2.0 Client Credentials for + * SAP S/4HANA Cloud. + * + * Username and password credentials for SAP S/4HANA. + * + * OAuth 2.0 client credentials for SAP S/4HANA Cloud. + * * Choose between different authentication types for Databricks. * * Personal Access Token authentication for Databricks. @@ -2550,10 +2574,12 @@ export enum AuthProvider { * * SSH private key authentication for SFTP */ -export interface AuthenticationTypeForTableau { +export interface AuthenticationType { /** * Password to access the service. * + * Password to authenticate with SAP S/4HANA. + * * Password to connect to source. * * Database user password. Leave empty if using IAM database authentication. @@ -2570,6 +2596,8 @@ export interface AuthenticationTypeForTableau { /** * Username to access the service. * + * Username to authenticate with SAP S/4HANA. + * * Username for authenticating with Dremio Software. This user should have appropriate * permissions to access metadata. * @@ -2589,20 +2617,32 @@ export interface AuthenticationTypeForTableau { */ personalAccessTokenSecret?: string; /** - * Generated Personal Access Token for Databricks workspace authentication. This token is - * created from User Settings -> Developer -> Access Tokens in your Databricks workspace. + * Authentication type identifier. */ - token?: string; + authType?: AuthType; /** + * OAuth 2.0 client ID registered in SAP. + * * Service Principal Application ID created in your Databricks Account Console for OAuth * Machine-to-Machine authentication. */ clientId?: string; /** + * OAuth 2.0 client secret. + * * OAuth Secret generated for the Service Principal in Databricks Account Console. Used for * secure OAuth2 authentication. */ clientSecret?: string; + /** + * OAuth 2.0 token endpoint URL (e.g. /sap/bc/security/oauth2/token). + */ + tokenEndpoint?: string; + /** + * Generated Personal Access Token for Databricks workspace authentication. This token is + * created from User Settings -> Developer -> Access Tokens in your Databricks workspace. + */ + token?: string; /** * Azure Service Principal Application (client) ID registered in your Azure Active Directory. */ @@ -2721,6 +2761,14 @@ export interface AuthenticationTypeForTableau { privateKeyPassphrase?: string; } +/** + * Authentication type identifier. + */ +export enum AuthType { + Basic = "basic", + Oauth2 = "oauth2", +} + /** * AWS credentials required to access the S3 file. * @@ -3185,6 +3233,9 @@ export enum KafkaSecurityProtocol { * * SSL Configuration details. * + * CA certificate, client certificate, and private key for SSL validation. Required when + * verifySSL is 'validate'. + * * SSL Configuration details for DB2 connection. Provide CA certificate for server * validation, and optionally client certificate and key for mutual TLS authentication. * @@ -3928,6 +3979,9 @@ export enum ConnectionScheme { * * SSL Configuration details. * + * CA certificate, client certificate, and private key for SSL validation. Required when + * verifySSL is 'validate'. + * * SSL Configuration details for DB2 connection. Provide CA certificate for server * validation, and optionally client certificate and key for mutual TLS authentication. * @@ -3999,6 +4053,9 @@ export enum ConnectionType { * * Client SSL verification. * + * Client SSL verification. Use 'no-ssl' for plain HTTP, 'ignore' to skip certificate + * validation, 'validate' to verify against a CA certificate. + * * Flag to verify SSL Certificate for OpenMetadata Server. */ export enum VerifySSL { @@ -4738,6 +4795,9 @@ export enum SpaceType { * * SSL Configuration details. * + * CA certificate, client certificate, and private key for SSL validation. Required when + * verifySSL is 'validate'. + * * SSL Configuration details for DB2 connection. Provide CA certificate for server * validation, and optionally client certificate and key for mutual TLS authentication. * @@ -4888,6 +4948,8 @@ export enum TokenType { * * Service type. * + * SAP S/4HANA service type + * * Custom database service type * * Kafka service type @@ -5043,6 +5105,7 @@ export enum ConfigType { Salesforce = "Salesforce", SapERP = "SapErp", SapHana = "SapHana", + SapS4Hana = "SapS4Hana", SapSuccessFactors = "SapSuccessFactors", ServiceNow = "ServiceNow", SharePoint = "SharePoint", diff --git a/openmetadata-ui/src/main/resources/ui/src/generated/metadataIngestion/workflow.ts b/openmetadata-ui/src/main/resources/ui/src/generated/metadataIngestion/workflow.ts index b311292a6c2d..05e0ff7b6501 100644 --- a/openmetadata-ui/src/main/resources/ui/src/generated/metadataIngestion/workflow.ts +++ b/openmetadata-ui/src/main/resources/ui/src/generated/metadataIngestion/workflow.ts @@ -186,6 +186,8 @@ export interface ServiceConnection { * SQL Server Reporting Services (SSRS) provides a set of on-premises tools and services to * create, deploy, and manage paginated reports * + * SAP S/4HANA Connection Config for Embedded Analytics + * * Google BigQuery Connection Config * * Google BigTable Connection Config @@ -430,6 +432,9 @@ export interface ConfigObject { /** * SSL Configuration details. * + * CA certificate, client certificate, and private key for SSL validation. Required when + * verifySSL is 'validate'. + * * SSL Configuration details for DB2 connection. Provide CA certificate for server * validation, and optionally client certificate and key for mutual TLS authentication. * @@ -493,6 +498,9 @@ export interface ConfigObject { * * Client SSL verification. * + * Client SSL verification. Use 'no-ssl' for plain HTTP, 'ignore' to skip certificate + * validation, 'validate' to verify against a CA certificate. + * * Flag to verify SSL Certificate for OpenMetadata Server. * * Boolean marking if we need to verify the SSL certs for KafkaConnect REST API. True by @@ -585,6 +593,8 @@ export interface ConfigObject { * * Host and Port of the Ssrs instance. * + * Base URL of the SAP S/4HANA instance (e.g. https://s4hana.example.com). + * * BigQuery APIs URL. * * Host and port of the AzureSQL service. @@ -1000,6 +1010,9 @@ export interface ConfigObject { /** * Types of methods used to authenticate to the tableau instance * + * Choose Basic Auth (username/password) for on-premise or OAuth 2.0 Client Credentials for + * SAP S/4HANA Cloud. + * * Choose between different authentication types for Databricks. * * Choose Auth Config Type. @@ -1016,7 +1029,7 @@ export interface ConfigObject { * * Authentication method: username/password or SSH private key */ - authType?: AuthenticationTypeForTableau | NoConfigAuthenticationTypes; + authType?: AuthenticationType | NoConfigAuthenticationTypes; /** * Pagination limit used while querying the tableau metadata API for getting data sources * @@ -1158,6 +1171,14 @@ export interface ConfigObject { * Type of token to use for authentication */ tokenType?: TokenType; + /** + * SAP client number (Mandant), typically a 3-digit string (e.g. '100'). + */ + clientNumber?: string; + /** + * Supports Lineage Extraction. + */ + supportsLineageExtraction?: boolean; /** * Billing Project ID */ @@ -1221,13 +1242,9 @@ export interface ConfigObject { supportsDataDiff?: boolean; supportsDBTExtraction?: boolean; supportsIncrementalMetadataExtraction?: boolean; - /** - * Supports Lineage Extraction. - */ - supportsLineageExtraction?: boolean; - supportsProfiler?: boolean; - supportsQueryComment?: boolean; - supportsSystemProfile?: boolean; + supportsProfiler?: boolean; + supportsQueryComment?: boolean; + supportsSystemProfile?: boolean; /** * Supports Usage Extraction. */ @@ -2550,6 +2567,13 @@ export enum AuthProvider { * * Access Token Auth Credentials * + * Choose Basic Auth (username/password) for on-premise or OAuth 2.0 Client Credentials for + * SAP S/4HANA Cloud. + * + * Username and password credentials for SAP S/4HANA. + * + * OAuth 2.0 client credentials for SAP S/4HANA Cloud. + * * Choose between different authentication types for Databricks. * * Personal Access Token authentication for Databricks. @@ -2610,10 +2634,12 @@ export enum AuthProvider { * * SSH private key authentication for SFTP */ -export interface AuthenticationTypeForTableau { +export interface AuthenticationType { /** * Password to access the service. * + * Password to authenticate with SAP S/4HANA. + * * Password to connect to source. * * Database user password. Leave empty if using IAM database authentication. @@ -2630,6 +2656,8 @@ export interface AuthenticationTypeForTableau { /** * Username to access the service. * + * Username to authenticate with SAP S/4HANA. + * * Username for authenticating with Dremio Software. This user should have appropriate * permissions to access metadata. * @@ -2649,20 +2677,32 @@ export interface AuthenticationTypeForTableau { */ personalAccessTokenSecret?: string; /** - * Generated Personal Access Token for Databricks workspace authentication. This token is - * created from User Settings -> Developer -> Access Tokens in your Databricks workspace. + * Authentication type identifier. */ - token?: string; + authType?: AuthType; /** + * OAuth 2.0 client ID registered in SAP. + * * Service Principal Application ID created in your Databricks Account Console for OAuth * Machine-to-Machine authentication. */ clientId?: string; /** + * OAuth 2.0 client secret. + * * OAuth Secret generated for the Service Principal in Databricks Account Console. Used for * secure OAuth2 authentication. */ clientSecret?: string; + /** + * OAuth 2.0 token endpoint URL (e.g. /sap/bc/security/oauth2/token). + */ + tokenEndpoint?: string; + /** + * Generated Personal Access Token for Databricks workspace authentication. This token is + * created from User Settings -> Developer -> Access Tokens in your Databricks workspace. + */ + token?: string; /** * Azure Service Principal Application (client) ID registered in your Azure Active Directory. */ @@ -2781,6 +2821,14 @@ export interface AuthenticationTypeForTableau { privateKeyPassphrase?: string; } +/** + * Authentication type identifier. + */ +export enum AuthType { + Basic = "basic", + Oauth2 = "oauth2", +} + /** * AWS credentials required to access the S3 file. * @@ -3245,6 +3293,9 @@ export enum KafkaSecurityProtocol { * * SSL Configuration details. * + * CA certificate, client certificate, and private key for SSL validation. Required when + * verifySSL is 'validate'. + * * SSL Configuration details for DB2 connection. Provide CA certificate for server * validation, and optionally client certificate and key for mutual TLS authentication. * @@ -3991,6 +4042,9 @@ export enum ConnectionScheme { * * SSL Configuration details. * + * CA certificate, client certificate, and private key for SSL validation. Required when + * verifySSL is 'validate'. + * * SSL Configuration details for DB2 connection. Provide CA certificate for server * validation, and optionally client certificate and key for mutual TLS authentication. * @@ -4065,6 +4119,9 @@ export enum ConnectionType { * * Client SSL verification. * + * Client SSL verification. Use 'no-ssl' for plain HTTP, 'ignore' to skip certificate + * validation, 'validate' to verify against a CA certificate. + * * Flag to verify SSL Certificate for OpenMetadata Server. * * SSL/TLS verification mode when fetching dbt artifacts over HTTPS. @@ -4806,6 +4863,9 @@ export enum SpaceType { * * SSL Configuration details. * + * CA certificate, client certificate, and private key for SSL validation. Required when + * verifySSL is 'validate'. + * * SSL Configuration details for DB2 connection. Provide CA certificate for server * validation, and optionally client certificate and key for mutual TLS authentication. * @@ -4959,6 +5019,8 @@ export enum TokenType { * * Service type. * + * SAP S/4HANA service type + * * Custom database service type * * Kafka service type @@ -5114,6 +5176,7 @@ export enum PurpleType { Salesforce = "Salesforce", SapERP = "SapErp", SapHana = "SapHana", + SapS4Hana = "SapS4Hana", SapSuccessFactors = "SapSuccessFactors", ServiceNow = "ServiceNow", SharePoint = "SharePoint", @@ -7185,6 +7248,10 @@ export interface LineageInformation { * List of Database Service Names for creation of lineage */ dbServiceNames?: string[]; + /** + * List of Messaging Service Names for creation of lineage + */ + messagingServiceNames?: string[]; /** * List of Storage Service Names for creation of lineage */ From 49064736795ff4f83d83fd8d8ea6a97849f32e04 Mon Sep 17 00:00:00 2001 From: varun-lakhyani Date: Fri, 24 Apr 2026 15:21:29 +0530 Subject: [PATCH 3/3] make username required --- .../database/sapsuccessfactors.json | 40 +++++++++---------- .../database/sapSuccessFactorsConnection.json | 4 +- .../database/sapSuccessFactorsConnection.ts | 2 +- 3 files changed, 23 insertions(+), 23 deletions(-) diff --git a/openmetadata-service/src/main/resources/json/data/testConnections/database/sapsuccessfactors.json b/openmetadata-service/src/main/resources/json/data/testConnections/database/sapsuccessfactors.json index af3a0024ca14..1a88dbb94c08 100644 --- a/openmetadata-service/src/main/resources/json/data/testConnections/database/sapsuccessfactors.json +++ b/openmetadata-service/src/main/resources/json/data/testConnections/database/sapsuccessfactors.json @@ -1,21 +1,21 @@ { - "name": "SapSuccessFactors", - "displayName": "SAP SuccessFactors Test Connection", - "description": "This Test Connection validates the access against the SAP SuccessFactors OData API and basic metadata extraction of entity types.", - "steps": [ - { - "name": "CheckAccess", - "description": "Validate that we can properly reach the SAP SuccessFactors OData API and authenticate with the given credentials by fetching the $metadata endpoint.", - "errorMessage": "Failed to connect to SAP SuccessFactors. Please validate the base URL, company ID, and credentials.", - "shortCircuit": true, - "mandatory": true - }, - { - "name": "GetEntities", - "description": "Validate that we can parse the OData $metadata response and discover at least one EntitySet (table).", - "errorMessage": "Failed to parse SAP SuccessFactors $metadata. The response may be empty or malformed.", - "shortCircuit": false, - "mandatory": true - } - ] -} \ No newline at end of file + "name": "SapSuccessFactors", + "displayName": "SAP SuccessFactors Test Connection", + "description": "This Test Connection validates the access against the SAP SuccessFactors OData API and basic metadata extraction of entity types.", + "steps": [ + { + "name": "CheckAccess", + "description": "Validate that we can properly reach the SAP SuccessFactors OData API and authenticate with the given credentials by fetching the $metadata endpoint.", + "errorMessage": "Failed to connect to SAP SuccessFactors. Please validate the base URL, company ID, and credentials.", + "shortCircuit": true, + "mandatory": true + }, + { + "name": "GetEntities", + "description": "Validate that we can parse the OData $metadata response and discover at least one EntitySet (table).", + "errorMessage": "Failed to parse SAP SuccessFactors $metadata. The response may be empty or malformed.", + "shortCircuit": false, + "mandatory": true + } + ] +} diff --git a/openmetadata-spec/src/main/resources/json/schema/entity/services/connections/database/sapSuccessFactorsConnection.json b/openmetadata-spec/src/main/resources/json/schema/entity/services/connections/database/sapSuccessFactorsConnection.json index effbb1c9c7e0..1b4886e16a0e 100644 --- a/openmetadata-spec/src/main/resources/json/schema/entity/services/connections/database/sapSuccessFactorsConnection.json +++ b/openmetadata-spec/src/main/resources/json/schema/entity/services/connections/database/sapSuccessFactorsConnection.json @@ -116,6 +116,6 @@ "$ref": "../connectionBasicType.json#/definitions/supportsMetadataExtraction" } }, - "required": ["baseUrl", "companyId"], + "required": ["baseUrl", "companyId", "username"], "additionalProperties": false -} \ No newline at end of file +} diff --git a/openmetadata-ui/src/main/resources/ui/src/generated/entity/services/connections/database/sapSuccessFactorsConnection.ts b/openmetadata-ui/src/main/resources/ui/src/generated/entity/services/connections/database/sapSuccessFactorsConnection.ts index b34e485b4105..c1e97cebe77a 100644 --- a/openmetadata-ui/src/main/resources/ui/src/generated/entity/services/connections/database/sapSuccessFactorsConnection.ts +++ b/openmetadata-ui/src/main/resources/ui/src/generated/entity/services/connections/database/sapSuccessFactorsConnection.ts @@ -74,7 +74,7 @@ export interface SapSuccessFactorsConnection { * requested. The user must exist in the SF system and be permitted to use the OAuth2 * application. */ - username?: string; + username: string; /** * Client SSL verification. */