diff --git a/docs/ISuite/10-InitialSetup/initial-setup-3dcf507.md b/docs/ISuite/10-InitialSetup/initial-setup-of-sap-integration-suite-3dcf507.md similarity index 97% rename from docs/ISuite/10-InitialSetup/initial-setup-3dcf507.md rename to docs/ISuite/10-InitialSetup/initial-setup-of-sap-integration-suite-3dcf507.md index aded5c2d..d1057967 100644 --- a/docs/ISuite/10-InitialSetup/initial-setup-3dcf507.md +++ b/docs/ISuite/10-InitialSetup/initial-setup-of-sap-integration-suite-3dcf507.md @@ -1,6 +1,6 @@ -# Initial Setup +# Initial Setup of SAP Integration Suite Get onboarded to SAP Integration Suite. diff --git a/docs/ISuite/10-InitialSetup/production-account-24ef511.md b/docs/ISuite/10-InitialSetup/production-account-24ef511.md index 10169c35..0c784601 100644 --- a/docs/ISuite/10-InitialSetup/production-account-24ef511.md +++ b/docs/ISuite/10-InitialSetup/production-account-24ef511.md @@ -11,9 +11,9 @@ This account model includes services for you to start working in SAP Integration [Subscribing and Configuring Initial Access to SAP Integration Suite](subscribing-and-configuring-initial-access-to-sap-integration-suite-8a3c8b7.md "Subscribe to the SAP Integration Suitein SAP BTP cockpit and assign the Integration_Provisioner role to gain access.") -[Configuring User Access](../configuring-user-access-2c6214a.md "Assign the required roles to users for accessing the individual capabilities.") +[Configuring User Access to SAP Integration Suite](../configuring-user-access-to-sap-integration-suite-2c6214a.md "Assign the required roles and role collections to users for accessing the individual capabilities.") -[Working with Integration Suite Home](../20-Working_with_SAP_Integration_Suite_Home/working-with-integration-suite-home-a53dce3.md "Access the various features and resources available on the Integration Suite home page.") +[Working with Integration Suite Home](../20-Working_with_SAP_Integration_Suite_Home/working-with-integration-suite-home-a53dce3.md "Access the various features and resources available on theIntegration Suite home page.") [Activating and Managing Capabilities](../activating-and-managing-capabilities-2ffb343.md "Activate capabilities for the SAP Integration Suite.") diff --git a/docs/ISuite/10-InitialSetup/subscribing-and-configuring-initial-access-to-sap-integration-suite-8a3c8b7.md b/docs/ISuite/10-InitialSetup/subscribing-and-configuring-initial-access-to-sap-integration-suite-8a3c8b7.md index 4ce06707..99107f37 100644 --- a/docs/ISuite/10-InitialSetup/subscribing-and-configuring-initial-access-to-sap-integration-suite-8a3c8b7.md +++ b/docs/ISuite/10-InitialSetup/subscribing-and-configuring-initial-access-to-sap-integration-suite-8a3c8b7.md @@ -51,7 +51,7 @@ You’ve created a subaccount in your assigned global account using the SAP BTP 12. Choose *Go to Application* to launch the Integration Suite home page. For more information, see [Working with Integration Suite Home](../20-Working_with_SAP_Integration_Suite_Home/working-with-integration-suite-home-a53dce3.md). > ### Tip: - > To access the application, you'll need the correct authorization. If you try to enter without it, you'll be asked to assign the necessary role. If you're still unable to access the application after role assignment, simply log out and then log back into the SAP BTP cockpit. This should grant you access to the application. + > Clear your web browser cache and cookies before navigating to *Go to Application*.To access the application, you'll need the correct authorization. If you try to enter without it, you'll be asked to assign the necessary role. If you're still unable to access the application after role assignment, simply log out and then log back into the SAP BTP cockpit. This should grant you access to the application. > ### Tip: > To remain informed and receive timely notifications about planned and unplanned downtime, customer communications, and maintenance announcements, we recommend you maintain your contact information via Cloud System Notification Subscriptions \(CSNS\). For more information, see [Cloud Availability Center & Cloud System Notification Subscriptions](https://support.sap.com/en/my-support/systems-installations/cac.html). diff --git a/docs/ISuite/10-InitialSetup/subscribing-to-free-tier-cf0cc4c.md b/docs/ISuite/10-InitialSetup/subscribing-to-free-tier-cf0cc4c.md index 45e342e3..8da7a73d 100644 --- a/docs/ISuite/10-InitialSetup/subscribing-to-free-tier-cf0cc4c.md +++ b/docs/ISuite/10-InitialSetup/subscribing-to-free-tier-cf0cc4c.md @@ -44,7 +44,7 @@ Subscribe to free tier service plan. > ### Note: > In the *New Instance or Subscription* dialog box, select the *free* as the plan. - 6. Assign role collection to access the tenant. See: [Configuring User Access](../configuring-user-access-2c6214a.md). + 6. Assign role collection to access the tenant. See: [Configuring User Access to SAP Integration Suite](../configuring-user-access-to-sap-integration-suite-2c6214a.md). 3. Go to the Integration Suite home page and provision the capabilities. See: [Working with Integration Suite Home](../20-Working_with_SAP_Integration_Suite_Home/working-with-integration-suite-home-a53dce3.md). diff --git a/docs/ISuite/20-Working_with_SAP_Integration_Suite_Home/working-with-integration-suite-home-a53dce3.md b/docs/ISuite/20-Working_with_SAP_Integration_Suite_Home/working-with-integration-suite-home-a53dce3.md index 48be1d9b..9a3d6b95 100644 --- a/docs/ISuite/20-Working_with_SAP_Integration_Suite_Home/working-with-integration-suite-home-a53dce3.md +++ b/docs/ISuite/20-Working_with_SAP_Integration_Suite_Home/working-with-integration-suite-home-a53dce3.md @@ -4,12 +4,12 @@ # Working with Integration Suite Home -Access the various features and resources available on the Integration Suite home page. +Access the various features and resources available on theIntegration Suite home page. **Prerequisites** - You’ve subscribed to the Integration Suite application. For more information, see [Subscribing and Configuring Initial Access to SAP Integration Suite](../10-InitialSetup/subscribing-and-configuring-initial-access-to-sap-integration-suite-8a3c8b7.md). -- You have the *Integration\_Provisioner* role or any relevant Integration Suite capability-specific role assigned to your user. For more information, see [Configuring User Access](../configuring-user-access-2c6214a.md). +- You have the *Integration\_Provisioner* role or any relevant Integration Suite capability-specific role assigned to your user. For more information, see [Configuring User Access to SAP Integration Suite](../configuring-user-access-to-sap-integration-suite-2c6214a.md). @@ -41,13 +41,13 @@ This section displays artifacts you've worked with lately. This section, depending on the capabilities provisioned, displays information pertaining to: - API usage and calls -- Integration deployment status +- Integration deployment status \(in the case of EIC, this includes artifacts deployed across all active runtime locations\) ### Capabilities -The *Capabilities* section displays the tiles of the capabilities activated for you. If you have the Integration\_Provisioner role, you'll be able to add new capabilities, and manage the existing capabilities. To know more about adding and activating capabilities, and providing users access to the functionality, see [Capabilities](../capabilities-e1c5b90.md) . +The *Capabilities* section displays the tiles of the capabilities activated for you. If you have the Integration\_Provisioner role, you'll be able to add new capabilities, and manage the existing capabilities. To know more about adding and activating capabilities, and providing users access to the functionality, see [Capabilities of SAP Integration Suite](../capabilities-of-sap-integration-suite-e1c5b90.md) . Each capability tile also displays some quick links to allow you to start working with the capability. @@ -451,7 +451,7 @@ Contextual help. You can activate contextual help by choosing -Built-in support. You can activate built-in support by choosing Get Support +Built-in support. You can activate built-in support by choosing Get Support > ### Note: > Built-in support is currently available for certain screens only. @@ -481,7 +481,7 @@ Explore our environment, and navigate to the following portals: - News and Announcements + News and Announcements @@ -497,7 +497,7 @@ News and Announcement. Lets you know what is new in the Integration Suite. [Subscribing and Configuring Initial Access to SAP Integration Suite](../10-InitialSetup/subscribing-and-configuring-initial-access-to-sap-integration-suite-8a3c8b7.md "Subscribe to the SAP Integration Suitein SAP BTP cockpit and assign the Integration_Provisioner role to gain access.") -[Configuring User Access](../configuring-user-access-2c6214a.md "Assign the required roles to users for accessing the individual capabilities.") +[Configuring User Access to SAP Integration Suite](../configuring-user-access-to-sap-integration-suite-2c6214a.md "Assign the required roles and role collections to users for accessing the individual capabilities.") [Activating and Managing Capabilities](../activating-and-managing-capabilities-2ffb343.md "Activate capabilities for the SAP Integration Suite.") diff --git a/docs/ISuite/30-Assessing_Integration_Strategy/create-a-business-solution-request-and-interface-request-f3d983a.md b/docs/ISuite/30-Assessing_Integration_Strategy/create-a-business-solution-request-and-interface-request-f3d983a.md index b2550486..412f52a4 100644 --- a/docs/ISuite/30-Assessing_Integration_Strategy/create-a-business-solution-request-and-interface-request-f3d983a.md +++ b/docs/ISuite/30-Assessing_Integration_Strategy/create-a-business-solution-request-and-interface-request-f3d983a.md @@ -6,7 +6,7 @@ Integration Assessment involves orchestration across different personas. -Creating a business solution request is the task of the business domain expert, see [Personas](../60-Security/personas-5df5af1.md). +Creating a business solution request is the task of the business domain expert, see [Personas for Integration Assessment](../60-Security/personas-for-integration-assessment-5df5af1.md). Perform the following steps to create a business solution request. diff --git a/docs/ISuite/30-Assessing_Integration_Strategy/integration-assessment-310067e.md b/docs/ISuite/30-Assessing_Integration_Strategy/integration-assessment-310067e.md index 7b58623e..72a77359 100644 --- a/docs/ISuite/30-Assessing_Integration_Strategy/integration-assessment-310067e.md +++ b/docs/ISuite/30-Assessing_Integration_Strategy/integration-assessment-310067e.md @@ -13,5 +13,3 @@ Integration Assessment provides you with a guided approach to assess your integr [Integration Assessment Process](integration-assessment-process-5769fcd.md "Define, document, and govern your integration technology strategy.") - - diff --git a/docs/ISuite/30-Assessing_Integration_Strategy/integration-assessment-process-5769fcd.md b/docs/ISuite/30-Assessing_Integration_Strategy/integration-assessment-process-5769fcd.md index 823799f7..8d1d3e0b 100644 --- a/docs/ISuite/30-Assessing_Integration_Strategy/integration-assessment-process-5769fcd.md +++ b/docs/ISuite/30-Assessing_Integration_Strategy/integration-assessment-process-5769fcd.md @@ -114,5 +114,5 @@ More information: [Decide on an Integration Technology](decide-on-an-integration Personas cover the tasks performed by specific roles associated with an integration project. -More information: [Personas](../60-Security/personas-5df5af1.md) +More information: [Personas for Integration Assessment](../60-Security/personas-for-integration-assessment-5df5af1.md) diff --git a/docs/ISuite/30-Assessing_Integration_Strategy/review-and-adjust-isa-m-settings-957de13.md b/docs/ISuite/30-Assessing_Integration_Strategy/review-and-adjust-isa-m-settings-957de13.md index d0d1f48d..d172b426 100644 --- a/docs/ISuite/30-Assessing_Integration_Strategy/review-and-adjust-isa-m-settings-957de13.md +++ b/docs/ISuite/30-Assessing_Integration_Strategy/review-and-adjust-isa-m-settings-957de13.md @@ -6,14 +6,9 @@ Settings include the SAP Integration Solution Advisory Methodology \(ISA-M\) master data. This data acts as the initial setup for completing the integration assessment. -For more information, see: +For more information, see: [SAP Integration Solution Advisory Methodology](sap-integration-solution-advisory-methodology-a2e17f3.md) -- [SAP Integration Solution Advisory Methodology](sap-integration-solution-advisory-methodology-a2e17f3.md) - -- - - -Reviewing and adjusting the ISA-M settings is the task of the enterprise architect \(see [Personas](../60-Security/personas-5df5af1.md)\). +Reviewing and adjusting the ISA-M settings is the task of the enterprise architect \(see [Personas for Integration Assessment](../60-Security/personas-for-integration-assessment-5df5af1.md)\). Go to the *Settings* section to inspect the available ISA-M master data predefined by SAP or to adjust the settings by adding your own data. diff --git a/docs/ISuite/40-RemoteSystems/basic-authentication-of-an-idp-user-for-api-clients-57f104d.md b/docs/ISuite/40-RemoteSystems/basic-authentication-of-an-idp-user-for-api-clients-57f104d.md index 78f39fbe..1a5f6274 100644 --- a/docs/ISuite/40-RemoteSystems/basic-authentication-of-an-idp-user-for-api-clients-57f104d.md +++ b/docs/ISuite/40-RemoteSystems/basic-authentication-of-an-idp-user-for-api-clients-57f104d.md @@ -53,7 +53,7 @@ In detail, perform the following steps. Assign a role that grants permission to access certain data through the API. In our example, we want to access monitoring data through the API, so we select the predefined *MonitoringDataRead* role. - For more information about the available predefined roles, see [Tasks and Permissions](../60-Security/tasks-and-permissions-556d557.md). + For more information about the available predefined roles, see [Tasks and Permissions for Cloud Integration](../60-Security/tasks-and-permissions-for-cloud-integration-556d557.md). > ### Tip: > Make sure you select a role with an application identifier that starts with `it!`. diff --git a/docs/ISuite/40-RemoteSystems/client-certificate-authentication-for-api-clients-d9ca0ac.md b/docs/ISuite/40-RemoteSystems/client-certificate-authentication-for-api-clients-d9ca0ac.md index 93857480..e1d21498 100644 --- a/docs/ISuite/40-RemoteSystems/client-certificate-authentication-for-api-clients-d9ca0ac.md +++ b/docs/ISuite/40-RemoteSystems/client-certificate-authentication-for-api-clients-d9ca0ac.md @@ -25,7 +25,7 @@ For more information, check out [Client Certificate Authentication \(Inbound\)]( 1. Look up the role to be used to authorize the API client to access the related Cloud Integration resource using the API. - See: [Tasks and Permissions](../60-Security/tasks-and-permissions-556d557.md) + See: [Tasks and Permissions for Cloud Integration](../60-Security/tasks-and-permissions-for-cloud-integration-556d557.md) 2. In SAP BTP cockpit, select the subaccount that hosts your SAP Integration Suite virtual environment and create a service instance and service key. @@ -111,7 +111,7 @@ For more information, check out [Client Certificate Authentication \(Inbound\)]( Select role according to the API resource to access. - See: [Tasks and Permissions](../60-Security/tasks-and-permissions-556d557.md) + See: [Tasks and Permissions for Cloud Integration](../60-Security/tasks-and-permissions-for-cloud-integration-556d557.md) @@ -155,7 +155,7 @@ For more information, check out [Client Certificate Authentication \(Inbound\)]( Select role according to the API resource to access. - See: [Tasks and Permissions](../60-Security/tasks-and-permissions-556d557.md) + See: [Tasks and Permissions for Cloud Integration](../60-Security/tasks-and-permissions-for-cloud-integration-556d557.md) diff --git a/docs/ISuite/40-RemoteSystems/client-certificate-authentication-for-integration-flow-processing-7f84d16.md b/docs/ISuite/40-RemoteSystems/client-certificate-authentication-for-integration-flow-processing-7f84d16.md index dee4fcda..b502dc4d 100644 --- a/docs/ISuite/40-RemoteSystems/client-certificate-authentication-for-integration-flow-processing-7f84d16.md +++ b/docs/ISuite/40-RemoteSystems/client-certificate-authentication-for-integration-flow-processing-7f84d16.md @@ -193,6 +193,10 @@ For more information, check out: + If you use an external certificate, the certificate needs to be signed by a certification authority that is supported by the load balancer. + + See: [Load Balancer Root Certificates Supported by SAP](load-balancer-root-certificates-supported-by-sap-4509f60.md) + 4. Configure the sender system. 1. Make sure that the sender keystore contains the root certificate of the load balancer server certificate. diff --git a/docs/ISuite/40-RemoteSystems/configuration-checklist-for-inbound-authentication-4a428fd.md b/docs/ISuite/40-RemoteSystems/configuration-checklist-for-inbound-authentication-4a428fd.md index 95000f98..3ba55366 100644 --- a/docs/ISuite/40-RemoteSystems/configuration-checklist-for-inbound-authentication-4a428fd.md +++ b/docs/ISuite/40-RemoteSystems/configuration-checklist-for-inbound-authentication-4a428fd.md @@ -374,7 +374,7 @@ See: [Client Certificate Authentication for API Clients](client-certificate-auth -Role as described at [Tasks and Permissions](../60-Security/tasks-and-permissions-556d557.md) +Role as described at [Tasks and Permissions for Cloud Integration](../60-Security/tasks-and-permissions-for-cloud-integration-556d557.md) diff --git a/docs/ISuite/40-RemoteSystems/configuring-inbound-communication-62690e5.md b/docs/ISuite/40-RemoteSystems/configuring-inbound-communication-62690e5.md index d418f279..091b3554 100644 --- a/docs/ISuite/40-RemoteSystems/configuring-inbound-communication-62690e5.md +++ b/docs/ISuite/40-RemoteSystems/configuring-inbound-communication-62690e5.md @@ -46,8 +46,6 @@ To enable communication with such a variety of systems, Cloud Integration suppor - Connections to an external message broker using the Advanced Message Queuing Protocol \(AMQP\) -For an overview of the communication protocols and the available adapters \(that are based on a certain protocol\), see [Connectivity (Adapters)](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/55325f2a722c4f67bb7752b369b09ff8.html "You have the option to specify which technical protocols should be used to connect a sender or a receiver to the tenant.") :arrow_upper_right:. - > ### Note: > The procedure to set up HTTP connections depends on whether you use Cloud Integration in the Cloud Foundry or in the Neo environment. @@ -56,8 +54,6 @@ For an overview of the communication protocols and the available adapters \(that [Configuring Inbound HTTP Connections](configuring-inbound-http-connections-f568400.md "") -[Configuring Inbound HTTP Connections, Neo Environment](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/bd1dbc4ba360426ab2244a9ae441ded6.html "") :arrow_upper_right: - [Setting Up Inbound SFTP Connections](setting-up-inbound-sftp-connections-d8fb958.md "Using the SFTP sender adapter, you connect an SAP Integration Suite tenant with an SFTP server so that the tenant can read data from the SFTP server (in a process referred to as polling).") [Setting Up Inbound Mail Connections](setting-up-inbound-mail-connections-6ad4956.md "Using the mail sender adapter, you connect the tenant with an e-mail server so that the tenant can read data from the e-mail server (in a process referred to as polling).") diff --git a/docs/ISuite/40-RemoteSystems/creating-service-instance-and-service-key-for-inbound-authentication-19af5e2.md b/docs/ISuite/40-RemoteSystems/creating-service-instance-and-service-key-for-inbound-authentication-19af5e2.md index bfb4f82e..7b63ef10 100644 --- a/docs/ISuite/40-RemoteSystems/creating-service-instance-and-service-key-for-inbound-authentication-19af5e2.md +++ b/docs/ISuite/40-RemoteSystems/creating-service-instance-and-service-key-for-inbound-authentication-19af5e2.md @@ -178,7 +178,7 @@ Create a service instance to implement inbound communication. A service instance These roles define permissions for API clients to access certain SAP Integration Suite resources using the OData API. - Choose the role depending on the resource you like to access using the OData API \(see [Tasks and Permissions](../60-Security/tasks-and-permissions-556d557.md)\). + Choose the role depending on the resource you like to access using the OData API \(see [Tasks and Permissions for Cloud Integration](../60-Security/tasks-and-permissions-for-cloud-integration-556d557.md)\). diff --git a/docs/ISuite/40-RemoteSystems/downloading-a-certificate-signing-request-b199dbe.md b/docs/ISuite/40-RemoteSystems/downloading-a-certificate-signing-request-b199dbe.md index 2354c781..0bd5da47 100644 --- a/docs/ISuite/40-RemoteSystems/downloading-a-certificate-signing-request-b199dbe.md +++ b/docs/ISuite/40-RemoteSystems/downloading-a-certificate-signing-request-b199dbe.md @@ -49,7 +49,7 @@ You send the CSR to a certification authority, who will provide a signing respon **Related Information** - + [Updating a Key Pair with a Signing Response](../50-Development/updating-a-key-pair-with-a-signing-response-4242f01.md "Upload a signing response from a certification authority and use it to update the key pair in your keystore, keeping the alias of the keystore entry unchanged.") diff --git a/docs/ISuite/40-RemoteSystems/introduction-10dc4a3.md b/docs/ISuite/40-RemoteSystems/introduction-10dc4a3.md index d9371c53..893aeebb 100644 --- a/docs/ISuite/40-RemoteSystems/introduction-10dc4a3.md +++ b/docs/ISuite/40-RemoteSystems/introduction-10dc4a3.md @@ -372,6 +372,46 @@ See: [AMQP Receiver for SAP Event Mesh](../50-Development/amqp-receiver-for-sap- +*AMQP for SAP Integration Suite, advanced event mesh* + +Sender adapter + + + + +Enables SAP Integration Suite to consume messages from SAP Integration Suite, advanced event mesh. + +Supported message protocol: AMQP \(Advanced Message Queuing Protocol\) 1.0 + +Supported transport protocol: TCP + +See: [AMQ Sender for SAP Integration Suite, advanced event mesh](../50-Development/amq-sender-for-sap-integration-suite-advanced-event-mesh-be1e496.md) + + + + + + +*AMQP for SAP Integration Suite, advanced event mesh* + +Receiver adapter + + + + +Enables SAP Integration Suite to send messages to SAP Integration Suite, advanced event mesh. + +Supported message protocol: AMQP \(Advanced Message Queuing Protocol\) 1.0 + +Supported transport protocol: TCP + +See: [AMQP Receiver for SAP Integration Suite, advanced event mesh](../50-Development/amqp-receiver-for-sap-integration-suite-advanced-event-mesh-5f229c0.md) + + + + + + *AMQP for Microsoft Azure Service Bus* Sender adapter @@ -385,7 +425,7 @@ Supported message protocol: AMQP \(Advanced Message Queuing Protocol\) 1.0 Supported transport protocol: TCP -See: [AMQP Sender for Microsoft Azure Service Bus](../50-Development/amqp-sender-for-microsoft-azure-service-bus-7384ac3.md) +See: [Configure the AMQP Sender Adapter](../50-Development/configure-the-amqp-sender-adapter-99ce674.md) @@ -405,7 +445,7 @@ Supported message protocol: AMQP \(Advanced Message Queuing Protocol\) 1.0 Supported transport protocol: TCP -See: [AMQP Receiver for Microsoft Azure Service Bus](../50-Development/amqp-receiver-for-microsoft-azure-service-bus-9c64d80.md) +See: [Configure the AMQP Receiver Adapter](../50-Development/configure-the-amqp-receiver-adapter-d5660c1.md) @@ -425,7 +465,7 @@ Supported message protocol: AMQP \(Advanced Message Queuing Protocol\) 1.0 Supported transport protocol: TCP -See: [AMQP Sender for Solace PubSub+](../50-Development/amqp-sender-for-solace-pubsub-c9ab47d.md) +See: [Configure the AMQP Sender Adapter](../50-Development/configure-the-amqp-sender-adapter-99ce674.md) @@ -445,7 +485,7 @@ Supported message protocol: AMQP \(Advanced Message Queuing Protocol\) 1.0 Supported transport protocol: TCP -See: [AMQP Receiver for Solace PubSub+](../50-Development/amqp-receiver-for-solace-pubsub-19f18d8.md) +See: [Configure the AMQP Receiver Adapter](../50-Development/configure-the-amqp-receiver-adapter-d5660c1.md) @@ -465,7 +505,7 @@ Supported message protocol: AMQP \(Advanced Message Queuing Protocol\) 1.0 Supported transport protocol: TCP, WebSocket -See: [AMQP Sender for Apache Qpid Broker-J](../50-Development/amqp-sender-for-apache-qpid-broker-j-b4983f7.md) +See: [Configure the AMQP Sender Adapter](../50-Development/configure-the-amqp-sender-adapter-99ce674.md) @@ -485,7 +525,7 @@ Supported message protocol: AMQP \(Advanced Message Queuing Protocol\) 1.0 Supported transport protocol: TCP, WebSocket -See: [AMQP Receiver for Apache Qpid Broker-J](../50-Development/amqp-receiver-for-apache-qpid-broker-j-622aa1d.md) +See: [Configure the AMQP Receiver Adapter](../50-Development/configure-the-amqp-receiver-adapter-d5660c1.md) @@ -505,7 +545,7 @@ Supported message protocol: AMQP \(Advanced Message Queuing Protocol\) 1.0 Supported transport protocol: TCP -See: [AMQP Sender for Apache ActiveMQ 5 and Apache ActiveMQ Artemis](../50-Development/amqp-sender-for-apache-activemq-5-and-apache-activemq-artemis-dc4c564.md) +See: [Configure the AMQP Sender Adapter](../50-Development/configure-the-amqp-sender-adapter-99ce674.md) @@ -525,7 +565,7 @@ Supported message protocol: AMQP \(Advanced Message Queuing Protocol\) 1.0 Supported transport protocol: TCP -See: [AMQP Receiver for Apache ActiveMQ 5 and Apache ActiveMQ Artemis](../50-Development/amqp-receiver-for-apache-activemq-5-and-apache-activemq-artemis-76c4dd3.md) +See: [Configure the AMQP Receiver Adapter](../50-Development/configure-the-amqp-receiver-adapter-d5660c1.md) @@ -545,7 +585,7 @@ Supported message protocol: AMQP \(Advanced Message Queuing Protocol\) 1.0 Supported transport protocol: TCP -See: [AMQP Sender for IBM MQ](../50-Development/amqp-sender-for-ibm-mq-f6cc0e4.md) +See: [Configure the AMQP Sender Adapter](../50-Development/configure-the-amqp-sender-adapter-99ce674.md) @@ -565,7 +605,7 @@ Supported message protocol: AMQP \(Advanced Message Queuing Protocol\) 1.0 Supported transport protocol: TCP -See: [AMQP Receiver for IBM MQ](../50-Development/amqp-receiver-for-ibm-mq-990fa99.md) +See: [Configure the AMQP Receiver Adapter](../50-Development/configure-the-amqp-receiver-adapter-d5660c1.md) diff --git a/docs/ISuite/40-RemoteSystems/oauth-with-client-credentials-grant-for-api-clients-20e26a8.md b/docs/ISuite/40-RemoteSystems/oauth-with-client-credentials-grant-for-api-clients-20e26a8.md index 1fefff1d..b66c7c74 100644 --- a/docs/ISuite/40-RemoteSystems/oauth-with-client-credentials-grant-for-api-clients-20e26a8.md +++ b/docs/ISuite/40-RemoteSystems/oauth-with-client-credentials-grant-for-api-clients-20e26a8.md @@ -35,7 +35,7 @@ To set up this authorization option, perform the following steps. 1. Look up the role to be used to authorize the API client to access the related Cloud Integration resource using the API. - See: [Tasks and Permissions](../60-Security/tasks-and-permissions-556d557.md) + See: [Tasks and Permissions for Cloud Integration](../60-Security/tasks-and-permissions-for-cloud-integration-556d557.md) 2. In SAP BTP cockpit, select the subaccount that hosts your SAP Integration Suite virtual environment and create a service instance and service key. @@ -121,7 +121,7 @@ To set up this authorization option, perform the following steps. Select role according to the API resource to access. - See: [Tasks and Permissions](../60-Security/tasks-and-permissions-556d557.md) + See: [Tasks and Permissions for Cloud Integration](../60-Security/tasks-and-permissions-for-cloud-integration-556d557.md) @@ -165,7 +165,7 @@ To set up this authorization option, perform the following steps. Select role according to the API resource to access. - See: [Tasks and Permissions](../60-Security/tasks-and-permissions-556d557.md) + See: [Tasks and Permissions for Cloud Integration](../60-Security/tasks-and-permissions-for-cloud-integration-556d557.md) @@ -209,7 +209,7 @@ To set up this authorization option, perform the following steps. Select role according to the API resource to access. - See: [Tasks and Permissions](../60-Security/tasks-and-permissions-556d557.md) + See: [Tasks and Permissions for Cloud Integration](../60-Security/tasks-and-permissions-for-cloud-integration-556d557.md) diff --git a/docs/ISuite/40-RemoteSystems/oauth-with-client-credentials-grant-for-integration-flow-processing-6c052ce.md b/docs/ISuite/40-RemoteSystems/oauth-with-client-credentials-grant-for-integration-flow-processing-6c052ce.md index a2ac4ae1..92463997 100644 --- a/docs/ISuite/40-RemoteSystems/oauth-with-client-credentials-grant-for-integration-flow-processing-6c052ce.md +++ b/docs/ISuite/40-RemoteSystems/oauth-with-client-credentials-grant-for-integration-flow-processing-6c052ce.md @@ -27,13 +27,18 @@ Simply spoken, this authentication is established using the following sequent st - Using a client certificate from the service key - If you use a client certificate, you can either use an own \("external"\) client certificate or a client certificate generated by SAP \(see [Service Key Types](service-key-types-0fc1446.md)\). + If you use a client certificate, you can either use an own \(*external*\) client certificate or a client certificate generated by SAP \(see [Service Key Types](service-key-types-0fc1446.md)\). > ### Tip: > For a step-by-step description of how to set up this use case, check out the following tutorial: > > [Set Up Inbound OAuth Client Credentials Grant Authentication for Senders Calling Integration Flows with SAP-Generated Certificate](https://developers-qa-blue.wcms-nonprod.c.eu-de-2.cloud.sap/tutorials/btp-integration-suite-oauth-integration-flow.html) + > ### Caution: + > If you use an *external* client certificate \(*Key Type* parameter set to *External Certificate* when creating the corresponding service key, see [Creating Service Instance and Service Key for Inbound Authentication](creating-service-instance-and-service-key-for-inbound-authentication-19af5e2.md)\), the certificate must be signed by a CA from the list specified in the following topic: + > + > See: [Trusted Authorities for X.509 Certificates](https://help.sap.com/docs/btp/sap-business-technology-platform/trusted-certificate-authorities-for-x-509-secrets?version=Cloud) + 2. Token server issues access token. diff --git a/docs/ISuite/40-RemoteSystems/service-key-types-0fc1446.md b/docs/ISuite/40-RemoteSystems/service-key-types-0fc1446.md index c36d2c2e..d4616a99 100644 --- a/docs/ISuite/40-RemoteSystems/service-key-types-0fc1446.md +++ b/docs/ISuite/40-RemoteSystems/service-key-types-0fc1446.md @@ -69,6 +69,10 @@ When defining a service key with this *Key Type*, you can specify a *Validity in SAP generates a client certificate and public/private key pair together with the service key. The certificate parameters of the service key \(for example, the issuer DN and the serial number\) are then determined by SAP. The validity of the certificate \(*validuntil* parameter of the certificate\) is calculated based on the entry that you've selected for *Validity in days* when defining the service key. +The certificate needs to be signed by a certification authority that is supported by the load balancer. + +See: [Load Balancer Root Certificates Supported by SAP](load-balancer-root-certificates-supported-by-sap-4509f60.md) + Furthermore, the certificate is signed by a certificate authority \(CA\) that is supported by SAP BTP. @@ -110,3 +114,49 @@ See: [Load Balancer Root Certificates Supported by SAP](load-balancer-root-certi +The list of CAs that can sign the certificate depends on the scenario. + + + + + + + + + + + + + + + +
+ +Scenario + + + +Certificate to be signed by … + +
+ +Sender uses client certificate to directly call integration flow \([Client Certificate Authentication for Integration Flow Processing](client-certificate-authentication-for-integration-flow-processing-7f84d16.md)\). + + + +The certificate needs to be signed by a certification authority that is supported by the load balancer. + +See: [Load Balancer Root Certificates Supported by SAP](load-balancer-root-certificates-supported-by-sap-4509f60.md) + +
+ +Sender uses client certificate to call token server, and in a second step uses the access token to call integration flow \([OAuth with Client Credentials Grant for Integration Flow Processing](oauth-with-client-credentials-grant-for-integration-flow-processing-6c052ce.md)\). + + + +The certificate must be signed by a CA from the list specified in the following topic: + +See: [Trusted Authorities for X.509 Certificates](https://help.sap.com/docs/btp/sap-business-technology-platform/trusted-certificate-authorities-for-x-509-secrets?version=Cloud) + +
+ diff --git a/docs/ISuite/40-RemoteSystems/setting-up-inbound-sftp-connections-details-e72eba4.md b/docs/ISuite/40-RemoteSystems/setting-up-inbound-sftp-connections-details-e72eba4.md index 70bb8f7d..ab99fd61 100644 --- a/docs/ISuite/40-RemoteSystems/setting-up-inbound-sftp-connections-details-e72eba4.md +++ b/docs/ISuite/40-RemoteSystems/setting-up-inbound-sftp-connections-details-e72eba4.md @@ -52,7 +52,7 @@ Configure the **SFTP sender adapter** to specify the technical details of how th [Inbound SFTP With Public Key Authentication](inbound-sftp-with-public-key-authentication-97e2baa.md "") -[Configure the SFTP Sender Adapter](../50-Development/configure-the-sftp-sender-adapter-2de9ee5.md "The SFTP sender adapter connects an SAP Cloud Integration tenant to a remote system using the SSH File Transfer protocol to read files from the system. SSH File Transfer protocol is also referred to as Secure File Transfer protocol (or SFTP).") +[Configure the SFTP Sender Adapter](../50-Development/configure-the-sftp-sender-adapter-2de9ee5.md "The SFTP sender adapter connects an SAP Integration Suite tenant to a remote system using the SSH File Transfer protocol to read files from the system. SSH File Transfer protocol is also referred to as Secure File Transfer protocol (or SFTP).") [Blog: Dynamically Configure the SFTP Receiver Adapter](https://blogs.sap.com/2020/05/29/cloud-integration-dynamically-configure-the-sftp-receiver-adapter/) diff --git a/docs/ISuite/40-RemoteSystems/setting-up-outbound-sftp-connections-details-15401a7.md b/docs/ISuite/40-RemoteSystems/setting-up-outbound-sftp-connections-details-15401a7.md index fddd0c6f..7844790c 100644 --- a/docs/ISuite/40-RemoteSystems/setting-up-outbound-sftp-connections-details-15401a7.md +++ b/docs/ISuite/40-RemoteSystems/setting-up-outbound-sftp-connections-details-15401a7.md @@ -65,7 +65,7 @@ Open the related integration flow and configure the **SFTP receiver adapter** to [Creating SFTP Keys](creating-sftp-keys-3485a75.md "You can set up reliable file transfer based on SSH File Transfer Protocol (SFTP). SFTP is an enhancement of the Secure Shell (SSH) network protocol.") -[Configure the SFTP Receiver Adapter](../50-Development/configure-the-sftp-receiver-adapter-4ef52cf.md "The SFTP receiver adapter connects an SAP Cloud Integration tenant to a remote system using the SSH File Transfer protocol to write files to the system. SSH File Transfer protocol is also referred to as Secure File Transfer protocol (or SFTP).") +[Configure the SFTP Receiver Adapter](../50-Development/configure-the-sftp-receiver-adapter-4ef52cf.md "The SFTP receiver adapter connects an SAP Integration Suite tenant to a remote system using the SSH File Transfer protocol to write files to the system. SSH File Transfer protocol is also referred to as Secure File Transfer protocol (or SFTP).") [Outbound SFTP With Public Key Authentication](outbound-sftp-with-public-key-authentication-d96b2d7.md "") diff --git a/docs/ISuite/50-Development/IntegrationSettings/creating-custom-tags-71c0448.md b/docs/ISuite/50-Development/IntegrationSettings/creating-custom-tags-71c0448.md index 0d8b17a4..c82637e6 100644 --- a/docs/ISuite/50-Development/IntegrationSettings/creating-custom-tags-71c0448.md +++ b/docs/ISuite/50-Development/IntegrationSettings/creating-custom-tags-71c0448.md @@ -9,7 +9,7 @@ You can maintain custom attributes in your editable integration packages. You can tag your integration package using custom attributes that can be created under the *Settings* tab. The tags can help you identify and track your packages based on attributes, for example, such as Author, Line of Business etc. > ### Remember: -> You must have the tenant administrator role assigned to access the *Custom Tags* settings. See [Tasks and Permissions](../../60-Security/tasks-and-permissions-556d557.md). +> You must have the tenant administrator role assigned to access the *Custom Tags* settings. See [Tasks and Permissions for Cloud Integration](../../60-Security/tasks-and-permissions-for-cloud-integration-556d557.md). 1. Navigate to the *Settings* \(:gear:\) in the web UI and choose *Custom Tags*. diff --git a/docs/ISuite/50-Development/IntegrationSettings/design-guidelines-4d1c84f.md b/docs/ISuite/50-Development/IntegrationSettings/design-guidelines-4d1c84f.md index 60e72465..60efaddc 100644 --- a/docs/ISuite/50-Development/IntegrationSettings/design-guidelines-4d1c84f.md +++ b/docs/ISuite/50-Development/IntegrationSettings/design-guidelines-4d1c84f.md @@ -41,7 +41,10 @@ Follow these simple steps to enable or disable all or a subset of available desi 4. Choose *Save*. -You can enable or disable a design guideline anytime +You can enable or disable a design guideline anytime. + +> ### Tip: +> As a tenant administrator, you can assign a dedicated Integration Lead to enable the applicable design guidelines. You can [define a custom role collection](https://help.sap.com/docs/btp/sap-business-technology-platform/define-role-collection?version=Cloud) in the SAP BTP cockpit and add the role `WorkspaceDesignGuidelinesConfigure` to it. Later, assign this role collection to a user. diff --git a/docs/ISuite/50-Development/IntegrationSettings/importing-content-from-sap-process-orchestration-system-53db5fb.md b/docs/ISuite/50-Development/IntegrationSettings/importing-content-from-sap-process-orchestration-system-53db5fb.md index d8c7e24c..78e1fe84 100644 --- a/docs/ISuite/50-Development/IntegrationSettings/importing-content-from-sap-process-orchestration-system-53db5fb.md +++ b/docs/ISuite/50-Development/IntegrationSettings/importing-content-from-sap-process-orchestration-system-53db5fb.md @@ -39,6 +39,7 @@ API endpoints and subpaths are used to extract data from your SAP Process Orches - `/rep/read/ext` - `/dir/read/ext` - `/rep/support/SimpleQuery` + - `/rep/query/ext` - For Message mapping: `/rep/query/` diff --git a/docs/ISuite/50-Development/IntegrationSettings/importing-mapping-content-from-es-repository-e18fc05.md b/docs/ISuite/50-Development/IntegrationSettings/importing-mapping-content-from-es-repository-e18fc05.md index 6a1347de..dc256248 100644 --- a/docs/ISuite/50-Development/IntegrationSettings/importing-mapping-content-from-es-repository-e18fc05.md +++ b/docs/ISuite/50-Development/IntegrationSettings/importing-mapping-content-from-es-repository-e18fc05.md @@ -59,7 +59,7 @@ Here's how you can do it: If you can't find the *References* tab, choose the empty space in the integration flow editor. You will find the *References* tab at the end of the integration flow editor. -2. Choose *Add* and select a supported resource. See the supported sources here: [Manage Resources of an Integration Flow](../manage-resources-of-an-integration-flow-b5968b2.md). +2. Choose *Add* and select a supported resource. See the supported sources here: [Manage Resources](../manage-resources-b5968b2.md). 3. Choose *ES Repository* as the source. diff --git a/docs/ISuite/50-Development/IntegrationSettings/upload-custom-adapters-fc4f957.md b/docs/ISuite/50-Development/IntegrationSettings/upload-custom-adapters-fc4f957.md index e6f908db..4929bc1e 100644 --- a/docs/ISuite/50-Development/IntegrationSettings/upload-custom-adapters-fc4f957.md +++ b/docs/ISuite/50-Development/IntegrationSettings/upload-custom-adapters-fc4f957.md @@ -26,16 +26,17 @@ Upload the adapters compatible with Camel 3.14 runtime version from your existin 1. From the subaccount of your productive Integration Suite tenant, go to *Services* \> *Integration Suite* \> *Settings* \> *Integrations* \> *Camel 3.14 Upgrade* \> *Upload*. -2. In the Upload Custom Integration Adapter dialog box, *Browse* and select the adapter for uploading. +2. **For your custom integration adapters:** In the Upload Custom Integration Adapter dialog box, *Browse* and select the adapter for uploading. > ### Note: - > The 3.14 runtime compatible adapter can only be uploaded if its 2.24 runtime compatible version is already deployed in the tenant. + > - The 3.14 runtime compatible adapter can only be uploaded if its 2.24 runtime compatible version is already deployed in the tenant. + > - The successfully uploaded custom adapters will be available in your production tenants after migration. -3. Select the checkbox beside *Enable porting of your existing OEM adapters to Apache Camel 3.14 runtime* to allow automatic porting of OEM adapters into your tenant once the tenants are migrated. You may also do it manually, by downloading OEM adapters from SMP and then uploading. For more details, see SAP Note [3326553](https://me.sap.com/notes/3326553). + **For your existing OEM adapters**: Select the checkbox beside *Enable porting of your existing OEM adapters to Apache Camel 3.14 runtime* to allow automatic porting of OEM adapters into your tenant once the tenants are migrated. You may also do it manually, by downloading OEM adapters from SMP and then uploading the adapters as mentioned above. For more details, see SAP Note [3326553](https://me.sap.com/notes/3326553). > ### Note: - > - The successfully uploaded custom adapters will be available in your production tenants after migration. + > Autoporting will update your adapter to the latest version. -4. After your tenant is upgraded to Camel 3.14 version, upload the adapter \(.esa file\) to the appropriate integration package. This action is done to ensure that your design time too has the latest version of the adapter. +3. After your tenant is upgraded to Camel 3.14 version, upload the adapter \(.esa file\) to the appropriate integration package. This action is done to ensure that your design time too has the latest version of the adapter. diff --git a/docs/ISuite/50-Development/access-logs-c1649cd.md b/docs/ISuite/50-Development/access-logs-c1649cd.md index 1a15627d..dd2ed445 100644 --- a/docs/ISuite/50-Development/access-logs-c1649cd.md +++ b/docs/ISuite/50-Development/access-logs-c1649cd.md @@ -7,7 +7,7 @@ The *Access Logs* section allows you to monitor and to analyze errors that occur > ### Caution: > This information is relevant only when you use SAP Cloud Integration in the Cloud Foundry environment. > -> You can access the system logs only if the Cloud Logging Service is available for your Cloud Integration application. This feature ist not yet enabled on all data centers. +> You can access the system logs only if the Cloud Logging Service is available for your Cloud Integration application. This feature is not yet enabled on all data centers. **Related Information** diff --git a/docs/ISuite/50-Development/additional-attributes-in-openapi-specification-35f357c.md b/docs/ISuite/50-Development/additional-attributes-in-openapi-specification-35f357c.md index 7f722d93..2723ce8a 100644 --- a/docs/ISuite/50-Development/additional-attributes-in-openapi-specification-35f357c.md +++ b/docs/ISuite/50-Development/additional-attributes-in-openapi-specification-35f357c.md @@ -579,7 +579,7 @@ The Open API specification 2.0 does not support multiple hosts \(and ports\), ne These features is supported in the `servers` property in the Open API specification v3.0. However, in Open API specification v2.0, the required configuration values can be added via the custom extension `x-servers`. -For more information about how to specify sandbox url and multiple hosts or production servers in OpenAPI 3.0, see the Sandbox and Configure Information sections in [Governance Guidelines for API Packages](https://help.sap.com/viewer/4fb3aee633a84254a48d3f8c3b5c5364/Cloud/en-US/1e1cd898d3984bc79f214202e12ad5b5.html "A checklist to ensure your APIs have been correctly packaged before they are published on the SAP Business Accelerator Hub.") :arrow_upper_right: +For more information about how to specify sandbox url and multiple hosts or production servers in OpenAPI 3.0, see the Sandbox and Configure Information sections in [Governance Guidelines for API Packages](https://help.sap.com/viewer/4fb3aee633a84254a48d3f8c3b5c5364/Dev/en-US/1e1cd898d3984bc79f214202e12ad5b5.html "A checklist to ensure your APIs have been correctly packaged before they are published on the SAP Business Accelerator Hub.") :arrow_upper_right: See [here](https://blogs.sap.com/2018/01/05/open-api-spec-2.0-vs-3.0/) to know more information about the differences between OpenAPI 2.0 and Open API 3.0 specifications diff --git a/docs/ISuite/50-Development/additional-attributes-in-openapi-specification-4ab4c8e.md b/docs/ISuite/50-Development/additional-attributes-in-openapi-specification-4ab4c8e.md index a6e9ba57..c7718b09 100644 --- a/docs/ISuite/50-Development/additional-attributes-in-openapi-specification-4ab4c8e.md +++ b/docs/ISuite/50-Development/additional-attributes-in-openapi-specification-4ab4c8e.md @@ -579,7 +579,7 @@ The Open API specification 2.0 does not support multiple hosts \(and ports\), ne These features is supported in the `servers` property in the Open API specification v3.0. However, in Open API specification v2.0, the required configuration values can be added via the custom extension `x-servers`. -For more information about how to specify sandbox url and multiple hosts or production servers in OpenAPI 3.0, see the Sandbox and Configure Information sections in [Governance Guidelines for API Packages](https://help.sap.com/viewer/4fb3aee633a84254a48d3f8c3b5c5364/Cloud/en-US/1e1cd898d3984bc79f214202e12ad5b5.html "A checklist to ensure your APIs have been correctly packaged before they are published on the SAP Business Accelerator Hub.") :arrow_upper_right: +For more information about how to specify sandbox url and multiple hosts or production servers in OpenAPI 3.0, see the Sandbox and Configure Information sections in [Governance Guidelines for API Packages](https://help.sap.com/viewer/4fb3aee633a84254a48d3f8c3b5c5364/Dev/en-US/1e1cd898d3984bc79f214202e12ad5b5.html "A checklist to ensure your APIs have been correctly packaged before they are published on the SAP Business Accelerator Hub.") :arrow_upper_right: See [here](https://blogs.sap.com/2018/01/05/open-api-spec-2.0-vs-3.0/) to know more information about the differences between OpenAPI 2.0 and Open API 3.0 specifications diff --git a/docs/ISuite/50-Development/advanced-event-mesh-adapter-dd7e034.md b/docs/ISuite/50-Development/advanced-event-mesh-adapter-dd7e034.md index a62406ac..829e0733 100644 --- a/docs/ISuite/50-Development/advanced-event-mesh-adapter-dd7e034.md +++ b/docs/ISuite/50-Development/advanced-event-mesh-adapter-dd7e034.md @@ -9,6 +9,13 @@ The adapter uses the Solace Message Format \(SMF\) message protocol. > ### Note: > Only SMF allowed headers are forwarded on the sender and receiver. To store any custom headers on the receiver, use the UserProperties header. +> ### Note: +> This adapter is available on SAP Business Accelerator Hub. +> +> For more information, see [Consuming Integration Adapters from SAP Business Accelerator Hub](consuming-integration-adapters-from-sap-business-accelerator-hub-b9250fb.md). +> +> The availability of the adapter is dependent on your SAP Integration Suite service plan. For more information about different service plans and their supported feature set, see SAP Notes [2903776](https://launchpad.support.sap.com/#/notes/2903776) and [3188446](https://launchpad.support.sap.com/#/notes/3188446). + **Related Information** diff --git a/docs/ISuite/50-Development/amqp-sender-for-ibm-mq-f6cc0e4.md b/docs/ISuite/50-Development/amq-sender-for-sap-integration-suite-advanced-event-mesh-be1e496.md similarity index 73% rename from docs/ISuite/50-Development/amqp-sender-for-ibm-mq-f6cc0e4.md rename to docs/ISuite/50-Development/amq-sender-for-sap-integration-suite-advanced-event-mesh-be1e496.md index d9d50524..83555e4b 100644 --- a/docs/ISuite/50-Development/amqp-sender-for-ibm-mq-f6cc0e4.md +++ b/docs/ISuite/50-Development/amq-sender-for-sap-integration-suite-advanced-event-mesh-be1e496.md @@ -1,11 +1,8 @@ - + -# AMQP Sender for IBM MQ +# AMQ Sender for SAP Integration Suite, advanced event mesh -Enables SAP Integration Suite to consume messages from queues in IBM MQ. - -> ### Note: -> This adapter works only with IBM MQ version 9.2 and above. +Enables SAP Integration Suite to consume messages from queues in SAP Integration Suite, advanced event mesh. @@ -19,7 +16,7 @@ Enables SAP Integration Suite to consume messages from queues in IBM MQ. > To use the latest version of a flow step or adapter – edit your integration flow, delete the flow step or adapter, add the step or adapter, and configure the same. Finally, redeploy the integration flow. See: [Updating your Existing Integration Flow](updating-your-existing-integration-flow-1f9e879.md). > ### Note: -> Queues, topics, and messages can only be monitored by using tools provided by the message broker provider. Those monitors are not integrated into SAP Integration Suite. In SAP Integration Suite, the integration flows using the AMQP adapter are monitored and the messages are sent to or consumed from the message broker. +> Queues, topics, and messages can only be monitored by using tools provided by the message broker provider. Those monitors are not integrated into SAP Integration Suite . Using SAP Integration Suite , you can only monitor the integration flows using the AMQP adapter and the messages that are sent to or consumed from the message broker. > ### Note: > To be able to connect to queues, you have to create queues and/or topics in the message broker. This needs to be done in the message broker, with the configuration tools provided by the message broker. In some messaging systems, you need to configure a *Lock Duration* to make sure that the message is not consumed more than once. This timeout must be longer than the expected processing time of the message, otherwise this would lead to duplicate messages. @@ -29,12 +26,7 @@ Enables SAP Integration Suite to consume messages from queues in IBM MQ. -> ### Note: -> This adapter enables you to connect SAP Integration Suite to a remote message broker. SAP can’t give advice on how to configure the external system nor does SAP provide support related to this. - - - -To connect Cloud Integration to IBM MQ, make sure to specify the following parameters in the described way: +To connect Cloud Integration to SAP Integration Suite, advanced event mesh, make sure to specify the following parameters in the described way. When creating the channel \(see [Overview of Integration Flow Editor](overview-of-integration-flow-editor-db10beb.md)\), select adapter type *AMQP* \> *TCP*. @@ -66,7 +58,7 @@ Description -AMQP +*AMQP* @@ -161,7 +153,7 @@ For more information, see [Using SAP Cloud Connector with Cloud Integration Adap -*Path* \(only if *WebSocket* is selected as the *Transport Protocol* in the *General* tab\) +*Path* @@ -178,7 +170,7 @@ Specify the access path of the message broker. -Select if *TLS* has to be used for the connection. +Select this option. @@ -202,14 +194,14 @@ To connect to an SAP Cloud Connector instance associated with your account, ente -Select the authentication method supported by the message broker. Make sure that *SASL* is selected \(default setting\). +Select *SASL*. -*Credential Name* \(only if *SASL* or *OAuth2 Client Credentials* are selected for *Authentication*\) +*Credential Name* @@ -260,11 +252,6 @@ Specify the name of the queue or topic subscription to consume from. Specify the number of processes used for parallel message processing. Note, that these processes are started from each worker node. -> ### Note: -> The maximum number of parallel processes cannot exceed 99. The default is set to 1. - - - @@ -315,7 +302,7 @@ By default, this option is deactivated. Define the number of retries to be executed before a different delivery status is sent to the message broker. > ### Note: -> With the default setting \(`0`\), any message that is marked as a retried message is directly returning the outcome configured in *Delivery Status After Max. Retries* to the message broker and does not even start processing the message. Be aware of the fact that any delivery attempt by the message broker, even a failed one \(for example, due to network issues\), increases the delivery counter of the message sent by the message broker. +> If this parameter is set to \(`0`\), any message that is marked as a retried message is directly returning the outcome configured in *Delivery Status After Max. Retries* to the message broker and does not even start processing the message. Be aware of the fact that any delivery attempt by the message broker, even a failed one \(for example, due to network issues\), increases the delivery counter of the message sent by the message broker. > > If the value is set to a number bigger than `0`, the AMQP adapter returns the outcome configured in *Delivery Status After Max. Retries* to the message broker if the delivery count of the message exceeds the configured value. Otherwise, it processes the message and returns a released outcome in case of an error and an accepted outcome in case of a successful message processing. > @@ -335,17 +322,20 @@ Define the number of retries to be executed before a different delivery status i -Define one delivery status that is to be sent to the message broker after the maximum number of retries. Choose between the following options: +Define one delivery status that is to be sent to the message broker after the maximum number of retries. -- *REJECTED* +Select *REJECTED*. -- *MODIFIED\_FAILED\_UNDELIVERABLE* +Make sure to configure the dead letter queue and the maximum redeliveries in the message broker as well. +Don't select *MODIFIED\_FAILED\_UNDELIVERABLE*. > ### Note: > See this [general information on AMQP](http://docs.oasis-open.org/amqp/core/v1.0/amqp-core-complete-v1.0.pdf) on delivery statuses and their meaning. > -> See this [blog](https://blogs.sap.com/2019/11/20/cloud-integration-connecting-to-external-messaging-systems-using-the-amqp-adapter/) for a summary of the capabilities supported by the different brokers. +> You can use the following headers to configure a delay in retry processing: `JMSRedelivered` and `JMSXDeliveryCount`. For more information, see the SAP Community blog [Cloud Integration – Connecting to Messaging Systems using the AMQP Adapter](https://community.sap.com/t5/technology-blogs-by-sap/cloud-integration-connecting-to-messaging-systems-using-the-amqp-adapter/ba-p/13419906). +> +> This blog also contains an overview of the recommended settings for different message brokers. @@ -353,22 +343,3 @@ Define one delivery status that is to be sent to the message broker after the ma - - - - -## Further Constraints - -Note the following when using the AMQP adapter to connect Cloud Integration to IBM MQ: - -- Dead letter queue handling based on delivery status isn't supported. - -- You can configure retry by setting the header `JMSRedelivered` \(with version \>= 9.2\). - -- You can use header `JMSXDeliveryCount` \(with version \>= 9.2\).. - - -See: [Headers and Exchange Properties Provided by the Integration Framework](headers-and-exchange-properties-provided-by-the-integration-framework-d0fcb09.md) - -For more information and an example scenario using this option, see the following SAP Community blog: [https://blogs.sap.com/2019/11/20/cloud-integration-connecting-to-external-messaging-systems-using-the-amqp-adapter/](https://blogs.sap.com/2019/11/20/cloud-integration-connecting-to-external-messaging-systems-using-the-amqp-adapter/). - diff --git a/docs/ISuite/50-Development/amqp-receiver-for-apache-activemq-5-and-apache-activemq-artemis-76c4dd3.md b/docs/ISuite/50-Development/amqp-receiver-for-apache-activemq-5-and-apache-activemq-artemis-76c4dd3.md deleted file mode 100644 index 93e1cc3a..00000000 --- a/docs/ISuite/50-Development/amqp-receiver-for-apache-activemq-5-and-apache-activemq-artemis-76c4dd3.md +++ /dev/null @@ -1,364 +0,0 @@ - - -# AMQP Receiver for Apache ActiveMQ 5 and Apache ActiveMQ Artemis - -Enables SAP Integration Suite to send messages to queues or topics in Apache ActiveMQ 5 / Apache ActiveMQ Artemis. - - - -> ### Note: -> In the following cases certain features might not be available for your current integration flow: -> -> - You are using a runtime profile other than the one expected. See: [Runtime Profiles](IntegrationSettings/runtime-profiles-8007daa.md). -> -> - A feature for a particular adapter or step was released after you created the corresponding shape in your integration flow. -> -> To use the latest version of a flow step or adapter – edit your integration flow, delete the flow step or adapter, add the step or adapter, and configure the same. Finally, redeploy the integration flow. See: [Updating your Existing Integration Flow](updating-your-existing-integration-flow-1f9e879.md). - -> ### Note: -> To be able to connect to queues or topics, you have to create queues and/or topics in the message broker. This needs to be done in the message broker with the configuration tools provided by the message broker. - -> ### Note: -> Queues, topics, and messages can only be monitored using tools provided by the message broker. Those monitors are not integrated into SAP Integration Suite. In SAP Integration Suite, the integration flows using the AMQP adapter are monitored and the messages send to or consumed from the message broker. - -> ### Note: -> This adapter exchanges data with a remote component that might be outside the scope of SAP. Make sure that the data exchange complies with your company’s policies. - - - -> ### Note: -> This adapter enables you to connect SAP Integration Suite to a remote message broker. SAP can’t give advice on how to configure the external system nor does SAP provide support related to this. - - - -Note the following when using the AMQP adapter to connect Cloud Integration to Apache ActiveMQ 5 and Apache ActiveMQ Artemis: - -- Exclusive queues aren't supported. - -- Message groups are supported. - -- Topic subscriptions are supported, which means: You can subscribe queues to topics. - - - - -To connect Cloud Integration to Apache ActiveMQ 5 and Apache ActiveMQ Artemis, make sure to specify the following parameters in the described way: - -When creating the channel \(see [Overview of Integration Flow Editor](overview-of-integration-flow-editor-db10beb.md)\), select adapter type *AMQP* \> *TCP*. - - - -The following values are displayed in the *General* tab after a channel has been established. To change the configurations, you need to configure a new channel. - -**General** - - - - - - - - - - - - - - - - - - - -
- -Parameter - - - -Description - -
- -*Name/Adapter Type* - - - -AMQP - -
- -*Transport Protocol* - - - -The protocol that the message broker supports: - -*TCP* - -
- -*Message Protocol* - - - -*AMQP 1.0* - -
- -Select the *Connection* tab and provide values in the fields as follows. - -**Connection** - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Parameter - - - -Description - -
- -*Host* - - - -Specify the hostname of the message broker. - -
- -*Port* - - - -Specify the port of the message broker. - -
- -*Proxy Type* - - - -The type of proxy that you’re using to connect to the target system. - -Select *Internet* if you’re connecting directly to the message broker. - -Select *On-Premise* if you’re connecting to an on-premise message broker. - -For more information, see [Using SAP Cloud Connector with Cloud Integration Adapters](../40-RemoteSystems/using-sap-cloud-connector-with-cloud-integration-adapters-65a60e7.md). - -
- -*Path* \(only if *WebSocket* is selected as the *Transport Protocol* in the *General* tab\) - - - -Specify the access path of the message broker. - -
- -*Connect with TLS* - - - -Select if *TLS* has to be used for the connection. - -
- -*Location ID* \(only if *On-Premise* is selected for *Proxy Type*\) - - - -To connect to an SAP Cloud Connector instance associated with your account, enter the location ID that you defined for this instance in the destination configuration on the cloud side. - -
- -*Authentication* - - - -Select the authentication method the message broker supports. Make sure that *SASL* is selected \(default setting\). - -
- -*Credential Name* \(only if *SASL* or *OAuth2 Client Credentials* is selected for *Authentication*\) - - - -Specify the name of the *User Credentials* artifact. - -
- -Select the *Processing* tab and provide values in the fields as follows. - -**Processing** - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Parameter - - - -Description - -
- -*Destination Type* - - - -Specify if messages should be sent to queues or topics in the message broker. - -You can select *Topic* or *Queue*. - -Both options are supported by Apache ActiveMQ 5 and Apache ActiveMQ Artemis. - -
- -*Destination Name* - - - -Enter the name of the queue or topic. - -This value can be defined dynamically by using the following expressions: `${header.queueabc}` or `${property.queueabc}`. - -
- -*Expiration Period \(in s\)* - - - -Specify the Time to Live \(TTL\) for the message. If nothing is specified, the setting for the queue or topic subscription in the message broker applies. - -
- -*Delivery* - - - -Specify whether the message broker has to make sure that the message is not lost, even in case of unexpected terminations. - -- *Persistent* - -- *Non-Persistent* - - - - -
- -*Message Type* - - - -Define the message type to be used for sending the message to the message broker. Choose between the following options: - -- *Automatic* \(recommended\): In this case, the adapter sets the message type based on the message format before the receiver channel. - -- *Binary*: In this case, the adapter converts the message into a binary message before sending. - -- *Text*: In this case, the adapter converts the message into a string before sending. - - -> ### Note: -> Select *Binary* or *Text* only if your application receiving the message requires a specific message type. -> -> Also, if you select *Binary* or *Text*, you can define the character encoding with the help of `CamelCharsetName` \(either header or property\) in the *Content Modifier*. In case you don't set the `CamelCharsetName` header or property, the transformation will use UTF-8 character encoding. See [Content Modifier Basics](content-modifier-basics-b0576a8.md) and [About Headers and Exchange Properties](about-headers-and-exchange-properties-0974c4f.md). - - - -
- -*Header Format Handling* - - - -There are two options for forwarding the message header name: - -- *Passtrough* \(default option\): - - Choose this option to pass the message header without transformation. For example, message-header.1 is forwarded as message-header.1. - -- *Replace*: - - Choose this option to replace dots and hyphens of a message header with \_HYPHEN\_ and \_DOT\_. For example, message-header.1 is forwarded as message\_HYPHEN\_header\_DOT\_1. - - - - -
- - - -For more information and an example scenario using this option, see the following SAP Community blog: [https://blogs.sap.com/2019/11/20/cloud-integration-connecting-to-external-messaging-systems-using-the-amqp-adapter/](https://blogs.sap.com/2019/11/20/cloud-integration-connecting-to-external-messaging-systems-using-the-amqp-adapter/). - diff --git a/docs/ISuite/50-Development/amqp-receiver-for-apache-qpid-broker-j-622aa1d.md b/docs/ISuite/50-Development/amqp-receiver-for-apache-qpid-broker-j-622aa1d.md deleted file mode 100644 index 230ea85b..00000000 --- a/docs/ISuite/50-Development/amqp-receiver-for-apache-qpid-broker-j-622aa1d.md +++ /dev/null @@ -1,369 +0,0 @@ - - -# AMQP Receiver for Apache Qpid Broker-J - -Enables SAP Integration Suite to send messages to queues or topics in Apache Qpid Broker-J. - - - -> ### Note: -> In the following cases certain features might not be available for your current integration flow: -> -> - You are using a runtime profile other than the one expected. See: [Runtime Profiles](IntegrationSettings/runtime-profiles-8007daa.md). -> -> - A feature for a particular adapter or step was released after you created the corresponding shape in your integration flow. -> -> To use the latest version of a flow step or adapter – edit your integration flow, delete the flow step or adapter, add the step or adapter, and configure the same. Finally, redeploy the integration flow. See: [Updating your Existing Integration Flow](updating-your-existing-integration-flow-1f9e879.md). - -> ### Note: -> To be able to connect to queues or topics, you have to create queues and/or topics in the message broker. This needs to be done in the message broker with the configuration tools provided by the message broker. - -> ### Note: -> Queues, topics, and messages can only be monitored using tools provided by the message broker. Those monitors are not integrated into SAP Integration Suite. In SAP Integration Suite, the integration flows using the AMQP adapter are monitored and the messages send to or consumed from the message broker. - -> ### Note: -> This adapter exchanges data with a remote component that might be outside the scope of SAP. Make sure that the data exchange complies with your company’s policies. - - - -> ### Note: -> This adapter enables you to connect SAP Integration Suite to a remote message broker. SAP can’t give advice on how to configure the external system nor does SAP provide support related to this. - - - -Note the following when using the AMQP adapter to connect Cloud Integration to Apache Qpid Broker-J: - -- Exclusive queues are supported. - -- Message groups are supported. - -- Topic subscriptions are supported, which means: You can subscribe queues to topics. - - - - -To connect Cloud Integration to Apache Qpid Broker-J, make sure to specify the following parameters in the described way: - -When creating the channel \(see [Overview of Integration Flow Editor](overview-of-integration-flow-editor-db10beb.md)\), select adapter type *AMQP* \> *TCP* or *AMQP* \> *WebSocket*. - - - -The following values are displayed in the *General* tab after a channel has been established. To change the configurations, you need to configure a new channel. - -**General** - - - - - - - - - - - - - - - - - - - -
- -Parameter - - - -Description - -
- -*Name/Adapter Type* - - - -AMQP - -
- -*Transport Protocol* - - - -The protocol that the message broker supports: - -- *TCP* - -- *WebSocket* - - - - -
- -*Message Protocol* - - - -*AMQP 1.0* - -
- -Select the *Connection* tab and provide values in the fields as follows. - -**Connection** - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Parameter - - - -Description - -
- -*Host* - - - -Specify the hostname of the message broker. - -
- -*Port* - - - -Specify the port of the message broker. - -
- -*Proxy Type* - - - -The type of proxy that you’re using to connect to the target system. - -Select *Internet* if you’re connecting directly to the message broker. - -Select *On-Premise* if you’re connecting to an on-premise message broker. - -For more information, see [Using SAP Cloud Connector with Cloud Integration Adapters](../40-RemoteSystems/using-sap-cloud-connector-with-cloud-integration-adapters-65a60e7.md). - -
- -*Path* \(only if *WebSocket* is selected as the *Transport Protocol* in the *General* tab\) - - - -Specify the access path of the message broker. - -
- -*Connect with TLS* - - - -Select if *TLS* has to be used for the connection. - -
- -*Location ID* \(only if *On-Premise* is selected for *Proxy Type*\) - - - -To connect to an SAP Cloud Connector instance associated with your account, enter the location ID that you defined for this instance in the destination configuration on the cloud side. - -
- -*Authentication* - - - -Select the authentication method the message broker supports. Make sure that *SASL* is selected \(default setting\). - -
- -*Credential Name* \(only if *SASL* or *OAuth2 Client Credentials* is selected for *Authentication*\) - - - -Specify the name of the *User Credentials* artifact. - -
- -Select the *Processing* tab and provide values in the fields as follows. - -**Processing** - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Parameter - - - -Description - -
- -*Destination Type* - - - -Specify if messages should be sent to queues or topics in the message broker. - -You can select *Topic* or *Queue*. - -Both options are supported by Apache Qpid Broker-J. - -
- -*Destination Name* - - - -Enter the name of the queue or topic. - -This value can be defined dynamically by using the following expressions: `${header.queueabc}` or `${property.queueabc}`. - -
- -*Expiration Period \(in s\)* - - - -Specify the Time to Live \(TTL\) for the message. If nothing is specified, the setting for the queue or topic subscription in the message broker applies. - -
- -*Delivery* - - - -Specify whether the message broker has to make sure that the message is not lost, even in case of unexpected terminations. - -- *Persistent* - -- *Non-Persistent* - - - - -
- -*Message Type* - - - -Define the message type to be used for sending the message to the message broker. Choose between the following options: - -- *Automatic* \(recommended\): In this case, the adapter sets the message type based on the message format before the receiver channel. - -- *Binary*: In this case, the adapter converts the message into a binary message before sending. - -- *Text*: In this case, the adapter converts the message into a string before sending. - - -> ### Note: -> Select *Binary* or *Text* only if your application receiving the message requires a specific message type. -> -> Also, if you select *Binary* or *Text*, you can define the character encoding with the help of `CamelCharsetName` \(either header or property\) in the *Content Modifier*. In case you don't set the `CamelCharsetName` header or property, the transformation will use UTF-8 character encoding. See [Content Modifier Basics](content-modifier-basics-b0576a8.md) and [About Headers and Exchange Properties](about-headers-and-exchange-properties-0974c4f.md). - - - -
- -*Header Format Handling* - - - -There are two options for forwarding the message header name: - -- *Passtrough* \(default option\): - - Choose this option to pass the message header without transformation. For example, message-header.1 is forwarded as message-header.1. - -- *Replace*: - - Choose this option to replace dots and hyphens of a message header with \_HYPHEN\_ and \_DOT\_. For example, message-header.1 is forwarded as message\_HYPHEN\_header\_DOT\_1. - - - - -
- - - -For more information and an example scenario using this option, see the following SAP Community blog: [https://blogs.sap.com/2019/11/20/cloud-integration-connecting-to-external-messaging-systems-using-the-amqp-adapter/](https://blogs.sap.com/2019/11/20/cloud-integration-connecting-to-external-messaging-systems-using-the-amqp-adapter/). - diff --git a/docs/ISuite/50-Development/amqp-receiver-for-ibm-mq-990fa99.md b/docs/ISuite/50-Development/amqp-receiver-for-ibm-mq-990fa99.md deleted file mode 100644 index c6fcee8f..00000000 --- a/docs/ISuite/50-Development/amqp-receiver-for-ibm-mq-990fa99.md +++ /dev/null @@ -1,374 +0,0 @@ - - -# AMQP Receiver for IBM MQ - -Enables SAP Integration Suite to send messages to queues or topics in IBM MQ. - -> ### Note: -> This adapter works only with IBM MQ version 9.2 and above. - - - -> ### Note: -> In the following cases certain features might not be available for your current integration flow: -> -> - You are using a runtime profile other than the one expected. See: [Runtime Profiles](IntegrationSettings/runtime-profiles-8007daa.md). -> -> - A feature for a particular adapter or step was released after you created the corresponding shape in your integration flow. -> -> To use the latest version of a flow step or adapter – edit your integration flow, delete the flow step or adapter, add the step or adapter, and configure the same. Finally, redeploy the integration flow. See: [Updating your Existing Integration Flow](updating-your-existing-integration-flow-1f9e879.md). - -> ### Note: -> To be able to connect to queues or topics, you have to create queues and/or topics in the message broker. This needs to be done in the message broker with the configuration tools provided by the message broker. - -> ### Note: -> Queues, topics, and messages can only be monitored using tools provided by the message broker. Those monitors are not integrated into SAP Integration Suite. In SAP Integration Suite, the integration flows using the AMQP adapter are monitored and the messages send to or consumed from the message broker. - -> ### Note: -> This adapter exchanges data with a remote component that might be outside the scope of SAP. Make sure that the data exchange complies with your company’s policies. - - - -> ### Note: -> This adapter enables you to connect SAP Integration Suite to a remote message broker. SAP can’t give advice on how to configure the external system nor does SAP provide support related to this. - - - -Note the following when using the AMQP adapter to connect Cloud Integration to IBM MQ: - -- Exclusive queues are supported as of version 9.2. - - > ### Note: - > Set parameter *Max. Number of Prefetched Messages* in AMQP sender channel to `0`. - > - > The Poll status in the deployed artifacts monitor show an error if multiple workers are running on your tenant. The reason is that one consumer is allowed for the exclusive queue. The second worker runs into an error when trying to connect. - -- Message groups aren't supported. - -- Topic subscriptions are supported, which means: You can subscribe queues to topics. - - - - -To connect Cloud Integration to IBM MQ, make sure to specify the following parameters in the described way: - -When creating the channel \(see [Overview of Integration Flow Editor](overview-of-integration-flow-editor-db10beb.md)\), select adapter type *AMQP* \> *TCP*. - - - -The following values are displayed in the *General* tab after a channel has been established. To change the configurations, you need to configure a new channel. - -**General** - - - - - - - - - - - - - - - - - - - -
- -Parameter - - - -Description - -
- -*Name/Adapter Type* - - - -AMQP - -
- -*Transport Protocol* - - - -The protocol that the message broker supports: - -*TCP* - -
- -*Message Protocol* - - - -*AMQP 1.0* - -
- -Select the *Connection* tab and provide values in the fields as follows. - -**Connection** - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Parameter - - - -Description - -
- -*Host* - - - -Specify the hostname of the message broker. - -
- -*Port* - - - -Specify the port as defined in the IBM MQ broker. - -
- -*Proxy Type* - - - -The type of proxy that you’re using to connect to the target system. - -Select *Internet* if you’re connecting directly to the message broker. - -Select *On-Premise* if you’re connecting to an on-premise message broker. - -For more information, see [Using SAP Cloud Connector with Cloud Integration Adapters](../40-RemoteSystems/using-sap-cloud-connector-with-cloud-integration-adapters-65a60e7.md). - -
- -*Path* \(only if *WebSocket* is selected as the *Transport Protocol* in the *General* tab\) - - - -Specify the access path of the message broker. - -
- -*Connect with TLS* - - - -Select if *TLS* has to be used for the connection. - -
- -*Location ID* \(only if *On-Premise* is selected for *Proxy Type*\) - - - -To connect to an SAP Cloud Connector instance associated with your account, enter the location ID that you defined for this instance in the destination configuration on the cloud side. - -
- -*Authentication* - - - -Select the authentication method the message broker supports. Make sure that *SASL* is selected \(default setting\). - -
- -*Credential Name* \(only if *SASL* or *OAuth2 Client Credentials* is selected for *Authentication*\) - - - -Specify the name of the *User Credentials* artifact. - -
- -Select the *Processing* tab and provide values in the fields as follows. - -**Processing** - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Parameter - - - -Description - -
- -*Destination Type* - - - -Specify if messages should be sent to queues or topics in the message broker. - -You can select *Topic* or *Queue* \(queues supported as of version 9.2\). - -Both options are supported by IBM MQ. - -
- -*Destination Name* - - - -Enter the name of the queue or topic. - -This value can be defined dynamically by using the following expressions: `${header.queueabc}` or `${property.queueabc}`. - -
- -*Expiration Period \(in s\)* - - - -Specify the Time to Live \(TTL\) for the message. If nothing is specified, the setting for the queue or topic subscription in the message broker applies. - -
- -*Delivery* - - - -Specify whether the message broker has to make sure that the message is not lost, even in case of unexpected terminations. - -- *Persistent* - -- *Non-Persistent* - - - - -
- -*Message Type* - - - -Define the message type to be used for sending the message to the message broker. Choose between the following options: - -- *Automatic* \(recommended\): In this case, the adapter sets the message type based on the message format before the receiver channel. - -- *Binary*: In this case, the adapter converts the message into a binary message before sending. - -- *Text*: In this case, the adapter converts the message into a string before sending. - - -> ### Note: -> Select *Binary* or *Text* only if your application receiving the message requires a specific message type. -> -> Also, if you select *Binary* or *Text*, you can define the character encoding with the help of `CamelCharsetName` \(either header or property\) in the *Content Modifier*. In case you don't set the `CamelCharsetName` header or property, the transformation will use UTF-8 character encoding. See [Content Modifier Basics](content-modifier-basics-b0576a8.md) and [About Headers and Exchange Properties](about-headers-and-exchange-properties-0974c4f.md). - - - -
- -*Header Format Handling* - - - -There are two options for forwarding the message header name: - -- *Passthrough* \(default option\): - - Choose this option to pass the message header without transformation. For example, message-header.1 is forwarded as message-header.1. - -- *Replace*: - - Choose this option to replace dots and hyphens of a message header with \_HYPHEN\_ and \_DOT\_. For example, message-header.1 is forwarded as message\_HYPHEN\_header\_DOT\_1. - - - - -
- - - -For more information and an example scenario using this option, see the following SAP Community blog: [https://blogs.sap.com/2019/11/20/cloud-integration-connecting-to-external-messaging-systems-using-the-amqp-adapter/](https://blogs.sap.com/2019/11/20/cloud-integration-connecting-to-external-messaging-systems-using-the-amqp-adapter/). - -This blog also provides more information on the supported versions of IBM MQ broker. - diff --git a/docs/ISuite/50-Development/amqp-receiver-for-microsoft-azure-service-bus-9c64d80.md b/docs/ISuite/50-Development/amqp-receiver-for-microsoft-azure-service-bus-9c64d80.md deleted file mode 100644 index b6a619a9..00000000 --- a/docs/ISuite/50-Development/amqp-receiver-for-microsoft-azure-service-bus-9c64d80.md +++ /dev/null @@ -1,354 +0,0 @@ - - -# AMQP Receiver for Microsoft Azure Service Bus - -Enables SAP Integration Suite to send messages to queues or topics in Microsoft Azure Service Bus. - - - -> ### Note: -> In the following cases certain features might not be available for your current integration flow: -> -> - You are using a runtime profile other than the one expected. See: [Runtime Profiles](IntegrationSettings/runtime-profiles-8007daa.md). -> -> - A feature for a particular adapter or step was released after you created the corresponding shape in your integration flow. -> -> To use the latest version of a flow step or adapter – edit your integration flow, delete the flow step or adapter, add the step or adapter, and configure the same. Finally, redeploy the integration flow. See: [Updating your Existing Integration Flow](updating-your-existing-integration-flow-1f9e879.md). - -> ### Note: -> To be able to connect to queues or topics, you have to create queues and/or topics in the message broker. This needs to be done in the message broker with the configuration tools provided by the message broker. - -> ### Note: -> Queues, topics, and messages can only be monitored using tools provided by the message broker. Those monitors are not integrated into SAP Integration Suite. In SAP Integration Suite, the integration flows using the AMQP adapter are monitored and the messages send to or consumed from the message broker. - -> ### Note: -> This adapter exchanges data with a remote component that might be outside the scope of SAP. Make sure that the data exchange complies with your company’s policies. - - - -> ### Note: -> This adapter enables you to connect SAP Integration Suite to a remote message broker. SAP can’t give advice on how to configure the external system nor does SAP provide support related to this. - - - -Note the following when using the AMQP adapter to connect Cloud Integration to Microsoft Azure Service Bus: - -- Exclusive queues are supported. - -- Message groups aren't supported. - -- Topic subscriptions are supported, which means: You can subscribe queues to topics. - - - - -To connect Cloud Integration to Microsoft Azure Service Bus, make sure to specify the following parameters in the described way: - -When creating the channel \(see [Overview of Integration Flow Editor](overview-of-integration-flow-editor-db10beb.md)\), select adapter type *AMQP* \> *TCP*. - - - -The following values are displayed in the *General* tab after a channel has been established. To change the configurations, you need to configure a new channel. - -**General** - - - - - - - - - - - - - - - - - - - -
- -Parameter - - - -Description - -
- -*Name/Adapter Type* - - - -AMQP - -
- -*Transport Protocol* - - - -The protocol that the message broker supports: - -*TCP* - -
- -*Message Protocol* - - - -*AMQP 1.0* - -
- -Select the *Connection* tab and provide values in the fields as follows. - -**Connection** - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Parameter - - - -Description - -
- -*Host* - - - -Specify the hostname of the message broker. - -
- -*Port* - - - -Specify the port of the message broker. - -Enter `5671`. - -
- -*Proxy Type* - - - -The type of proxy that you’re using to connect to the target system. - -Select *Internet* if you’re connecting directly to the message broker. - -Select *On-Premise* if you’re connecting to an on-premise message broker. - -For more information, see [Using SAP Cloud Connector with Cloud Integration Adapters](../40-RemoteSystems/using-sap-cloud-connector-with-cloud-integration-adapters-65a60e7.md). - -
- -*Connect with TLS* - - - -Select this option to ensure that *TLS* is used for the connection. - -
- -*Location ID* \(only if *On-Premise* is selected for *Proxy Type*\) - - - -To connect to an SAP Cloud Connector instance associated with your account, enter the location ID that you defined for this instance in the destination configuration on the cloud side. - -
- -*Authentication* - - - -Select the authentication method the message broker supports. Make sure that *SASL* is selected \(default setting\). - -
- -*Credential Name* \(only if *SASL* is selected for *Authentication*\) - - - -Specify the name of the *User Credentials* artifact. - -
- -Select the *Processing* tab and provide values in the fields as follows. - -**Processing** - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Parameter - - - -Description - -
- -*Destination Type* - - - -Specify if messages should be sent to queues or topics in the message broker. - -You can select *Topic* or *Queue*. - -Both options are supported by Microsoft Azure Service Bus. - -
- -*Destination Name* - - - -Enter the name of the queue or topic. - -This value can be defined dynamically by using the following expressions: `${header.queueabc}` or `${property.queueabc}`. - -
- -*Expiration Period \(in s\)* - - - -Specify the Time to Live \(TTL\) for the message. If nothing is specified, the setting for the queue or topic subscription in the message broker applies. - -
- -*Delivery* - - - -Specify whether the message broker has to make sure that the message is not lost, even in case of unexpected terminations. - -- *Persistent* - -- *Non-Persistent* - - - - -
- -*Message Type* - - - -Define the message type to be used for sending the message to the message broker. Choose between the following options: - -- *Automatic* \(recommended\): In this case, the adapter sets the message type based on the message format before the receiver channel. - -- *Binary*: In this case, the adapter converts the message into a binary message before sending. - -- *Text*: In this case, the adapter converts the message into a string before sending. - - -> ### Note: -> Select *Binary* or *Text* only if your application receiving the message requires a specific message type. -> -> Also, if you select *Binary* or *Text*, you can define the character encoding with the help of `CamelCharsetName` \(either header or property\) in the *Content Modifier*. In case you don't set the `CamelCharsetName` header or property, the transformation will use UTF-8 character encoding. See [Content Modifier Basics](content-modifier-basics-b0576a8.md) and [About Headers and Exchange Properties](about-headers-and-exchange-properties-0974c4f.md). - - - -
- -*Header Format Handling* - - - -There are two options for forwarding the message header name: - -- *Passtrough* \(default option\): - - Choose this option to pass the message header without transformation. For example, message-header.1 is forwarded as message-header.1. - -- *Replace*: - - Choose this option to replace dots and hyphens of a message header with \_HYPHEN\_ and \_DOT\_. For example, message-header.1 is forwarded as message\_HYPHEN\_header\_DOT\_1. - - - - -
- - - -For more information and an example scenario using this option, see the following SAP Community blog: [https://blogs.sap.com/2019/11/20/cloud-integration-connecting-to-external-messaging-systems-using-the-amqp-adapter/](https://blogs.sap.com/2019/11/20/cloud-integration-connecting-to-external-messaging-systems-using-the-amqp-adapter/). - diff --git a/docs/ISuite/50-Development/amqp-receiver-for-solace-pubsub-19f18d8.md b/docs/ISuite/50-Development/amqp-receiver-for-sap-integration-suite-advanced-event-mesh-5f229c0.md similarity index 83% rename from docs/ISuite/50-Development/amqp-receiver-for-solace-pubsub-19f18d8.md rename to docs/ISuite/50-Development/amqp-receiver-for-sap-integration-suite-advanced-event-mesh-5f229c0.md index a040ac0a..b5664ed4 100644 --- a/docs/ISuite/50-Development/amqp-receiver-for-solace-pubsub-19f18d8.md +++ b/docs/ISuite/50-Development/amqp-receiver-for-sap-integration-suite-advanced-event-mesh-5f229c0.md @@ -1,8 +1,8 @@ - + -# AMQP Receiver for Solace PubSub+ +# AMQP Receiver for SAP Integration Suite, advanced event mesh -Enables SAP Integration Suite to send messages to queues or topics in Solace PubSub+. +Enables SAP Integration Suite to send messages to queues or topics in SAP Integration Suite, advanced event mesh. @@ -26,21 +26,7 @@ Enables SAP Integration Suite to send messages to queues or topics in Solace Pub -> ### Note: -> This adapter enables you to connect SAP Integration Suite to a remote message broker. SAP can’t give advice on how to configure the external system nor does SAP provide support related to this. - - - -Note the following when using the AMQP adapter to connect Cloud Integration to Solace PubSub+: - -- Exclusive queues are supported. - -- Message groups aren't supported. - - - - -To connect Cloud Integration to Solace PubSub+, make sure to specify the following parameters in the described way: +To connect Cloud Integration to SAP Event Mesh, make sure to specify the following parameters in the described way. When creating the channel \(see [Overview of Integration Flow Editor](overview-of-integration-flow-editor-db10beb.md)\), select adapter type *AMQP* \> *TCP*. @@ -167,7 +153,7 @@ For more information, see [Using SAP Cloud Connector with Cloud Integration Adap -*Path* \(only if *WebSocket* is selected as the *Transport Protocol* in the *General* tab\) +*Path* @@ -184,7 +170,7 @@ Specify the access path of the message broker. -Select if *TLS* has to be used for the connection. +Select this option to ensure that *TLS* is used for the connection. @@ -208,7 +194,9 @@ To connect to an SAP Cloud Connector instance associated with your account, ente -Select the authentication method the message broker supports. Make sure that *SASL* is selected \(default setting\). +Select the authentication method the message broker supports. + +Select *SASL*. @@ -256,8 +244,6 @@ Specify if messages should be sent to queues or topics in the message broker. You can select *Topic* or *Queue*. -Both options are supported by Solace PubSub+. - @@ -356,7 +342,3 @@ There are two options for forwarding the message header name: - - -For more information and an example scenario using this option, see the following SAP Community blog: Topic subscriptions are supported, which means: You can subscribe queues to topics.[https://blogs.sap.com/2019/11/20/cloud-integration-connecting-to-external-messaging-systems-using-the-amqp-adapter/](https://blogs.sap.com/2019/11/20/cloud-integration-connecting-to-external-messaging-systems-using-the-amqp-adapter/). - diff --git a/docs/ISuite/50-Development/amqp-sender-for-apache-activemq-5-and-apache-activemq-artemis-dc4c564.md b/docs/ISuite/50-Development/amqp-sender-for-apache-activemq-5-and-apache-activemq-artemis-dc4c564.md deleted file mode 100644 index 93e2c7db..00000000 --- a/docs/ISuite/50-Development/amqp-sender-for-apache-activemq-5-and-apache-activemq-artemis-dc4c564.md +++ /dev/null @@ -1,376 +0,0 @@ - - -# AMQP Sender for Apache ActiveMQ 5 and Apache ActiveMQ Artemis - -Enables SAP Integration Suite to consume messages from queues in Apache ActiveMQ 5 / Apache ActiveMQ Artemis. - - - -> ### Note: -> In the following cases certain features might not be available for your current integration flow: -> -> - You are using a runtime profile other than the one expected. See: [Runtime Profiles](IntegrationSettings/runtime-profiles-8007daa.md). -> -> - A feature for a particular adapter or step was released after you created the corresponding shape in your integration flow. -> -> To use the latest version of a flow step or adapter – edit your integration flow, delete the flow step or adapter, add the step or adapter, and configure the same. Finally, redeploy the integration flow. See: [Updating your Existing Integration Flow](updating-your-existing-integration-flow-1f9e879.md). - -> ### Note: -> Queues, topics, and messages can only be monitored by using tools provided by the message broker provider. Those monitors are not integrated into SAP Integration Suite. In SAP Integration Suite, the integration flows using the AMQP adapter are monitored and the messages are sent to or consumed from the message broker. - -> ### Note: -> To be able to connect to queues, you have to create queues and/or topics in the message broker. This needs to be done in the message broker, with the configuration tools provided by the message broker. In some messaging systems, you need to configure a *Lock Duration* to make sure that the message is not consumed more than once. This timeout must be longer than the expected processing time of the message, otherwise this would lead to duplicate messages. - -> ### Note: -> This adapter exchanges data with a remote component that might be outside the scope of SAP. Make sure that the data exchange complies with your company’s policies. - - - -> ### Note: -> This adapter enables you to connect SAP Integration Suite to a remote message broker. SAP can’t give advice on how to configure the external system nor does SAP provide support related to this. - - - -To connect Cloud Integration to Apache ActiveMQ 5 and Apache ActiveMQ Artemis, make sure to specify the following parameters in the described way: - -When creating the channel \(see [Overview of Integration Flow Editor](overview-of-integration-flow-editor-db10beb.md)\), select adapter type *AMQP* \> *TCP*. - - - -The following values are displayed in the *General* tab after a channel has been established. If you want to change the configurations, you need to configure a new channel. - -**General** - - - - - - - - - - - - - - - - - - - -
- -Parameter - - - -Description - -
- -*Name/Adapter Type* - - - -AMQP - -
- -*Transport Protocol* - - - -The protocol that the message broker supports: - -*TCP* - -
- -*Message Protocol* - - - -*AMQP 1.0* - -
- -Select the *Connection* tab and provide values in the fields as follows: - -**Connection** - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Parameter - - - -Description - -
- -*Host* - - - -Specify the hostname of the message broker. - -
- -*Port* - - - -Specify the port of the message broker. - -
- -*Proxy Type* - - - -The type of proxy that you’re using to connect to the target system. - -Select *Internet* if you’re connecting directly to the message broker. - -Select *On-Premise* if you’re connecting to an on-premise message broker. - -For more information, see [Using SAP Cloud Connector with Cloud Integration Adapters](../40-RemoteSystems/using-sap-cloud-connector-with-cloud-integration-adapters-65a60e7.md). - -
- -*Path* \(only if *WebSocket* is selected as the *Transport Protocol* in the *General* tab\) - - - -Specify the access path of the message broker. - -
- -*Connect with TLS* - - - -Select if *TLS* has to be used for the connection. - -
- -*Location ID* \(only if *On-Premise* is selected for *Proxy Type*\) - - - -To connect to an SAP Cloud Connector instance associated with your account, enter the location ID that you defined for this instance in the destination configuration on the cloud side. - -
- -*Authentication* - - - -Select the authentication method supported by the message broker. Make sure that *SASL* is selected \(default setting\). - -
- -*Credential Name* \(only if *SASL* or *OAuth2 Client Credentials* are selected for *Authentication*\) - - - -Specify the name of the *User Credentials* artifact. - -
- -Select the *Processing* tab and provide values in the fields as follows. - -**Processing** - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Parameter - - - -Description - -
- -*Queue Name* - - - -Specify the name of the queue or topic subscription to consume from. - -> ### Note: -> Topics are not supported in the sender adapter, only queues and topic subscriptions. -> -> Technically, the AMQP sender adapter allows you to consume from queues only. The adapter doesn’t allow you to directly subscribe to a topic. If you like to work with topic subscriptions, subscribe a queue to a topic and consume from this queue. - - - -
- -*Number of Current Processes* - - - -Specify the number of processes used for parallel message processing. Note, that these processes are started from each worker node. - -> ### Note: -> The maximum number of parallel processes cannot exceed 99. The default is set to 1. - - - -
- -*Max. Number of Prefechted Messages* - - - -Enter the max. number of messages that may be prefechted by one worker. The allowed value range is 1 to 100. - -The prefetch value is the number of messages that the sender adapter fetches in advance from the broker, and then gradually processes. The prefetch reduces the communication overhead and ensures that when a message has been processed, another is already there and is ready for processing. - -If the integration flows that are triggered by the AMQP sender adapter run for longer than a few seconds, it makes sense to set a lower prefetch value. In particular, if the integration flow runs for more than a minute, you should consider setting the value to 1. You can expect then a performance deterioration in the two-digit millisecond range, per message. On the other hand, load balancing between several nodes works better even with short backlogs. - -If you need to process a large number of messages with the integration flow, and the processing of the individual message only runs for a few milliseconds, it can be useful to increase the prefetch value. - -> ### Note: -> If you increase the value, this can lead to lock timeouts and the load balancing between the nodes deteriorates. In return, you can expect performance gains in the three-digit microsecond range, per message. For example, with a prefetch value of 100, 10000 messages process approximately a second or two faster. - - - -
- -*Consume Expired Messages* - - - -Select if the adapter is to consume already expired messages. - -By default, this option is deactivated. - -
- -*Max. Number of Retries* - - - -Define the number of retries to be executed before a different delivery status is sent to the message broker. - -> ### Note: -> With the default setting \(`0`\), any message that is marked as a retried message is directly returning the outcome configured in *Delivery Status After Max. Retries* to the message broker and does not even start processing the message. Be aware of the fact that any delivery attempt by the message broker, even a failed one \(for example, due to network issues\), increases the delivery counter of the message sent by the message broker. -> -> If the value is set to a number bigger than `0`, the AMQP adapter returns the outcome configured in *Delivery Status After Max. Retries* to the message broker if the delivery count of the message exceeds the configured value. Otherwise, it processes the message and returns a released outcome in case of an error and an accepted outcome in case of a successful message processing. -> -> The consequences of the provided outcome depend on the message broker and the queue configuration on the message broker. An accepted outcome usually removes the message from the queue. A released outcome usually triggers a redelivery. A rejected outcome may trigger a redelivery or move the message to a dead letter queue \(maybe only if the message was rejected for a configured number of times\). The same applies to a modified outcome with the undeliverable flag set, which also might transit the message on the message broker to some undeliverable state. -> -> If the message broker is not configured properly, this behavior can lead to unwanted side effects. For example, the messaging system constantly re-sends the message, no other messages are being processed, and no additional message processing logs are written. As consequence, this can result in an unplanned high load of your tenant and message broker. - - - -
- -*Delivery Status After Max. Retries* - - - -Define one delivery status that is to be sent to the message broker after the maximum number of retries. The following options are supported: - -- *REJECTED*. - -- *MODIFIED\_FAILED\_UNDELIVERABLE* - - -> ### Note: -> See this [general information on AMQP](http://docs.oasis-open.org/amqp/core/v1.0/amqp-core-complete-v1.0.pdf) on delivery statuses and their meaning. -> -> See this [blog](https://blogs.sap.com/2019/11/20/cloud-integration-connecting-to-external-messaging-systems-using-the-amqp-adapter/) for a summary of the capabilities supported by the different brokers. - - - -
- - - - - -## Further Constraints - -Note the following when using the AMQP adapter to connect Cloud Integration to Apache ActiveMQ 5 and Apache ActiveMQ Artemis: - -- You can configure retry by setting the header `JMSRedelivered`. - -- You can also use header `JMSXDeliveryCount`. - - -See: [Headers and Exchange Properties Provided by the Integration Framework](headers-and-exchange-properties-provided-by-the-integration-framework-d0fcb09.md) - -For more information and an example scenario using this option, see the following SAP Community blog: [https://blogs.sap.com/2019/11/20/cloud-integration-connecting-to-external-messaging-systems-using-the-amqp-adapter/](https://blogs.sap.com/2019/11/20/cloud-integration-connecting-to-external-messaging-systems-using-the-amqp-adapter/). - diff --git a/docs/ISuite/50-Development/amqp-sender-for-apache-qpid-broker-j-b4983f7.md b/docs/ISuite/50-Development/amqp-sender-for-apache-qpid-broker-j-b4983f7.md deleted file mode 100644 index 3a01bc1c..00000000 --- a/docs/ISuite/50-Development/amqp-sender-for-apache-qpid-broker-j-b4983f7.md +++ /dev/null @@ -1,381 +0,0 @@ - - -# AMQP Sender for Apache Qpid Broker-J - -Enables SAP Integration Suite to consume messages from queues in Apache Qpid Broker-J. - - - -> ### Note: -> In the following cases certain features might not be available for your current integration flow: -> -> - You are using a runtime profile other than the one expected. See: [Runtime Profiles](IntegrationSettings/runtime-profiles-8007daa.md). -> -> - A feature for a particular adapter or step was released after you created the corresponding shape in your integration flow. -> -> To use the latest version of a flow step or adapter – edit your integration flow, delete the flow step or adapter, add the step or adapter, and configure the same. Finally, redeploy the integration flow. See: [Updating your Existing Integration Flow](updating-your-existing-integration-flow-1f9e879.md). - -> ### Note: -> Queues, topics, and messages can only be monitored by using tools provided by the message broker provider. Those monitors are not integrated into SAP Integration Suite. In SAP Integration Suite, the integration flows using the AMQP adapter are monitored and the messages are sent to or consumed from the message broker. - -> ### Note: -> To be able to connect to queues, you have to create queues and/or topics in the message broker. This needs to be done in the message broker, with the configuration tools provided by the message broker. In some messaging systems, you need to configure a *Lock Duration* to make sure that the message is not consumed more than once. This timeout must be longer than the expected processing time of the message, otherwise this would lead to duplicate messages. - -> ### Note: -> This adapter exchanges data with a remote component that might be outside the scope of SAP. Make sure that the data exchange complies with your company’s policies. - - - -> ### Note: -> This adapter enables you to connect SAP Integration Suite to a remote message broker. SAP can’t give advice on how to configure the external system nor does SAP provide support related to this. - - - -To connect Cloud Integration to Apache Qpid Broker-J, make sure to specify the following parameters in the described way: - -When creating the channel \(see [Overview of Integration Flow Editor](overview-of-integration-flow-editor-db10beb.md)\), select adapter type *AMQP* \> *TCP* or *AMQP* \> *WebSocket*. - - - -The following values are displayed in the *General* tab after a channel has been established. If you want to change the configurations, you need to configure a new channel. - -**General** - - - - - - - - - - - - - - - - - - - -
- -Parameter - - - -Description - -
- -*Name/Adapter Type* - - - -AMQP - -
- -*Transport Protocol* - - - -The protocol that the message broker supports: - -- *TCP* - -- *WebSocket* - - - - -
- -*Message Protocol* - - - -*AMQP 1.0* - -
- -Select the *Connection* tab and provide values in the fields as follows: - -**Connection** - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Parameter - - - -Description - -
- -*Host* - - - -Specify the hostname of the message broker. - -
- -*Port* - - - -Specify the port of the message broker. - -
- -*Proxy Type* - - - -The type of proxy that you’re using to connect to the target system. - -Select *Internet* if you’re connecting directly to the message broker. - -Select *On-Premise* if you’re connecting to an on-premise message broker. - -For more information, see [Using SAP Cloud Connector with Cloud Integration Adapters](../40-RemoteSystems/using-sap-cloud-connector-with-cloud-integration-adapters-65a60e7.md). - -
- -*Path* \(only if *WebSocket* is selected as the *Transport Protocol* in the *General* tab\) - - - -Specify the access path of the message broker. - -
- -*Connect with TLS* - - - -Select if *TLS* has to be used for the connection. - -
- -*Location ID* \(only if *On-Premise* is selected for *Proxy Type*\) - - - -To connect to an SAP Cloud Connector instance associated with your account, enter the location ID that you defined for this instance in the destination configuration on the cloud side. - -
- -*Authentication* - - - -Select the authentication method supported by the message broker. Make sure that *SASL* is selected \(default setting\). - -
- -*Credential Name* \(only if *SASL* or *OAuth2 Client Credentials* are selected for *Authentication*\) - - - -Specify the name of the *User Credentials* artifact. - -
- -Select the *Processing* tab and provide values in the fields as follows. - -**Processing** - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Parameter - - - -Description - -
- -*Queue Name* - - - -Specify the name of the queue or topic subscription to consume from. - -> ### Note: -> Topics are not supported in the sender adapter, only queues and topic subscriptions. -> -> Technically, the AMQP sender adapter allows you to consume from queues only. The adapter doesn’t allow you to directly subscribe to a topic. If you like to work with topic subscriptions, subscribe a queue to a topic and consume from this queue. - - - -
- -*Number of Current Processes* - - - -Specify the number of processes used for parallel message processing. Note, that these processes are started from each worker node. - -> ### Note: -> The maximum number of parallel processes cannot exceed 99. The default is set to 1. - - - -
- -*Max. Number of Prefechted Messages* - - - -Enter the max. number of messages that may be prefechted by one worker. The allowed value range is 1 to 100. - -The prefetch value is the number of messages that the sender adapter fetches in advance from the broker, and then gradually processes. The prefetch reduces the communication overhead and ensures that when a message has been processed, another is already there and is ready for processing. - -If the integration flows that are triggered by the AMQP sender adapter run for longer than a few seconds, it makes sense to set a lower prefetch value. In particular, if the integration flow runs for more than a minute, you should consider setting the value to 1. You can expect then a performance deterioration in the two-digit millisecond range, per message. On the other hand, load balancing between several nodes works better even with short backlogs. - -If you need to process a large number of messages with the integration flow, and the processing of the individual message only runs for a few milliseconds, it can be useful to increase the prefetch value. - -> ### Note: -> If you increase the value, this can lead to lock timeouts and the load balancing between the nodes deteriorates. In return, you can expect performance gains in the three-digit microsecond range, per message. For example, with a prefetch value of 100, 10000 messages process approximately a second or two faster. - - - -
- -*Consume Expired Messages* - - - -Select if the adapter is to consume already expired messages. - -By default, this option is deactivated. - -
- -*Max. Number of Retries* - - - -Define the number of retries to be executed before a different delivery status is sent to the message broker. - -> ### Note: -> With the default setting \(`0`\), any message that is marked as a retried message is directly returning the outcome configured in *Delivery Status After Max. Retries* to the message broker and does not even start processing the message. Be aware of the fact that any delivery attempt by the message broker, even a failed one \(for example, due to network issues\), increases the delivery counter of the message sent by the message broker. -> -> If the value is set to a number bigger than `0`, the AMQP adapter returns the outcome configured in *Delivery Status After Max. Retries* to the message broker if the delivery count of the message exceeds the configured value. Otherwise, it processes the message and returns a released outcome in case of an error and an accepted outcome in case of a successful message processing. -> -> The consequences of the provided outcome depend on the message broker and the queue configuration on the message broker. An accepted outcome usually removes the message from the queue. A released outcome usually triggers a redelivery. A rejected outcome may trigger a redelivery or move the message to a dead letter queue \(maybe only if the message was rejected for a configured number of times\). The same applies to a modified outcome with the undeliverable flag set, which also might transit the message on the message broker to some undeliverable state. -> -> If the message broker is not configured properly, this behavior can lead to unwanted side effects. For example, the messaging system constantly re-sends the message, no other messages are being processed, and no additional message processing logs are written. As consequence, this can result in an unplanned high load of your tenant and message broker. - - - -
- -*Delivery Status After Max. Retries* - - - -Define one delivery status that is to be sent to the message broker after the maximum number of retries. Both options are supported: - -- *REJECTED*. - -- *MODIFIED\_FAILED\_UNDELIVERABLE* - - -> ### Note: -> See this [general information on AMQP](http://docs.oasis-open.org/amqp/core/v1.0/amqp-core-complete-v1.0.pdf) on delivery statuses and their meaning. -> -> See this [blog](https://blogs.sap.com/2019/11/20/cloud-integration-connecting-to-external-messaging-systems-using-the-amqp-adapter/) for a summary of the capabilities supported by the different brokers. - - - -
- - - - - -## Retry Configuration - -Note the following when using the AMQP adapter to connect Cloud Integration to Apache Qpid Broker-J: - -- You can configure retry by setting the header `JMSRedelivered`. - -- You can also use header `JMSXDeliveryCount`. - - -See: [Headers and Exchange Properties Provided by the Integration Framework](headers-and-exchange-properties-provided-by-the-integration-framework-d0fcb09.md) - -For more information and an example scenario using this option, see the following SAP Community blog: [https://blogs.sap.com/2019/11/20/cloud-integration-connecting-to-external-messaging-systems-using-the-amqp-adapter/](https://blogs.sap.com/2019/11/20/cloud-integration-connecting-to-external-messaging-systems-using-the-amqp-adapter/). - diff --git a/docs/ISuite/50-Development/amqp-sender-for-microsoft-azure-service-bus-7384ac3.md b/docs/ISuite/50-Development/amqp-sender-for-microsoft-azure-service-bus-7384ac3.md deleted file mode 100644 index 9bfdaa9b..00000000 --- a/docs/ISuite/50-Development/amqp-sender-for-microsoft-azure-service-bus-7384ac3.md +++ /dev/null @@ -1,368 +0,0 @@ - - -# AMQP Sender for Microsoft Azure Service Bus - -Enables SAP Integration Suite to consume messages from queues in Microsoft Azure Service Bus. - - - -> ### Note: -> In the following cases certain features might not be available for your current integration flow: -> -> - You are using a runtime profile other than the one expected. See: [Runtime Profiles](IntegrationSettings/runtime-profiles-8007daa.md). -> -> - A feature for a particular adapter or step was released after you created the corresponding shape in your integration flow. -> -> To use the latest version of a flow step or adapter – edit your integration flow, delete the flow step or adapter, add the step or adapter, and configure the same. Finally, redeploy the integration flow. See: [Updating your Existing Integration Flow](updating-your-existing-integration-flow-1f9e879.md). - -> ### Note: -> Queues, topics, and messages can only be monitored by using tools provided by the message broker provider. Those monitors are not integrated into SAP Integration Suite. In SAP Integration Suite, the integration flows using the AMQP adapter are monitored and the messages are sent to or consumed from the message broker. - -> ### Note: -> To be able to connect to queues, you have to create queues and/or topics in the message broker. This needs to be done in the message broker, with the configuration tools provided by the message broker. In some messaging systems, you need to configure a *Lock Duration* to make sure that the message is not consumed more than once. This timeout must be longer than the expected processing time of the message, otherwise this would lead to duplicate messages. - -> ### Note: -> This adapter exchanges data with a remote component that might be outside the scope of SAP. Make sure that the data exchange complies with your company’s policies. - - - -> ### Note: -> This adapter enables you to connect SAP Integration Suite to a remote message broker. SAP can’t give advice on how to configure the external system nor does SAP provide support related to this. - - - -To connect Cloud Integration to Microsoft Azure Service Bus, make sure to specify the following parameters in the described way: - -When creating the channel \(see [Overview of Integration Flow Editor](overview-of-integration-flow-editor-db10beb.md)\), select adapter type *AMQP* \> *TCP*. - - - -The following values are displayed in the *General* tab after a channel has been established. If you want to change the configurations, you need to configure a new channel. - -**General** - - - - - - - - - - - - - - - - - - - -
- -Parameter - - - -Description - -
- -*Name/Adapter Type* - - - -AMQP - -
- -*Transport Protocol* - - - -The protocol that the message broker supports: - -*TCP* - -
- -*Message Protocol* - - - -*AMQP 1.0* - -
- -Select the *Connection* tab and provide values in the fields as follows: - -**Connection** - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Parameter - - - -Description - -
- -*Host* - - - -Specify the hostname of the message broker. - -
- -*Port* - - - -Specify the port of the message broker. - -Enter `5671`. - -
- -*Proxy Type* - - - -The type of proxy that you’re using to connect to the target system. - -Select *Internet* if you’re connecting directly to the message broker. - -Select *On-Premise* if you’re connecting to an on-premise message broker. - -For more information, see [Using SAP Cloud Connector with Cloud Integration Adapters](../40-RemoteSystems/using-sap-cloud-connector-with-cloud-integration-adapters-65a60e7.md). - -
- -*Connect with TLS* - - - -Select this option. - -
- -*Location ID* \(only if *On-Premise* is selected for *Proxy Type*\) - - - -To connect to an SAP Cloud Connector instance associated with your account, enter the location ID that you defined for this instance in the destination configuration on the cloud side. - -
- -*Authentication* - - - -Select the authentication method supported by the message broker. Make sure that *SASL* is selected \(default setting\). - -
- -*Credential Name* \(only if *SASL* is selected for *Authentication*\) - - - -Specify the name of the *User Credentials* artifact. - -
- -Select the *Processing* tab and provide values in the fields as follows. - -**Processing** - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Parameter - - - -Description - -
- -*Queue Name* - - - -Specify the name of the queue or topic subscription to consume from. - -> ### Note: -> You can access topic subscriptions as separate entities with the following syntax: -> -> `[topic name]/subscriptions/[subscription name]` -> -> Multiple subscriptions for a single topic can exist. - - - -
- -*Number of Current Processes* - - - -Specify the number of processes used for parallel message processing. Note, that these processes are started from each worker node. - -> ### Note: -> The maximum number of parallel processes cannot exceed 99. The default is set to 1. - - - -
- -*Max. Number of Prefechted Messages* - - - -Enter the max. number of messages that may be prefechted by one worker. The allowed value range is 1 to 100. - -The prefetch value is the number of messages that the sender adapter fetches in advance from the broker, and then gradually processes. The prefetch reduces the communication overhead and ensures that when a message has been processed, another is already there and is ready for processing. - -If the integration flows that are triggered by the AMQP sender adapter run for longer than a few seconds, it makes sense to set a lower prefetch value. In particular, if the integration flow runs for more than a minute, you should consider setting the value to 1. You can expect then a performance deterioration in the two-digit millisecond range, per message. On the other hand, load balancing between several nodes works better even with short backlogs. - -If you need to process a large number of messages with the integration flow, and the processing of the individual message only runs for a few milliseconds, it can be useful to increase the prefetch value. - -> ### Note: -> If you increase the value, this can lead to lock timeouts and the load balancing between the nodes deteriorates. In return, you can expect performance gains in the three-digit microsecond range, per message. For example, with a prefetch value of 100, 10000 messages process approximately a second or two faster. - - - -
- -*Consume Expired Messages* - - - -Select if the adapter is to consume already expired messages. - -By default, this option is deactivated. - -
- -*Max. Number of Retries* - - - -Define the number of retries to be executed before a different delivery status is sent to the message broker. - -> ### Note: -> With the default setting \(`0`\), any message that is marked as a retried message is directly returning the outcome configured in *Delivery Status After Max. Retries* to the message broker and does not even start processing the message. Be aware of the fact that any delivery attempt by the message broker, even a failed one \(for example, due to network issues\), increases the delivery counter of the message sent by the message broker. -> -> If the value is set to a number bigger than `0`, the AMQP adapter returns the outcome configured in *Delivery Status After Max. Retries* to the message broker if the delivery count of the message exceeds the configured value. Otherwise, it processes the message and returns a released outcome in case of an error and an accepted outcome in case of a successful message processing. -> -> The consequences of the provided outcome depend on the message broker and the queue configuration on the message broker. An accepted outcome usually removes the message from the queue. A released outcome usually triggers a redelivery. A rejected outcome may trigger a redelivery or move the message to a dead letter queue \(maybe only if the message was rejected for a configured number of times\). The same applies to a modified outcome with the undeliverable flag set, which also might transit the message on the message broker to some undeliverable state. -> -> If the message broker is not configured properly, this behavior can lead to unwanted side effects. For example, the messaging system constantly re-sends the message, no other messages are being processed, and no additional message processing logs are written. As consequence, this can result in an unplanned high load of your tenant and message broker. - - - -
- -*Delivery Status After Max. Retries* - - - -Define one delivery status that is to be sent to the message broker after the maximum number of retries. Both options are supported: - -- *REJECTED*. - -- *MODIFIED\_FAILED\_UNDELIVERABLE* - - -> ### Note: -> See this [general information on AMQP](http://docs.oasis-open.org/amqp/core/v1.0/amqp-core-complete-v1.0.pdf) on delivery statuses and their meaning. -> -> See this [blog](https://blogs.sap.com/2019/11/20/cloud-integration-connecting-to-external-messaging-systems-using-the-amqp-adapter/) for a summary of the capabilities supported by the different brokers. - - - -
- - - - - -## Further Constraints - -Note the following when using the AMQP adapter to connect Cloud Integration to Microsoft Azure Service Bus: - -- You can configure retry by setting the header `JMSRedelivered`. - -- You can also use header `JMSXDeliveryCount`. - - -See: [Headers and Exchange Properties Provided by the Integration Framework](headers-and-exchange-properties-provided-by-the-integration-framework-d0fcb09.md) - -For more information and an example scenario using this option, see the following SAP Community blog: [https://blogs.sap.com/2019/11/20/cloud-integration-connecting-to-external-messaging-systems-using-the-amqp-adapter/](https://blogs.sap.com/2019/11/20/cloud-integration-connecting-to-external-messaging-systems-using-the-amqp-adapter/). - diff --git a/docs/ISuite/50-Development/amqp-sender-for-sap-event-mesh-7d8a83f.md b/docs/ISuite/50-Development/amqp-sender-for-sap-event-mesh-7d8a83f.md index 8d8f27fd..afe8400a 100644 --- a/docs/ISuite/50-Development/amqp-sender-for-sap-event-mesh-7d8a83f.md +++ b/docs/ISuite/50-Development/amqp-sender-for-sap-event-mesh-7d8a83f.md @@ -16,7 +16,7 @@ Enables SAP Integration Suite to consume messages from queues in SAP Event Mesh. > To use the latest version of a flow step or adapter – edit your integration flow, delete the flow step or adapter, add the step or adapter, and configure the same. Finally, redeploy the integration flow. See: [Updating your Existing Integration Flow](updating-your-existing-integration-flow-1f9e879.md). > ### Note: -> Queues, topics, and messages can only be monitored by using tools provided by the message broker provider. Those monitors are not integrated into SAP Integration Suite. In SAP Integration Suite, the integration flows using the AMQP adapter are monitored and the messages are sent to or consumed from the message broker. +> Queues, topics, and messages can only be monitored by using tools provided by the message broker provider. Those monitors are not integrated into SAP Integration Suite . Using SAP Integration Suite , you can only monitor the integration flows using the AMQP adapter and the messages that are sent to or consumed from the message broker. > ### Note: > To be able to connect to queues, you have to create queues and/or topics in the message broker. This needs to be done in the message broker, with the configuration tools provided by the message broker. In some messaging systems, you need to configure a *Lock Duration* to make sure that the message is not consumed more than once. This timeout must be longer than the expected processing time of the message, otherwise this would lead to duplicate messages. @@ -323,7 +323,7 @@ By default, this option is deactivated. Define the number of retries to be executed before a different delivery status is sent to the message broker. > ### Note: -> With the default setting \(`0`\), any message that is marked as a retried message is directly returning the outcome configured in *Delivery Status After Max. Retries* to the message broker and does not even start processing the message. Be aware of the fact that any delivery attempt by the message broker, even a failed one \(for example, due to network issues\), increases the delivery counter of the message sent by the message broker. +> If this parameter is set to \(`0`\), any message that is marked as a retried message is directly returning the outcome configured in *Delivery Status After Max. Retries* to the message broker and does not even start processing the message. Be aware of the fact that any delivery attempt by the message broker, even a failed one \(for example, due to network issues\), increases the delivery counter of the message sent by the message broker. > > If the value is set to a number bigger than `0`, the AMQP adapter returns the outcome configured in *Delivery Status After Max. Retries* to the message broker if the delivery count of the message exceeds the configured value. Otherwise, it processes the message and returns a released outcome in case of an error and an accepted outcome in case of a successful message processing. > @@ -354,7 +354,9 @@ Don't select *MODIFIED\_FAILED\_UNDELIVERABLE*. > ### Note: > See this [general information on AMQP](http://docs.oasis-open.org/amqp/core/v1.0/amqp-core-complete-v1.0.pdf) on delivery statuses and their meaning. > -> See this [blog](https://blogs.sap.com/2019/11/20/cloud-integration-connecting-to-external-messaging-systems-using-the-amqp-adapter/) for a summary of the capabilities supported by the different brokers. +> You can use the following headers to configure a delay in retry processing: `JMSRedelivered` and `JMSXDeliveryCount`. For more information, see the SAP Community blog [Cloud Integration – Connecting to Messaging Systems using the AMQP Adapter](https://community.sap.com/t5/technology-blogs-by-sap/cloud-integration-connecting-to-messaging-systems-using-the-amqp-adapter/ba-p/13419906). +> +> This blog also contains an overview of the recommended settings for different message brokers. diff --git a/docs/ISuite/50-Development/amqp-sender-for-solace-pubsub-c9ab47d.md b/docs/ISuite/50-Development/amqp-sender-for-solace-pubsub-c9ab47d.md deleted file mode 100644 index 52a5b173..00000000 --- a/docs/ISuite/50-Development/amqp-sender-for-solace-pubsub-c9ab47d.md +++ /dev/null @@ -1,363 +0,0 @@ - - -# AMQP Sender for Solace PubSub+ - -Enables SAP Integration Suite to consume messages from queues in Solace PubSub+. - - - -> ### Note: -> In the following cases certain features might not be available for your current integration flow: -> -> - You are using a runtime profile other than the one expected. See: [Runtime Profiles](IntegrationSettings/runtime-profiles-8007daa.md). -> -> - A feature for a particular adapter or step was released after you created the corresponding shape in your integration flow. -> -> To use the latest version of a flow step or adapter – edit your integration flow, delete the flow step or adapter, add the step or adapter, and configure the same. Finally, redeploy the integration flow. See: [Updating your Existing Integration Flow](updating-your-existing-integration-flow-1f9e879.md). - -> ### Note: -> Queues, topics, and messages can only be monitored by using tools provided by the message broker provider. Those monitors are not integrated into SAP Integration Suite. In SAP Integration Suite, the integration flows using the AMQP adapter are monitored and the messages are sent to or consumed from the message broker. - -> ### Note: -> To be able to connect to queues, you have to create queues and/or topics in the message broker. This needs to be done in the message broker, with the configuration tools provided by the message broker. In some messaging systems, you need to configure a *Lock Duration* to make sure that the message is not consumed more than once. This timeout must be longer than the expected processing time of the message, otherwise this would lead to duplicate messages. - -> ### Note: -> This adapter exchanges data with a remote component that might be outside the scope of SAP. Make sure that the data exchange complies with your company’s policies. - - - -> ### Note: -> This adapter enables you to connect SAP Integration Suite to a remote message broker. SAP can’t give advice on how to configure the external system nor does SAP provide support related to this. - - - -To connect Cloud Integration to Solace PubSub+, make sure to specify the following parameters in the described way: - -When creating the channel \(see [Overview of Integration Flow Editor](overview-of-integration-flow-editor-db10beb.md)\), select adapter type *AMQP* \> *TCP*. - - - -The following values are displayed in the *General* tab after a channel has been established. If you want to change the configurations, you need to configure a new channel. - -**General** - - - - - - - - - - - - - - - - - - - -
- -Parameter - - - -Description - -
- -*Name/Adapter Type* - - - -AMQP - -
- -*Transport Protocol* - - - -The protocol that the message broker supports: - -*TCP* - -
- -*Message Protocol* - - - -*AMQP 1.0* - -
- -Select the *Connection* tab and provide values in the fields as follows: - -**Connection** - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Parameter - - - -Description - -
- -*Host* - - - -Specify the hostname of the message broker. - -
- -*Port* - - - -Specify the port of the message broker. - -
- -*Proxy Type* - - - -The type of proxy that you’re using to connect to the target system. - -Select *Internet* if you’re connecting directly to the message broker. - -Select *On-Premise* if you’re connecting to an on-premise message broker. - -For more information, see [Using SAP Cloud Connector with Cloud Integration Adapters](../40-RemoteSystems/using-sap-cloud-connector-with-cloud-integration-adapters-65a60e7.md). - -
- -*Connect with TLS* - - - -Select if *TLS* has to be used for the connection. - -
- -*Location ID* \(only if *On-Premise* is selected for *Proxy Type*\) - - - -To connect to an SAP Cloud Connector instance associated with your account, enter the location ID that you defined for this instance in the destination configuration on the cloud side. - -
- -*Authentication* - - - -Select the authentication method supported by the message broker. Make sure that *SASL* is selected \(default setting\). - -
- -*Credential Name* - - - -Specify the name of the *User Credentials* artifact. - -
- -Select the *Processing* tab and provide values in the fields as follows. - -**Processing** - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Parameter - - - -Description - -
- -*Queue Name* - - - -Specify the name of the queue or topic subscription to consume from. - -> ### Note: -> Topics are not supported in the sender adapter, only queues and topic subscriptions. -> -> Technically, the AMQP sender adapter allows you to consume from queues only. The adapter doesn’t allow you to directly subscribe to a topic. If you like to work with topic subscriptions, subscribe a queue to a topic and consume from this queue. - - - -
- -*Number of Current Processes* - - - -Specify the number of processes used for parallel message processing. Note, that these processes are started from each worker node. - -> ### Note: -> The maximum number of parallel processes cannot exceed 99. The default is set to 1. - - - -
- -*Max. Number of Prefechted Messages* - - - -Enter the max. number of messages that may be prefechted by one worker. The allowed value range is 1 to 100. - -The prefetch value is the number of messages that the sender adapter fetches in advance from the broker, and then gradually processes. The prefetch reduces the communication overhead and ensures that when a message has been processed, another is already there and is ready for processing. - -If the integration flows that are triggered by the AMQP sender adapter run for longer than a few seconds, it makes sense to set a lower prefetch value. In particular, if the integration flow runs for more than a minute, you should consider setting the value to 1. You can expect then a performance deterioration in the two-digit millisecond range, per message. On the other hand, load balancing between several nodes works better even with short backlogs. - -If you need to process a large number of messages with the integration flow, and the processing of the individual message only runs for a few milliseconds, it can be useful to increase the prefetch value. - -> ### Note: -> If you increase the value, this can lead to lock timeouts and the load balancing between the nodes deteriorates. In return, you can expect performance gains in the three-digit microsecond range, per message. For example, with a prefetch value of 100, 10000 messages process approximately a second or two faster. - - - -
- -*Consume Expired Messages* - - - -Select if the adapter is to consume already expired messages. - -By default, this option is deactivated. - -
- -*Max. Number of Retries* - - - -Define the number of retries to be executed before a different delivery status is sent to the message broker. - -> ### Note: -> With the default setting \(`0`\), any message that is marked as a retried message is directly returning the outcome configured in *Delivery Status After Max. Retries* to the message broker and does not even start processing the message. Be aware of the fact that any delivery attempt by the message broker, even a failed one \(for example, due to network issues\), increases the delivery counter of the message sent by the message broker. -> -> If the value is set to a number bigger than `0`, the AMQP adapter returns the outcome configured in *Delivery Status After Max. Retries* to the message broker if the delivery count of the message exceeds the configured value. Otherwise, it processes the message and returns a released outcome in case of an error and an accepted outcome in case of a successful message processing. -> -> The consequences of the provided outcome depend on the message broker and the queue configuration on the message broker. An accepted outcome usually removes the message from the queue. A released outcome usually triggers a redelivery. A rejected outcome may trigger a redelivery or move the message to a dead letter queue \(maybe only if the message was rejected for a configured number of times\). The same applies to a modified outcome with the undeliverable flag set, which also might transit the message on the message broker to some undeliverable state. -> -> If the message broker is not configured properly, this behavior can lead to unwanted side effects. For example, the messaging system constantly re-sends the message, no other messages are being processed, and no additional message processing logs are written. As consequence, this can result in an unplanned high load of your tenant and message broker. - - - -
- -*Delivery Status After Max. Retries* - - - -Define one delivery status that is to be sent to the message broker after the maximum number of retries. The following option is supported: - -*REJECTED*. - -Don't use option *MODIFIED\_FAILED\_UNDELIVERABLE*. If selected, it can lead to errors during message processing. - -> ### Note: -> See this [general information on AMQP](http://docs.oasis-open.org/amqp/core/v1.0/amqp-core-complete-v1.0.pdf) on delivery statuses and their meaning. -> -> See this [blog](https://blogs.sap.com/2019/11/20/cloud-integration-connecting-to-external-messaging-systems-using-the-amqp-adapter/) for a summary of the capabilities supported by the different brokers. - - - -
- - - - - -## Further Constraints - -Note the following when using the AMQP adapter to connect Cloud Integration to Solace PubSub+: - -- You can configure retry by setting the header `JMSRedelivered`. - -- You can't use header `JMSXDeliveryCount`. - - -See: [Headers and Exchange Properties Provided by the Integration Framework](headers-and-exchange-properties-provided-by-the-integration-framework-d0fcb09.md) - -For more information and an example scenario using this option, see the following SAP Community blog: [https://blogs.sap.com/2019/11/20/cloud-integration-connecting-to-external-messaging-systems-using-the-amqp-adapter/](https://blogs.sap.com/2019/11/20/cloud-integration-connecting-to-external-messaging-systems-using-the-amqp-adapter/). - diff --git a/docs/ISuite/50-Development/analytics-dashboard-ee416ac.md b/docs/ISuite/50-Development/analytics-dashboard-ee416ac.md index d10896ef..0fb8fdb0 100644 --- a/docs/ISuite/50-Development/analytics-dashboard-ee416ac.md +++ b/docs/ISuite/50-Development/analytics-dashboard-ee416ac.md @@ -18,9 +18,6 @@ The following lists common features on the dashboard: 2. **Time interval**: Displays data only for the selected period of time. For example, time interval of months, weeks, and so on. 3. **Resize charts**: Resize charts from small, medium to large. -> ### Note: -> The values on the chart for a particular dimension are shown only up to a certain threshold. Any values beyond this threshold are grouped together and labelled as **Others**. By default, the threshold value for the charts is set to **25**. If you wish to modify the threshold value for the charts, please create a support ticket. To create a support ticket, see [Request to Modify Threshold Value for Charts](request-to-modify-threshold-value-for-charts-b55f89d.md). - **Related Information** diff --git a/docs/ISuite/50-Development/analyze-apis-7712c61.md b/docs/ISuite/50-Development/analyze-api-proxies-7712c61.md similarity index 89% rename from docs/ISuite/50-Development/analyze-apis-7712c61.md rename to docs/ISuite/50-Development/analyze-api-proxies-7712c61.md index fab45b9e..7227b5b8 100644 --- a/docs/ISuite/50-Development/analyze-apis-7712c61.md +++ b/docs/ISuite/50-Development/analyze-api-proxies-7712c61.md @@ -1,8 +1,8 @@ -# Analyze APIs +# Analyze API Proxies -Use the capabilities of API Analytics to analyze API usage and performance. +Use the capabilities of API Analytics to analyze API proxy usage and performance. SAP Integration Suite provides comprehensive analytics capabilities to understand the various patterns of API consumption and performance. The API Analytics server uses the runtime data of the APIs to analyze the information. The runtime data is gathered, analyzed, and displayed as charts, headers, and key performance indicators \(KPIs\). @@ -16,7 +16,7 @@ There are two variants of analytics dashboard available for analyzing API report - **Advanced API Analytics** - Advanced API Analytics brings to you the all new analytics dashboard, providing powerful tools and in-depth reports for analyzing your API usage and performance. The reports are categorized across report pages, with each report page providing information about key API metrics, which are relevant for both business users and API developers. For more information, see [Advanced API Analytics](https://help.sap.com/viewer/38c3df3f8da44a809f937220b3579607/Cloud/en-US/eeefd0e49118408a9f97b14ff46fdadf.html "") :arrow_upper_right:. + Advanced API Analytics brings to you the all new analytics dashboard, providing powerful tools and in-depth reports for analyzing your API usage and performance. The reports are categorized across report pages, with each report page providing information about key API metrics, which are relevant for both business users and API developers. For more information, see [Advanced API Analytics](https://help.sap.com/viewer/ec9c3ac6441e4b03a59ef82e10471763/Development/en-US/eeefd0e49118408a9f97b14ff46fdadf.html "") :arrow_upper_right:. > ### Note: > We're calling this new flavor of analytics, Advanced API Analytics. However, for you, as an end-user there will be no direct reference to this title on the user interface. We're sure that the various new features will enable you to make best use of this exciting new analytics dashboard. diff --git a/docs/ISuite/50-Development/anomaly-detection-7a4fe7d.md b/docs/ISuite/50-Development/anomaly-detection-7a4fe7d.md deleted file mode 100644 index bd1562b9..00000000 --- a/docs/ISuite/50-Development/anomaly-detection-7a4fe7d.md +++ /dev/null @@ -1,6 +0,0 @@ - - -# Anomaly Detection - -Anomaly detection involves identifying patterns or data points that significantly deviate from normal behaviour or expected patterns, allowing for the detection of unusual behaviour in API calls. It is now possible to analyze specific data points to detect anomalies and potentially prevent or mitigate risks. - diff --git a/docs/ISuite/50-Development/approve-the-pending-connection-requests-classic-design-b4e6f56.md b/docs/ISuite/50-Development/approve-the-pending-connection-requests-classic-design-b4e6f56.md index 65ebf2d2..1a506a83 100644 --- a/docs/ISuite/50-Development/approve-the-pending-connection-requests-classic-design-b4e6f56.md +++ b/docs/ISuite/50-Development/approve-the-pending-connection-requests-classic-design-b4e6f56.md @@ -14,6 +14,9 @@ As an API business hub enterprise administrator, you must approve or reject the You’re assigned the *AuthGroup.API.Admin* role. +> ### Caution: +> Effective June 2024, the classic design of the API business hub enterprise will be deprecated and will no longer be accessible. The new design of the API business hub enterprise will be set as your default design from March 2024. For more information, see [Configure the API business hub enterprise \[New Design\]](configure-the-api-business-hub-enterprise-new-design-54b4607.md). + > ### Note: > This document describes the classic design of the API business hub enterprise. To view the documentation for the new design, see [Approve the Pending Connection Requests \[New Design\]](approve-the-pending-connection-requests-new-design-e296f80.md). @@ -38,7 +41,7 @@ You’re assigned the *AuthGroup.API.Admin* role. ## Results -The connection has been set up between the Integration Suite API portal and the API business hub enterprise. +The connection has been set up between the Integration Suite API Management tenant and the API business hub enterprise. **Related Information** diff --git a/docs/ISuite/50-Development/approve-the-pending-connection-requests-new-design-e296f80.md b/docs/ISuite/50-Development/approve-the-pending-connection-requests-new-design-e296f80.md index d0468bb6..6ec82cdc 100644 --- a/docs/ISuite/50-Development/approve-the-pending-connection-requests-new-design-e296f80.md +++ b/docs/ISuite/50-Development/approve-the-pending-connection-requests-new-design-e296f80.md @@ -42,5 +42,5 @@ You’re assigned the *AuthGroup.APIPortalRegistration* role. ## Results -The connection has been set up between the Integration Suite API portal and the API business hub enterprise. +The connection has been set up between the Integration Suite API Management tenant and the API business hub enterprise. diff --git a/docs/ISuite/50-Development/archiving-payload-data-b927e01.md b/docs/ISuite/50-Development/archiving-payload-data-b927e01.md new file mode 100644 index 00000000..46486348 --- /dev/null +++ b/docs/ISuite/50-Development/archiving-payload-data-b927e01.md @@ -0,0 +1,22 @@ + + +# Archiving Payload Data + +Archive your sender and receiver interchange payloads. + +The feature *Archive Payload Data* allows you to archive your interchange payloads to backend CMIS system. This is how it works: + +- Each tenant will have one B2B archiving job assigned to it. The initial status of the job would be set to inactive. + +- To activate this, you need to enable the checkbox *Archive Payload Data* provided in your agreement for the sender/receiver interchange step under *B2B Scenarios* tab. +- The archiving job will be executed once a day and the status of the archiving job can be monitored in the *Monitor* tab. +- Each archived interchange will be compressed to one zip file with the naming convention `Business_Document_Data_Content.zip`. +- The archiving job, once activated will archive the payload data upto 7 days before the date of activation. Other payload data created before this time period will not be archived. +- Each archived interchange is sent to CMIS system in one transaction. +- There is no retry mechanism for the failed archived interchanges. These interchanges have to wait for the next archiving schedule job execution. +- Once the archiving job is completed, you need to check your CMIS system to check the archived data as the tenant does not display this information. +- The archiving feature is supported by the generic integration flow from version 2.3.0 and above. +- Once the interchange arhive is completed, the monitor backend database will store the data for 90 days post which the data will be deleted automatically. To monitor the archiving status, see [Monitoring B2B Messages](monitoring-b2b-messages-b5e1fc9.md) + +. + diff --git a/docs/ISuite/50-Development/attach-rate-plan-to-a-product-1980cab.md b/docs/ISuite/50-Development/attach-rate-plan-to-a-product-1980cab.md index babfcf4f..acf7880b 100644 --- a/docs/ISuite/50-Development/attach-rate-plan-to-a-product-1980cab.md +++ b/docs/ISuite/50-Development/attach-rate-plan-to-a-product-1980cab.md @@ -16,10 +16,14 @@ Attach a rate plan to a product using the SAP Integration Suite. > ### Note: -> You can only attach rate plans to those products that do not have any rate plans associated with them. A product can only be associated with one rate plan. you can also attach a rate plan to a product during the product creation. +> A product can only be associated with one rate plan. You can also attach a rate plan to a product during the product creation. > ### Note: -> If you try changing a rate plan or add a new rate plan to a product, all the existing applications of this product will remain unaffected by the changes. For example, if you add a rate plan to a product associated with the application, which has already been subscribed, this will not impact the current billing of the application. +> If you change a rate plan or add a new rate plan to a product, all the existing applications of this product will remain unaffected by the changes. +> +> Consider the following scenario, where you have subscribed to a product P1 \(that doesn't have a rate plan attached to it\) through application A1 in the source developer portal. In this case, the API calls associated with product P1 will not get billed. +> +> Now if you add a rate plan to product P1, this rate plan will not impact the current billing of application A1 or any other existing subscription. However, if you create a new subscription to product P1, the associated rate plan charges will be applicable. @@ -33,9 +37,9 @@ You are attaching a rate plan to a product. 1. Log on to the SAP Integration Suite. -2. Choose the navigation icon on the left and choose *Design* \> *APIs*. +2. Choose the navigation icon on the left and choose *Configure* \> *APIs*. -3. On the *Design* \> *APIs* page, choose *Products*. +3. On the *Configure* \> *APIs* page, choose *Products*. 4. From the list of products available, select the product to which you want to add the rate plan. @@ -55,9 +59,9 @@ You are attaching a rate plan to a product. **Related Information** -[Create a Rate Plan](https://help.sap.com/viewer/66d066d903c2473f81ec33acfe2ccdb4/Cloud/en-US/cfe6a30600f148a39a7920dbc7fa1ab2.html "Create a rate plan using the API portal.") :arrow_upper_right: + -[Update a Rate Plan](https://help.sap.com/viewer/66d066d903c2473f81ec33acfe2ccdb4/Cloud/en-US/b8c1e6b68be74ead8700f7f8be9baa8b.html "Update a rate plan using the API portal.") :arrow_upper_right: + -[Delete a Rate Plan](https://help.sap.com/viewer/66d066d903c2473f81ec33acfe2ccdb4/Cloud/en-US/d4181ad418e4446e830c498d672204ff.html "Delete a rate plan using the API portal.") :arrow_upper_right: + diff --git a/docs/ISuite/50-Development/billing-service-a4e2fb8.md b/docs/ISuite/50-Development/billing-service-a4e2fb8.md index de2a691a..a9c2887c 100644 --- a/docs/ISuite/50-Development/billing-service-a4e2fb8.md +++ b/docs/ISuite/50-Development/billing-service-a4e2fb8.md @@ -155,7 +155,7 @@ Service to view bills : - You can also view the bill details in the SAP Integration Suite and API business hub enterprise. For more information see, - - [View Bill Details in the API portal](https://help.sap.com/viewer/66d066d903c2473f81ec33acfe2ccdb4/Cloud/en-US/2378110c9b23422aa9c7b56afa5c8515.html "View bill details in theAPI portalfor all the applications and products assigned to a particular developer.") :arrow_upper_right: - - [View Bill Details in the API business hub enterprise](https://help.sap.com/viewer/66d066d903c2473f81ec33acfe2ccdb4/Cloud/en-US/4ddac6740f344f8d8260bbf2db97d950.html "View the bill details in the API business hub enterprise for all the applications subscribed by a developer.") :arrow_upper_right: + - + - diff --git a/docs/ISuite/50-Development/build-api-proxies-74c042b.md b/docs/ISuite/50-Development/build-api-proxies-74c042b.md index 28b2cf42..288ee04f 100644 --- a/docs/ISuite/50-Development/build-api-proxies-74c042b.md +++ b/docs/ISuite/50-Development/build-api-proxies-74c042b.md @@ -30,7 +30,7 @@ To build an API, you need to perform the following tasks: 3. [Associate policies to an API](policies-7e4f3e5.md). -4. [Test APIs using the API Test Console](https://help.sap.com/viewer/66d066d903c2473f81ec33acfe2ccdb4/Cloud/en-US/3ba6151391bc474b9f1fa69455f65e3b.html "Use the API Test Console to test the runtime behavior of the API proxies.") :arrow_upper_right:. +4. [Test APIs using the API Test Console](https://help.sap.com/viewer/4425026877144cc2b15505ed30215167/IAT/en-US/3ba6151391bc474b9f1fa69455f65e3b.html "Use the API Test Console to test the runtime behavior of the API proxies.") :arrow_upper_right:. > ### Note: > In order to achieve an effortless navigation to the API business hub enterprise, choose *Navigation Links*\(![](../images/Finalgrid_1a621ca.png)\) from the SAP Integration Suite and select *API Business Hub Enterprise*. diff --git a/docs/ISuite/50-Development/centralized-api-business-hub-enterprise-classic-design-33b706f.md b/docs/ISuite/50-Development/centralized-api-business-hub-enterprise-classic-design-33b706f.md index 2128782a..613c60f4 100644 --- a/docs/ISuite/50-Development/centralized-api-business-hub-enterprise-classic-design-33b706f.md +++ b/docs/ISuite/50-Development/centralized-api-business-hub-enterprise-classic-design-33b706f.md @@ -4,8 +4,8 @@ The centralized API business hub enterprise is a central API catalog, allowing application developers to consume APIs and other assets, from a common platform. -> ### Note: -> By default, the Site Administrator has an option to switch from classic to new design and set the new design as the default UI using the **Site Editor.** The Site Administrator has the right to enable the configuration to let all the other users switch between the old and the new design. +> ### Caution: +> Effective June 2024, the classic design of the API business hub enterprise will be deprecated and will no longer be accessible. The new design of the API business hub enterprise will be set as your default design from March 2024. For more information, see [Configure the API business hub enterprise \[New Design\]](configure-the-api-business-hub-enterprise-new-design-54b4607.md). > ### Note: > This document describes the classic design of the API business hub enterprise. To view the documentation for the new design, see [Centralized API business hub enterprise \[New Design\]](centralized-api-business-hub-enterprise-new-design-38422de.md). @@ -13,12 +13,17 @@ The centralized API business hub enterprise is a central API catalog, allowing a > ### Example: > Organizations can use the centralized API business hub enterprise as a single platform, where different lines of business publish their APIs, allowing the organization's consumers to access these varied APIs from one location. -Every API Management instance will have an API business hub enterprise application on cloud. One of the various API Business Hub Enterprises is set as a centralized API catalog. This catalog will then receive API proxies, API products, and other assets from each connected API Portal. All the assets published to the centralized API business hub enterprise must be unique. +If you have enabled API business hub enterprise and API Management tenant in the same Integration Suite sub-account, they will automatically connect to each other. + +> ### Note: +> Once this connection is established, you will not be able to connect the API Management tenant to any other API business hub enterprise enabled in a different sub-account. However, if you have not enabled API business hub enterprise in the same Integration Suite sub-account where you have enabled API Management tenant, you can connect this API Management tenant to an API business hub enterprise enabled in another sub-account and designate it as a centralized API business hub enterprise. +> +> This centralized API business hub enterprise can be used to establish connections with multiple API Management tenants and can receive API proxies, API products, and other assets from each connected API Management tenants. It is important to ensure that all assets published to the centralized API business hub enterprise are unique. > ### Remember: -> You can define different API Management instances to suit a particular stage in the API lifecycle. So you can have Development, Test, and Productive instances. Transport of APIs between the API Portals of these instances is also possible, see [Transport APIs and Its Related Artifacts](transport-apis-and-its-related-artifacts-eb83118.md). However, connecting the API Portals having such a relationship to the same API business hub enterprise will violate the uniquness of the assets. +> You can configure multipleIntegration Suite API Management tenants to cater to different stages of the API lifecycle. For example, you can have separate instances for development, testing, and production. However, connecting these API Management tenants having such a relationship to the same API business hub enterprise will violate the uniquness of the assets. -Once the application developers register to centralized API business hub enterprise, they can seamlessly search, explore, and test APIs. They can also create and subscribe to various applications from the API business hub enterprise. +Once the application developers register with the centralized API business hub enterprise, they can easily search, explore, and test APIs. They can also create and subscribe to specific types of applications available from the API business hub enterprise. -The API business hub enterprise admin identifies which existing or new API Business Hub Enterprise application can accept content from multiple API portals. +The API business hub enterprise admin identifies which existing or new API business hub enterprise application can accept content from multiple Integration Suite API Management tenants. diff --git a/docs/ISuite/50-Development/centralized-api-business-hub-enterprise-new-design-38422de.md b/docs/ISuite/50-Development/centralized-api-business-hub-enterprise-new-design-38422de.md index b1211d58..72f6d6d7 100644 --- a/docs/ISuite/50-Development/centralized-api-business-hub-enterprise-new-design-38422de.md +++ b/docs/ISuite/50-Development/centralized-api-business-hub-enterprise-new-design-38422de.md @@ -2,22 +2,27 @@ # Centralized API business hub enterprise \[New Design\] -The centralized API business hub enterprise is a central API catalog, allowing application developers to consume APIs and other assets, from a common platform. +The API business hub enterprise is a central API catalog, allowing application developers to consume APIs and other assets, from a common platform. > ### Note: -> By default, the Site Administrator has an option to switch from classic to new design and set the new design as the default UI using the **Site Editor.** The Site Administrator has the right to enable the configuration to let all the other users switch between the old and the new design. +> By default, the site administrator has the option to switch from the classic design to the new design and set the new design as the default user interface \(UI\) using the *Site Editor*. The site administrator also has the authority to enable a configuration that allows all other users to switch between the old and new designs. > > This document describes the new design of the API business hub enterprise. To view the documentation for the classic design, see [Centralized API business hub enterprise \[Classic Design\]](centralized-api-business-hub-enterprise-classic-design-33b706f.md) > ### Example: -> Organizations can use the centralized API business hub enterprise as a single platform, where different lines of business publish their APIs, allowing the organization's consumers to access these varied APIs from one location. +> By default, the site administrator has the option to switch from the classic design to the new design and set the new design as the default user interface \(UI\) using the *Site Editor*. The site administrator also has the authority to enable a configuration that allows all other users to switch between the old and new designs. -Every API Management instance will have an API business hub enterprise application on cloud. One of the various API Business Hub Enterprises is set as a centralized API catalog. This catalog will then receive API proxies, API products, and other assets from each connected API Portal. All the assets published to the centralized API business hub enterprise must be unique. +If you have enabled API business hub enterprise and API Management tenant in the same Integration Suite sub-account, they will automatically connect to each other. + +> ### Note: +> Once this connection is established, you will not be able to connect the API Management tenant to any other API business hub enterprise enabled in a different sub-account. However, if you have not enabled API business hub enterprise in the same Integration Suite sub-account where you have enabled API Management tenant, you can connect this API Management tenant to an API business hub enterprise enabled in another sub-account and designate it as a centralized API business hub enterprise. +> +> This centralized API business hub enterprise can be used to establish connections with multiple API Management tenants and can receive API proxies, API products, and other assets from each connected API Management tenants. It is important to ensure that all assets published to the centralized API business hub enterprise are unique. > ### Remember: -> You can define different API Management instances to suit a particular stage in the API lifecycle. So you can have Development, Test, and Productive instances. Transport of APIs between the API Portals of these instances is also possible, see [Transport APIs and Its Related Artifacts](transport-apis-and-its-related-artifacts-eb83118.md). However, connecting the API Portals having such a relationship to the same API business hub enterprise will violate the uniquness of the assets. +> You can configure multipleIntegration Suite API Management tenants to cater to different stages of the API lifecycle. For example, you can have separate instances for development, testing, and production. However, connecting these API Management tenants having such a relationship to the same API business hub enterprise will violate the uniquness of the assets. -Once the application developers register to centralized API business hub enterprise, they can seamlessly search, explore, and test APIs. They can also create and subscribe to various applications from the API business hub enterprise. +Once the application developers register with the centralized API business hub enterprise, they can easily search, explore, and test APIs. They can also create and subscribe to specific types of applications available from the API business hub enterprise. -The API business hub enterprise admin identifies which existing or new API Business Hub Enterprise application can accept content from multiple API portals. +The API business hub enterprise admin identifies which existing or new API business hub enterprise application can accept content from multiple Integration Suite API Management tenants. diff --git a/docs/ISuite/50-Development/configure-0bb111e.md b/docs/ISuite/50-Development/configure-0bb111e.md index 21b64956..f126464f 100644 --- a/docs/ISuite/50-Development/configure-0bb111e.md +++ b/docs/ISuite/50-Development/configure-0bb111e.md @@ -2,7 +2,7 @@ # Configure -From this section, you can create and configure API proxies, API providers, certificates, key-value maps, and policy templates. +Create, and configure API proxies, API providers, certificates, key-value maps, and policy templates in SAP Integration Suite. SAP Integration Suite enables consumers to access relevant data directly in a secure manner. Selective data can be exposed while reducing the risk of security breaches. App devlopers access APIs created using SAP Integration Suite rather than app consuming services directly. SAP Integration Suite maps a publicly available HTTP endpoint to backend services and handles the security and authorizations required to protect, analyze, and monitor your services. diff --git a/docs/ISuite/50-Development/configure-adapter-in-communication-channels-1f06633.md b/docs/ISuite/50-Development/configure-adapter-in-communication-channels-1f06633.md index 9d59c709..f1e0955b 100644 --- a/docs/ISuite/50-Development/configure-adapter-in-communication-channels-1f06633.md +++ b/docs/ISuite/50-Development/configure-adapter-in-communication-channels-1f06633.md @@ -187,6 +187,46 @@ See: [AMQP Receiver for SAP Event Mesh](amqp-receiver-for-sap-event-mesh-0b7cc2f +*AMQP for SAP Integration Suite, advanced event mesh* + +Sender adapter + + + + +Enables SAP Integration Suite to consume messages from SAP Integration Suite, advanced event mesh. + +Supported message protocol: AMQP \(Advanced Message Queuing Protocol\) 1.0 + +Supported transport protocol: TCP + +See: [AMQ Sender for SAP Integration Suite, advanced event mesh](amq-sender-for-sap-integration-suite-advanced-event-mesh-be1e496.md) + + + + + + +*AMQP for SAP Integration Suite, advanced event mesh* + +Receiver adapter + + + + +Enables SAP Integration Suite to send messages to SAP Integration Suite, advanced event mesh. + +Supported message protocol: AMQP \(Advanced Message Queuing Protocol\) 1.0 + +Supported transport protocol: TCP + +See: [AMQP Receiver for SAP Integration Suite, advanced event mesh](amqp-receiver-for-sap-integration-suite-advanced-event-mesh-5f229c0.md) + + + + + + *AMQP for Microsoft Azure Service Bus* Sender adapter @@ -200,7 +240,7 @@ Supported message protocol: AMQP \(Advanced Message Queuing Protocol\) 1.0 Supported transport protocol: TCP -See: [AMQP Sender for Microsoft Azure Service Bus](amqp-sender-for-microsoft-azure-service-bus-7384ac3.md) +See: [Configure the AMQP Sender Adapter](configure-the-amqp-sender-adapter-99ce674.md) @@ -220,7 +260,7 @@ Supported message protocol: AMQP \(Advanced Message Queuing Protocol\) 1.0 Supported transport protocol: TCP -See: [AMQP Receiver for Microsoft Azure Service Bus](amqp-receiver-for-microsoft-azure-service-bus-9c64d80.md) +See: [Configure the AMQP Receiver Adapter](configure-the-amqp-receiver-adapter-d5660c1.md) @@ -240,7 +280,7 @@ Supported message protocol: AMQP \(Advanced Message Queuing Protocol\) 1.0 Supported transport protocol: TCP -See: [AMQP Sender for Solace PubSub+](amqp-sender-for-solace-pubsub-c9ab47d.md) +See: [Configure the AMQP Sender Adapter](configure-the-amqp-sender-adapter-99ce674.md) @@ -260,7 +300,7 @@ Supported message protocol: AMQP \(Advanced Message Queuing Protocol\) 1.0 Supported transport protocol: TCP -See: [AMQP Receiver for Solace PubSub+](amqp-receiver-for-solace-pubsub-19f18d8.md) +See: [Configure the AMQP Receiver Adapter](configure-the-amqp-receiver-adapter-d5660c1.md) @@ -280,7 +320,7 @@ Supported message protocol: AMQP \(Advanced Message Queuing Protocol\) 1.0 Supported transport protocol: TCP, WebSocket -See: [AMQP Sender for Apache Qpid Broker-J](amqp-sender-for-apache-qpid-broker-j-b4983f7.md) +See: [Configure the AMQP Sender Adapter](configure-the-amqp-sender-adapter-99ce674.md) @@ -300,7 +340,7 @@ Supported message protocol: AMQP \(Advanced Message Queuing Protocol\) 1.0 Supported transport protocol: TCP, WebSocket -See: [AMQP Receiver for Apache Qpid Broker-J](amqp-receiver-for-apache-qpid-broker-j-622aa1d.md) +See: [Configure the AMQP Receiver Adapter](configure-the-amqp-receiver-adapter-d5660c1.md) @@ -320,7 +360,7 @@ Supported message protocol: AMQP \(Advanced Message Queuing Protocol\) 1.0 Supported transport protocol: TCP -See: [AMQP Sender for Apache ActiveMQ 5 and Apache ActiveMQ Artemis](amqp-sender-for-apache-activemq-5-and-apache-activemq-artemis-dc4c564.md) +See: [Configure the AMQP Sender Adapter](configure-the-amqp-sender-adapter-99ce674.md) @@ -340,7 +380,7 @@ Supported message protocol: AMQP \(Advanced Message Queuing Protocol\) 1.0 Supported transport protocol: TCP -See: [AMQP Receiver for Apache ActiveMQ 5 and Apache ActiveMQ Artemis](amqp-receiver-for-apache-activemq-5-and-apache-activemq-artemis-76c4dd3.md) +See: [Configure the AMQP Receiver Adapter](configure-the-amqp-receiver-adapter-d5660c1.md) @@ -360,7 +400,7 @@ Supported message protocol: AMQP \(Advanced Message Queuing Protocol\) 1.0 Supported transport protocol: TCP -See: [AMQP Sender for IBM MQ](amqp-sender-for-ibm-mq-f6cc0e4.md) +See: [Configure the AMQP Sender Adapter](configure-the-amqp-sender-adapter-99ce674.md) @@ -380,7 +420,7 @@ Supported message protocol: AMQP \(Advanced Message Queuing Protocol\) 1.0 Supported transport protocol: TCP -See: [AMQP Receiver for IBM MQ](amqp-receiver-for-ibm-mq-990fa99.md) +See: [Configure the AMQP Receiver Adapter](configure-the-amqp-receiver-adapter-d5660c1.md) diff --git a/docs/ISuite/50-Development/configure-receiver-channel-with-pull-message-protocol-7cdde30.md b/docs/ISuite/50-Development/configure-receiver-channel-with-pull-message-protocol-7cdde30.md index 0cef4a26..b7f18e2e 100644 --- a/docs/ISuite/50-Development/configure-receiver-channel-with-pull-message-protocol-7cdde30.md +++ b/docs/ISuite/50-Development/configure-receiver-channel-with-pull-message-protocol-7cdde30.md @@ -199,6 +199,48 @@ Description +*Username Token* + + + + +Choose the relevant password type to be used when a username token is generated from credentials. + +- *Dynamic*: To set the values dynamically using `SAP_AS4_Outbound_Pull_Username_Token` header. The valid values are: + - none + - hashedPasswordWithTimestamp + - plainTextPassword + - plainTextPasswordWithTimestamp + + +- *Not Required*: To skip the username token generation. +- *With Hashed Password and Timestamp*: The username and password from the token are added to the XML payload as a plain text and hashed value respectively along with the timestamp. This is the most secure way of adding the username to the payload. +- *With Plain Text Password*: The username and password from the token are added to the XML payload as a plain text. +- *With Plain Text Password and Timestamp*: The username and password from the token are added to the XML payload as a plain text along with the timestamp. + + > ### Recommendation: + > Transmit such payloads over HTTPS transport layer. + + + + + + + + + +*Credential Name* only if *Username Token* isn't selected as *Not Required* + + + + +Enter the credential name of the username-password pair specified during the deployment of the security artifact. You can also enter $\{header.headername\} or $\{property.propertyname\} to read the value dynamically from a header or a property. + + + + + + *Sign Message* @@ -300,6 +342,39 @@ Provide the public key alias to verify the signature of the AS4 message. +*Verify Username Token* + + + + +Select the relevant option for username token verification: + +- Dynamic: You can also set the value of this attribute dynamically by using the header `SAP_AS4_Outbound_Verify_Response_Username_Token`. The valid values are: + - notRequired + - required + +- Not Required: To skip the verification of response message. +- Required + + + + + + + + +*Credential Name* only if *Verify Username Token* isn't selected as *Not Required* + + + + +Enter the credential name of the username-password pair specified during the deployment of the security artifact. You can also enter $\{header.headername\} or $\{property.propertyname\} to read the value dynamically from a header or a property. + + + + + + *Decrypt Message* diff --git a/docs/ISuite/50-Development/configure-receiver-channel-with-push-message-protocol-449f6e9.md b/docs/ISuite/50-Development/configure-receiver-channel-with-push-message-protocol-449f6e9.md index 74de68ad..0380a464 100644 --- a/docs/ISuite/50-Development/configure-receiver-channel-with-push-message-protocol-449f6e9.md +++ b/docs/ISuite/50-Development/configure-receiver-channel-with-push-message-protocol-449f6e9.md @@ -362,6 +362,48 @@ Description +*Username Token* + + + + +Choose the relevant password type to be used when a username token is generated from credentials. + +- *Dynamic*: To set the values dynamically using `SAP_AS4_Outbound_Username_Token` header. The valid values are: + - none + - hashedPasswordWithTimestamp + - plainTextPassword + - plainTextPasswordWithTimestamp + + +- *Not Required*: To skip the username token generation. +- *With Hashed Password and Timestamp*: The username and password from the token are added to the XML payload as a plain text and hashed value respectively along with the timestamp. This is the most secure way of adding the username to the payload. +- *With Plain Text Password*: The username and password from the token are added to the XML payload as a plain text. +- *With Plain Text Password and Timestamp*: The username and password from the token are added to the XML payload as a plain text along with the timestamp. + + > ### Recommendation: + > Transmit such payloads over HTTPS transport layer. + + + + + + + + + +*Credential Name* only if *Username Token* isn't selected as *Not Required* + + + + +Enter the credential name of the username-password pair specified during the deployment of the security artifact. You can also enter $\{header.headername\} or $\{property.propertyname\} to read the value dynamically from a header or a property. + + + + + + *WS-Security Type* @@ -542,6 +584,39 @@ The valid values are: + + + + + +*Verify Username Token* + + + + +Select the relevant option for username token verification in AS4 receipt: + +- Dynamic: You can also set the value of this attribute dynamically by using the header `SAP_AS4_Outbound_Verify_Receipt_Username_Token`. The valid values are: + - notRequired + - required + +- Not Required: To skip the verification of response message. +- Required + + + + + + + + +*Credential Name* only if *Verify Username Token* isn't selected as *Not Required* + + + + +Enter the credential name of the username-password pair specified during the deployment of the security artifact. You can also enter $\{header.headername\} or $\{property.propertyname\} to read the value dynamically from a header or a property. + diff --git a/docs/ISuite/50-Development/configure-the-advanced-event-mesh-receiver-adapter-881f656.md b/docs/ISuite/50-Development/configure-the-advanced-event-mesh-receiver-adapter-881f656.md index df8b2781..cd98038b 100644 --- a/docs/ISuite/50-Development/configure-the-advanced-event-mesh-receiver-adapter-881f656.md +++ b/docs/ISuite/50-Development/configure-the-advanced-event-mesh-receiver-adapter-881f656.md @@ -4,6 +4,16 @@ The AdvancedEventMesh receiver adapter allows SAP Integration Suite to send messages to queues or topics in SAP Integration Suite, advanced event mesh. +> ### Note: +> This adapter is available on SAP Business Accelerator Hub. +> +> For more information, see [Consuming Integration Adapters from SAP Business Accelerator Hub](consuming-integration-adapters-from-sap-business-accelerator-hub-b9250fb.md). +> +> The availability of the adapter is dependent on your SAP Integration Suite service plan. For more information about different service plans and their supported feature set, see SAP Notes [2903776](https://launchpad.support.sap.com/#/notes/2903776) and [3188446](https://launchpad.support.sap.com/#/notes/3188446). + +> ### Note: +> This adapter exchanges data with a remote component that might be outside the scope of SAP. Make sure that the data exchange complies with your company’s policies. + The adapter uses the Solace Message Format \(SMF\) message protocol. The *General* tab displays general information about the adapter itself. @@ -142,6 +152,8 @@ The authentication mechanism to be used while connecting to advanced event mesh. - *Client Certificate* +- *OAuth2* + @@ -150,7 +162,7 @@ The authentication mechanism to be used while connecting to advanced event mesh. -*Password Secure Alias \(Only when using \`Basic\` authentication\)* +*Password Secure Alias* \(Only when using *Basic* authentication\) @@ -162,7 +174,7 @@ The alias which defines the client password used for authentication with the eve -*Keystore Alias \(Only when using \`Client Certificate\` authentication\)* +*Keystore Alias* \(Only when using *Client Certificate* authentication\) @@ -174,9 +186,7 @@ The alias of the private Key Pair in the Integration Suite's Keystore. -*Private Key Alias* - -\(Only if for *Truststore Alias \(Only when using \`Client Certificate\` authentication\)* +*Truststore Alias* \(Only when using *Client Certificate* authentication\) @@ -188,7 +198,7 @@ The alias of the Certificate in the Integration Suite's Keystore. This is option -*OAuth2 Credential Type \(Only when using \`OAuth2\` authentication\)* +*OAuth2 Credential Type* \(Only when using *OAuth2* authentication\) @@ -209,7 +219,7 @@ The type of OAuth2 credential type to be used. The available options are: -*Access Token Fetch/Refresh Interval \(in secs\) \(Only when using \`OAuth2\` authentication\)* +*Access Token Fetch/Refresh Interval \(in secs\)* \(Only when using *OAuth2* authentication\) @@ -221,7 +231,7 @@ The interval in seconds for fetching the access token from the respective Integr -*OAuth2 Client Credentials Credential Name \(Only when using \`OAuth2\` authentication and \`OAuth2 Client Credentials\` OAuth2 credential type\)* +*OAuth2 Client Credentials Credential Name* \(Only when using *OAuth2* authentication and *OAuth2 Client Credentials* OAuth2 credential type\) @@ -233,7 +243,21 @@ The alias of the deployed OAuth2 Client Credentials artifact in the Integrations -*OAUTH2 Access Token Secure Alias \(Only when using \`OAuth2\` authentication and \`OAuth2 - Custom\` OAuth2 credential type\)* +*OAuth2 Authorization Code Credential Name* + +\(Only when using *OAuth2* authentication and *OAuth2 Authorization Code* OAuth2 credential type\) + + + + +The alias of the deployed *OAuth2 Authorization Code* artifact in the Integrations Suite's Credential Store. See [Deploying an OAuth2 Authorization Code](deploying-an-oauth2-authorization-code-081bfd7.md) + + + + + + +*OAUTH2 Access Token Secure Alias* \(Only when using *OAuth2* authentication and *OAuth2 - Custom* OAuth2 credential type\) @@ -245,7 +269,7 @@ The alias of OAuth2 Access token, stored as Secure Parameter. -*OAUTH2 Refresh Token Secure Alias \(Only when using \`OAuth2\` authentication and \`OAuth2 - Custom\` OAuth2 credential type\)* +*OAUTH2 Refresh Token Secure Alias* \(Only when using *OAuth2* authentication and *OAuth2 - Custom* OAuth2 credential type\) @@ -257,7 +281,7 @@ The alias of the OAuth2 Refresh token, stored as Secure Parameter. -*OAUTH2 Client ID Secure Alias \(Only when using \`OAuth2\` authentication and \`OAuth2 - Custom\` OAuth2 credential type\)* +*OAUTH2 Client ID Secure Alias* \(Only when using *OAuth2* authentication and *OAuth2 - Custom* OAuth2 credential type\) @@ -269,7 +293,7 @@ The alias of the OAuth2 Client ID, stored as Secure Parameter. -*OAUTH2 Refresh Token URL Secure Alias \(Only when using \`OAuth2\` authentication and \`OAuth2 - Custom\` OAuth2 credential type\)* +*OAUTH2 Refresh Token URL Secure Alias* \(Only when using *OAuth2* authentication and *OAuth2 - Custom* OAuth2 credential type\) @@ -286,23 +310,17 @@ The alias of the OAuth2 Refresh token URL, stored as Secure Parameter. -A map of key-value pairs to configure additional connection properties. See [JCSMP Properties](https://docs.solace.com/API-Developer-Online-Ref-Documentation/java/com/solacesystems/jcsmp/JCSMPProperties.html) and [JCSMP Channel Properties](https://docs.solace.com/API-Developer-Online-Ref-Documentation/java/com/solacesystems/jcsmp/JCSMPChannelProperties.html) +A map of key-value pairs to configure additional connection properties. For more information, see the product documentation on Solace PubSub+ Platform. > ### Note: -> JCSMP channel property keys must be prepended by \`CLIENT\_CHANNEL\_PROPERTIES.\`. For example: -> -> - \`GENERATE\_SENDER\_ID\` \(regular JCSMP property\) -> -> - \`CLIENT\_CHANNEL\_PROPERTIES.ReconnectRetries\` \(JCSMP channel property\) -> -> A map of key-value pairs to configure additional connection properties. See [JCSMP Properties](https://docs.solace.com/API-Developer-Online-Ref-Documentation/java/com/solacesystems/jcsmp/JCSMPProperties.html) and [JCSMP Channel Properties](https://docs.solace.com/API-Developer-Online-Ref-Documentation/java/com/solacesystems/jcsmp/JCSMPChannelProperties.html) +> JCSMP channel property keys must be prepended by `CLIENT_CHANNEL_PROPERTIES`. + +For example: + +- `GENERATE_SENDER_ID` \(regular JCSMP property\) + +- `CLIENT_CHANNEL_PROPERTIES.ReconnectRetries` \(JCSMP channel property\) -> ### Note: -> JCSMP channel property keys must be prepended by \`CLIENT\_CHANNEL\_PROPERTIES.\`. For example: -> -> - \`GENERATE\_SENDER\_ID\` \(regular JCSMP property\) -> -> - \`CLIENT\_CHANNEL\_PROPERTIES.ReconnectRetries\` \(JCSMP channel property\) @@ -371,8 +389,6 @@ The endpoint/destination type for the message being published. The available opt *Destination Name* -\(Only if for *Destination Type* the option *Exchange* is selected\) - @@ -411,7 +427,7 @@ The message type to be used for publishing the message to the broker. The availa -*Synchronous Request Processing Details* +*Convert Publish Into Synchronous Requestor* @@ -423,7 +439,7 @@ Enable if this is a Request in the Adapter Request/Reply pattern. This will send -*Reply Timeout \(ms\) \(Only when Convert Publish Into Synchronous Requestor? is selected\)* +*Reply Timeout \(ms\)* \(Only when *Convert Publish Into Synchronous Requestor* is selected\) @@ -698,7 +714,7 @@ The value of the respective User Property's key/name. The value can be defined d *Message Headers* -The adapter accepts headers on both Sender and Receiver side. +The adapter accepts headers on both sender and receiver side. -The Receiver can support the following headers on the message being published to the broker: ApplicationMessageId, ApplicationMessageType, CoS, CorrelationId, DeliveryCount, Destination, DestinationEndpointType, Expiration, HttpContentEncoding, HttpContentType, IsDiscardIndication, IsDMQEligible, IsElidingEligible, IsRedelivered, IsReplyMessage, Priority, ReceiveTimestamp, ReplicationGroupMessageId, ReplyToEndpointType, ReplyToDestination, SenderId, SenderTimestamp, SequenceNumber, TimeToLive, UserProperties. When setting up the integration flow, add them to the allowlist via Integration Flow -\> Runtime Configuration -\> Allowed Header\(s\), if required. See [Specify the Runtime Configuration](https://help.sap.com/docs/cloud-integration/sap-cloud-integration/specify-runtime-configuration). Some of these headers can be defined at design-time via the *Message Properties* tab and the rest could be defined using a Content Modifier. +The receiver can support the following headers on the message being published to the broker: ApplicationMessageId, ApplicationMessageType, CoS, CorrelationId, DeliveryCount, Destination, DestinationEndpointType, Expiration, HttpContentEncoding, HttpContentType, IsDiscardIndication, IsDMQEligible, IsElidingEligible, IsRedelivered, IsReplyMessage, Priority, ReceiveTimestamp, ReplicationGroupMessageId, ReplyToEndpointType, ReplyToDestination, SenderId, SenderTimestamp, SequenceNumber, TimeToLive, UserProperties. When setting up the integration flow, add them to the allowlist via Integration Flow -\> Runtime Configuration -\> Allowed Header\(s\), if required. See [Specify the Runtime Configuration](https://help.sap.com/docs/cloud-integration/sap-cloud-integration/specify-runtime-configuration). Some of these headers can be defined at design-time via the *Message Properties* tab and the rest could be defined using a Content Modifier. diff --git a/docs/ISuite/50-Development/configure-the-advanced-event-mesh-sender-adapter-abd2efc.md b/docs/ISuite/50-Development/configure-the-advanced-event-mesh-sender-adapter-abd2efc.md index 18c4a4a0..0ee5a0d1 100644 --- a/docs/ISuite/50-Development/configure-the-advanced-event-mesh-sender-adapter-abd2efc.md +++ b/docs/ISuite/50-Development/configure-the-advanced-event-mesh-sender-adapter-abd2efc.md @@ -4,6 +4,16 @@ The AdvancedEventMesh sender adapter allows SAP Integration Suite to consume messages from queues or subscriptions in SAP Integration Suite, advanced event mesh. +> ### Note: +> This adapter is available on SAP Business Accelerator Hub. +> +> For more information, see [Consuming Integration Adapters from SAP Business Accelerator Hub](consuming-integration-adapters-from-sap-business-accelerator-hub-b9250fb.md). +> +> The availability of the adapter is dependent on your SAP Integration Suite service plan. For more information about different service plans and their supported feature set, see SAP Notes [2903776](https://launchpad.support.sap.com/#/notes/2903776) and [3188446](https://launchpad.support.sap.com/#/notes/3188446). + +> ### Note: +> This adapter exchanges data with a remote component that might be outside the scope of SAP. Make sure that the data exchange complies with your company’s policies. + The adapter uses the Solace Message Format \(SMF\) message protocol. The *General* tab displays general information about the adapter itself. @@ -152,7 +162,7 @@ The authentication mechanism to be used while connecting to AEM. The available o -*Password Secure Alias\(Only when using Basic authentication\)* +*Password Secure Alias* \(Only when using *Basic* authentication\) @@ -164,7 +174,7 @@ The alias which defines the client password used for authentication with the eve -*Keystore Alias\(Only when using Client Certificate authentication\)* +*Keystore Alias* \(Only when using *Client Certificate* authentication\) @@ -176,7 +186,7 @@ The alias of the private Key Pair in the Integration Suite's Keystore. -*Truststore Alias\(Only when using Client Certificate authentication\)* +*Truststore Alias* \(Only when using *Client Certificate* authentication\) @@ -188,7 +198,7 @@ The alias of the Certificate in the Integration Suite's Keystore. This is option -*OAuth2 Credential Type\(Only when using \`OAuth2\` authentication\)* +*OAuth2 Credential Type* \(Only when using *OAuth2* authentication\) @@ -209,7 +219,7 @@ The type of OAuth2 credential type to be used. The available options are: -*Access Token Fetch/Refresh Interval \(in secs\) \(Only when using \`OAuth2\` authentication\)* +*Access Token Fetch/Refresh Interval \(in secs\)* \(Only when using *OAuth2* authentication\) @@ -221,7 +231,7 @@ The interval in seconds for fetching the access token from the respective Integr -*OAuth2 Client Credentials Credential Name \(Only when using \`OAuth2\` authentication and \`OAuth2 Client Credentials\` OAuth2 credential type\)* +*OAuth2 Client Credentials Credential Name* \(Only when using *OAuth2* authentication and *OAuth2 Client Credentials* OAuth2 credential type\) @@ -233,7 +243,7 @@ The alias of the deployed OAuth2 Client Credentials artifact in the Integrations -*OAuth2 Authorization Code Credential Name\(Only when using \`OAuth2\` authentication and \`OAuth2 Authorization Code\` OAuth2 credential type\)* +*OAuth2 Authorization Code Credential Name* \(Only when using *OAuth2* authentication and *OAuth2 Authorization Code* OAuth2 credential type\) @@ -245,7 +255,7 @@ The alias of the deployed OAuth2 Authorization Code artifact in the Integrations -*OAUTH2 Access Token Secure Alias\(Only when using \`OAuth2\` authentication and \`OAuth2 - Custom\` OAuth2 credential type\)* +*OAUTH2 Access Token Secure Alias* \(Only when using *OAuth2* authentication and *OAuth2 - Custom* OAuth2 credential type\) @@ -257,7 +267,7 @@ The alias of OAuth2 Access token, stored as Secure Parameter. -*OAUTH2 Refresh Token Secure Alias\(Only when using \`OAuth2\` authentication and \`OAuth2 - Custom\` OAuth2 credential type\)* +*OAUTH2 Refresh Token Secure Alias* \(Only when using *OAuth2* authentication and *OAuth2 - Custom* OAuth2 credential type\) @@ -269,7 +279,7 @@ The alias of the OAuth2 Refresh token, stored as Secure Parameter. -*OAUTH2 Client ID Secure Alias\(Only when using \`OAuth2\` authentication and \`OAuth2 - Custom\` OAuth2 credential type\)* +*OAUTH2 Client ID Secure Alias* \(Only when using *OAuth2* authentication and *OAuth2 - Custom* OAuth2 credential type\) @@ -281,7 +291,7 @@ The alias of the OAuth2 Client ID, stored as Secure Parameter. -*OAUTH2 Refresh Token URL Secure Alias\(Only when using \`OAuth2\` authentication and \`OAuth2 - Custom\` OAuth2 credential type\)* +*OAUTH2 Refresh Token URL Secure Alias* \(Only when using *OAuth2* authentication and *OAuth2 - Custom* OAuth2 credential type\) @@ -298,7 +308,7 @@ The alias of the OAuth2 Refresh token URL, stored as Secure Parameter. -A map of key-value pairs to configure additional connection properties. See `https://docs.solace.com/API-Developer-Online-Ref-Documentation/java/com/solacesystems/jcsmp/JCSMPProperties.html` and `href="https://docs.solace.com/API-Developer-Online-Ref-Documentation/java/com/solacesystems/jcsmp/JCSMPChannelProperties.html` for the available options. +A map of key-value pairs to configure additional connection properties. For more information, see the product documentation on Solace PubSub+ Platform. > ### Note: > JCSMP channel property keys must be prepended by \`CLIENT\_CHANNEL\_PROPERTIES.\`. For example: @@ -345,6 +355,27 @@ The adapter's consumer mode. The available options are: - Guaranteed +- Durable Topic Endpoint + + + + + + + + + +*Run on a single worker node?* + + + + +When enabled, the consumer is bound to only one of the available worker nodes. It is recommended in the following cases: + +- When consuming in *Direct* mode to avoid the processing of the same message on all the worker nodes due to fanout. + +- To successfully bind to an Exclusive access type *Durable Topic Endpoint*, as it only allows one consumer binding. + @@ -353,7 +384,7 @@ The adapter's consumer mode. The available options are: -*Topic Subscriptions\(Only when using \`Direct\` consumer mode\)* +*Topic Subscriptions* \(Only when using *Direct* consumer mode\) @@ -370,7 +401,7 @@ The list of AEM topic subscriptions from which messages will be consumed. -*Parallel Consumers\(Only when using \`Guaranteed\` consumer mode\)* +*Parallel Consumers* \(Only when using *Guaranteed* or *Durable Topic Endpoint* consumer mode\) @@ -387,19 +418,76 @@ The number of concurrent consumer flows. -*Selector\(Only when using \`Guaranteed\` consumer mode\)* +*Queue Name* \(Only when using *Guaranteed* consumer mode\) + + + + +The Advanced Event Mesh queue name from which messages are consumed. + + + + + + +*Topic Endpoint Name* \(Only when using *Durable Topic Endpoint* consumer mode\) + + + + +A durable topic endpoint has an access type that determines how messages are delivered when multiple consumer flows are bound to it. Topic endpoints can be assigned one of the following access types: + +- Exclusive + + Specifies that only one client can bind to and be serviced by the topic endpoint. If other consumers attempt to bind, they are rejected. + +- Non-exclusive + + Specifies that all bound flows are able to receive messages, and when multiple flows are bound to a non-exclusive topic endpoint, they receive messages in a round-robin fashion. + + + + + + + + + +*Topic Name* \(Only when using *Durable Topic Endpoint* consumer mode\) + + + + +The Advanced Event Mesh topic name on which the durable topic subscription needs to be made. + +> ### Caution: +> Durable Topic endpoints support a single subscription. If the topic subscription changes, all messages persisted to the topic endpoint are deleted. + + + + + + + + +*Selector* \(Only when using *Guaranteed* or *Durable Topic Endpoint* consumer mode\) -A SQL-92 selector to filter messages for consumption. +An SQL-92 selector to filter messages for consumption. It is a string up to a maximum of 2,000 bytes that uses a conditional expression syntax that is a subset of SQL92. + +> ### Caution: +> When binding to a topic in Durable Topic Endpoint mode: If the selector changes, all messages persisted to the topic endpoint are deleted + + -*Acknowledgment Mode\(Only when using \`Guaranteed\` consumer mode\)* +*Acknowledgment Mode* \(Only when using *Guaranteed* or *Durable Topic Endpoint* consumer mode\) @@ -422,7 +510,7 @@ The strategy to be used when acknowledging messages. The possible options are: -*Settlement Outcome After Maximum Attempts\(Only when using \`Guaranteed\` consumer mode and \`Automatic On Exchange Complete\` acknowledgment mode\)* +*Settlement Outcome After Maximum Attempts* \(Only when using *Guaranteed* or *Durable Topic Endpoint* consumer mode and *Automatic On Exchange Complete* acknowledgment mode\) @@ -448,12 +536,17 @@ Settlement outcome for failed messages after all processing attempts have been e The maximum number of attempts to process a message. +> ### Note: +> This is an adapter level retry and hence will not result in DeliveryCount header increment. DeliveryCount increments only when the message is re-delivered by the event broker. + + + -*Retry Interval \(in ms\)\(Only when using more than 1 maximum message processing attempts\)* +*Retry Interval \(in ms\)* \(Only when using more than 1 maximum message processing attempts\) @@ -465,7 +558,7 @@ The initial time interval to delay retrying to process a message. -*Maximum Retry Interval \(in ms\)\(Only when using more than 1 maximum message processing attempts\)* +*Maximum Retry Interval \(in ms\)* \(Only when using more than 1 maximum message processing attempts\) @@ -477,7 +570,7 @@ The maximum time interval to delay retrying to process a message. -*Exponential Backoff Multiplier\(Only when using more than 1 maximum message processing attempts\)* +*Exponential Backoff Multiplier* \(Only when using more than 1 maximum message processing attempts\) @@ -486,19 +579,29 @@ The multiplier to apply to the current time interval delay after every subsequen - - + -*Message Headers* - - -The adapter accepts headers on both Sender and Receiver side. + -The Sender adds the following headers: ApplicationMessageId, ApplicationMessageType, CoS, CorrelationId, DeliveryCount, Destination, DestinationEndpointType, Expiration, HttpContentEncoding, HttpContentType, IsDiscardIndication, IsDMQEligible, IsElidingEligible, IsRedelivered, IsReplyMessage, Priority, ReceiveTimestamp, ReplicationGroupMessageId, ReplyToEndpointType, ReplyToDestination, SenderId, SenderTimestamp, SequenceNumber, TimeToLive, UserProperties. When setting up the integration flow, add them to the allowlist via Integration Flow -\> Runtime Configuration -\> Allowed Header\(s\), if required. See [Specify the Runtime Configuration](https://help.sap.com/docs/cloud-integration/sap-cloud-integration/specify-runtime-configuration) +## Message Headers - - - +The adapter accepts headers on both sender and receiver side. + +The sender adds the following SMF headers to the Exchange: ApplicationMessageId, ApplicationMessageType, CoS, CorrelationId, DeliveryCount, Destination, DestinationEndpointType, Expiration, HttpContentEncoding, HttpContentType, IsDiscardIndication, IsDMQEligible, IsElidingEligible, IsRedelivered, IsReplyMessage, Priority, ReceiveTimestamp, ReplicationGroupMessageId, ReplyToEndpointType, ReplyToDestination, SenderId, SenderTimestamp, SequenceNumber, TimeToLive, UserProperties. + +In addition to the SMF headers there are some non-SMF headers as well that are added to the Exchange by the sender. + +> ### Note: +> These non-SMF headers are not automatically persisted on the message beyond the Exchange. + +1. LocalProcessingAttempt: The count of processing attempts per delivery of a message from the advanced event mesh Queue or Durable Topic Endpoint. + +2. TotalLocalProcessingAttempt: The total processing attempts for all deliveries which includes redelivery of a message from the advanced event mesh. Note: For the count to be accurate, ensure the DeliveryCount feature is enabled on the respective Queue or Durable Topic Endpoint and all the delivery attempts are made within the same integration flow. + + +When setting up the integration flow, add them to the allowlist. To do that, click the modeling area outside any integration flow shape. Then, choose *Runtime Configuration* \> *Allowed Header\(s\)*, if required. + +See [Specify the Runtime Configuration](https://help.sap.com/docs/cloud-integration/sap-cloud-integration/specify-runtime-configuration) diff --git a/docs/ISuite/50-Development/configure-the-amqp-receiver-adapter-d5660c1.md b/docs/ISuite/50-Development/configure-the-amqp-receiver-adapter-d5660c1.md index 4600c2cc..7bd1b7a2 100644 --- a/docs/ISuite/50-Development/configure-the-amqp-receiver-adapter-d5660c1.md +++ b/docs/ISuite/50-Development/configure-the-amqp-receiver-adapter-d5660c1.md @@ -220,7 +220,7 @@ Select the authentication method the message broker supports. *SASL* is selected > ### Note: > This authentication option implies that Transport Layer Security \(TLS\) is used for the connection. - More information: + More information: - *None* @@ -390,3 +390,5 @@ There are two options for forwarding the message header name: [Blog: Cloud Integration – How to Connect to an On-Premise AMQP server via Cloud Connector](https://blogs.sap.com/2020/01/17/cloud-integration-how-to-connect-to-an-on-premise-amqp-server-via-cloud-connector/) +[Supported Settings for Specific Message Brokers](supported-settings-for-specific-message-brokers-059bd96.md "Learn how to connect external message brokers using the AMQP adapter.") + diff --git a/docs/ISuite/50-Development/configure-the-amqp-sender-adapter-99ce674.md b/docs/ISuite/50-Development/configure-the-amqp-sender-adapter-99ce674.md index 35e963be..88248107 100644 --- a/docs/ISuite/50-Development/configure-the-amqp-sender-adapter-99ce674.md +++ b/docs/ISuite/50-Development/configure-the-amqp-sender-adapter-99ce674.md @@ -16,7 +16,7 @@ You use the Advanced Message Queuing Protocol \(AMQP\) sender adapter to consume > To use the latest version of a flow step or adapter – edit your integration flow, delete the flow step or adapter, add the step or adapter, and configure the same. Finally, redeploy the integration flow. See: [Updating your Existing Integration Flow](updating-your-existing-integration-flow-1f9e879.md). > ### Note: -> Queues, topics, and messages can only be monitored by using tools provided by the message broker provider. Those monitors are not integrated into SAP Integration Suite. In SAP Integration Suite, the integration flows using the AMQP adapter are monitored and the messages are sent to or consumed from the message broker. +> Queues, topics, and messages can only be monitored by using tools provided by the message broker provider. Those monitors are not integrated into SAP Integration Suite . Using SAP Integration Suite , you can only monitor the integration flows using the AMQP adapter and the messages that are sent to or consumed from the message broker. > ### Note: > To be able to connect to queues, you have to create queues and/or topics in the message broker. This needs to be done in the message broker, with the configuration tools provided by the message broker. In some messaging systems, you need to configure a *Lock Duration* to make sure that the message is not consumed more than once. This timeout must be longer than the expected processing time of the message, otherwise this would lead to duplicate messages. @@ -220,7 +220,7 @@ Select the authentication method the message broker supports. *SASL* is selected > ### Note: > This authentication option implies that Transport Layer Security \(TLS\) is used for the connection. - More information: + More information: - *None* @@ -363,10 +363,10 @@ By default, this option is deactivated. Define the number of retries to be executed before a different delivery status is sent to the message broker. -Default nalue is set to `0`, maximum value is `99`. +Default value is set to `5`, maximum value is `99`. > ### Note: -> With the default setting \(`0`\), any message that is marked as a retried message is directly returning the outcome configured in *Delivery Status After Max. Retries* to the message broker and does not even start processing the message. Be aware of the fact that any delivery attempt by the message broker, even a failed one \(for example, due to network issues\), increases the delivery counter of the message sent by the message broker. +> If this parameter is set to \(`0`\), any message that is marked as a retried message is directly returning the outcome configured in *Delivery Status After Max. Retries* to the message broker and does not even start processing the message. Be aware of the fact that any delivery attempt by the message broker, even a failed one \(for example, due to network issues\), increases the delivery counter of the message sent by the message broker. > > If the value is set to a number bigger than `0`, the AMQP adapter returns the outcome configured in *Delivery Status After Max. Retries* to the message broker if the delivery count of the message exceeds the configured value. Otherwise, it processes the message and returns a released outcome in case of an error and an accepted outcome in case of a successful message processing. > @@ -396,7 +396,9 @@ Define one delivery status that is to be sent to the message broker after the ma > ### Note: > See this [general information on AMQP](http://docs.oasis-open.org/amqp/core/v1.0/amqp-core-complete-v1.0.pdf) on delivery statuses and their meaning. > -> See this [blog](https://blogs.sap.com/2019/11/20/cloud-integration-connecting-to-external-messaging-systems-using-the-amqp-adapter/) for a summary of the capabilities supported by the different brokers. +> You can use the following headers to configure a delay in retry processing: `JMSRedelivered` and `JMSXDeliveryCount`. For more information, see the SAP Community blog [Cloud Integration – Connecting to Messaging Systems using the AMQP Adapter](https://community.sap.com/t5/technology-blogs-by-sap/cloud-integration-connecting-to-messaging-systems-using-the-amqp-adapter/ba-p/13419906). +> +> This blog also contains an overview of the recommended settings for different message brokers. @@ -411,3 +413,5 @@ Define one delivery status that is to be sent to the message broker after the ma [Blog: SAP Cloud Integration – How to Connect to an On-Premise AMQP server via Cloud Connector](https://blogs.sap.com/2020/01/17/cloud-integration-how-to-connect-to-an-on-premise-amqp-server-via-cloud-connector/) +[Supported Settings for Specific Message Brokers](supported-settings-for-specific-message-brokers-059bd96.md "Learn how to connect external message brokers using the AMQP adapter.") + diff --git a/docs/ISuite/50-Development/configure-the-as2-mdn-sender-adapter-c54effe.md b/docs/ISuite/50-Development/configure-the-as2-mdn-sender-adapter-c54effe.md index 98b29668..91f98abc 100644 --- a/docs/ISuite/50-Development/configure-the-as2-mdn-sender-adapter-c54effe.md +++ b/docs/ISuite/50-Development/configure-the-as2-mdn-sender-adapter-c54effe.md @@ -91,7 +91,7 @@ The default value is `ESBMessaging.send`. This role authorizes a sender system t > ### Caution: > The role name must not contain any umlaut characters \(for example, `ä`\). -For more information on user roles, see [Tasks and Permissions](../60-Security/tasks-and-permissions-556d557.md). +For more information on user roles, see [Tasks and Permissions for Cloud Integration](../60-Security/tasks-and-permissions-for-cloud-integration-556d557.md). diff --git a/docs/ISuite/50-Development/configure-the-as2-sender-adapter-5d7ee17.md b/docs/ISuite/50-Development/configure-the-as2-sender-adapter-5d7ee17.md index bad3120d..0ef6c3af 100644 --- a/docs/ISuite/50-Development/configure-the-as2-sender-adapter-5d7ee17.md +++ b/docs/ISuite/50-Development/configure-the-as2-sender-adapter-5d7ee17.md @@ -109,7 +109,7 @@ The default value is `ESBMessaging.send`. This role authorizes a sender system t > ### Caution: > The role name must not contain any umlaut characters \(for example, `ä`\). -For more information on user roles, see [Tasks and Permissions](../60-Security/tasks-and-permissions-556d557.md) . +For more information on user roles, see [Tasks and Permissions for Cloud Integration](../60-Security/tasks-and-permissions-for-cloud-integration-556d557.md) . diff --git a/docs/ISuite/50-Development/configure-the-odata-sender-adapter-de7aee5.md b/docs/ISuite/50-Development/configure-the-odata-sender-adapter-de7aee5.md index 85b78b23..aae8144e 100644 --- a/docs/ISuite/50-Development/configure-the-odata-sender-adapter-de7aee5.md +++ b/docs/ISuite/50-Development/configure-the-odata-sender-adapter-de7aee5.md @@ -94,7 +94,7 @@ Select *Client Certificate* if you want to authorize a user to send OData reques The user role that you're using for authorization. Choose *Select* to get a list of all the available user roles for your tenant and select the one that you want to use. -For more information on user roles, see [Tasks and Permissions](../60-Security/tasks-and-permissions-556d557.md). +For more information on user roles, see [Tasks and Permissions for Cloud Integration](../60-Security/tasks-and-permissions-for-cloud-integration-556d557.md). @@ -159,14 +159,9 @@ To know more about using the adapter from external clients, see: - [Use CSRF Protection](use-csrf-protection-a0765d5.md) -- [Setting Up OAuth Inbound Authentication with Client Credentials Grant for API Clients](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/040d8110293d44b1bfaa75674530d395.html "The API is protected by basic authentication and OAuth.") :arrow_upper_right: +- [OAuth with Client Credentials Grant for API Clients](../40-RemoteSystems/oauth-with-client-credentials-grant-for-api-clients-20e26a8.md) > ### Note: > Upon deployment, the endpoint of an integration artifact with OData Sender Adapter is derived from the name of the artifact. -**Related Information** - - -[Setting Up Inbound HTTP Connections (Integration Flow Processing), Neo Environment](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/778c7e7835ff46408aafe0d499720dc7.html "You can use various sender adapters (for example, the SOAP adapters, the IDoc adapter, and the HTTP adapter) to connect the tenant to a sender system so that the sender can send messages to Cloud Integration over the HTTP protocol.") :arrow_upper_right: - diff --git a/docs/ISuite/50-Development/configure-the-odata-v2-receiver-adapter-c5c2e38.md b/docs/ISuite/50-Development/configure-the-odata-v2-receiver-adapter-c5c2e38.md index 1e3cfb51..e86663fc 100644 --- a/docs/ISuite/50-Development/configure-the-odata-v2-receiver-adapter-c5c2e38.md +++ b/docs/ISuite/50-Development/configure-the-odata-v2-receiver-adapter-c5c2e38.md @@ -27,7 +27,7 @@ OData receiver adapter supports externalization. To externalize the parameters o > > - OData API response code is captured in the `camelhttpresponsecode` header. > -> - OData adapter doesn’t support incoming payload in JSON format. The adapter only supports a payload in XML format. +> - OData adapter doesn’t support incoming payload in JSON format – both the body to be sent and the response from a server. The adapter only supports a payload in XML format. > > - OData adapter doesn't support the word `link` in your payload. The word is reserved for creating reference links. > diff --git a/docs/ISuite/50-Development/configure-the-sftp-receiver-adapter-4ef52cf.md b/docs/ISuite/50-Development/configure-the-sftp-receiver-adapter-4ef52cf.md index 7ecd9b51..7238651b 100644 --- a/docs/ISuite/50-Development/configure-the-sftp-receiver-adapter-4ef52cf.md +++ b/docs/ISuite/50-Development/configure-the-sftp-receiver-adapter-4ef52cf.md @@ -2,7 +2,7 @@ # Configure the SFTP Receiver Adapter -The SFTP receiver adapter connects an SAP Cloud Integration tenant to a remote system using the SSH File Transfer protocol to write files to the system. SSH File Transfer protocol is also referred to as Secure File Transfer protocol \(or SFTP\). +The SFTP receiver adapter connects an SAP Integration Suite tenant to a remote system using the SSH File Transfer protocol to write files to the system. SSH File Transfer protocol is also referred to as Secure File Transfer protocol \(or SFTP\). > ### Note: > In the following cases certain features might not be available for your current integration flow: diff --git a/docs/ISuite/50-Development/configure-the-sftp-sender-adapter-2de9ee5.md b/docs/ISuite/50-Development/configure-the-sftp-sender-adapter-2de9ee5.md index ccc4b9d2..5d51bbaf 100644 --- a/docs/ISuite/50-Development/configure-the-sftp-sender-adapter-2de9ee5.md +++ b/docs/ISuite/50-Development/configure-the-sftp-sender-adapter-2de9ee5.md @@ -2,7 +2,7 @@ # Configure the SFTP Sender Adapter -The SFTP sender adapter connects an SAP Cloud Integration tenant to a remote system using the SSH File Transfer protocol to read files from the system. SSH File Transfer protocol is also referred to as Secure File Transfer protocol \(or SFTP\). +The SFTP sender adapter connects an SAP Integration Suite tenant to a remote system using the SSH File Transfer protocol to read files from the system. SSH File Transfer protocol is also referred to as Secure File Transfer protocol \(or SFTP\). > ### Note: > In the following cases certain features might not be available for your current integration flow: diff --git a/docs/ISuite/50-Development/configure-the-sftp-sender-adapter-used-with-the-poll-enrich-step-1f15fe2.md b/docs/ISuite/50-Development/configure-the-sftp-sender-adapter-used-with-the-poll-enrich-step-1f15fe2.md index 0b9d2970..f750ee18 100644 --- a/docs/ISuite/50-Development/configure-the-sftp-sender-adapter-used-with-the-poll-enrich-step-1f15fe2.md +++ b/docs/ISuite/50-Development/configure-the-sftp-sender-adapter-used-with-the-poll-enrich-step-1f15fe2.md @@ -2,7 +2,7 @@ # Configure the SFTP Sender Adapter Used with the Poll Enrich Step -The SFTP sender adapter connects an SAP Cloud Integration tenant to a remote system using the SSH File Transfer protocol to read files from the system. SSH File Transfer protocol is also referred to as Secure File Transfer protocol \(or SFTP\). +The SFTP sender adapter connects an SAP Integration Suite tenant to a remote system using the SSH File Transfer protocol to read files from the system. SSH File Transfer protocol is also referred to as Secure File Transfer protocol \(or SFTP\). > ### Note: > In the following cases certain features might not be available for your current integration flow: diff --git a/docs/ISuite/50-Development/configure-the-soap-sap-rm-sender-adapter-6962234.md b/docs/ISuite/50-Development/configure-the-soap-sap-rm-sender-adapter-6962234.md index 2420fcb5..7aa8732a 100644 --- a/docs/ISuite/50-Development/configure-the-soap-sap-rm-sender-adapter-6962234.md +++ b/docs/ISuite/50-Development/configure-the-soap-sap-rm-sender-adapter-6962234.md @@ -195,13 +195,11 @@ Select the *Conditions* tab and provide values in the fields as follows. **Related Information** -[Read and Modify SOAP Headers](read-and-modify-soap-headers-8a2827d.md "You can use the Script step to address SOAP headers.") + [Setting Up Principal Propagation \(Example Scenario\)](../40-RemoteSystems/setting-up-principal-propagation-example-scenario-34eff84.md "Use principal propagation to forward the principal (identity of a user) across several connections in a complex system landscape.") [https://wiki.scn.sap.com/wiki/display/ABAPConn/Plain+SOAP?original\_fqdn=wiki.sdn.sap.com](https://wiki.scn.sap.com/wiki/display/ABAPConn/Plain+SOAP?original_fqdn=wiki.sdn.sap.com) -[Defining Permissions for Senders to Process Messages on a Runtime Node](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/24585cc503334e6c917ef383efb5558a.html "") :arrow_upper_right: - -[Setting Up Inbound HTTP Connections (Integration Flow Processing), Neo Environment](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/778c7e7835ff46408aafe0d499720dc7.html "You can use various sender adapters (for example, the SOAP adapters, the IDoc adapter, and the HTTP adapter) to connect the tenant to a sender system so that the sender can send messages to Cloud Integration over the HTTP protocol.") :arrow_upper_right: +[Setting Up Inbound HTTP Connections \(Integration Flow Processing\)](../40-RemoteSystems/setting-up-inbound-http-connections-integration-flow-processing-0f92842.md "Enable a sender system to send messages to Cloud Integration over the HTTP protocol.") diff --git a/docs/ISuite/50-Development/configure-the-soap-soap-1-x-receiver-adapter-57f7b34.md b/docs/ISuite/50-Development/configure-the-soap-soap-1-x-receiver-adapter-57f7b34.md index 52cdbde2..000a29d4 100644 --- a/docs/ISuite/50-Development/configure-the-soap-soap-1-x-receiver-adapter-57f7b34.md +++ b/docs/ISuite/50-Development/configure-the-soap-soap-1-x-receiver-adapter-57f7b34.md @@ -168,7 +168,7 @@ To select the WSDL from a source, you have the following options: - Select a WSDL from your file system. -- Select a WSDL from your integration flow resources \(see: [Manage Resources of an Integration Flow](manage-resources-of-an-integration-flow-b5968b2.md)\). +- Select a WSDL from your integration flow resources \(see: [Manage Resources](manage-resources-b5968b2.md)\). In the *Resources* view, you can upload an individual WSDL file or an archive file \(file ending with `.zip`\) that contains multiple WSDLs or XSDs, or both. For example, you can upload a WSDL that contains an imported XSD referenced by an `xsd:import` statement. This means that if you want to upload a WSDL and dependent resources, you need to add the parent file along with its dependencies in a single archive \(`.zip` file\). diff --git a/docs/ISuite/50-Development/configure-the-soap-soap-1-x-sender-adapter-a178913.md b/docs/ISuite/50-Development/configure-the-soap-soap-1-x-sender-adapter-a178913.md index 516838f4..86a0f63f 100644 --- a/docs/ISuite/50-Development/configure-the-soap-soap-1-x-sender-adapter-a178913.md +++ b/docs/ISuite/50-Development/configure-the-soap-soap-1-x-sender-adapter-a178913.md @@ -147,7 +147,7 @@ To select the WSDL from a source, you've the following options: - Select a WSDL from your file system. -- Select a WSDL from your integration flow resources \(see [Manage Resources of an Integration Flow](manage-resources-of-an-integration-flow-b5968b2.md)\). +- Select a WSDL from your integration flow resources \(see [Manage Resources](manage-resources-b5968b2.md)\). In the *Resources* view, you can upload an individual WSDL file or an archive file \(file ending with `.zip`\) that contains multiple WSDLs or XSDs, or both. For example, you can upload a WSDL that contains an imported XSD referenced by an `xsd:import` statement. This means that if you want to upload a WSDL and dependent resources, you need to add the parent file along with its dependencies in a single archive \(`.zip` file\). diff --git a/docs/ISuite/50-Development/configuring-sender-channel-with-ebms3-pull-4f5ddb3.md b/docs/ISuite/50-Development/configuring-sender-channel-with-ebms3-pull-4f5ddb3.md index 58f2f7fe..749a1b61 100644 --- a/docs/ISuite/50-Development/configuring-sender-channel-with-ebms3-pull-4f5ddb3.md +++ b/docs/ISuite/50-Development/configuring-sender-channel-with-ebms3-pull-4f5ddb3.md @@ -270,6 +270,39 @@ Description +*Verify Username Token* + + + + +Select the relevant option for username token verification in the AS4 message: + +- Dynamic: You can also set the value of this attribute dynamically by using `SAP_AS4_Inbound_Pull_Verify_Response_Username_Token` parameter of partner directory. The valid values are: + - notRequired + - required + +- Not Required: To skip the verification of response message. +- Required + + + + + + + + +*Credential Name* only if *Verify Username Token* isn't selected as *Not Required* + + + + +Define the credential name of the username-password pair specified during the deployment of the security artifact. + + + + + + *Verify Signature* @@ -337,6 +370,48 @@ Description +*Username Token* + + + + +Choose the relevant password type to be used when a username token is generated from credentials. + +- *Dynamic*: To set the values dynamically using `SAP_AS4_Inbound_Response_Username_Token` parameter of partner directory. The valid values are: + - none + - hashedPasswordWithTimestamp + - plainTextPassword + - plainTextPasswordWithTimestamp + + +- *Not Required*: To skip the username token generation. +- *With Hashed Password and Timestamp*: The username and password from the token are added to the XML payload as a plain text and hashed value respectively along with the timestamp. This is the most secure way of adding the username to the payload. +- *With Plain Text Password*: The username and password from the token are added to the XML payload as a plain text. +- *With Plain Text Password and Timestamp*: The username and password from the token are added to the XML payload as a plain text along with the timestamp. + + > ### Recommendation: + > Transmit such payloads over HTTPS transport layer. + + + + + + + + + +*Credential Name* only if *Username Token* isn't selected as *Not Required* + + + + +Define the credential name of the username-password pair specified during the deployment of the security artifact. + + + + + + *Compress Message* diff --git a/docs/ISuite/50-Development/configuring-sender-channel-with-ebms3-push-3dc3907.md b/docs/ISuite/50-Development/configuring-sender-channel-with-ebms3-push-3dc3907.md index 762fdf14..6ddf8651 100644 --- a/docs/ISuite/50-Development/configuring-sender-channel-with-ebms3-push-3dc3907.md +++ b/docs/ISuite/50-Development/configuring-sender-channel-with-ebms3-push-3dc3907.md @@ -234,6 +234,39 @@ Description +*Verify Username Token* + + + + +Select the relevant option for username token verification in the AS4 message: + +- Dynamic: You can also set the value of this attribute dynamically by using `SAP_AS4_Inbound_Verify_Username_Token` parameter of partner directory. The valid values are: + - notRequired + - required + +- Not Required: To skip the verification of response message. +- Required + + + + + + + + +*Credential Name* only if *Verify Username Token* isn't selected as *Not Required* + + + + +Define the credential name of the username-password pair specified during the deployment of the security artifact. + + + + + + *Verify Signature* @@ -325,6 +358,48 @@ Description +*Username Token* + + + + +Choose the relevant password type to be used when a username token is generated from credentials. + +- *Dynamic*: To set the values dynamically using `SAP_AS4_Inbound_Receipt_Username_Token` parameter in partner directory. The valid values are: + - none + - hashedPasswordWithTimestamp + - plainTextPassword + - plainTextPasswordWithTimestamp + + +- *Not Required*: To skip the username token generation. +- *With Hashed Password and Timestamp*: The username and password from the token are added to the XML payload as a plain text and hashed value respectively along with the timestamp. This is the most secure way of adding the username to the payload. +- *With Plain Text Password*: The username and password from the token are added to the XML payload as a plain text. +- *With Plain Text Password and Timestamp*: The username and password from the token are added to the XML payload as a plain text along with the timestamp. + + > ### Recommendation: + > Transmit such payloads over HTTPS transport layer. + + + + + + + + + +*Credential Name* only if *Username Token* isn't selected as *Not Required* + + + + +Define the credential name of the username-password pair specified during the deployment of the security artifact. + + + + + + *Signing* diff --git a/docs/ISuite/50-Development/configuring-sender-channel-with-ebms3-receipt-428ae65.md b/docs/ISuite/50-Development/configuring-sender-channel-with-ebms3-receipt-428ae65.md index c957a9c9..8677bd61 100644 --- a/docs/ISuite/50-Development/configuring-sender-channel-with-ebms3-receipt-428ae65.md +++ b/docs/ISuite/50-Development/configuring-sender-channel-with-ebms3-receipt-428ae65.md @@ -120,6 +120,39 @@ Description +*Verify Username Token* + + + + +Select the relevant option for username token verification in the AS4 message: + +- Dynamic: You can also set the value of this attribute dynamically by using `SAP_AS4_Inbound _Receipt_Verify_Username_Token` parameter of partner directory. The valid values are: + - notRequired + - required + +- Not Required: To skip the verification of response message. +- Required + + + + + + + + +*Credential Name* only if *Verify Username Token* isn't selected as *Not Required* + + + + +Define the credential name of the username-password pair specified during the deployment of the security artifact. + + + + + + *Save Incoming Receipt* @@ -319,12 +352,12 @@ You can set an upper limit on that value to avoid an endless increase of the ret *Dead-Letter Queue* -\(only if as *Temporary Storage* the option *JMS Queue* is selected\) +\(only if as *Temporary Storage**JMS Queue* is selected\) -Select this option to place the message in the dead-letter queue if it cannot be processed after three retries caused by an out-of-memory. Processing of the message is stopped then. +Select this option to place the message in the dead-letter queue if it cannot be processed after three retries caused by an out-of-memory. Processing of the message is stopped then. the option In such cases, a lock entry is created which you can view and release in the *Monitor* section of the Web UI under *Managing Locks*. @@ -348,7 +381,7 @@ Select this option in case the messages should be stored in an encrypted way dur -Select the *Conditions* tab and provide values in the fields as follows. +Select the *Conditions* the option tab and provide values in the fields as follows. **Conditions** diff --git a/docs/ISuite/50-Development/consuming-function-library-in-message-mapping-d4dcb4a.md b/docs/ISuite/50-Development/consuming-function-library-in-message-mapping-d4dcb4a.md index b053a2b5..0b513eb0 100644 --- a/docs/ISuite/50-Development/consuming-function-library-in-message-mapping-d4dcb4a.md +++ b/docs/ISuite/50-Development/consuming-function-library-in-message-mapping-d4dcb4a.md @@ -26,7 +26,7 @@ Understand how to consume a function library object in a message mapping flow st 1. Open the integration flow that contains the message mapping flow step in edit mode. -2. In the property sheet of the integration flow, under the *References* tab, create a reference to a Function Libraries artifact. See: [Manage Resources of an Integration Flow](manage-resources-of-an-integration-flow-b5968b2.md). +2. In the property sheet of the integration flow, under the *References* tab, create a reference to a Function Libraries artifact. See: [Manage Resources](manage-resources-b5968b2.md). 3. In the property sheet of the message mapping step, choose the *Processing* tab. diff --git a/docs/ISuite/50-Development/consuming-imported-archives-e7562a7.md b/docs/ISuite/50-Development/consuming-imported-archives-e7562a7.md new file mode 100644 index 00000000..e7d3a7eb --- /dev/null +++ b/docs/ISuite/50-Development/consuming-imported-archives-e7562a7.md @@ -0,0 +1,102 @@ + + +# Consuming Imported Archives + +Understand how to consume an imported archive object in a Function Libraries artifact. + + + + + +## Prerequisites + +1. [Reuse Imported Archives Objects from ES Repository](reuse-imported-archives-objects-from-es-repository-4196091.md) + +2. Deploy the Imported Archives artifact. + + + + + + +## Context + +Consuming an imported archive object is a two-step process: + +1. Create an artifact-to-artifact reference – create a reference from the Function Libraries artifact to the Imported Archives artifact. You can refer to the same Imported Archives artifact from multiple Function Libraries artifacts. + +2. Use the archive in a function library object – add the archive object to one of the function library objects. You can add the same archive object to multiple function library objects. + + + + + + +## Creating a Reference With Function Libraries Artifact + + + + + +## Prerequisites + +[Import Function Library from ES Repository](import-function-library-from-es-repository-d6e7585.md) + + + + + +## Procedure + +1. Open the Function Libraries artifact in edit mode. + +2. In the left-side resource pane, choose the *References* tab. + +3. Choose *Add References* \> *Imported Archives*. + +4. Choose one or more integration packages. + + All Imported Archives available in the selected packages appear. + +5. Choose one or more Imported Archives artifacts based on your requirement and choose *OK*. + +6. Choose *Save* to save the Function Libraries artifact. + + + + + + +## Add an Imported Archive Object To The Function Library Object + + + + + +## Procedure + +1. Open the Function Libraries artifact in edit mode. + +2. In the left-side resource pane, choose the *Function Libraries* tab. + +3. Choose a function library object. + + The java class opens up in the editor. + +4. In the right side editor, choose the *Archives Used* tab. + +5. Choose *Add* and select an imported archive. Choose *OK*. + +6. Change the code for loading the archive object. + + The default line of code that comes with an ESR object is as follows: + + `InputStream in = this.getClass().getClassLoader().getResourceAsStream("com/customer/appl/MyConfig.properties");` + + For the function library object to be able to rightly fetch the imported archive object in Integration Suite, change the existing code line as follows: + + `InputStream in = super.loadResourceFromArchive("ID of the Imported Archive artifact", "path of the file in archive");`. + +7. Choose *Save* to keep your changes and add archive object to the Function Libraries artifact. + + diff --git a/docs/ISuite/50-Development/consuming-message-types-in-message-mapping-34f6345.md b/docs/ISuite/50-Development/consuming-message-types-in-message-mapping-34f6345.md index c7f62f1c..526839f1 100644 --- a/docs/ISuite/50-Development/consuming-message-types-in-message-mapping-34f6345.md +++ b/docs/ISuite/50-Development/consuming-message-types-in-message-mapping-34f6345.md @@ -26,7 +26,7 @@ Understand how to consume a message type artifact in a message mapping flow step 1. Open the integration flow that contains the message mapping flow step in edit mode. -2. In the property sheet of the integration flow, under the *References* tab, create a reference to a Message Type artifact. See: [Manage Resources of an Integration Flow](manage-resources-of-an-integration-flow-b5968b2.md). +2. In the property sheet of the integration flow, under the *References* tab, create a reference to a Message Type artifact. See: [Manage Resources](manage-resources-b5968b2.md). 3. In the property sheet of the message mapping step, choose the *Processing* tab. diff --git a/docs/ISuite/50-Development/content-transport-using-cloud-transport-management-d458b17.md b/docs/ISuite/50-Development/content-transport-using-cloud-transport-management-d458b17.md index f0e0cb98..da49b30d 100644 --- a/docs/ISuite/50-Development/content-transport-using-cloud-transport-management-d458b17.md +++ b/docs/ISuite/50-Development/content-transport-using-cloud-transport-management-d458b17.md @@ -35,7 +35,7 @@ Here's how you can transport content to Cloud Transport Management: 2. Choose *Transport*. - If you don't see the *Transport* button, contact your tenant administrator to enable transport option in the tenant settings. For more information on the roles, see [Configuring User Access to Cloud Integration](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/ed6033b2eabe4a64a20cce1e6076bacf.html "Create and modify application roles and assign users to these roles.") :arrow_upper_right: and [Tasks and Permissions](../60-Security/tasks-and-permissions-556d557.md). + If you don't see the *Transport* button, contact your tenant administrator to enable transport option in the tenant settings. For more information on the roles, see [Tasks and Permissions for Cloud Integration](../60-Security/tasks-and-permissions-for-cloud-integration-556d557.md). 3. In the *Transport Comments* prompt, you can see the type of transport under the *Mode* field configured by the tenant administrator. Provide comments under the *Comments* field and choose *Transport*. diff --git a/docs/ISuite/50-Development/content-transport-using-cts-3cdfb51.md b/docs/ISuite/50-Development/content-transport-using-cts-3cdfb51.md index 69b911f2..563e455f 100644 --- a/docs/ISuite/50-Development/content-transport-using-cts-3cdfb51.md +++ b/docs/ISuite/50-Development/content-transport-using-cts-3cdfb51.md @@ -11,9 +11,9 @@ > ### Note: > This information is relevant only when you use SAP Cloud Integration in the Cloud Foundry environment. -- You've set the *Transport Mode* as *CTS+* in the tenant *Transport* settings. For more information, see [Enabling Content Transport, Cloud Foundry Environment](enabling-content-transport-cloud-foundry-environment-452c677.md). +- You've set the *Transport Mode* as *CTS+* in the tenant Solutions Lifecycle Management*Transport* settings. For more information, see [Enabling Content Transport, Cloud Foundry Environment](enabling-content-transport-cloud-foundry-environment-452c677.md). -- You've created two HTTP destinations on *Solutions Lifecycle Management*. One for the tenant management node. For more information, see [Creating HTTP Destinations and Transport Route](creating-http-destinations-and-transport-route-94057be.md). The other one is for CTS+ system via cloud connector. For more information, see [Integration with Transport Management Tools](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/905baea4d6c7404290bff6c042184b4e.html?q=Integration%20with%20Transport%20Management%20Tools). +- You've created two HTTP destinations on **Solutions Lifecycle. One for the tenant management node. For more information, see [Creating HTTP Destinations and Transport Route](creating-http-destinations-and-transport-route-94057be.md). The other one is for CTS+ system via cloud connector. For more information, see [Integration with Transport Management Tools](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/905baea4d6c7404290bff6c042184b4e.html?q=Integration%20with%20Transport%20Management%20Tools). - You've the role *WorkspacePackagesTransport* for CF or *IntegrationContent.Transport* for Neo assigned. @@ -32,7 +32,7 @@ SAP Cloud Integration provides an option to transport integration content direct 2. Choose *Transport*. - If you don't see the *Transport* button, contact your tenant administrator to enable transport option in the tenant settings. For more information on the roles, see [Configuring User Access to Cloud Integration](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/ed6033b2eabe4a64a20cce1e6076bacf.html "Create and modify application roles and assign users to these roles.") :arrow_upper_right: and [Tasks and Permissions](../60-Security/tasks-and-permissions-556d557.md). + If you don't see the *Transport* button, contact your tenant administrator to enable transport option in the tenant settings. For more information on the roles, see [Tasks and Permissions for Cloud Integration](../60-Security/tasks-and-permissions-for-cloud-integration-556d557.md). 3. In the *Transport Comments* prompt, you can see the type of transport under the *Mode* field configured by the tenant administrator. Provide comments under the *Comments* section and choose *Transport*. diff --git a/docs/ISuite/50-Development/content-transport-using-mtar-download-c111710.md b/docs/ISuite/50-Development/content-transport-using-mtar-download-c111710.md index 541eddd2..6b2128d8 100644 --- a/docs/ISuite/50-Development/content-transport-using-mtar-download-c111710.md +++ b/docs/ISuite/50-Development/content-transport-using-mtar-download-c111710.md @@ -29,7 +29,7 @@ You can use the *MTAR Download* option to download a MTAR file/s of the integrat 2. Choose *Transport*. - If you don't see the *Transport* button, contact your tenant administrator to enable transport option in the tenant settings. For more information on the roles, see [Configuring User Access to Cloud Integration](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/ed6033b2eabe4a64a20cce1e6076bacf.html "Create and modify application roles and assign users to these roles.") :arrow_upper_right: and [Tasks and Permissions](../60-Security/tasks-and-permissions-556d557.md). + If you don't see the *Transport* button, contact your tenant administrator to enable transport option in the tenant settings. For more information on the roles, see [Tasks and Permissions for Cloud Integration](../60-Security/tasks-and-permissions-for-cloud-integration-556d557.md). 3. In the *Transport Comments* prompt, you can see the type of transport under the *Mode* field configured by the tenant administrator. Provide comments under the *Comments* section and choose *Transport*. diff --git a/docs/ISuite/50-Development/conversion-rules-for-xml-to-json-conversion-66d099d.md b/docs/ISuite/50-Development/conversion-rules-for-xml-to-json-conversion-66d099d.md index 0b9e93d5..2e723107 100644 --- a/docs/ISuite/50-Development/conversion-rules-for-xml-to-json-conversion-66d099d.md +++ b/docs/ISuite/50-Development/conversion-rules-for-xml-to-json-conversion-66d099d.md @@ -92,7 +92,7 @@ The conversion from XML format to JSON format follows the following rules: [How Streaming in the XML-to-JSON Converter Works](how-streaming-in-the-xml-to-json-converter-works-4e05044.md "During streaming the XML document is processed in parts or segments:") - + - + diff --git a/docs/ISuite/50-Development/copy-an-api-proxy-23974d6.md b/docs/ISuite/50-Development/copy-an-api-proxy-23974d6.md index cf9e6f0d..05a5c496 100644 --- a/docs/ISuite/50-Development/copy-an-api-proxy-23974d6.md +++ b/docs/ISuite/50-Development/copy-an-api-proxy-23974d6.md @@ -34,7 +34,7 @@ To copy an API proxy, proceed as follows: 3. On the *APIs* tab page, choose the Action icon against the required API and then select the *Copy* option. Alternatively, you can open the required API and in the details page select the option *Copy*. -4. In the *Copy API* dialog box, the details for each attribute is pre filled. *Name* and *API Base Path* fields should be unique. So, it is required to change the API name and basepath values. The values for the remaining fields can either be retained or changed. +4. In the *Copy API*, the details for each attribute is pre filled. The *Name* and *API Base Path* fields should be unique. So, it is required to change the API *Name* and *API Base Path* values. The values for the remaining fields \(*Title*, *Short Text*, *API State*, and *Host Alias*\) can either be reatined or changed. 1. Optional: Enter a version for your API proxy. diff --git a/docs/ISuite/50-Development/coupa-receiver-adapter-648ac01.md b/docs/ISuite/50-Development/coupa-receiver-adapter-648ac01.md new file mode 100644 index 00000000..c3fe72ca --- /dev/null +++ b/docs/ISuite/50-Development/coupa-receiver-adapter-648ac01.md @@ -0,0 +1,407 @@ + + +# Coupa Receiver Adapter + +The Coupa receiver adapter connects SAP Integration Suite to Coupa. Coupa is a business spending management software. The Coupa adapter helps you exchange data between the two systems. + +> ### Note: +> This adapter is available on SAP Business Accelerator Hub. +> +> For more information, see [Consuming Integration Adapters from SAP Business Accelerator Hub](consuming-integration-adapters-from-sap-business-accelerator-hub-b9250fb.md). +> +> The availability of the adapter is dependent on your SAP Integration Suite service plan. For more information about different service plans and their supported feature set, see SAP Notes [2903776](https://launchpad.support.sap.com/#/notes/2903776) and [3188446](https://launchpad.support.sap.com/#/notes/3188446). + +> ### Note: +> This adapter exchanges data with a remote component that might be outside the scope of SAP. Make sure that the data exchange complies with your company’s policies. + + + + + +## How the Coupa Receiver Adapter Works + +If you have configured a Coupa receiver adapter, the data exchange is performed as follows at runtime: The SAP through SAP Integration Suite tenant sends the request to Coupa \(this is a receiver system\), the Coupa works on the request and sends back the data to the SAP. + +For Example, SAP S4/HANA generates and pushes the list of suppliers to be copied to Coupa. SAP Integration Suite receives the request and transforms it to the Coupa format. SAP Integration Suite then queries the existing suppliers in Coupa, updates the data for them, and creates a new supplier for the non-existent suppliers. + +The following diagram illustrates the example. + +![](images/Coupa_Receiver_Adapter_dccbe44.png) + + + + + +## Configuring the Coupa Receiver Adapter + +Once you have created a receiver channel and selected the Coupa receiver adapter, you can configure the following attributes. + +Select the *Connection* tab. + +The *Connection* tab contains the connection and the authentication parameters for the Coupa. The adapter supports only OAuth 2.0 authentication type. + +**Connection** + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +Parameter + + + +Description + +
+ +*Address* + + + +Specifies the recipient's endpoint URL, this is Coupa tenant’s URL of the organization. + +Example: + +`https://.coupacloud.com` + +
+ +*OAuth Credential Name* + + + +Specifies the name of the *User Credentials* artifact configured or saved under *Monitor* \> *Manage Security* \> *Security Material*. It contains the Coupa OAuth key and client secret pair. This property enables the system to fetch the security token from the keystore for authentication. + +
+ +*Scopes* + + + +Specifies the permissions configured in Coupa. Enter the different scope values with a space in between. + +Example: + +`core.accounting.read core.account.write core.budgeting.write` + +
+ +*Connection Timeout* + + + +Specifies the connection timeout in milliseconds. This timeout allows the user to configure the maximum waiting time for the connection to be established between SAP and Coupa. + +Example: + +`3000` + +
+ +*Response Timeout* + + + +Specifies the response timeout in milliseconds. This timeout allows the user to configure the maximum waiting time for SAP until a response is received from Coupa. + +Example: + +`3000` + +
+ +The *Processing* tab contains all operation configurations for the Coupa adapter. + +**Processing** + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +Parameter + + + +Description + +
+ +*Operation* + + + +To access and exchange data with Coupa, you can choose one of the provided operations. Here, you specify the type of action you want to run in Coupa. + +
+ +*Resource* + + + +Select the name of the Coupa resources to perform the API operation. It can be any of the Coupa defined resources like reference data resource, transactional resources or shared resources or any user defined custom object resources. This is an editable dropdown field. You can manually add any other resources that are not listed in the dropdown. + +> ### Note: +> Since the dropdown is editable, ensure you do not leave the operation field blank. + + + +
+ +*Resource Parameters* + + + +To specify the resource key and value in case resource path included parameters. For example, if Account/:id is the resource, name should be specified with `id`, and `` value should be specified as corresponding value pair. This is mostly used in Get Resources, Modify Resources and Update Resource Operations. + +
+ +*Return Object Fields* + + + +To specify only the set of fields to be passed in the response payload. The return objects format should be in JSON. + +For example: + +`["firstname","lastname",{"roles":["id","name"]}]` + +
+ +*Payload Format* + + + +Specifies the format of the request message to be sent to and the response to be returned from Coupa. Values include *Application/XML* and *Application/JSON*. + +Default value: *Application/XML* + +
+ +*Data from Attachment* + + + +Specify whether the attachment object should be obtained from an attachment of the message exchange in SAP Integration Suite or the from the body in SAP Integration Suite. + +> ### Note: +> The Create Resource operation allows working with attachments. After selecting a resource including attachments such as invoices/:invoice\_id/attachment, additional options appear. + + + +
+ +*Attachment Name* + + + +When selecting data from attachment, specify the name of the attachment on the exchange in SAP Integration Suite to retrieve the file. + +Example: + +`Filename.zip, ${property.filename}.zip` + +This field appears when you select *Data from Attachment*. + +
+ +*File Name* + + + +Specify the name of the file to be uploaded to Coupa. + +
+ +*Type* + + + +Specify the attachment type expected by Coupa. + +Default value: *file* + +
+ +*Attachment Properties* + + + +Specify the key and value in case attachment includes parameters. You can add Property Name and Property Value pairs for various fields like file-url, linked-to, intent, text, url. + +
+ +*Limit* + + + +Specify the limit to query records with maximum of 50 records. + +Example: `20` + +When auto pagination is enabled the limit value does not work as all the records will be queried or up to the pre-defined limit value of 100. + +> ### Note: +> Query Resource operation allows querying of any Coupa Resource. After selecting this operation additional fields appear that help you to customize your query requests. + + + +
+ +*Offset* + + + +Specify the offset value for the number of records to be acquired after. + +Example: `20` + +
+ +*Auto Pagination* + + + +Enable to retrieve all the records in case the query result has more than one page of records. + +
+ +*Query Filter Parameter* + + + +Specify the querying parameters to use to retrieve the records. + +This parameter has the following options: + +- *Name* + +- *Operator* + +- *Value* + + +Example: + +`Name Contains Created date` + +`Operator Contains Greater Than` + +`Value Contains 2202-01-01` + +
+ +*Order by Field* + + + +Specify the field or resource property to perform the sorting of the queried records. + +
+ +*Sorting Direction* + + + +Specify the sorting order of the records. There are the following options: + +- *Ascending* + +- *Descending* + + +The default value is *Ascending*. + +
+ diff --git a/docs/ISuite/50-Development/create-a-connection-request-for-the-centralized-api-business-hub-enterprise-classic-desig-02f7877.md b/docs/ISuite/50-Development/create-a-connection-request-for-the-centralized-api-business-hub-enterprise-classic-desig-02f7877.md index d6b0a758..966b73c6 100644 --- a/docs/ISuite/50-Development/create-a-connection-request-for-the-centralized-api-business-hub-enterprise-classic-desig-02f7877.md +++ b/docs/ISuite/50-Development/create-a-connection-request-for-the-centralized-api-business-hub-enterprise-classic-desig-02f7877.md @@ -12,6 +12,9 @@ Create a request to connect the Integration Suite API Management tenant to the A ## Prerequisites +> ### Caution: +> Effective June 2024, the classic design of the API business hub enterprise will be deprecated and will no longer be accessible. The new design of the API business hub enterprise will be set as your default design from March 2024. For more information, see [Configure the API business hub enterprise \[New Design\]](configure-the-api-business-hub-enterprise-new-design-54b4607.md). + - To establish connections between the API business hub enterprise and Integration Suite API Management tenants, a Cloud Foundry space should be created in the sub-account from where the API business hub enterprise is hosted. - To establish a connection between an Integration Suite API Management tenant and the centralised API business hub enterprise which is available in a different sub-account, you must ensure that the API business hub enterprise capability is not enabled in the same sub-account as that of the Integration Suite API Management tenant . diff --git a/docs/ISuite/50-Development/create-a-rate-plan-b57bc3b.md b/docs/ISuite/50-Development/create-a-rate-plan-b57bc3b.md index d59c0a82..fb80a947 100644 --- a/docs/ISuite/50-Development/create-a-rate-plan-b57bc3b.md +++ b/docs/ISuite/50-Development/create-a-rate-plan-b57bc3b.md @@ -130,9 +130,9 @@ You are creating a rate plan. **Related Information** -[Attach Rate Plan to a Product](https://help.sap.com/viewer/66d066d903c2473f81ec33acfe2ccdb4/Cloud/en-US/cc5c942e32df494785c33ba0fc0346f4.html "Attach a rate plan to a product using the API portal.") :arrow_upper_right: + -[Update a Rate Plan](https://help.sap.com/viewer/66d066d903c2473f81ec33acfe2ccdb4/Cloud/en-US/b8c1e6b68be74ead8700f7f8be9baa8b.html "Update a rate plan using the API portal.") :arrow_upper_right: + -[Delete a Rate Plan](https://help.sap.com/viewer/66d066d903c2473f81ec33acfe2ccdb4/Cloud/en-US/d4181ad418e4446e830c498d672204ff.html "Delete a rate plan using the API portal.") :arrow_upper_right: + diff --git a/docs/ISuite/50-Development/create-an-api-provider-6b263e2.md b/docs/ISuite/50-Development/create-an-api-provider-6b263e2.md index 9905e969..942071d8 100644 --- a/docs/ISuite/50-Development/create-an-api-provider-6b263e2.md +++ b/docs/ISuite/50-Development/create-an-api-provider-6b263e2.md @@ -51,7 +51,11 @@ If you want to configure the API Management solution to access data from a serve 3. Choose *Create*. -4. Enter a name and a description for the API provider. + ![](images/CreateImage1_3bf6c81.png) + +4. Enter a name and a description for the API provider in the *Overview* section. + + ![](images/OverviewImage2_9550dd7.png) > ### Note: > Do not use the names mentioned in following list: @@ -79,8 +83,12 @@ If you want to configure the API Management solution to access data from a serve - Choose *Open Connectors* to connect third-party APIs via harmonized RESTful APIs. - Choose *Cloud Integration* to access all the service endpoints. + ![](images/ConnectListImage3_06ef74d.png) + - *Internet* connection type: + ![](images/InternetImage4_354b74e.png) + **Internet** @@ -423,6 +431,8 @@ If you want to configure the API Management solution to access data from a serve 6. In the *CATALOG SERVICE SETTINGS* section, enter the required details. + ![](images/CatalogImage5_49e100b.png) + **Catalog Service Settings** @@ -497,9 +507,11 @@ If you want to configure the API Management solution to access data from a serve > ### Note: > Catalog service settings aren’t applicable for Open Connectors type connection and SAP Cloud Integration. -7. Save the changes. +7. *Save* the changes. + + Choose *Configure* \> *API Provider* to view the newly created API provider. Further, you can test the connection of the API provider, by navigating to the API provider's details page and selecting *Test Connection*. - Choose*Configure* \> *API Provider* to view the newly created API provider. Further, you can test the connection of the API provider, by navigating to the API provider's details page and selecting *Test Connection*. + ![](images/TestConnectionImage6_82dccf5.png) > ### Note: > The following table lists the attributes considered for testing the connection: diff --git a/docs/ISuite/50-Development/create-an-api-proxy-based-on-an-existing-api-proxy-54831ca.md b/docs/ISuite/50-Development/create-an-api-proxy-based-on-an-existing-api-proxy-54831ca.md index 1324289d..1aa84916 100644 --- a/docs/ISuite/50-Development/create-an-api-proxy-based-on-an-existing-api-proxy-54831ca.md +++ b/docs/ISuite/50-Development/create-an-api-proxy-based-on-an-existing-api-proxy-54831ca.md @@ -20,20 +20,23 @@ If you want to browse for an existing API proxy, proceed as follows: Create an A 6. Select the required API proxy. -7. Enter a name and description for the API. + > ### Note: + > The dropdown list contains the providers that you’re connected to. If the provider you need isn’t listed here, add it on the *Configure* tab. - The dropdown list contains the providers that you’re connected to. If the provider you need isn’t listed here, add it on the *Configure* tab. +7. The details of the API *Name*, *Title*, *API Base Path*, *API State*, *Host Alias* and *Service Type* are automatically populated. -8. Optionally, enter a *Version* for your API proxy. +8. Enter a short introductory text in the *Short Text* field. + +9. Optionally, enter a *Version* for your API proxy. When you choose to version your API proxy, its name is appended with the version, and its basepath are prepended with the version. For example, if the version you enter is v1, the name is Name\_v1, and the basepath is /v1/SalesOrder. For more information, see -9. Select a virtual host alias from the *Host Alias* dropdown. +10. Select a virtual host alias from the *Host Alias* dropdown. -10. In the *API Base Path* field, provide a path prefix for the API. +11. In the *API Base Path* field, provide a path prefix for the API. -11. Choose *Create*. +12. Choose *Create*. -12. Complete the remaining steps by referring to the [Create an API Proxy](create-an-api-proxy-c0842d5.md) topic. +13. Complete the remaining steps by referring to the [Create an API Proxy](create-an-api-proxy-c0842d5.md) topic. diff --git a/docs/ISuite/50-Development/create-an-api-proxy-by-providing-a-direct-target-endpoint-url-d0f5087.md b/docs/ISuite/50-Development/create-an-api-proxy-by-providing-a-direct-target-endpoint-url-d0f5087.md index dd00dc3d..396d35fc 100644 --- a/docs/ISuite/50-Development/create-an-api-proxy-by-providing-a-direct-target-endpoint-url-d0f5087.md +++ b/docs/ISuite/50-Development/create-an-api-proxy-by-providing-a-direct-target-endpoint-url-d0f5087.md @@ -25,7 +25,7 @@ The role collection *APIPortal.Administrator* should be assigned to you. > ### Note: > Ensure that the service URL you provide doesn’t redirect to a different URL. That is, check if the service URL you’re trying to access is temporarily or permanently moved to a different location. If it does so, then it’s recommended that you provide the new location \(redirected URL, if exists\) of the service. For more information about how to handle URL redirection, see [Handling URL Redirects in an API Proxy Using Policies](handling-url-redirects-in-an-api-proxy-using-policies-9e63c01.md). -3. Enter a name and description for the API. +3. Enter the *Name* and *Title*, and provide an introductory text in the *Short Text* field, for the API. 4. Optionally, enter a version for your API Proxy. @@ -55,7 +55,7 @@ The role collection *APIPortal.Administrator* should be assigned to you. > ### Note: > Ensure that the service URL you provide doesn’t redirect to a different URL. That is, check if the service URL you’re trying to access is temporarily or permanently moved to a different location. If it does so, then it’s recommended that you provide the new location \(redirected URL, if exists\) of the service. For more information about how to handle URL redirection, see [Handling URL Redirects in an API Proxy Using Policies](handling-url-redirects-in-an-api-proxy-using-policies-9e63c01.md). -3. Enter a name and description for the API. +3. Enter the *Name* and *Title*, and provide an introductory text in the *Short Text* field, for the API. 4. Optionally, enter a version for your API Proxy. diff --git a/docs/ISuite/50-Development/create-an-api-proxy-by-referring-to-an-api-provider-system-84628b9.md b/docs/ISuite/50-Development/create-an-api-proxy-by-referring-to-an-api-provider-system-84628b9.md index 190b3b24..0bf13337 100644 --- a/docs/ISuite/50-Development/create-an-api-proxy-by-referring-to-an-api-provider-system-84628b9.md +++ b/docs/ISuite/50-Development/create-an-api-proxy-by-referring-to-an-api-provider-system-84628b9.md @@ -32,24 +32,24 @@ If you want to browse for an OData service for a provider that you’ve already Also, since such APIs aren’t linked to any API provider, you can’t use the *Synchronize* option to update the API with the latest version that might be available in the backend. -7. Select a virtual host alias from the *Host Alias* dropdown. +7. The details of the API *Name*, *Title*, *API Base Path*, *API State*, *Host Alias* and *Service Type* are automatically populated. - The details of the API name, description, API base path, and service type are automatically populated. +8. Enter a short introductory text in the *Short Text* field. -8. Optionally, enter a *Version* for your API proxy. +9. Optionally, enter a *Version* for your API proxy. When you choose to version your API proxy, its name is appended with the version, and its basepath are prepended with the version. For example, if the version you enter is v1, the name is Name\_v1, and the basepath is /v1/SalesOrder. For more information, see [API Versioning](api-versioning-b3cda3b.md). -9. Choose *Create*. +10. Choose *Create*. -10. If you want to add SAP documentation annotations to the API documentation, choose *Yes* for *Documentation*. +11. If you want to add SAP documentation annotations to the API documentation, choose *Yes* for *Documentation*. > ### Note: > This field is only displayed if you’re fetching services from SAP Gateway Systems. For more information about SAP documentation annotations, see [Extended Support of Long Texts in the Metadata](http://help.sap.com/saphelp_gateway20sp10/helpdata/en/30/6e8c537c8fcc26e10000000a4450e5/frameset.htm). -11. Choose *Create*. +12. Choose *Create*. -12. Complete the remaining steps by referring to the [Create an API Proxy](create-an-api-proxy-c0842d5.md) topic. +13. Complete the remaining steps by referring to the [Create an API Proxy](create-an-api-proxy-c0842d5.md) topic. @@ -78,18 +78,18 @@ If you want to create a proxy for an Open Connector instance for a provider that Also, since such APIs aren’t linked to any API provider, you can’t use the *Synchronize* option to update the API with the latest version that might be available in the backend. -7. Select a virtual host alias from the *Host Alias* dropdown. - - The details of the API name, description, API base path, and service type are automatically populated. +7. The details of the API *Name*, *Title*, *API Base Path*, *API State*, *Host Alias* and *Service Type* are automatically populated. > ### Note: > Name and basepath shouldn’t contain spaces. -8. Optionally, enter a *Version* for your API proxy. +8. Enter a short introductory text in the *Short Text* field. + +9. Optionally, enter a *Version* for your API proxy. When you choose to version your API proxy, its name is appended with the version, and its basepath are prepended with the version. For example, if the version you enter is v1, the name is Name\_v1, and the basepath is /v1/SalesOrder. For more information, see [API Versioning](api-versioning-b3cda3b.md). -9. Choose *Create*. +10. Choose *Create*. On creating the proxy, an encrypted key value map is created with the following name `apim.oc.instance.token` and key name `default`. Also, an open connector policy is attached to the incoming POST flow request of the target endpoint of the APIProxy. @@ -106,8 +106,8 @@ If you want to create a proxy for an Open Connector instance for a provider that > > - On deleting the proxy, the encrypted key value map created above is also deleted. Further, while exporting the API, encrypted key value map created above isn’t exported with the API. -10. Choose *Create*. +11. Choose *Create*. -11. Complete the remaining steps by referring to the [Create an API Proxy](create-an-api-proxy-c0842d5.md) topic. +12. Complete the remaining steps by referring to the [Create an API Proxy](create-an-api-proxy-c0842d5.md) topic. diff --git a/docs/ISuite/50-Development/create-an-api-proxy-c0842d5.md b/docs/ISuite/50-Development/create-an-api-proxy-c0842d5.md index d9478dac..d12ca823 100644 --- a/docs/ISuite/50-Development/create-an-api-proxy-c0842d5.md +++ b/docs/ISuite/50-Development/create-an-api-proxy-c0842d5.md @@ -258,9 +258,9 @@ Instead of consuming services directly, application developers can access API pr > > For more information on how to define multiple target endpoints using Route Rule, see [Enable Dynamic Routing](enable-dynamic-routing-49cbe91.md). -10. If you want to define multiple target endpoints, navigate to *Target EndPoint* tab. In the *Target Endpoint Properties*section, choose *Add*. +10. To define target endpoint properties, navigate to the *Target EndPoint* tab and choose *Add*. - In the *Target Endpoint Properties*section, choose *Add*. Enter the *Property Name* and the *Values*. For the Target Endpoint property specifications, see [Target Endpoint Properties](target-endpoint-properties-edeed6a.md). + Enter the *Property Name* and the *Values*. For the Target Endpoint property specifications, see [Target Endpoint Properties](target-endpoint-properties-edeed6a.md). 11. Once you’ve filled in all the required details of the API, you can select one of the following two actions for the API: diff --git a/docs/ISuite/50-Development/create-an-application-classic-design-7b4e71b.md b/docs/ISuite/50-Development/create-an-application-classic-design-7b4e71b.md index 895b6d1e..d1572cdd 100644 --- a/docs/ISuite/50-Development/create-an-application-classic-design-7b4e71b.md +++ b/docs/ISuite/50-Development/create-an-application-classic-design-7b4e71b.md @@ -12,7 +12,7 @@ Create an Application to consume the required APIs. **Prerequisites** -- You either have the `AuthGroup.API.ApplicationDeveloper` role or `AuthGroup.API.Admin` role assigned to you. For more information on roles, see [User Roles in API Management \(New\)](../user-roles-in-api-management-new-911ca5a.md). +- You either have the `AuthGroup.API.ApplicationDeveloper` role or `AuthGroup.API.Admin` role assigned to you. For more information on roles, see [Tasks and Corresponding Role Collections](../tasks-and-corresponding-role-collections-911ca5a.md). > ### Note: > The AuthGroup.API.ApplicationDeveloper role must not be assigned manually to a user form the SAP BTP Cockpit and this role must not be a part of any user group assignment. diff --git a/docs/ISuite/50-Development/create-custom-dimensions-and-measures-ba211be.md b/docs/ISuite/50-Development/create-custom-dimensions-and-measures-ba211be.md index 5d462b59..773d8a0f 100644 --- a/docs/ISuite/50-Development/create-custom-dimensions-and-measures-ba211be.md +++ b/docs/ISuite/50-Development/create-custom-dimensions-and-measures-ba211be.md @@ -24,7 +24,7 @@ Perform the step-by-step instructions in this topic to create custom dimensions 3. Choose *OK*. -4. Choose the navigation icon on the left and choose *Design* \> *APIs*. +4. Choose the navigation icon on the left and choose *Configure* \> *APIs*. 5. From the APIs list, choose the required API for which you want to collect data using the custom metric. diff --git a/docs/ISuite/50-Development/creating-a-company-profile-909d928.md b/docs/ISuite/50-Development/creating-a-company-profile-909d928.md index 3b83af30..1944aedc 100644 --- a/docs/ISuite/50-Development/creating-a-company-profile-909d928.md +++ b/docs/ISuite/50-Development/creating-a-company-profile-909d928.md @@ -194,8 +194,12 @@ Follow the next procedure to create a company profile. ## Identifiers -1. Navigate to the *Identifier* tab and choose *Create*. -2. In the resulting dialog, enter the following details. +1. Navigate to the *Identifiers* tab. The tab consists of two sections: + - *Single Identifiers*: These are individual identifiers that have their own type system, scheme and organization etc. If you want to create a single identifier, choose *Create* provided above the *Single Identifiers* table and follow from Step 2 below. + + - *Identifier Groups*: These are identifier groups that have a common Alias, Type System, Agency and Scheme. If you want to create an identifier group, choose *Create* provided above the *Identifiers Groups* table and follow the instructions from Step 4 below. + +2. For Single Identifier, enter the following details. **Identifier** @@ -287,6 +291,104 @@ Follow the next procedure to create a company profile. 3. Choose *Save*. +4. For Identifier Group, maintain the following details: + + **Create Identifier Group** + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + Field Name + + + + Description + +
+ + Group Name + + + + Provide a valid name for the identifier group. + +
+ + Alias + + + + Enter an alias for the identifier. + +
+ + Type System + + + + Choose a type system from the drop-down list. + + > ### Note: + > - For *GS1 XML* type system, you must maintain the contact details in the *Contacts* tab. + > + > - For *Tradacoms* type system for the identifier, the field *Identification* is mandatory. If the sender payload contains both *Identification* and *Name*, the integration flow will consider only *Identification* for the computed Partner Directory ID. + > + > The system ASSEMBLY will use Company profile's *Short Name* for the *Identification Name* + > + > Tradacoms is supported only in the 2.0 version of the integration package *Cloud Integration - Trading Partner Management V2* + + + +
+ + Scheme + + + + Choose a scheme from the drop-down list. + +
+ + Agency + + + + Provide the agency name and code in their respective fields. + +
+ +5. Choose *Save*. The identifier group is created successfully. You need to now add identifiers to it. +6. Open the identifier group from the *Identifier Groups* table. +7. Choose *Edit* to edit the details of the group. +8. Select *Add* above the *Identifiers in Group* to add idenifiers to this group. +9. Maintain the values for *Identification* and *Sub-Organization* fields and choose *Save*. +10. Choose *Activate* to activate the group and publish its identifier details into the partner directory. This step just publishes the content and the identifiers would take effect only if any agreement using the identifier group gets activated. +11. If you make any changes after the activation of the group and want to push the latest changes to the Partner Directory, save your changes and choose *Update*. diff --git a/docs/ISuite/50-Development/creating-a-new-message-implementation-guideline-b894de0.md b/docs/ISuite/50-Development/creating-a-new-message-implementation-guideline-b894de0.md index 24c37c6e..7cda194d 100644 --- a/docs/ISuite/50-Development/creating-a-new-message-implementation-guideline-b894de0.md +++ b/docs/ISuite/50-Development/creating-a-new-message-implementation-guideline-b894de0.md @@ -49,7 +49,7 @@ A message implementation guideline \(MIG\) is the source/target that you use in 3. *Summary*: You can provide a text description of the Message Implementation Guideline \(MIG\). This description is visible as short text documentation in the MIG overview list. - 4. *Business Context*: Select :heavy_plus_sign:, and choose the business context that you want to add. Based on the business context that you add, you're provided with further options in dropdown list. To understand, *Business Context* refer to [Terminology & Glossary for SAP Integration Advisor](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/9c221b48799a4ce59367b0e3367f5a8f.html "") :arrow_upper_right:. + 4. *Business Context*: Select :heavy_plus_sign:, and choose the business context that you want to add. Based on the business context that you add, you're provided with further options in dropdown list. To understand, *Business Context* refer to [Glossary for SAP Integration Advisor](../glossary-for-sap-integration-advisor-9c221b4.md). 8. Choose *Create*. diff --git a/docs/ISuite/50-Development/creating-a-trading-partner-agreement-9bd43c9.md b/docs/ISuite/50-Development/creating-a-trading-partner-agreement-9bd43c9.md index ab2ee407..97267025 100644 --- a/docs/ISuite/50-Development/creating-a-trading-partner-agreement-9bd43c9.md +++ b/docs/ISuite/50-Development/creating-a-trading-partner-agreement-9bd43c9.md @@ -156,7 +156,7 @@ The creation modes apply only for the agreements you newly create. The agreement Select a contact person from the drop-down list. > ### Note: - > You need to have the Business Expert to assign a contact person. To know more on assigning roles, see [Configuring User Access](../configuring-user-access-2c6214a.md). + > You need to have the Business Expert to assign a contact person. To know more on assigning roles, see [Configuring User Access to SAP Integration Suite](../configuring-user-access-to-sap-integration-suite-2c6214a.md). @@ -267,7 +267,7 @@ The creation modes apply only for the agreements you newly create. The agreement Select a contact person from the drop-down list. > ### Note: - > You need to have the Business Expert to assign a contact person. To know more on assigning roles, see [Configuring User Access](../configuring-user-access-2c6214a.md). + > You need to have the Business Expert to assign a contact person. To know more on assigning roles, see [Configuring User Access to SAP Integration Suite](../configuring-user-access-to-sap-integration-suite-2c6214a.md). @@ -363,51 +363,54 @@ The creation modes apply only for the agreements you newly create. The agreement > The application now provides you with the *ProcessDirect* adapter that allows you to use your customised integration flow within the generic integration flow. To know more about how it works, see [Interchange Processing Flow](interchange-processing-flow-7d3bce9.md) 20. The *Enable Payload Validation* checkbox allows the system to validate the incoming payload. Check/Uncheck the option if you want to enable or disable the payload validation. -21. Choose the *Mapping* step. -22. Select a mapping guideline using the value help provided for the field *Mapping Guideline\(MAG\)*. +21. To archive the sender payload, select the checkbox for the field *Archive Sender Payload*. To know more about archiving data, see [Archiving Payload Data](archiving-payload-data-b927e01.md). +22. Choose the *Mapping* step. +23. Select a mapping guideline using the value help provided for the field *Mapping Guideline\(MAG\)*. If you want to view the details of the MAG that you chose, you can use the link provided under the *Version* field. -23. If you want to use custom integration flow for the Mapping process, enable the checkbox for *Customized Mapping Processing* and provide the address of the integration flow under the field *Process Direct Address* field. +24. If you want to use custom integration flow for the Mapping process, enable the checkbox for *Customized Mapping Processing* and provide the address of the integration flow under the field *Process Direct Address* field. > ### Note: > Enabling custom message processing will disable the *Mapping Guideline \(MAG\)* field. > > The application now provides you with the *ProcessDirect* adapter that allows you to use your customised integration flow within the generic integration flow. To know more about how it works, see [Interchange Processing Flow](interchange-processing-flow-7d3bce9.md) -24. Choose the *Communication Channel* on the receiver side and select a value from the drop-down list for the field *Communication*. -25. Select the value for the field *Receiver Functional Acknowledgement Channel*. +25. Choose the *Communication Channel* on the receiver side and select a value from the drop-down list for the field *Communication*. +26. Select the value for the field *Receiver Functional Acknowledgement Channel*. > ### Note: > This field appears only for AS2 adapter. > > You can view the status of the Functional Acknowledgement through the *Monitor* tab. To know more, see [Monitoring B2B Messages](monitoring-b2b-messages-b5e1fc9.md) -26. Select the *Interchange* shape on the receiver side. -27. Choose the value help provided for the *Message Implementation Guideline \(MIG\)* field and select a MIG from the list and select *Choose*. +27. Select the *Interchange* shape on the receiver side. +28. Choose the value help provided for the *Message Implementation Guideline \(MIG\)* field and select a MIG from the list and select *Choose*. > ### Note: > If you want to view the details of the MIG that you chose, you can use the link provided under the *Version* field. -28. Select a value from the drop-down list for the field *Number Range*. +29. Select a value from the drop-down list for the field *Number Range*. > ### Note: > A number range is used to insert unique sequence numbers. > > You need to configure this number range in the Cloud Integration tenant. To do so, see [Number Ranges](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/b6e17fa17a70491da4a54216db298f84.html). -29. Similar to the Sender, if you want to use custom integration flows for your Pre/Post-Processing of the interchange step, enable the checkbox under *Custom Integration Flow*. +30. Similar to the Sender, if you want to use custom integration flows for your Pre/Post-Processing of the interchange step, enable the checkbox under *Custom Integration Flow*. > ### Note: > The application now provides you with the *ProcessDirect* adapter that allows you to use your customised integration flow within the generic integration flow. To know more about how it works, see [Interchange Processing Flow](interchange-processing-flow-7d3bce9.md) -30. Provide the address path of your custom integration flow in the *Process Direct Address* field. +31. Provide the address path of your custom integration flow in the *Process Direct Address* field. > ### Note: > To know more about how it works, see [Interchange Processing Flow](interchange-processing-flow-7d3bce9.md) -31. The *Enable Payload Validation* checkbox allows the system to validate the outgoing payload. It is selected by default. Uncheck the option if you want to disable the payload validation. -32. Select the *Enable* checkbox under *Receiver Functional Acknowledgement* if you want to enable the functional acknowledgement for the receiver. +32. The *Enable Payload Validation* checkbox allows the system to validate the outgoing payload. It is selected by default. Uncheck the option if you want to disable the payload validation. +33. To archive the receiver payload, select the checkbox for the field *Archive Receiver Payload*. To know more about archiving data, see [Archiving Payload Data](archiving-payload-data-b927e01.md). +34. If your receiver type system is UN/EDIFACT, you might want to set a target encoding. To do so, under the field *Target Encoding*, select a value from the list. +35. Select the *Enable* checkbox under *Receiver Functional Acknowledgement* if you want to enable the functional acknowledgement for the receiver. > ### Note: > This option is available only for the following type systems: @@ -418,12 +421,12 @@ The creation modes apply only for the agreements you newly create. The agreement > > You also need to maintain the Functional Acknowledgement in the Receiver side. -33. If you have enabled *Receiver Functional Acknowledgement*, choose *Communication* on the receiver side and set the following values: +36. If you have enabled *Receiver Functional Acknowledgement*, choose *Communication* on the receiver side and set the following values: - *Communication*: It should be of type AS2. This detail has to be maintained in the trading partner profile. To know more, see [Creating a Trading Partner Profile](creating-a-trading-partner-profile-542fb11.md) - *Receiver Functional Acknowledgement Channel*: Select a value from the drop-down list -34. If you want to specify which separators to be used in the interchange message payload, select the checkbox for the field *Use Custom Separators*. This will enable the following fields. Set the character from the drop-down list for each of the separator. +37. If you want to specify which separators to be used in the interchange message payload, select the checkbox for the field *Use Custom Separators*. This will enable the following fields. Set the character from the drop-down list for each of the separator. - *Segment Terminator* @@ -434,7 +437,7 @@ The creation modes apply only for the agreements you newly create. The agreement > ### Note: > You can also manually specify the custom separator for these fields. Enter the hexadecimal value for the separator you want to use in the respective field. For example, enter `#x2b` to use **\+** as the separator. -35. Choose *Save*. +38. Choose *Save*. @@ -579,7 +582,7 @@ The creation modes apply only for the agreements you newly create. The agreement Select a contact person from the drop-down list. > ### Note: - > You need to have the Business Expert to assign a contact person. To know more on assigning roles, see [Configuring User Access](../configuring-user-access-2c6214a.md). + > You need to have the Business Expert to assign a contact person. To know more on assigning roles, see [Configuring User Access to SAP Integration Suite](../configuring-user-access-to-sap-integration-suite-2c6214a.md). @@ -690,7 +693,7 @@ The creation modes apply only for the agreements you newly create. The agreement Select a contact person from the drop-down list. > ### Note: - > You need to have the Business Expert to assign a contact person. To know more on assigning roles, see [Configuring User Access](../configuring-user-access-2c6214a.md). + > You need to have the Business Expert to assign a contact person. To know more on assigning roles, see [Configuring User Access to SAP Integration Suite](../configuring-user-access-to-sap-integration-suite-2c6214a.md). @@ -792,51 +795,53 @@ The creation modes apply only for the agreements you newly create. The agreement > The application now provides you with the *ProcessDirect* adapter that allows you to use your customised integration flow within the generic integration flow. To know more about how it works, see [Interchange Processing Flow](interchange-processing-flow-7d3bce9.md) 23. The *Enable Payload Validation* checkbox allows the system to validate the incoming payload. Check/Uncheck the option if you want to enable or disable the payload validation. -24. Choose the *Mapping* step. -25. Select a mapping guideline using the value help provided for the field *Mapping Guideline\(MAG\)*. +24. To archive the sender payload, select the checkbox for the field *Archive Sender Payload*. To know more about archiving data, see [Archiving Payload Data](archiving-payload-data-b927e01.md) +25. Choose the *Mapping* step. +26. Select a mapping guideline using the value help provided for the field *Mapping Guideline\(MAG\)*. If you want to view the details of the MAG that you chose, you can use the link provided under the *Version* field. -26. If you want to use custom integration flow for the Mapping process, enable the checkbox for *Customized Mapping Processing* and provide the address of the integration flow under the field *Process Direct Address* field. +27. If you want to use custom integration flow for the Mapping process, enable the checkbox for *Customized Mapping Processing* and provide the address of the integration flow under the field *Process Direct Address* field. > ### Note: > Enabling custom message processing will disable the *Mapping Guideline \(MAG\)* field. > > The application now provides you with the *ProcessDirect* adapter that allows you to use your customised integration flow within the generic integration flow. To know more about how it works, see [Interchange Processing Flow](interchange-processing-flow-7d3bce9.md) -27. Choose the *Communication Channel* on the receiver side and select a value from the drop-down list for the field *Communication*. -28. Select the value for the field *Receiver Functional Acknowledgement Channel*. +28. Choose the *Communication Channel* on the receiver side and select a value from the drop-down list for the field *Communication*. +29. Select the value for the field *Receiver Functional Acknowledgement Channel*. > ### Note: > This field appears only for AS2 adapter. > > You can view the status of the Functional Acknowledgement through the *Monitor* tab. To know more, see [Monitoring B2B Messages](monitoring-b2b-messages-b5e1fc9.md) -29. Select the *Interchange* shape on the receiver side. -30. Choose the value help provided for the *Message Implementation Guideline \(MIG\)* field and select a MIG from the list and select *Choose*. +30. Select the *Interchange* shape on the receiver side. +31. Choose the value help provided for the *Message Implementation Guideline \(MIG\)* field and select a MIG from the list and select *Choose*. > ### Note: > If you want to view the details of the MIG that you chose, you can use the link provided under the *Version* field. -31. Select a value from the drop-down list for the field *Number Range*. +32. Select a value from the drop-down list for the field *Number Range*. > ### Note: > A number range is used to insert unique sequence numbers. > > You need to configure this number range in the Cloud Integration tenant. To do so, see [Number Ranges](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/b6e17fa17a70491da4a54216db298f84.html). -32. Similar to the Sender, if you want to use custom integration flows for your Pre/Post-Processing of the interchange step, enable the checkbox under *Custom Integration Flow*. +33. Similar to the Sender, if you want to use custom integration flows for your Pre/Post-Processing of the interchange step, enable the checkbox under *Custom Integration Flow*. > ### Note: > The application now provides you with the *ProcessDirect* adapter that allows you to use your customised integration flow within the generic integration flow. To know more about how it works, see [Interchange Processing Flow](interchange-processing-flow-7d3bce9.md) -33. Provide the address path of your custom integration flow in the *Process Direct Address* field. +34. Provide the address path of your custom integration flow in the *Process Direct Address* field. > ### Note: > To know more about how it works, see [Interchange Processing Flow](interchange-processing-flow-7d3bce9.md) -34. The *Enable Payload Validation* checkbox allows the system to validate the outgoing payload. It is selected by default. Uncheck the option if you want to disable the payload validation. -35. Select the *Enable* checkbox under *Receiver Functional Acknowledgement* if you want to enable the functional acknowledgement for the receiver. +35. The *Enable Payload Validation* checkbox allows the system to validate the outgoing payload. It is selected by default. Uncheck the option if you want to disable the payload validation. +36. To archive the receiver payload, select the checkbox for the field *Archive Receiver Payload*. To know more about archiving data, see [Archiving Payload Data](archiving-payload-data-b927e01.md) +37. Select the *Enable* checkbox under *Receiver Functional Acknowledgement* if you want to enable the functional acknowledgement for the receiver. > ### Note: > This option is available only for the following type systems: @@ -847,12 +852,12 @@ The creation modes apply only for the agreements you newly create. The agreement > > You also need to maintain the Functional Acknowledgement in the Receiver side. -36. If you have enabled *Receiver Functional Acknowledgement*, choose *Communication* on the receiver side and set the following values: +38. If you have enabled *Receiver Functional Acknowledgement*, choose *Communication* on the receiver side and set the following values: - *Communication*: It should be of type AS2. This detail has to be maintained in the trading partner profile. To know more, see [Creating a Trading Partner Profile](creating-a-trading-partner-profile-542fb11.md) - *Receiver Functional Acknowledgement Channel*: Select a value from the drop-down list -37. If you want to specify which separators to be used in the interchange message payload, select the checkbox for the field *Use Custom Separators*. This will enable the following fields. Set the character from the drop-down list for each of the separator. +39. If you want to specify which separators to be used in the interchange message payload, select the checkbox for the field *Use Custom Separators*. This will enable the following fields. Set the character from the drop-down list for each of the separator. - *Segment Terminator* @@ -863,7 +868,7 @@ The creation modes apply only for the agreements you newly create. The agreement > ### Note: > You can also manually specify the custom separator for these fields. Enter the hexadecimal value for the separator you want to use in the respective field. For example, enter `#x2b` to use **\+** as the separator. -38. Choose *Save*. +40. Choose *Save*. diff --git a/docs/ISuite/50-Development/creating-a-trading-partner-profile-542fb11.md b/docs/ISuite/50-Development/creating-a-trading-partner-profile-542fb11.md index 6d9f20b4..308baf2b 100644 --- a/docs/ISuite/50-Development/creating-a-trading-partner-profile-542fb11.md +++ b/docs/ISuite/50-Development/creating-a-trading-partner-profile-542fb11.md @@ -191,8 +191,12 @@ Follow the procedure below to create a trading partner profile ## Identifiers -1. Navigate to the *Identifiers* tab and choose *Create*. -2. In the resulting dialog box, enter the following details +1. Navigate to the *Identifiers* tab. The tab consists of two sections: + - *Single Identifiers*: These are individual identifiers that have their own type system, scheme and organization etc. If you want to create a single identifier, choose *Create* provided above the *Single Identifiers* table and follow from Step 2 below. + + - *Identifier Groups*: These are identifier groups that have a common Alias, Type System, Agency and Scheme. If you want to create an identifier group, choose *Create* provided above the *Identifiers Groups* table and follow the instructions from Step 4 below. + +2. For Single Identifier, enter the following details. **Identifier** @@ -218,7 +222,7 @@ Follow the procedure below to create a trading partner profile - Provide a valid ID for the identifier + Provide a valid ID for the identifier. @@ -230,13 +234,100 @@ Follow the procedure below to create a trading partner profile - Enter an alias to the identifier + Enter an alias for the identifier. + + + + + + + Type System + + + + + Choose a type system from the drop-down list. > ### Note: - > An Alias is a user provided, tenant independent identifier for artifacts, that can be used to maintain referential integrity in cross tenant use cases like transport. To know more, see [Understanding the Basic Concepts](understanding-the-basic-concepts-74c068d.md). + > - For *GS1 XML* type system, you must maintain the contact details in the *Contacts* tab. + > + > - For *Tradacoms* type system for the identifier, the field *Identification* is mandatory. If the sender payload contains both *Identification* and *Name*, the integration flow will consider only *Identification* for the computed Partner Directory ID. + > + > The system ASSEMBLY will use Company profile's *Short Name* for the *Identification Name* + > + > Tradacoms is supported only in the 2.0 version of the integration package *Cloud Integration - Trading Partner Management V2* + + + + + + Scheme + + + + + Choose a scheme from the drop-down list. + + + + + + + Agency + + + + + Provide the agency name and code in their respective fields. + + + + + +3. Choose *Save*. +4. For Identifier Group, maintain the following details: + + **Create Identifier Group** + + + + + + + + + + + + + + @@ -247,7 +338,7 @@ Follow the procedure below to create a trading partner profile @@ -282,13 +373,19 @@ Follow the procedure below to create a trading partner profile
+ + Field Name + + + + Description + +
+ + Group Name + + + + Provide a valid name for the identifier group. + +
+ + Alias + + + + Enter an alias for the identifier. +
- Choose a type system from the drop-down list + Choose a type system from the drop-down list. > ### Note: > - For *GS1 XML* type system, you must maintain the contact details in the *Contacts* tab. @@ -270,7 +361,7 @@ Follow the procedure below to create a trading partner profile - Choose a scheme from the drop-down list + Choose a scheme from the drop-down list.
- Provide the agency name and code in their respective fields + Provide the agency name and code in their respective fields.
-3. Choose *Save*. +5. Choose *Save*. The identifier group is created successfully. You need to now add identifiers to it. +6. Open the identifier group from the *Identifier Groups* table. +7. Choose *Edit* to edit the details of the group. +8. Select *Add* above the *Identifiers in Group* to add idenifiers to this group. +9. Maintain the values for *Identification* and *Sub-Organization* fields and choose *Save*. +10. Choose *Activate* to activate the group and publish its identifier details into the partner directory. This step just publishes the content and the identifiers would take effect only if any agreement using the identifier group gets activated. +11. If you make any changes after the activation of the group and want to push the latest changes to the Partner Directory, save your changes and choose *Update*. diff --git a/docs/ISuite/50-Development/creating-an-agreement-template-9692cb1.md b/docs/ISuite/50-Development/creating-an-agreement-template-9692cb1.md index b50ce127..124e7e57 100644 --- a/docs/ISuite/50-Development/creating-an-agreement-template-9692cb1.md +++ b/docs/ISuite/50-Development/creating-an-agreement-template-9692cb1.md @@ -137,7 +137,7 @@ Follow the next procedure to create an agreement template. Select a contact person from the drop-down list. > ### Note: - > You need to have the *Business Expert* to assign a contact person. To know more on assigning roles, see [Configuring User Access](../configuring-user-access-2c6214a.md). + > You need to have the *Business Expert* to assign a contact person. To know more on assigning roles, see [Configuring User Access to SAP Integration Suite](../configuring-user-access-to-sap-integration-suite-2c6214a.md). @@ -384,32 +384,34 @@ Follow the next procedure to create an agreement template. 22. If you want to enable the payload validation, select the checkbox under *Validation Option*. -23. Similarly, choose the *Communication Channel* on the receiver side and enter a value for the field *Alias for Communication*. +23. To archive the sender payload, select the checkbox for the field *Archive Sender Payload*. To know more about archiving data, see [Archiving Payload Data](archiving-payload-data-b927e01.md) -24. Select a value from the drop-down list for the field *Receiver Functional Acknowledgement Channel*. +24. Similarly, choose the *Communication Channel* on the receiver side and enter a value for the field *Alias for Communication*. + +25. Select a value from the drop-down list for the field *Receiver Functional Acknowledgement Channel*. This field appears only for AS2 adapter. -25. Select the *Interchange* shape on the receiver side. +26. Select the *Interchange* shape on the receiver side. -26. Choose the value help provided for the *Message Implementation Guideline \(MIG\)* field and select a MIG from the list and select *Choose*. +27. Choose the value help provided for the *Message Implementation Guideline \(MIG\)* field and select a MIG from the list and select *Choose*. If you want to view the details of the MIG that you chose, you can use the link provided under the *Version* field. -27. Enter an alias value for the field *Number Range Alias*. +28. Enter an alias value for the field *Number Range Alias*. > ### Note: > A number range is used to insert unique sequence numbers. > > You need to configure this number range in the Cloud Integration tenant. To do so, see [Number Ranges](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/b6e17fa17a70491da4a54216db298f84.html). -28. Similar to the Sender, if you want to use custom integration flows for your Post-Processing of the interchange step, enable the checkbox under *Custom Integration Flow*. +29. Similar to the Sender, if you want to use custom integration flows for your Post-Processing of the interchange step, enable the checkbox under *Custom Integration Flow*. -29. Provide the address of your custom integration flow in the *Process Direct Address* field. +30. Provide the address of your custom integration flow in the *Process Direct Address* field. This step is carried out using the ProcessDirect adapter. To know more about how it works, see [Interchange Processing Flow](interchange-processing-flow-7d3bce9.md) -30. Select the *Enable* checkbox under *Receiver Functional Acknowledgement* if you want to enable the functional acknowledgement for the receiver. +31. Select the *Enable* checkbox under *Receiver Functional Acknowledgement* if you want to enable the functional acknowledgement for the receiver. > ### Note: > This option is available only for the following type systems: @@ -419,19 +421,23 @@ Follow the next procedure to create an agreement template. You can view the status of the Functional Acknowledgement through the *Monitor* tab. To know more, see [Monitoring B2B Messages](monitoring-b2b-messages-b5e1fc9.md) -31. If you want to enable the payload validation, select the checkbox under *Validation Option*. +32. If you want to enable the payload validation, select the checkbox under *Validation Option*. + +33. To archive the receiver payload, select the checkbox for the field *Archive Receiver Payload*. To know more about archiving data, see [Archiving Payload Data](archiving-payload-data-b927e01.md). + +34. If your receiver type system is UN/EDIFACT, you might want to set a target encoding. To do so, under the field *Target Encoding*, select a value from the list. -32. Select the *Mapping* step of the transaction. +35. Select the *Mapping* step of the transaction. -33. Select a mapping guideline and its corresponding version using the value help for the *Mapping Guideline\(MAG\)* field. +36. Select a mapping guideline and its corresponding version using the value help for the *Mapping Guideline\(MAG\)* field. -34. If you want to custom integration flow for the mapping processing, enable the checkbox for the field *Customized Mapping Processing*. +37. If you want to custom integration flow for the mapping processing, enable the checkbox for the field *Customized Mapping Processing*. -35. Provide the address of your integration flow in the *Process Direct Address* field. +38. Provide the address of your integration flow in the *Process Direct Address* field. -36. Choose anywhere outside the transaction and the common properties get displayed below the transaction. Choose the *Activity Parameters* tab if you want to add any paramaters to the template. +39. Choose anywhere outside the transaction and the common properties get displayed below the transaction. Choose the *Activity Parameters* tab if you want to add any paramaters to the template. -37. Choose *Add Parameters*. This will display the following options: +40. Choose *Add Parameters*. This will display the following options: - *Extend from Company*: This option allows you to use the dynamic parameters from the company profile used in the agreement template. If you have created a *two-way* business transaction, you can choose between *Inbound* or *Outbound* parameters. Select a parameter from the list and choose *Save*. @@ -443,11 +449,11 @@ Follow the next procedure to create an agreement template. - *Create Activity Parameters*: You can also create your onw activity paramaters using this option. If you have created a *two-way* business transaction, you can choose between *Inbound* or *Outbound* parameters. Maintain the values of the fields *Parameter Key* and *Value* and choose *Save*. -38. Navigate to the *Custom Search Attirbutes* tab if you want to add any custom search values which are picked up for the B2B monitoring. +41. Navigate to the *Custom Search Attirbutes* tab if you want to add any custom search values which are picked up for the B2B monitoring. Before adding custom search attributes, you need to maintain them in the *Configuration Manager*. To know more, see [Configuration Manager](configuration-manager-7daf06c.md). -39. Choose *Add* and maintain the following fields: +42. Choose *Add* and maintain the following fields: @@ -525,7 +531,7 @@ Follow the next procedure to create an agreement template.
-40. Choose *Save*. +43. Choose *Save*. diff --git a/docs/ISuite/50-Development/creating-an-api-proxy-using-sap-cloud-integration-api-provider-aefbd74.md b/docs/ISuite/50-Development/creating-an-api-proxy-using-sap-cloud-integration-api-provider-aefbd74.md index 2d5b5101..8576bca9 100644 --- a/docs/ISuite/50-Development/creating-an-api-proxy-using-sap-cloud-integration-api-provider-aefbd74.md +++ b/docs/ISuite/50-Development/creating-an-api-proxy-using-sap-cloud-integration-api-provider-aefbd74.md @@ -90,7 +90,9 @@ Instead of directly consuming API services, application developers can access AP In the *Create API* dialog, the *API Details* consisting of *Name*, *Title*, *Description*, *Host Alias*, *API Base Path*, and *Service Type* are auto populated. - 7. Choose *Create*. + 7. Enter a short introductory text in the *Short Text* field. + + 8. Choose *Create*. An API provider is auto-created with the name that is populated in the *Name* field of the *Create API* dialog. This auto-created API provider helps in storing the user credentials provided in the *Authentication* dialog and connects to the API proxy. diff --git a/docs/ISuite/50-Development/creating-an-application-with-api-business-hub-enterprise-administrator-role-new-design-df4f777.md b/docs/ISuite/50-Development/creating-an-application-with-api-business-hub-enterprise-administrator-role-new-design-df4f777.md index eaf11ee4..565d4964 100644 --- a/docs/ISuite/50-Development/creating-an-application-with-api-business-hub-enterprise-administrator-role-new-design-df4f777.md +++ b/docs/ISuite/50-Development/creating-an-application-with-api-business-hub-enterprise-administrator-role-new-design-df4f777.md @@ -10,7 +10,7 @@ With the API business hub enterprise administrator role you can create an applic ## Prerequisites -You shoul have the *AuthGroup.API.Admin* role assigned to you. For more information on roles, see [User Roles in API Management \(New\)](../user-roles-in-api-management-new-911ca5a.md). +You shoul have the *AuthGroup.API.Admin* role assigned to you. For more information on roles, see [Tasks and Corresponding Role Collections](../tasks-and-corresponding-role-collections-911ca5a.md). diff --git a/docs/ISuite/50-Development/creating-an-application-with-application-developer-role-new-design-99515fc.md b/docs/ISuite/50-Development/creating-an-application-with-application-developer-role-new-design-99515fc.md index 2ce71663..75b71171 100644 --- a/docs/ISuite/50-Development/creating-an-application-with-application-developer-role-new-design-99515fc.md +++ b/docs/ISuite/50-Development/creating-an-application-with-application-developer-role-new-design-99515fc.md @@ -10,7 +10,7 @@ As an application developer you can create an application, and view the existing ## Prerequisites -- You have the *AuthGroup.API.ApplicationDeveloper* role assigned to you. For more information on roles, see [User Roles in API Management \(New\)](../user-roles-in-api-management-new-911ca5a.md). +- You have the *AuthGroup.API.ApplicationDeveloper* role assigned to you. For more information on roles, see [Tasks and Corresponding Role Collections](../tasks-and-corresponding-role-collections-911ca5a.md). > ### Note: > The *AuthGroup.API.ApplicationDeveloper* role must not be assigned manually to a user form the SAP BTP Cockpit. Also, this role must not be a part of any user group assignment. diff --git a/docs/ISuite/50-Development/creating-an-imported-archives-artifact-e555caf.md b/docs/ISuite/50-Development/creating-an-imported-archives-artifact-e555caf.md new file mode 100644 index 00000000..612715bc --- /dev/null +++ b/docs/ISuite/50-Development/creating-an-imported-archives-artifact-e555caf.md @@ -0,0 +1,104 @@ + + +# Creating an Imported Archives Artifact + +Create an Imported Archives artifact to which later you can add imported archive objects. + + + + + +## Procedure + +1. Open your integration package and choose *Edit*. + +2. In the *Artifacts* tab, choose *Add* \> *Imported Archives*. + +3. In the *Add Imported Archives* dialog box, choose one of the following options: + + - *Create* – to create an artifact. + + - *Upload* – to upload a .zip file that contains the resources for an Imported Archives artifact. You can download such a file from other integration packages. + + +4. Enter the details as listed in the following table: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + Field + + + + Description + +
+ + Imported Archives \(only for upload\) + + + + Upload a .zip file containing the resources. + +
+ + Name + + + + Name for the Imported Archives. + +
+ + ID + + + + Uniquely identifies the Imported Archives. + +
+ + Runtime Profile + + + + Select the runtime where you want to execute the Imported Archives. For more information, see [Runtime Profiles](IntegrationSettings/runtime-profiles-8007daa.md). + +
+ + Description + + + + Description of the Imported Archives and its purpose. + +
+ +5. Choose *OK*. + + diff --git a/docs/ISuite/50-Development/creating-an-instance-of-api-portal-api-management-6129172.md b/docs/ISuite/50-Development/creating-an-instance-of-api-portal-api-management-6129172.md index 2684173c..578c3d56 100644 --- a/docs/ISuite/50-Development/creating-an-instance-of-api-portal-api-management-6129172.md +++ b/docs/ISuite/50-Development/creating-an-instance-of-api-portal-api-management-6129172.md @@ -10,7 +10,7 @@ Create an instance of API portal, API Management in your source subaccount and c ## Prerequisites -Create an API portal, API Management subaccount and subscribe to it. Set it as your source subaccount, from where you can start exporting the API Management content. For more information, see [Set Up API Portal Application](https://help.sap.com/viewer/66d066d903c2473f81ec33acfe2ccdb4/Cloud/en-US/29c281b4a002404eba44e91c6fad0d34.html "To create APIs, products, import policy templates, and view applications, set up the API portal application.") :arrow_upper_right:. +Create an API portal, API Management subaccount and subscribe to it. Set it as your source subaccount, from where you can start exporting the API Management content. For more information, see [Set Up API Portal Application](https://help.sap.com/viewer/4425026877144cc2b15505ed30215167/IAT/en-US/29c281b4a002404eba44e91c6fad0d34.html "To create APIs, products, import policy templates, and view applications, set up the API portal application.") :arrow_upper_right:. diff --git a/docs/ISuite/50-Development/creating-custom-roles-for-access-policies-7db3c87.md b/docs/ISuite/50-Development/creating-custom-roles-for-access-policies-7db3c87.md index c226ee4e..ee599933 100644 --- a/docs/ISuite/50-Development/creating-custom-roles-for-access-policies-7db3c87.md +++ b/docs/ISuite/50-Development/creating-custom-roles-for-access-policies-7db3c87.md @@ -48,5 +48,5 @@ For more information about roles and role collections see: **Related Information** -[Tasks and Permissions](../60-Security/tasks-and-permissions-556d557.md "") +[Tasks and Permissions for Cloud Integration](../60-Security/tasks-and-permissions-for-cloud-integration-556d557.md "") diff --git a/docs/ISuite/50-Development/creating-message-mapping-as-a-flow-step-3d5cb7f.md b/docs/ISuite/50-Development/creating-message-mapping-as-a-flow-step-3d5cb7f.md index d09f55e3..78f87269 100644 --- a/docs/ISuite/50-Development/creating-message-mapping-as-a-flow-step-3d5cb7f.md +++ b/docs/ISuite/50-Development/creating-message-mapping-as-a-flow-step-3d5cb7f.md @@ -145,6 +145,8 @@ The supported file types for source and target messages are: > > - For OpenAPI Spec JSON, you can't use the *Duplicate Subtree* action for a node that is of the type array. > + > - Outputs are not produced for elements that begin with the character "`@`” and their child elements. + > > > Read the [blog](https://blogs.sap.com/2020/09/16/sap-cloud-integration-swagger-openapi-spec-json-in-message-mapping/) to know more about Swagger/OpenAPI Spec JSON in message mapping. @@ -159,7 +161,7 @@ The supported file types for source and target messages are: 2. If you want to assign an existing mapping definition \(.mmap file\) which is fixed, do the following substeps: - 1. From [Manage Resources of an Integration Flow](manage-resources-of-an-integration-flow-b5968b2.md), add or refer existing mapping resources to your integration flow. + 1. From [Manage Resources](manage-resources-b5968b2.md), add or refer existing mapping resources to your integration flow. 2. In the property sheet of the message mapping step, choose the *Processing* tab. diff --git a/docs/ISuite/50-Development/creating-message-mapping-as-an-artifact-1d52a7b.md b/docs/ISuite/50-Development/creating-message-mapping-as-an-artifact-1d52a7b.md index 820cb228..fa216c29 100644 --- a/docs/ISuite/50-Development/creating-message-mapping-as-an-artifact-1d52a7b.md +++ b/docs/ISuite/50-Development/creating-message-mapping-as-an-artifact-1d52a7b.md @@ -134,10 +134,10 @@ Use this option to upload a message mapping artifact stored on your computer. On ## Prerequisites -- You've created an integration package and opened it in edit mode. - - You've established connection to your SAP Process Orchestration system. See: [Configuring Connectivity to an SAP Process Orchestration System](IntegrationSettings/configuring-connectivity-to-an-sap-process-orchestration-system-8c36fd2.md). +- You've created an integration package and opened it in edit mode. + @@ -167,21 +167,37 @@ Use this option to import a message mapping object from the Enterprise Services 5. Select a message mapping object that you want to import. Choose *Next*. -6. In the *Dependent Resources* tab, provide a name, ID, and an optional description for the message mapping artifact. You also see a list of dependent files of the message mapping object like function library objects and WSDL files that are to be imported too. Choose *Next*. +6. In the *Dependent Resources* tab, provide a name, ID, and an optional description for the message mapping artifact. You also see a list of dependent objects like function library, message type, archives, and WSDL files that are to be imported too. Choose *Next*. + + 1. Optional: If there are dependent message type objects, choose *Import Message Types as WDSLs* to convert the message type objects as WSDL files during the import. + + > ### Note: + > Until the May 2024 release of SAP Integration Suite, message types were automatically converted as WSDL files. The checkbox helps you maintain backward compatibility and avoid any regressions. -7. Optional, only if the source message mapping object has function library objects: Select one or more Function Libraries artifacts to contain all dependent function library objects of the source mapping object. + +7. Optional, only if the source message mapping object has dependent function library objects: In the *Import Function Libraries* tab, select one or more Function Libraries artifacts to contain all dependent function library objects of the source mapping object. In SAP Integration Suite, a function library object from ES Repository must be imported to a Function Libraries artifact. You can't add a function library object directly to a message mapping or an integration package. See: [Working with Function Libraries](working-with-function-libraries-dd8c30d.md). -8. Choose *Add*. + > ### Remember: + > The dependent archive objects of the function library object are not imported. You must manually import the archive object and refer the same in the Function Libraries artifact. For more information, see: [Consuming Imported Archives](consuming-imported-archives-e7562a7.md). + +8. Optional, only if the source message mapping object has dependent message type objects: In the *Import Message Types* tab, see a list of message type objects and understand their metadata. Choose *Next*. + + 1. Choose *Include Dependent Data Types* if you would like to import the associated data type objects as well. + + +9. Optional, only if the source message mapping object has dependent message type objects: In the *Import DT Dependencies* tab, see the import status of the message type and data type objects. Choose *Next*. + +10. Choose *Submit*. A message mapping artifact is created. - If there are dependent function library objects, they are imported to the selected Function Libraries artifact. References to the dependent function library objects are also created. + If there are dependent objects, they are imported appropriately. References to the dependent objects are also created. -9. Open the message mapping artifact and choose *Edit* to change the source and target messages, create mappings, and perform operations. Choose *Save*. +11. Open the message mapping artifact and choose *Edit* to change the source and target messages, create mappings, and perform operations. Choose *Save*. -10. Choose *Deploy*. +12. Choose *Deploy*. Before consuming a message mapping artifact, you must first deploy it. diff --git a/docs/ISuite/50-Development/creating-oauth-client-credentials-for-cloud-foundry-environment-50b63c6.md b/docs/ISuite/50-Development/creating-oauth-client-credentials-for-cloud-foundry-environment-50b63c6.md new file mode 100644 index 00000000..ca8b8d0f --- /dev/null +++ b/docs/ISuite/50-Development/creating-oauth-client-credentials-for-cloud-foundry-environment-50b63c6.md @@ -0,0 +1,71 @@ + + + + +# Creating OAuth Client Credentials for Cloud Foundry Environment + +You can create OAuth client credentials to access your SAP Cloud Integration tenant hosted on the Cloud Foundry environment. + + + + + +## Prerequisites + +- You’ve access to a subaccount in the SAP BTP cockpit. + +- You’ve activated the Process Integration service or the Cloud Integration capability of SAP Integration Suite in your subaccount. + + + + +## Procedure + +1. Log into the SAP BTP cockpit and navigate to your subaccount. + +2. Choose *Services* \> *Service Instances* on the navigation sidebar. + +3. Choose *Create Instance*. + +4. In the *New Instance* dialog box, enter the following values: + + 1. In the *Service* field, select *Process Integration Runtime*. + + 2. In the *Service Plan* field, select *api*. + + 3. Enter a name for your instance in the *Instance Name* field and choose *Next*. + + +5. On the next screen, specify the configuration parameter for the instance. + + - Enter the following configuration parameter inline in JSON format. + + > ### Source Code: + > ``` + > { + > "roles":[ + > "WorkspacePackagesEdit" + > ] + > } + > + > ``` + + - Optional: Choose *Browse* to upload the JSON file containing the configuration parameter. + +6. Choose *Next* to review and verify the instance details. + +7. Choose *Create Instance*. + +8. Choose \(Actions\) and then select *Create Service Key* on the service instance created in the previous step. + +9. In the *New Service Key* dialog box, enter a value in the *Service key name* field and choose *Create*. + + The service key is created successfully. You can view the service key under the *Service Keys* section. + +10. Choose \(Actions\) and then select *View* on the service key to display the details. + + The service key details containing the OAuth client credentials including the clientid, clientsecret, and token url are displayed. + +11. Choose *Download* or *Copy JSON* to use the client credentials in the *Destination Configuration* section of your subaccount. + + diff --git a/docs/ISuite/50-Development/data-storages-31efe35.md b/docs/ISuite/50-Development/data-storages-31efe35.md index 92e5334c..a556b774 100644 --- a/docs/ISuite/50-Development/data-storages-31efe35.md +++ b/docs/ISuite/50-Development/data-storages-31efe35.md @@ -78,7 +78,7 @@ Tenant database -During the processing of an integration flow, Cloud IntegrationCloud Integration tenant. The database keeps the data for a restricted amount of time. +During the processing of an integration flow, Cloud Integration can write data to and read data from a database that comes with the tenant. The database keeps the data for a restricted amount of time. The database is associated with a subaccount of SAP BTP. @@ -116,7 +116,7 @@ JMS queues -To asynchronously decouple inbound and outbound processing, Cloud Integration can store messages in message queues and read from there \(using the JMS adapter\). can write data to and read data from a database that comes with the +To asynchronously decouple inbound and outbound processing, Cloud Integration can store messages in message queues and read from there \(using the JMS adapter\). As soon as the message has been consumed successfully, it isn't available anymore in the queue. diff --git a/docs/ISuite/50-Development/define-a-local-script-step-03b32eb.md b/docs/ISuite/50-Development/define-a-local-script-step-03b32eb.md index 5711d35f..24d0abc0 100644 --- a/docs/ISuite/50-Development/define-a-local-script-step-03b32eb.md +++ b/docs/ISuite/50-Development/define-a-local-script-step-03b32eb.md @@ -50,7 +50,7 @@ JavaScript Engine \(Rhino\) -1.7 R4 +1.7.14 diff --git a/docs/ISuite/50-Development/define-content-modifier-8f04a70.md b/docs/ISuite/50-Development/define-content-modifier-8f04a70.md index 12c0905f..1ad94153 100644 --- a/docs/ISuite/50-Development/define-content-modifier-8f04a70.md +++ b/docs/ISuite/50-Development/define-content-modifier-8f04a70.md @@ -285,7 +285,7 @@ Note that data written to the message header during a processing step, for examp - The default value is *Expression*. If the payload contains expressions within it, then set the type as *Expression*; if the payload is huge and it has no expressions within it, then it is recommended to use the type *Constant*. + The default value is *Constant*. If the payload contains expressions within it, then set the type as *Expression*; if the payload is huge and it has no expressions within it, then it is recommended to use the type *Constant*. > ### Remember: > If the payload size is more than 256 KB, the system doesn't let you use the type expression. If there are actual expressions used and you can't reduce the size of the text, use a groovy script. diff --git a/docs/ISuite/50-Development/define-data-store-operations-79f63a4.md b/docs/ISuite/50-Development/define-data-store-operations-79f63a4.md index cf13150b..52d17edb 100644 --- a/docs/ISuite/50-Development/define-data-store-operations-79f63a4.md +++ b/docs/ISuite/50-Development/define-data-store-operations-79f63a4.md @@ -101,7 +101,7 @@ More information: [Define Data Store Get Operations](define-data-store-get-opera -This component stores data on your tenant \(using SAP ASE Platform Edition\). Note that there is an overall DB space limit of 32 GB. +This component stores data on your tenant using a database. Note that there's an overall database size limit of 32 GB. **Related Information** diff --git a/docs/ISuite/50-Development/define-edi-splitter-584a3be.md b/docs/ISuite/50-Development/define-edi-splitter-584a3be.md index 07c14afc..57ec2893 100644 --- a/docs/ISuite/50-Development/define-edi-splitter-584a3be.md +++ b/docs/ISuite/50-Development/define-edi-splitter-584a3be.md @@ -175,6 +175,24 @@ You use the EDI splitter to split inbound bulk EDI messages, and configure the s + + + + + + Decimal Character + + + + + Choose the decimal character to be used during message validation: + + - Dot \(.\) + - Dynamic: Define the value 'dot' or 'fromIncomingPayload' in `SAP_EDISPLITTER_DECIMAL_CHARACTER` header. + - From Incoming Payload: The decimal characater is read from the incoming payload. + + + @@ -498,15 +516,13 @@ You use the EDI splitter to split inbound bulk EDI messages, and configure the s - Validates an EDI interchange against the XSD schema for conversion. Deploy the schema by selecting it from an integration flow or by defining the location of the schema. - Follow the steps here to add an `*.xsd` file to the integration flow: - 1. In the *EDI Schema Definition*, select *Integration Flow*. + 1. In the *EDI Schema Definition**Integration Flow*. - 2. Choose *Add* from the *Schemas* table. + 2. Choose *Add* from the from the choose the schema\). *Schemas* table. - 3. Choose *Select* to add an XML Schema file from the XSD folder found in the integration project. + 3. Choose *Select* choose the schema\). to add an XML Schema file from the XSD folder found in the integration project. > ### Note: > - During runtime only XSD’s from Integration Advisor \(IA\) are supported. @@ -666,7 +682,7 @@ You use the EDI splitter to split inbound bulk EDI messages, and configure the s - Dynamic - If selected, the encoding format is set dynamically at runtime using the header `SAP_EDISPLITTER_TRADACOMS_SOURCE_ENCODING` \(possible values: `UTF-8`, `ISO-8859-1`\). + If selected, the encoding format is set dynamically at runtime using the headernullnullnull`SAP_EDISPLITTER_TRADACOMS_SOURCE_ENCODING` \(possible values: `UTF-8`, `ISO-8859-1`\). @@ -720,7 +736,7 @@ You use the EDI splitter to split inbound bulk EDI messages, and configure the s - Integration Flow - If selected, the schema definition is specified from a resource file of the integration flow \(use the parameter *Schemas* to choose the schema\). + If selected, the schema definition is specified from a resource file of the integration flow \(use the parameter *Schemas* diff --git a/docs/ISuite/50-Development/define-edi-to-xml-converter-6a3d12b.md b/docs/ISuite/50-Development/define-edi-to-xml-converter-6a3d12b.md index 8e4edd75..9b2a3530 100644 --- a/docs/ISuite/50-Development/define-edi-to-xml-converter-6a3d12b.md +++ b/docs/ISuite/50-Development/define-edi-to-xml-converter-6a3d12b.md @@ -60,36 +60,36 @@ Use this procedure to convert EDIFACT, ODETTE, TRADACOMS, and ASC-X12 format int - Name + Source Encoding - Enter the name of the converter. + Select encoding format for the incoming payload. - Source Encoding + Target Encoding - Select encoding format for the incoming payload. + Select encoding format for the outgoing payload. If you select *Dynamic*, you must define the value 'UTF-8' or 'ISO-8859-1' in SAP\_EDITOXML\_EDIFACT\_TARGET\_ENCODING exchange header. - Target Encoding + Target Decimal Character - Select encoding format for the outgoing payload. If you select 'Dynamic', you must define the value 'UTF-8' or 'ISO-8859-1' in SAP\_EDITOXML\_EDIFACT\_TARGET\_ENCODING exchange header. + Select the decimal character of the converted message. If you select *Dynamic*, you must define the value 'dot' or 'fromIncomingPayload' in `SAP_EDITOXML_TARGET_DECIMAL_CHARACTER` header. @@ -113,7 +113,7 @@ Use this procedure to convert EDIFACT, ODETTE, TRADACOMS, and ASC-X12 format int - If exchange headeryou select `Integration Flow` as *EDI Schema Definition*, then you can see the table *Schemas*, in *Properties* view. Select the valid schemas against which the conversion will take place. + If you select `Integration Flow` as *EDI Schema Definition*, then you can see the table *Schemas*, in *Properties* view. Select the valid schemas against which the conversion will take place. > ### Note: > - You can add XSD files to the integration flow. For more details, please refer to [Validating Message Payload against XML Schema](validating-message-payload-against-xml-schema-360dc70.md). diff --git a/docs/ISuite/50-Development/define-general-splitter-a6c1916.md b/docs/ISuite/50-Development/define-general-splitter-a6c1916.md index 61d77c33..e69ee6c1 100644 --- a/docs/ISuite/50-Development/define-general-splitter-a6c1916.md +++ b/docs/ISuite/50-Development/define-general-splitter-a6c1916.md @@ -243,7 +243,7 @@ If you use a Splitter step in a local integration process, the following limitat ## Next Steps -When a message is split \(as configured in a Splitter step of an integration flow\), the Camel headers listed below are generated every time the runtime finishes splitting an Exchange. You have several options for accessing these Camel headers at runtime. For example, suppose that you are configuring an integration flow with a Splitter step before an SFTP receiver adapter. If you enter the string `split_${exchangeId}_Index${header.CamelSplitIndex}` for *File Name*, the file name of the generated file on the SFTP server contains the Camel header `CamelSplitIndex`. In other words, the information on the number of split Exchanges induced by the Splitter step. +When a message is split \(as configured in a Splitter step of an integration flow\), the Camel headers listed below are generated every time the runtime finishes splitting an Exchange. You have several options for accessing these Camel headers at runtime. For example, suppose that you are configuring an integration flow with a Splitter step before an SFTP receiver adapter. If you enter the string `split_${exchangeId}_Index${property.CamelSplitIndex}` for *File Name*, the file name of the generated file on the SFTP server contains the property `CamelSplitIndex`. This property contains the information on the number of split Exchanges induced by the Splitter step. - CamelSplitIndex diff --git a/docs/ISuite/50-Development/define-iterating-splitter-d61d6ec.md b/docs/ISuite/50-Development/define-iterating-splitter-d61d6ec.md index 316baa5e..d75a2eed 100644 --- a/docs/ISuite/50-Development/define-iterating-splitter-d61d6ec.md +++ b/docs/ISuite/50-Development/define-iterating-splitter-d61d6ec.md @@ -238,7 +238,7 @@ If you use a Splitter step in a local integration process, the following limitat ## Next Steps -When a message is split \(as configured in a Splitter step of an integration flow\), the Camel headers listed below are generated every time the runtime finishes splitting an Exchange. You have several options for accessing these Camel headers at runtime. For example, suppose that you are configuring an integration flow with a Splitter step before an SFTP receiver adapter. If you enter the string `split_${exchangeId}_Index${header.CamelSplitIndex}` for *File Name*, the file name of the generated file on the SFTP server contains the Camel header `CamelSplitIndex`. In other words, the information on the number of split Exchanges induced by the Splitter step. +When a message is split \(as configured in a Splitter step of an integration flow\), the Camel headers listed below are generated every time the runtime finishes splitting an Exchange. You have several options for accessing these Camel headers at runtime. For example, suppose that you are configuring an integration flow with a Splitter step before an SFTP receiver adapter. If you enter the string `split_${exchangeId}_Index${property.CamelSplitIndex}` for *File Name*, the file name of the generated file on the SFTP server contains the property `CamelSplitIndex`. This property contains the information on the number of split Exchanges induced by the Splitter step. - CamelSplitIndex diff --git a/docs/ISuite/50-Development/define-multicast-17de3ea.md b/docs/ISuite/50-Development/define-multicast-17de3ea.md index c5801a50..27e69f99 100644 --- a/docs/ISuite/50-Development/define-multicast-17de3ea.md +++ b/docs/ISuite/50-Development/define-multicast-17de3ea.md @@ -10,6 +10,21 @@ You can use the *Multicast* step to send copies of the same message to multiple routes. You can send copies to all routes at once using *Parallel Multicast* or in an order of your choice using *Sequential Multicast*. This allows you to perform multiple operations on the same message in a single integration process. Without *Multicast*, you needed multiple integration processes to perform this task. +There are certain best practices and limitations that you must know when using Multicast: + +- The number of outgoing branches using a *Multicast* step must be equal to the number of incoming branches in a *Join* step. + +- Use only one *Multicast* step per *Integration Process* pool. + + To handle errors, you must move all inner *Multicast* steps \(Multicast steps within a Multicast step\) along with its branches to a new *Local Integration Process* pool with its own *Exception Subprocess* pool. For more information, see [SAP Note 3028577](https://me.sap.com/notes/3028577). + +- Use *Router* and *Multicast* steps in different Integration Process pools. + + Always include the *Router* step in a separate *Local Integration Process* pool and call it from the multicast branch. + +- If you like to combine the resulting output from multicast branches, use a *Gather* step immediately after the *Join* step to avoid data loss. + + ## Procedure diff --git a/docs/ISuite/50-Development/define-poll-enrich-f8c8c1d.md b/docs/ISuite/50-Development/define-poll-enrich-f8c8c1d.md index b212884b..faa9c832 100644 --- a/docs/ISuite/50-Development/define-poll-enrich-f8c8c1d.md +++ b/docs/ISuite/50-Development/define-poll-enrich-f8c8c1d.md @@ -41,7 +41,7 @@ You can use the *Poll Enrich* to read \(poll\) messages from an external compone > > See: [Configure the SFTP Sender Adapter Used with the Poll Enrich Step](configure-the-sftp-sender-adapter-used-with-the-poll-enrich-step-1f15fe2.md). -5. Click on the connection line between the *Sender* shape and the *Poll Enrich* step and specify the settings of the SFTP sender adapter. +5. Select the connection line between the *Sender* shape and the *Poll Enrich* step and specify the settings of the SFTP sender adapter. See: [Configure the SFTP Sender Adapter](configure-the-sftp-sender-adapter-2de9ee5.md). diff --git a/docs/ISuite/50-Development/define-settings-for-the-integration-flow-3a6446c.md b/docs/ISuite/50-Development/define-settings-for-the-integration-flow-3a6446c.md index d8dc1dd2..f2ec3f82 100644 --- a/docs/ISuite/50-Development/define-settings-for-the-integration-flow-3a6446c.md +++ b/docs/ISuite/50-Development/define-settings-for-the-integration-flow-3a6446c.md @@ -11,7 +11,7 @@ When clicking the area outside the Integration Process shape, you can configure [Define Error Configuration](define-error-configuration-77d0041.md "You can define how to handle errors when message processing fails at runtime.") -[Manage Resources of an Integration Flow](manage-resources-of-an-integration-flow-b5968b2.md "") +[Manage Resources](manage-resources-b5968b2.md "") [Externalized Parameters View](externalized-parameters-view-27a0216.md "Use this view to compare the default and configured values of the integration flow. The advantage of this view is that you can see the consolidated view of all parameter values externalized.") diff --git a/docs/ISuite/50-Development/define-xml-to-edi-converter-707973f.md b/docs/ISuite/50-Development/define-xml-to-edi-converter-707973f.md index 60f7040a..f33b9388 100644 --- a/docs/ISuite/50-Development/define-xml-to-edi-converter-707973f.md +++ b/docs/ISuite/50-Development/define-xml-to-edi-converter-707973f.md @@ -169,7 +169,7 @@ XML to EDI Converter version 2.0 and above supports the TRADACOMS standard \(*TR - Select this option if you want to specify which separators are to be used in the converted message. You can select the characters available in the dropdown list for each separator. + Select this option if you want to specify which separators are to be used in the converted message. You can select the characters available in the dropdown list for each separator type. > ### Note: > You can also manually specify the custom separator. diff --git a/docs/ISuite/50-Development/define-xml-to-json-converter-a60a282.md b/docs/ISuite/50-Development/define-xml-to-json-converter-a60a282.md index cfa6d209..5c625404 100644 --- a/docs/ISuite/50-Development/define-xml-to-json-converter-a60a282.md +++ b/docs/ISuite/50-Development/define-xml-to-json-converter-a60a282.md @@ -14,11 +14,11 @@ The XML to JSON converter enables you to transform messages in XML format to JSO - You are familiar with the conversion rules for XML to JSON conversion. - For more information see . + For more information see . - You are familiar with the limitations for XML to JSON conversion. - For more information see . + For more information see . - You are familiar with streaming for XML to JSON conversion. diff --git a/docs/ISuite/50-Development/delete-a-rate-plan-af1a2a6.md b/docs/ISuite/50-Development/delete-a-rate-plan-af1a2a6.md index 10050ca4..249f9449 100644 --- a/docs/ISuite/50-Development/delete-a-rate-plan-af1a2a6.md +++ b/docs/ISuite/50-Development/delete-a-rate-plan-af1a2a6.md @@ -45,9 +45,9 @@ You are deleting a rate plan. **Related Information** -[Create a Rate Plan](https://help.sap.com/viewer/66d066d903c2473f81ec33acfe2ccdb4/Cloud/en-US/cfe6a30600f148a39a7920dbc7fa1ab2.html "Create a rate plan using the API portal.") :arrow_upper_right: + -[Update a Rate Plan](https://help.sap.com/viewer/66d066d903c2473f81ec33acfe2ccdb4/Cloud/en-US/b8c1e6b68be74ead8700f7f8be9baa8b.html "Update a rate plan using the API portal.") :arrow_upper_right: + -[Attach Rate Plan to a Product](https://help.sap.com/viewer/66d066d903c2473f81ec33acfe2ccdb4/Cloud/en-US/cc5c942e32df494785c33ba0fc0346f4.html "Attach a rate plan to a product using the API portal.") :arrow_upper_right: + diff --git a/docs/ISuite/50-Development/deploying-a-user-credentials-artifact-6912d63.md b/docs/ISuite/50-Development/deploying-a-user-credentials-artifact-6912d63.md index 1b1749d5..d4a82044 100644 --- a/docs/ISuite/50-Development/deploying-a-user-credentials-artifact-6912d63.md +++ b/docs/ISuite/50-Development/deploying-a-user-credentials-artifact-6912d63.md @@ -25,7 +25,7 @@ To set up a connection using basic authentication or username token authenticati For more information on how to manage security artifacts for Edge Integration Cell, see [Manage Security for Edge Integration Cell](../manage-security-for-edge-integration-cell-1783cf8.md). -3. Click the *Security Material* tile in the *Manage Security* section. +3. Select the *Security Material* tile in the *Manage Security* section. 4. Choose *Add*. @@ -55,7 +55,7 @@ To set up a connection using basic authentication or username token authenticati - A name for the artifact + A name for the artifact. The artifact name is used as an alias for the confidential data assigned by this parameter. @@ -69,7 +69,7 @@ To set up a connection using basic authentication or username token authenticati - A description of the artifact \(optional\) + A description of the artifact \(optional\). @@ -104,7 +104,7 @@ To set up a connection using basic authentication or username token authenticati - The user that calls the receiver system + The user that calls the receiver system. @@ -116,7 +116,7 @@ To set up a connection using basic authentication or username token authenticati - Password against which the user has to be authenticated + Password against which the user has to be authenticated. This parameter has a maximum length of 255 characters. diff --git a/docs/ISuite/50-Development/developing-script-and-script-collection-e60f706.md b/docs/ISuite/50-Development/developing-script-and-script-collection-e60f706.md index 4036e287..898319ef 100644 --- a/docs/ISuite/50-Development/developing-script-and-script-collection-e60f706.md +++ b/docs/ISuite/50-Development/developing-script-and-script-collection-e60f706.md @@ -45,7 +45,7 @@ A typical workflow to rightly use a script collection is as follows: 4. [Deploying a Script Collection](deploying-a-script-collection-95cb2d9.md) -5. [Save and Deploy the Integration Flow](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/33a5123e424c431bbe55bcfba971c230.html "Save and deploy the integration flow on the tenant to process it.") :arrow_upper_right:. +5. Save and deploy the integration flow. diff --git a/docs/ISuite/50-Development/development-de1ae81.md b/docs/ISuite/50-Development/development-de1ae81.md index eb7c75c8..b589b19c 100644 --- a/docs/ISuite/50-Development/development-de1ae81.md +++ b/docs/ISuite/50-Development/development-de1ae81.md @@ -175,7 +175,7 @@ Test and debug the runtime behaviour of APIs. -[Test API Proxies](https://help.sap.com/viewer/66d066d903c2473f81ec33acfe2ccdb4/Cloud/en-US/3ba6151391bc474b9f1fa69455f65e3b.html "Use the API Test Console to test the runtime behavior of the API proxies.") :arrow_upper_right: +[Test API Proxies](https://help.sap.com/viewer/4425026877144cc2b15505ed30215167/IAT/en-US/3ba6151391bc474b9f1fa69455f65e3b.html "Use the API Test Console to test the runtime behavior of the API proxies.") :arrow_upper_right: @@ -230,7 +230,7 @@ Analyze API usage and performance. -[Analyze APIs](analyze-apis-7712c61.md) +[Analyze API Proxies](analyze-api-proxies-7712c61.md) @@ -247,7 +247,7 @@ Generate revenue from APIs. -[Monetize APIs](https://help.sap.com/viewer/66d066d903c2473f81ec33acfe2ccdb4/Cloud/en-US/fcdc89b5c4884d5e8cfb32c5914943ab.html "API Management provides monetization feature to all API providers to generate revenue for using the APIs.") :arrow_upper_right: + diff --git a/docs/ISuite/50-Development/enabling-anomaly-detection-98534a0.md b/docs/ISuite/50-Development/enabling-anomaly-detection-98534a0.md deleted file mode 100644 index 52f2a343..00000000 --- a/docs/ISuite/50-Development/enabling-anomaly-detection-98534a0.md +++ /dev/null @@ -1,42 +0,0 @@ - - -# Enabling Anomaly Detection - -To detect anomalies in API calls and analyze the detected anomalies in the analytics dashboard, you need to enable the anomaly detection setting. - - - - - -## Context - -To enable anomaly detection through the API portal, follow the steps below: - - - -## Procedure - -1. Log in to the API portal. - -2. Click on the navigation icon on the left and select *Settings*. - -3. Go to the *Anomaly Detection* tab. - -4. Toggle the radio button to the *ON* position to enable anomaly detection. - - - - - - -## Results - -Anomaly Detection for API calls is now enabled. - -**Related Information** - - -[Enabling APIs for Anomaly Detection](enabling-apis-for-anomaly-detection-9e7e5d1.md "The System Level Anomaly check is performed by default in the backend. However, for an API Level Anomaly check, specific APIs need to be selected.") - -[](https://help.sap.com/viewer/51ab953548be4459bfe8539ecaeee98d/CLOUD/en-US/1c677b2472f94aa28ea4fc4ecc4e4bef.html "") :arrow_upper_right: - diff --git a/docs/ISuite/50-Development/enabling-apis-for-anomaly-detection-9e7e5d1.md b/docs/ISuite/50-Development/enabling-apis-for-anomaly-detection-9e7e5d1.md deleted file mode 100644 index da072aa5..00000000 --- a/docs/ISuite/50-Development/enabling-apis-for-anomaly-detection-9e7e5d1.md +++ /dev/null @@ -1,41 +0,0 @@ - - -# Enabling APIs for Anomaly Detection - -The **System Level Anomaly** check is performed by default in the backend. However, for an **API Level Anomaly** check, specific APIs need to be selected. - - - - - -## Context - -To select or modify the APIs for anomaly detection, follow the steps below: - - - -## Procedure - -1. Log in to the API portal. - -2. Click on the navigation icon on the left and select *Settings*. - -3. Go to the *Anomaly Detection* tab. - -4. Toggle the radio button to the *ON* position to enable anomaly detection. - -5. In the **API Selection** section, you can view the list of APIs that have been selected for anomaly detection. - -6. Click *Modify* to make changes to the selection of APIs. - - > ### Note: - > The maximum number of APIs that can be monitored for anomaly detection is 5. - - -**Related Information** - - -[Enabling Anomaly Detection](enabling-anomaly-detection-98534a0.md "To detect anomalies in API calls and analyze the detected anomalies in the analytics dashboard, you need to enable the anomaly detection setting.") - -[](https://help.sap.com/viewer/51ab953548be4459bfe8539ecaeee98d/CLOUD/en-US/1c677b2472f94aa28ea4fc4ecc4e4bef.html "") :arrow_upper_right: - diff --git a/docs/ISuite/50-Development/enabling-content-transport-cloud-foundry-environment-452c677.md b/docs/ISuite/50-Development/enabling-content-transport-cloud-foundry-environment-452c677.md index e8a8870b..17212dc1 100644 --- a/docs/ISuite/50-Development/enabling-content-transport-cloud-foundry-environment-452c677.md +++ b/docs/ISuite/50-Development/enabling-content-transport-cloud-foundry-environment-452c677.md @@ -5,7 +5,7 @@ All the tasks mentioned here are one-time activities. The tenant administrator performs these tasks to enable content transport. > ### Note: -> To use the automatic transport options \(CTS+ or Cloud Transport Management\), you must enable an additional service – *Content Agent Service*. This service is responsible for packaging the integration content objects \(integration packages with their artifacts\) into MTAR files and handing them over to the transport mechanism. This service is always needed independently of the transport mechanism, whether CTS+ or Cloud Transport Management. +> To use the automatic transport options \(CTS+ or Cloud Transport Management\), you must enable an additional service – *Content Agent Service*. This service is responsible for packaging the integration content objects \(integration packages with their artifacts\) into MTAR files and handing them over to the transport mechanism. This service is always needed independently of the transport mechanism, whether CTS+ or. Enabling Content Transport involves the following major steps: diff --git a/docs/ISuite/50-Development/enabling-content-transport-using-sap-cloud-transport-management-service-4f55441.md b/docs/ISuite/50-Development/enabling-content-transport-using-sap-cloud-transport-management-service-4f55441.md index 01816c8f..c0012963 100644 --- a/docs/ISuite/50-Development/enabling-content-transport-using-sap-cloud-transport-management-service-4f55441.md +++ b/docs/ISuite/50-Development/enabling-content-transport-using-sap-cloud-transport-management-service-4f55441.md @@ -10,13 +10,13 @@ Configure the service instances and destinations, and establish a route between ## Prerequisites -- Create a source subaccount and subscribe to API portal, API Management. For more information, see [Set Up API Portal Application](https://help.sap.com/viewer/66d066d903c2473f81ec33acfe2ccdb4/Cloud/en-US/29c281b4a002404eba44e91c6fad0d34.html "To create APIs, products, import policy templates, and view applications, set up the API portal application.") :arrow_upper_right:. +- Create a source subaccount and subscribe to API portal, API Management. For more information, see [Set Up API Portal Application](https://help.sap.com/viewer/4425026877144cc2b15505ed30215167/IAT/en-US/29c281b4a002404eba44e91c6fad0d34.html "To create APIs, products, import policy templates, and view applications, set up the API portal application.") :arrow_upper_right:. - Create a **transport** subaccount and subscribe to SAP Cloud Transport Management service. Set up and subscribe to SAP Cloud Transport Management service as described in [Set Up the Environment to Transport Content Archives directly in an Application](https://help.sap.com/viewer/7f7160ec0d8546c6b3eab72fb5ad6fd8/Cloud/en-US/8d9490792ed14f1bbf8a6ac08a6bca64.html). To view and access the SAP Cloud Transport Management service, assign TMS\_ADMIN and TMS\_VIEWER roles to yourself. To set the roles, scroll down to "Steps to Assign User Roles and Permissions" section in [Set Up the Environment to Transport Content Archives directly in an Application](https://help.sap.com/viewer/7f7160ec0d8546c6b3eab72fb5ad6fd8/Cloud/en-US/8d9490792ed14f1bbf8a6ac08a6bca64.html). -- Create a **Destination** subaccount and subscribe to API portal, API Management. For more information, see [Set Up API Portal Application](https://help.sap.com/viewer/66d066d903c2473f81ec33acfe2ccdb4/Cloud/en-US/29c281b4a002404eba44e91c6fad0d34.html "To create APIs, products, import policy templates, and view applications, set up the API portal application.") :arrow_upper_right:. +- Create a **Destination** subaccount and subscribe to API portal, API Management. For more information, see [Set Up API Portal Application](https://help.sap.com/viewer/4425026877144cc2b15505ed30215167/IAT/en-US/29c281b4a002404eba44e91c6fad0d34.html "To create APIs, products, import policy templates, and view applications, set up the API portal application.") :arrow_upper_right:. diff --git a/docs/ISuite/50-Development/endpoint-visualization-6c3fb22.md b/docs/ISuite/50-Development/endpoint-visualization-6c3fb22.md index e3341b8c..c1ff6aca 100644 --- a/docs/ISuite/50-Development/endpoint-visualization-6c3fb22.md +++ b/docs/ISuite/50-Development/endpoint-visualization-6c3fb22.md @@ -151,7 +151,7 @@ SOAP sender adapter > ### Caution: > In case you want to download the WSDL in Cloud Foundry via a technical client, you need a service instance of the plan `api` assigned with the`MonitoringDataRead` role. It is not possible to use a service instance of plan `integration flow`. > - > See: [Creating Service Instance and Service Key for Inbound Authentication](../40-RemoteSystems/creating-service-instance-and-service-key-for-inbound-authentication-19af5e2.md) and [Tasks and Permissions](../60-Security/tasks-and-permissions-556d557.md). + > See: [Creating Service Instance and Service Key for Inbound Authentication](../40-RemoteSystems/creating-service-instance-and-service-key-for-inbound-authentication-19af5e2.md) and [Tasks and Permissions for Cloud Integration](../60-Security/tasks-and-permissions-for-cloud-integration-556d557.md). - *WSDL Policies* diff --git a/docs/ISuite/50-Development/engage-1036845.md b/docs/ISuite/50-Development/engage-1036845.md index ee18f153..3f8256a1 100644 --- a/docs/ISuite/50-Development/engage-1036845.md +++ b/docs/ISuite/50-Development/engage-1036845.md @@ -2,7 +2,7 @@ # Engage -Create products and view application details as they’re the key components used to manage and expose APIs to the developers. +Create products and view application details in SAP Integration Suite. The *Engage* section allows you create products, which represent a logical grouping of APIs. It allows you to bundle related APIs together, making it easier to manage and govern them as a unit. Products can be used to define usage quotas for the APIs they contain. diff --git a/docs/ISuite/50-Development/externally-managed-apis-848015d.md b/docs/ISuite/50-Development/externally-managed-apis-848015d.md index d2c6433d..e94c403e 100644 --- a/docs/ISuite/50-Development/externally-managed-apis-848015d.md +++ b/docs/ISuite/50-Development/externally-managed-apis-848015d.md @@ -2,7 +2,7 @@ # Externally Managed APIs -You can manage APIs that are not managed by SAP Integration Suite but by some other API Management solution. +You can add and view APIs that are not managed by SAP Integration Suite but by some other API Management solution. You can import an API definition \(Open API Specification 2.0 or 3.0\) of externally managed APIs in Integration Suite, without adding management capability \(proxy creation and policies\) of SAP Integration Suite and publish them to API business hub enterprise. @@ -21,3 +21,8 @@ You can import an API definition \(Open API Specification 2.0 or 3.0\) of extern - You can choose to manage the life cycle of these externally managed APIs after listing them. To do so, from the *Overview* page of the API, choose *Manage*. - You can list externally managed APIs by importing them. For more information, see [Import an API Definition](import-an-api-definition-9342a93.md). +**Related Information** + + +[Adding Externally Managed APIs](adding-externally-managed-apis-523ff94.md "To add an externally managed API, you must import the API definition of an externally managed API in Integration Suite.") + diff --git a/docs/ISuite/50-Development/guidelines-on-role-assignments-fc409e8.md b/docs/ISuite/50-Development/guidelines-on-role-assignments-fc409e8.md index 18667c07..a90f378f 100644 --- a/docs/ISuite/50-Development/guidelines-on-role-assignments-fc409e8.md +++ b/docs/ISuite/50-Development/guidelines-on-role-assignments-fc409e8.md @@ -2,7 +2,7 @@ # Guidelines on Role Assignments -The combined usage of the following role collections, respectively, authorization groups \(as described under [Persona](../60-Security/persona-2937e5c.md)\) gives you full control of the tenant in terms of design, monitoring, and administration. +The combined usage of the following role collections, respectively, authorization groups \(as described under [Personas for Cloud Integration](../60-Security/personas-for-cloud-integration-2937e5c.md)\) gives you full control of the tenant in terms of design, monitoring, and administration. Assigning these role collections/authorization groups to a user is a good choice for the source tenant \(development system\). However, assigning these role collections/authorization groups to a user on target tenants can lead to undesired behavior and inconsistencies with the transport system. To avoid that a user gets too many permissions in the target system, it's necessary to define permissions on a more detailed level on the target tenant \(test and production\). @@ -229,7 +229,7 @@ Allows user to access SAP Business Accelerator Hub \(*Discover* section\). -All roles related to the *Monitor* area \(see [Tasks and Permissions](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/fda781c59e4b46a390ce5b409f60365e.html "") :arrow_upper_right:\) +All roles related to the *Monitor* area \(see [Tasks and Permissions for Cloud Integration](../60-Security/tasks-and-permissions-for-cloud-integration-556d557.md)\) @@ -272,7 +272,7 @@ Allows user configure the transport option. -For more information on the individual roles and tasks, see [Tasks and Permissions](../60-Security/tasks-and-permissions-556d557.md). +For more information on the individual roles and tasks, see [Tasks and Permissions for Cloud Integration](../60-Security/tasks-and-permissions-for-cloud-integration-556d557.md). Certain roles must be assigned also in the transport system to determine the responsibilities of who can do what \(for example, import a transport order into a queue, release an order\). diff --git a/docs/ISuite/50-Development/handle-idoc-bulk-messages-e35e389.md b/docs/ISuite/50-Development/handle-idoc-bulk-messages-e35e389.md new file mode 100644 index 00000000..5d3440f2 --- /dev/null +++ b/docs/ISuite/50-Development/handle-idoc-bulk-messages-e35e389.md @@ -0,0 +1,158 @@ + + +# Handle IDoc Bulk Messages + +Learn how to set up scenarios with composite IDoc messages. + +IDoc \(Intermediate Document\) is a message format used by SAP systems for application integration \(see [IDocs \(SAP Library\)](https://help.sap.com/saphelp_46c/helpdata/en/0b/2a60ef507d11d18ee90000e8366fc2/content.htm?no_cache=true)\). A composite message is a message that consists of multiple items of the same structure. + +To implement exchange of IDoc messages between Cloud Integration and remote systems, you can use the IDoc sender and receiver adapter. These adapters also support the processing of composite messages as demonstrated in the following example scenario. Another integration flow component that comes into play when dealing with IDoc bulk messages is the *IDoc Splitter* which splits a composite IDoc message into individual IDocs. + +See also: + +- [Configure the IDoc Sender Adapter](configure-the-idoc-sender-adapter-bf769d6.md) + +- [Configure the IDoc Receiver Adapter](configure-the-idoc-receiver-adapter-018aa88.md) + +- [Define IDoc Splitter](define-idoc-splitter-4f250e4.md) + + + + + + +## Implementation + +The example scenario works in the following way: + +1. You use an HTTP client \(for example, Postman\) to send a bulk XML message to the first integration flow *IDoc Bulk Handling – Outbound*. This integration flow transforms the XML message to a \(bulk\) IDoc message and forwards the latter to a second integration flow *IDoc Bulk Handling – Inbound*. Both integration flows are deployed on the same tenant. + +2. Integration flow *IDoc Bulk Handling – Inbound* splits the composite message into single parts and sends them to the *Generic Receiver* integration flow. + +3. The *Generic Receiver* integration flow stores the resulting individual IDocs in a data store. + + +> ### Note: +> This scenario is a simplified demo version and is not suitable for use in a production environment. IDocs are used to exchange messages with SAP systems. Regarding this aspect, this scenario doesn’t show, in particular, how to set up the connection of Cloud Integration with SAP systems. +> +> To mock a sender system, an HTTP client and to simulate as receiver the *Generic Receiver* integration flow is used \(like in the other integration flow design guidelines\). + +The example integration flow *IDoc Bulk Handling – Outbound* is designed the following way:![](images/IDoc_Outbound_Flow_763a508.png) + +It performs the following steps: + +1. The sender \(HTTP client, for example, Postman\) sends an XML message to the integration flow through the HTTPS sender adapter. The XML message is a composite \(bulk\) message that contains three *Material* items. + +2. The Content Modifier *Set IDoc header* sets properties to define the IDoc control header, for example sender and receiver port, sender and receiver partner type, sender and receiver partner name, IDoc type, and so forth. + +3. The IDoc is sent to a receiver through an IDoc receiver adapter. The receiver is integration flow *IDoc Bulk Handling – Inbound* deployed on the same tenant. The sender integration flow authenticates itself against the receiver using basic authentication \(with credentials stored in the *User Credentials* artifact *OWN*\). + + As *IDoc Content Type* the option *Text/XML* is selected \(only this content type supports composed messages\). + + For each single IDoc within the IDoc bulk message, the IDoc receiver adapter creates a transfer ID and an IDoc number. Note that the header *SapIDocTransferId* contains as value the transfer ID of the first IDoc in the composite message only. The same applies for the header *sapidocdbid*: it contains the IDoc number of the first IDoc in the composite message only. You can access the complete list of IDoc transfer IDs and the assigned IDoc numbers either from the header *SapIDocAssignMap* or from the payload of the response message. + + +The example integration flow *IDoc Bulk Handling – Inbound* is designed the following way: + +![](images/IDoc_Inbound_Flow_f8d6430.png) + +It performs the following steps: + +1. The integration flow receives an IDoc bulk message from integration flow *IDoc Bulk Handling – Outbound* \(through the IDoc sender adapter\). + + The received composite IDoc message contains the header *SapIDocTransferId*. Its value specifies the transfer ID of the first IDoc only. + + Note that this header contains the incoming IDoc number from the sending system and corresponds to the field *DOCNUM*. + +2. The Content Modifier *Set SAP headers* defines the following headers: + + - *SAP\_Sender* with XPath expression *//EDI\_DC40/SNDPRN* + + - *SAP\_MessageType* based on header *sapidoctype* + + +3. The *IDoc Splitter* step splits the composite message into individual IDocs. + +4. Content Modifier *Set DataStore Context* sets the context for the *Generic Receiver* integration flow. + +5. Finally, the integration flow sends the messages to the *Generic Receiver* integration flow through the ProcessDirect adapter. + + Like in the other integration flow design guidelines, the *Generic Receiver* integration flow simulates \(mocks\) a receiver system. In this specific scenario, imagine the receiver system \(for the IDoc messages\) to be an SAP system. In a real-live scenario, such a receiver system is connected with an IDoc receiver adapter. In our example scenario, the *Generic Receiver* is used to store the resulting message in a data store. This integration flow is deployed on the same tenant and connected with the integration flow by the ProcessDirect adapter. + + +To test the scenario, perform the following steps: + +1. Set up inbound *Basic* authentication for integration flow endpoints. + + See: + + [Basic Authentication with clientId and clientsecret for Integration Flow Processing](../40-RemoteSystems/basic-authentication-with-clientid-and-clientsecret-for-integration-flow-processing-647eeb3.md) + +2. Deploy a *User Credentials* artifact with the following parameters using the *Monitor* application \(*Security Material* tile under *Manage Security*\). + + + + + + + + + + + + + + + + + + + +
+ + Parameter + + + + Setting + +
+ + Name + + + + OWN + +
+ + User + + + + Enter the user as specified when setting up inbound basic authentication. + +
+ + Password + + + + Enter the password as specified when setting up inbound basic authentication. + +
+ + > ### Note: + > When you check out the integration flow *IDoc Bulk Handling – Outbound*, you notice that the IDoc receiver adapter refers to a *User Credentials* artifact with the name *OWN*. + +3. Deploy all 3 integration *IDoc Bulk Handling – Outbound*, *IDoc Bulk Handling – Inbound*, and *Generic Receiver*. + +4. In the Postman client, open the *HandlingIDocBulks* folder in the *Integration Flow Design Guidelines - Learn the Basics* collection, and first run the *HandlingIDocBulks\_GetXsrfToken* request to fetch the CSRF token. Then, run the *HandlingIDocBulks* request to post the sample message to the *IDoc Bulk Handling – Outbound* integration flow. + +5. Once the system has processed the message successfully, you receive an IDoc response that contains the list of transfer IDs and IDoc numbers of all IDoc messages in the IDoc bulk. Furthermore, check the data store *IDocBulk* \(open the *Monitor* application and select the *Data Stores* tile under *Manage Stores*\). You notice three new entries whereas the data store IDs correspond to the IDoc numbers. + +6. Before rerunning the test, clean up the data store. + +7. Optionally, you can switch the log level of the deployed integration flows to *Trace* to be able to verify the overall behavior. In particular, you can use the trace to evaluate the value of the headers *SapIDocTransferId*, *SapIDocAssignMap*, and *sapidocdbid*. + + diff --git a/docs/ISuite/50-Development/images/CatalogImage5_49e100b.png b/docs/ISuite/50-Development/images/CatalogImage5_49e100b.png new file mode 100644 index 00000000..4903eca9 Binary files /dev/null and b/docs/ISuite/50-Development/images/CatalogImage5_49e100b.png differ diff --git a/docs/ISuite/50-Development/images/ConnectListImage3_06ef74d.png b/docs/ISuite/50-Development/images/ConnectListImage3_06ef74d.png new file mode 100644 index 00000000..ab698686 Binary files /dev/null and b/docs/ISuite/50-Development/images/ConnectListImage3_06ef74d.png differ diff --git a/docs/ISuite/50-Development/images/Coupa_Receiver_Adapter_dccbe44.png b/docs/ISuite/50-Development/images/Coupa_Receiver_Adapter_dccbe44.png new file mode 100644 index 00000000..8ccc5dc4 Binary files /dev/null and b/docs/ISuite/50-Development/images/Coupa_Receiver_Adapter_dccbe44.png differ diff --git a/docs/ISuite/50-Development/images/CreateImage1_3bf6c81.png b/docs/ISuite/50-Development/images/CreateImage1_3bf6c81.png new file mode 100644 index 00000000..4b1d7431 Binary files /dev/null and b/docs/ISuite/50-Development/images/CreateImage1_3bf6c81.png differ diff --git a/docs/ISuite/50-Development/images/IDoc_Inbound_Flow_f8d6430.png b/docs/ISuite/50-Development/images/IDoc_Inbound_Flow_f8d6430.png new file mode 100644 index 00000000..3eb66855 Binary files /dev/null and b/docs/ISuite/50-Development/images/IDoc_Inbound_Flow_f8d6430.png differ diff --git a/docs/ISuite/50-Development/images/IDoc_Outbound_Flow_763a508.png b/docs/ISuite/50-Development/images/IDoc_Outbound_Flow_763a508.png new file mode 100644 index 00000000..46a22c8e Binary files /dev/null and b/docs/ISuite/50-Development/images/IDoc_Outbound_Flow_763a508.png differ diff --git a/docs/ISuite/50-Development/images/InternetImage4_354b74e.png b/docs/ISuite/50-Development/images/InternetImage4_354b74e.png new file mode 100644 index 00000000..99b3bde5 Binary files /dev/null and b/docs/ISuite/50-Development/images/InternetImage4_354b74e.png differ diff --git a/docs/ISuite/50-Development/images/OverviewImage2_9550dd7.png b/docs/ISuite/50-Development/images/OverviewImage2_9550dd7.png new file mode 100644 index 00000000..8986e17d Binary files /dev/null and b/docs/ISuite/50-Development/images/OverviewImage2_9550dd7.png differ diff --git a/docs/ISuite/50-Development/images/Swagger_definition_0fffa2e.png b/docs/ISuite/50-Development/images/Swagger_definition_0fffa2e.png index 621bba7c..f4042dc8 100644 Binary files a/docs/ISuite/50-Development/images/Swagger_definition_0fffa2e.png and b/docs/ISuite/50-Development/images/Swagger_definition_0fffa2e.png differ diff --git a/docs/ISuite/50-Development/images/TestConnectionImage6_82dccf5.png b/docs/ISuite/50-Development/images/TestConnectionImage6_82dccf5.png new file mode 100644 index 00000000..e9956606 Binary files /dev/null and b/docs/ISuite/50-Development/images/TestConnectionImage6_82dccf5.png differ diff --git a/docs/ISuite/50-Development/import-function-library-from-es-repository-d6e7585.md b/docs/ISuite/50-Development/import-function-library-from-es-repository-d6e7585.md index ddfd11f8..2f8bfac4 100644 --- a/docs/ISuite/50-Development/import-function-library-from-es-repository-d6e7585.md +++ b/docs/ISuite/50-Development/import-function-library-from-es-repository-d6e7585.md @@ -21,13 +21,9 @@ There are certain limitations while importing and consuming the function library object: -- Function library object with user-defined functions of ExecutionType**ALL\_VALUES\_OF\_QUEUE** is not supported. - -- Function library object that has references to imported archives is not supported. - - The combination of the attributes `category` and `title` in a function library's method must be unique. No two methods within a function library class can have the same combination. -- An imported function library object can be consumed in integration flows via message mapping flow steps and message mapping artifacts. For other artifacts like REST API or OData service, you can consume only via message mapping artifacts; not via message mapping flow steps. +- An imported function library object can be consumed in integration flows via message-mapping flow steps and message mapping artifacts. For other artifacts like REST API or OData service, you can consume only via message mapping artifacts; not via message-mapping flow steps. @@ -48,7 +44,7 @@ There are certain limitations while importing and consuming the function library 5. Choose a function library object of your choice and choose *Select*. - The selected function library object gets imported to resource pane. + The selected function library object gets imported to the resource pane. 6. Choose the imported object. @@ -56,4 +52,8 @@ There are certain limitations while importing and consuming the function library 7. Make necessary changes to the java class as per your requirement and choose *Save*. + For example, if you want to change the execution type, find the `executionType` key and change its value. The supported values for execution type are: `SINGLE_VALUE`, `ALL_VALUES_OF_QUEUE`, and `ALL_VALUES_OF_CONTEXT`. + +8. Deploy the Function Libraries artifact before consumption. + diff --git a/docs/ISuite/50-Development/importing-custom-integration-adapter-482286e.md b/docs/ISuite/50-Development/importing-custom-integration-adapter-482286e.md index 3c6efb2a..a2109c68 100644 --- a/docs/ISuite/50-Development/importing-custom-integration-adapter-482286e.md +++ b/docs/ISuite/50-Development/importing-custom-integration-adapter-482286e.md @@ -14,7 +14,7 @@ Use the integration-adapter artifact type to import custom integration adapter i - You've exported integration adapter content, which is essentially an `*.esa` file in your local file system. -- You’ve assigned the role template *WorkspacePackagesEdit* and *WorkspaceArtifactsDeploy* that are required to accomplish the various tasks when working with custom integration adapter. For more information, see [Tasks and Permissions](../60-Security/tasks-and-permissions-556d557.md). +- You’ve assigned the role template *WorkspacePackagesEdit* and *WorkspaceArtifactsDeploy* that are required to accomplish the various tasks when working with custom integration adapter. For more information, see [Tasks and Permissions for Cloud Integration](../60-Security/tasks-and-permissions-for-cloud-integration-556d557.md). - You’ve created an integration package. For more information, see [Create an Integration Package](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/748968a0f43d442f98d93a9a197cdbd2.html). diff --git a/docs/ISuite/50-Development/inject-mapping-artifacts-to-sap-cloud-integration-47ad97e.md b/docs/ISuite/50-Development/inject-mapping-artifacts-to-sap-cloud-integration-47ad97e.md index 53044a40..cf2f3e1e 100644 --- a/docs/ISuite/50-Development/inject-mapping-artifacts-to-sap-cloud-integration-47ad97e.md +++ b/docs/ISuite/50-Development/inject-mapping-artifacts-to-sap-cloud-integration-47ad97e.md @@ -127,9 +127,7 @@ You need to maintain the SAP Cloud Integration tenant details into which you nee > > You need to register the client application as the OAuth client in the consumer account using the SAP BTP cockpit with the TMN node details. In the *Security* \> *OAuth* section, go to the *Clients* tab. Under *Subscription*, enter the VM name of the TMN node\(it ends with the node type `.tmn`\). > - > For information on creating OAuuth client credentials for Neo environment, see: [Creating OAuth Client Credentials for Neo Environment](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/040d8110293d44b1bfaa75674530d395.html "The API is protected by basic authentication and OAuth.") :arrow_upper_right: - > - > For information on creating OAuth client credentials for Cloud Foundry, see: [Creating OAuth Client Credentials for Cloud Foundry Environment](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/50b63c69028643b18016d6795003392d.html "You can create OAuth client credentials to access your SAP Cloud Integration tenant hosted on the Cloud Foundry environment.") :arrow_upper_right:. + > For information on creating OAuth client credentials for Cloud Foundry, see: [Creating OAuth Client Credentials for Cloud Foundry Environment](creating-oauth-client-credentials-for-cloud-foundry-environment-50b63c6.md). diff --git a/docs/ISuite/50-Development/inspect-a4d5e49.md b/docs/ISuite/50-Development/inspect-a4d5e49.md index e4b77b55..6dd82fbd 100644 --- a/docs/ISuite/50-Development/inspect-a4d5e49.md +++ b/docs/ISuite/50-Development/inspect-a4d5e49.md @@ -9,7 +9,7 @@ Each SAP Integration Suite tenant comes with certain physical resources that are You can inspect consumption of integration resources, identify those integration flows that contribute significantly to integration-resource exhaustion, and perform steps to resolve critical situations. Based on the insights, you can, for example, optimize integration flow design to overcome integration resource bottlenecks. > ### Note: -> To use this feature, role collection `MonitoringDataRead` needs to be assigned to your user \(see [Tasks and Permissions](../60-Security/tasks-and-permissions-556d557.md)\). +> To use this feature, role collection `MonitoringDataRead` needs to be assigned to your user \(see [Tasks and Permissions for Cloud Integration](../60-Security/tasks-and-permissions-for-cloud-integration-556d557.md)\). diff --git a/docs/ISuite/50-Development/inspect-data-store-usage-fcc08f6.md b/docs/ISuite/50-Development/inspect-data-store-usage-fcc08f6.md index 8e6a393b..f6b8a299 100644 --- a/docs/ISuite/50-Development/inspect-data-store-usage-fcc08f6.md +++ b/docs/ISuite/50-Development/inspect-data-store-usage-fcc08f6.md @@ -55,23 +55,6 @@ Database Connection Usage -Critical - - - - -Red - - - - -More than 90% - - - - - - Warning @@ -82,7 +65,7 @@ Orange -Between 70% and 90% +100% or more @@ -99,7 +82,7 @@ Green -Less than 70% +Less than 100% diff --git a/docs/ISuite/50-Development/inspect-monitoring-storage-usage-216dc43.md b/docs/ISuite/50-Development/inspect-monitoring-storage-usage-216dc43.md index 614d84db..517fc965 100644 --- a/docs/ISuite/50-Development/inspect-monitoring-storage-usage-216dc43.md +++ b/docs/ISuite/50-Development/inspect-monitoring-storage-usage-216dc43.md @@ -6,9 +6,6 @@ Inspect usage of the monitoring storage database for a given time period \(as se At runtime, monitoring data is written to a database. For each integration flow processed at runtime, a message processing log is written that contains information about the processing steps \(see [Message Processing Log](message-processing-log-b32f8cd.md)\). -> ### Tip: -> Each SAP Integration Suite tenant is associated with a physical database that has a limited size. This database is used by certain steps during the runtime of integration flows. - > ### Note: > The *Time* filter element allows you to select the time interval \(options: *Past Day*, *Past Week*, *Past Month*, or *Custom*\). > @@ -18,9 +15,9 @@ At runtime, monitoring data is written to a database. For each integration flow The usage of database storage is plotted in a bar graph against time. -The bar height shows the data volume \(in MB\) used by monitoring data for a given time period \(as selected with the *Time* parameter\). +The bar height shows the total data volume \(in MB\) stored in the monitoring database for a given time period \(as selected with the *Time* parameter\). For example, the value of a bar at the time period 11:00-12:00 does not represent the amount of monitoring data that was added during 11:00-12:00, but rather the total amount of monitoring data found in the database during 11:00-12:00. -A green bullet represents the total count of message processing logs. +A blue bullet represents the count of message processing logs. With the *Message Processing Status* parameter, you can filter the count of message processing logs by status. The default value is *All*. That means, the total count of message processing logs is displayed. The level of usage is indicated by the bar height and color \(from green for low usage, up to red for critical usage\). The thresholds are based on the assigned database capacity for monitoring storage consumption in the monitoring database. @@ -46,23 +43,6 @@ Monitoring Storage Usage -Critical - - - - -Red - - - - -More than 90% - - - - - - Warning @@ -73,7 +53,7 @@ Orange -Between 70% and 90% +100% and more @@ -90,7 +70,7 @@ Green -Less than 70% +Less than 100% @@ -151,6 +131,8 @@ See: [Setting Log Levels](setting-log-levels-4e6d3fc.md) You can also check if there are integration flows showing many erroneous message processing logs. To filter for such integration flows, set the *Message Processing Status* filter to *Failed*. Check the respective integration flow and fix the root cause for the failures. +You might see a critical status, even though there were not too many message processing logs in the past 24 hours. In this situation you have to extend the time selection to *Past Week* or even *Past Month*, to reveal the point of time when a large amount of message processing logs further in the past could have filled the monitoring storage to a critical level. Note also that monitoring data is removed only through an automated cleanup job, which removes monitoring data for which the retention period has expired \(30 days by default\). + More information: [Guidelines and Best Practices for Message Monitoring](guidelines-and-best-practices-for-message-monitoring-6f598b4.md) diff --git a/docs/ISuite/50-Development/inspect-top-global-data-stores-by-usage-00431bf.md b/docs/ISuite/50-Development/inspect-top-global-data-stores-by-usage-00431bf.md index 52e0c589..ca692232 100644 --- a/docs/ISuite/50-Development/inspect-top-global-data-stores-by-usage-00431bf.md +++ b/docs/ISuite/50-Development/inspect-top-global-data-stores-by-usage-00431bf.md @@ -16,7 +16,7 @@ Click a cell to get more context information and to get access to the following Navigate to the *Monitor Message Processing* screen for the time period covered by the bar \(see [Monitor Message Processing](monitor-message-processing-314df3f.md)\). -- *Show Integration Content* +- *Show Data Stores* Navigate to the *Data Stores* tile, *Manage Stores* screen, to show all data stores of the tenant \(see [Managing Data Stores](managing-data-stores-ac39f1d.md)\). diff --git a/docs/ISuite/50-Development/inspect-top-local-data-stores-by-usage-55670e6.md b/docs/ISuite/50-Development/inspect-top-local-data-stores-by-usage-55670e6.md index 191bbe7a..84eabbfa 100644 --- a/docs/ISuite/50-Development/inspect-top-local-data-stores-by-usage-55670e6.md +++ b/docs/ISuite/50-Development/inspect-top-local-data-stores-by-usage-55670e6.md @@ -16,7 +16,7 @@ Click a cell to get more context information and to get access to the following Navigate to the *Monitor Message Processing* screen for the time period covered by the bar \(see [Monitor Message Processing](monitor-message-processing-314df3f.md)\). -- *Show Integration Content* +- *Show Data Stores* Navigate to the *Data Stores* tile, *Manage Stores* screen, to show all data stores of the tenant \(see [Managing Data Stores](managing-data-stores-ac39f1d.md)\). @@ -24,6 +24,10 @@ Click a cell to get more context information and to get access to the following Inspect database connection usage \(can correlate with database consumption by data stores\). +- *Inspect Data Store* + + Inspect resource consmumption for the selected data store. + - *Copy Name to Clipboard* diff --git a/docs/ISuite/50-Development/integration-artifact-types-bf932e0.md b/docs/ISuite/50-Development/integration-artifact-types-bf932e0.md index 8b663015..0bdff475 100644 --- a/docs/ISuite/50-Development/integration-artifact-types-bf932e0.md +++ b/docs/ISuite/50-Development/integration-artifact-types-bf932e0.md @@ -32,9 +32,13 @@ You can design the following integration artifact types with the Cloud Integrati A set of scripts that can be used in a Script integration flow step \(see [Creating a Script Collection](creating-a-script-collection-824bff0.md)\). -- Function libraries +- Function Libraries - Contains functions that can be used in a mapping \(see [Working with Function Libraries](working-with-function-libraries-dd8c30d.md)\). + Contains functions from ESR that can be used in a mapping \(see [Working with Function Libraries](working-with-function-libraries-dd8c30d.md)\). + +- Imported Archives + + Contains imported archives from ESR that can be used in a mapping \(see [Working with Imported Archives](working-with-imported-archives-e00e81d.md)\). - Integration adapter diff --git a/docs/ISuite/50-Development/integration-content-d1679a8.md b/docs/ISuite/50-Development/integration-content-d1679a8.md index 0e659a23..1fb4ecaa 100644 --- a/docs/ISuite/50-Development/integration-content-d1679a8.md +++ b/docs/ISuite/50-Development/integration-content-d1679a8.md @@ -109,7 +109,7 @@ To authorize an API client to access the OData API, perform the steps as describ Perform the steps described at: [Setting Up Inbound HTTP Connections \(for API Clients\)](../40-RemoteSystems/setting-up-inbound-http-connections-for-api-clients-8db3d51.md) -Assign the role template as listed for the desired task \(for example, download deployed integration flow\) under [Tasks and Permissions](../60-Security/tasks-and-permissions-556d557.md). +Assign the role template as listed for the desired task \(for example, download deployed integration flow\) under [Tasks and Permissions for Cloud Integration](../60-Security/tasks-and-permissions-for-cloud-integration-556d557.md). To be able to maintain custom tags: diff --git a/docs/ISuite/50-Development/interchange-processing-flow-7d3bce9.md b/docs/ISuite/50-Development/interchange-processing-flow-7d3bce9.md index a9570123..1a307f64 100644 --- a/docs/ISuite/50-Development/interchange-processing-flow-7d3bce9.md +++ b/docs/ISuite/50-Development/interchange-processing-flow-7d3bce9.md @@ -6,9 +6,9 @@ This integration flow transforms the message sent by the sending partner to the structure expected by the receiving partner. -Follow the procedure below to configure the integration flow +Follow the procedure below to configure the integration flow: -1. In the *Artifacts* tab, choose the *Action* button of the integration flow *Step 2 - Interchange Processing Flow* and select *Configure* +1. In the *Artifacts* tab, choose *Action* of the integration flow *Step 2 - Interchange Processing Flow* and select *Configure*. 2. Under the *Sender* tab, maintain the following parameter. @@ -57,7 +57,7 @@ Follow the procedure below to configure the integration flow -3. Choose the *Receiver* tab and maintain the following parameter +3. Choose the *Receiver* tab and maintain the following parameter. **Receiver Parameter** diff --git a/docs/ISuite/50-Development/library-of-type-systems-740136b.md b/docs/ISuite/50-Development/library-of-type-systems-740136b.md index b3dfc5ad..08bdfdba 100644 --- a/docs/ISuite/50-Development/library-of-type-systems-740136b.md +++ b/docs/ISuite/50-Development/library-of-type-systems-740136b.md @@ -4,7 +4,7 @@ The library of type systems is a collection of message templates that are provided by agencies that maintain the B2B/A2A/B2G standards. Each of the type system is developed and maintained by the agency that owns it. For example, the type system *SAP IDoc* is developed and maintained by SAP SE. Similarly, the type system ASC X12 is maintained by ANSI ASC X12. This is a very good starting point for implementing your B2B integration provided if you and your business partners are using these industry standards for your business messages. -A typical type system in the library is comprised of a collection of messages, and associated complex types, simple types, and code lists. Refer to [Terminology & Glossary for SAP Integration Advisor](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/9c221b48799a4ce59367b0e3367f5a8f.html "") :arrow_upper_right: to get an understanding of Messages, Complex Types, Simple Types and Codelists. +A typical type system in the library is comprised of a collection of messages, and associated complex types, simple types, and code lists. Refer to [Glossary for SAP Integration Advisor](../glossary-for-sap-integration-advisor-9c221b4.md) to get an understanding of Messages, Complex Types, Simple Types and Codelists. ![The graphic gives an overview of a typical type system in your library.](images/ICA_-_Library_of_Type_Systems_3ea131a.png) diff --git a/docs/ISuite/50-Development/limitations-for-xml-to-json-conversion-4bf5a05.md b/docs/ISuite/50-Development/limitations-for-xml-to-json-conversion-4bf5a05.md index ef313f2f..04aa0633 100644 --- a/docs/ISuite/50-Development/limitations-for-xml-to-json-conversion-4bf5a05.md +++ b/docs/ISuite/50-Development/limitations-for-xml-to-json-conversion-4bf5a05.md @@ -27,9 +27,9 @@ The XML to JSON conversion has the following limitations: [Define XML to JSON Converter](define-xml-to-json-converter-a60a282.md "The XML to JSON converter enables you to transform messages in XML format to JSON format.") - + [How Streaming in the XML-to-JSON Converter Works](how-streaming-in-the-xml-to-json-converter-works-4e05044.md "During streaming the XML document is processed in parts or segments:") - + diff --git a/docs/ISuite/50-Development/lookup-cache-dcb1507.md b/docs/ISuite/50-Development/lookup-cache-dcb1507.md index e0423983..32b1d6ca 100644 --- a/docs/ISuite/50-Development/lookup-cache-dcb1507.md +++ b/docs/ISuite/50-Development/lookup-cache-dcb1507.md @@ -4,7 +4,7 @@ An OAuth access token is written to the cache using a Populate Cache policy. The OAuth token is retrieved for subsequent requests by a Lookup Cache policy. -At runtime, the LookupCache policy retrieves a value from the cache, assigning the value to the variable you specify with the AssignTo element \(if no value is retrieved, the variable will not be set\). It looks for the value based on a cache key created through configuration that combines the CacheKey and Scope elements. In other words, to retrieve a particular value-added to the cache by a PopulateCache policy, your LookupCache policy must have cache key-related elements configured in the same way as the PopulateCache policy. +At runtime, the Lookup Cache policy retrieves a value from the cache, assigning the value to the variable you specify with the element \(if no value is retrieved, the variable will not be set\). It looks for the value based on a cache key created through configuration that combines the and elements. In other words, to retrieve a particular value-added to the cache by a Populate Cache policy, your Lookup Cache policy must have cache key related elements configured in the same way as the Populate Cache policy. You can retrieve cached values with the Lookup Cache policy. @@ -71,7 +71,7 @@ Scope -Enumeration used to construct a prefix for a cache key when a Prefix element is not provided in the CacheKey element.The list of supported values are: Global, Application, Proxy, Target, and Exclusive. +Enumeration used to construct a prefix for a cache key when a Prefix element is not provided in the element.The list of supported values are: Global, Application, Proxy, Target, and Exclusive. @@ -115,8 +115,6 @@ Specifies a value that should be included in the cache key, creating a namespace The following predefined Flow variables are available after you customize the behavior of the cache you define in a Lookup Cache policy. -**Flow Variables** - diff --git a/docs/ISuite/50-Development/mail-sender-for-imap-5b94e42.md b/docs/ISuite/50-Development/mail-sender-for-imap-5b94e42.md index b892090b..f27b12c8 100644 --- a/docs/ISuite/50-Development/mail-sender-for-imap-5b94e42.md +++ b/docs/ISuite/50-Development/mail-sender-for-imap-5b94e42.md @@ -4,7 +4,7 @@ You use the mail sender adapter to download e-mails from mailboxes using the Internet Message Access Protocol \(IMAP\) protocol, to access the content of the e-mail body, and to access e-mail attachments. -To use this adapter, create a sender channel and as *Adapter Type* select *Mail* \> *IMAP4* \> *.* \(see [Overview of Integration Flow Editor](overview-of-integration-flow-editor-db10beb.md)\). +To use this adapter, create a sender channel and as *Adapter Type* select *Mail* \> *IMAP4* \> *,* see [Overview of Integration Flow Editor](overview-of-integration-flow-editor-db10beb.md). Configure the adapter parameters as described at [Configure the Mail Sender Adapter](configure-the-mail-sender-adapter-e23e9cc.md). diff --git a/docs/ISuite/50-Development/manage-certificates-c665875.md b/docs/ISuite/50-Development/manage-certificates-c665875.md index 25174807..8b39bafd 100644 --- a/docs/ISuite/50-Development/manage-certificates-c665875.md +++ b/docs/ISuite/50-Development/manage-certificates-c665875.md @@ -29,7 +29,7 @@ The following are the supported file format for certificates: .cer, .jar \(signe 1. Log on to Integration Suite . -2. Choose the navigation icon on the top-left and choose *Configure* \> *APIs*. . +2. Choose the navigation icon on the top-left and choose *Configure* \> *APIs*. 3. Select the *Certificates* tab. @@ -40,7 +40,7 @@ The following are the supported file format for certificates: .cer, .jar \(signe - *Trust Store* - A truststore contains certificates used to verify certificates received as part of SSL handshaking. If the certificate received by an SSL client is signed by a valid certificate authority \(CA\), then the client makes a request to the CA to authenticate the certificate else self-signed certificate can be uploaded in the truststore. > ### Note: - > Since client certificate chains are used in the authentication process to establish the identity of clients accessing the API Management service, it is important to ensure that these chains have sufficient security measures in place. Weak client certificate chains lack the necessary security measures and are therefore vulnerable to attacks. As a result, weak client certificate chains have been deprecated. For more detailed information, please[3418201 - Deprecation of Weak Client Certificate Chains in API Management \(sap.corp\)](https://i7p.wdf.sap.corp/sap(bD1lbiZjPTAwMQ==)/bc/bsp/sno/ui_entry/entry.htm?param=69765F6D6F64653D3030312669765F7361706E6F7465735F6E756D6265723D3334313832303126). + > Since client certificate chains are used in the authentication process to establish the identity of clients accessing the API Management service, it is important to ensure that these chains have sufficient security measures in place. Weak client certificate chains lack the necessary security measures and are therefore vulnerable to attacks. As a result, weak client certificate chains have been deprecated. For more detailed information, please [3418201 - Deprecation of Weak Client Certificate Chains in API Management \(sap.corp\)](https://i7p.wdf.sap.corp/sap(bD1lbiZjPTAwMQ==)/bc/bsp/sno/ui_entry/entry.htm?param=69765F6D6F64653D3030312669765F7361706E6F7465735F6E756D6265723D3334313832303126). - *Key Store* - A keystore contains an SSL certificate and private key used to validate the server during SSL handshaking. diff --git a/docs/ISuite/50-Development/manage-access-9df3ece.md b/docs/ISuite/50-Development/manage-developer-access-9df3ece.md similarity index 99% rename from docs/ISuite/50-Development/manage-access-9df3ece.md rename to docs/ISuite/50-Development/manage-developer-access-9df3ece.md index ab414d23..a39d22e1 100644 --- a/docs/ISuite/50-Development/manage-access-9df3ece.md +++ b/docs/ISuite/50-Development/manage-developer-access-9df3ece.md @@ -1,6 +1,6 @@ -# Manage Access +# Manage Developer Access As an API business hub enterprise admin, you have the authority to control the level of access for your users, allowing them to search, discover, and access the content available on the API business hub enterprise. diff --git a/docs/ISuite/50-Development/manage-domain-categories-new-design-bd9691d.md b/docs/ISuite/50-Development/manage-domain-categories-new-design-bd9691d.md index fe303368..39f3974b 100644 --- a/docs/ISuite/50-Development/manage-domain-categories-new-design-bd9691d.md +++ b/docs/ISuite/50-Development/manage-domain-categories-new-design-bd9691d.md @@ -20,7 +20,7 @@ You need the following roles to create and update categories: - *AuthGroup.API.Admin* - To assign the role, see [User Roles in API Management \(New\)](../user-roles-in-api-management-new-911ca5a.md) . + To assign the role, see [Tasks and Corresponding Role Collections](../tasks-and-corresponding-role-collections-911ca5a.md) . diff --git a/docs/ISuite/50-Development/manage-external-content-new-design-f5bd17d.md b/docs/ISuite/50-Development/manage-external-content-new-design-f5bd17d.md index c1882eca..f961203d 100644 --- a/docs/ISuite/50-Development/manage-external-content-new-design-f5bd17d.md +++ b/docs/ISuite/50-Development/manage-external-content-new-design-f5bd17d.md @@ -12,7 +12,7 @@ On this page, you have the option to adjust the visibility of the Graph navigato - Assign the *AuthGroup.API.Admin* role. - To assign the role, see [User Roles in API Management \(New\)](../user-roles-in-api-management-new-911ca5a.md) . + To assign the role, see [Tasks and Corresponding Role Collections](../tasks-and-corresponding-role-collections-911ca5a.md) . - Enable *Graph* in Integration Suite. For more information, see [Activating and Managing Capabilities](https://help.sap.com/docs/integration-suite/sap-integration-suite/activating-and-managing-capabilities?version=CLOUD) and [Configuring User Access](https://help.sap.com/docs/integration-suite/sap-integration-suite/configuring-user-access?version=CLOUD). diff --git a/docs/ISuite/50-Development/manage-navigation-categories-classic-design-7f1a44b.md b/docs/ISuite/50-Development/manage-navigation-categories-classic-design-7f1a44b.md index a60b7b09..45cf5120 100644 --- a/docs/ISuite/50-Development/manage-navigation-categories-classic-design-7f1a44b.md +++ b/docs/ISuite/50-Development/manage-navigation-categories-classic-design-7f1a44b.md @@ -2,7 +2,7 @@ # Manage Navigation Categories \[Classic Design\] -Navigation categories are displayed on the home page. +Manage and configure the navigation categories. @@ -12,12 +12,17 @@ Navigation categories are displayed on the home page. You have the content admin role assigned to you. +> ### Caution: +> Effective June 2024, the classic design of the API business hub enterprise will be deprecated and will no longer be accessible. The new design of the API business hub enterprise will be set as your default design from March 2024. For more information, see [Configure the API business hub enterprise \[New Design\]](configure-the-api-business-hub-enterprise-new-design-54b4607.md). + ## Context +Navigation categories are displayed on the home page. + > ### Note: > This document describes the classic design of the API business hub enterprise. To view the documentation for the new design, see [Manage Domain Categories \[New Design\]](manage-domain-categories-new-design-bd9691d.md). diff --git a/docs/ISuite/50-Development/manage-resources-of-an-integration-flow-b5968b2.md b/docs/ISuite/50-Development/manage-resources-b5968b2.md similarity index 97% rename from docs/ISuite/50-Development/manage-resources-of-an-integration-flow-b5968b2.md rename to docs/ISuite/50-Development/manage-resources-b5968b2.md index cb1ad417..4b9e8cdd 100644 --- a/docs/ISuite/50-Development/manage-resources-of-an-integration-flow-b5968b2.md +++ b/docs/ISuite/50-Development/manage-resources-b5968b2.md @@ -2,7 +2,7 @@ -# Manage Resources of an Integration Flow +# Manage Resources Use *References* tab to manage different resources associated within an integration content optimally. The term "resources" refers to a collection of different categories of file types. @@ -57,6 +57,8 @@ File System Integration Flow +API Artifact + diff --git a/docs/ISuite/50-Development/python-script-8703aa8.md b/docs/ISuite/50-Development/python-script-8703aa8.md index 8cc8c9c8..6343fd77 100644 --- a/docs/ISuite/50-Development/python-script-8703aa8.md +++ b/docs/ISuite/50-Development/python-script-8703aa8.md @@ -13,7 +13,7 @@ Jython version 2.5.2 provides the required python language support. You can find > ### Note: > The third-party libraries you add must be implemented in pure python language only. -A Python policy contains no actual code. Instead, a Python policy references a Python 'resource' and defines the Step in the API flow where the Python script executes. The Python Script resource must always have the .py extension. +The Python Script policy contains no actual code. Instead, it references a Python resource and defines the Step in the API flow where the Python script executes. The Python Script resource must always have the .py extension. You can attach this policy in the following locations: ![](images/Flow_policy_116062b.png) @@ -32,7 +32,8 @@ An example payload for the policy is as follows: > > ``` > -> An example of a mainscript.py script +> > ### Example: +> > mainscript.py > > > ### Code Syntax: > > ``` @@ -43,87 +44,181 @@ An example payload for the policy is as follows: > > print "x is 1." > > ``` +**`timeLimit` attribute of the ` +> ``` - - +
@@ -88,6 +90,8 @@ Integration Flow ES Repository +API Artifact + @@ -136,6 +140,8 @@ File System Integration Flow +API Artifact + @@ -169,6 +175,8 @@ File System Integration Flow +API Artifact + @@ -193,6 +201,8 @@ File System Integration Flow +API Artifact + @@ -222,6 +232,8 @@ File System Integration Flow +API Artifact + @@ -250,6 +262,8 @@ Integration Flow ES Repository +API Artifact + @@ -276,6 +290,8 @@ File System Integration Flow +API Artifact + @@ -302,6 +318,8 @@ File System Integration Flow +API Artifact + diff --git a/docs/ISuite/50-Development/manage-updates-classic-design-94e37b4.md b/docs/ISuite/50-Development/manage-updates-classic-design-94e37b4.md index 66a5a805..523ab671 100644 --- a/docs/ISuite/50-Development/manage-updates-classic-design-94e37b4.md +++ b/docs/ISuite/50-Development/manage-updates-classic-design-94e37b4.md @@ -2,7 +2,7 @@ # Manage Updates \[Classic Design\] -Configure the updates to be displayed in the *Updates* section on the home page. +Manage and configure updates. @@ -12,11 +12,14 @@ Configure the updates to be displayed in the *Updates* section on the home page. You have the site admin role assigned to you. +> ### Caution: +> Effective June 2024, the classic design of the API business hub enterprise will be deprecated and will no longer be accessible. The new design of the API business hub enterprise will be set as your default design from March 2024. For more information, see [Configure the API business hub enterprise \[New Design\]](configure-the-api-business-hub-enterprise-new-design-54b4607.md). + ## Context -Use the following procedure to configure updates. +Configure the updates to be displayed in the *Updates* section on the home page. Use the following procedure to configure updates. diff --git a/docs/ISuite/50-Development/managing-jdbc-data-sources-4c873fa.md b/docs/ISuite/50-Development/managing-jdbc-data-sources-4c873fa.md index 50e8de11..42732911 100644 --- a/docs/ISuite/50-Development/managing-jdbc-data-sources-4c873fa.md +++ b/docs/ISuite/50-Development/managing-jdbc-data-sources-4c873fa.md @@ -223,8 +223,11 @@ After you complete the above configuration, now create a JDBC data source for yo 5. Deploy the data source. +> ### Recommendation: +> Limit the number of deployed data sources to 49 at any point of time to avoid any business process disruption. + > ### Note: -> To undeploy a data source, select it from the list and choose *Undeploy*. The system displays a warning and requires you to confirm the task. After confirmation the data source is undeployed and removed from the list. +> - To undeploy a data source, select it from the list and choose *Undeploy*. The system displays a warning and requires you to confirm the task. After confirmation the data source is undeployed and removed from the list. diff --git a/docs/ISuite/50-Development/managing-the-access-request-of-the-users-classic-design-5b3e2f6.md b/docs/ISuite/50-Development/managing-the-access-request-of-the-users-classic-design-5b3e2f6.md index 7869ec10..18cd8c6f 100644 --- a/docs/ISuite/50-Development/managing-the-access-request-of-the-users-classic-design-5b3e2f6.md +++ b/docs/ISuite/50-Development/managing-the-access-request-of-the-users-classic-design-5b3e2f6.md @@ -12,7 +12,10 @@ Procedure to provide or reject access to an Application developer for using the ## Prerequisites -You’re assigned the *AuthGroup.API.Admin* role. +The *AuthGroup.API.Admin* role must be assigned to you. + +> ### Caution: +> Effective June 2024, the classic design of the API business hub enterprise will be deprecated and will no longer be accessible. The new design of the API business hub enterprise will be set as your default design from March 2024. For more information, see [Configure the API business hub enterprise \[New Design\]](configure-the-api-business-hub-enterprise-new-design-54b4607.md). > ### Note: > This document describes the classic design of the API business hub enterprise. To view the documentation for the new design, see [Managing the Access Request of the Users \[New Design\]](managing-the-access-request-of-the-users-new-design-8b79ee8.md). diff --git a/docs/ISuite/50-Development/managing-the-access-request-of-the-users-new-design-8b79ee8.md b/docs/ISuite/50-Development/managing-the-access-request-of-the-users-new-design-8b79ee8.md index 79745d93..c3adfb9f 100644 --- a/docs/ISuite/50-Development/managing-the-access-request-of-the-users-new-design-8b79ee8.md +++ b/docs/ISuite/50-Development/managing-the-access-request-of-the-users-new-design-8b79ee8.md @@ -36,6 +36,9 @@ You’re assigned the *AuthGroup.API.Admin* role. 4. Look for the request and choose *Accept Request* from the *Actions* coulmn. The application developer can now access the API business hub enterprise. + > ### Note: + > The user will be added to all the IDPs configured in the sub-account, along with the *ApplicationDeveloper* role. + If you don't wish to provide access to the user, choose *Decline Request* from the *Actions* coulmn. On accepting the request, an approval email is sent to the requester. On rejecting a request, you need to provide a reason for rejection; an email notification is sent to the requester. diff --git a/docs/ISuite/50-Development/message-processing-logs-827a2d7.md b/docs/ISuite/50-Development/message-processing-logs-827a2d7.md index 8bed14da..baf3a1a7 100644 --- a/docs/ISuite/50-Development/message-processing-logs-827a2d7.md +++ b/docs/ISuite/50-Development/message-processing-logs-827a2d7.md @@ -30,7 +30,7 @@ Perform the steps described in: [Setting Up Inbound HTTP Connections \(for API C Assign the following role template: -`MonitoringDataRead` \(see [Tasks and Permissions](../60-Security/tasks-and-permissions-556d557.md)\) +`MonitoringDataRead` \(see [Tasks and Permissions for Cloud Integration](../60-Security/tasks-and-permissions-for-cloud-integration-556d557.md)\) To access the ID Mapper, assign role template `MessageProcessingLocksRead`. diff --git a/docs/ISuite/50-Development/message-stores-1aab5e9.md b/docs/ISuite/50-Development/message-stores-1aab5e9.md index f6ca0170..ab347f87 100644 --- a/docs/ISuite/50-Development/message-stores-1aab5e9.md +++ b/docs/ISuite/50-Development/message-stores-1aab5e9.md @@ -72,7 +72,7 @@ To authorize an API client to access the OData API: Perform the steps described in: [Setting Up Inbound HTTP Connections \(for API Clients\)](../40-RemoteSystems/setting-up-inbound-http-connections-for-api-clients-8db3d51.md) -Depending on the use case, assign the following role templates \(see [Tasks and Permissions](../60-Security/tasks-and-permissions-556d557.md)\): +Depending on the use case, assign the following role templates \(see [Tasks and Permissions for Cloud Integration](../60-Security/tasks-and-permissions-for-cloud-integration-556d557.md)\): - To view message store content: `MonitoringDataRead` diff --git a/docs/ISuite/50-Development/message-validation-policy-e68da2f.md b/docs/ISuite/50-Development/message-validation-policy-e68da2f.md index ea2334e0..d8443adb 100644 --- a/docs/ISuite/50-Development/message-validation-policy-e68da2f.md +++ b/docs/ISuite/50-Development/message-validation-policy-e68da2f.md @@ -21,8 +21,9 @@ An example payload for the policy is as follows > contain a element with name "msg" and type string --> > > -> string -> response +> string +> +> request > xsd://validation.xsd > > @@ -32,36 +33,68 @@ An example payload for the policy is as follows > > ``` +**Attributes of the `` element** + + + + + + + + + +
-**Elements and Attributes** +Attribute + + + +Default + + + +Type -**Description** +Description
-Name +`async` + + + +false -The internal name of the policy. Characters you can use in the name are restricted to: A-Z0-9.\_\\-$ %. Optionally, use the element to label the policy in the UI proxy editor with a different, natural-language name. +String + + + +This attribute is deprecated.
-continueOnError +`continueOnError` + + + +false + + + +String @@ -73,7 +106,17 @@ Set to false to return an error when a policy fails. This is expected behavior f
-enabled +`enabled` + + + +true + + + +String @@ -82,88 +125,212 @@ Set to true to enforce the policy. Set to false to "turn off" the policy. The po
+ +**`` element** + + + + + + + + + - - +
+ +Element + + + +Default + + + +Type + + + +Description + +
-async +`Element` \(Mandatory\) -This attribute is deprecated. +N/A
-DisplayName +N/A -Use in addition to the name attribute to label the policy in the management UI proxy editor with a different, natural-language name. If you omit this element, then the value of the policy's name attribute is used. +Specifies the root, or parent, element of the messages to be validated. + +> ### Sample Code: +> ``` +> PurchaseOrder +> ``` + +
+ +**`namespace` attribute of the `` element** + + + + + + + + + + + +
+ +Attribute + + + +Default + + + +Type + + + +Description + +
-Source +`namespace` -Identifies the source message to be validated. +http://sample.com -If you do not provide a value, a value of message is used. + -If the variable cannot be resolved, or resolves to a non-message type, then one of the following occurs: +String -If the source variable resolves to a null value in the message flow, a steps.messagevalidation.SourceMessageNotAvailable error code is thrown. + -If the source variable resolves to a non-message value, a steps.messagevalidation.NonMessageVariable error code is thrown. +Provides the namespace of the root, or parent, element of the messages to be validated.
+ +**`` element** + + + + + + + + + + + +
+ +Element + + + +Default + + + +Type + + + +Description + +
-ResourceURL +`SOAPMessage` \(Mandatory\) -Identifies the XSD schema or WSDL definition to be used to validate the source message. +N/A -If the WSDL does not have schemas or if the maximum import depth exceeds 10, message validation will fail. + -If a value is not specified, the message is checked for well-formed JSON or XML if the content-type is application/json or application/xml, respectively. +N/A -Default: wsdl:// + + +Provides the SOAP version against which to validate SOAP messages. + +> ### Sample Code: +> ``` +> +> ``` -Presence: Optional -Type: String
+ +**`version` attribute of the `` element** + + + + + + + + + - - +
+ +Attribute + + + +Default + + + +Type + + + +Description + +
-SOAPMessage +`version` -Provides the SOAP version against which to validate SOAP messages. +N/A
-Version +N/A @@ -172,31 +339,129 @@ Identifies the SOAP version against which to validate SOAP messages. Valid value
+ +**`` element** + + + - + + + + + + + + +
+ Element + + +Default + + + +Type + + + +Description + +
+ +`Source` + -Specifies the root, or parent, element of the messages to be validated. +N/A + + + +N/A + + + +Identifies the source message to be validated. + +If you do not provide a `` value, a value of message is used. + +If the `` variable cannot be resolved, or resolves to a non-message type, then one of the following occurs: + +If the `` variable resolves to a null value in the message flow, a steps.messagevalidation.SourceMessageNotAvailable error code is thrown. + +If the `` variable resolves to a non-message value, a steps.messagevalidation.NonMessageVariable error code is thrown. + +> ### Sample Code: +> ``` +> request +> ``` -PurchaseOrder -PurchaseOrder
+ +**`` element** + + + + + + + + + + + diff --git a/docs/ISuite/50-Development/monetize-49b7841.md b/docs/ISuite/50-Development/monetize-49b7841.md index 4a0a06c9..39494da1 100644 --- a/docs/ISuite/50-Development/monetize-49b7841.md +++ b/docs/ISuite/50-Development/monetize-49b7841.md @@ -2,7 +2,7 @@ # Monetize -Use the *Monetize* section to monetize artifacts created on the SAP Integration Suite. +Monetize artifacts created in SAP Integration Suite. -To know more about monetizing APIs, see [Monetize APIs](https://help.sap.com/viewer/66d066d903c2473f81ec33acfe2ccdb4/Cloud/en-US/fcdc89b5c4884d5e8cfb32c5914943ab.html "API Management provides monetization feature to all API providers to generate revenue for using the APIs.") :arrow_upper_right:. +To know more about monetizing APIs, see . diff --git a/docs/ISuite/50-Development/monetize-apis-f6ab151.md b/docs/ISuite/50-Development/monetize-apis-f6ab151.md index 2c8ea120..76b7a1a7 100644 --- a/docs/ISuite/50-Development/monetize-apis-f6ab151.md +++ b/docs/ISuite/50-Development/monetize-apis-f6ab151.md @@ -10,8 +10,8 @@ As an application developer, in the API business hub enterprise you can create a SAP Integration Suite provides this feature through the following services: -- [Rate Plan Service](https://help.sap.com/viewer/66d066d903c2473f81ec33acfe2ccdb4/Cloud/en-US/f4537cef059e44ee8e0f8536f80f1599.html "API Management allows user to create rate plans and attach a rate plan to a product. Through a rate plan you can charge the application developers for the use of your APIs.") :arrow_upper_right: -- [Billing Service](https://help.sap.com/viewer/66d066d903c2473f81ec33acfe2ccdb4/Cloud/en-US/1e20fb575ad644399a7af8e1c4f423d0.html "Billing service is available in both API portal and API business hub enterprise.") :arrow_upper_right: +- +- -If you were creating, updating, or reading an application using the APIs and not through the user interface, then you need to switch to Subscription entity from Application entity to use the Monetize feature. For more information see, [Create or Update or Read an Application using Subscription key](https://help.sap.com/viewer/66d066d903c2473f81ec33acfe2ccdb4/Cloud/en-US/e2645b5658e64fdfae97aa952756dd01.html "Creating, updating, and reading an application using the Subscription key.") :arrow_upper_right: +If you were creating, updating, or reading an application using the APIs and not through the user interface, then you need to switch to Subscription entity from Application entity to use the Monetize feature. For more information, see diff --git a/docs/ISuite/50-Development/monitor-650995c.md b/docs/ISuite/50-Development/monitor-650995c.md index 0b4f84b7..fc417b48 100644 --- a/docs/ISuite/50-Development/monitor-650995c.md +++ b/docs/ISuite/50-Development/monitor-650995c.md @@ -57,7 +57,7 @@ APIs diff --git a/docs/ISuite/50-Development/monitoring-b2b-messages-b5e1fc9.md b/docs/ISuite/50-Development/monitoring-b2b-messages-b5e1fc9.md index 62d54210..4f30a224 100644 --- a/docs/ISuite/50-Development/monitoring-b2b-messages-b5e1fc9.md +++ b/docs/ISuite/50-Development/monitoring-b2b-messages-b5e1fc9.md @@ -24,27 +24,28 @@ An interchange is the incoming payload for B2B transactions. It is a bulk messag > ### Note: > Choose *Custom* from the *Interchange Creation Date Time* field dropdown if you want to access messages that were created between a specific time period. -6. If you want to customise your filter options, choose *Adapt Filters*. -7. In the resulting dialog box, select or unselect fields depending on your preference and choose *OK*. +6. You can filter the messages using their payload archiving status using the *Archiving Status* field. +7. If you want to customise your filter options, choose *Adapt Filters*. +8. In the resulting dialog box, select or unselect fields depending on your preference and choose *OK*. > ### Note: > If you had defined any custom search attributes in your active agreements, they will appear in *Adapt Filters* dialog. Select them if you want to customise your search option. -8. You can also save your customised filter options using the *Save As* option provided under the down icon after the title *Standard\**. -9. You can also export the interchanges in Excel format using the icon provided proceeding the list. -10. Choose and open an interchange from the *Interchanges* list. -11. The *Error Information* tab provides additional error information for the failed interchanges. Choose *Details* to access more information about the error. -12. If there are any issues with the agreement configuration, the *Error Information* tab provides a *Check Agreements* option. Select it to review the agreement details. -13. The *Used Agreement Data in Message* section provides the Partner Directory information of the interchange. -14. The corresponding transaction activities are listed in the *Valid Agreements* table. You can also filter the table details using the filter option provided by selecting the column header. Choose *Close* after viewing the details. -15. The *General* tab of your interchange displays the following information +9. You can also save your customised filter options using the *Save As* option provided under the down icon after the title *Standard\**. +10. You can also export the interchanges in Excel format using the icon provided proceeding the list. +11. Choose and open an interchange from the *Interchanges* list. +12. The *Error Information* tab provides additional error information for the failed interchanges. Choose *Details* to access more information about the error. +13. If there are any issues with the agreement configuration, the *Error Information* tab provides a *Check Agreements* option. Select it to review the agreement details. +14. The *Used Agreement Data in Message* section provides the Partner Directory information of the interchange. +15. The corresponding transaction activities are listed in the *Valid Agreements* table. You can also filter the table details using the filter option provided by selecting the column header. Choose *Close* after viewing the details. +16. The *General* tab of your interchange displays the following information 1. General Information 2. Custom Attributes \(if defined in the agreement transaction\) 3. Sender 4. Receiver -16. The *Events* tab displays the list of business transaction events with the following details +17. The *Events* tab displays the list of business transaction events with the following details 1. *ID* Provides the unique identification number for the event @@ -62,21 +63,21 @@ An interchange is the incoming payload for B2B transactions. It is a bulk messag Provides you a reference link to the message details -17. Choose the link provided under *Monitoring Reference* for an event. It displays the message processing details of the integration flow involved in the transaction in a new window. -18. The *Interchange Payload* tab displays the payload file of the interchange. You can choose to open either the sender or receiver payload from the drop-down list provided in the *Version* field. -19. Choose *Download* provided after the *Version* field if you want to download the interchange payload. -20. Navigate to the *Unassigned Interchanges* tile after the *Monitor* tab. -21. This tile displays the interchanges that resulted in an error early during the processing. -22. You can also filter the unassigned interchanges based on +18. Choose the link provided under *Monitoring Reference* for an event. It displays the message processing details of the integration flow involved in the transaction in a new window. +19. The *Interchange Payload* tab displays the payload file of the interchange. You can choose to open either the sender or receiver payload from the drop-down list provided in the *Version* field. +20. Choose *Download* provided after the *Version* field if you want to download the interchange payload. +21. Navigate to the *Unassigned Interchanges* tile after the *Monitor* tab. +22. This tile displays the interchanges that resulted in an error early during the processing. +23. You can also filter the unassigned interchanges based on - Error Date Time - Error Category - Error Information - MPL ID -23. Set the filter based on your requirements and choose *Go*. -24. Choose and open an interchange from the list. -25. You can review the details of the error in the resulting dialog. The link after *Message Processing Log ID* displays the error log details of the integration flow involved in the transaction. +24. Set the filter based on your requirements and choose *Go*. +25. Choose and open an interchange from the list. +26. You can review the details of the error in the resulting dialog. The link after *Message Processing Log ID* displays the error log details of the integration flow involved in the transaction. diff --git a/docs/ISuite/50-Development/naming-conventions-7c00e9b.md b/docs/ISuite/50-Development/naming-conventions-7c00e9b.md index aaf62fb4..fde85f40 100644 --- a/docs/ISuite/50-Development/naming-conventions-7c00e9b.md +++ b/docs/ISuite/50-Development/naming-conventions-7c00e9b.md @@ -12,7 +12,7 @@ It's important to have a logical system behind the naming patterns applied. This ### Integration Packages -The Integration Package is the folder containing or organizing your integration content \(integration flows, value mappings, APIs, and so forth\). Right now, an Integration Package is the minimum unit that can be transported. See [Create an Integration Package](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/748968a0f43d442f98d93a9a197cdbd2.html "Create an integration package that contains your integration flows.") :arrow_upper_right:. +The Integration Package is the folder containing or organizing your integration content \(integration flows, value mappings, APIs, and so forth\). Right now, an Integration Package is the minimum unit that can be transported. See [Creating an Integration Package](creating-an-integration-package-9126d79.md). The naming convention for custom integration packages is as follows: @@ -890,7 +890,7 @@ Description: Meaningful step description in camelCase ### Security Artifacts -Security artifacts are the credentials needed to connect to an external system. See [Security Elements](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/26e42b1d69304ce39b908fd11882e7ab.html "To set up the secure communication between a tenant and a sender/receiver system, certain security elements have to be created and - in some cases - exchanged between the involved components (the tenant on the one side and the sender/receiver system on the other side of the communication).") :arrow_upper_right:. +Security artifacts are the credentials needed to connect to an external system. The naming convention is as follows: diff --git a/docs/ISuite/50-Development/oauth-v2-0-09b5abb.md b/docs/ISuite/50-Development/oauth-v2-0-09b5abb.md index 2ff2d91d..d5e87b15 100644 --- a/docs/ISuite/50-Development/oauth-v2-0-09b5abb.md +++ b/docs/ISuite/50-Development/oauth-v2-0-09b5abb.md @@ -925,6 +925,59 @@ fault.name = "invalid\_request"
+ +Element + + + +Default + + + +Type + + + +Description + +
-namespace +`ResourceURL` \(Optional\) + + + +wsdl:// + + + +String -Provides the namespace of the root, or parent, element of the messages to be validated. Default: "http://sample.com" +Identifies the XSD schema or WSDL definition to be used to validate the source message. + +If the WSDL does not have schemas or if the maximum import depth exceeds 10, message validation will fail. + +If a `` value is not specified, the message is checked for well-formed JSON or XML if the content-type is application/json or application/xml, respectively. + +> ### Sample Code: +> ``` +> xsd://validation.xsd +> ``` + +
-[Analyze APIs](analyze-apis-7712c61.md) +[Analyze API Proxies](analyze-api-proxies-7712c61.md)
+ + + + +## Non-RFC-compliant Behavior + +The OAuthV2 policy returns a token response that contains certain non-RFC-compliant properties. The following table shows the non-compliant properties returned by the OAuthV2 policy and the corresponding compliant properties: + + + + + + + + + + + + + + + +
+ +OAuthV2 returns: + + + +The RFC-compliant property is: + +
+ +`"token_type":"BearerToken"` + + + +`"token_type":"Bearer"` + +
+ +`"expires_in":"3600"` + + + +`"expires_in":3600` + +
+ +Also, the error response for an expired refresh token when grant\_type = refresh\_token is:`{"ErrorCode" : "invalid_request", "Error" :"Refresh Token expired"}`. However, the RFC-compliant response is: `{"error" : "invalid_grant", "error_description" :"refresh token expired"}`. + +> ### Note: +> If you require that these elements be compliant, you can create a policy, such as a JavaScript or AssignMessage policy, to transform the policy output into a compliant format. + **Related Information** diff --git a/docs/ISuite/50-Development/odata-api-a617d6f.md b/docs/ISuite/50-Development/odata-api-a617d6f.md index 234aae9c..9d8e0d59 100644 --- a/docs/ISuite/50-Development/odata-api-a617d6f.md +++ b/docs/ISuite/50-Development/odata-api-a617d6f.md @@ -12,7 +12,7 @@ You can find the OData API on SAP Business Accelerator Hub at: A prerequisite for using the OData API is that your user is connected to Cloud Integration and that you have access to an OData client. -Individual actions that you can perform using the OData API are protected by an authorization concept. To find out the required role for the task that you want to perform with the OData API, see [Tasks and Permissions](../60-Security/tasks-and-permissions-556d557.md). +Individual actions that you can perform using the OData API are protected by an authorization concept. To find out the required role for the task that you want to perform with the OData API, see [Tasks and Permissions for Cloud Integration](../60-Security/tasks-and-permissions-for-cloud-integration-556d557.md). The OData API covers the following aspects: diff --git a/docs/ISuite/50-Development/onboard-an-application-developer-786d107.md b/docs/ISuite/50-Development/onboard-an-application-developer-786d107.md index f30ffe55..8fafd3e7 100644 --- a/docs/ISuite/50-Development/onboard-an-application-developer-786d107.md +++ b/docs/ISuite/50-Development/onboard-an-application-developer-786d107.md @@ -20,6 +20,6 @@ To provide application developers with access to the API business hub enterprise 2. The API administrator approves or rejects the request to access the API business hub enterprise. For more information, see [Managing the Access Request of the Users \[Classic Design\]](managing-the-access-request-of-the-users-classic-design-5b3e2f6.md). - If you haven’t enabled the automatic creation of shadow users, and you've not explicitly created shadow users for your developers, then they’re unable to log on to the application, and they’re asked to contact the administrator. For more information, see [Shadow Users](https://help.sap.com/viewer/38c3df3f8da44a809f937220b3579607/Cloud/en-US/a0f5fe580ed846ca95f8601678509add.html "Whenever a user authenticates at an application in your subaccount using any identity provider, it’s essential that user-related data provided by the identity provider is stored in the form of shadow users.") :arrow_upper_right: + If you haven’t enabled the automatic creation of shadow users, and you've not explicitly created shadow users for your developers, then they’re unable to log on to the application, and they’re asked to contact the administrator. For more information, see [Shadow Users](https://help.sap.com/viewer/4425026877144cc2b15505ed30215167/IAT/en-US/a0f5fe580ed846ca95f8601678509add.html "Whenever a user authenticates at an application in your subaccount using any identity provider, it’s essential that user-related data provided by the identity provider is stored in the form of shadow users.") :arrow_upper_right: diff --git a/docs/ISuite/50-Development/package-details-f0bf802.md b/docs/ISuite/50-Development/package-details-f0bf802.md index ee3ca9f0..f4aeabb9 100644 --- a/docs/ISuite/50-Development/package-details-f0bf802.md +++ b/docs/ISuite/50-Development/package-details-f0bf802.md @@ -27,9 +27,9 @@ Each package has the following details: You can view the details of an API, a policy template, or an API proxy by choosing the respective artifact. This opens a screen that provides the details of that particular artifact. - To copy APIs, choose the Action icon and choose *Copy*. In the *Copy API* window, provide the necessary information. You can either leave the information displayed for *API Details* as it is, or you can change it. After the action is completed, you can view the copied API by navigating to *Design* \> *APIs* \> *POLICY TEMPLATES*. Alternatively, you can copy the APIs by choosing the respective artifact and then, on the screen that opens, choosing *Copy*. + To copy APIs, choose the Action icon and choose *Copy*. In the *Copy API* window, provide the necessary information. You can either leave the information displayed for *API Details* as it is, or you can change it. After the action is completed, you can view the copied API by navigating to *Configure* \> *APIs* \> *POLICY TEMPLATES*. Alternatively, you can copy the APIs by choosing the respective artifact and then, on the screen that opens, choosing *Copy*. - To copy a policy template, choose the Action icon and select *Copy*. After the action is completed, you can view the copied policy template by navigating to *Design* \> *APIs* \> *POLICY TEMPLATES*. Alternatively, you can copy the policy template by choosing the respective artifact and the, on the screen that opens, choosing *Copy*. + To copy a policy template, choose the Action icon and select *Copy*. After the action is completed, you can view the copied policy template by navigating to *Configure* \> *APIs* \> *POLICY TEMPLATES*. Alternatively, you can copy the policy template by choosing the respective artifact and the, on the screen that opens, choosing *Copy*. - **Documents** diff --git a/docs/ISuite/50-Development/payload-indicator-in-integration-flow-message-processing-7f322c0.md b/docs/ISuite/50-Development/payload-indicator-in-integration-flow-message-processing-7f322c0.md index 18b6fe6d..b707ac9e 100644 --- a/docs/ISuite/50-Development/payload-indicator-in-integration-flow-message-processing-7f322c0.md +++ b/docs/ISuite/50-Development/payload-indicator-in-integration-flow-message-processing-7f322c0.md @@ -6,12 +6,12 @@ Monitor the message processing of the integration flows. The *Monitor* tab of the Cloud Integration tenant allows you to monitor the message processing of the integration flows. To know more, see [Monitoring](https://help.sap.com/docs/CLOUD_INTEGRATION/368c481cd6954bdfa5d0435479fd4eaf/05446d0616d44e1daf821c273b69fcc6.html). -1. Log on to your Integration Suite . +1. Log on to your Integration Suite. 2. Choose *Monitor* \> *Integrations*. 3. Choose *All Integration Flows* tile under the *Monitor Message Processing* section. -4. Select the integration flow for which you want to see the processing information and choose *Trace* link provided next to the *Log Level* field on the right side. -5. In the resulting screen, select the step for which you want to see the message content. Choose *Send Receiver Interchange* to see the payload. +4. Select the integration flow for which you want to check the processing information and choose *Trace* link provided next to the *Log Level* field on the right side. +5. In the resulting screen, select the step for which you want to check the message content. Choose *Send Receiver Interchange* to review the payload. 6. Choose *Message Content* on the right side and select the *Payload* tab. 7. This will display the payload of the agreement transaction. Depending on the purpose type configured in the company/trading partner profile, an indicator is set in the payload to display if the transaction is of type test, dev or prod. @@ -20,7 +20,7 @@ The *Monitor* tab of the Cloud Integration tenant allows you to monitor the mess > > And if you have modified the System Purpose of an active agreement, you need to reactivate the agreement to see the corresponding indicator in the payload. - The table below lists the receiver type system and the corresponding purpose indicator: + The following table lists the receiver type system and the corresponding purpose indicator: To help you understand, if the agreement has a trading partner system with the ASC-X12 type system as the receiver system, and the configured purpose is "Test", then the indicator value in the converted ASC-X12 payload will be "T". diff --git a/docs/ISuite/50-Development/permissions-eaa8779.md b/docs/ISuite/50-Development/permissions-eaa8779.md index 6d411a3e..97638a8e 100644 --- a/docs/ISuite/50-Development/permissions-eaa8779.md +++ b/docs/ISuite/50-Development/permissions-eaa8779.md @@ -12,7 +12,7 @@ The the role template `AuthGroup_TenantPartnerDirectoryConfigurator` grants perm More information: -[Persona](../60-Security/persona-2937e5c.md) +[Personas for Cloud Integration](../60-Security/personas-for-cloud-integration-2937e5c.md) -[Tasks and Permissions](../60-Security/tasks-and-permissions-556d557.md) +[Tasks and Permissions for Cloud Integration](../60-Security/tasks-and-permissions-for-cloud-integration-556d557.md) diff --git a/docs/ISuite/50-Development/policies-7e4f3e5.md b/docs/ISuite/50-Development/policies-7e4f3e5.md index 814971a2..ba747791 100644 --- a/docs/ISuite/50-Development/policies-7e4f3e5.md +++ b/docs/ISuite/50-Development/policies-7e4f3e5.md @@ -22,5 +22,5 @@ There are few policies that work as expected only when associated with multiple For example, Response Cache policy must be attached to both request and response Flow of an API proxy. In such cases, you can add Response Cache policy to a request flow & then attach the same to the response flow. -To attach a policy to multiple flows, select Add "+" against the required policy in the *Created Policies* area. +To attach a policy to multiple flows, click "+" against the required policy in the *Created Policies* area. diff --git a/docs/ISuite/50-Development/policy-template-structure-a0210da.md b/docs/ISuite/50-Development/policy-template-structure-a0210da.md index ccccc364..e0a833fa 100644 --- a/docs/ISuite/50-Development/policy-template-structure-a0210da.md +++ b/docs/ISuite/50-Development/policy-template-structure-a0210da.md @@ -95,7 +95,7 @@ Contains a list of all available policies. Each policy is available as a separat 		-Contains the header information of all the available policies. +Contains the header information of all the available policies \(including the policies associated with the default fault rules or a post-client flow\).
-Optional
+ +**`` element** + + + + + + + + + + + - @@ -167,22 +262,10 @@ This error occurs when the format of the resource URL specified within the `` or the `` attributes refer to a python file that doesn't exist, resulting in failure of API proxy deployment. - - - - -
+ +Element + + + +Default + + + +Type + + + +Description + +
+ +`ResourceURL` \(Required\) + + + +N/A + + -`ResourceURL` +N/A -This attribute specifies the primary python file that executes in the API flow. You must store this python file under `/APIProxy/FileResources/` in the API proxy bundle. +This attribute specifies the primary python file that executes in the API flow. You must store this python file under /APIProxy/FileResources/ in the API proxy bundle. The name of the primary python file must be of type ‘String’. > ### Note: > The python libraries you add must be implemented using pure python language only. +> ### Sample Code: +> ``` +> +> ``` - - -Yes
- -`NoResourceForURL` - - - -The `` and `` attributes refer to a Python Script file that doesn't exist. -
> ### Note: -> For added security API Management python runtime executes in a restricted mode, where import is not allowed for os, sys, and java.lang. +> Security API Management python runtime executes in a restricted mode, where import is not allowed for os, sys, and java.lang. diff --git a/docs/ISuite/50-Development/raise-fault-c7f2e8d.md b/docs/ISuite/50-Development/raise-fault-c7f2e8d.md index e5937861..e5150232 100644 --- a/docs/ISuite/50-Development/raise-fault-c7f2e8d.md +++ b/docs/ISuite/50-Development/raise-fault-c7f2e8d.md @@ -2,11 +2,11 @@ # Raise Fault -The RaiseFault policy allows you to create custom messages in case of error conditions. This policy returns a FaultResponse to the requesting application if it encounters an error condition. +The Raise Fault policy allows you to create custom messages in case of error conditions. This policy returns a Fault Response to the requesting application if it encounters an error condition. -A FaultResponse can consist of HTTP headers, query parameters, and a message payload. These elements can be populated using variables. This enables you to send customized FaultResponses that are specific to the error conditions. +A Fault Response can consist of HTTP headers, query parameters, and a message payload. These elements can be populated using variables. This enables you to send customized Fault Responses that are specific to the error conditions. -During execution, the RaiseFault policy transfers the message flow to the default ErrorFlow, which in turn returns the designated FaultResponse to the requesting application. When the message flow switches to the default ErrorFlow, no further policy processing occurs. All remaining processing steps are bypassed, and the FaultResponse is returned directly to the requesting app. +During the execution, the Raise Fault policy transfers the message flow to the default Error Flow, which in turn returns the designated Fault Response to the requesting application. When the message flow switches to the default Error Flow, no further policy processing occurs. All remaining processing steps are bypassed, and the Fault Response is returned directly to the requesting app. You can attach this policy in the following locations:![](images/Flow_policy_116062b.png) @@ -31,45 +31,425 @@ An example payload for the policy is as follows:: > > ``` +**`` element** + + + + + + +
-**Field Name** +Element + + + +Default -**Description** +Type + + + +Description
-IgnoreUnresolvedVariables\(Optional\) +`FaultResponse` -Ignores any unresolved variable error in the flow. +N/A -Valid values: `true` or `false` + -Default value: `true` +N/A + +Defines the response message returned to the requesting application. + +> ### Sample Code: +> ``` +> +> +> +> +> +> 500 +> Server Error +> +> +> ``` + + + +
+ +**``/`` element** + + + + + + + + + + + +
+ +Element + + + +Default + + + +Type + + + +Description + +
-FaultResponse\(Optional\) +`Set` -Defines the response message returned to the requesting application. +N/A + + + +N/A + + + +Sets information in the error message. + +> ### Sample Code: +> ``` +> +> +> +> +> 500 +> Server Error +> +> ``` + + + +
+ +**``/``/`` element** + + + + + + + + + + + + + + + +
+ +Element + + + +Default + + + +Type + + + +Description + +
+ +`Headers` \(Optional\) + + + +N/A + + + +String + + + +Sets or overwrites HTTP headers in the error message. + +> ### Sample Code: +> ``` +> +> +> +> +> ``` + + + +
+ +**``/``/`` element** + + + + + + + + + + + + + + + +
+ +Element + + + +Default + + + +Type + + + +Description + +
+ +`Payload` \(Optional\) + + + +N/A + + + +String + + + +Sets the payload of the error message. + +> ### Sample Code: +> ``` +> +> Sample Payload +> +> ``` + + + +
+ +**``/``/`` element** + + + + + + + + + + + + + + + +
+ +Element + + + +Default + + + +Type + + + +Description + +
+ +`StatusCode` \(Optional\) + + + +false + + + +Boolean + + + +Sets the status code of the response. + +> ### Sample Code: +> ``` +> +> 500 +> +> ``` + + + +
+ +**``/``/`` element** + + + + + + + + + + + + + + + +
+ +Element + + + +Default + + + +Type + + + +Description + +
+ +`ReasonPhrase` \(Optional\) + + + +false + + + +Boolean + + + +Sets the reason phrase of the response. + +> ### Sample Code: +> ``` +> +> Server Error +> +> ``` + + + +
+ +**`` element** + + + + + + + + + + + + + + diff --git a/docs/ISuite/50-Development/rate-plan-service-c27570f.md b/docs/ISuite/50-Development/rate-plan-service-c27570f.md index 0674d504..c2452f8a 100644 --- a/docs/ISuite/50-Development/rate-plan-service-c27570f.md +++ b/docs/ISuite/50-Development/rate-plan-service-c27570f.md @@ -6,8 +6,8 @@ SAP Integration Suite allows user to create rate plans and attach a rate plan to For more information see, -- [Create a Rate Plan](https://help.sap.com/viewer/66d066d903c2473f81ec33acfe2ccdb4/Cloud/en-US/cfe6a30600f148a39a7920dbc7fa1ab2.html "Create a rate plan using the API portal.") :arrow_upper_right: -- [Attach Rate Plan to a Product](https://help.sap.com/viewer/66d066d903c2473f81ec33acfe2ccdb4/Cloud/en-US/cc5c942e32df494785c33ba0fc0346f4.html "Attach a rate plan to a product using the API portal.") :arrow_upper_right: -- [Update a Rate Plan](https://help.sap.com/viewer/66d066d903c2473f81ec33acfe2ccdb4/Cloud/en-US/b8c1e6b68be74ead8700f7f8be9baa8b.html "Update a rate plan using the API portal.") :arrow_upper_right: -- [Delete a Rate Plan](https://help.sap.com/viewer/66d066d903c2473f81ec33acfe2ccdb4/Cloud/en-US/d4181ad418e4446e830c498d672204ff.html "Delete a rate plan using the API portal.") :arrow_upper_right: +- +- +- +- diff --git a/docs/ISuite/50-Development/reset-quota-e18ccb8.md b/docs/ISuite/50-Development/reset-quota-e18ccb8.md index e5bc2d1e..e47be572 100644 --- a/docs/ISuite/50-Development/reset-quota-e18ccb8.md +++ b/docs/ISuite/50-Development/reset-quota-e18ccb8.md @@ -18,85 +18,452 @@ An example payload for the policy is as follows: > > > -> 100 +> -**Elements and Attributes** +Element + + + + + + + +
+ +Element + + + +Default + + + +Type + + + +Description + +
+ +`IgnoreUnresolvedVariables` + + + +true + + + +Boolean + + + +Ignores any unresolved variable error in the Flow + +> ### Sample Code: +> ``` +> +> true +> +> ``` + +
+ +Default + + + +Type -**Description** +Description
-Quota \(Mandatory\) +`Quota` \(Mandatory\) + + + +N/A + + + +N/A Specifies the name of the Quota policy whose counter should be reset. -The ref attribute identifies the variable that fetches the Quota policy that has to be reset, +> ### Sample Code: +> ``` +> +> +> 100 +> +> +> ``` + + + +
+ +**Attributes of the `` element** + +> ### Note: +> Both `name` and `ref` are optional but at least one of the attributes should be used. + + + + + + + + + + + + + + + + + + + + +
+ +Attribute + + + +Default + + + +Type + + + +Description + +
+ +`name`\(Optional\) + + + +N/A + + + +N/A + + + +Specifies the name of the target Quota policy. + +
+ +`ref` \(Optional\) + + + +N/A + + + +N/A + + -Both name and ref are optional but at least one of attributes should be used. +A flow variable that contains the `name` of the target Quota policy. If both `ref` and `name` are specified, then `ref` gets priority. If `ref` does not resolve at runtime, then `name` is used.
+ +**`` element** + +> ### Note: +> Both `name` and `ref` are optional but at least one of the attributes should be used. + + + + + + + + + + + +
+ +Element + + + +Default + + + +Type + + + +Description + +
-Identifier \(Optional\) +`Identifier` \(Mandatory\) + + + +N/A + + + +String Specifies the name of the client. -The ref attribute is the variable used for uniquely identifying the client, for example client\_id. +> ### Sample Code: +> ``` +> +> +> 100 +> +> +> ``` + -Both name and ref are optional but at least one of attributes should be used.
+ +**Attributes of the `` element** + + + + + + + + + + + + + + + + + + + +
+ +Attribute + + + +Default + + + +Type + + + +Description + +
+ +`name`\(Optional\) + + -Allow \(Allow integer\) +N/A + + + +String + + + +Specifies the name of the count identifier in the target Quota policy. + +
+ +`ref` \(Optional\) + + + +N/A + + + +N/A + + + +A flow variable that contains the name of the count identifier in the target Quota policy. If both `ref` and `name` are specified, then `ref` gets priority. If `ref` does not resolve at runtime, then `name` is used. + +
+ +**`` element** + + + + + + + + + + + + + +
+ +Element + + + +Default + + + +Type + + + +Description + +
+ +`Allow` \(mandatory\) + + + +N/A + + + +Integer Specifies the message count to which the Quota will be reset. +> ### Sample Code: +> ``` +> +> +> 100 +> +> +> ``` + + +
+ +**`` element** + + + + + + + + + + + + + + + +
+ +Element + + + +Default + + + +Type + + + +Description + +
+ +`Class`\(Optional\) + + + +N/A + + + +N/A + + + +Specifies the class for which the Quota counter is updated. + +> ### Sample Code: +> ``` +> +> +> 100 +> +> +> ``` + + + +
+ +**`ref` attribute of the `` and elements** + + + + + + + + + + diff --git a/docs/ISuite/50-Development/reuse-imported-archives-objects-from-es-repository-4196091.md b/docs/ISuite/50-Development/reuse-imported-archives-objects-from-es-repository-4196091.md new file mode 100644 index 00000000..3b817309 --- /dev/null +++ b/docs/ISuite/50-Development/reuse-imported-archives-objects-from-es-repository-4196091.md @@ -0,0 +1,61 @@ + + +# Reuse Imported Archives Objects from ES Repository + + + + + +## Prerequisites + +- [Configuring Connectivity to an SAP Process Orchestration System](IntegrationSettings/configuring-connectivity-to-an-sap-process-orchestration-system-8c36fd2.md) + +- [Creating an Imported Archives Artifact](creating-an-imported-archives-artifact-e555caf.md) + + + + + + +## Context + +There are certain limitations while importing and consuming the imported archive objects: + +- You can import archive objects with XSLT mapping but you can't assign the mapping to a *XSLT Mapping* flow step. + +- You can import archive objects with Java mapping but you can't assign the mapping to an *Operation Mapping* flow step. + + + + +## Procedure + +1. Open the Imported Archives artifact that you created and choose *Edit*. + + The resource pane and editor comes up on the left and right sides respectively. + +2. In the resource pane, choose *Upload*. + +3. In the dialog box, choose *ES Repository* as the *Source*. + +4. Select the *Name* of the ES Repository that you want to connect with. + + You see the details populated in the *Address* and *Location ID* fields. + +5. Choose *Connect*. + + You see a list of available imported archive objects. + +6. Choose an imported archive object of your choice and choose *Select*. + + The selected imported archive object gets imported to the resource pane. + +7. Choose the imported archive object to view its content. + + The contents of the archive object appear in the editor pane. You see the name and path for all files contained in the archive object. + +8. Choose *Save*. + +9. Deploy the Imported Archives artifact. + + diff --git a/docs/ISuite/50-Development/revoke-access-classic-design-147fb9d.md b/docs/ISuite/50-Development/revoke-access-classic-design-147fb9d.md index 34804847..a496ef4f 100644 --- a/docs/ISuite/50-Development/revoke-access-classic-design-147fb9d.md +++ b/docs/ISuite/50-Development/revoke-access-classic-design-147fb9d.md @@ -12,6 +12,9 @@ Revoke the access of an application developer. You are an API administrator and the role *AuthGroup.API.Admin* is assigned to your user. +> ### Caution: +> Effective June 2024, the classic design of the API business hub enterprise will be deprecated and will no longer be accessible. The new design of the API business hub enterprise will be set as your default design from March 2024. For more information, see [Configure the API business hub enterprise \[New Design\]](configure-the-api-business-hub-enterprise-new-design-54b4607.md). + ## Context diff --git a/docs/ISuite/50-Development/salesforce-receiver-adapter-a548be9.md b/docs/ISuite/50-Development/salesforce-receiver-adapter-a548be9.md index 2b18acd9..b7d00343 100644 --- a/docs/ISuite/50-Development/salesforce-receiver-adapter-a548be9.md +++ b/docs/ISuite/50-Development/salesforce-receiver-adapter-a548be9.md @@ -19,13 +19,13 @@ The Salesforce receiver adapter enables an SAP Cloud Integration tenant to accel You configure the receiver channel with the Salesforce adapter to enable your tenant to send data to Salesforce customer relationship management \(CRM\) platform. > ### Note: -> You need to download the adapter from SAP Software Download Center. You can find more information on the download navigation path [here](https://api.sap.com/package/SalesforceAdapter?section=Overview). +> You need to download the adapter from SAP Software Download Center. You can find more information on the download navigation path on the following web page: [Legal Disclaimer for Links](https://help.sap.com/docs/link-disclaimer?site=https%3A%2F%2Fapi.sap.com%2Fpackage%2FSalesforceAdapter%3Fsection%3DOverview). > > After you complete the download, uncompress and extract the files to your local system. Then deploy the adapter on your tenant. > > - For more information on deploying the adapter in multicloud environment, see [Importing Custom Integration Adapter](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/482286e544014098874fde0da4bcca2c.html). > -> - For tenants hosted on Neo environment, you must import the adapter to your Eclipse tool and deploy the adapter project. For more information see, [Develop Adapter](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/f798db6491424460bb4b43d4a86ed1cf.html). +> - For tenants hosted on Neo environment, you must import the adapter to your Eclipse tool and deploy the adapter project. For more information, see [Develop Adapter](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/f798db6491424460bb4b43d4a86ed1cf.html). Once you’ve created a receiver channel and selected the Salesforce receiver adapter, you can configure its parameters by referring the following description: diff --git a/docs/ISuite/50-Development/salesforce-sender-adapter-ba6420d.md b/docs/ISuite/50-Development/salesforce-sender-adapter-ba6420d.md index ef501ed1..4eaa1a7b 100644 --- a/docs/ISuite/50-Development/salesforce-sender-adapter-ba6420d.md +++ b/docs/ISuite/50-Development/salesforce-sender-adapter-ba6420d.md @@ -17,7 +17,7 @@ The Salesforce sender adapter enables Cloud Integration to accelerate the implem > This adapter exchanges data with a remote component that might be outside the scope of SAP. Make sure that the data exchange complies with your company’s policies. > ### Note: -> You need to download the adapter from SAP Software Download Center. You can find more information on the download navigation path [here](https://api.sap.com/package/SalesforceAdapter?section=Overview). +> You need to download the adapter from SAP Software Download Center. You can find more information on the download navigation path on the following website: [Salesforce Adapter for SAP Integration Suite](https://api.sap.com/package/SalesforceAdapter/overview). > > After you complete the download, uncompress and extract the files to your local system. Then deploy the adapter on your tenant. > @@ -363,7 +363,7 @@ Specifies the version of the API to be used for retrieving data from Salesforce. diff --git a/docs/ISuite/50-Development/sap-master-data-integration-receiver-adapter-e91e373.md b/docs/ISuite/50-Development/sap-master-data-integration-receiver-adapter-e91e373.md index 28761a6a..937298fc 100644 --- a/docs/ISuite/50-Development/sap-master-data-integration-receiver-adapter-e91e373.md +++ b/docs/ISuite/50-Development/sap-master-data-integration-receiver-adapter-e91e373.md @@ -16,6 +16,13 @@ Use SAP Master Data Integration \(MDI\) receiver adapter to synchronize your mas > ### Note: > This adapter exchanges data with a remote component that might be outside the scope of SAP. Make sure that the data exchange complies with your company’s policies. +> ### Note: +> This adapter is available on SAP Business Accelerator Hub. +> +> For more information, see [Consuming Integration Adapters from SAP Business Accelerator Hub](consuming-integration-adapters-from-sap-business-accelerator-hub-b9250fb.md). +> +> The availability of the adapter is dependent on your SAP Integration Suite service plan. For more information about different service plans and their supported feature set, see SAP Notes [2903776](https://launchpad.support.sap.com/#/notes/2903776) and [3188446](https://launchpad.support.sap.com/#/notes/3188446). + > ### Note: > This information is relevant only when you use the Cloud Integration capability as a part of SAP Integration Suite. Availability of this feature depends upon the SAP Integration Suite service plan that you use. For more information about different service plans and their supported feature set, see SAP Note [2903776](https://launchpad.support.sap.com/#/notes/2903776). diff --git a/docs/ISuite/50-Development/security-content-e01d3f0.md b/docs/ISuite/50-Development/security-content-e01d3f0.md index cd07a545..2464cdb4 100644 --- a/docs/ISuite/50-Development/security-content-e01d3f0.md +++ b/docs/ISuite/50-Development/security-content-e01d3f0.md @@ -22,7 +22,7 @@ Perform the steps described in: [Setting Up Inbound HTTP Connections \(for API C Assign the following role template: -`MonitoringDataRead` \(see [Tasks and Permissions](../60-Security/tasks-and-permissions-556d557.md)\) +`MonitoringDataRead` \(see [Tasks and Permissions for Cloud Integration](../60-Security/tasks-and-permissions-for-cloud-integration-556d557.md)\) diff --git a/docs/ISuite/50-Development/setting-up-api-management-capability-f34e86c.md b/docs/ISuite/50-Development/setting-up-api-management-capability-f34e86c.md index 76fee052..11b32960 100644 --- a/docs/ISuite/50-Development/setting-up-api-management-capability-f34e86c.md +++ b/docs/ISuite/50-Development/setting-up-api-management-capability-f34e86c.md @@ -14,7 +14,7 @@ To create APIs, build API proxies as a service provider, or use APIs and other c The following role collections must be assigned to you: -- The API Management capability must be enabled in Integration Suite. For more information, see [Enable API Management Capability](../enable-api-management-capability-f6eb433.md). +- The API Management capability must be enabled in Integration Suite. For more information, see [Activate and Configure API Management Capability](../activate-and-configure-api-management-capability-f6eb433.md). - To access the *Settings* page, the *APIManagement.Selfservice.Administrator* role collection must be assigned to you diff --git a/docs/ISuite/50-Development/setting-up-oauth-for-cloud-integration-in-cloud-foundry-641c56b.md b/docs/ISuite/50-Development/setting-up-oauth-for-cloud-integration-in-cloud-foundry-641c56b.md index 427a57ee..1b8b9928 100644 --- a/docs/ISuite/50-Development/setting-up-oauth-for-cloud-integration-in-cloud-foundry-641c56b.md +++ b/docs/ISuite/50-Development/setting-up-oauth-for-cloud-integration-in-cloud-foundry-641c56b.md @@ -15,7 +15,7 @@ Use OAuth2ClientCredentials for connecting requests to the server. This OAuth2Cl > ### Note: > The values you provide for the above, are the ones associated with your Cloud Integration tenant. > -> **Generate *clientId*, *clientSecret*, and *tokenUrl* Associated with Your Cloud Integration Tenant** +> **Generate *clientId*, *clientSecret*, and *tokenUrl* Associated with Your Cloud Integration Tenant.** @@ -38,7 +38,7 @@ Use OAuth2ClientCredentials for connecting requests to the server. This OAuth2Cl ``` -6. Choose *Next* until you reach the *Confirm* section +6. Choose *Next* until you reach the *Confirm* section. 7. In the *Confirm* section, enter a unique *Instance Name* and choose *Finish*. @@ -57,7 +57,7 @@ The creation of service instance is successful. ## Next Steps -Now, for the created service instance, generate a service key from the steps given below: +Now, for the created service instance, generate a service key from the steps given next: @@ -108,5 +108,5 @@ Now, for the created service instance, generate a service key from the steps giv ## Context -The service keys provide you with *clientId* and *clientSecret*. The *clientId* can be used as username and secret can be used as password if you would like to connect to your integration flows of Cloud Integration via Basic Authentication. Alternatively, you can leverage the*clientId*, *clientSecret*, and *tokenUrl* from the service keys file to get the OAuth access token and then connect to your integration flow of Cloud Integration via OAuth access token approach. For more information, see [Creating an API Proxy using SAP Cloud Integration API Provider](creating-an-api-proxy-using-sap-cloud-integration-api-provider-aefbd74.md). +The service keys provide you with *clientId* and *clientSecret*. The *clientId* can be used as username and secret can be used as password if you would like to connect to your integration flows of Cloud Integration via Basic Authentication. Alternatively, you can leverage the *clientId*, *clientSecret*, and *tokenUrl* from the service keys file to get the OAuth access token and then connect to your integration flow of Cloud Integration via OAuth access token approach. For more information, see [Creating an API Proxy using SAP Cloud Integration API Provider](creating-an-api-proxy-using-sap-cloud-integration-api-provider-aefbd74.md). diff --git a/docs/ISuite/50-Development/settings-9e64d05.md b/docs/ISuite/50-Development/settings-9e64d05.md index 5f039643..08d506f2 100644 --- a/docs/ISuite/50-Development/settings-9e64d05.md +++ b/docs/ISuite/50-Development/settings-9e64d05.md @@ -2,7 +2,7 @@ # Settings -In the *Settings* section you can fine-tune the process of setting up individual capabilities once you've activated them for the Integration Suite. +Fine-tune the settings for individual capabilities once activated, in the SAP Integration Suite. The following tabs are available for each capability: diff --git a/docs/ISuite/50-Development/sftp-adapter-e3dce88.md b/docs/ISuite/50-Development/sftp-adapter-e3dce88.md index b02838ff..741027ef 100644 --- a/docs/ISuite/50-Development/sftp-adapter-e3dce88.md +++ b/docs/ISuite/50-Development/sftp-adapter-e3dce88.md @@ -117,7 +117,7 @@ CI-PI currently supports the following ciphers for SSH \(SFTP\) communication: b **Related Information** -[Configure the SFTP Sender Adapter](configure-the-sftp-sender-adapter-2de9ee5.md "The SFTP sender adapter connects an SAP Cloud Integration tenant to a remote system using the SSH File Transfer protocol to read files from the system. SSH File Transfer protocol is also referred to as Secure File Transfer protocol (or SFTP).") +[Configure the SFTP Sender Adapter](configure-the-sftp-sender-adapter-2de9ee5.md "The SFTP sender adapter connects an SAP Integration Suite tenant to a remote system using the SSH File Transfer protocol to read files from the system. SSH File Transfer protocol is also referred to as Secure File Transfer protocol (or SFTP).") -[Configure the SFTP Receiver Adapter](configure-the-sftp-receiver-adapter-4ef52cf.md "The SFTP receiver adapter connects an SAP Cloud Integration tenant to a remote system using the SSH File Transfer protocol to write files to the system. SSH File Transfer protocol is also referred to as Secure File Transfer protocol (or SFTP).") +[Configure the SFTP Receiver Adapter](configure-the-sftp-receiver-adapter-4ef52cf.md "The SFTP receiver adapter connects an SAP Integration Suite tenant to a remote system using the SSH File Transfer protocol to write files to the system. SSH File Transfer protocol is also referred to as Secure File Transfer protocol (or SFTP).") diff --git a/docs/ISuite/50-Development/specify-the-runtime-configuration-0c1c96e.md b/docs/ISuite/50-Development/specify-the-runtime-configuration-0c1c96e.md index 0b73af0a..771d06b8 100644 --- a/docs/ISuite/50-Development/specify-the-runtime-configuration-0c1c96e.md +++ b/docs/ISuite/50-Development/specify-the-runtime-configuration-0c1c96e.md @@ -93,6 +93,9 @@ Specify the runtime properties of the integration flow. Specify the headers to be retained when the incoming message is processed. + > ### Caution: + > Only include the headers that are truly needed in the further processing of the message. This is the only way to ensure that no headers are processed that may have unwanted side effects or pose a security risk. Entering a wildcard character \(`*`\) bears the risk that you can’t control which headers will be processed by the integration flow. + > ### Note: > Enter one or more names of headers by separating them with the pipe character \(`|`\). Ensure that the header names separated with the pipe character don't have any whitespaces in between. > diff --git a/docs/ISuite/50-Development/spike-arrest-bf441dc.md b/docs/ISuite/50-Development/spike-arrest-bf441dc.md index d1e8fba9..19b9b50b 100644 --- a/docs/ISuite/50-Development/spike-arrest-bf441dc.md +++ b/docs/ISuite/50-Development/spike-arrest-bf441dc.md @@ -4,11 +4,11 @@ The Spike Arrest policy limits the number of requests forwarded from the point in the processing flow where the policy is attached as a processing step. -You can attach a Spike Arrest policy at the proxy endpoint or the target endpoint. At the proxy endpoint, this policy limits inbound requests. When you attach this policy at the TargetEndpoint, it limits request forwarded to the backend service. +You can attach a Spike Arrest policy at the proxy endpoint or at the target endpoint. At the Proxy Endpoint, this policy limits the inbound requests. When you attach this policy at the Target Endpoint, it limits the requests forwarded to the backend service. -Unlike Quotas, spike arrests are not implemented as counts. Rather, they are implemented as a rate limit which is based on the time the last matching message was processed. If you specify 6 messages per minute, it means that requests can only be submitted at the rate of one per 10 second interval. A second request within 10 seconds on the same API Management server will be rejected. Even with a larger number \(200 per second\), if two requests come in nearly simultaneously to the same API Management server, one will be rejected. Each successful request will update the spike arrest's last processed count. +Unlike Quotas, spike arrests are not implemented as counts. Rather, they are implemented as a rate limit which is based on the time the last matching message was processed. For example, if you specify 6 messages per minute, it means that the requests can only be submitted at the rate of one per 10 second interval. The second request within the 10 seconds on the same API Management server will be rejected. Even with a larger number of requests \(200 per second\), if two requests come in nearly simultaneously to the same API Management server, one will be rejected. Each successful request will update the spike arrest's last processed count. -No counter is maintained for spike arrests, only a time that the last message was successfully passed through the Spike Arrest policy. On a given API Management server, if a request is received now, all subsequent requests will fail until 10 seconds has elapsed. Since Spike Arrest is not distributed, you might see some discrepancy between the actual behavior of the system and your expected results. In general, you should use Spike Arrest to set a limit that throttles traffic to what your backend services can handle. Do not use Spike Arrest to limit traffic from individual clients. +No counter is maintained for spike arrests, only the time that the last message was successfully passed through the Spike Arrest policy is maintained. On a given API Management server, if a request is received now, all subsequent requests will fail until the duration of 10 seconds has elapsed. Since Spike Arrest policy is not distributed, you might see some discrepancy between the actual behavior of the system and your expected results. In general, you should use Spike Arrest policy to set a limit that throttles traffic to what your backend services can handle. Do not use Spike Arrest policy to limit traffic from individual clients. You can attach the policy in the following locations: ![](images/flow_policy_1_1aa837c.png) @@ -24,61 +24,348 @@ An example payload for the policy is as follows: > > > 30pm +> true > > > ``` +**`` element** +
+ +Attribute + + + +Default + + + +Type + + + +Description + +
-Class\(Optional\) +`ref` \(Optional\) -Refers to the class for which the quota counter will be reset. +N/A -` + -`ref="request.header.classIdentifier">` +N/A + +A flow variable that contains the name of the count identifier in the target Quota policy.
-Specifies the format of the request message to be sent to and the response to be returned from Salesforce. Possible values include *Application/XML* and *Application/JSON*. Note that the default value is *Application/XML* +Specifies the format of the request message to be sent to and the response to be returned from Salesforce. Possible values include *Application/XML* and *Application/JSON*. Note that the default value is *Application/XML*.
+ + + + + +
-**Elements and Attributes** +Element -**Description** +Default + + + +Type + + + +Description
-Identifier ref +`Identifier` \(Optional\) + + + +N/A -Variable used for uniquely identifying the application or client. +String + +Flow variable used for identifying the application or client. + +> ### Sample Code: +> ``` +> +> +> +> ``` + + + +
+ +**`ref` attribute of the `` element** + + + + + + + + + + + + +
+ +Attribute + + + +Default + + + +Type + + + +Description + +
-MessageWeight ref +`ref` \(Required\) + + + +N/A + + + +N/A + + + +Identifies the flow variable by which Spike Arrest groups incoming requests. + +
+ +**`` element** + + + + + + + + + + + + + +
+ +Element + + + +Default + + + +Type + + + +Description + +
+ +`MessageWeight` \(Optional\) + + + +N/A + + + +Integer Specifies the weight defined for each message. -Message weight is used to modify the impact of a single request on the calculation of the SpikeArrest limit. Message weight can be set by variables based on HTTP headers, query parameters, or message body content. For example, if the SpikeArrest Rate is 10 per minute, and an application submits requests with weight 5, then only 2 messages are permitted per minute from that application. +Message weight modifies the impact of a single request on the calculation of the SpikeArrest limit. Message weight can be set by variables based on HTTP headers, query parameters, or message body content. + +For example, if the SpikeArrest Rate is 10 per minute, and an application submits requests with weight 5, then only 2 messages are permitted per minute from that application. + +> ### Sample Code: +> ``` +> +> +> +> ``` + +
+ +**`ref` attribute of the `` element** + + + + + + + + + + + + + +
+ +Attribute + + + +Default + + + +Type + + + +Description + +
+ +`ref` \(Required\) + + -Rate +N/A + + + +N/A + + + +Identifies the flow variable that contains the message weight for the specific client. This can be any flow variable, such as an HTTP query param, header, or message body content. + +
+ +**`` element** + + + + + + + + + + + + + + +
+ +Element + + + +Default + + + +Type + + + +Description + +
+ +`Rate` \(Required\) + + + +N/A + + + +Interger Specifies the rate at which to limit the traffic spike \(or burst\). -Valid value: integer per or or . +Valid value: integer per or or + +> ### Sample Code: +> ``` +> +> 30pm +> +> ``` + + + +
+ +**`` element** + + + + + + + + + + + + + + @@ -208,11 +495,28 @@ FailedToResolveSpikeArrestRate The referenced variable used to specify the rate can't be resolved. + + + + + +
+ +Element + + + +Default + + + +Type + + + +Description + +
+ +`UseEffectiveCount` \(Optional\) + + + +N/A + + + +Boolean + + + +Distributes your Spike Arrest count across Message Processors \(MPs\) when using auto-scalin groups. + +> ### Sample Code: +> ``` +> +> true +> +> ``` + +
+ +InvalidAllowedRate + + + +500 + + + +If the spike arrest rate specified in the `` element of the Spike Arrest Policy is not an integer or if the rate does not have ps or pm as a suffix, then the deployment of the API proxy fails. +
-Following fault variables are set when the policy triggers an error at runtime: +The following fault variables are set when the policy triggers an error at runtime: **Fault Variables** @@ -243,7 +547,7 @@ Example -The fault variable \[prefix\] is ratelimit. +The fault variable \[prefix\] is rate limit. The \[policy\_name\] is the name of the policy that threw the error. diff --git a/docs/ISuite/50-Development/supported-settings-for-specific-message-brokers-059bd96.md b/docs/ISuite/50-Development/supported-settings-for-specific-message-brokers-059bd96.md new file mode 100644 index 00000000..2c72ae59 --- /dev/null +++ b/docs/ISuite/50-Development/supported-settings-for-specific-message-brokers-059bd96.md @@ -0,0 +1,395 @@ + + +# Supported Settings for Specific Message Brokers + +Learn how to connect external message brokers using the AMQP adapter. + +You can use the AMQP sender and receiver adapter to connect Cloud Integration with various message brokers. + +For more information on how to connect Cloud Integration with SAP message brokers, see: + +- [AMQP Sender for SAP Event Mesh](amqp-sender-for-sap-event-mesh-7d8a83f.md) + +- [AMQP Receiver for SAP Event Mesh](amqp-receiver-for-sap-event-mesh-0b7cc2f.md) + +- [Supported Settings for Specific Message Brokers](supported-settings-for-specific-message-brokers-059bd96.md) + +- [AMQP Receiver for SAP Integration Suite, advanced event mesh](amqp-receiver-for-sap-integration-suite-advanced-event-mesh-5f229c0.md) + + +You can also connect the non-SAP message brokers as listed in the table below. The following settings are supported. + +> ### Note: +> This adapter exchanges data with a remote component that might be outside the scope of SAP. Make sure that the data exchange complies with your company’s policies. + +> ### Tip: +> For more information, check out the following SAP Community blog: [Cloud Integration – Connecting to Messaging Systems using the AMQP Adapter](https://community.sap.com/t5/technology-blogs-by-sap/cloud-integration-connecting-to-messaging-systems-using-the-amqp-adapter/ba-p/13419906). + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +  + + + +Microsoft Azure Service Bus + + + +Solace PubSub+ + + + +Apache Qpid Broker-J + + + +Apache ActiveMQ 5 / Apache ActiveMQ Artemis + + + +IBM MQ + +
+ +Transport Protocol + + + +TLS over TCP + + + +TCP + +TLS over TCP + + + +TCP + +TLS over TCP + +WebSocket + +WebSocket over TLS + + + +TCP + +TLS over TCP + + + +TCP + +TLS over TCP + +
+ +Authentication + + + +SASL + + + +SASL + + + +SASL + + + +SASL + + + +SASL + +
+ +Dead letter queue handling based on *Delivery Status* + + + +Yes + + + +Yes + + + +Yes + + + +Yes + + + +No + +
+ +JMSRedelivered header + + + +Yes + + + +Yes + + + +Yes + + + +Yes + + + +Yes \(version \>= 9.2\) + +
+ +JMSXDeliveryCount header + + + +Yes + + + +No + + + +Yes + + + +Yes + + + +Yes \(version \>= 9.2\) + +
+ +Exclusive queues + + + +No + + + +Yes + + + +Yes + + + +No + + + +Yes \(version \>= 9.2\) + +
+ +Message groups + + + +No + + + +No + + + +Yes + + + +Yes + + + +No + +
+ +Queues + + + +Yes + + + +Yes + + + +Yes + + + +Yes + + + +Yes \(version \>= 9.2\) + +
+ +Topics + + + +Yes + + + +Yes + + + +Yes + + + +Yes + + + +Yes + +
+ +Topic subscriptions + + + +Yes + + + +Yes + + + +Yes + + + +Yes + + + +Yes + +
+ diff --git a/docs/ISuite/50-Development/test-69499e8.md b/docs/ISuite/50-Development/test-69499e8.md index bd62bffc..38e93ed8 100644 --- a/docs/ISuite/50-Development/test-69499e8.md +++ b/docs/ISuite/50-Development/test-69499e8.md @@ -2,5 +2,5 @@ # Test -You can test artifacts created on the SAP Integration Suite in the *Test* section. To know more about testing APIs, see [Test API Proxies](https://help.sap.com/viewer/66d066d903c2473f81ec33acfe2ccdb4/Cloud/en-US/3ba6151391bc474b9f1fa69455f65e3b.html "Use the API Test Console to test the runtime behavior of the API proxies.") :arrow_upper_right:. +You can test artifacts created on the SAP Integration Suite in the *Test* section. To know more about testing APIs, see [Test API Proxies](https://help.sap.com/viewer/4425026877144cc2b15505ed30215167/IAT/en-US/3ba6151391bc474b9f1fa69455f65e3b.html "Use the API Test Console to test the runtime behavior of the API proxies.") :arrow_upper_right:. diff --git a/docs/ISuite/50-Development/test-api-proxies-75cccc3.md b/docs/ISuite/50-Development/test-api-proxies-75cccc3.md index cb86f86d..f40e23ec 100644 --- a/docs/ISuite/50-Development/test-api-proxies-75cccc3.md +++ b/docs/ISuite/50-Development/test-api-proxies-75cccc3.md @@ -61,5 +61,5 @@ The API Test Console allows you to test OData and REST-based services. - *Cookies*: View the cookies. 13. If you want to use the response body as an input request, choose *Use as Request* on the *Body \(Raw\)* tab. -14. To view the transactions based on the testing activity that you did, choose *Launch API Viewer*. For more information on tracing API proxy, see [Debug an API Proxy](https://help.sap.com/viewer/66d066d903c2473f81ec33acfe2ccdb4/Cloud/en-US/fb2c7aa34cdc443294a325ccb7876785.html "You debug an API proxy to troubleshoot and monitor them in SAP API Management, by probing the details of each step through the API proxy flow.") :arrow_upper_right: +14. To view the transactions based on the testing activity that you did, choose *Launch API Viewer*. For more information on tracing API proxy, see [Debug an API Proxy](https://help.sap.com/viewer/4425026877144cc2b15505ed30215167/IAT/en-US/fb2c7aa34cdc443294a325ccb7876785.html "You debug an API proxy to troubleshoot and monitor them in SAP API Management, by probing the details of each step through the API proxy flow.") :arrow_upper_right: diff --git a/docs/ISuite/50-Development/test-runtime-behavior-of-apis-new-design-15c7d52.md b/docs/ISuite/50-Development/test-runtime-behavior-of-apis-new-design-15c7d52.md index b93d71df..f40ebf47 100644 --- a/docs/ISuite/50-Development/test-runtime-behavior-of-apis-new-design-15c7d52.md +++ b/docs/ISuite/50-Development/test-runtime-behavior-of-apis-new-design-15c7d52.md @@ -7,7 +7,7 @@ Use the API Test Environment to test the runtime behavior of APIs. The *Test Environment* enables you to test your APIs. Testing an API is essential to understand the runtime behavior of the APIs. It allows you to explore the resources associated with an API and execute the operations. It also allows you to test OData and REST-based services. > ### Note: -> This document describes the new design of the API business hub enterprise. To view the documentation for the classic design, see [Test API Proxies](https://help.sap.com/viewer/66d066d903c2473f81ec33acfe2ccdb4/Cloud/en-US/3ba6151391bc474b9f1fa69455f65e3b.html "Use the API Test Console to test the runtime behavior of the API proxies.") :arrow_upper_right:. +> This document describes the new design of the API business hub enterprise. To view the documentation for the classic design, see [Test API Proxies](https://help.sap.com/viewer/4425026877144cc2b15505ed30215167/IAT/en-US/3ba6151391bc474b9f1fa69455f65e3b.html "Use the API Test Console to test the runtime behavior of the API proxies.") :arrow_upper_right:. @@ -69,5 +69,5 @@ The *Test Environment* tab will be visible to you only if you have the *AuthGrou - *Cookies*: View the cookies. 13. If you want to use the response body as an input request, choose *Use as Request* on the *Body \(Raw\)* tab. -14. To view the transactions based on the testing activity that you did, choose *Launch API Viewer*. For more information on tracing API proxy, see [Debug an API Proxy](https://help.sap.com/viewer/66d066d903c2473f81ec33acfe2ccdb4/Cloud/en-US/fb2c7aa34cdc443294a325ccb7876785.html "You debug an API proxy to troubleshoot and monitor them in SAP API Management, by probing the details of each step through the API proxy flow.") :arrow_upper_right: +14. To view the transactions based on the testing activity that you did, choose *Launch API Viewer*. For more information on tracing API proxy, see [Debug an API Proxy](https://help.sap.com/viewer/4425026877144cc2b15505ed30215167/IAT/en-US/fb2c7aa34cdc443294a325ccb7876785.html "You debug an API proxy to troubleshoot and monitor them in SAP API Management, by probing the details of each step through the API proxy flow.") :arrow_upper_right: diff --git a/docs/ISuite/50-Development/update-a-rate-plan-5ef271f.md b/docs/ISuite/50-Development/update-a-rate-plan-5ef271f.md index 42fc304c..d9d0f951 100644 --- a/docs/ISuite/50-Development/update-a-rate-plan-5ef271f.md +++ b/docs/ISuite/50-Development/update-a-rate-plan-5ef271f.md @@ -141,9 +141,9 @@ You are updating a rate plan. **Related Information** -[Create a Rate Plan](https://help.sap.com/viewer/66d066d903c2473f81ec33acfe2ccdb4/Cloud/en-US/cfe6a30600f148a39a7920dbc7fa1ab2.html "Create a rate plan using the API portal.") :arrow_upper_right: + -[Update a Rate Plan](https://help.sap.com/viewer/66d066d903c2473f81ec33acfe2ccdb4/Cloud/en-US/b8c1e6b68be74ead8700f7f8be9baa8b.html "Update a rate plan using the API portal.") :arrow_upper_right: + -[Delete a Rate Plan](https://help.sap.com/viewer/66d066d903c2473f81ec33acfe2ccdb4/Cloud/en-US/d4181ad418e4446e830c498d672204ff.html "Delete a rate plan using the API portal.") :arrow_upper_right: + diff --git a/docs/ISuite/50-Development/updating-the-connection-request-credentials-for-a-submitted-request-classic-design-eb84854.md b/docs/ISuite/50-Development/updating-the-connection-request-credentials-for-a-submitted-request-classic-design-eb84854.md index 7688ddef..8e05f49c 100644 --- a/docs/ISuite/50-Development/updating-the-connection-request-credentials-for-a-submitted-request-classic-design-eb84854.md +++ b/docs/ISuite/50-Development/updating-the-connection-request-credentials-for-a-submitted-request-classic-design-eb84854.md @@ -10,6 +10,9 @@ Update the credentials you've used to establish a connection between the Integra ## Prerequisites +> ### Caution: +> Effective June 2024, the classic design of the API business hub enterprise will be deprecated and will no longer be accessible. The new design of the API business hub enterprise will be set as your default design from March 2024. For more information, see [Configure the API business hub enterprise \[New Design\]](configure-the-api-business-hub-enterprise-new-design-54b4607.md). + - Only the users who submitted the connection request and has the *AuthGroup.APIPortalRegistration* role assigned to themselves can edit the credentials. - To update the Integration Suite API Management tenant access credentials, you must first generate it. To generate the credentials from the Integration Suite API Management tenant, you must have the *APIPortal. Administrator* role assigned to you. diff --git a/docs/ISuite/50-Development/updating-the-connection-request-credentials-for-an-approved-request-classic-design-b583b7a.md b/docs/ISuite/50-Development/updating-the-connection-request-credentials-for-an-approved-request-classic-design-b583b7a.md index ce64e580..55eafeef 100644 --- a/docs/ISuite/50-Development/updating-the-connection-request-credentials-for-an-approved-request-classic-design-b583b7a.md +++ b/docs/ISuite/50-Development/updating-the-connection-request-credentials-for-an-approved-request-classic-design-b583b7a.md @@ -10,6 +10,9 @@ There can be instances where you have to update the credentials once the connect ## Prerequisites +> ### Caution: +> Effective June 2024, the classic design of the API business hub enterprise will be deprecated and will no longer be accessible. The new design of the API business hub enterprise will be set as your default design from March 2024. For more information, see [Configure the API business hub enterprise \[New Design\]](configure-the-api-business-hub-enterprise-new-design-54b4607.md). + To update the API Management tenant access credentials, you must first generate it. To generate the credentials from theAPI Management tenants, you must have the *APIPortal. Administrator* role assigned to you. 1. Log in to the Integration Suite. diff --git a/docs/ISuite/50-Development/upload-wsdls-as-integration-flow-resource-9c22b39.md b/docs/ISuite/50-Development/upload-wsdls-as-integration-flow-resource-9c22b39.md index 533438da..18b9ee71 100644 --- a/docs/ISuite/50-Development/upload-wsdls-as-integration-flow-resource-9c22b39.md +++ b/docs/ISuite/50-Development/upload-wsdls-as-integration-flow-resource-9c22b39.md @@ -167,7 +167,7 @@ You can verify the concatenated single name by inspecting the entry of the is ma [Configure the SOAP \(SOAP 1.x\) Receiver Adapter](configure-the-soap-soap-1-x-receiver-adapter-57f7b34.md "The SOAP (SOAP 1.x) receiver adapter enables a SAP BTP tenant to exchange messages with a receiver system that supports Simple Object Access Protocol (SOAP) 1.1.") -[Manage Resources of an Integration Flow](manage-resources-of-an-integration-flow-b5968b2.md "") +[Manage Resources](manage-resources-b5968b2.md "") [Creating Message Mapping as a Flow Step](creating-message-mapping-as-a-flow-step-3d5cb7f.md "") diff --git a/docs/ISuite/50-Development/view-applications-feac368.md b/docs/ISuite/50-Development/view-applications-feac368.md index 63ec932c..d3029f60 100644 --- a/docs/ISuite/50-Development/view-applications-feac368.md +++ b/docs/ISuite/50-Development/view-applications-feac368.md @@ -10,7 +10,7 @@ In the context of API Management, an application is the unit of API consumption. API Management enables the creation of secure API proxies for your APIs. These proxies are protected using "Appkey" and "Secret". Application developers are required to acquire these credentials in order to utilize the API proxies exposed through the various products. They need to declare the usage of these products by creating an application from API business hub enterprise. -As an admin, you can view the list of applications that the developers have created in the API business hub enterprise, along with the developer details, associated products and AppKey and secret. +As an admin, you can view the list of applications that the application developers have created in the API business hub enterprise, along with the developer details, associated products and AppKey and secret. diff --git a/docs/ISuite/50-Development/working-with-a-mapping-guideline-mag-0803ca6.md b/docs/ISuite/50-Development/working-with-a-mapping-guideline-mag-0803ca6.md index 6f35cefc..0490afa9 100644 --- a/docs/ISuite/50-Development/working-with-a-mapping-guideline-mag-0803ca6.md +++ b/docs/ISuite/50-Development/working-with-a-mapping-guideline-mag-0803ca6.md @@ -31,7 +31,7 @@ There could be scenarios where there are significant differences between the Mes 1. Choose *Edit*. > ### Note: - > Ensure that the MAG you are trying to edit is not locked by other users. The *Locked By* field displays the ID of ths user who's currently editing the MAG. You need to have admin rights to unlock it. To know more about the role, see [Assigning Users for SAP Integration Advisor](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/b5226b95e11b42cd9e257ae6d2b0ee0a.html "") :arrow_upper_right: + > Ensure that the MAG you are trying to edit is not locked by other users. The *Locked By* field displays the ID of ths user who's currently editing the MAG. You need to have admin rights to unlock it. To know more about the role, see [Configuring User Access to SAP Integration Suite](../configuring-user-access-to-sap-integration-suite-2c6214a.md) 2. Choose *Mapping* tab to edit the mapping details of the MAG. For more information on mapping nodes, see [Mapping the Source and Target Nodes](mapping-the-source-and-target-nodes-9ea58d6.md) diff --git a/docs/ISuite/50-Development/working-with-a-message-implementation-guideline-9d1c1df.md b/docs/ISuite/50-Development/working-with-a-message-implementation-guideline-9d1c1df.md index 5bdf7a55..66de82f2 100644 --- a/docs/ISuite/50-Development/working-with-a-message-implementation-guideline-9d1c1df.md +++ b/docs/ISuite/50-Development/working-with-a-message-implementation-guideline-9d1c1df.md @@ -31,7 +31,7 @@ Here are a few considerations to be mindful of before you work with MIG: 1. Choose *Edit*. > ### Note: - > Ensure that the MIG you are trying to edit is not locked by other users. The *Locked By* field displays the ID of ths user who's currently editing the MIG. You need to have admin rights to unlock it. To know more about the role, see [Assigning Users for SAP Integration Advisor](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/b5226b95e11b42cd9e257ae6d2b0ee0a.html "") :arrow_upper_right: + > Ensure that the MIG you are trying to edit is not locked by other users. The *Locked By* field displays the ID of ths user who's currently editing the MIG. You need to have admin rights to unlock it. To know more about the role, see [Configuring User Access to SAP Integration Suite](../configuring-user-access-to-sap-integration-suite-2c6214a.md) 2. Use and to expand and collapse nodes. @@ -50,7 +50,7 @@ Here are a few considerations to be mindful of before you work with MIG: > > To know more on editing these properties, see [Working with a Node](working-with-a-node-518b54f.md) > - > Refer to the [Terminology & Glossary for SAP Integration Advisor](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/9c221b48799a4ce59367b0e3367f5a8f.html "") :arrow_upper_right: to get an understanding of Qualifier, Notes and Codelist. + > Refer to the [Glossary for SAP Integration Advisor](../glossary-for-sap-integration-advisor-9c221b4.md) to get an understanding of Qualifier, Notes and Codelist. 5. Review the *Message Implementation Guideline* by setting a review status, or comparing the MIG diff --git a/docs/ISuite/50-Development/working-with-imported-archives-e00e81d.md b/docs/ISuite/50-Development/working-with-imported-archives-e00e81d.md new file mode 100644 index 00000000..b45dee1e --- /dev/null +++ b/docs/ISuite/50-Development/working-with-imported-archives-e00e81d.md @@ -0,0 +1,28 @@ + + +# Working with Imported Archives + +Imported Archives is a collection of multiple imported archive objects from ESR. + +> ### Note: +> This information is relevant only when you use the Cloud Integration capability as a part of SAP Integration Suite. Availability of this feature depends upon the SAP Integration Suite service plan that you use. For more information about different service plans and their supported feature set, see SAP Note [2903776](https://launchpad.support.sap.com/#/notes/2903776). + +Imported Archives are custom-implemented user-defined functions \(UDFs\) and saved as archives in the Enterprise Services Repository \(ESR\). For more information about what is an imported archive object and how it's created in an ESR, see [Imported Archives](https://help.sap.com/docs/SAP_NETWEAVER_750/0b9668e854374d8fa3fc8ec327ff3693/4bf40f29c0c33de4e10000000a42189e.html?version=latest). + +To achieve reusability across message mappings, SAP Integration Suite supports import of archives from ESR. In SAP Integration Suite, you create an *Imported Archives* artifact and import multiple imported archive objects from ES Repository to the Imported Archives artifact. Later, you reuse the imported archive objects across multiple Function Libraries artifacts, which in turn are reused across multiple message mappings. + + + + + +### Workflow + +A typical workflow to rightly use Imported Archives is as follows: + +1. [Creating an Imported Archives Artifact](creating-an-imported-archives-artifact-e555caf.md) in an integration package. + +2. [Reuse Imported Archives Objects from ES Repository](reuse-imported-archives-objects-from-es-repository-4196091.md) + +3. [Consuming Imported Archives](consuming-imported-archives-e7562a7.md) + + diff --git a/docs/ISuite/60-Security/identity-and-access-management-for-api-management-016556f.md b/docs/ISuite/60-Security/identity-and-access-management-for-api-management-016556f.md index 49daaf31..c29e3f9d 100644 --- a/docs/ISuite/60-Security/identity-and-access-management-for-api-management-016556f.md +++ b/docs/ISuite/60-Security/identity-and-access-management-for-api-management-016556f.md @@ -38,7 +38,7 @@ Authorization -In API Management, you provide authorization to users by assigning relevant roles. For more information on how to provide authorizations, see [User Roles in API Management \(New\)](../user-roles-in-api-management-new-911ca5a.md). +In API Management, you provide authorization to users by assigning relevant roles. For more information on how to provide authorizations, see [Tasks and Corresponding Role Collections](../tasks-and-corresponding-role-collections-911ca5a.md). diff --git a/docs/ISuite/60-Security/identity-and-access-management-for-cloud-integration-f805b22.md b/docs/ISuite/60-Security/identity-and-access-management-for-cloud-integration-f805b22.md index 92fb8f4a..4bcef7ce 100644 --- a/docs/ISuite/60-Security/identity-and-access-management-for-cloud-integration-f805b22.md +++ b/docs/ISuite/60-Security/identity-and-access-management-for-cloud-integration-f805b22.md @@ -56,7 +56,7 @@ Therefore, apply the following measures when designing integration flows for sec > ### Tip: > Instead of using the predefined authorization groups, you can tailor the permissions to your own requirements by applying elementary roles that are defined for individual tasks. > -> More information: [Tasks and Permissions](tasks-and-permissions-556d557.md) +> More information: [Tasks and Permissions for Cloud Integration](tasks-and-permissions-for-cloud-integration-556d557.md) @@ -82,5 +82,5 @@ When a sender system calls the integration platform using HTTPS-based \(inbound\ [Authentication and Authorization Options \(Inbound\)](../40-RemoteSystems/authentication-and-authorization-options-inbound-983f2a5.md "When a client calls a server using a secure communication channel, two different kinds of checks are performed subsequently.") -[Persona](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/4b4ba1c553474259b5be661f4ef0702c.html "When you perform user management tasks using SAP BTP cockpit, you find a set of predefined roles that you can assign to users of the account. According to the main tasks associated with integration projects, these roles are associated to certain persona relevant for an integration project.") :arrow_upper_right: +[Personas](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/4b4ba1c553474259b5be661f4ef0702c.html "When you perform user management tasks using SAP BTP cockpit, you find a set of predefined roles that you can assign to users of the account. According to the main tasks associated with integration projects, these roles are associated to certain persona relevant for an integration project.") :arrow_upper_right: diff --git a/docs/ISuite/60-Security/identity-and-access-management-for-integration-assessment-9a09cdd.md b/docs/ISuite/60-Security/identity-and-access-management-for-integration-assessment-9a09cdd.md index fcdf2f96..82500a57 100644 --- a/docs/ISuite/60-Security/identity-and-access-management-for-integration-assessment-9a09cdd.md +++ b/docs/ISuite/60-Security/identity-and-access-management-for-integration-assessment-9a09cdd.md @@ -5,5 +5,5 @@ **Related Information** -[Personas](personas-5df5af1.md "") +[Personas for Integration Assessment](personas-for-integration-assessment-5df5af1.md "") diff --git a/docs/ISuite/60-Security/identity-and-access-management-for-migration-assessment-a2ee575.md b/docs/ISuite/60-Security/identity-and-access-management-for-migration-assessment-a2ee575.md index aca1b059..32a32fbd 100644 --- a/docs/ISuite/60-Security/identity-and-access-management-for-migration-assessment-a2ee575.md +++ b/docs/ISuite/60-Security/identity-and-access-management-for-migration-assessment-a2ee575.md @@ -7,5 +7,5 @@ Learn about identity and access management for Migration Assessment, including r **Related Information** -[Tasks and Permissions](tasks-and-permissions-2714db1.md "Learn about security-related topics like users and authorizations.") +[Tasks and Permissions for Migration Assessment](tasks-and-permissions-for-migration-assessment-2714db1.md "Learn about security-related topics like users and authorizations.") diff --git a/docs/ISuite/60-Security/persona-2937e5c.md b/docs/ISuite/60-Security/personas-for-cloud-integration-2937e5c.md similarity index 96% rename from docs/ISuite/60-Security/persona-2937e5c.md rename to docs/ISuite/60-Security/personas-for-cloud-integration-2937e5c.md index 9bab0a18..cb29396e 100644 --- a/docs/ISuite/60-Security/persona-2937e5c.md +++ b/docs/ISuite/60-Security/personas-for-cloud-integration-2937e5c.md @@ -1,10 +1,10 @@ -# Persona +# Personas for Cloud Integration When you perform user management tasks using SAP BTP cockpit, you find a set of predefined roles that you can assign to users of the account. According to the main tasks associated with integration projects, these roles are associated to certain persona relevant for an integration project. -Personas cover the different tasks associated with an integration project. To assign roles that are application-based, see [Configuring User Access](../configuring-user-access-2c6214a.md). +Personas cover the different tasks associated with an integration project. To assign roles that are application-based, see [Configuring User Access to SAP Integration Suite](../configuring-user-access-to-sap-integration-suite-2c6214a.md). > ### Note: > This topic contains also information that is related to SAP BTP, Neo environment. Note that SAP Integration Suite is available only in the SAP BTP, Cloud Foundry environment, not in the Neo environment. However, many customers know SAP Cloud Integration as standalone service. The additional information should help those customers to relate the Neo-related information they know to the information relevant in the context of SAP Integration Suite. @@ -298,5 +298,5 @@ In order to enable a sender system to process messages on Cloud Integration Usin **Related Information** -[Tasks and Permissions](tasks-and-permissions-556d557.md "") +[Tasks and Permissions for Cloud Integration](tasks-and-permissions-for-cloud-integration-556d557.md "") diff --git a/docs/ISuite/60-Security/personas-5df5af1.md b/docs/ISuite/60-Security/personas-for-integration-assessment-5df5af1.md similarity index 92% rename from docs/ISuite/60-Security/personas-5df5af1.md rename to docs/ISuite/60-Security/personas-for-integration-assessment-5df5af1.md index f4d59b32..0e1e2df4 100644 --- a/docs/ISuite/60-Security/personas-5df5af1.md +++ b/docs/ISuite/60-Security/personas-for-integration-assessment-5df5af1.md @@ -1,10 +1,10 @@ -# Personas +# Personas for Integration Assessment Different personas cover the different tasks associated with an integration project. -For more information about the available roles to grant permission to accomplish the tasks, see [Tasks and Permissions](tasks-and-permissions-693e14f.md). +For more information about the available roles to grant permission to accomplish the tasks, see [Tasks and Permissions for Integration Assessment](tasks-and-permissions-for-integration-assessment-693e14f.md). diff --git a/docs/ISuite/60-Security/persona-d0c9a80.md b/docs/ISuite/60-Security/personas-for-trading-partner-management-d0c9a80.md similarity index 97% rename from docs/ISuite/60-Security/persona-d0c9a80.md rename to docs/ISuite/60-Security/personas-for-trading-partner-management-d0c9a80.md index 3cda11c8..4d966d15 100644 --- a/docs/ISuite/60-Security/persona-d0c9a80.md +++ b/docs/ISuite/60-Security/personas-for-trading-partner-management-d0c9a80.md @@ -1,6 +1,6 @@ -# Persona +# Personas for Trading Partner Management When you perform user management tasks using SAP BTP Cockpit, you find a set of predefined roles that you can assign to users of the account. According to the main tasks associated with B2B scenarios, these roles are associated to certain persona relevant for an B2B scenario. diff --git a/docs/ISuite/60-Security/security-a58b240.md b/docs/ISuite/60-Security/security-a58b240.md index c43a84a6..051d1394 100644 --- a/docs/ISuite/60-Security/security-a58b240.md +++ b/docs/ISuite/60-Security/security-a58b240.md @@ -32,7 +32,7 @@ This documentation summarizes the measures that are taken by SAP to fulfill thes > ### Note: -> The role collection *Integration\_Provisioner* has been made available for managing security settings for SAP Integration Suite. For detailed information on how to assign this role collection, refer to [Configuring User Access](../configuring-user-access-2c6214a.md). +> The role collection *Integration\_Provisioner* has been made available for managing security settings for SAP Integration Suite. For detailed information on how to assign this role collection, refer to [Configuring User Access to SAP Integration Suite](../configuring-user-access-to-sap-integration-suite-2c6214a.md). **Related Information** diff --git a/docs/ISuite/60-Security/tasks-and-permissions-556d557.md b/docs/ISuite/60-Security/tasks-and-permissions-for-cloud-integration-556d557.md similarity index 98% rename from docs/ISuite/60-Security/tasks-and-permissions-556d557.md rename to docs/ISuite/60-Security/tasks-and-permissions-for-cloud-integration-556d557.md index a17aa49f..c94eeeda 100644 --- a/docs/ISuite/60-Security/tasks-and-permissions-556d557.md +++ b/docs/ISuite/60-Security/tasks-and-permissions-for-cloud-integration-556d557.md @@ -1,6 +1,6 @@ -# Tasks and Permissions +# Tasks and Permissions for Cloud Integration The following table provides an overview of which roles are required in order to accomplish the various tasks related to Cloud Integration. It's also indicated in how far the tasks and roles are relevant for the main persona defined for Cloud Integration. @@ -14,7 +14,7 @@ In the different environments, these persona are mapped to different objects. - In the Cloud Foundry environment, a persona ia realized by a role collection. -The mapping of the persona to the authorization groups \(Neo\) or role collections \(Cloud Foundry\) is described under [Persona](persona-2937e5c.md). +The mapping of the persona to the authorization groups \(Neo\) or role collections \(Cloud Foundry\) is described under [Personas for Cloud Integration](personas-for-cloud-integration-2937e5c.md). In the different environments, the permissions to execute certain tasks are given by different objects. @@ -716,6 +716,33 @@ Monitor + + + + + + + diff --git a/docs/ISuite/60-Security/tasks-and-permissions-693e14f.md b/docs/ISuite/60-Security/tasks-and-permissions-for-integration-assessment-693e14f.md similarity index 98% rename from docs/ISuite/60-Security/tasks-and-permissions-693e14f.md rename to docs/ISuite/60-Security/tasks-and-permissions-for-integration-assessment-693e14f.md index 67b99261..323e5e3c 100644 --- a/docs/ISuite/60-Security/tasks-and-permissions-693e14f.md +++ b/docs/ISuite/60-Security/tasks-and-permissions-for-integration-assessment-693e14f.md @@ -1,6 +1,6 @@ -# Tasks and Permissions +# Tasks and Permissions for Integration Assessment The following table provides an overview of which role templates are required in order to accomplish the various tasks related to Integration Assessment. diff --git a/docs/ISuite/60-Security/tasks-and-permissions-2714db1.md b/docs/ISuite/60-Security/tasks-and-permissions-for-migration-assessment-2714db1.md similarity index 98% rename from docs/ISuite/60-Security/tasks-and-permissions-2714db1.md rename to docs/ISuite/60-Security/tasks-and-permissions-for-migration-assessment-2714db1.md index 25a9164e..6403ece5 100644 --- a/docs/ISuite/60-Security/tasks-and-permissions-2714db1.md +++ b/docs/ISuite/60-Security/tasks-and-permissions-for-migration-assessment-2714db1.md @@ -1,6 +1,6 @@ -# Tasks and Permissions +# Tasks and Permissions for Migration Assessment Learn about security-related topics like users and authorizations. diff --git a/docs/ISuite/60-Security/tasks-and-permissions-eb14b22.md b/docs/ISuite/60-Security/tasks-and-permissions-for-trading-partner-management-eb14b22.md similarity index 97% rename from docs/ISuite/60-Security/tasks-and-permissions-eb14b22.md rename to docs/ISuite/60-Security/tasks-and-permissions-for-trading-partner-management-eb14b22.md index 966d7b51..b7ff5871 100644 --- a/docs/ISuite/60-Security/tasks-and-permissions-eb14b22.md +++ b/docs/ISuite/60-Security/tasks-and-permissions-for-trading-partner-management-eb14b22.md @@ -1,6 +1,6 @@ -# Tasks and Permissions +# Tasks and Permissions for Trading Partner Management The following table provides an overview of which roles are required in order to accomplish the various tasks related to Trading Partner Management. It's also indicated in how far the tasks and roles are relevant for the main persona defined for Cloud Integration. diff --git a/docs/ISuite/60-Security/technical-landscape-daea676.md b/docs/ISuite/60-Security/technical-landscape-daea676.md index 499eb173..846b4809 100644 --- a/docs/ISuite/60-Security/technical-landscape-daea676.md +++ b/docs/ISuite/60-Security/technical-landscape-daea676.md @@ -42,8 +42,6 @@ These are the basic constituents of the virtual platform: - As an alternative deployment option, you can deploy integration content in the private cloud environment managed by the customer. Using this option, messages are processed on a runtime component in the customer landscape. This way of integration is also referred to as ground-to-ground integration. In technical terms, this runtime is realized as set of compute clusters managed by Kubernetes. -- The customer-managed private cloud runtime can operate independent from SAP BTP for a dedicated time \(4 hours\). That means, if the connection between SAP BTP and the customer landscape is interrupted for up to 4 hours, the integration scenarios operated on the Edge runtime continue to operate. Like the integration content also the security-relevant artifacts \(for example, User Credentials artifacts or keystore entries\) are maintained by the SAP Integration Suite user interface on SAP BTP. To make sure that the correct artifact version is used on an Edge runtime, there’s a synchronization mechanism between the Edge runtime and SAP BTP. The synchronization is triggered by the Edge runtime on a regular basis \(pull pattern\). - As consequence of this cluster design, the following main communication paths are active during the operation of an integration scenario: @@ -192,8 +190,8 @@ Experts on the customer side access the infrastructure to design and deploy inte For more information, see: -- [Persona](persona-2937e5c.md) +- [Personas for Cloud Integration](personas-for-cloud-integration-2937e5c.md) -- [Tasks and Permissions](tasks-and-permissions-556d557.md) +- [Tasks and Permissions for Cloud Integration](tasks-and-permissions-for-cloud-integration-556d557.md) diff --git a/docs/ISuite/60-Security/types-of-stored-data-c36c7c6.md b/docs/ISuite/60-Security/types-of-stored-data-c36c7c6.md index c2983b6b..c03f623b 100644 --- a/docs/ISuite/60-Security/types-of-stored-data-c36c7c6.md +++ b/docs/ISuite/60-Security/types-of-stored-data-c36c7c6.md @@ -12,7 +12,7 @@ Such data needs to be considered as sensitive data as it can contain personal in Trading Partner profiles allows maintaining the contact person details for different trading partners. This information can be subject to local sensitive data regulations like GDPR. Ensure you handle such data according to the applicable laws. The data is owned, maintained & used by the organization owning the tenant. Apart from providing the infrastructure for maintaining such data, SAP does not have direct access to the data itself. - The read and write access of the contact person details is protected by appropriate roles. To know more, see [Persona](persona-d0c9a80.md). + The read and write access of the contact person details is protected by appropriate roles. To know more, see [Personas for Trading Partner Management](personas-for-trading-partner-management-d0c9a80.md). - *Cloud Integration Runtime Configuration* diff --git a/docs/ISuite/APIM-Migration/clone-api-management-content-7abd887.md b/docs/ISuite/APIM-Migration/clone-api-management-content-7abd887.md index 72459412..46d0023a 100644 --- a/docs/ISuite/APIM-Migration/clone-api-management-content-7abd887.md +++ b/docs/ISuite/APIM-Migration/clone-api-management-content-7abd887.md @@ -95,6 +95,11 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -132,6 +137,11 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -161,6 +171,11 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -185,6 +200,11 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -219,6 +239,11 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -248,6 +273,11 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -272,6 +302,11 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -291,7 +326,7 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -358,6 +398,11 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -385,6 +430,11 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -407,6 +457,11 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -431,6 +486,11 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -460,6 +520,11 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -482,6 +547,11 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -504,6 +574,11 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -526,6 +601,11 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -563,6 +643,11 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -585,6 +670,11 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -607,6 +697,11 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -631,6 +726,11 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -660,6 +760,11 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -682,6 +787,11 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -704,6 +814,11 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -726,6 +841,11 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -763,6 +883,11 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -785,6 +910,11 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -807,6 +937,11 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -831,6 +966,11 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -860,6 +1000,11 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -882,6 +1027,11 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -904,6 +1054,11 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -926,6 +1081,11 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -948,7 +1108,7 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -991,7 +1156,7 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -1033,7 +1203,7 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -1068,7 +1243,7 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -1108,7 +1288,7 @@ Once you have your source and target system ready, you can clone your API Manage + diff --git a/docs/ISuite/APIM-Migration/clone-api-management-content-for-cloud-foundry-to-cloud-foundry-migration-2e5d127.md b/docs/ISuite/APIM-Migration/clone-api-management-content-between-cloud-foundry-environments-2e5d127.md similarity index 93% rename from docs/ISuite/APIM-Migration/clone-api-management-content-for-cloud-foundry-to-cloud-foundry-migration-2e5d127.md rename to docs/ISuite/APIM-Migration/clone-api-management-content-between-cloud-foundry-environments-2e5d127.md index 78e285cc..276ea1c1 100644 --- a/docs/ISuite/APIM-Migration/clone-api-management-content-for-cloud-foundry-to-cloud-foundry-migration-2e5d127.md +++ b/docs/ISuite/APIM-Migration/clone-api-management-content-between-cloud-foundry-environments-2e5d127.md @@ -1,6 +1,6 @@ -# Clone API Management Content for Cloud Foundry to Cloud Foundry Migration +# Clone API Management Content between Cloud Foundry Environments Clone the API Management content using the Tenant Cloning Tool. @@ -95,6 +95,11 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -137,6 +142,11 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -164,6 +174,11 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -186,6 +201,11 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -212,6 +232,11 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -241,6 +266,11 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -263,6 +293,11 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -285,6 +320,11 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -307,6 +347,11 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -344,6 +389,11 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -371,6 +421,11 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -393,6 +448,11 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -417,6 +477,11 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -446,6 +511,11 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -468,6 +538,11 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -490,6 +565,11 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -512,6 +592,11 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -529,7 +614,7 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -586,6 +676,11 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -613,6 +708,11 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -635,6 +735,11 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -659,6 +764,11 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -688,6 +798,11 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -710,6 +825,11 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -732,6 +852,11 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -754,6 +879,11 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -791,6 +921,11 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -818,6 +953,11 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -840,6 +980,11 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -864,6 +1009,11 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -893,6 +1043,11 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -915,6 +1070,11 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -937,6 +1097,11 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -959,6 +1124,11 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -981,7 +1151,7 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -1026,7 +1201,7 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -1061,7 +1241,7 @@ Once you have your source and target system ready, you can clone your API Manage + @@ -1101,7 +1286,7 @@ Once you have your source and target system ready, you can clone your API Manage + diff --git a/docs/ISuite/APIM-Migration/cloned-and-uncloned-entities-8973ca0.md b/docs/ISuite/APIM-Migration/cloned-and-uncloned-entities-8973ca0.md index 9418b1da..76dfdfeb 100644 --- a/docs/ISuite/APIM-Migration/cloned-and-uncloned-entities-8973ca0.md +++ b/docs/ISuite/APIM-Migration/cloned-and-uncloned-entities-8973ca0.md @@ -47,7 +47,7 @@ Refer this section for the entities that are cloned and entities that aren’t c > > With this the `created_by` will reflect in the API proxy. -The following list displays the API Management entities that are cloned: +The following list displays the API Management entities that can be cloned: - Certificates and Certificate Store - Rate Plans @@ -62,6 +62,8 @@ The following list displays the API Management entities that are cloned: - Application Developer - Access Control Permissions for API Product - Custom Metrics and Charts +- Cache Resources + diff --git a/docs/ISuite/APIM-Migration/cloned-and-uncloned-entities-b2b393d.md b/docs/ISuite/APIM-Migration/cloned-and-uncloned-entities-b2b393d.md index 965d674d..562b08d2 100644 --- a/docs/ISuite/APIM-Migration/cloned-and-uncloned-entities-b2b393d.md +++ b/docs/ISuite/APIM-Migration/cloned-and-uncloned-entities-b2b393d.md @@ -47,7 +47,7 @@ Refer this section for the entities that are cloned and entities that aren’t c > > With this the `created_by` will reflect in the API proxy. -The following list displays the API Management entities that are cloned: +The following list displays the API Management entities that can be cloned: - Certificates and Certificate Store - Rate Plans @@ -62,6 +62,7 @@ The following list displays the API Management entities that are cloned: - Application Developer - Access Control Permissions for API Product - Custom Metrics and Charts +- Cache Resources diff --git a/docs/ISuite/APIM-Migration/post-cloning-tasks-116d82c.md b/docs/ISuite/APIM-Migration/post-cloning-tasks-116d82c.md index c59eb654..a8ed3802 100644 --- a/docs/ISuite/APIM-Migration/post-cloning-tasks-116d82c.md +++ b/docs/ISuite/APIM-Migration/post-cloning-tasks-116d82c.md @@ -212,7 +212,7 @@ Depending upon the location of your application, and your API Management service If your cloud foundry application and the API Management capability are on the same sub account, then use the following steps to migrate the route service binding: 1. Create an API Management, API portal service instance using the service plan, apim-as-route-service. For more information, see [Creating an API Management, API portal Service Instance](../managing-cloud-foundry-microservices-through-api-management-e609a3e.md#loioe609a3efe6d64e1781cbf81ae5592071__CreatingAPIMInstance) -2. Unbind your application from the API Management service instance on Neo. For more information, see [Unbinding a Cloud Foundry Application from an API Management, API portal Service Instance](../managing-cloud-foundry-microservices-through-api-management-e609a3e.md#loioe609a3efe6d64e1781cbf81ae5592071__unbinding) +2. Unbind your application from the API Management service instance on Neo. For more information, see [Unbinding a Cloud Foundry Application from an API Management, API portal Service Instance](../unbinding-a-cloud-foundry-application-from-an-api-management-api-portal-service-instance-09fd33a.md) 3. Bind your application to the API Management service instance on Cloud Foundry. For more information, see [Binding a Cloud Foundry Application to an API Management, API portal Service Instance](../managing-cloud-foundry-microservices-through-api-management-e609a3e.md#loioe609a3efe6d64e1781cbf81ae5592071__Binding) @@ -231,7 +231,7 @@ If your Cloud Foundry application and the API Management capability are on diffe For more information, see [User Provided Service](https://docs.cloudfoundry.org/services/route-services.html#user-provided) -2. Unbind your application from the API Management service instance on Neo. For more information, see [Unbinding a Cloud Foundry Application from an API Management, API portal Service Instance](../managing-cloud-foundry-microservices-through-api-management-e609a3e.md#loioe609a3efe6d64e1781cbf81ae5592071__unbinding) +2. Unbind your application from the API Management service instance on Neo. For more information, see [Unbinding a Cloud Foundry Application from an API Management, API portal Service Instance](../unbinding-a-cloud-foundry-application-from-an-api-management-api-portal-service-instance-09fd33a.md) 3. Bind the User Provided Service created in the first step to the Cloud Foundry Application. For this binding, use the following command: > ### Sample Code: diff --git a/docs/ISuite/APIM-Migration/post-cloning-tasks-49e9716.md b/docs/ISuite/APIM-Migration/post-cloning-tasks-49e9716.md index bdbb1476..e0de83c5 100644 --- a/docs/ISuite/APIM-Migration/post-cloning-tasks-49e9716.md +++ b/docs/ISuite/APIM-Migration/post-cloning-tasks-49e9716.md @@ -143,7 +143,7 @@ Depending on the configurations you have on your source system, you must configu - Cloud Connector setup - Principal Propagation setup at the subaccount level - Changes to Principal Propagation policy for on-premise connectivity -- Migration of route service bindings. For more information, see [Migrating Route Service Binding](post-cloning-tasks-116d82c.md#loio116d82c83b6a4665a6f30f21a0e6e0d8__routebinding) +- Migration of route service bindings. For more information, see [Migrating Route Service Binding](post-cloning-tasks-49e9716.md#loio49e9716c499d44059907f18c0659cd69__routebinding) - Any integrations with other systems \(like SAP Web IDE\) - Any other configurations that you created for API Management at the subaccount level of your source system @@ -174,7 +174,7 @@ Depending upon the location of your application, and your API Management service If your cloud foundry application and the API Management capability are on the same sub account, then use the following steps to migrate the route service binding: 1. Create an API Management, API portal service instance using the service plan, apim-as-route-service. For more information, see [Creating an API Management, API portal Service Instance](../managing-cloud-foundry-microservices-through-api-management-e609a3e.md#loioe609a3efe6d64e1781cbf81ae5592071__CreatingAPIMInstance) -2. Unbind your application from the API Management service instance on Cloud Foundry. For more information, see [Unbinding a Cloud Foundry Application from an API Management, API portal Service Instance](../managing-cloud-foundry-microservices-through-api-management-e609a3e.md#loioe609a3efe6d64e1781cbf81ae5592071__unbinding) +2. Unbind your application from the API Management service instance on Cloud Foundry. For more information, see [Unbinding a Cloud Foundry Application from an API Management, API portal Service Instance](../unbinding-a-cloud-foundry-application-from-an-api-management-api-portal-service-instance-09fd33a.md) 3. Bind your application to the API Management service instance on Cloud Foundry. For more information, see [Binding a Cloud Foundry Application to an API Management, API portal Service Instance](../managing-cloud-foundry-microservices-through-api-management-e609a3e.md#loioe609a3efe6d64e1781cbf81ae5592071__Binding) @@ -193,7 +193,7 @@ If your Cloud Foundry application and the API Management capability are on diffe For more information, see [User Provided Service](https://docs.cloudfoundry.org/services/route-services.html#user-provided) -2. Unbind your application from the API Management service instance on Cloud Foundry. For more information, see [Unbinding a Cloud Foundry Application from an API Management, API portal Service Instance](../managing-cloud-foundry-microservices-through-api-management-e609a3e.md#loioe609a3efe6d64e1781cbf81ae5592071__unbinding) +2. Unbind your application from the API Management service instance on Cloud Foundry. For more information, see [Unbinding a Cloud Foundry Application from an API Management, API portal Service Instance](../unbinding-a-cloud-foundry-application-from-an-api-management-api-portal-service-instance-09fd33a.md) 3. Bind the User Provided Service created in the first step to the Cloud Foundry Application. For this binding, use the following command: > ### Sample Code: diff --git a/docs/ISuite/APIM-Migration/prerequisites-for-the-source-and-the-target-system-1b181dd.md b/docs/ISuite/APIM-Migration/prerequisites-for-the-source-and-the-target-system-1b181dd.md index 98f9ff97..c60003bd 100644 --- a/docs/ISuite/APIM-Migration/prerequisites-for-the-source-and-the-target-system-1b181dd.md +++ b/docs/ISuite/APIM-Migration/prerequisites-for-the-source-and-the-target-system-1b181dd.md @@ -25,7 +25,7 @@ Both the source and the target system are the system that has your API Managemen The client id, client secret are used while filling in the details of the `apim-tct-input.json` file before running the Tenant Cloning Tool. See [Clone API Management Content](clone-api-management-content-7abd887.md). > ### Note: - > During Cloud Foundry to Cloud Foundry migration, the default input.json shipped with Tenant Cloning Tool maven zip bundle has username and password as the source field. Please ensure that you change this to token URL, clientId, and client secret as mentioned in the sample configuration in [Clone API Management Content for Cloud Foundry to Cloud Foundry Migration](clone-api-management-content-for-cloud-foundry-to-cloud-foundry-migration-2e5d127.md). + > During Cloud Foundry to Cloud Foundry migration, the default input.json shipped with Tenant Cloning Tool maven zip bundle has username and password as the source field. Please ensure that you change this to token URL, clientId, and client secret as mentioned in the sample configuration in [Clone API Management Content between Cloud Foundry Environments](clone-api-management-content-between-cloud-foundry-environments-2e5d127.md). @@ -105,5 +105,5 @@ Both the source and the target system are the system that has your API Managemen - When you have API products protected by the custom roles permission in the source Cloud Foundry system, ensure that custom roles creation and assignments are done in the target Cloud Foundry environment before starting the migration. -Once you complete these checks, you can start cloning the API Management content from the source to the target system. See [Clone API Management Content for Cloud Foundry to Cloud Foundry Migration](clone-api-management-content-for-cloud-foundry-to-cloud-foundry-migration-2e5d127.md). +Once you complete these checks, you can start cloning the API Management content from the source to the target system. See [Clone API Management Content between Cloud Foundry Environments](clone-api-management-content-between-cloud-foundry-environments-2e5d127.md). diff --git a/docs/ISuite/APIM-Migration/tenant-cloning-tool-behavior-6d15ffd.md b/docs/ISuite/APIM-Migration/tenant-cloning-tool-behavior-6d15ffd.md index 8f9e33be..64348c0f 100644 --- a/docs/ISuite/APIM-Migration/tenant-cloning-tool-behavior-6d15ffd.md +++ b/docs/ISuite/APIM-Migration/tenant-cloning-tool-behavior-6d15ffd.md @@ -44,6 +44,3 @@ This topic describes the behavior of the Tenant Cloning Tool with respect to clo > > **Reason for the error**: During migration, the product gets cloned along with the newly revised rate plan in the target tenant. However, while creating the application in the target tenant, the system couldn't locate the revised rate plan ID. The revised rate plan ID was not present in the payload as it belonged to an older subscription, resulting in application creation failure. -> ### Note: -> CacheResources cloning is currently not supported via the Tenant Cloning Tool. You must create it manually on the target Integration Suite using the following service: `/apiportal/api/1.0/Management.svc/CacheResources`. - diff --git a/docs/ISuite/APIM-Migration/tenant-cloning-tool-behavior-b23c603.md b/docs/ISuite/APIM-Migration/tenant-cloning-tool-behavior-b23c603.md index 74dcb361..bc652118 100644 --- a/docs/ISuite/APIM-Migration/tenant-cloning-tool-behavior-b23c603.md +++ b/docs/ISuite/APIM-Migration/tenant-cloning-tool-behavior-b23c603.md @@ -44,6 +44,3 @@ This topic describes the behavior of the Tenant Cloning Tool with respect to clo > > **Reason for the error**: During migration, the product gets cloned along with the newly revised rate plan in the target tenant. However, while creating the application in the target tenant, the system couldn't locate the revised rate plan ID. The revised rate plan ID was not present in the payload as it belonged to an older subscription, resulting in application creation failure. -> ### Note: -> CacheResources cloning is currently not supported via the Tenant Cloning Tool. You must create it manually on the target Integration Suite using the following service: `/apiportal/api/1.0/Management.svc/CacheResources`. - diff --git a/docs/ISuite/accessing-api-business-hub-enterprise-apis-programmatically-dabee6e.md b/docs/ISuite/accessing-api-business-hub-enterprise-apis-programmatically-dabee6e.md index 1bf6c7be..3147c516 100644 --- a/docs/ISuite/accessing-api-business-hub-enterprise-apis-programmatically-dabee6e.md +++ b/docs/ISuite/accessing-api-business-hub-enterprise-apis-programmatically-dabee6e.md @@ -43,7 +43,7 @@ This topic explains how to enable API access for API business hub enterprise. The client credentials like url, clientId, and clientSecret details appear for the given service key. -- You have created a destination of type `OAuth2Credentials` to the XSUAA APIs by using the credentials you derived from creating the service key. +- You have created a destination of type `OAuth2Credentials` to the XSUAA APIs by using the credentials you derived from creating the service key. This is required to access the XSUAA APIs for authorization and trust mangement services. 1. From your *Subaccount*, navigate to *Connectivity* \> *Destinations* \> *New Destination*. 2. Choose the service instance that you created above. 3. In the *Destination Configuration* window, provide the details. diff --git a/docs/ISuite/accessing-api-management-apis-programmatically-24a2c37.md b/docs/ISuite/accessing-api-management-apis-programmatically-24a2c37.md index 12065a7d..6114d518 100644 --- a/docs/ISuite/accessing-api-management-apis-programmatically-24a2c37.md +++ b/docs/ISuite/accessing-api-management-apis-programmatically-24a2c37.md @@ -2,7 +2,7 @@ # Accessing API Management APIs Programmatically -The *apiportal-apiaccess* paln offers external applications the ability to access the public APIs of the Integration Suite API Management capability. These APIs are used by the external applications to perform CRUD operations on API Management features like API proxies or products. These APIs are built on REST and OData principles and are extensively documented on the [Business Accelerator Hub](https://api.sap.com/package/APIMgmt/odata). +The *apiportal-apiaccess* plan offers external applications the ability to access the public APIs of the Integration Suite API Management capability. These APIs are used by the external applications to perform CRUD operations on API Management features like API proxies or products. These APIs are built on REST and OData principles and are extensively documented on the [Business Accelerator Hub](https://api.sap.com/package/APIMgmt/odata). @@ -12,7 +12,7 @@ The *apiportal-apiaccess* paln offers external applications the ability to acces The *apiportal-apiaccess* plan allows you to programmatically import/export API proxies, create products, key value maps. It is especially useful when integrating API Management with a CI/CD process or when migrating from a Neo to Cloud Foundry environment using the migration tool. -The API Access plan allows you to generate a service key by creating a service instance. By creating a service instance, you can generate a service key that includes the application url, clientId, clientSecret, and tokenUrl is used tohttps://api.sap.com/package/APIMgmt/odata generate a bearer token with the help of a REST Console. This Bearer Token, along with the application url and API endpoint are used to trigger the API. Therefore, bearer token acts like a key to access the APIs. +The API Access plan allows you to generate a service key by creating a service instance. By creating a service instance, you can generate a service key that includes the application url, clientId, clientSecret, and tokenUrl is used to generate a bearer token with the help of a REST Console. This Bearer Token, along with the application url and API endpoint are used to trigger the API. Therefore, bearer token acts like a key to access the APIs. @@ -24,7 +24,7 @@ The API Access plan allows you to generate a service key by creating a service i OR - You have subscribed to the standalone *API Management, API portal* tile in the Cloud Foundry environment. For more information, see [Set Up API Portal Application](https://help.sap.com/viewer/66d066d903c2473f81ec33acfe2ccdb4/Cloud/en-US/29c281b4a002404eba44e91c6fad0d34.html "To create APIs, products, import policy templates, and view applications, set up the API portal application.") :arrow_upper_right:. + You have subscribed to the standalone *API Management, API portal* tile in the Cloud Foundry environment. For more information, see [Set Up API Portal Application](https://help.sap.com/viewer/4425026877144cc2b15505ed30215167/IAT/en-US/29c281b4a002404eba44e91c6fad0d34.html "To create APIs, products, import policy templates, and view applications, set up the API portal application.") :arrow_upper_right:. - As a subaccount administrator, you additionally need the role of \(org member\) and *space developer* in the Cloud Foundry space in which the Integration Suite is provisioned. @@ -404,7 +404,7 @@ In the REST Console: - Now, to trigger an API, in the same REST Console, append the API endpoint \(obtained from the API portal APIs that are located in the SAP API Management package of API Business Hub\) to the *url*. > ### Note: - > Currently, the *apiportal-apiaccess* plan allows you to access only the API portal APIs from the [SAP API Management package](https://api.sap.com/package/APIMgmt?section=Artifacts). + > Currently, the *apiportal-apiaccess* plan allows you to access only the API Management APIs from the [SAP API Management package](https://api.sap.com/package/APIMgmt?section=Artifacts). - Choose `Bearer Token` as the `Authorization` type and paste the copied Bearer Token in the specified space. - Include payloads, if needed. diff --git a/docs/ISuite/accessing-on-premise-systems-through-api-management-2fc7a5b.md b/docs/ISuite/accessing-on-premise-systems-through-api-management-2fc7a5b.md index 0c4163b4..86a88645 100644 --- a/docs/ISuite/accessing-on-premise-systems-through-api-management-2fc7a5b.md +++ b/docs/ISuite/accessing-on-premise-systems-through-api-management-2fc7a5b.md @@ -12,6 +12,9 @@ The *on-premise-connectivity* plan helps in achieving principal propagation whil Let us consider an use case where you want to pass the identity and security context of the logged-in user in the client application \(known as the principal\) from client application to on-premise backend. It ensures that the downstream services have the necessary information to authenticate the client without requiring the client to re-authenticate for each service. When a client makes a request to an API gateway, the gateway authenticates the user. It then propagates the principal information, such as the user's identity, to the backend services that the client's request needs to access. This allows the downstream services to make authorization decisions based on the user's details. +> ### Note: +> The API Management platform incorporates the circuit breaker pattern to enhance the resilience of the back-end. For more information, see [Circuit Breaker](circuit-breaker-bd3c2d5.md). + ![](images/On-prem_Connectivity_1067d7f.png) To accomplish principal propagation, you require a service key. This plan allows you to obtain the token by creating a service instance and generating a service key. diff --git a/docs/ISuite/activate-and-configure-api-management-capability-f6eb433.md b/docs/ISuite/activate-and-configure-api-management-capability-f6eb433.md new file mode 100644 index 00000000..caa2849a --- /dev/null +++ b/docs/ISuite/activate-and-configure-api-management-capability-f6eb433.md @@ -0,0 +1,90 @@ + + +# Activate and Configure API Management Capability + +Steps to activate and configure API Management capability in SAP Integration Suite. + + +
+Create, edit, delete user roles. + + + +n.a. + + + +UserRolesEdit + + + +Tenant Administrator + +
+ +Monitor + + + View deployed security material + Supported Values + + + Required/Optional +   + + + Required +   + + + Optional +   + + + Optional +   + + + Required +   + + + Optional +   + + + Optional - Supported values: "guid" +   @@ -306,6 +341,11 @@ Once you have your source and target system ready, you can clone your API Manage + Supported values: "guid" + + + Optional +   + + + Required +   + + + Required +   + + + Optional +   + + + Optional +   + + + Optional +   + + + Optional +   + + + Optional +   + + + Optional +   + + + Required +   + + + Required +   + + + Optional +   + + + Optional +   + + + Optional +   + + + Optional +   + + + Optional +   + + + Optional +   + + + Required +   + + + Required +   + + + Optional +   + + + Optional +   + + + Optional +   + + + Optional +   + + + Optional +   + + + Optional - Supported values: `true/false` +   @@ -963,6 +1123,11 @@ Once you have your source and target system ready, you can clone your API Manage + Supported values: `true/false` + + + Optional - Supported values: `true/false` +   @@ -1006,6 +1171,11 @@ Once you have your source and target system ready, you can clone your API Manage + Supported values: `true/false` + + + Optional - Supported values: `true/false` +   @@ -1048,6 +1218,11 @@ Once you have your source and target system ready, you can clone your API Manage + Supported values: `true/false` + + + Optional - Supported values: `true/false` +   @@ -1083,6 +1258,11 @@ Once you have your source and target system ready, you can clone your API Manage + Supported values: `true/false` + + + Optional - Supported values: `"DEFAULT" | "SWITCHOVER` +   @@ -1123,6 +1303,11 @@ Once you have your source and target system ready, you can clone your API Manage + Supported values: `"DEFAULT" | "SWITCHOVER` + + + Optional + Supported Values + + + Required/Optional +   + + + Required +   + + + Optional +   + + + Optional +   + + + Optional +   + + + Required +   + + + Required +   + + + Required +   + + + Required +   + + + Required +   + + + Optional +   + + + Optional +   + + + Optional +   + + + Optional +   + + + Optional +   + + + Optional +   + + + Optional - Supported values: "guid" +   @@ -544,6 +629,11 @@ Once you have your source and target system ready, you can clone your API Manage + Supported values: "guid" + + + Not Applicable +   + + + Required +   + + + Required +   + + + Optional +   + + + Optional +   + + + Optional +   + + + Optional +   + + + Optional +   + + + Optional +   + + + Required +   + + + Required +   + + + Optional +   + + + Optional +   + + + Optional +   + + + Optional +   + + + Optional +   + + + Optional - Supported values: `true/false` +   @@ -996,6 +1166,11 @@ Once you have your source and target system ready, you can clone your API Manage + Supported values: `true/false` + + + Optional - Supported values: `true/false` +   @@ -1041,6 +1216,11 @@ Once you have your source and target system ready, you can clone your API Manage + Supported values: `true/false` + + + Optional - Supported values: `true/false` +   @@ -1076,6 +1256,11 @@ Once you have your source and target system ready, you can clone your API Manage + Supported values: `true/false` + + + Optional - Supported values: `"DEFAULT" | "SWITCHOVER` +   @@ -1116,6 +1301,11 @@ Once you have your source and target system ready, you can clone your API Manage + Supported values: `"DEFAULT" | "SWITCHOVER` + + + Optional
+ + + + + + + + + + + + + + + + +
+ +Steps + + + +Details + +
+ +Subscribe to SAP Integration Suite + + + +To set up the API Management capability from Integration Suite, you should first have an Integration Suite subscription. + +Subscribe to the SAP Integration Suite in SAP BTP cockpit and assign the *Integration\_Provisioner* role to gain access. For more information, see [Initial Setup of SAP Integration Suite](10-InitialSetup/initial-setup-of-sap-integration-suite-3dcf507.md). + +> ### Note: +> Please make sure that you do not have a starter plan instance created in the same subaccount where you intend to create an Integration Suite subscription. Additionally, please note that API Management capabilities from Integration Suite and API Management subscriptions using the stand-alone tile cannot coexist in the same subaccount. + + + +
+ +Activate the API Management capability + + + +Add and activate API Management capability in Integration Suite. For more information, see [Activating and Managing Capabilities](activating-and-managing-capabilities-2ffb343.md). + +
+ +Configure the API Management capability + + + +Access the *API Settings* page, and complete the onboarding process. For more information, see [Setting Up API Management Capability](50-Development/setting-up-api-management-capability-f34e86c.md). + +To access the *API Settings*, the *APIManagement.Selfservice.Administrator* role must me assigned to you. + +> ### Note: +> If you are using a trial account, your account will be automatically provisioned once you select the *APIs* option in the *Settings* menu. During the provisioning process, the system will assign a default virtual host for you. You will receive a notification when the provisioning is complete. At this point, the *APIs* option will no longer be visible in the side-navigation menu under *Settings*. You will be logged out of the Integration Suite automatically. To continue, simply log in again. After logging in, you will have the ability to create APIs, build API proxies as a service provider, and utilize other convenient services offered by the platform. + + + +
+ +> ### Note: +> For visual intructions on how to activate and configure API Management capability from Integration Suite, refer the tutorial [Set Up API Management from Integration Suite | Tutorials for SAP Developers](https://developers.sap.com/tutorials/api-mgmt-isuite-initial-setup.html). + +**Related Information** + + +[Tasks and Corresponding Role Collections](tasks-and-corresponding-role-collections-911ca5a.md "Similar to other capabilities of the SAP Integration Suite, the API Management capability defines a set of technical roles that grant specific permissions to users. Users can be assigned roles through SAP BTP's role collection concept. While users have the option to create their own role collections, a set of predefined role collections is automatically created when the API Management capability is provisioned.") + +[Create an API Provider](50-Development/create-an-api-provider-6b263e2.md "Define the details of the host you want an application to reach by creating an API provider.") + +[Different Methods of Creating an API Proxy](50-Development/different-methods-of-creating-an-api-proxy-4ac0431.md "An API proxy is the data object that contains all the functionality to be executed when an external user wants to access the backend service.") + +[Configuring a Custom Domain for a Virtual Host](configuring-a-custom-domain-for-a-virtual-host-6b9e5a3.md "The API Management capability enables you to personalize the virtual host URL by configuring a custom domain of your choice. This means that you can have all your APIs displayed as "https://api.bestrun.com/..." if desired. Additionally, you have the option to set up multiple virtual hosts using the same custom domain, such as "https://api1.bestrun.com," "https://api2.bestrun.com," and so on.") + +[Configuring Mutual TLs for Virtual Host](configuring-mutual-tls-for-virtual-host-9faf7ce.md "You can configure mutual TLs for a virtual host, which validates the identities of both the web server and the web client.") + +[Cancel API Management Service Subscription](cancel-api-management-service-subscription-df6df2b.md "You can deactivate your API Management capability from Integration Suite to disable your account from the API Management service.") + diff --git a/docs/ISuite/activate-edge-integration-cell-a8e497f.md b/docs/ISuite/activate-edge-integration-cell-a8e497f.md index b66ace48..c30f429c 100644 --- a/docs/ISuite/activate-edge-integration-cell-a8e497f.md +++ b/docs/ISuite/activate-edge-integration-cell-a8e497f.md @@ -21,6 +21,11 @@ Activate Edge Integration Cell in SAP Integration Suite. Edge Integration Cell is an optional hybrid runtime offered as part of SAP Integration Suite. Before starting the actual deployment, you need to activate the Edge Integration Cell option in SAP Integration Suite. +> ### Note: +> The Edge Integration Cell runtime can be activated within designated SAP BTP regions and Cloud Service Providers. +> +> For more information, including the full list of supported regions and the future availability schedule, see [3379690](https://me.sap.com/notes/3379690). + ## Procedure @@ -30,6 +35,6 @@ Edge Integration Cell is an optional hybrid runtime offered as part of SAP Integ 2. Choose *Activate*. Once the Edge Integration Cell is activated, the URL for accessing Edge Lifecycle Management user interface is displayed. You use this user interface to perform all lifecycle management operations. > ### Note: - > Edge Integration Cell URL is enabled as soon as the *Integration Suite* tenant has been successfully created. + > Edge Integration Cell URL is enabled as soon as the *Integration Suite* tenant has been successfully created diff --git a/docs/ISuite/activating-and-managing-capabilities-2ffb343.md b/docs/ISuite/activating-and-managing-capabilities-2ffb343.md index 32436974..95857c51 100644 --- a/docs/ISuite/activating-and-managing-capabilities-2ffb343.md +++ b/docs/ISuite/activating-and-managing-capabilities-2ffb343.md @@ -191,7 +191,7 @@ This topic describes how to add and activate relevant capabilities in Integratio > > - You can choose *Add Capabilities* to activate additional capabilities at a later point in time. > - > - After activation, assign the required roles to users for accessing the individual capabilities. See [Configuring User Access](configuring-user-access-2c6214a.md). + > - After activation, assign the required roles to users for accessing the individual capabilities. See [Configuring User Access](configuring-user-access-to-sap-integration-suite-2c6214a.md). @@ -200,11 +200,11 @@ This topic describes how to add and activate relevant capabilities in Integratio ## Results -- Capabilities are displayed on the home page as tiles. To access the functionalities offered by these capabilities, users must have the required roles assigned. See [Configuring User Access](configuring-user-access-2c6214a.md). +- Capabilities are displayed on the home page as tiles. To access the functionalities offered by these capabilities, users must have the required roles assigned. See [Configuring User Access to SAP Integration Suite](configuring-user-access-to-sap-integration-suite-2c6214a.md). - The API Management capability needs a few more configuration steps before activation. See [Additional Configurations for API Management](additional-configurations-for-api-management-5ac63ab.md). **Related Information** -[Centralized API business hub enterprise \[New Design\]](50-Development/centralized-api-business-hub-enterprise-new-design-38422de.md "The centralized API business hub enterprise is a central API catalog, allowing application developers to consume APIs and other assets, from a common platform.") +[Centralized API business hub enterprise \[New Design\]](50-Development/centralized-api-business-hub-enterprise-new-design-38422de.md "The API business hub enterprise is a central API catalog, allowing application developers to consume APIs and other assets, from a common platform.") diff --git a/docs/ISuite/add-an-sap-process-orchestration-system-5f76723.md b/docs/ISuite/add-an-sap-process-orchestration-system-5f76723.md index 427ed9d4..ae53b1da 100644 --- a/docs/ISuite/add-an-sap-process-orchestration-system-5f76723.md +++ b/docs/ISuite/add-an-sap-process-orchestration-system-5f76723.md @@ -17,7 +17,7 @@ Establish a connection between your SAP Process Orchestration system and Migrati > ### Note: > Do you prefer hands-on instructions? Check out the tutorial [Enable Migration Assessment Application](https://developers.sap.com/tutorials/migration-assessment-enablement.html). -- You've set up the relevant access rights for yourself and your users as described in [Configuring User Access](configuring-user-access-2c6214a.md). +- You've set up the relevant access rights for yourself and your users as described in [Configuring User Access to SAP Integration Suite](configuring-user-access-to-sap-integration-suite-2c6214a.md). - As API endpoints and subpaths are used to extract data from your SAP Process Orchestration system, make sure that the SAP Destination service can access the endpoints listed in the following. See [Destination Service](https://help.sap.com/docs/BTP/65de2977205c403bbc107264b8eccf4b/eeb0ec2318fb4dda87830a09ac7a02fa.html). @@ -38,6 +38,7 @@ Establish a connection between your SAP Process Orchestration system and Migrati - `/rep/read/ext` - `/dir/read/ext` - `/rep/support/SimpleQuery` + - `/rep/query/ext` - Message Monitoring diff --git a/docs/ISuite/api-lifecycle-5e8ea7d.md b/docs/ISuite/api-lifecycle-5e8ea7d.md index 2eb9f34f..5108bd81 100644 --- a/docs/ISuite/api-lifecycle-5e8ea7d.md +++ b/docs/ISuite/api-lifecycle-5e8ea7d.md @@ -13,13 +13,13 @@ API Management in SAP Integration Suite is used to discover, shape, compose, int [Build API Proxies](50-Development/build-api-proxies-74c042b.md "SAP Integration Suite provides a common platform for API designers to define and publish APIs. Every SAP Integration Suite customer is provided with their own SAP Integration Suite application on cloud. The SAP Integration Suite offers capabilities to configure systems, build and publish APIs, analyze and test APIs.") -[Test API Proxies](https://help.sap.com/viewer/66d066d903c2473f81ec33acfe2ccdb4/Cloud/en-US/3ba6151391bc474b9f1fa69455f65e3b.html "Use the API Test Console to test the runtime behavior of the API proxies.") :arrow_upper_right: +[Test API Proxies](https://help.sap.com/viewer/4425026877144cc2b15505ed30215167/IAT/en-US/3ba6151391bc474b9f1fa69455f65e3b.html "Use the API Test Console to test the runtime behavior of the API proxies.") :arrow_upper_right: [Publish API Proxies](50-Development/publish-api-proxies-75a4a11.md "To make your API consumable by external application developers, it is necessary to publish API proxies. Publishing allows you to expose the API proxies in a structured manner, presenting them as a product. To publish API proxies effectively, it is important to understand how to bundle them together and present them as a cohesive product.") -[Monetize APIs](https://help.sap.com/viewer/66d066d903c2473f81ec33acfe2ccdb4/Cloud/en-US/fcdc89b5c4884d5e8cfb32c5914943ab.html "API Management provides monetization feature to all API providers to generate revenue for using the APIs.") :arrow_upper_right: + [Consume API Proxies](50-Development/consume-api-proxies-ea561e4.md "Consume API proxies via the API business hub enterprise. In the API business hub enterprise, an application developer registers, explores the API exposed by customers, creates applications, and tests API proxies.") -[Analyze APIs](50-Development/analyze-apis-7712c61.md "Use the capabilities of API Analytics to analyze API usage and performance.") +[Analyze API Proxies](50-Development/analyze-api-proxies-7712c61.md "Use the capabilities of API Analytics to analyze API proxy usage and performance.") diff --git a/docs/ISuite/api-management-1b17d18.md b/docs/ISuite/api-management-1b17d18.md index bedf54d7..e775cab4 100644 --- a/docs/ISuite/api-management-1b17d18.md +++ b/docs/ISuite/api-management-1b17d18.md @@ -117,7 +117,7 @@ Use this service in tenant-aware pplications. ## Getting Started -You can provision the API Management capability from the Integration Suite launchpad. For the detailed steps, see [Enable API Management Capability](enable-api-management-capability-f6eb433.md). +You can provision the API Management capability from the Integration Suite launchpad. For the detailed steps, see [Activate and Configure API Management Capability](activate-and-configure-api-management-capability-f6eb433.md). **Related Information** diff --git a/docs/ISuite/api-management-service-plans-e064663.md b/docs/ISuite/api-management-service-plans-e064663.md index 868d85ca..d5c9c375 100644 --- a/docs/ISuite/api-management-service-plans-e064663.md +++ b/docs/ISuite/api-management-service-plans-e064663.md @@ -2,7 +2,7 @@ # API Management Service Plans -The functionality of the API Management capability is typically managed using the Integration Suite \(UI\) application, which is the primary focus of this user guide. However, you can also call API Management APIs, manage Cloud Foundry applications, and connect to an on-premise backend sytem by means of service plans. +The service plans of the API Management Cloud Foundry environment allow you to interact with the services available in Cloud Foundry. By creating a service instance, you can obtain unique credentials to connect with these services. The API Management services on Cloud Foundry provides different capabilities through the following plans: diff --git a/docs/ISuite/assigning-role-collections-to-users-80bb02e.md b/docs/ISuite/assigning-role-collections-to-users-80bb02e.md index 15a1521f..7590bd89 100644 --- a/docs/ISuite/assigning-role-collections-to-users-80bb02e.md +++ b/docs/ISuite/assigning-role-collections-to-users-80bb02e.md @@ -28,9 +28,9 @@ Role collections enable you to group together the roles you create. The role col **Related Information** -[Set Up API Portal Application](https://help.sap.com/viewer/66d066d903c2473f81ec33acfe2ccdb4/Cloud/en-US/29c281b4a002404eba44e91c6fad0d34.html "To create APIs, products, import policy templates, and view applications, set up the API portal application.") :arrow_upper_right: +[Set Up API Portal Application](https://help.sap.com/viewer/4425026877144cc2b15505ed30215167/IAT/en-US/29c281b4a002404eba44e91c6fad0d34.html "To create APIs, products, import policy templates, and view applications, set up the API portal application.") :arrow_upper_right: -[Set Up API business hub enterprise Application Using the Standalone Tile](https://help.sap.com/viewer/66d066d903c2473f81ec33acfe2ccdb4/Cloud/en-US/80c0519ebf1449d9bed37fccf7ba127a.html "To discover, consume and monitor API from a centralized API catalog, set up the API business hub enterprise application.") :arrow_upper_right: +[Set Up API business hub enterprise Application Using the Standalone Tile](https://help.sap.com/viewer/4425026877144cc2b15505ed30215167/IAT/en-US/80c0519ebf1449d9bed37fccf7ba127a.html "To discover, consume and monitor API from a centralized API catalog, set up the API business hub enterprise application.") :arrow_upper_right: -[Shadow Users](https://help.sap.com/viewer/38c3df3f8da44a809f937220b3579607/Cloud/en-US/a0f5fe580ed846ca95f8601678509add.html "Whenever a user authenticates at an application in your subaccount using any identity provider, it’s essential that user-related data provided by the identity provider is stored in the form of shadow users.") :arrow_upper_right: +[Shadow Users](https://help.sap.com/viewer/4425026877144cc2b15505ed30215167/IAT/en-US/a0f5fe580ed846ca95f8601678509add.html "Whenever a user authenticates at an application in your subaccount using any identity provider, it’s essential that user-related data provided by the identity provider is stored in the form of shadow users.") :arrow_upper_right: diff --git a/docs/ISuite/cancel-api-management-service-subscription-df6df2b.md b/docs/ISuite/cancel-api-management-service-subscription-df6df2b.md index 40fcb543..16d46aaf 100644 --- a/docs/ISuite/cancel-api-management-service-subscription-df6df2b.md +++ b/docs/ISuite/cancel-api-management-service-subscription-df6df2b.md @@ -42,9 +42,9 @@ If you've enabled the API Management capability via Integration Suite, perform t [Region-Specific IP Addresses Available for API Management Cloud Foundry Environment](region-specific-ip-addresses-available-for-api-management-cloud-foundry-environment-585d639.md "API Management protects your backend services. However, API Management needs to establish connectivity to your backend services during an API call execution.") -[User Roles in API Management \(New\)](user-roles-in-api-management-new-911ca5a.md "Similar to other capabilities of the SAP Integration Suite, the API Management capability defines a set of technical roles that grant specific permissions to users. Users can be assigned roles through SAP BTP's role collection concept. While users have the option to create their own role collections, a set of predefined role collections is automatically created when the API Management capability is provisioned.") +[Tasks and Corresponding Role Collections](tasks-and-corresponding-role-collections-911ca5a.md "Similar to other capabilities of the SAP Integration Suite, the API Management capability defines a set of technical roles that grant specific permissions to users. Users can be assigned roles through SAP BTP's role collection concept. While users have the option to create their own role collections, a set of predefined role collections is automatically created when the API Management capability is provisioned.") [User Roles in API Management](user-roles-in-api-management-7010b58.md "Use role collections to group together different roles that can be assigned to API Portal and API business hub enterprise users.") -[](https://help.sap.com/viewer/51ab953548be4459bfe8539ecaeee98d/CLOUD/en-US/1e88d9cb4e90466cb0ab2c53e33b2e1c.html "") :arrow_upper_right: +[Setting Up API Management with SAP Cloud Identity Services](setting-up-api-management-with-sap-cloud-identity-services-1e88d9c.md "SAP Cloud Platform allows customers to connect their SAP Cloud Identity Services with the BTP offerings.") diff --git a/docs/ISuite/capabilities-e1c5b90.md b/docs/ISuite/capabilities-of-sap-integration-suite-e1c5b90.md similarity index 83% rename from docs/ISuite/capabilities-e1c5b90.md rename to docs/ISuite/capabilities-of-sap-integration-suite-e1c5b90.md index ce851bdc..9b6958e0 100644 --- a/docs/ISuite/capabilities-e1c5b90.md +++ b/docs/ISuite/capabilities-of-sap-integration-suite-e1c5b90.md @@ -1,8 +1,8 @@ -# Capabilities +# Capabilities of SAP Integration Suite -Working with capabilities. +Working with SAP Integration Suite capabilities. SAP Integration Suite brings together the features and functionality of various capabilities such as Cloud Integration, API Management, Graph, Trading Partner Management, Integration Advisor, Open Connectors, Integration Assessment, and Migration Assessment. @@ -13,5 +13,5 @@ To work with these capabilities, you must: > ### Note: > You must have the Integration\_Provisioner role to add and activate the capabilities. See [Subscribing and Configuring Initial Access to SAP Integration Suite](10-InitialSetup/subscribing-and-configuring-initial-access-to-sap-integration-suite-8a3c8b7.md) -- Once the capabilities are activated, configure user access by assigning the appropriate roles and role collections to the users who want to work with the capabilities. See [Configuring User Access](configuring-user-access-2c6214a.md). +- Once the capabilities are activated, configure user access by assigning the appropriate roles and role collections to the users who want to work with the capabilities. See [Configuring User Access to SAP Integration Suite](configuring-user-access-to-sap-integration-suite-2c6214a.md). diff --git a/docs/ISuite/circuit-breaker-bd3c2d5.md b/docs/ISuite/circuit-breaker-bd3c2d5.md new file mode 100644 index 00000000..2a2166ee --- /dev/null +++ b/docs/ISuite/circuit-breaker-bd3c2d5.md @@ -0,0 +1,20 @@ + + +# Circuit Breaker + +In the context of an API or service proxy, a circuit breaker is a design pattern used to improve the resilience and fault tolerance of the system. It is typically used to prevent cascading failures when a service or API endpoint becomes unresponsive or starts to exhibit high latency. + +The circuit breaker monitors the requests being made to a particular service or endpoint. If the number of failed requests exceeds a certain threshold within a specified time period, the circuit breaker "trips" and starts to short-circuit subsequent requests. Instead of forwarding the requests to the unresponsive service, the circuit breaker returns an error response immediately. + +By doing this, the circuit breaker helps to protect the system from overloading and allows it to gracefully handle failures. It also provides a fallback mechanism, where alternative actions can be taken when a service is unavailable, such as returning cached data or using a different service. + +The circuit breaker can periodically attempt to close the circuit and forward requests to the service again. If the service starts to respond successfully, the circuit breaker will reset and resume normal operation. However, if the service continues to fail, the circuit breaker will remain open, preventing further requests from being sent. + +Consider the following example: + +![](images/Circuit_Breaker_OPproxy_68cc29e.png) + +If the number of failed requests exceeds a certain threshold within a 10-second timeframe, the circuit breaker will activate and begin to intercept subsequent requests. Instead of forwarding these requests to the unresponsive service, the circuit breaker will return an error response. + +After 5 seconds, the circuit breaker will test the backend by forwarding a few requests to it. If these requests succeed, the circuit breaker will close and resume normal operation by forwarding all requests to the backend. + diff --git a/docs/ISuite/component-monitoring-49f487e.md b/docs/ISuite/component-monitor-49f487e.md similarity index 81% rename from docs/ISuite/component-monitoring-49f487e.md rename to docs/ISuite/component-monitor-49f487e.md index 3b6e37a5..9375dd4a 100644 --- a/docs/ISuite/component-monitoring-49f487e.md +++ b/docs/ISuite/component-monitor-49f487e.md @@ -2,11 +2,11 @@ -# Component Monitoring +# Component Monitor Get information on the components. -The Component Monitoring-tile shows you the most important information regarding your components at a glance. Out of all components for Edge Integration Cell, the tile always shows either those components in status *Error* or the status of the top three components, *Policy Engine*, *Worker*, and *Solace* \(Message Service\) in status *Ok*. +The Component Monitor tile shows you the most important information regarding your components at a glance. Out of all components for Edge Integration Cell, the tile always shows either those components in status *Error* or the status of the top three components, *Policy Engine*, *Worker*, and *Solace* \(Message Service\) in status *Ok*. Click on the tile to get a details view. On the screen, you see a table with the following information: @@ -36,9 +36,7 @@ Status of Resources: Error -If the *Pod Status* indicates an error, select *View Pod Events* \( View Pod Events \) to show the details of the pod events. For more information about pod events, see [https://kubernetes.io/docs/reference/kubernetes-api/cluster-resources/event-v1/\#Event.](https://kubernetes.io/docs/reference/kubernetes-api/cluster-resources/event-v1/#Event.) - -Running +OK @@ -69,6 +67,24 @@ Number of resources. +*Pod Status* + + + + +Status of Pods: + +Error + +Running + +If the *Pod Status* indicates an error, select *View Pod Events* \( View Pod Events \) to show the details of the pod events. For more information about pod events, see [https://kubernetes.io/docs/reference/kubernetes-api/cluster-resources/event-v1/\#Event.](https://kubernetes.io/docs/reference/kubernetes-api/cluster-resources/event-v1/#Event.) + + + + + + *Restarts* diff --git a/docs/ISuite/components-of-api-management-e02ae53.md b/docs/ISuite/components-of-api-management-e02ae53.md index a1bb61cf..e0bef766 100644 --- a/docs/ISuite/components-of-api-management-e02ae53.md +++ b/docs/ISuite/components-of-api-management-e02ae53.md @@ -8,11 +8,11 @@ The API Management infrastructure comprises of five key components: - **API Management Runtime**: You can deploy and effectively utilize your APIs. Applications consume the API runtime, request API authentication, and gain access. -- **API Management Design Time**: Serves as a platform for easy API discovery, allowing API administrators to manage, meter, and secure their APIs. Additionally, it enables administrators to define and publish rate plans for their APIs. For more information, see[Build API Proxies](50-Development/build-api-proxies-74c042b.md), [Publish API Proxies](50-Development/publish-api-proxies-75a4a11.md) [Monetize APIs](https://help.sap.com/viewer/66d066d903c2473f81ec33acfe2ccdb4/Cloud/en-US/fcdc89b5c4884d5e8cfb32c5914943ab.html "API Management provides monetization feature to all API providers to generate revenue for using the APIs.") :arrow_upper_right: [Analyze APIs](50-Development/analyze-apis-7712c61.md). +- **API Management Design Time**: Serves as a platform for easy API discovery, allowing API administrators to manage, meter, and secure their APIs. Additionally, it enables administrators to define and publish rate plans for their APIs. For more information, see[Build API Proxies](50-Development/build-api-proxies-74c042b.md), [Publish API Proxies](50-Development/publish-api-proxies-75a4a11.md) [Analyze API Proxies](50-Development/analyze-api-proxies-7712c61.md). - **API business hub enterprise**: It is a self-service portal for application developers. You can discover, browse, and explore APIs. Subscribe to a rate plan and build application. For more information, see [Consume API Proxies](50-Development/consume-api-proxies-ea561e4.md). -- **API Analytics**: Offers advanced analytical capabilities to track your API usage. Utilize API Analytics to gather data on URL usage, user IDs associated with API calls, latency information, and more. For more information, see [Analyze APIs](50-Development/analyze-apis-7712c61.md). +- **API Analytics**: Offers advanced analytical capabilities to track your API usage. Utilize API Analytics to gather data on URL usage, user IDs associated with API calls, latency information, and more. For more information, see [Analyze API Proxies](50-Development/analyze-api-proxies-7712c61.md). - **API Designer**: API developers have the ability to define, implement, and document APIs. The API Designer offers support for open APIs and allows for the generation of various outputs. For more information, see [Create an API Proxy Using the API Designer](50-Development/create-an-api-proxy-using-the-api-designer-26e1bbd.md). diff --git a/docs/ISuite/configuring-a-default-domain-for-a-virtual-host-1085228.md b/docs/ISuite/configuring-a-default-domain-for-a-virtual-host-1085228.md index 88e6159a..0226b6e2 100644 --- a/docs/ISuite/configuring-a-default-domain-for-a-virtual-host-1085228.md +++ b/docs/ISuite/configuring-a-default-domain-for-a-virtual-host-1085228.md @@ -108,6 +108,92 @@ To request a custom domain with one-way TLS, perform the following steps: > ``` +3. Service to update a virtual host: + + You can update the virtualHostUrl, trustStore, and the isDefaultVirtualHostRequest flag. + + You can also convert your default domain virtual host to custom domain by refering to the update section \(Step 3\) of the [Configuring a Custom Domain for a Virtual Host](configuring-a-custom-domain-for-a-virtual-host-6b9e5a3.md) topic. + + - Service URL: https:///apiportal/operations/1.0/Configuration.svc/VirtualHostRequests + - Method: POST + - Request Header: Authentication Bearer + - Content Type: application/json + - Request Body: + + > ### Sample Code: + > ``` + > { + > "accountId" : "subdomain of your subaccount", + > "virtualHostUrl": "prod-apis-updated", + > "isDefaultVirtualHostRequest" : false, + > "operation" : "UPDATE", + > "virtualHostId":"c269915f-7adc-4f78-bdd0-dd39ffcb079f" + > } + > --> + > + > ``` + + > ### Note: + > - accountId: This is the subdomain of your subaccount. + > + > - virtualHostUrl - This is your virtual host alias, for example, prod-apis, testapi. + > + > - isDefaultVirtualHostRequest -if you want the new virtual host to be the default virtual host, set the value to "true", else set it to "false". + > + > - virtualHostId: This is the unique ID of the virtual host you are trying to update. + + > ### Note: + > To enable client authentication \(mutual TLS\) while configuring the virtual host with default domain, see [Configuring Mutual TLs for Virtual Host](configuring-mutual-tls-for-virtual-host-9faf7ce.md). + + + - Response: 201 + + > ### Sample Code: + > ``` + > { + > "d": { + > "__metadata": { + > "id": "https://apiportalurl:443/apiportal/api/1.0/Management.svc/VirtualHostRequests('2F02AD6A-A53C-43F4-BF95-F053A8A1469B')", + > "uri": "https://apiportalurl:443/apiportal/api/1.0/Management.svc/VirtualHostRequests('2F02AD6A-A53C-43F4-BF95-F053A8A1469B')", + > "type": "apimgmtconfiguration.VirtualHostRequest" + > }, + > "accountId": "subdomain of your subaccount", + > "allocatedPort": 443, + > "allocationStatus": "COMPLETE", + > "clusterName": "", + > "id": "2F02AD6A-A53C-43F4-BF95-F053A8A1469B", + > "isClientAuthEnabled": false, + > "isDefaultVirtualHostRequest": false, + > "isForCustomDomain": false, + > "isForNonSni": false, + > "isTLS": false, + > "keyStoreAlias": null, + > "keyStoreName": null, + > "life_cycle": { + > "__metadata": { + > "type": "apimgmtconfiguration.History" + > }, + > "changed_at": "/Date(1707380514905)/", + > "changed_by": "sb-apiaccess_1705298659201!b109482|api-portal-xsuaa!b11864", + > "created_at": "/Date(1707380504072)/", + > "created_by": "sb-apiaccess_1705298659201!b109482|api-portal-xsuaa!b11864" + > }, + > "operation": "UPDATE", + > "trustStore": null, + > "virtualHostId": "c269915f-7adc-4f78-bdd0-dd39ffcb079f", + > "virtualHostUrl": "prod-apis-updated.sapdefaultdomain", + > "lbHost": null + > } + > } + > + > ``` + + - Response: 201 + + > ### Note: + > After the virtual host is updated, APIs associated to a product using the updated virtual host must be redeployed and republished. + **Related Information** diff --git a/docs/ISuite/configuring-additional-virtual-host-in-cloud-foundry-environment-a7b91e5.md b/docs/ISuite/configuring-additional-virtual-host-in-cloud-foundry-environment-a7b91e5.md index de7474e3..1fb2b6f8 100644 --- a/docs/ISuite/configuring-additional-virtual-host-in-cloud-foundry-environment-a7b91e5.md +++ b/docs/ISuite/configuring-additional-virtual-host-in-cloud-foundry-environment-a7b91e5.md @@ -11,11 +11,11 @@ Create a new virtual host with default domain or custom domain and update alias, [Region-Specific IP Addresses Available for API Management Cloud Foundry Environment](region-specific-ip-addresses-available-for-api-management-cloud-foundry-environment-585d639.md "API Management protects your backend services. However, API Management needs to establish connectivity to your backend services during an API call execution.") -[User Roles in API Management \(New\)](user-roles-in-api-management-new-911ca5a.md "Similar to other capabilities of the SAP Integration Suite, the API Management capability defines a set of technical roles that grant specific permissions to users. Users can be assigned roles through SAP BTP's role collection concept. While users have the option to create their own role collections, a set of predefined role collections is automatically created when the API Management capability is provisioned.") +[Tasks and Corresponding Role Collections](tasks-and-corresponding-role-collections-911ca5a.md "Similar to other capabilities of the SAP Integration Suite, the API Management capability defines a set of technical roles that grant specific permissions to users. Users can be assigned roles through SAP BTP's role collection concept. While users have the option to create their own role collections, a set of predefined role collections is automatically created when the API Management capability is provisioned.") [User Roles in API Management](user-roles-in-api-management-7010b58.md "Use role collections to group together different roles that can be assigned to API Portal and API business hub enterprise users.") [Cancel API Management Service Subscription](cancel-api-management-service-subscription-df6df2b.md "You can deactivate your API Management capability from Integration Suite to disable your account from the API Management service.") -[](https://help.sap.com/viewer/51ab953548be4459bfe8539ecaeee98d/CLOUD/en-US/1e88d9cb4e90466cb0ab2c53e33b2e1c.html "") :arrow_upper_right: +[Setting Up API Management with SAP Cloud Identity Services](setting-up-api-management-with-sap-cloud-identity-services-1e88d9c.md "SAP Cloud Platform allows customers to connect their SAP Cloud Identity Services with the BTP offerings.") diff --git a/docs/ISuite/configuring-user-access-2c6214a.md b/docs/ISuite/configuring-user-access-to-sap-integration-suite-2c6214a.md similarity index 96% rename from docs/ISuite/configuring-user-access-2c6214a.md rename to docs/ISuite/configuring-user-access-to-sap-integration-suite-2c6214a.md index 51818093..696238ec 100644 --- a/docs/ISuite/configuring-user-access-2c6214a.md +++ b/docs/ISuite/configuring-user-access-to-sap-integration-suite-2c6214a.md @@ -2,9 +2,9 @@ -# Configuring User Access +# Configuring User Access to SAP Integration Suite -Assign the required roles to users for accessing the individual capabilities. +Assign the required roles and role collections to users for accessing the individual capabilities. @@ -66,7 +66,7 @@ For more information on role collections, see [Roles and Role Collections](https Cloud Integration - For detailed list of scope and actions for each role collection, see [Tasks and Permissions](60-Security/tasks-and-permissions-556d557.md). + For detailed list of scope and actions for each role collection, see [Tasks and Permissions for Cloud Integration](60-Security/tasks-and-permissions-for-cloud-integration-556d557.md). @@ -132,7 +132,7 @@ For more information on role collections, see [Roles and Role Collections](https - Complete the onboarding process - Access the *API Settings* page. See [Setting Up API Management Capability](50-Development/setting-up-api-management-capability-f34e86c.md) - For more information on relevant roles, see [User Roles in API Management \(New\)](user-roles-in-api-management-new-911ca5a.md). + For more information on relevant roles, see [Tasks and Corresponding Role Collections](tasks-and-corresponding-role-collections-911ca5a.md). For end-to end instructions on how to set up and configure API Management, refer the tutorial [Set Up API Management from Integration Suite | Tutorials for SAP Developers](https://developers.sap.com/tutorials/api-mgmt-isuite-initial-setup.html). diff --git a/docs/ISuite/connectivity-options-93d82e8.md b/docs/ISuite/connectivity-options-93d82e8.md index d961f907..f4b35fff 100644 --- a/docs/ISuite/connectivity-options-93d82e8.md +++ b/docs/ISuite/connectivity-options-93d82e8.md @@ -218,6 +218,46 @@ See: [AMQP Receiver for SAP Event Mesh](50-Development/amqp-receiver-for-sap-eve +*AMQP for SAP Integration Suite, advanced event mesh* + +Sender adapter + + + + +Enables SAP Integration Suite to consume messages from SAP Integration Suite, advanced event mesh. + +Supported message protocol: AMQP \(Advanced Message Queuing Protocol\) 1.0 + +Supported transport protocol: TCP + +See: [AMQ Sender for SAP Integration Suite, advanced event mesh](50-Development/amq-sender-for-sap-integration-suite-advanced-event-mesh-be1e496.md) + + + + + + +*AMQP for SAP Integration Suite, advanced event mesh* + +Receiver adapter + + + + +Enables SAP Integration Suite to send messages to SAP Integration Suite, advanced event mesh. + +Supported message protocol: AMQP \(Advanced Message Queuing Protocol\) 1.0 + +Supported transport protocol: TCP + +See: [AMQP Receiver for SAP Integration Suite, advanced event mesh](50-Development/amqp-receiver-for-sap-integration-suite-advanced-event-mesh-5f229c0.md) + + + + + + *AMQP for Microsoft Azure Service Bus* Sender adapter @@ -231,7 +271,7 @@ Supported message protocol: AMQP \(Advanced Message Queuing Protocol\) 1.0 Supported transport protocol: TCP -See: [AMQP Sender for Microsoft Azure Service Bus](50-Development/amqp-sender-for-microsoft-azure-service-bus-7384ac3.md) +See: [Configure the AMQP Sender Adapter](50-Development/configure-the-amqp-sender-adapter-99ce674.md) @@ -251,7 +291,7 @@ Supported message protocol: AMQP \(Advanced Message Queuing Protocol\) 1.0 Supported transport protocol: TCP -See: [AMQP Receiver for Microsoft Azure Service Bus](50-Development/amqp-receiver-for-microsoft-azure-service-bus-9c64d80.md) +See: [Configure the AMQP Receiver Adapter](50-Development/configure-the-amqp-receiver-adapter-d5660c1.md) @@ -271,7 +311,7 @@ Supported message protocol: AMQP \(Advanced Message Queuing Protocol\) 1.0 Supported transport protocol: TCP -See: [AMQP Sender for Solace PubSub+](50-Development/amqp-sender-for-solace-pubsub-c9ab47d.md) +See: [Configure the AMQP Sender Adapter](50-Development/configure-the-amqp-sender-adapter-99ce674.md) @@ -291,7 +331,7 @@ Supported message protocol: AMQP \(Advanced Message Queuing Protocol\) 1.0 Supported transport protocol: TCP -See: [AMQP Receiver for Solace PubSub+](50-Development/amqp-receiver-for-solace-pubsub-19f18d8.md) +See: [Configure the AMQP Receiver Adapter](50-Development/configure-the-amqp-receiver-adapter-d5660c1.md) @@ -311,7 +351,7 @@ Supported message protocol: AMQP \(Advanced Message Queuing Protocol\) 1.0 Supported transport protocol: TCP, WebSocket -See: [AMQP Sender for Apache Qpid Broker-J](50-Development/amqp-sender-for-apache-qpid-broker-j-b4983f7.md) +See: [Configure the AMQP Sender Adapter](50-Development/configure-the-amqp-sender-adapter-99ce674.md) @@ -331,7 +371,7 @@ Supported message protocol: AMQP \(Advanced Message Queuing Protocol\) 1.0 Supported transport protocol: TCP, WebSocket -See: [AMQP Receiver for Apache Qpid Broker-J](50-Development/amqp-receiver-for-apache-qpid-broker-j-622aa1d.md) +See: [Configure the AMQP Receiver Adapter](50-Development/configure-the-amqp-receiver-adapter-d5660c1.md) @@ -351,7 +391,7 @@ Supported message protocol: AMQP \(Advanced Message Queuing Protocol\) 1.0 Supported transport protocol: TCP -See: [AMQP Sender for Apache ActiveMQ 5 and Apache ActiveMQ Artemis](50-Development/amqp-sender-for-apache-activemq-5-and-apache-activemq-artemis-dc4c564.md) +See: [Configure the AMQP Sender Adapter](50-Development/configure-the-amqp-sender-adapter-99ce674.md) @@ -371,7 +411,7 @@ Supported message protocol: AMQP \(Advanced Message Queuing Protocol\) 1.0 Supported transport protocol: TCP -See: [AMQP Receiver for Apache ActiveMQ 5 and Apache ActiveMQ Artemis](50-Development/amqp-receiver-for-apache-activemq-5-and-apache-activemq-artemis-76c4dd3.md) +See: [Configure the AMQP Receiver Adapter](50-Development/configure-the-amqp-receiver-adapter-d5660c1.md) @@ -391,7 +431,7 @@ Supported message protocol: AMQP \(Advanced Message Queuing Protocol\) 1.0 Supported transport protocol: TCP -See: [AMQP Sender for IBM MQ](50-Development/amqp-sender-for-ibm-mq-f6cc0e4.md) +See: [Configure the AMQP Sender Adapter](50-Development/configure-the-amqp-sender-adapter-99ce674.md) @@ -411,7 +451,7 @@ Supported message protocol: AMQP \(Advanced Message Queuing Protocol\) 1.0 Supported transport protocol: TCP -See: [AMQP Receiver for IBM MQ](50-Development/amqp-receiver-for-ibm-mq-990fa99.md) +See: [Configure the AMQP Receiver Adapter](50-Development/configure-the-amqp-receiver-adapter-d5660c1.md) diff --git a/docs/ISuite/creating-a-custom-role-9d827cd.md b/docs/ISuite/creating-a-custom-role-9d827cd.md index d29b1459..eef7e9db 100644 --- a/docs/ISuite/creating-a-custom-role-9d827cd.md +++ b/docs/ISuite/creating-a-custom-role-9d827cd.md @@ -91,5 +91,5 @@ You can restrict access to an API product in API Management using a custom role. [Create a Product](50-Development/create-a-product-d769622.md "Explains how to create products to publish a bundle of API proxies together.") -[User Roles in API Management \(New\)](user-roles-in-api-management-new-911ca5a.md "Similar to other capabilities of the SAP Integration Suite, the API Management capability defines a set of technical roles that grant specific permissions to users. Users can be assigned roles through SAP BTP's role collection concept. While users have the option to create their own role collections, a set of predefined role collections is automatically created when the API Management capability is provisioned.") +[Tasks and Corresponding Role Collections](tasks-and-corresponding-role-collections-911ca5a.md "Similar to other capabilities of the SAP Integration Suite, the API Management capability defines a set of technical roles that grant specific permissions to users. Users can be assigned roles through SAP BTP's role collection concept. While users have the option to create their own role collections, a set of predefined role collections is automatically created when the API Management capability is provisioned.") diff --git a/docs/ISuite/edge-integration-cell-runtime-scope-144c64a.md b/docs/ISuite/edge-integration-cell-runtime-scope-144c64a.md index 960e8b93..43ecd575 100644 --- a/docs/ISuite/edge-integration-cell-runtime-scope-144c64a.md +++ b/docs/ISuite/edge-integration-cell-runtime-scope-144c64a.md @@ -57,6 +57,8 @@ Reusable artifacts - Function Libraries +- Imported Archives + diff --git a/docs/ISuite/enable-api-management-capability-f6eb433.md b/docs/ISuite/enable-api-management-capability-f6eb433.md deleted file mode 100644 index 98f9681d..00000000 --- a/docs/ISuite/enable-api-management-capability-f6eb433.md +++ /dev/null @@ -1,166 +0,0 @@ - - -# Enable API Management Capability - -You can provision the API Management capability from the **Integration Suite** launchpad. - - - - - -## Prerequisites - -- You already have a subaccount and have enable the Cloud Foundry environment in this subaccount. For more information, see [Create a Subaccount](https://help.sap.com/docs/BTP/65de2977205c403bbc107264b8eccf4b/05280a123d3044ae97457a25b3013918.html?q=entitlements). - -- An *Integration Suite* entitlement has been created for your subaccount. For more information, see [Configure Entitlements and Quotas for Subaccounts](https://help.sap.com/docs/BTP/65de2977205c403bbc107264b8eccf4b/5ba357b4fa1e4de4b9fcc4ae771609da.html?q=entitlements). - - - - - - -## Context - -To set up the API Management capability from Integration Suite, you should first have an Integration Suite subscription. - -> ### Note: -> Ensure that you don’t have an instance of a starter plan created in the same subaccount where you plan to create an Integration Suite subscription. Also, note that API Management capabilities from Integration Suite and API Management subscriptions using the stand-alone tile can’t coexist in the same subaccount. - -> ### Note: -> For visual intructions on how to set up and configure API Management capability from Integration Suite, refer the tutorial [Set Up API Management from Integration Suite | Tutorials for SAP Developers](https://developers.sap.com/tutorials/api-mgmt-isuite-initial-setup.html). - - - - - -## Procedure - -1. Log on to SAP BTP Cockpit and navigate to your subaccount. - -2. In the navigation area of the subaccount, choose *Services* \> *Service Marketplace* and search for *Integration Suite* and choose *Create*. - -3. On the *New Instances and Subscriptions* dialog, choose Integration Suite as the *Service*, select the *Plan*, and choose *Create*. - - Wait for the subscription to complete successfully. - -4. Choose *View Subscription* on the *Creation in Progress* dialog. - - Check the status of the submission in the *Subscriptions* section on the *Instances and Subscriptions* page. If the subscription is successful, you’ll notice the status of the *Integration Suite* is shown as *Subscribed*. - -5. To access the Integration Suite, assign the *Integration\_Provisioner* role to yourself. - - > ### Note: - > If you choose *Go to Application* without assigning the *Integration\_Provisioner* role, an application authentication error appears. If the error persists after assigning the role, clear your web browser cache, and log out of the application and log on again. - - To assign the role: - - 1. On the navigation pane, under *Security*, choose *Users*. - - 2. Select your Username and under *Role Collections* section, choose *Assign Role Collection*. - - 3. In the resulting dialog box, select the *Integration\_Provisioner* role and choose *Assign Role Collection*. - - - For detailed instructions, see [Working with Role Collections](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/393ea0b222754311884123ce564779bd.html?q=SAP%20ID%20Service). - -6. Once the role is assigned, choose *Instances and Subscriptions* on the left navigation pane and under *Subscriptions* look for ***Integration Suite***, and choose **Go To Application**. - - You’re navigated to the *Integration Suite* home page. - -7. On the Integration Suite home page, under *Capabilities*, choose *Add Capabilities*. - -8. To design, develop, publish, and oversee APIs in a secure and scalable environment, select *Manage APIs* on the *Activate Capabilities* dialog, and choose *Next*. - -9. To discover, consume and monitor APIs from a centralized API catalogue, choose *Enable API Business Hub Enterprise*. - - Once you enable API business hub enterprise, you will get an option to enable *Graph*. - -10. If you want to expose all your business data in the form of a single semantically connected data graph, select the checkbox for *Graph*, and choose **Next**. - -11. Choose *Activate* on the *Activate Capabilities* dialog. - - > ### Note: - > If you face any issues during activation or the activation fails, then refer SAP Note [2904202](https://me.sap.com/notes/2904202) and proceed accordingly. - -12. On the resulting screen, choose *OK* once the status changes from *In Progress* to *Active*. - -13. Log out of *Integration Suite*. - -14. At this point, navigate back to the SAP BTP Cockpit and assign the following roles: - - - *APIManagement.Selfservice.Administrator*: This role is required for the onboarding of API Portal and to get access to its Settings page. - - - *AuthGroup.SelfService.Admin*: You'll need this role during the onboarding of API business hub enterprise and to get access to it. - - - To assign these roles: - - 1. Choose *Security* \> *Users* from the left navigation pane. - - 2. Select your username and under *Role Collections* section, choose *Assign Role Collection*. - - 3. In the resulting dialog box, select the *APIManagement.Selfservice.Administrator* and *AuthGroup.SelfService.Admin* roles and choose *Assign Role Collection*. - - -15. Once the roles are assigned, log on to the *Integration Suite*. - - > ### Note: - > If you are using a trial account, the account will be provisioned automatically. As a result, the option to access *APIs* will not appear under *Settings* in the side-navigation menu once the account is onboarded. During the provisioning process, the system will select the default virtual host for you. You will receive a notification indicating that the account is being provisioned. Once the process is complete, you will be automatically logged out of the Integration Suite. To continue, simply log in again. At this point, you will be able to create APIs, build API proxies as a service provider, and utilize other convenient services provided by the platform. - > - > Steps 16 and 17 are not applicable for the trial users. - -16. On the *Integration Suite* home page, choose *Settings* \> *APIs* from the left navigation pane. - -17. On the *Configure the API Management Service* screen, configure the following and choose *Set Up*: - - - Select the *Account type*: - - - Select the *Non Production* account type for non-business critical activities, such as integrating test systems, testing new scenarios, performance testing, and sandbox activities. - - Select the *Production* account type for business critical usages, such as integrating production systems, and productive APIs. - - - In the *Virtual Host* section, enter the *Host Alias*. - - - Provide an email ID in the *Notification Contact* field to receive updates. - - - In the *Set-up Confirmation* window, review the provided details and choose *Confirm* to start the onboarding process. - - You’re redirected to a progress window, which states *API Management Service Setup In Progress*. - - The *Configuration* process is triggered, where the necessary resources are provisioned for you. It’s followed by *Testing the Setup* process, where a simple API Proxy is deployed and invoked to check that everything is set up properly. - - When the processes complete, the indicators turn green to indicate that the processes are successful. A *Release Notification* mail is sent out to the email IDs provided in the *Configure the API Management Service* screen. This email contains details of the newly set up API Management service on your account. - - > ### Note: - > If the API Management Service Setup encounters an error or fails, the onboarding process will automatically retry the setup up to five times. If the same error or failure continues to occur, please report the issue by creating an incident in the [SAP Support Portal](https://support.sap.com/en/index.html). Please use the component OPU-API-OD-OPS for reporting. - - The API Management capability is now configured. - -18. You must log out of *Integration Suite* and log in again. - - You can now create APIs, build API proxies as a service provider, or use APIs and other convenient services. - - - - - - -## Next Steps - -After enabling the API Management capability, you need to first set up the service. For more information, see [Setting Up API Management Capability](50-Development/setting-up-api-management-capability-f34e86c.md). - -**Related Information** - - -[User Roles in API Management \(New\)](user-roles-in-api-management-new-911ca5a.md "Similar to other capabilities of the SAP Integration Suite, the API Management capability defines a set of technical roles that grant specific permissions to users. Users can be assigned roles through SAP BTP's role collection concept. While users have the option to create their own role collections, a set of predefined role collections is automatically created when the API Management capability is provisioned.") - -[Create an API Provider](50-Development/create-an-api-provider-6b263e2.md "Define the details of the host you want an application to reach by creating an API provider.") - -[Different Methods of Creating an API Proxy](50-Development/different-methods-of-creating-an-api-proxy-4ac0431.md "An API proxy is the data object that contains all the functionality to be executed when an external user wants to access the backend service.") - -[Configuring a Custom Domain for a Virtual Host](configuring-a-custom-domain-for-a-virtual-host-6b9e5a3.md "The API Management capability enables you to personalize the virtual host URL by configuring a custom domain of your choice. This means that you can have all your APIs displayed as "https://api.bestrun.com/..." if desired. Additionally, you have the option to set up multiple virtual hosts using the same custom domain, such as "https://api1.bestrun.com," "https://api2.bestrun.com," and so on.") - -[Configuring Mutual TLs for Virtual Host](configuring-mutual-tls-for-virtual-host-9faf7ce.md "You can configure mutual TLs for a virtual host, which validates the identities of both the web server and the web client.") - -[Cancel API Management Service Subscription](cancel-api-management-service-subscription-df6df2b.md "You can deactivate your API Management capability from Integration Suite to disable your account from the API Management service.") - diff --git a/docs/ISuite/establishing-trust-between-sap-cloud-identity-account-and-btp-offerings-7208200.md b/docs/ISuite/establishing-trust-between-sap-cloud-identity-account-and-btp-offerings-7208200.md new file mode 100644 index 00000000..a2de6022 --- /dev/null +++ b/docs/ISuite/establishing-trust-between-sap-cloud-identity-account-and-btp-offerings-7208200.md @@ -0,0 +1,113 @@ + + +# Establishing Trust between SAP Cloud Identity Account and BTP Offerings + +Connect SAP Cloud Identity services with the BTP offerings. + + + +## Context + +To configure and establish trust between SAP Cloud Identity and BTP offerings, follow the steps below: + + + +## Procedure + +1. Log on to the SAP BTP Cockpit. + +2. Navigate to *Trust*. In the *Local Service Provider* tab: + + 1. Select *Custom* in the *Configuration Type* field. + + 2. Click *Generate Key Pair*. + + 3. Click *Save*. + + 4. Click *Get Metadata* to generate the metadata. This metadata will need to be imported into SAP Cloud Identity. + + +3. Log on to the SAP Cloud Identity Admin Cockpit \(`https://.ondemand.com/admin/`\). + +4. From the left navigation pane, choose *Applications*, scroll down to the bottom of the page and choose *Add*. + +5. On the *Add Application* dialog, provide an application name, \(for example: SAP APIM\), and then choose *Save*. + +6. In the newly created application, under the *Trust* tab, choose the *SAML 2.0 Configuration* option. + +7. In the *Define from Metadata* tab, click *Browse* and upload the SAML metadata downloaded from Step 2, and then choose *Save*. + +8. Navigate to *Assertion Attributes* of the SAML 2.0 configurations, and then provide the mapping between the SAML Assertion values. The developer needs these configurations for onboarding on the API business hub enterprise. + + The following table contains the mapping between the user attribute and the assertion attribute fields: + + + + + + + + + + + + + + + + + + + + + + + +
+ + User Attribute + + + + Assertion Attribute + +
+ + Last Name + + + + last\_name + +
+ + Display Name + + + + display\_name + +
+ + E-Mail + + + + mail + +
+ + First Name + + + + first\_name + +
+ + +**Related Information** + + +[Establishing Trust between SAP HANA Cloud Platform Account and SAP Cloud Identity](establishing-trust-between-sap-hana-cloud-platform-account-and-sap-cloud-identity-c597708.md "Connect SAP HANA Cloud Platform account with the SAP Cloud Identity services.") + diff --git a/docs/ISuite/establishing-trust-between-sap-hana-cloud-platform-account-and-sap-cloud-identity-c597708.md b/docs/ISuite/establishing-trust-between-sap-hana-cloud-platform-account-and-sap-cloud-identity-c597708.md new file mode 100644 index 00000000..7019095e --- /dev/null +++ b/docs/ISuite/establishing-trust-between-sap-hana-cloud-platform-account-and-sap-cloud-identity-c597708.md @@ -0,0 +1,90 @@ + + +# Establishing Trust between SAP HANA Cloud Platform Account and SAP Cloud Identity + +Connect SAP HANA Cloud Platform account with the SAP Cloud Identity services. + + + +## Context + +To configure and establish trust between SAP HANA Cloud Platform and SAP Cloud Identity, follow the steps below: + + + +## Procedure + +1. Download the SAML metadata from the *SAP Cloud Identity* by navigating to *Tenant Settings* \> *SAML 2.0 Configurations*. + +2. In the *SAML 2.0 Configurations* window, scroll down to the bottom of the page and choose *Download Metadata File*. + +3. Log on to the SAP HANA Cloud Platform Cockpit. + +4. Navigate to *Trust* \> *Trusted Identity Provider*, and choose *Add Trusted Identity Provider*. + +5. In the *Trusted Identity Provider* window, for the *Metadata File* field, click *Browse* and upload the SAML metadata that was downloaded from Steps 1 and 2. + +6. In the *Trusted Identity Provider* window, navigate to the *Attributes* tab, and then add the attributes value. + + The following table contains the maping between the assertion attribute and the principal attribute: + + + + + + + + + + + + + + + + + + + +
+ + Assertion Attribute + + + + Principal Attribute + +
+ + first\_name + + + + firstname + +
+ + last\_name + + + + lastname + +
+ + mail + + + + email + +
+ +7. Now, you can navigate to the API Portal or API business hub enterprise, and login using your SAP Cloud IDP users. + + +**Related Information** + + +[Establishing Trust between SAP Cloud Identity Account and BTP Offerings](establishing-trust-between-sap-cloud-identity-account-and-btp-offerings-7208200.md "Connect SAP Cloud Identity services with the BTP offerings.") + diff --git a/docs/ISuite/fix-connectivity-issues-59e80e4.md b/docs/ISuite/fix-connectivity-issues-59e80e4.md index 76be4d4f..77311971 100644 --- a/docs/ISuite/fix-connectivity-issues-59e80e4.md +++ b/docs/ISuite/fix-connectivity-issues-59e80e4.md @@ -37,10 +37,12 @@ If the Edge Integration Cell solution deployment finished successfully, but the In addition, verify the existence of the Ingress Gateway , using the following command : `kubectl get gateway -n edge-icell -o yaml`. The response is `default-gateway`, listed under hosts, and port 443. - - Next, enter the command `kubectl rollout restart deployment edc -n edge-icell`, to restart Policy Engine. + 1. Enter the command `kubectl rollout restart deployment/edc -n edge-icell`, to restart Edge Deployment Controller. - - Then recheck the existence of the gateway as described in step 3. - - If the gateway `default-gateway` still doesn't exist, open a ticket on component BC-CP-IS-EDG-DPL, and attach the diagnostics file or the Edge Deploy Controller log. You can create the diagnostics file via Edge LM UI. - - To get the Edge Deploy Controller log, first identify the Edge Deploy Controller pod by entering `kubectl get pod -n edge-icell` in the kubectl tool. Then get the Edge Deploy Controller log by entering `kubectl logs -n edge-icell` in the kubectl tool. + 2. Enter the command `kubectl rollout restart deployment/policyengine -n edge-icell`, to restart Policy Engine. + + 3. Then recheck the existence of the gateway as described in step 3. + 4. If the gateway `default-gateway` still doesn't exist, open a ticket on component BC-CP-IS-EDG-DPL, and attach the diagnostics file or the Edge Deploy Controller log. You can create the diagnostics file via Edge LM UI. + 5. To get the Edge Deploy Controller log, first identify the Edge Deploy Controller pod by entering `kubectl get pod -n edge-icell` in the kubectl tool. Then get the Edge Deploy Controller log by entering `kubectl logs -n edge-icell` in the kubectl tool. diff --git a/docs/ISuite/fix-integration-flow-deployment-issues-d2d5586.md b/docs/ISuite/fix-integration-flow-deployment-issues-d2d5586.md index d2c6dcc3..c8b0b3c8 100644 --- a/docs/ISuite/fix-integration-flow-deployment-issues-d2d5586.md +++ b/docs/ISuite/fix-integration-flow-deployment-issues-d2d5586.md @@ -28,7 +28,7 @@ Integration flow deployment/ undeployment failed with error code 403 \(forbidden -If an upgrade has been skipped by SAP or delayed by you, you must at least modify the Edge Integration Cell deployment solution properties to allow key rotation and continue using the object stores, and deployed content. See: [Modify Edge Integration Cell Solution Deployment Properties](modify-edge-integration-cell-solution-deployment-properties-6a060ff.md). +Modify the Edge Integration Cell deployment solution properties to allow key rotation and continue using the object stores and deployed content. See: [Modify Edge Integration Cell Solution Deployment Properties](modify-edge-integration-cell-solution-deployment-properties-6a060ff.md). diff --git a/docs/ISuite/glossary-for-sap-integration-advisor-9c221b4.md b/docs/ISuite/glossary-for-sap-integration-advisor-9c221b4.md new file mode 100644 index 00000000..f8ec9519 --- /dev/null +++ b/docs/ISuite/glossary-for-sap-integration-advisor-9c221b4.md @@ -0,0 +1,183 @@ + + +# Glossary for SAP Integration Advisor + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +Term + + + +Definition + +
+ +Type System + + + +A "Type System" is an independent system of data description format of reusable message and data types, which is based on a combination of: + +- Responsible agency +- Syntax rules for syntax representation +- Schema notation and definition +- Methodology for modeling, naming, and structuring of complete messages +- Template library + +Only a single agency \(organization ANSI ASC X12 for the Type System ASC X12 or organization SAP SE for the Type System SAP IDoc\) is responsible for the development and maintenance of the syntax, concept \(methodology\) and library. + +
+ +Message Implementation Guideline \(MIG\) + + + +A Message Implementation Guideline \(also called as Message Guideline or MIG\) is a detailed documentation of a A2A/B2B message type considering just these aspects and constraints for fulfilling the needs of the user's business purpose in a given business context. + +
+ +Mapping Guideline \(MAG\) + + + +A Mapping Guideline \(also called as a MAG\) is an artifact that you can directly use in the mapping step of an integration application. + +A Mapping Guideline \(MAG\) is based on a source and a target message implementation guideline. It demonstrates how the defined nodes at each side are mapped, describing all mapping elements in detail with definitions or notes and providing further instructions for the transformation, such as functions or code value mappings. + +
+ +Business Context + + + +The formal description of a specific business circumstance as identified by the values of a set of context categories, allowing different business circumstances to be uniquely distinguished. + +The business context is a very important part of the MIG. It labels the MIG so that the system can give you an appropriate proposal based on the defined business context and will be used for statistical information, which will be provided in future releases of IA. Therefore, at least one business context value must be set. IA provides for setting the own business context and the business partner's business context five different business context categories with a list of business context values. These business context categories are: + +- *Business Process* - In describing a business situation, generally the most important aspect of that situation is the business activity being conducted. Business process context provides a way to unambiguously identify the business activity. + +- *Product Classification* - It describes those aspects of a business situation related to the goods or services being exchanged by, or otherwise manipulated, or concerned, in the business process. +- *Industry Classification* - It provides a description of the industry or sub-industry in which the business process takes place. +- *Geo Political*- Allows the description of those aspects of the business context that are related to region, nationality, or geographically based cultural factors. The starting point of the geo political context category is country. +- *Business Process Role* - It describes those aspects of a business situation that are specific to an actor or actors within the business process. + +The accuracy of the proposal depends on the selected number of business context categories and business context values. As more business context categories and values you selected as tighter will be the proposal. + +
+ +Message + + + +A message is used to describe business document transactions between two business partners in electronic manner. + +
+ +Complex Types + + + +Reusable complex structures that are used for assembling a message. Each complex type has a complex structure of child elements for expressing the properties of a complex object such as *Partner*, *Location* or *Address*. + +
+ +Simple Types + + + +Reusable simple types are defining the characteristics and properties of leaf elements that are used for carrying data in an instance + +
+ +Codelists + + + +A codelist is a stable collection of code values that’s maintained by a responsible agency. Codelists can be used in several ways: + +1. A fixed list of commonly used acronyms and abbreviations that provides a common understanding of the names, meanings, or objects that are represented by code values; for example, the country codelist. + +2. Shorter representation and controlled list of methods, conditions, or rules, that provides the system further instruction for processing or validating data; for example, the status list, which tells if something is new or in progress. +3. List of qualifying values that provide a more precise meaning to semantically generic elements in an interface; for example, the qualifiers for the generic group *Party* might be *seller* or *buyer*. + +Codelists require consideration when you use them in MIGs, for the following reasons: + +- Code values must be mapped from the source side to the target side in a mapping guideline \(MAG\). + +- Code values are used as qualifiers that make MIG semantics more precise. +- Code values are used when generating, processing, or validating payloads. + + + +
+ +Qualifiers + + + +The qualifier reference approach in IA supports the semantic qualification in a very efficient manner. The qualifier references bring both, the semantically generic elements and the leaf elements who provide the additional meaning by code values together. This new approach is very powerful, because it increases the understanding of customized interfaces in MIGs on business meaning level and furthermore, it significantly reduces the efforts in mappings. + +
+ +Notes + + + +Notes gives further details to the definition and meaning of a node. These details can be categorized by different kinds of notes, which describe usage scenarios, further constraints, a comment or a usage example. + +The *Usage* category is used for specification of possible usages of a node. + +The *Constraint* category is used to provide information about the qualifiers. + +The *Example* category is used to provide example data. + +The *Comment* category is used to provide addition information. + +
+ diff --git a/docs/ISuite/images/Circuit_Breaker_OPproxy_68cc29e.png b/docs/ISuite/images/Circuit_Breaker_OPproxy_68cc29e.png new file mode 100644 index 00000000..cef7695f Binary files /dev/null and b/docs/ISuite/images/Circuit_Breaker_OPproxy_68cc29e.png differ diff --git a/docs/ISuite/images/SCI_Block_Diagram_3053fc5.png b/docs/ISuite/images/SCI_Block_Diagram_3053fc5.png new file mode 100644 index 00000000..9cfb3164 Binary files /dev/null and b/docs/ISuite/images/SCI_Block_Diagram_3053fc5.png differ diff --git a/docs/ISuite/index.md b/docs/ISuite/index.md index 8e6fd740..f01a7d5c 100644 --- a/docs/ISuite/index.md +++ b/docs/ISuite/index.md @@ -10,7 +10,8 @@ - [What's New for Integration Suite General Features](what-s-new-for-integration-suite-general-features-2ad1b96.md) - [Patch Release Notes for SAP Integration Suite](patch-release-notes-for-sap-integration-suite-58595b5.md) - [Patch Releases for Cloud Integration and Related Components](patch-releases-for-cloud-integration-and-related-components-023a472.md) -- [Initial Setup](10-InitialSetup/initial-setup-3dcf507.md) + - [Patch Releases for API Management](patch-releases-for-api-management-6ddd927.md) +- [Initial Setup of SAP Integration Suite](10-InitialSetup/initial-setup-of-sap-integration-suite-3dcf507.md) - [Get an SAP Business Technology Platform Account](10-InitialSetup/get-an-sap-business-technology-platform-account-1eda403.md) - [Production Account](10-InitialSetup/production-account-24ef511.md) - [Setting Up Your Account](10-InitialSetup/setting-up-your-account-079c68f.md) @@ -19,12 +20,12 @@ - [Subscribing to Free Tier](10-InitialSetup/subscribing-to-free-tier-cf0cc4c.md) - [Unsubscribing from Integration Suite](10-InitialSetup/unsubscribing-from-integration-suite-74947c8.md) - [Working with Integration Suite Home](20-Working_with_SAP_Integration_Suite_Home/working-with-integration-suite-home-a53dce3.md) -- [Capabilities](capabilities-e1c5b90.md) +- [Capabilities of SAP Integration Suite](capabilities-of-sap-integration-suite-e1c5b90.md) - [Activating and Managing Capabilities](activating-and-managing-capabilities-2ffb343.md) - - [Configuring User Access](configuring-user-access-2c6214a.md) + - [Configuring User Access to SAP Integration Suite](configuring-user-access-to-sap-integration-suite-2c6214a.md) - [API Management](api-management-1b17d18.md) - [API Lifecycle](api-lifecycle-5e8ea7d.md) - - [Enable API Management Capability](enable-api-management-capability-f6eb433.md) + - [Activate and Configure API Management Capability](activate-and-configure-api-management-capability-f6eb433.md) - [Components of API Management](components-of-api-management-e02ae53.md) - [Important Concepts of API Management](important-concepts-of-api-management-414808b.md) - [Managing API Endpoints](managing-api-endpoints-ac794e4.md) @@ -37,20 +38,21 @@ - [Managing Cloud Foundry Microservices through API Management](managing-cloud-foundry-microservices-through-api-management-e609a3e.md) - [Unbinding a Cloud Foundry Application from an API Management, API portal Service Instance](unbinding-a-cloud-foundry-application-from-an-api-management-api-portal-service-instance-09fd33a.md) - [Accessing On-Premise Systems through API Management](accessing-on-premise-systems-through-api-management-2fc7a5b.md) + - [Circuit Breaker](circuit-breaker-bd3c2d5.md) - [Additional Configurations for API Management](additional-configurations-for-api-management-5ac63ab.md) - [Configuring Additional Virtual Host in Cloud Foundry Environment](configuring-additional-virtual-host-in-cloud-foundry-environment-a7b91e5.md) - [Configuring a Custom Domain for a Virtual Host](configuring-a-custom-domain-for-a-virtual-host-6b9e5a3.md) - [Configuring a Default Domain for a Virtual Host](configuring-a-default-domain-for-a-virtual-host-1085228.md) - [Configuring Mutual TLs for Virtual Host](configuring-mutual-tls-for-virtual-host-9faf7ce.md) - [Region-Specific IP Addresses Available for API Management Cloud Foundry Environment](region-specific-ip-addresses-available-for-api-management-cloud-foundry-environment-585d639.md) - - [User Roles in API Management \(New\)](user-roles-in-api-management-new-911ca5a.md) + - [Tasks and Corresponding Role Collections](tasks-and-corresponding-role-collections-911ca5a.md) - [Assigning Role Collections to Users](assigning-role-collections-to-users-80bb02e.md) - [Creating a Custom Role](creating-a-custom-role-9d827cd.md) - [User Roles in API Management](user-roles-in-api-management-7010b58.md) - [Cancel API Management Service Subscription](cancel-api-management-service-subscription-df6df2b.md) - - [1e88d9cb4e90466cb0ab2c53e33b2e1c.xml](1e88d9cb4e90466cb0ab2c53e33b2e1c.md) - - [72082006fdbd440faa915cde7e1eb53d.xml](72082006fdbd440faa915cde7e1eb53d.md) - - [c5977080232f44a2b3dc6c88eb2f8c85.xml](c5977080232f44a2b3dc6c88eb2f8c85.md) + - [Setting Up API Management with SAP Cloud Identity Services](setting-up-api-management-with-sap-cloud-identity-services-1e88d9c.md) + - [Establishing Trust between SAP Cloud Identity Account and BTP Offerings](establishing-trust-between-sap-cloud-identity-account-and-btp-offerings-7208200.md) + - [Establishing Trust between SAP HANA Cloud Platform Account and SAP Cloud Identity](establishing-trust-between-sap-hana-cloud-platform-account-and-sap-cloud-identity-c597708.md) - [API Documentation](api-documentation-e26b332.md) - [Limits in API Management](limits-in-api-management-f70f425.md) - [Migration of API Management Content](APIM-Migration/migration-of-api-management-content-d66b3e5.md) @@ -66,7 +68,7 @@ - [Migrating API Management Subscription Created Using the Starter Plan Service Instance to Different Subaccounts](APIM-Migration/migrating-api-management-subscription-created-using-the-starter-plan-service-instance-to-1f4ed86.md) - [Migration of API Management Content between Cloud Foundry Environments](APIM-Migration/migration-of-api-management-content-between-cloud-foundry-environments-17f09f3.md) - [Prerequisites for the Source and the Target System](APIM-Migration/prerequisites-for-the-source-and-the-target-system-1b181dd.md) - - [Clone API Management Content for Cloud Foundry to Cloud Foundry Migration](APIM-Migration/clone-api-management-content-for-cloud-foundry-to-cloud-foundry-migration-2e5d127.md) + - [Clone API Management Content between Cloud Foundry Environments](APIM-Migration/clone-api-management-content-between-cloud-foundry-environments-2e5d127.md) - [Cloned and Uncloned Entities](APIM-Migration/cloned-and-uncloned-entities-b2b393d.md) - [Tenant Cloning Tool Behavior](APIM-Migration/tenant-cloning-tool-behavior-b23c603.md) - [Post Cloning Tasks](APIM-Migration/post-cloning-tasks-49e9716.md) @@ -94,6 +96,7 @@ - [Upgrade Edge Integration Cell](upgrade-edge-integration-cell-27c3926.md) - [Learn About Upgrading the Kubernetes Cluster](learn-about-upgrading-the-kubernetes-cluster-f1a047b.md) - [Upgrade Edge Integration Cell Solution](upgrade-edge-integration-cell-solution-e7b8089.md) + - [Rollback Edge Integration Cell Solution](rollback-edge-integration-cell-solution-9eec21b.md) - [Undeploy Edge Integration Cell from the Kubernetes Cluster](undeploy-edge-integration-cell-from-the-kubernetes-cluster-80ead4a.md) - [Delete the Edge Integration Cell Solution](delete-the-edge-integration-cell-solution-2b771d2.md) - [Remove the Edge Node](remove-the-edge-node-485f6e2.md) @@ -101,7 +104,7 @@ - [Operating Edge Integration Cell](operating-edge-integration-cell-2af17b8.md) - [Operations Cockpit](operations-cockpit-ec0fc95.md) - [Job Management](job-management-4146fa5.md) - - [Component Monitoring](component-monitoring-49f487e.md) + - [Component Monitor](component-monitor-49f487e.md) - [Status Information](status-information-732f300.md) - [Solace Monitor](solace-monitor-26a7894.md) - [Runtime Parameters](runtime-parameters-63c5276.md) @@ -120,6 +123,7 @@ - [Create Heap and Thread Dumps](create-heap-and-thread-dumps-fb10394.md) - [Access the Message Service](access-the-message-service-abbb36a.md) - [Execute Integration Flows with Proxies](execute-integration-flows-with-proxies-e9515b5.md) + - [Operations Cockpit](operations-cockpit-ec0fc95.md) - [Assessing the Integration Strategy](30-Assessing_Integration_Strategy/assessing-the-integration-strategy-35194ec.md) - [Integration Assessment](30-Assessing_Integration_Strategy/integration-assessment-310067e.md) - [What Is Integration Assessment](30-Assessing_Integration_Strategy/what-is-integration-assessment-eeee253.md) @@ -381,7 +385,7 @@ - [Define Settings for the Integration Flow](50-Development/define-settings-for-the-integration-flow-3a6446c.md) - [Specify the Runtime Configuration](50-Development/specify-the-runtime-configuration-0c1c96e.md) - [Define Error Configuration](50-Development/define-error-configuration-77d0041.md) - - [Manage Resources of an Integration Flow](50-Development/manage-resources-of-an-integration-flow-b5968b2.md) + - [Manage Resources](50-Development/manage-resources-b5968b2.md) - [Externalized Parameters View](50-Development/externalized-parameters-view-27a0216.md) - [Problems View](50-Development/problems-view-7614a1f.md) - [Deployment Status View](50-Development/deployment-status-view-40add87.md) @@ -401,18 +405,11 @@ - [AMQP Adapter](50-Development/amqp-adapter-5cc1a71.md) - [Configure the AMQP Sender Adapter](50-Development/configure-the-amqp-sender-adapter-99ce674.md) - [AMQP Sender for SAP Event Mesh](50-Development/amqp-sender-for-sap-event-mesh-7d8a83f.md) - - [AMQP Sender for Microsoft Azure Service Bus](50-Development/amqp-sender-for-microsoft-azure-service-bus-7384ac3.md) - - [AMQP Sender for Solace PubSub+](50-Development/amqp-sender-for-solace-pubsub-c9ab47d.md) - - [AMQP Sender for Apache Qpid Broker-J](50-Development/amqp-sender-for-apache-qpid-broker-j-b4983f7.md) - - [AMQP Sender for Apache ActiveMQ 5 and Apache ActiveMQ Artemis](50-Development/amqp-sender-for-apache-activemq-5-and-apache-activemq-artemis-dc4c564.md) - - [AMQP Sender for IBM MQ](50-Development/amqp-sender-for-ibm-mq-f6cc0e4.md) + - [AMQ Sender for SAP Integration Suite, advanced event mesh](50-Development/amq-sender-for-sap-integration-suite-advanced-event-mesh-be1e496.md) - [Configure the AMQP Receiver Adapter](50-Development/configure-the-amqp-receiver-adapter-d5660c1.md) - [AMQP Receiver for SAP Event Mesh](50-Development/amqp-receiver-for-sap-event-mesh-0b7cc2f.md) - - [AMQP Receiver for Microsoft Azure Service Bus](50-Development/amqp-receiver-for-microsoft-azure-service-bus-9c64d80.md) - - [AMQP Receiver for Solace PubSub+](50-Development/amqp-receiver-for-solace-pubsub-19f18d8.md) - - [AMQP Receiver for Apache Qpid Broker-J](50-Development/amqp-receiver-for-apache-qpid-broker-j-622aa1d.md) - - [AMQP Receiver for Apache ActiveMQ 5 and Apache ActiveMQ Artemis](50-Development/amqp-receiver-for-apache-activemq-5-and-apache-activemq-artemis-76c4dd3.md) - - [AMQP Receiver for IBM MQ](50-Development/amqp-receiver-for-ibm-mq-990fa99.md) + - [AMQP Receiver for SAP Integration Suite, advanced event mesh](50-Development/amqp-receiver-for-sap-integration-suite-advanced-event-mesh-5f229c0.md) + - [Supported Settings for Specific Message Brokers](50-Development/supported-settings-for-specific-message-brokers-059bd96.md) - [Ariba Adapter](50-Development/ariba-adapter-98da76c.md) - [Configure the Ariba Sender Adapter](50-Development/configure-the-ariba-sender-adapter-0629b58.md) - [Configure the Ariba Receiver Adapter](50-Development/configure-the-ariba-receiver-adapter-49dffa3.md) @@ -440,6 +437,7 @@ - [AzureStorage Receiver Adapter for Fileshare Storage](50-Development/azurestorage-receiver-adapter-for-fileshare-storage-1ea5b2b.md) - [AzureStorage Receiver Adapter for Queue Storage](50-Development/azurestorage-receiver-adapter-for-queue-storage-e683a21.md) - [AzureStorage Receiver Adapter for Table Storage](50-Development/azurestorage-receiver-adapter-for-table-storage-ab7c20f.md) + - [Coupa Receiver Adapter](50-Development/coupa-receiver-adapter-648ac01.md) - [Data Store Sender Adapter](50-Development/data-store-sender-adapter-4f5ef3f.md) - [Dropbox Adapter](50-Development/dropbox-adapter-578148d.md) - [Configure the Dropbox Sender Adapter](50-Development/configure-the-dropbox-sender-adapter-de61991.md) @@ -574,6 +572,10 @@ - [Creating a Function Libraries Artifact](50-Development/creating-a-function-libraries-artifact-950b897.md) - [Import Function Library from ES Repository](50-Development/import-function-library-from-es-repository-d6e7585.md) - [Consuming Function Library in Message Mapping](50-Development/consuming-function-library-in-message-mapping-d4dcb4a.md) + - [Working with Imported Archives](50-Development/working-with-imported-archives-e00e81d.md) + - [Creating an Imported Archives Artifact](50-Development/creating-an-imported-archives-artifact-e555caf.md) + - [Reuse Imported Archives Objects from ES Repository](50-Development/reuse-imported-archives-objects-from-es-repository-4196091.md) + - [Consuming Imported Archives](50-Development/consuming-imported-archives-e7562a7.md) - [Developing Script and Script Collection](50-Development/developing-script-and-script-collection-e60f706.md) - [Creating a Script Collection](50-Development/creating-a-script-collection-824bff0.md) - [Creating Scripts in a Script Collection](50-Development/creating-scripts-in-a-script-collection-ed9b52c.md) @@ -894,6 +896,7 @@ - [Variant: Exception Subprocess with End Event](50-Development/variant-exception-subprocess-with-end-event-5f7b1c7.md) - [Variant: Exception Subprocess with Error End Event](50-Development/variant-exception-subprocess-with-error-end-event-c032016.md) - [Variant: Exception Subprocess with Escalation End Event](50-Development/variant-exception-subprocess-with-escalation-end-event-5649cde.md) + - [Handle IDoc Bulk Messages](50-Development/handle-idoc-bulk-messages-e35e389.md) - [Message Monitoring](50-Development/message-monitoring-8398448.md) - [Modify Content](50-Development/modify-content-fc0d3c4.md) - [Guidelines for Modifying Content](50-Development/guidelines-for-modifying-content-6a7c9a1.md) @@ -1065,6 +1068,7 @@ - [Receiver Isn't Idempotent](50-Development/receiver-isn-t-idempotent-5955d3f.md) - [Protocol Contains Unique ID](50-Development/protocol-contains-unique-id-751c2c9.md) - [XI Sender Adapter Handles Duplicates](50-Development/xi-sender-adapter-handles-duplicates-7c9a0fd.md) + - [Reuse Imported Archives Objects from ES Repository](50-Development/reuse-imported-archives-objects-from-es-repository-4196091.md) - [API Development](50-Development/api-development-94957bc.md) - [Add an API Artifact](50-Development/add-an-api-artifact-c2fe62c.md) - [Create an API Artifact Using URL](50-Development/create-an-api-artifact-using-url-914f57e.md) @@ -1099,6 +1103,7 @@ - [AS2 Security Configuration](50-Development/as2-security-configuration-dd0cf80.md) - [Creating a Trading Partner Profile](50-Development/creating-a-trading-partner-profile-542fb11.md) - [Creating an Agreement Template](50-Development/creating-an-agreement-template-9692cb1.md) + - [Archiving Payload Data](50-Development/archiving-payload-data-b927e01.md) - [Migrating an Agreement Template](50-Development/migrating-an-agreement-template-70c469b.md) - [Creating a Trading Partner Agreement](50-Development/creating-a-trading-partner-agreement-9bd43c9.md) - [Understanding Identifiers in Agreement](50-Development/understanding-identifiers-in-agreement-783e935.md) @@ -1169,6 +1174,7 @@ - [Exporting MIG/MAG](50-Development/exporting-mig-mag-c8bba26.md) - [Exporting Documentation](50-Development/exporting-documentation-f7dbd2d.md) - [Exporting Runtime Artifacts](50-Development/exporting-runtime-artifacts-5ab4cfe.md) + - [Creating OAuth Client Credentials for Cloud Foundry Environment](50-Development/creating-oauth-client-credentials-for-cloud-foundry-environment-50b63c6.md) - [Inject Mapping Artifacts to SAP Cloud Integration](50-Development/inject-mapping-artifacts-to-sap-cloud-integration-47ad97e.md) - [Consuming Artifacts in Integration Flows](50-Development/consuming-artifacts-in-integration-flows-a33a6c6.md) - [Test](50-Development/test-69499e8.md) @@ -1253,6 +1259,7 @@ - [Create an API Proxy by Referring to an API Provider System](50-Development/create-an-api-proxy-by-referring-to-an-api-provider-system-84628b9.md) - [Create an API Proxy Based on an Existing API Proxy](50-Development/create-an-api-proxy-based-on-an-existing-api-proxy-54831ca.md) - [Create an API Proxy by Providing a Direct Target Endpoint URL](50-Development/create-an-api-proxy-by-providing-a-direct-target-endpoint-url-d0f5087.md) + - [Creating an API Proxy using SAP Cloud Integration API Provider](50-Development/creating-an-api-proxy-using-sap-cloud-integration-api-provider-aefbd74.md) - [Create an API Proxy Using the API Designer](50-Development/create-an-api-proxy-using-the-api-designer-26e1bbd.md) - [OpenAPI Specification 3.0](50-Development/openapi-specification-3-0-3ce080d.md) - [API Designer](50-Development/api-designer-51f3ca1.md) @@ -1311,7 +1318,6 @@ - [Enable Streaming of Requests and Responses in an API Proxy](50-Development/enable-streaming-of-requests-and-responses-in-an-api-proxy-b43d826.md) - [Enable Dynamic Routing](50-Development/enable-dynamic-routing-49cbe91.md) - [Overriding the Default Update Operation for API Proxy of Type OData](50-Development/overriding-the-default-update-operation-for-api-proxy-of-type-odata-4a12c59.md) - - [Creating an API Proxy using SAP Cloud Integration API Provider](50-Development/creating-an-api-proxy-using-sap-cloud-integration-api-provider-aefbd74.md) - [Custom Attributes](50-Development/custom-attributes-90a5a6d.md) - [Add Custom Attributes to a Product](50-Development/add-custom-attributes-to-a-product-e46a874.md) - [Add Custom Attributes to an Application](50-Development/add-custom-attributes-to-an-application-39c3cbd.md) @@ -1359,7 +1365,7 @@ - [Manage Domain Categories \[New Design\]](50-Development/manage-domain-categories-new-design-bd9691d.md) - [Manage Notifications \[New Design\]](50-Development/manage-notifications-new-design-df32457.md) - [Manage External Content \(New Design\)](50-Development/manage-external-content-new-design-f5bd17d.md) - - [Manage Access](50-Development/manage-access-9df3ece.md) + - [Manage Developer Access](50-Development/manage-developer-access-9df3ece.md) - [Subscribe to a Product \[Classic Design\]](50-Development/subscribe-to-a-product-classic-design-2e586e1.md) - [Subscribe to a Product \[New Design\]](50-Development/subscribe-to-a-product-new-design-486d263.md) - [Create an Application \[Classic Design\]](50-Development/create-an-application-classic-design-7b4e71b.md) @@ -1472,7 +1478,7 @@ - [Key Performance Indicators for Archiving Runs](50-Development/key-performance-indicators-for-archiving-runs-7279d38.md) - [Central Monitoring and Alerting Solutions](50-Development/central-monitoring-and-alerting-solutions-605fc6e.md) - [Monitor APIs](50-Development/monitor-apis-399b6c6.md) - - [Analyze APIs](50-Development/analyze-apis-7712c61.md) + - [Analyze API Proxies](50-Development/analyze-api-proxies-7712c61.md) - [API Analytics](50-Development/api-analytics-6766dc3.md) - [Analytics Dashboard](50-Development/analytics-dashboard-ee416ac.md) - [Working with the Analytics Dashboard](50-Development/working-with-the-analytics-dashboard-e07e815.md) @@ -1482,10 +1488,6 @@ - [Create and Work with Custom Reports](50-Development/create-and-work-with-custom-reports-daf54fd.md) - [Create Custom Dimensions and Measures](50-Development/create-custom-dimensions-and-measures-ba211be.md) - [Request to Modify Threshold Value for Charts](50-Development/request-to-modify-threshold-value-for-charts-b55f89d.md) - - [Anomaly Detection](50-Development/anomaly-detection-7a4fe7d.md) - - [Enabling Anomaly Detection](50-Development/enabling-anomaly-detection-98534a0.md) - - [Enabling APIs for Anomaly Detection](50-Development/enabling-apis-for-anomaly-detection-9e7e5d1.md) - - [1c677b2472f94aa28ea4fc4ecc4e4bef.xml](1c677b2472f94aa28ea4fc4ecc4e4bef.md) - [SAP Analytics Cloud for SAP Integration Suite](50-Development/sap-analytics-cloud-for-sap-integration-suite-fb3648a.md) - [B2B Monitoring](50-Development/b2b-monitoring-9dc75c8.md) - [Monitoring B2B Messages](50-Development/monitoring-b2b-messages-b5e1fc9.md) @@ -1556,18 +1558,18 @@ - [Security Aspects of Data, Data Flow for Cloud Integration](60-Security/security-aspects-of-data-data-flow-for-cloud-integration-7895724.md) - [Identity and Access Management](60-Security/identity-and-access-management-77868c2.md) - [Identity and Access Management for Integration Assessment](60-Security/identity-and-access-management-for-integration-assessment-9a09cdd.md) - - [Personas](60-Security/personas-5df5af1.md) - - [Tasks and Permissions](60-Security/tasks-and-permissions-693e14f.md) + - [Personas for Integration Assessment](60-Security/personas-for-integration-assessment-5df5af1.md) + - [Tasks and Permissions for Integration Assessment](60-Security/tasks-and-permissions-for-integration-assessment-693e14f.md) - [Identity and Access Management for Migration Assessment](60-Security/identity-and-access-management-for-migration-assessment-a2ee575.md) - - [Tasks and Permissions](60-Security/tasks-and-permissions-2714db1.md) + - [Tasks and Permissions for Migration Assessment](60-Security/tasks-and-permissions-for-migration-assessment-2714db1.md) - [Identity and Access Management for API Management](60-Security/identity-and-access-management-for-api-management-016556f.md) - [Identity and Access Management for Cloud Integration](60-Security/identity-and-access-management-for-cloud-integration-f805b22.md) - - [Persona](60-Security/persona-2937e5c.md) - - [Tasks and Permissions](60-Security/tasks-and-permissions-556d557.md) + - [Personas for Cloud Integration](60-Security/personas-for-cloud-integration-2937e5c.md) + - [Tasks and Permissions for Cloud Integration](60-Security/tasks-and-permissions-for-cloud-integration-556d557.md) - [Identity and Access Management for Integration Advisor](60-Security/identity-and-access-management-for-integration-advisor-ed50e64.md) - [Identity and Access Management for Trading Partner Management](60-Security/identity-and-access-management-for-trading-partner-management-5979108.md) - - [Persona](60-Security/persona-d0c9a80.md) - - [Tasks and Permissions](60-Security/tasks-and-permissions-eb14b22.md) + - [Personas for Trading Partner Management](60-Security/personas-for-trading-partner-management-d0c9a80.md) + - [Tasks and Permissions for Trading Partner Management](60-Security/tasks-and-permissions-for-trading-partner-management-eb14b22.md) - [Data Protection and Privacy](60-Security/data-protection-and-privacy-3df9abf.md) - [Data Protection and Privacy for Integration Assessment](60-Security/data-protection-and-privacy-for-integration-assessment-9ef9fbc.md) - [Kinds of Stored Data](60-Security/kinds-of-stored-data-cfb9ffb.md) @@ -1606,4 +1608,5 @@ - [Terminology and Glossary](terminology-and-glossary-fd1491d.md) - [Glossary for Integration Assessment](glossary-for-integration-assessment-5c29e9b.md) - [Glossary for SAP Trading Partner Management](glossary-for-sap-trading-partner-management-81860a4.md) + - [Glossary for SAP Integration Advisor](glossary-for-sap-integration-advisor-9c221b4.md) diff --git a/docs/ISuite/initial-setup-64ac761.md b/docs/ISuite/initial-setup-64ac761.md index 44551f19..8b224f87 100644 --- a/docs/ISuite/initial-setup-64ac761.md +++ b/docs/ISuite/initial-setup-64ac761.md @@ -69,7 +69,7 @@ Integration Developer -- +- - [Troubleshooting for Edge Integration Cell](troubleshooting-for-edge-integration-cell-816d9e4.md) diff --git a/docs/ISuite/job-management-4146fa5.md b/docs/ISuite/job-management-4146fa5.md index a4f64ce7..cd336d32 100644 --- a/docs/ISuite/job-management-4146fa5.md +++ b/docs/ISuite/job-management-4146fa5.md @@ -323,5 +323,5 @@ Choose between: [Operations Cockpit](operations-cockpit-ec0fc95.md "The Operations Cockpit is the central control point for operating edge integration cells and allows the Edge Integration Cell administrator to monitor and adjust system configurations and resources.") -[Component Monitoring](component-monitoring-49f487e.md "Get information on the components.") +[Component Monitor](component-monitor-49f487e.md "Get information on the components.") diff --git a/docs/ISuite/migrate-integrated-configuration-objects-7e7909e.md b/docs/ISuite/migrate-integrated-configuration-objects-7e7909e.md index 583d1b27..a0196568 100644 --- a/docs/ISuite/migrate-integrated-configuration-objects-7e7909e.md +++ b/docs/ISuite/migrate-integrated-configuration-objects-7e7909e.md @@ -65,13 +65,16 @@ Migrate supported integration artifacts from your SAP Process Orchestration syst 2. Select the *Import Method* based on your requirement. - - If the selected integration package doesn't contain any message mapping artifacts, the method is set to *Create*. + - If the selected integration package doesn't contain a relevant message mapping artifact, the method is set to *Create*. - If the selected integration package already contains message mapping artifacts relevant to the one you're trying to import, the method is automatically set to *Reuse*. Based on your requirements, either select an existing message mapping artifact or change the import method to *Create*. The comparison happens based on conditions like name, namespace, and software component version \(SWCV\). + > ### Tip: + > For ease of reusability, in the *Artifact Package* column, select more or all integration packages so that you can check for the availability of the message mapping object across all selected packages. + 9. Choose *Next Step*. diff --git a/docs/ISuite/migration-assessment-5c5e50e.md b/docs/ISuite/migration-assessment-5c5e50e.md index 4a9ae8f6..e658ca96 100644 --- a/docs/ISuite/migration-assessment-5c5e50e.md +++ b/docs/ISuite/migration-assessment-5c5e50e.md @@ -13,5 +13,5 @@ Migration Assessment helps you estimate the technical effort involved in the mig [Concepts](concepts-324507c.md "Get to know the most important concepts used in Migration Assessment.") -[Tasks and Permissions](60-Security/tasks-and-permissions-2714db1.md "Learn about security-related topics like users and authorizations.") +[Tasks and Permissions for Migration Assessment](60-Security/tasks-and-permissions-for-migration-assessment-2714db1.md "Learn about security-related topics like users and authorizations.") diff --git a/docs/ISuite/modify-edge-integration-cell-solution-deployment-properties-6a060ff.md b/docs/ISuite/modify-edge-integration-cell-solution-deployment-properties-6a060ff.md index a8425628..ebc76310 100644 --- a/docs/ISuite/modify-edge-integration-cell-solution-deployment-properties-6a060ff.md +++ b/docs/ISuite/modify-edge-integration-cell-solution-deployment-properties-6a060ff.md @@ -10,9 +10,6 @@ Use Edge Lifecycle Management \(Edge LM\) to modify the solution deployment prop During the upgrade the service keys for connectivity with SAP Integration Suite and BTP services are rotated as needed. For key rotation, the `modify` operation can be used even without changing specific solution properties. -> ### Note: -> You must modify the Edge Integration Cell deployment solution properties \(without changing any parameter\) with every new solution release if an upgrade is skipped by SAP or delayed by you. Else, deployment and undeployment of content will be blocked. - To modify the Edge Integration Cell deployment solution properties, proceed as follows: @@ -31,7 +28,7 @@ To modify the Edge Integration Cell deployment solution properties, proceed as f The system opens a dialog box where you can update solution deployment properties. -6. Choose *Update*. +6. Choose *Modify*. @@ -40,5 +37,6 @@ To modify the Edge Integration Cell deployment solution properties, proceed as f ## Results -The solution is updated based on modified helm charts. +- The solution is updated based on modified helm charts. +- If the modify configuration operation fails, you can rollback the solution to its last successfully deployed version. For more details, see [Rollback Edge Integration Cell Solution](rollback-edge-integration-cell-solution-9eec21b.md). diff --git a/docs/ISuite/operations-cockpit-ec0fc95.md b/docs/ISuite/operations-cockpit-ec0fc95.md index 2ddfacf1..302f78d9 100644 --- a/docs/ISuite/operations-cockpit-ec0fc95.md +++ b/docs/ISuite/operations-cockpit-ec0fc95.md @@ -15,9 +15,17 @@ In the Operations Cockpit, you can get a first overview over the most critical r For more information, see [Job Management](job-management-4146fa5.md). -- *Component Monitoring*: Get information on the components in status *Error* quickly and efficiently. +- *Component Monitor*: Get information on the components in status *Error* quickly and efficiently. - For more information, see [Component Monitoring](component-monitoring-49f487e.md). + For more information, see [Component Monitor](component-monitor-49f487e.md). + +- *Status Information*: Get status information on the Edge Integration Cell components. + + For more information, see [Status Information](status-information-732f300.md). + +- *Solace Monitor*: Monitor Solace Message Broker metrics, keep track of resource utilization, and access information about message VPNs, queues, and clients. + + For more information, see [Solace Monitor](solace-monitor-26a7894.md). - *Quick Links*: Jump direclty to *View Runtime Parameters*, a screen that you can also enter via *Component Monitoring*. diff --git a/docs/ISuite/patch-release-notes-for-sap-integration-suite-58595b5.md b/docs/ISuite/patch-release-notes-for-sap-integration-suite-58595b5.md index 80960fec..9c564df2 100644 --- a/docs/ISuite/patch-release-notes-for-sap-integration-suite-58595b5.md +++ b/docs/ISuite/patch-release-notes-for-sap-integration-suite-58595b5.md @@ -121,7 +121,7 @@ API Management -[Patch Releases for API Management](https://help.sap.com/viewer/66d066d903c2473f81ec33acfe2ccdb4/Cloud/en-US/6ddd927cbeaa42e384dc903e6002e269.html "This topic provides information on patch releases for API Management that are provided for bug fixes.") :arrow_upper_right: +[Patch Releases for API Management](patch-releases-for-api-management-6ddd927.md) diff --git a/docs/ISuite/patch-releases-for-api-management-6ddd927.md b/docs/ISuite/patch-releases-for-api-management-6ddd927.md new file mode 100644 index 00000000..ef21b68d --- /dev/null +++ b/docs/ISuite/patch-releases-for-api-management-6ddd927.md @@ -0,0 +1,192 @@ + + +# Patch Releases for API Management + +This topic provides information on patch releases for API Management that are provided for bug fixes. + + + + + +## May 2024 + +**Software Increment: 2403** + + + + + + + + + + + + + +
+ +Technical Component + + + +Software Version + + + +Description + +
+ +API Management + + + +1.168.4 + + + +UI issues in the policy editor have been resolved. You can now move the splitters around effortlessly, enter the necessary policy details, and edit their flows without any interruptions to the user interface. + +
+ + + + + +## March 2024 + +**Software Increment: 2313** + + + + + + + + + + + + + +
+ +Technical Component + + + +Software Version + + + +Description + +
+ +API Management + + + +1.165.3 + + + +The prefix "custom\_" has been added to all custom metrics during creation. Additionally, the Policy Validator for the StatsCollector will check if a custom metric already exists and update it accordingly with the "custom\_" prefix in the StatsCollector. + +
+ + + + + +## January 2024 + +**Software Increment: 2310** + + + + + + + + + + + + + + + + + + + + + + + +
+ +Technical Component + + + +Software Version + + + +Description + +
+ +API Management + + + +1.162.7 + + + +The following issues have been identified: + +- In the event of an onboarding failure after successfully creating a keystore for opproxy, the same step was being executed again. + +- When navigating to product details from the product list in the Application details page, particularly when the product has a different name and title in API business hub enterprise the following issues were observed: + + - Users are unable to navigate to the product details from the product list if the product has a different name and title. + + - The APIProduct uses the name as the primary key in API business hub enterprise, but the Application details page uses the title to navigate, which resulted in an error. + + +- The rate limiting for the SAP PKI Certificate Service on all Public & Private Cloud landscapes went live on November 16, 2023, according to the certificate service team. So adjustments need to be made to accommodate the rate limiting. + + +This patch fixes the above issues. + +
+ +API Management + + + +1.162.6 + + + +In the Neo platform, the onboarding process for new developers in runtime was not functioning properly. This patch fixes the issue. + +
+ +API Management + + + +1.162.5 + + + +Request initiated for all services to adopt the latest xsuaa security patch. + +
+ diff --git a/docs/ISuite/patch-releases-for-cloud-integration-and-related-components-023a472.md b/docs/ISuite/patch-releases-for-cloud-integration-and-related-components-023a472.md index e3bde9ce..bbbf94c6 100644 --- a/docs/ISuite/patch-releases-for-cloud-integration-and-related-components-023a472.md +++ b/docs/ISuite/patch-releases-for-cloud-integration-and-related-components-023a472.md @@ -8,7 +8,150 @@ This topic provides information on patch releases for hotfixes, bugfixes, and co This topic covers patches for the following capabilities and features of SAP Integration Suite: Cloud Integration, Trading Partner Management, Integration Advisor, Integration Assessment, Migration Assessment, and Edge Integration Cell. -The following patch release information covers the most recent changes made to the latest version of the software. For earlier patch release notes, see [Archive - Patch Release Notes for Cloud Integration](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/f4b7126c524e4126b54fc7b4a34cadc0.html "This page contains a historical archive of all patch release notes for Cloud Integration.") :arrow_upper_right:. +The following patch release information covers the most recent changes made to the latest version of the software. + + + + + +## May 2024 + +**Software Increment: 2403** + + + + + + + + +
+ +Technical Component + + + +Software Version + + + +Description + +
+ + + + + +## April 2024 + +**Software Increment: 2402** + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +Technical Component + + + +Software Version + + + +Description + +
+ +Cloud Integration + + + +6.51.28 + + + +There have been problems to load *Monitor* page. This patch fixes the issue. + +
+ +Cloud Integration + + + +6.51.27 + + + +There were some issues with the generation of key-pairs with X.509 certificates using elliptic curve algorithms \(for example, secp192k1, secp256k1, secp192r1, and others\). This patch fixes the issue. + +
+ +Cloud Integration + + + +6.51.26 + + + +There has been a performance issue with the Inspect feature. This patch fixes the issue. + +
+ +Cloud Integration + + + +6.51.25 + + + +There was an issue with a potential negative impact on the deployment and undeployment of integration artifacts. This patch fixes the issue. + +
+ +Cloud Integration + + + +6.51.23 + + + +System performance has been improved and truncation of value mapping has been fixed by changing the way XML files are read. + +
diff --git a/docs/ISuite/region-specific-ip-addresses-available-for-api-management-cloud-foundry-environment-585d639.md b/docs/ISuite/region-specific-ip-addresses-available-for-api-management-cloud-foundry-environment-585d639.md index 8ec1c2c7..dfb9d43b 100644 --- a/docs/ISuite/region-specific-ip-addresses-available-for-api-management-cloud-foundry-environment-585d639.md +++ b/docs/ISuite/region-specific-ip-addresses-available-for-api-management-cloud-foundry-environment-585d639.md @@ -79,7 +79,7 @@ West Europe -51.105.226.79, 20.107.78.224, 20.4.205.181 +51.105.226.79, 20.107.78.224, 20.4.205.181, 108.143.96.175, 172.201.40.15, 20.31.245.126 @@ -239,7 +239,7 @@ East US -20.42.28.32, 20.25.8.237 +20.42.28.32 @@ -839,11 +839,11 @@ us-east-1 [Configuring Additional Virtual Host in Cloud Foundry Environment](configuring-additional-virtual-host-in-cloud-foundry-environment-a7b91e5.md "A virtual host allows you to host multiple domain names on the API Management capability within Integration Suite.") -[User Roles in API Management \(New\)](user-roles-in-api-management-new-911ca5a.md "Similar to other capabilities of the SAP Integration Suite, the API Management capability defines a set of technical roles that grant specific permissions to users. Users can be assigned roles through SAP BTP's role collection concept. While users have the option to create their own role collections, a set of predefined role collections is automatically created when the API Management capability is provisioned.") +[Tasks and Corresponding Role Collections](tasks-and-corresponding-role-collections-911ca5a.md "Similar to other capabilities of the SAP Integration Suite, the API Management capability defines a set of technical roles that grant specific permissions to users. Users can be assigned roles through SAP BTP's role collection concept. While users have the option to create their own role collections, a set of predefined role collections is automatically created when the API Management capability is provisioned.") [User Roles in API Management](user-roles-in-api-management-7010b58.md "Use role collections to group together different roles that can be assigned to API Portal and API business hub enterprise users.") [Cancel API Management Service Subscription](cancel-api-management-service-subscription-df6df2b.md "You can deactivate your API Management capability from Integration Suite to disable your account from the API Management service.") -[](https://help.sap.com/viewer/51ab953548be4459bfe8539ecaeee98d/CLOUD/en-US/1e88d9cb4e90466cb0ab2c53e33b2e1c.html "") :arrow_upper_right: +[Setting Up API Management with SAP Cloud Identity Services](setting-up-api-management-with-sap-cloud-identity-services-1e88d9c.md "SAP Cloud Platform allows customers to connect their SAP Cloud Identity Services with the BTP offerings.") diff --git a/docs/ISuite/rollback-edge-integration-cell-solution-9eec21b.md b/docs/ISuite/rollback-edge-integration-cell-solution-9eec21b.md new file mode 100644 index 00000000..be94d32d --- /dev/null +++ b/docs/ISuite/rollback-edge-integration-cell-solution-9eec21b.md @@ -0,0 +1,47 @@ + + +# Rollback Edge Integration Cell Solution + +Use Edge Lifecycle Management \(Edge LM\) to rollback deployment of Edge Integration Cell solution to the last suceessful deployed version when an upgrade or modify configuration operation fails. + + + + + +## Prerequisites + +The upgrade or modify configuration operation failed on the deployed Edge Integration Cell solution. + + + +## Context + +You can rollback only to the last successfully deployed solution version. + + + +## Procedure + +1. Open the *Edge Lifecycle Management* UI. + +2. Go to the *Edge Nodes* tab. + +3. Choose the Edge Node where upgrade or modify operation failed. + +4. Select the solution where you want to perform the rollback operation. + +5. From the *Operations* context menu, choose *Rollback*. + + > ### Note: + > When rolling back a solution version with dependencies, those dependencies will not be rolled back or modified. If any parent dependencies can't be satisfied with rollback, the operation may not be permitted. In this case, you will see a warning message. + + + + + + +## Results + +- The solution is rolled back to its last successfully deployed version. +- If the Rollback operation is unsuccessful, you can choose *Retry* from the *Operations* context menu to attempt rollback operation again. + diff --git a/docs/ISuite/setting-up-api-management-with-sap-cloud-identity-services-1e88d9c.md b/docs/ISuite/setting-up-api-management-with-sap-cloud-identity-services-1e88d9c.md new file mode 100644 index 00000000..3cff071e --- /dev/null +++ b/docs/ISuite/setting-up-api-management-with-sap-cloud-identity-services-1e88d9c.md @@ -0,0 +1,25 @@ + + +# Setting Up API Management with SAP Cloud Identity Services + +SAP Cloud Platform allows customers to connect their SAP Cloud Identity Services with the BTP offerings. + +SAP Cloud Identity \(SCI\) service supports SAML 2.0 for identity federations. Using SAML, it can federate and connect with any Custom IDP that supports SAML 2.0. + +The high-level view for SAP API Management and the SAP Cloud Identity is captured in the diagram below: + +![](images/SCI_Block_Diagram_3053fc5.png) + +**Related Information** + + +[Configuring Additional Virtual Host in Cloud Foundry Environment](configuring-additional-virtual-host-in-cloud-foundry-environment-a7b91e5.md "A virtual host allows you to host multiple domain names on the API Management capability within Integration Suite.") + +[Region-Specific IP Addresses Available for API Management Cloud Foundry Environment](region-specific-ip-addresses-available-for-api-management-cloud-foundry-environment-585d639.md "API Management protects your backend services. However, API Management needs to establish connectivity to your backend services during an API call execution.") + +[Tasks and Corresponding Role Collections](tasks-and-corresponding-role-collections-911ca5a.md "Similar to other capabilities of the SAP Integration Suite, the API Management capability defines a set of technical roles that grant specific permissions to users. Users can be assigned roles through SAP BTP's role collection concept. While users have the option to create their own role collections, a set of predefined role collections is automatically created when the API Management capability is provisioned.") + +[User Roles in API Management](user-roles-in-api-management-7010b58.md "Use role collections to group together different roles that can be assigned to API Portal and API business hub enterprise users.") + +[Cancel API Management Service Subscription](cancel-api-management-service-subscription-df6df2b.md "You can deactivate your API Management capability from Integration Suite to disable your account from the API Management service.") + diff --git a/docs/ISuite/solace-monitor-26a7894.md b/docs/ISuite/solace-monitor-26a7894.md index 21e6e53a..c825b1c1 100644 --- a/docs/ISuite/solace-monitor-26a7894.md +++ b/docs/ISuite/solace-monitor-26a7894.md @@ -2,11 +2,9 @@ # Solace Monitor -Monitor Solace Message Broker metrics, keep track of resource utilization, and access information about message VPNs, queues, and clients. +Monitor Solace Broker metrics, keep track of resource utilization, and access information about message VPNs, queues, and clients. -The Solace Monitor card provides status updates on the *Kubernetes Custom Resource*`SolaceSoftwareBroker`, the *Guaranteed Messaging* capability and the *Config-Sync* feature. The status of the Kubernetes Custom Resource indicates the operational state of the Solace Message Broker, which is used as a messaging service by the Edge Integration Cell, installed on your Kubernetes cluster. The Guaranteed Messaging capability signifies the reliability of message delivery, even in the face of network failures or downtime with the receiving application. Config-Sync is an internal Solace feature which ensures configurations remain in sync, allowing the system to continue functioning in the event of a failover. Config-Sync status is available only in a high-availability setup. - -> ### Note: +The Solace Monitor card provides status updates on the *Kubernetes Custom Resource*`SolaceSoftwareBroker`, the *Guaranteed Messaging* capability and the *Config-Sync* feature. The status of the Kubernetes Custom Resource indicates the operational state of the Solace Broker, which is used as a messaging service by the Edge Integration Cell, installed on your Kubernetes cluster. The Guaranteed Messaging capability signifies the reliability of message delivery, even in the face of network failures or downtime with the receiving application. Config-Sync is an internal Solace feature which ensures configurations remain in sync, allowing the system to continue functioning in the event of a failover. Config-Sync status is available only in a high-availability setup. Choose the card to monitor the current state, track resource utilization, and view detailed information about message VPNs, queues, and messaging clients in real-time. On the screen, you see the following information: diff --git a/docs/ISuite/user-roles-in-api-management-new-911ca5a.md b/docs/ISuite/tasks-and-corresponding-role-collections-911ca5a.md similarity index 98% rename from docs/ISuite/user-roles-in-api-management-new-911ca5a.md rename to docs/ISuite/tasks-and-corresponding-role-collections-911ca5a.md index 6232631c..4644fdd3 100644 --- a/docs/ISuite/user-roles-in-api-management-new-911ca5a.md +++ b/docs/ISuite/tasks-and-corresponding-role-collections-911ca5a.md @@ -1,6 +1,6 @@ -# User Roles in API Management \(New\) +# Tasks and Corresponding Role Collections Similar to other capabilities of the SAP Integration Suite, the API Management capability defines a set of technical roles that grant specific permissions to users. Users can be assigned roles through SAP BTP's role collection concept. While users have the option to create their own role collections, a set of predefined role collections is automatically created when the API Management capability is provisioned. @@ -725,5 +725,5 @@ GraphNavigator.Viewer [Cancel API Management Service Subscription](cancel-api-management-service-subscription-df6df2b.md "You can deactivate your API Management capability from Integration Suite to disable your account from the API Management service.") -[](https://help.sap.com/viewer/51ab953548be4459bfe8539ecaeee98d/CLOUD/en-US/1e88d9cb4e90466cb0ab2c53e33b2e1c.html "") :arrow_upper_right: +[Setting Up API Management with SAP Cloud Identity Services](setting-up-api-management-with-sap-cloud-identity-services-1e88d9c.md "SAP Cloud Platform allows customers to connect their SAP Cloud Identity Services with the BTP offerings.") diff --git a/docs/ISuite/terminology-and-glossary-fd1491d.md b/docs/ISuite/terminology-and-glossary-fd1491d.md index ff1eceef..f2e066bb 100644 --- a/docs/ISuite/terminology-and-glossary-fd1491d.md +++ b/docs/ISuite/terminology-and-glossary-fd1491d.md @@ -5,7 +5,9 @@ **Related Information** - + [Glossary for SAP Trading Partner Management](glossary-for-sap-trading-partner-management-81860a4.md "") +[Glossary for SAP Integration Advisor](glossary-for-sap-integration-advisor-9c221b4.md "") + diff --git a/docs/ISuite/upgrade-edge-integration-cell-solution-e7b8089.md b/docs/ISuite/upgrade-edge-integration-cell-solution-e7b8089.md index 61a70cb6..c7e1117b 100644 --- a/docs/ISuite/upgrade-edge-integration-cell-solution-e7b8089.md +++ b/docs/ISuite/upgrade-edge-integration-cell-solution-e7b8089.md @@ -40,8 +40,13 @@ Service keys for connectivity to SAP Integration Suite and BTP services are rota ## Results -The solution is upgraded based on helm charts of the new version. +- The solution is upgraded based on helm charts of the new version. + + > ### Note: + > Upgrading Istio can lead to traffic disruption during the upgrade process. + +- If the upgrade of the Edge Integration Cell solution fails, you can choose to: + - Retry the upgrade but be aware that if failure persists after a retry you can't rollback to the last successfully deployed version. + - Rollback to the last successfully deployed version. For more information see [Rollback Edge Integration Cell Solution](rollback-edge-integration-cell-solution-9eec21b.md). -> ### Note: -> Upgrading Istio can lead to traffic disruption during the upgrade process. diff --git a/docs/ISuite/user-roles-in-api-management-7010b58.md b/docs/ISuite/user-roles-in-api-management-7010b58.md index 27af24c5..ed3d6991 100644 --- a/docs/ISuite/user-roles-in-api-management-7010b58.md +++ b/docs/ISuite/user-roles-in-api-management-7010b58.md @@ -199,9 +199,9 @@ Use this role to: [Region-Specific IP Addresses Available for API Management Cloud Foundry Environment](region-specific-ip-addresses-available-for-api-management-cloud-foundry-environment-585d639.md "API Management protects your backend services. However, API Management needs to establish connectivity to your backend services during an API call execution.") -[User Roles in API Management \(New\)](user-roles-in-api-management-new-911ca5a.md "Similar to other capabilities of the SAP Integration Suite, the API Management capability defines a set of technical roles that grant specific permissions to users. Users can be assigned roles through SAP BTP's role collection concept. While users have the option to create their own role collections, a set of predefined role collections is automatically created when the API Management capability is provisioned.") +[Tasks and Corresponding Role Collections](tasks-and-corresponding-role-collections-911ca5a.md "Similar to other capabilities of the SAP Integration Suite, the API Management capability defines a set of technical roles that grant specific permissions to users. Users can be assigned roles through SAP BTP's role collection concept. While users have the option to create their own role collections, a set of predefined role collections is automatically created when the API Management capability is provisioned.") [Cancel API Management Service Subscription](cancel-api-management-service-subscription-df6df2b.md "You can deactivate your API Management capability from Integration Suite to disable your account from the API Management service.") -[](https://help.sap.com/viewer/51ab953548be4459bfe8539ecaeee98d/CLOUD/en-US/1e88d9cb4e90466cb0ab2c53e33b2e1c.html "") :arrow_upper_right: +[Setting Up API Management with SAP Cloud Identity Services](setting-up-api-management-with-sap-cloud-identity-services-1e88d9c.md "SAP Cloud Platform allows customers to connect their SAP Cloud Identity Services with the BTP offerings.") diff --git a/docs/ISuite/what-is-migration-assessment-164b835.md b/docs/ISuite/what-is-migration-assessment-164b835.md index 121285ca..508de025 100644 --- a/docs/ISuite/what-is-migration-assessment-164b835.md +++ b/docs/ISuite/what-is-migration-assessment-164b835.md @@ -13,7 +13,7 @@ Learn more about Migration Assessment. ## Features -- Extract data from your existing SAP Process Orchestration 7.5 system +- Extract data from your existing SAP Process Orchestration system Migration is currently supported for the following versions of SAP Process Orchestration: @@ -26,7 +26,7 @@ Learn more about Migration Assessment. - Evaluate the extracted data -- Estimate the potential effort of migrating your integrated configuration objects from your SAP Process Orchestration 7.5 system to SAP Integration Suite +- Estimate the potential effort of migrating your integrated configuration objects from your SAP Process Orchestration system to SAP Integration Suite > ### Note: @@ -53,5 +53,5 @@ This service is available in the SAP BTP, Cloud Foundry environment. [Create a Scenario Evaluation Request](create-a-scenario-evaluation-request-435ec61.md "Assess your integration scenarios using the information from data extraction requests.") -[Tasks and Permissions](60-Security/tasks-and-permissions-2714db1.md "Learn about security-related topics like users and authorizations.") +[Tasks and Permissions for Migration Assessment](60-Security/tasks-and-permissions-for-migration-assessment-2714db1.md "Learn about security-related topics like users and authorizations.") diff --git a/docs/ISuite/what-s-new-for-integration-suite-general-features-2ad1b96.md b/docs/ISuite/what-s-new-for-integration-suite-general-features-2ad1b96.md index e8593ae2..f007986a 100644 --- a/docs/ISuite/what-s-new-for-integration-suite-general-features-2ad1b96.md +++ b/docs/ISuite/what-s-new-for-integration-suite-general-features-2ad1b96.md @@ -86,6 +86,70 @@ Integration Suite General Features + + + +New theme for the user interface. + + + + +Our user interface nows follows a new Horizon theme. You will find some changes in the way the icons, buttons, and texts look. There is no change in the functionality of the various features. + + + + +Info only + + + + +General Availability + + + + +New + + + + +Technology + + + + +Not applicable + + + + +SAP Business Technology Platform + + + + +2024-05-10 + + + + +2024-05-10 + + + + + + +Integration Suite General Features + + + + +- Cloud Foundry + + + @@ -94,13 +158,13 @@ Built-In Support -A new feature, referred as built-insupport, helps you find solutions to problems you may encounter when using the SAP Integration Suite. +This new feature helps you find solutions to problems you may encounter when using SAP Integration Suite. -From SAP Integration Suite screens, you can search knowledge base articles that that can help you understand the application behaviour and guide you towards solution. +From SAP Integration Suite, you can search knowledge base articles that can help you understand the application behavior and guide you towards a solution. -You can also file an incident and receive assistance with recommended solutions through knowledge base articles or help recommendations. +The built-in support feature also lets you file incidents and assists you with recommended solutions through knowledge base articles or help recommendations. -See: [Working with Integration Suite Home](https://help.sap.com/docs/integration-suite/sap-integration-suite/working-with-integration-suite-home?version=CLOUD) +See: [Working with Integration Suite Home](20-Working_with_SAP_Integration_Suite_Home/working-with-integration-suite-home-a53dce3.md) @@ -135,12 +199,12 @@ SAP Business Technology Platform -2024-04-06 +2024-05-10 -2024-04-06 +2024-05-10 @@ -306,7 +370,7 @@ Graph -If you've activated Graph as a capability of API Management, and have assigned the suitable roles to your user, you can access Graph by navigating from *Design* \> *Graph*. For more information, see [What is Graph?](https://help.sap.com/docs/graph) +If you've activated Graph as a capability of API Management, and have assigned the suitable roles to your user, you can access Graph by navigating from *Design* \> *Graph*. For more information, see [What is Graph?](https://help.sap.com/docs/graph) diff --git a/docs/apim/API-Management/2020-archives-085f4e9.md b/docs/apim/API-Management/2020-archives-085f4e9.md index b1c02d43..526395af 100644 --- a/docs/apim/API-Management/2020-archives-085f4e9.md +++ b/docs/apim/API-Management/2020-archives-085f4e9.md @@ -1057,6 +1057,8 @@ New **Related Information** +[Archive 2023](archive-2023-a8dd11f.md "") + [2022 Archives](2022-archives-7eaa63d.md "") [2021 Archives](2021-archives-bdf0f0e.md "") diff --git a/docs/apim/API-Management/2021-archives-bdf0f0e.md b/docs/apim/API-Management/2021-archives-bdf0f0e.md index 85231636..5f45e8eb 100644 --- a/docs/apim/API-Management/2021-archives-bdf0f0e.md +++ b/docs/apim/API-Management/2021-archives-bdf0f0e.md @@ -1209,6 +1209,8 @@ New **Related Information** +[Archive 2023](archive-2023-a8dd11f.md "") + [2022 Archives](2022-archives-7eaa63d.md "") [2020 Archives](2020-archives-085f4e9.md "") diff --git a/docs/apim/API-Management/2022-archives-7eaa63d.md b/docs/apim/API-Management/2022-archives-7eaa63d.md index 03565562..a9dc45dc 100644 --- a/docs/apim/API-Management/2022-archives-7eaa63d.md +++ b/docs/apim/API-Management/2022-archives-7eaa63d.md @@ -779,6 +779,8 @@ Not applicable **Related Information** +[Archive 2023](archive-2023-a8dd11f.md "") + [2021 Archives](2021-archives-bdf0f0e.md "") [2020 Archives](2020-archives-085f4e9.md "") diff --git a/docs/apim/API-Management/APIM-Initial-Setup/accessing-api-business-hub-enterprise-apis-programmatically-dabee6e.md b/docs/apim/API-Management/APIM-Initial-Setup/accessing-api-business-hub-enterprise-apis-programmatically-dabee6e.md index 634d38cf..f5d5525c 100644 --- a/docs/apim/API-Management/APIM-Initial-Setup/accessing-api-business-hub-enterprise-apis-programmatically-dabee6e.md +++ b/docs/apim/API-Management/APIM-Initial-Setup/accessing-api-business-hub-enterprise-apis-programmatically-dabee6e.md @@ -548,7 +548,7 @@ In the REST client: **Related Information** -[Accessing API Management APIs Programmatically](accessing-api-management-apis-programmatically-24a2c37.md "The apiportal-apiaccess paln offers external applications the ability to access the public APIs of the Integration Suite API Management capability. These APIs are used by the external applications to perform CRUD operations on API Management features like API proxies or products. These APIs are built on REST and OData principles and are extensively documented on the Business Accelerator Hub.") +[Accessing API Management APIs Programmatically](accessing-api-management-apis-programmatically-24a2c37.md "The apiportal-apiaccess plan offers external applications the ability to access the public APIs of the Integration Suite API Management capability. These APIs are used by the external applications to perform CRUD operations on API Management features like API proxies or products. These APIs are built on REST and OData principles and are extensively documented on the Business Accelerator Hub.") [Managing Cloud Foundry Microservices through API Management](managing-cloud-foundry-microservices-through-api-management-e609a3e.md "The apim-as-route-service plan helps you in managing Cloud Foundry applications by including policies such as rate limit, quota. The service instance you create through this plan allows you to bind to the route service and creates an API Proxy. This API Proxy serves in establishing a secure connection with your Cloud Foundry application and all the calls made to the Cloud Foundry application are routed via API Management, API portal.") diff --git a/docs/apim/API-Management/APIM-Initial-Setup/accessing-api-management-apis-programmatically-24a2c37.md b/docs/apim/API-Management/APIM-Initial-Setup/accessing-api-management-apis-programmatically-24a2c37.md index 34b065cc..2ed07bde 100644 --- a/docs/apim/API-Management/APIM-Initial-Setup/accessing-api-management-apis-programmatically-24a2c37.md +++ b/docs/apim/API-Management/APIM-Initial-Setup/accessing-api-management-apis-programmatically-24a2c37.md @@ -2,7 +2,7 @@ # Accessing API Management APIs Programmatically -The *apiportal-apiaccess* paln offers external applications the ability to access the public APIs of the Integration Suite API Management capability. These APIs are used by the external applications to perform CRUD operations on API Management features like API proxies or products. These APIs are built on REST and OData principles and are extensively documented on the [Business Accelerator Hub](https://api.sap.com/package/APIMgmt/odata). +The *apiportal-apiaccess* plan offers external applications the ability to access the public APIs of the Integration Suite API Management capability. These APIs are used by the external applications to perform CRUD operations on API Management features like API proxies or products. These APIs are built on REST and OData principles and are extensively documented on the [Business Accelerator Hub](https://api.sap.com/package/APIMgmt/odata). @@ -12,7 +12,7 @@ The *apiportal-apiaccess* paln offers external applications the ability to acces The *apiportal-apiaccess* plan allows you to programmatically import/export API proxies, create products, key value maps. It is especially useful when integrating API Management with a CI/CD process or when migrating from a Neo to Cloud Foundry environment using the migration tool. -The API Access plan allows you to generate a service key by creating a service instance. By creating a service instance, you can generate a service key that includes the application url, clientId, clientSecret, and tokenUrl is used tohttps://api.sap.com/package/APIMgmt/odata generate a bearer token with the help of a REST Console. This Bearer Token, along with the application url and API endpoint are used to trigger the API. Therefore, bearer token acts like a key to access the APIs. +The API Access plan allows you to generate a service key by creating a service instance. By creating a service instance, you can generate a service key that includes the application url, clientId, clientSecret, and tokenUrl is used to generate a bearer token with the help of a REST Console. This Bearer Token, along with the application url and API endpoint are used to trigger the API. Therefore, bearer token acts like a key to access the APIs. @@ -404,7 +404,7 @@ In the REST Console: - Now, to trigger an API, in the same REST Console, append the API endpoint \(obtained from the API portal APIs that are located in the SAP API Management package of API Business Hub\) to the *url*. > ### Note: - > Currently, the *apiportal-apiaccess* plan allows you to access only the API portal APIs from the [SAP API Management package](https://api.sap.com/package/APIMgmt?section=Artifacts). + > Currently, the *apiportal-apiaccess* plan allows you to access only the API Management APIs from the [SAP API Management package](https://api.sap.com/package/APIMgmt?section=Artifacts). - Choose `Bearer Token` as the `Authorization` type and paste the copied Bearer Token in the specified space. - Include payloads, if needed. diff --git a/docs/apim/API-Management/APIM-Initial-Setup/accessing-on-premise-systems-through-api-management-2fc7a5b.md b/docs/apim/API-Management/APIM-Initial-Setup/accessing-on-premise-systems-through-api-management-2fc7a5b.md index 8d8df463..dd0242b8 100644 --- a/docs/apim/API-Management/APIM-Initial-Setup/accessing-on-premise-systems-through-api-management-2fc7a5b.md +++ b/docs/apim/API-Management/APIM-Initial-Setup/accessing-on-premise-systems-through-api-management-2fc7a5b.md @@ -12,6 +12,9 @@ The *on-premise-connectivity* plan helps in achieving principal propagation whil Let us consider an use case where you want to pass the identity and security context of the logged-in user in the client application \(known as the principal\) from client application to on-premise backend. It ensures that the downstream services have the necessary information to authenticate the client without requiring the client to re-authenticate for each service. When a client makes a request to an API gateway, the gateway authenticates the user. It then propagates the principal information, such as the user's identity, to the backend services that the client's request needs to access. This allows the downstream services to make authorization decisions based on the user's details. +> ### Note: +> The API Management platform incorporates the circuit breaker pattern to enhance the resilience of the back-end. For more information, see . + ![](images/On-prem_Connectivity_1067d7f.png) To accomplish principal propagation, you require a service key. This plan allows you to obtain the token by creating a service instance and generating a service key. @@ -310,7 +313,7 @@ You can use the credentials to establish: **Related Information** -[Accessing API Management APIs Programmatically](accessing-api-management-apis-programmatically-24a2c37.md "The apiportal-apiaccess paln offers external applications the ability to access the public APIs of the Integration Suite API Management capability. These APIs are used by the external applications to perform CRUD operations on API Management features like API proxies or products. These APIs are built on REST and OData principles and are extensively documented on the Business Accelerator Hub.") +[Accessing API Management APIs Programmatically](accessing-api-management-apis-programmatically-24a2c37.md "The apiportal-apiaccess plan offers external applications the ability to access the public APIs of the Integration Suite API Management capability. These APIs are used by the external applications to perform CRUD operations on API Management features like API proxies or products. These APIs are built on REST and OData principles and are extensively documented on the Business Accelerator Hub.") [Accessing API business hub enterprise APIs Programmatically](accessing-api-business-hub-enterprise-apis-programmatically-dabee6e.md "The devportal-apiaccess plan allows you to access the API business hub enterprise APIs to programmatically onboard developers, create applications, and more.") diff --git a/docs/apim/API-Management/APIM-Initial-Setup/api-management-service-plans-e064663.md b/docs/apim/API-Management/APIM-Initial-Setup/api-management-service-plans-e064663.md index 868d85ca..df62f704 100644 --- a/docs/apim/API-Management/APIM-Initial-Setup/api-management-service-plans-e064663.md +++ b/docs/apim/API-Management/APIM-Initial-Setup/api-management-service-plans-e064663.md @@ -2,7 +2,7 @@ # API Management Service Plans -The functionality of the API Management capability is typically managed using the Integration Suite \(UI\) application, which is the primary focus of this user guide. However, you can also call API Management APIs, manage Cloud Foundry applications, and connect to an on-premise backend sytem by means of service plans. +The functionality of the API Management capability is typically managed using the Integration Suite \(UI\) application, which is the primary focus of this user guide.However, you can also call API Management APIs, manage Cloud Foundry applications, and connect to an on-premise backend sytem by means of service plans. The API Management services on Cloud Foundry provides different capabilities through the following plans: diff --git a/docs/apim/API-Management/APIM-Initial-Setup/configuring-a-custom-domain-for-a-virtual-host-6b9e5a3.md b/docs/apim/API-Management/APIM-Initial-Setup/configuring-a-custom-domain-for-a-virtual-host-6b9e5a3.md index 88f7908c..ad373f02 100644 --- a/docs/apim/API-Management/APIM-Initial-Setup/configuring-a-custom-domain-for-a-virtual-host-6b9e5a3.md +++ b/docs/apim/API-Management/APIM-Initial-Setup/configuring-a-custom-domain-for-a-virtual-host-6b9e5a3.md @@ -70,7 +70,7 @@ To request a custom domain with one-way TLS, perform the following steps: > > - isForCustomDomain - Ensure that the value is set to "true". > - > - keyStoreName: The keyStoreName parameter refers to the name of the keystore that should contain the custom domain's public and private key, or the name of the certificate store reference pointing to the keystore. To learn how to create a keystore and upload certificates, see [Manage Certificates](../manage-certificates-c665875.md). Alternatively, you can use a certificate store reference name that points to the keystore containing the custom domain's public and private keys. For more information, see . + > - keyStoreName: The keyStoreName parameter refers to the name of the keystore that should contain the custom domain's public and private key, or the name of the certificate store reference pointing to the keystore. To learn how to create a keystore and upload certificates, see [Manage Certificates](../manage-certificates-c665875.md). Alternatively, you can use a certificate store reference name that points to the keystore containing the custom domain's public and private keys. For more information, see [Working with References](../working-with-references-6f96b64.md). > > - keyStoreAlias: The keyStoreAlias parameter refers to the name of the keystore certificate containing the custom domain's public and private key. To learn how to create a keystore certificate and upload certificates, see [Manage Certificates](../manage-certificates-c665875.md). @@ -158,7 +158,7 @@ To request a custom domain with one-way TLS, perform the following steps: > > - isForCustomDomain - Ensure that the value is set to "true". > - > - keyStoreName: The keyStoreName parameter refers to the name of the keystore that should contain the custom domain's public and private key, or the name of the certificate store reference pointing to the keystore. To learn how to create a keystore and upload certificates, see [Manage Certificates](../manage-certificates-c665875.md). Alternatively, you can use a certificate store reference name that points to the keystore containing the custom domain's public and private keys. For more information, see . + > - keyStoreName: The keyStoreName parameter refers to the name of the keystore that should contain the custom domain's public and private key, or the name of the certificate store reference pointing to the keystore. To learn how to create a keystore and upload certificates, see [Manage Certificates](../manage-certificates-c665875.md). Alternatively, you can use a certificate store reference name that points to the keystore containing the custom domain's public and private keys. For more information, see [Working with References](../working-with-references-6f96b64.md). > > - keyStoreAlias: The keyStoreAlias parameter refers to the name of the keystore certificate containing the custom domain's public and private key. To learn how to create a keystore certificate and upload certificates, see [Manage Certificates](../manage-certificates-c665875.md). > diff --git a/docs/apim/API-Management/APIM-Initial-Setup/configuring-a-default-domain-for-a-virtual-host-1085228.md b/docs/apim/API-Management/APIM-Initial-Setup/configuring-a-default-domain-for-a-virtual-host-1085228.md index 88e6159a..0226b6e2 100644 --- a/docs/apim/API-Management/APIM-Initial-Setup/configuring-a-default-domain-for-a-virtual-host-1085228.md +++ b/docs/apim/API-Management/APIM-Initial-Setup/configuring-a-default-domain-for-a-virtual-host-1085228.md @@ -108,6 +108,92 @@ To request a custom domain with one-way TLS, perform the following steps: > ``` +3. Service to update a virtual host: + + You can update the virtualHostUrl, trustStore, and the isDefaultVirtualHostRequest flag. + + You can also convert your default domain virtual host to custom domain by refering to the update section \(Step 3\) of the [Configuring a Custom Domain for a Virtual Host](configuring-a-custom-domain-for-a-virtual-host-6b9e5a3.md) topic. + + - Service URL: https:///apiportal/operations/1.0/Configuration.svc/VirtualHostRequests + - Method: POST + - Request Header: Authentication Bearer + - Content Type: application/json + - Request Body: + + > ### Sample Code: + > ``` + > { + > "accountId" : "subdomain of your subaccount", + > "virtualHostUrl": "prod-apis-updated", + > "isDefaultVirtualHostRequest" : false, + > "operation" : "UPDATE", + > "virtualHostId":"c269915f-7adc-4f78-bdd0-dd39ffcb079f" + > } + > --> + > + > ``` + + > ### Note: + > - accountId: This is the subdomain of your subaccount. + > + > - virtualHostUrl - This is your virtual host alias, for example, prod-apis, testapi. + > + > - isDefaultVirtualHostRequest -if you want the new virtual host to be the default virtual host, set the value to "true", else set it to "false". + > + > - virtualHostId: This is the unique ID of the virtual host you are trying to update. + + > ### Note: + > To enable client authentication \(mutual TLS\) while configuring the virtual host with default domain, see [Configuring Mutual TLs for Virtual Host](configuring-mutual-tls-for-virtual-host-9faf7ce.md). + + + - Response: 201 + + > ### Sample Code: + > ``` + > { + > "d": { + > "__metadata": { + > "id": "https://apiportalurl:443/apiportal/api/1.0/Management.svc/VirtualHostRequests('2F02AD6A-A53C-43F4-BF95-F053A8A1469B')", + > "uri": "https://apiportalurl:443/apiportal/api/1.0/Management.svc/VirtualHostRequests('2F02AD6A-A53C-43F4-BF95-F053A8A1469B')", + > "type": "apimgmtconfiguration.VirtualHostRequest" + > }, + > "accountId": "subdomain of your subaccount", + > "allocatedPort": 443, + > "allocationStatus": "COMPLETE", + > "clusterName": "", + > "id": "2F02AD6A-A53C-43F4-BF95-F053A8A1469B", + > "isClientAuthEnabled": false, + > "isDefaultVirtualHostRequest": false, + > "isForCustomDomain": false, + > "isForNonSni": false, + > "isTLS": false, + > "keyStoreAlias": null, + > "keyStoreName": null, + > "life_cycle": { + > "__metadata": { + > "type": "apimgmtconfiguration.History" + > }, + > "changed_at": "/Date(1707380514905)/", + > "changed_by": "sb-apiaccess_1705298659201!b109482|api-portal-xsuaa!b11864", + > "created_at": "/Date(1707380504072)/", + > "created_by": "sb-apiaccess_1705298659201!b109482|api-portal-xsuaa!b11864" + > }, + > "operation": "UPDATE", + > "trustStore": null, + > "virtualHostId": "c269915f-7adc-4f78-bdd0-dd39ffcb079f", + > "virtualHostUrl": "prod-apis-updated.sapdefaultdomain", + > "lbHost": null + > } + > } + > + > ``` + + - Response: 201 + + > ### Note: + > After the virtual host is updated, APIs associated to a product using the updated virtual host must be redeployed and republished. + **Related Information** diff --git a/docs/apim/API-Management/APIM-Initial-Setup/configuring-mutual-tls-for-virtual-host-9faf7ce.md b/docs/apim/API-Management/APIM-Initial-Setup/configuring-mutual-tls-for-virtual-host-9faf7ce.md index 44bc50db..32bfea9d 100644 --- a/docs/apim/API-Management/APIM-Initial-Setup/configuring-mutual-tls-for-virtual-host-9faf7ce.md +++ b/docs/apim/API-Management/APIM-Initial-Setup/configuring-mutual-tls-for-virtual-host-9faf7ce.md @@ -64,7 +64,7 @@ You can configure mutual TLs for a virtual host, which validates the identities > ### Note: > - isClientAuthEnabled: This field must be set to "true" to enable mutual TLS. > - > - trustStore: This refers to the name of the truststore that holds the client certificate, or name of the certificate store reference that points to the trust store. To learn how to create a truststore and upload certificates, see [Manage Certificates](../manage-certificates-c665875.md). Alternatively, you can use a certificate store reference name instead of the truststore name. This reference name points to the truststore that contains the client certificate. For detailed instructions, see . + > - trustStore: This refers to the name of the truststore that holds the client certificate, or name of the certificate store reference that points to the trust store. To learn how to create a truststore and upload certificates, see [Manage Certificates](../manage-certificates-c665875.md). Alternatively, you can use a certificate store reference name instead of the truststore name. This reference name points to the truststore that contains the client certificate. For detailed instructions, see [Working with References](../working-with-references-6f96b64.md). > ### Note: diff --git a/docs/apim/API-Management/APIM-Initial-Setup/enable-api-management-capability-f6eb433.md b/docs/apim/API-Management/APIM-Initial-Setup/enable-api-management-capability-f6eb433.md deleted file mode 100644 index 98e1fbe2..00000000 --- a/docs/apim/API-Management/APIM-Initial-Setup/enable-api-management-capability-f6eb433.md +++ /dev/null @@ -1,168 +0,0 @@ - - -# Enable API Management Capability - -You can provision the API Management capability from the **Integration Suite** launchpad. - - - - - -## Prerequisites - -- You already have a subaccount and have enable the Cloud Foundry environment in this subaccount. For more information, see [Create a Subaccount](https://help.sap.com/docs/BTP/65de2977205c403bbc107264b8eccf4b/05280a123d3044ae97457a25b3013918.html?q=entitlements). - -- An *Integration Suite* entitlement has been created for your subaccount. For more information, see [Configure Entitlements and Quotas for Subaccounts](https://help.sap.com/docs/BTP/65de2977205c403bbc107264b8eccf4b/5ba357b4fa1e4de4b9fcc4ae771609da.html?q=entitlements). - - - - - - -## Context - -To set up the API Management capability from Integration Suite, you should first have an Integration Suite subscription. - -> ### Note: -> Ensure that you don’t have an instance of a starter plan created in the same subaccount where you plan to create an Integration Suite subscription. Also, note that API Management capabilities from Integration Suite and API Management subscriptions using the stand-alone tile can’t coexist in the same subaccount. - -> ### Note: -> For visual intructions on how to set up and configure API Management capability from Integration Suite, refer the tutorial [Set Up API Management from Integration Suite | Tutorials for SAP Developers](https://developers.sap.com/tutorials/api-mgmt-isuite-initial-setup.html). - - - - - -## Procedure - -1. Log on to SAP BTP Cockpit and navigate to your subaccount. - -2. In the navigation area of the subaccount, choose *Services* \> *Service Marketplace* and search for *Integration Suite* and choose *Create*. - -3. On the *New Instances and Subscriptions* dialog, choose Integration Suite as the *Service*, select the *Plan*, and choose *Create*. - - Wait for the subscription to complete successfully. - -4. Choose *View Subscription* on the *Creation in Progress* dialog. - - Check the status of the submission in the *Subscriptions* section on the *Instances and Subscriptions* page. If the subscription is successful, you’ll notice the status of the *Integration Suite* is shown as *Subscribed*. - -5. To access the Integration Suite, assign the *Integration\_Provisioner* role to yourself. - - > ### Note: - > If you choose *Go to Application* without assigning the *Integration\_Provisioner* role, an application authentication error appears. If the error persists after assigning the role, clear your web browser cache, and log out of the application and log on again. - - To assign the role: - - 1. On the navigation pane, under *Security*, choose *Users*. - - 2. Select your Username and under *Role Collections* section, choose *Assign Role Collection*. - - 3. In the resulting dialog box, select the *Integration\_Provisioner* role and choose *Assign Role Collection*. - - - For detailed instructions, see [Working with Role Collections](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/393ea0b222754311884123ce564779bd.html?q=SAP%20ID%20Service). - -6. Once the role is assigned, choose *Instances and Subscriptions* on the left navigation pane and under *Subscriptions* look for ***Integration Suite***, and choose **Go To Application**. - - You’re navigated to the *Integration Suite* home page. - -7. On the Integration Suite home page, under *Capabilities*, choose *Add Capabilities*. - -8. To design, develop, publish, and oversee APIs in a secure and scalable environment, select *Manage APIs* on the *Activate Capabilities* dialog, and choose *Next*. - -9. To discover, consume and monitor APIs from a centralized API catalogue, choose *Enable API Business Hub Enterprise*. - - Once you enable API business hub enterprise, you will get an option to enable *Graph*. - -10. If you want to expose all your business data in the form of a single semantically connected data graph, select the checkbox for *Graph*, and choose **Next**. - -11. Choose *Activate* on the *Activate Capabilities* dialog. - - > ### Note: - > If you face any issues during activation or the activation fails, then refer SAP Note [2904202](https://me.sap.com/notes/2904202) and proceed accordingly. - -12. On the resulting screen, choose *OK* once the status changes from *In Progress* to *Active*. - -13. Log out of *Integration Suite*. - -14. At this point, navigate back to the SAP BTP Cockpit and assign the following roles: - - - *APIManagement.Selfservice.Administrator*: This role is required for the onboarding of API Portal and to get access to its Settings page. - - - *AuthGroup.SelfService.Admin*: You'll need this role during the onboarding of API business hub enterprise and to get access to it. - - - To assign these roles: - - 1. Choose *Security* \> *Users* from the left navigation pane. - - 2. Select your username and under *Role Collections* section, choose *Assign Role Collection*. - - 3. In the resulting dialog box, select the *APIManagement.Selfservice.Administrator* and *AuthGroup.SelfService.Admin* roles and choose *Assign Role Collection*. - - -15. Once the roles are assigned, log on to the *Integration Suite*. - - > ### Note: - > If you are using a trial account, the account will be provisioned automatically. As a result, the option to access *APIs* will not appear under *Settings* in the side-navigation menu once the account is onboarded. During the provisioning process, the system will select the default virtual host for you. You will receive a notification indicating that the account is being provisioned. Once the process is complete, you will be automatically logged out of the Integration Suite. To continue, simply log in again. At this point, you will be able to create APIs, build API proxies as a service provider, and utilize other convenient services provided by the platform. - > - > Steps 16 and 17 are not applicable for the trial users. - -16. On the *Integration Suite* home page, choose *Settings* \> *APIs* from the left navigation pane. - -17. On the *Configure the API Management Service* screen, configure the following and choose *Set Up*: - - - Select the *Account type*: - - - Select the *Non Production* account type for non-business critical activities, such as integrating test systems, testing new scenarios, performance testing, and sandbox activities. - - Select the *Production* account type for business critical usages, such as integrating production systems, and productive APIs. - - - In the *Virtual Host* section, enter the *Host Alias*. - - - Provide an email ID in the *Notification Contact* field to receive updates. - - - In the *Set-up Confirmation* window, review the provided details and choose *Confirm* to start the onboarding process. - - You’re redirected to a progress window, which states *API Management Service Setup In Progress*. - - The *Configuration* process is triggered, where the necessary resources are provisioned for you. It’s followed by *Testing the Setup* process, where a simple API Proxy is deployed and invoked to check that everything is set up properly. - - When the processes complete, the indicators turn green to indicate that the processes are successful. A *Release Notification* mail is sent out to the email IDs provided in the *Configure the API Management Service* screen. This email contains details of the newly set up API Management service on your account. - - > ### Note: - > If the API Management Service Setup encounters an error or fails, the onboarding process will automatically retry the setup up to five times. If the same error or failure continues to occur, please report the issue by creating an incident in the [SAP Support Portal](https://support.sap.com/en/index.html). Please use the component OPU-API-OD-OPS for reporting. - - The API Management capability is now configured. - -18. You must log out of *Integration Suite* and log in again. - - You can now create APIs, build API proxies as a service provider, or use APIs and other convenient services. - - - - - - -## Next Steps - -After enabling the API Management capability, you need to first set up the service. For more information, see . - -**Related Information** - - -[Setting Up API Portal Application Using API Management Standalone Tile](setting-up-api-portal-application-using-api-management-standalone-tile-9d8c7ae.md "You can provision the API portal using the API Management, API Portal standalone tile from the SAP BTP cockpit.") - -[Assign User Roles in API Management](https://help.sap.com/viewer/de4066bb3f9240e3bfbcd5614e18c2f9/Cloud/en-US/911ca5a620e94ab581fa159d76b3b108.html "Use role collections to group together different roles that can be assigned to API Portal and API business hub enterprise users.") :arrow_upper_right: - -[Create an API Provider](../create-an-api-provider-6b263e2.md "Define the details of the host you want an application to reach by creating an API provider.") - -[Different Methods of Creating an API Proxy](../different-methods-of-creating-an-api-proxy-4ac0431.md "An API proxy is the data object that contains all the functionality to be executed when an external user wants to access the backend service.") - -[Configuring a Custom Domain for a Virtual Host](configuring-a-custom-domain-for-a-virtual-host-6b9e5a3.md "The API Management capability enables you to personalize the virtual host URL by configuring a custom domain of your choice. This means that you can have all your APIs displayed as "https://api.bestrun.com/..." if desired. Additionally, you have the option to set up multiple virtual hosts using the same custom domain, such as "https://api1.bestrun.com," "https://api2.bestrun.com," and so on.") - -[Configuring Mutual TLs for Virtual Host](configuring-mutual-tls-for-virtual-host-9faf7ce.md "You can configure mutual TLs for a virtual host, which validates the identities of both the web server and the web client.") - -[Cancel API Management Service Subscription](cancel-api-management-service-subscription-df6df2b.md "You can deactivate your API Management capability from Integration Suite to disable your account from the API Management service.") - diff --git a/docs/apim/API-Management/APIM-Initial-Setup/managing-cloud-foundry-microservices-through-api-management-e609a3e.md b/docs/apim/API-Management/APIM-Initial-Setup/managing-cloud-foundry-microservices-through-api-management-e609a3e.md index 7f863d63..98ddb873 100644 --- a/docs/apim/API-Management/APIM-Initial-Setup/managing-cloud-foundry-microservices-through-api-management-e609a3e.md +++ b/docs/apim/API-Management/APIM-Initial-Setup/managing-cloud-foundry-microservices-through-api-management-e609a3e.md @@ -93,7 +93,7 @@ Open the command-line interface for Cloud Foundry and enter the following comman **Related Information** -[Accessing API Management APIs Programmatically](accessing-api-management-apis-programmatically-24a2c37.md "The apiportal-apiaccess paln offers external applications the ability to access the public APIs of the Integration Suite API Management capability. These APIs are used by the external applications to perform CRUD operations on API Management features like API proxies or products. These APIs are built on REST and OData principles and are extensively documented on the Business Accelerator Hub.") +[Accessing API Management APIs Programmatically](accessing-api-management-apis-programmatically-24a2c37.md "The apiportal-apiaccess plan offers external applications the ability to access the public APIs of the Integration Suite API Management capability. These APIs are used by the external applications to perform CRUD operations on API Management features like API proxies or products. These APIs are built on REST and OData principles and are extensively documented on the Business Accelerator Hub.") [Accessing API business hub enterprise APIs Programmatically](accessing-api-business-hub-enterprise-apis-programmatically-dabee6e.md "The devportal-apiaccess plan allows you to access the API business hub enterprise APIs to programmatically onboard developers, create applications, and more.") diff --git a/docs/apim/API-Management/APIM-Initial-Setup/region-specific-ip-addresses-available-for-api-management-cloud-foundry-environ-585d639.md b/docs/apim/API-Management/APIM-Initial-Setup/region-specific-ip-addresses-available-for-api-management-cloud-foundry-environ-585d639.md index 74ff7a5b..5dfd969f 100644 --- a/docs/apim/API-Management/APIM-Initial-Setup/region-specific-ip-addresses-available-for-api-management-cloud-foundry-environ-585d639.md +++ b/docs/apim/API-Management/APIM-Initial-Setup/region-specific-ip-addresses-available-for-api-management-cloud-foundry-environ-585d639.md @@ -79,7 +79,7 @@ West Europe -51.105.226.79, 20.107.78.224, 20.4.205.181 +51.105.226.79, 20.107.78.224, 20.4.205.181, 108.143.96.175, 172.201.40.15, 20.31.245.126 @@ -239,7 +239,7 @@ East US -20.42.28.32, 20.25.8.237 +20.42.28.32 diff --git a/docs/apim/API-Management/APIM-Initial-Setup/set-up-api-business-hub-enterprise-application-using-the-standalone-tile-80c0519.md b/docs/apim/API-Management/APIM-Initial-Setup/set-up-api-business-hub-enterprise-application-using-the-standalone-tile-80c0519.md index f647a601..a66e5c11 100644 --- a/docs/apim/API-Management/APIM-Initial-Setup/set-up-api-business-hub-enterprise-application-using-the-standalone-tile-80c0519.md +++ b/docs/apim/API-Management/APIM-Initial-Setup/set-up-api-business-hub-enterprise-application-using-the-standalone-tile-80c0519.md @@ -25,7 +25,7 @@ To discover, consume and monitor API from a centralized API catalog, set up the ## Context -Depending upon the license you hold, you can use the *API Management, API Business Hub Enterprise* stand-alone tile to subscribe to the application, or you can set up the API business hub enterprise capability from the **Integration Suite** launchpad. To set up API business hub enterprise from **Integration Suite**, see [Enable API Management Capability](enable-api-management-capability-f6eb433.md). +Depending upon the license you hold, you can use the *API Management, API Business Hub Enterprise* stand-alone tile to subscribe to the application, or you can set up the API business hub enterprise capability from the **Integration Suite** launchpad. To set up API business hub enterprise from **Integration Suite**, see [Setting Up API Management Capability from Integration Suite](https://help.sap.com/viewer/de4066bb3f9240e3bfbcd5614e18c2f9/Cloud/en-US/f6eb4332cd5144ef91f4a84cc614ba1c.html "You can provision the API Management capability from the Integration Suite launchpad.") :arrow_upper_right:. > ### Note: > Ensure that you don’t have an instance of a starter plan created in the same subaccount where you plan to create an API business hub enterprise subscription. Also, note that the API Management capabilities from Integration Suite and API Management subscriptions using the stand-alone tile can’t coexist in the same subaccount. diff --git a/docs/apim/API-Management/APIM-Initial-Setup/set-up-api-portal-application-29c281b.md b/docs/apim/API-Management/APIM-Initial-Setup/set-up-api-portal-application-29c281b.md index e92fb32d..731b03a2 100644 --- a/docs/apim/API-Management/APIM-Initial-Setup/set-up-api-portal-application-29c281b.md +++ b/docs/apim/API-Management/APIM-Initial-Setup/set-up-api-portal-application-29c281b.md @@ -10,7 +10,7 @@ To create APIs, products, import policy templates, and view applications, set up ## Context -Depending upon the license you hold, you can set up the *API Management, API Portal* capability from the **Integration Suite** launchpad, or you can use the standalone tile for **API Management, API Portal** to subscribe to the API Portal application. +Depending upon the license you hold, you can set up the *API Management, API Portal* capability from the **Integration Suite** launchpad. For more information, see [Enable API Management Capability](https://help.sap.com/docs/integration-suite/sap-integration-suite/enabling-api-management-capability-from-integration-suite?version=CLOUD). You can also use the standalone tile for **API Management, API Portal** to subscribe to the API Portal application. See, [Set Up API business hub enterprise Application Using the Standalone Tile](set-up-api-business-hub-enterprise-application-using-the-standalone-tile-80c0519.md). > ### Note: > - You should either have **Integration Suite** subscription or **API Management, API Portal** tile visibility to set up the API Portal application. diff --git a/docs/apim/API-Management/APIM-Initial-Setup/setting-up-api-portal-application-using-api-management-standalone-tile-9d8c7ae.md b/docs/apim/API-Management/APIM-Initial-Setup/setting-up-api-portal-application-using-api-management-standalone-tile-9d8c7ae.md index 64037ea2..f089d6ca 100644 --- a/docs/apim/API-Management/APIM-Initial-Setup/setting-up-api-portal-application-using-api-management-standalone-tile-9d8c7ae.md +++ b/docs/apim/API-Management/APIM-Initial-Setup/setting-up-api-portal-application-using-api-management-standalone-tile-9d8c7ae.md @@ -121,8 +121,6 @@ Once API Business Hub Enterprise is set up, navigate to :gear: and choose *Conne **Related Information** -[Enable API Management Capability](enable-api-management-capability-f6eb433.md "You can provision the API Management capability from the Integration Suite launchpad.") - [Assign User Roles in API Management](https://help.sap.com/viewer/de4066bb3f9240e3bfbcd5614e18c2f9/Cloud/en-US/911ca5a620e94ab581fa159d76b3b108.html "Use role collections to group together different roles that can be assigned to API Portal and API business hub enterprise users.") :arrow_upper_right: [Cancel API Management Service Subscription](cancel-api-management-service-subscription-df6df2b.md "You can deactivate your API Management capability from Integration Suite to disable your account from the API Management service.") diff --git a/docs/apim/API-Management/archive-2023-a8dd11f.md b/docs/apim/API-Management/archive-2023-a8dd11f.md new file mode 100644 index 00000000..53cfb5f9 --- /dev/null +++ b/docs/apim/API-Management/archive-2023-a8dd11f.md @@ -0,0 +1,1510 @@ + + +# Archive 2023 + + + +**2023** + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +Technical Component + + + +Environment + + + +Title + + + +Description + + + +Action + + + +Lifecycle + + + +Type + + + +Line of Business + + + +Modular Business Process + + + +Product + + + +Latest Revision + + + +Available as of + +
+ +API Management + + + +- Cloud Foundry + + + + + +Client SDK version 1.5.2 + + + +In Cloud Foundry, authentication using X509 certificates and keys is now supported. Instead of using clientid, clientsecret, and tokenurl, you should now use certificate, privateKey, certUrl, and clientid. Additionally, security vulnerabilities reported in the SAP NOTE [https://me.sap.com/notes/3411067](https://me.sap.com/notes/3411067) have been fixed. For more information, please refer to : + +See the Client SDK version 1.5.2 in: [API Services](https://help.sap.com/docs/integration-suite/sap-integration-suite/api-services?version=CLOUD) \(SAP API Management customers choose: [API Services](https://help.sap.com/docs/sap-api-management/sap-api-management/api-services?q=certificate&version=Cloud)\) + + + +Info only + + + +General Availability + + + +New + + + +Technology + + + +Not applicable + + + +  + + + +2023-12-13 + + + +2023-12-13 + +
+ +API Management + + + +- Cloud Foundry + + + + + +Policy Template + + + +If there are any default fault rules or a post-client flow available within the API proxy, they will also be appended to the policy template. + +See: [Apply a Policy Template](https://help.sap.com/docs/integration-suite/sap-integration-suite/apply-policy-template) \(SAP API Management customers choose: [Apply a Policy Template](https://help.sap.com/docs/sap-api-management/sap-api-management/apply-policy-template)\) + + + +Info only + + + +General Availability + + + +Changed + + + +Technology + + + +Not applicable + + + +  + + + +2023-12-04 + + + +2023-12-04 + +
+ +API Management + + + +- Cloud Foundry + + + + + +Manage external content in API business hub enterprise + + + +The new *Manage External Content* option in *Enterprise Manager* enables you to configure additional content, such as Business Data Graphs \(BDGs\), for display on the API business hub enterprise. For more information, see [Manage External Content \(New Design\)](https://help.sap.com/docs/integration-suite/sap-integration-suite/manage-external-content-new-design). + + + +Info only + + + +General Availability + + + +New + + + +Technology + + + +Not applicable + + + +  + + + +2023-12-04 + + + +2023-12-04 + +
+ +API Management + + + +- Cloud Foundry + + + + + +Deprecation of Classic Design of API business hub enterprise + + + +The classic design of the API business hub enterprise will be deprecated soon. Starting from March 2024, the new design of the API business hub enterprise will become the default design. However, you’ll still be able to toggle between the new and old design until June 2024 using the *Set Default Design* feature in *Site Editor*. For more information, see + +See: [Customize the Visual Format of the API business hub enterprise](https://help.sap.com/docs/integration-suite/sap-integration-suite/customize-visual-format-of-api-business-hub-enterprise)\(SAP API Management customers choose: [Customize the Visual Format of the API business hub enterprise](https://help.sap.com/docs/sap-api-management/sap-api-management/customize-visual-format-of-api-business-hub-enterprise)\) + + + +Info only + + + +Deprecated + + + +Announcement + + + +Technology + + + +Not applicable + + + +  + + + +2023-12-04 + + + +2023-12-04 + +
+ +API Management + + + +- Cloud Foundry + + + + + +Auto-Registration of developers in API business hub enterprise + + + +If the AuthGroup.API.ApplicationDeveloper role is already assigned to you by the SAP BTP admin or via the IDP Role Collection mapping, you will get automatically registered as an application developer in API business hub enterprise when you logon for the first time. + +See: [Register on API business hub enterprise](register-on-api-business-hub-enterprise-c85fafe.md) \(SAP API Management customers choose: [Register on API business hub enterprise](https://help.sap.com/docs/sap-api-management/sap-api-management/register-on-api-business-hub-enterprise)\) + + + +Info only + + + +General Availability + + + +New + + + +Technology + + + +Not applicable + + + +  + + + +2023-12-04 + + + +2023-12-04 + +
+ +API Management + + + +- Cloud Foundry + + + + + +API Revisions + + + +Unique naming pattern for Drafts in API Revisions to clearly differentiate between the deployed draft and the working draft and the drafts originating from revisions. + +See: [Creating API Revisions](https://help.sap.com/docs/integration-suite/sap-integration-suite/creating-api-revisions) \(SAP API Management customers choose: [Creating API Revisions](https://help.sap.com/docs/sap-api-management/sap-api-management/creating-api-revisions-0a0d7d41222e42e4834b30c89609f400)\) + + + +Info only + + + +General Availability + + + +New + + + +Technology + + + +Not applicable + + + +  + + + +2023-10-30 + + + +2023-10-30 + +
+ +API Management + + + +- Cloud Foundry + + + + + +API Artifact in Edge Integration Cell + + + +With the introduction of the API artifact and the general availability of the Edge Integration Cell, a few navigation changes have been made to the Integration Suite API Management capability. The APIs and Policy Templates, previously located under *Design* \> *APIs* in the left navigation, have been moved to *Configure* \> *APIs*. Additionally, the term "APIs" is now referred to as "API Proxies." Furthermore, "Products" and "Applications", which were previously found under *Design* \> *APIs* can now be accessed through a new left navigation item called *Engage*. To know more, see [API Development](https://help.sap.com/docs/integration-suite/sap-integration-suite/manage-apis?version=CLOUD). + + + +Info only + + + +General Availability + + + +New + + + +Technology + + + +Not applicable + + + +  + + + +2023-10-30 + + + +2023-10-30 + +
+ +API Management + + + +- Cloud Foundry + + + + + +API Revisions + + + +When publishing products, it's important to note that resources are available from the deployed API, rather than from the latest revision or draft of the API. Additionally, if a deployed resource is not available in the latest revision, you won't be able to attach that resource to the product. + +The revision name now includes support for parentheses \(\) as an additional special character in the name. For more information, see . + +- : [API Revisions](https://help.sap.com/docs/integration-suite/sap-integration-suite/api-revisions) +- API Management standalone service: [API Revisions](https://help.sap.com/docs/sap-api-management/sap-api-management/api-revisions) + + + + + +Info only + + + +General Availability + + + +New + + + +Technology + + + +Not applicable + + + +  + + + +2023-09-30 + + + +2023-09-30 + +
+ +API Management + + + +- Cloud Foundry + + + + + +Certificate-based Credentials + + + +The connection between the centralised API business hub enterprise and the API portal has been secured with certificate-based authentication. For more information, see [Create a Connection Request for the Centralized API business hub enterprise \[Classic Design\]](APIM-Initial-Setup/create-a-connection-request-for-the-centralized-api-business-hub-enterprise-cla-02f7877.md) and [Create a Connection Request for the Centralized API business hub enterprise \[New Design\]](APIM-Initial-Setup/create-a-connection-request-for-the-centralized-api-business-hub-enterprise-new-c7bda8c.md). + + + +Info only + + + +General Availability + + + +New + + + +Technology + + + +Not applicable + + + +  + + + +2023-09-30 + + + +2023-09-30 + +
+ +API Management + + + +- Cloud Foundry + + + + + +Client SDK + + + +In Cloud Foundry, Authentication using the X509 certificate and key is now supported. Instead of clientid, clientsecret and tokenurl, use certificate, privateKey, certUrl and clientid. For more information, refer to the Client SDK version 1.5.0 in [API Services](api-services-007d50f.md). + + + +Info only + + + +General Availability + + + +New + + + +Technology + + + +Not applicable + + + +  + + + +2023-09-13 + + + +2023-09-13 + +
+ +API Management + + + +- Cloud Foundry + + + + + +API Revisions + + + +You can now create a new revision of your API and make necessary changes to the API definitions, policies, and resources without causing any disruption to the already published API. + +You can also see all the changes made to the API and restore the API to its previous state. For more information, see [API Revisions](api-revisions-58097ac.md). + + + +Info only + + + +General Availability + + + +New + + + +Technology + + + +Not applicable + + + +  + + + +2023-08-28 + + + +2023-08-28 + +
+ +API Management + + + +- Cloud Foundry + + + + + +Graph + + + +Graph is a new and innovative capability of API Management within SAP Integration Suite.It enables you to expose all your business data in the form of a semantically connected data graph, accessed via a single unified and powerful API. For more information, see [Activating and Managing Capabilities](https://help.sap.com/docs/integration-suite/sap-integration-suite/activating-and-managing-capabilities?version=CLOUD). + + + +Info only + + + +General Availability + + + +New + + + +Technology + + + +Not applicable + + + +  + + + +2023-07-17 + + + +2023-07-17 + +
+ +API Management + + + +- Cloud Foundry + + + + + +API business hub enterprise: Add Links and Email Addresses Using Markdown + + + +You can use markdown to add links and email addresses to the title and subtitle fields as part of the banner description in *Site Editor*. For more information, see [Customize the Visual Format of the API business hub enterprise](customize-the-visual-format-of-the-api-business-hub-enterprise-2eacd52.md). + + + +Info only + + + +General Availability + + + +New + + + +Technology + + + +Not applicable + + + +  + + + +2023-07-17 + + + +2023-07-17 + +
+ +API Management + + + +- Cloud Foundry + + + + + +Latest Version of the Tenant Cloning Tool + + + +The 1.7.2 version of the Tenant Cloning Tool is now available. For more information, see [Clone API Management Content](APIM-Migration/clone-api-management-content-7abd887.md) and [Clone API Management Content for Cloud Foundry to Cloud Foundry Migration](APIM-Migration/clone-api-management-content-for-cloud-foundry-to-cloud-foundry-migration-2e5d127.md). + + + +Info only + + + +General Availability + + + +New + + + +Technology + + + +Not applicable + + + +  + + + +2023-06-23 + + + +2023-06-23 + +
+ +API Management + + + +- Cloud Foundry + + + + + +Latest Version of the Tenant Cloning Tool + + + +The 1.7.1 version of the Tenant Cloning Tool is now available. For more information, see [Clone API Management Content](APIM-Migration/clone-api-management-content-7abd887.md) and [Clone API Management Content for Cloud Foundry to Cloud Foundry Migration](APIM-Migration/clone-api-management-content-for-cloud-foundry-to-cloud-foundry-migration-2e5d127.md). + + + +Info only + + + +General Availability + + + +New + + + +Technology + + + +Not applicable + + + +  + + + +2023-05-22 + + + +2023-05-22 + +
+ +API Management + + + +- Cloud Foundry + + + + + +Secure options to consume APIs + + + +We have introduced secure options to consume APIs using the API Access Plan for API portal, API business hub enterprise and on-premise connectivity. You can now create service keys with credential types "binding- secret", "instance- secret" and "x509". For more information, see [Accessing API Management APIs Programmatically](APIM-Initial-Setup/accessing-api-management-apis-programmatically-24a2c37.md), [Accessing API business hub enterprise APIs Programmatically](APIM-Initial-Setup/accessing-api-business-hub-enterprise-apis-programmatically-dabee6e.md) and [Accessing On-Premise Systems through API Management](APIM-Initial-Setup/accessing-on-premise-systems-through-api-management-2fc7a5b.md). + + + +Info only + + + +General Availability + + + +New + + + +Technology + + + +Not applicable + + + +  + + + +2023-05-08 + + + +2023-05-08 + +
+ +API Management + + + +- Cloud Foundry + + + + + +Short text field in API products. + + + +In the API portal, a new *Short Text* field is now available for products. You can use this field to add an introductory text to your products. When you add the introductory text in this field and publish the product, this short text appears in the product tile on the corresponding API business hub enterprise page and is also available on the API proxy details page. For more information, see [Create a Product](create-a-product-d769622.md). + + + +Info only + + + +General Availability + + + +New + + + +Technology + + + +Not applicable + + + +  + + + +2023-05-08 + + + +2023-05-08 + +
+ +API Management + + + +- Cloud Foundry + + + + + +API business hub enterprise \[New Design\] and \[Classic Design\] + + + +If you have defined the external documentation information for an API in the OpenAPI specification, you can access this information under the *Documentation* section in the API details page under the *Overview* tab. + + + +Info only + + + +General Availability + + + +New + + + +Technology + + + +Not applicable + + + +  + + + +2023-04-10 + + + +2023-04-10 + +
+ +API Management + + + +- Cloud Foundry + + + + + +API business hub enterprise + + + +\[New DesignThe Manage options \(for example Manage Users, Manage Domain\] Categories, and so on\) on the API business hub enterprise \[New Design\] header are now listed under *\[New DesignEnterprise Manager*. Based on the roles assigned to the users, these options will appear under the *Enterprise Manager* tab. For more information, see [Manage Domain Categories \[New Design\]](manage-domain-categories-new-design-bd9691d.md). + + + +Info only + + + +General Availability + + + + + + + +Technology + + + +Not applicable + + + +  + + + +2023-02-20 + + + +2023-02-20 + +
+ +API Management + + + +- Cloud Foundry + + + + + +API business hub enterprise \[New Design\] + + + +You can now configure notifications for providing information to the API business hub enterprise end users on any website updates, events or news items from the API business hub enterprise new user interface. For more information, see [Manage Notifications \[New Design\]](manage-notifications-new-design-df32457.md). + + + +Info only + + + +General Availability + + + +New + + + +Technology + + + +Not applicable + + + +  + + + +2023-02-20 + + + +2023-02-20 + +
+ +API Management + + + +- Cloud Foundry + + + + + +API business hub enterprise + + + +The mandatory Client ID and Client Secret fields on *Edit Credentials* popup have been replaced with *\*API Portal Access Credentials* field. For more information, see [Updating the Connection Request Credentials for a Pending Request \[New Design\]](APIM-Initial-Setup/updating-the-connection-request-credentials-for-a-pending-request-new-design-dd37a7b.md) and [Updating the Connection Request Credentials for a Submitted Request \[Classic Design\]](APIM-Initial-Setup/updating-the-connection-request-credentials-for-a-submitted-request-classic-des-eb84854.md). + + + +Info only + + + +General Availability + + + +New + + + +Technology + + + +Not applicable + + + +  + + + +2023-01-17 + + + +2023-01-17 + +
+ +API Management + + + +- Cloud Foundry + + + + + +Migrating API Management Subscription from One Cloud Foundry to Another Cloud Foundry Environment + + + +You can choose to migrate an existing API Management subscription that you have in the Cloud Foundry environment to another API Management subscription within the Cloud Foundry environment. This can be done to a different tenant within the same data center or to a tenant in a different data center. For more information, see [Migration of API Management Content between Cloud Foundry Environments](APIM-Migration/migration-of-api-management-content-between-cloud-foundry-environments-17f09f3.md). + + + +Info only + + + +General Availability + + + +New + + + +Technology + + + +Not applicable + + + +API Management + + + +2023-01-04 + + + +2023-01-04 + +
+ +**Related Information** + + +[2022 Archives](2022-archives-7eaa63d.md "") + +[2021 Archives](2021-archives-bdf0f0e.md "") + +[2020 Archives](2020-archives-085f4e9.md "") + diff --git a/docs/apim/API-Management/copy-an-api-proxy-23974d6.md b/docs/apim/API-Management/copy-an-api-proxy-23974d6.md index fc51da29..317e85b8 100644 --- a/docs/apim/API-Management/copy-an-api-proxy-23974d6.md +++ b/docs/apim/API-Management/copy-an-api-proxy-23974d6.md @@ -34,7 +34,7 @@ To copy an API proxy, proceed as follows: 3. On the *APIs* tab page, choose the Action icon against the required API and then select the *Copy* option. Alternatively, you can open the required API and in the details page select the option *Copy*. -4. In the *Copy API* dialog box, the details for each attribute is pre filled. *Name* and *API Base Path* fields should be unique. So, it is required to change the API name and basepath values. The values for the remaining fields can either be retained or changed. +4. In the *Copy API*, the details for each attribute is pre filled. The *Name* and *API Base Path* fields should be unique. So, it is required to change the API *Name* and *API Base Path* values. The values for the remaining fields \(*Title*, *Short Text*, *API State*, and *Host Alias*\) can either be reatined or changed. 1. Optional: Enter a version for your API proxy. diff --git a/docs/apim/API-Management/create-an-api-proxy-based-on-an-existing-api-proxy-54831ca.md b/docs/apim/API-Management/create-an-api-proxy-based-on-an-existing-api-proxy-54831ca.md index ac569558..485b674b 100644 --- a/docs/apim/API-Management/create-an-api-proxy-based-on-an-existing-api-proxy-54831ca.md +++ b/docs/apim/API-Management/create-an-api-proxy-based-on-an-existing-api-proxy-54831ca.md @@ -20,20 +20,23 @@ If you want to browse for an existing API proxy, proceed as follows: Create an A 6. Select the required API proxy. -7. Enter a name and description for the API. + > ### Note: + > The dropdown list contains the providers that you’re connected to. If the provider you need isn’t listed here, add it on the *Configure* tab. - The dropdown list contains the providers that you’re connected to. If the provider you need isn’t listed here, add it on the *Configure* tab. +7. The details of the API *Name*, *Title*, *API Base Path*, *API State*, *Host Alias* and *Service Type* are automatically populated. -8. Optionally, enter a *Version* for your API proxy. +8. Enter a short introductory text in the *Short Text* field. + +9. Optionally, enter a *Version* for your API proxy. When you choose to version your API proxy, its name is appended with the version, and its basepath are prepended with the version. For example, if the version you enter is v1, the name is Name\_v1, and the basepath is /v1/SalesOrder. For more information, see -9. Select a virtual host alias from the *Host Alias* dropdown. +10. Select a virtual host alias from the *Host Alias* dropdown. -10. In the *API Base Path* field, provide a path prefix for the API. +11. In the *API Base Path* field, provide a path prefix for the API. -11. Choose *Create*. +12. Choose *Create*. -12. Complete the remaining steps by referring to the [Create an API Proxy](create-an-api-proxy-c0842d5.md) topic. +13. Complete the remaining steps by referring to the [Create an API Proxy](create-an-api-proxy-c0842d5.md) topic. diff --git a/docs/apim/API-Management/create-an-api-proxy-by-providing-a-direct-target-endpoint-url-d0f5087.md b/docs/apim/API-Management/create-an-api-proxy-by-providing-a-direct-target-endpoint-url-d0f5087.md index dd00dc3d..396d35fc 100644 --- a/docs/apim/API-Management/create-an-api-proxy-by-providing-a-direct-target-endpoint-url-d0f5087.md +++ b/docs/apim/API-Management/create-an-api-proxy-by-providing-a-direct-target-endpoint-url-d0f5087.md @@ -25,7 +25,7 @@ The role collection *APIPortal.Administrator* should be assigned to you. > ### Note: > Ensure that the service URL you provide doesn’t redirect to a different URL. That is, check if the service URL you’re trying to access is temporarily or permanently moved to a different location. If it does so, then it’s recommended that you provide the new location \(redirected URL, if exists\) of the service. For more information about how to handle URL redirection, see [Handling URL Redirects in an API Proxy Using Policies](handling-url-redirects-in-an-api-proxy-using-policies-9e63c01.md). -3. Enter a name and description for the API. +3. Enter the *Name* and *Title*, and provide an introductory text in the *Short Text* field, for the API. 4. Optionally, enter a version for your API Proxy. @@ -55,7 +55,7 @@ The role collection *APIPortal.Administrator* should be assigned to you. > ### Note: > Ensure that the service URL you provide doesn’t redirect to a different URL. That is, check if the service URL you’re trying to access is temporarily or permanently moved to a different location. If it does so, then it’s recommended that you provide the new location \(redirected URL, if exists\) of the service. For more information about how to handle URL redirection, see [Handling URL Redirects in an API Proxy Using Policies](handling-url-redirects-in-an-api-proxy-using-policies-9e63c01.md). -3. Enter a name and description for the API. +3. Enter the *Name* and *Title*, and provide an introductory text in the *Short Text* field, for the API. 4. Optionally, enter a version for your API Proxy. diff --git a/docs/apim/API-Management/create-an-api-proxy-by-referring-to-an-api-provider-system-84628b9.md b/docs/apim/API-Management/create-an-api-proxy-by-referring-to-an-api-provider-system-84628b9.md index 83288d45..411fd2ca 100644 --- a/docs/apim/API-Management/create-an-api-proxy-by-referring-to-an-api-provider-system-84628b9.md +++ b/docs/apim/API-Management/create-an-api-proxy-by-referring-to-an-api-provider-system-84628b9.md @@ -32,24 +32,24 @@ If you want to browse for an OData service for a provider that you’ve already Also, since such APIs aren’t linked to any API provider, you can’t use the *Synchronize* option to update the API with the latest version that might be available in the backend. -7. Select a virtual host alias from the *Host Alias* dropdown. +7. The details of the API *Name*, *Title*, *API Base Path*, *API State*, *Host Alias* and *Service Type* are automatically populated. - The details of the API name, description, API base path, and service type are automatically populated. +8. Enter a short introductory text in the *Short Text* field. -8. Optionally, enter a *Version* for your API proxy. +9. Optionally, enter a *Version* for your API proxy. When you choose to version your API proxy, its name is appended with the version, and its basepath are prepended with the version. For example, if the version you enter is v1, the name is Name\_v1, and the basepath is /v1/SalesOrder. For more information, see [API Versioning](api-versioning-b3cda3b.md). -9. Choose *Create*. +10. Choose *Create*. -10. If you want to add SAP documentation annotations to the API documentation, choose *Yes* for *Documentation*. +11. If you want to add SAP documentation annotations to the API documentation, choose *Yes* for *Documentation*. > ### Note: > This field is only displayed if you’re fetching services from SAP Gateway Systems. For more information about SAP documentation annotations, see [Extended Support of Long Texts in the Metadata](http://help.sap.com/saphelp_gateway20sp10/helpdata/en/30/6e8c537c8fcc26e10000000a4450e5/frameset.htm). -11. Choose *Create*. +12. Choose *Create*. -12. Complete the remaining steps by referring to the [Create an API Proxy](create-an-api-proxy-c0842d5.md) topic. +13. Complete the remaining steps by referring to the [Create an API Proxy](create-an-api-proxy-c0842d5.md) topic. @@ -78,18 +78,18 @@ If you want to create a proxy for an Open Connector instance for a provider that Also, since such APIs aren’t linked to any API provider, you can’t use the *Synchronize* option to update the API with the latest version that might be available in the backend. -7. Select a virtual host alias from the *Host Alias* dropdown. - - The details of the API name, description, API base path, and service type are automatically populated. +7. The details of the API *Name*, *Title*, *API Base Path*, *API State*, *Host Alias* and *Service Type* are automatically populated. > ### Note: > Name and basepath shouldn’t contain spaces. -8. Optionally, enter a *Version* for your API proxy. +8. Enter a short introductory text in the *Short Text* field. + +9. Optionally, enter a *Version* for your API proxy. When you choose to version your API proxy, its name is appended with the version, and its basepath are prepended with the version. For example, if the version you enter is v1, the name is Name\_v1, and the basepath is /v1/SalesOrder. For more information, see [API Versioning](api-versioning-b3cda3b.md). -9. Choose *Create*. +10. Choose *Create*. On creating the proxy, an encrypted key value map is created with the following name `apim.oc.instance.token` and key name `default`. Also, an open connector policy is attached to the incoming POST flow request of the target endpoint of the APIProxy. @@ -106,8 +106,8 @@ If you want to create a proxy for an Open Connector instance for a provider that > > - On deleting the proxy, the encrypted key value map created above is also deleted. Further, while exporting the API, encrypted key value map created above isn’t exported with the API. -10. Choose *Create*. +11. Choose *Create*. -11. Complete the remaining steps by referring to the [Create an API Proxy](create-an-api-proxy-c0842d5.md) topic. +12. Complete the remaining steps by referring to the [Create an API Proxy](create-an-api-proxy-c0842d5.md) topic. diff --git a/docs/apim/API-Management/create-an-api-proxy-c0842d5.md b/docs/apim/API-Management/create-an-api-proxy-c0842d5.md index d2424a34..910566f4 100644 --- a/docs/apim/API-Management/create-an-api-proxy-c0842d5.md +++ b/docs/apim/API-Management/create-an-api-proxy-c0842d5.md @@ -258,9 +258,9 @@ Instead of consuming services directly, application developers can access API pr > > For more information on how to define multiple target endpoints using Route Rule, see [Enable Dynamic Routing](enable-dynamic-routing-49cbe91.md). -10. If you want to define multiple target endpoints, navigate to *Target EndPoint* tab. In the *Target Endpoint Properties*section, choose *Add*. +10. To define multiple target endpoints, navigate to the *Target EndPoint* tab and choose *Add*. - In the *Target Endpoint Properties*section, choose *Add*. Enter the *Property Name* and the *Values*. For the Target Endpoint property specifications, see [Target Endpoint Properties](target-endpoint-properties-edeed6a.md). + Enter the *Property Name* and the *Values*. For the Target Endpoint property specifications, see [Target Endpoint Properties](target-endpoint-properties-edeed6a.md). 11. Once you’ve filled in all the required details of the API, you can select one of the following two actions for the API: diff --git a/docs/apim/API-Management/creating-an-api-proxy-using-sap-cloud-integration-api-provider-aefbd74.md b/docs/apim/API-Management/creating-an-api-proxy-using-sap-cloud-integration-api-provider-aefbd74.md index 1ed51643..1d1766cd 100644 --- a/docs/apim/API-Management/creating-an-api-proxy-using-sap-cloud-integration-api-provider-aefbd74.md +++ b/docs/apim/API-Management/creating-an-api-proxy-using-sap-cloud-integration-api-provider-aefbd74.md @@ -90,7 +90,9 @@ Instead of directly consuming API services, application developers can access AP In the *Create API* dialog, the *API Details* consisting of *Name*, *Title*, *Description*, *Host Alias*, *API Base Path*, and *Service Type* are auto populated. - 7. Choose *Create*. + 7. Enter a short introductory text in the *Short Text* field. + + 8. Choose *Create*. An API provider is auto-created with the name that is populated in the *Name* field of the *Create API* dialog. This auto-created API provider helps in storing the user credentials provided in the *Authentication* dialog and connects to the API proxy. diff --git a/docs/apim/API-Management/creating-the-references-ddc5fdf.md b/docs/apim/API-Management/creating-the-references-ddc5fdf.md new file mode 100644 index 00000000..bb0b016b --- /dev/null +++ b/docs/apim/API-Management/creating-the-references-ddc5fdf.md @@ -0,0 +1,117 @@ + + +# Creating the References + +You can use the CertificateStoreReferences API to create a new certificate store reference. + + + + + +## Prerequisites + +- You must have a service key for the `APIPortal.Administrator` role. + + To know more about creating a service key for accessing APIs in the API portal, see the **Creating a Service Key** section in [Accessing API Management APIs Programmatically](APIM-Initial-Setup/accessing-api-management-apis-programmatically-24a2c37.md). + +- You have fetched a valid bearer token. To know more about obtaining a bearer token, see the **Obtaining a Bearer Token** section in [Accessing API Management APIs Programmatically](APIM-Initial-Setup/accessing-api-management-apis-programmatically-24a2c37.md). + + + + + +## Procedure + +1. Run the services using a standard REST console. + +2. Create a new certificate store reference using the below API: + + - Service URL: https:///apiportal/api/1.0/Management.svc/CertificateStoreReferences + - Method: POST + - Request Header: Authorization: Bearer + - Content Type: application/json + - Accept: application/json + - Request Body: + + > ### Sample Code: + > ``` + > { + > "name": "reference-name" + > "certificateStoreName": "store-name" + > } + > + > ``` + + > ### Note: + > - name - This is the name of the certificate store reference + > + > - certificateStoreName - This is the name of the certificate store to which this certificate store reference is pointing to + + + - CertificateStoreReference created successfully + + Response: 201 + + > ### Sample Code: + > ``` + > { + > "d": { + > "__metadata": { + > "id": "https:///apiportal/api/1.0/Management.svc/CertificateStoreReferences('reference_ts_1')", + > "uri": "https:///apiportal/api/1.0/Management.svc/CertificateStoreReferences('reference_ts_1')", + > "type": "apiportal.CertificateStoreReference" + > }, + > "certificateStoreName": "ts", + > "life_cycle": { + > "__metadata": { + > "type": "apiportal.History" + > }, + > "changed_at": "\/Date(1709793613017)\/", + > "changed_by": "sb-apiaccess1689070958781!b6077|api-portal-xsuaa!b2160", + > "created_at": "\/Date(1709793612858)\/", + > "created_by": "sb-apiaccess1689070958781!b6077|api-portal-xsuaa!b2160" + > }, + > "name": "reference_ts_1", + > "storeType": "TRUSTSTORE" + > } + > } + > ``` + + - When a CertificateStoreReference with the same name already exists + + Response: 400 Bad request: + + > ### Sample Code: + > ``` + > + > { + > "error": { + > "code": "CERTIFICATE_STORE_REFERENCE_NAME_DUPLICATION_ERROR", + > "message": { + > "lang": "en", + > "value": "A certificate store reference already exists with the same name. Please provide a different name and try creating again." + > } + > } + > } + > ``` + + - When no such certificate store exists with the given name + + Response: 400 Bad request + + > ### Sample Code: + > ``` + > + > { + > "error": { + > "code": "CERTIFICATE_STORE_REFERENCE_CREATE_FAILED_LINKED_CERTIFICATE_STORE_VALIDATION_ERROR", + > "message": { + > "lang": "en", + > "value": "The certificate store reference cannot be created as the certificate store name provided is invalid. Provide a correct certificate store name and try creating again." + > } + > } + > } + > ``` + + + diff --git a/docs/apim/API-Management/deleting-the-references-bd809db.md b/docs/apim/API-Management/deleting-the-references-bd809db.md new file mode 100644 index 00000000..2f0bfb15 --- /dev/null +++ b/docs/apim/API-Management/deleting-the-references-bd809db.md @@ -0,0 +1,56 @@ + + +# Deleting the References + +Use the CertificateStoreReference API to delete the certificate store reference via service calls. + + + + + +## Prerequisites + +- You must have a service key for the `APIPortal.Administrator` role. + + To know more about creating a service key for accessing APIs in the API portal, see the **Creating a Service Key** section in [Accessing API Management APIs Programmatically](APIM-Initial-Setup/accessing-api-management-apis-programmatically-24a2c37.md). + +- You have fetched a valid bearer token. To know more about obtaining a bearer token, see the **Obtaining a Bearer Token** section in [Accessing API Management APIs Programmatically](APIM-Initial-Setup/accessing-api-management-apis-programmatically-24a2c37.md). + + + + + +## Procedure + +1. Run the services using a standard REST console. + +2. Delete the certificate store reference using the below API: + + - Service URL: https:///apiportal/api/1.0/Management.svc/CertificateStoreReferences\(''\) + - Method: DELETE + - Request Header: Authorization: Bearer + - Accept:: application/json + - CertificateStoreReference deleted successfully. + + Response: 204: No Content + + - When no CertificateStoreReference entity exists with the given name + + Response: 400 Bad request + + > ### Sample Code: + > ``` + > + > { + > "error": { + > "code": "NO_SUCH_CERTIFICATE_STORE_REFERENCE_EXISTS", + > "message": { + > "lang": "en", + > "value": "No such certificate store reference exists. Please check the certificate store reference name and try again." + > } + > } + > } + > ``` + + + diff --git a/docs/apim/API-Management/monetize-apis-fcdc89b.md b/docs/apim/API-Management/monetize-apis-fcdc89b.md index 7f3aff23..c82420fc 100644 --- a/docs/apim/API-Management/monetize-apis-fcdc89b.md +++ b/docs/apim/API-Management/monetize-apis-fcdc89b.md @@ -13,5 +13,5 @@ provides this feature through the following services: - [Rate Plan Service](rate-plan-service-f4537ce.md) - [Billing Service](billing-service-1e20fb5.md) -If you were creating, updating, or reading an application using the APIs and not through the user interface, then you need to switch to Subscription entity from Application entity to use the Monetize feature. For more information see, [Create or Update or Read an Application using Subscription key](create-or-update-or-read-an-application-using-subscription-key-e2645b5.md) +If you were creating, updating, or reading an application using the APIs and not through the user interface, then you need to switch to Subscription entity from Application entity to use the Monetize feature. For more information, see [Create or Update or Read an Application using Subscription key](create-or-update-or-read-an-application-using-subscription-key-e2645b5.md) diff --git a/docs/apim/API-Management/reading-the-references-4f3d168.md b/docs/apim/API-Management/reading-the-references-4f3d168.md new file mode 100644 index 00000000..29e38176 --- /dev/null +++ b/docs/apim/API-Management/reading-the-references-4f3d168.md @@ -0,0 +1,69 @@ + + +# Reading the References + +Use the CertificateStoreReference API to get the list of certificate store references. + + + + + +## Prerequisites + +- You must have a service key for the `APIPortal.Administrator` role. + + To know more about creating a service key for accessing APIs in the API portal, see the **Creating a Service Key** section in [Accessing API Management APIs Programmatically](APIM-Initial-Setup/accessing-api-management-apis-programmatically-24a2c37.md). + +- You have fetched a valid bearer token. To know more about obtaining a bearer token, see the **Obtaining a Bearer Token** section in [Accessing API Management APIs Programmatically](APIM-Initial-Setup/accessing-api-management-apis-programmatically-24a2c37.md). + + + + + +## Procedure + +1. Run the services using a standard REST console. + +2. Get the list of all the certificate store references using the below API: + + - Service URL: https:///apiportal/api/1.0/Management.svc/CertificateStoreReferences + - Method: GET + - Request Header: Authorization: Bearer + - Accept: application/json + + - Fetches the list of all the certificate store references + + Response: 200 + + > ### Sample Code: + > ``` + > { + > "d": { + > "results": [ + > { + > "__metadata": { + > "id": "https:///apiportal/api/1.0/Management.svc/CertificateStoreReferences('reference_ts_1')", + > "uri": "https:///apiportal/api/1.0/Management.svc/CertificateStoreReferences('reference_ts_1')", + > "type": "apiportal.CertificateStoreReference" + > }, + > "certificateStoreName": "ts_1", + > "life_cycle": { + > "__metadata": { + > "type": "apiportal.History" + > }, + > "changed_at": "\/Date(1709810822439)\/", + > "changed_by": "sb-apiaccess1689070958781!b6077|api-portal-xsuaa!b2160", + > "created_at": "\/Date(1709793612858)\/", + > "created_by": "sb-apiaccess1689070958781!b6077|api-portal-xsuaa!b2160" + > }, + > "name": "reference_ts_1", + > "storeType": "TRUSTSTORE" + > }, + > ............... + > ] + > } + > } + > ``` + + + diff --git a/docs/apim/API-Management/updating-the-references-e2a9ec4.md b/docs/apim/API-Management/updating-the-references-e2a9ec4.md new file mode 100644 index 00000000..608c7f42 --- /dev/null +++ b/docs/apim/API-Management/updating-the-references-e2a9ec4.md @@ -0,0 +1,89 @@ + + +# Updating the References + +You can use the CertificateStoreReferences API to update a certificate store reference via service calls. + + + + + +## Prerequisites + +- You must have a service key for the `APIPortal.Administrator` role. + + To know more about creating a service key for accessing APIs in the API portal, see the **Creating a Service Key** section in [Accessing API Management APIs Programmatically](APIM-Initial-Setup/accessing-api-management-apis-programmatically-24a2c37.md). + +- You have fetched a valid bearer token. To know more about obtaining a bearer token, see the **Obtaining a Bearer Token** section in [Accessing API Management APIs Programmatically](APIM-Initial-Setup/accessing-api-management-apis-programmatically-24a2c37.md). + + + + + +## Procedure + +1. Run the services using a standard REST console. + +2. Create a new certificate store reference using the below API: + + - Service URL: https:///apiportal/api/1.0/Management.svc/CertificateStoreReferences\(''\) + - Method: PUT + - Request Header: Authorization: Bearer + - Content Type: application/json + - Accept: application/json + - Request Body: + + > ### Sample Code: + > ``` + > { + > "certificateStoreName": "updated-store-name" + > } + > + > ``` + + > ### Note: + > certificateStoreName - This is the name of the new certificate store to which this certificate store reference will point to. + + + - CertificateStoreReference updated successfully + + Response: 204 No Content + + - When no such CertificateStoreReference entity exists with the given name + + Response: 400 Bad request: + + > ### Sample Code: + > ``` + > { + > "error": { + > "code": "NO_SUCH_CERTIFICATE_STORE_REFERENCE_EXISTS", + > "message": { + > "lang": "en", + > "value": "No such certificate store reference exists. Please check the certificate store reference name and try again." + > } + > } + > } + > + > ``` + + - When no such certificate store store exists with the given name + + Response: 400 Bad request: + + > ### Sample Code: + > ``` + > { + > + > "error": { + > "code": "CERTIFICATE_STORE_REFERENCE_UPDATE_FAILED_LINKED_CERTIFICATE_STORE_VALIDATION_ERROR", + > "message": { + > "lang": "en", + > "value": "The certificate store reference cannot be updated as the certificate store name provided is invalid. Please provide a correct certificate store name and try creating again." + > } + > } + > } + > ``` + + + diff --git a/docs/apim/API-Management/what-s-new-for-sap-api-management-cloud-foundry-d9d60be.md b/docs/apim/API-Management/what-s-new-for-sap-api-management-cloud-foundry-d9d60be.md index 69d2ee10..deef0da1 100644 --- a/docs/apim/API-Management/what-s-new-for-sap-api-management-cloud-foundry-d9d60be.md +++ b/docs/apim/API-Management/what-s-new-for-sap-api-management-cloud-foundry-d9d60be.md @@ -6,7 +6,7 @@ -**2023** +**2024** @@ -87,96 +87,41 @@ API Management - - - - - - - - - - - - - - @@ -230,14 +175,14 @@ API Management @@ -296,14 +241,25 @@ API Management @@ -362,14 +318,14 @@ API Management @@ -428,14 +384,14 @@ API Management @@ -494,14 +450,14 @@ API Management @@ -626,18 +582,14 @@ API Management @@ -696,28 +648,14 @@ API Management @@ -842,78 +784,28 @@ API Management - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/apim/API-Management/working-with-references-6f96b64.md b/docs/apim/API-Management/working-with-references-6f96b64.md new file mode 100644 index 00000000..6b970ed3 --- /dev/null +++ b/docs/apim/API-Management/working-with-references-6f96b64.md @@ -0,0 +1,18 @@ + + +# Working with References + +A reference is a variable that holds the name of the keystore or truststore, instead of directly specifying the name in the virtual host configuration. + +The benefit of using a reference is that you can easily change the value of the reference to switch the keystore or truststore used by the virtual host. This is particularly useful when the current keystore or truststore's certificate is about to expire. + +> ### Note: +> References can only be used for the keystore and truststore, not for the certificates. +> +> When changing the reference to a keystore, make sure that the alias name of the certificate remains the same as in the old keystore. + +> ### Note: +> When configuring a virtual host, you have the option to specify a keystore or truststore using a reference. For more information on how to configure custom domain virtual host and client certificate based authentication using references, see [Configuring Additional Virtual Host in Cloud Foundry Environment](APIM-Initial-Setup/configuring-additional-virtual-host-in-cloud-foundry-environment-a7b91e5.md). + +You can create, update, fetch and delete any certificate store references via service calls. For more information, see the following: + diff --git a/docs/apim/index.md b/docs/apim/index.md index 5baa90b1..6e76d715 100644 --- a/docs/apim/index.md +++ b/docs/apim/index.md @@ -11,6 +11,7 @@ How to use SAP API Management - [Important Notes](API-Management/important-notes-36d2131.md) - [What's New for SAP API Management Cloud Foundry](API-Management/what-s-new-for-sap-api-management-cloud-foundry-d9d60be.md) - [Archive - Release Notes for SAP API Management](API-Management/archive-release-notes-for-sap-api-management-6adb6cd.md) + - [Archive 2023](API-Management/archive-2023-a8dd11f.md) - [2022 Archives](API-Management/2022-archives-7eaa63d.md) - [2021 Archives](API-Management/2021-archives-bdf0f0e.md) - [2020 Archives](API-Management/2020-archives-085f4e9.md) @@ -21,7 +22,6 @@ How to use SAP API Management - [Set Up API Portal Application](API-Management/APIM-Initial-Setup/set-up-api-portal-application-29c281b.md) - [Setting Up API Portal Application Using API Management Standalone Tile](API-Management/APIM-Initial-Setup/setting-up-api-portal-application-using-api-management-standalone-tile-9d8c7ae.md) - [Configuring Additional Virtual Host in Cloud Foundry Environment](API-Management/APIM-Initial-Setup/configuring-additional-virtual-host-in-cloud-foundry-environment-a7b91e5.md) - - [Enable API Management Capability](API-Management/APIM-Initial-Setup/enable-api-management-capability-f6eb433.md) - [Set Up API business hub enterprise Application Using the Standalone Tile](API-Management/APIM-Initial-Setup/set-up-api-business-hub-enterprise-application-using-the-standalone-tile-80c0519.md) - [API Management Service Plans](API-Management/APIM-Initial-Setup/api-management-service-plans-e064663.md) - [Accessing API Management APIs Programmatically](API-Management/APIM-Initial-Setup/accessing-api-management-apis-programmatically-24a2c37.md) @@ -130,6 +130,7 @@ How to use SAP API Management - [Create an API Proxy by Referring to an API Provider System](API-Management/create-an-api-proxy-by-referring-to-an-api-provider-system-84628b9.md) - [Create an API Proxy Based on an Existing API Proxy](API-Management/create-an-api-proxy-based-on-an-existing-api-proxy-54831ca.md) - [Create an API Proxy by Providing a Direct Target Endpoint URL](API-Management/create-an-api-proxy-by-providing-a-direct-target-endpoint-url-d0f5087.md) + - [Creating an API Proxy using SAP Cloud Integration API Provider](API-Management/creating-an-api-proxy-using-sap-cloud-integration-api-provider-aefbd74.md) - [Create an API Proxy Using the API Designer](API-Management/create-an-api-proxy-using-the-api-designer-26e1bbd.md) - [OpenAPI Specification 3.0](API-Management/openapi-specification-3-0-3ce080d.md) - [API Designer](API-Management/api-designer-51f3ca1.md) @@ -158,6 +159,11 @@ How to use SAP API Management - [Update a Key Value Map](API-Management/update-a-key-value-map-4961431.md) - [Delete a Key Value Map](API-Management/delete-a-key-value-map-24fbb01.md) - [Manage Certificates](API-Management/manage-certificates-c665875.md) + - [Working with References](API-Management/working-with-references-6f96b64.md) + - [Creating the References](API-Management/creating-the-references-ddc5fdf.md) + - [Updating the References](API-Management/updating-the-references-e2a9ec4.md) + - [Reading the References](API-Management/reading-the-references-4f3d168.md) + - [Deleting the References](API-Management/deleting-the-references-bd809db.md) - [Create a Policy Template](API-Management/create-a-policy-template-c5d1872.md) - [Apply a Policy Template](API-Management/apply-a-policy-template-2ceab71.md) - [Update a Policy Template](API-Management/update-a-policy-template-269442f.md) @@ -183,7 +189,6 @@ How to use SAP API Management - [Enable Streaming of Requests and Responses in an API Proxy](API-Management/enable-streaming-of-requests-and-responses-in-an-api-proxy-b43d826.md) - [Enable Dynamic Routing](API-Management/enable-dynamic-routing-49cbe91.md) - [Overriding the Default Update Operation for API Proxy of Type OData](API-Management/overriding-the-default-update-operation-for-api-proxy-of-type-odata-4a12c59.md) - - [Creating an API Proxy using SAP Cloud Integration API Provider](API-Management/creating-an-api-proxy-using-sap-cloud-integration-api-provider-aefbd74.md) - [Custom Attributes](API-Management/custom-attributes-90a5a6d.md) - [Add Custom Attributes to a Product](API-Management/add-custom-attributes-to-a-product-e46a874.md) - [Add Custom Attributes to an Application](API-Management/add-custom-attributes-to-an-application-39c3cbd.md) diff --git a/docs/ci/Development/define-a-timer-start-event-ae14ad7.md b/docs/ci/Development/define-a-timer-start-event-ae14ad7.md index 9abb31e5..d60291ba 100644 --- a/docs/ci/Development/define-a-timer-start-event-ae14ad7.md +++ b/docs/ci/Development/define-a-timer-start-event-ae14ad7.md @@ -16,7 +16,7 @@ If you want to configure a process to automatically start and run on a particula > ### Remember: > - When you deploy or undeploy an integration flow with *Scheduler*, the system automatically releases all the scheduler locks. > -> - When you deploy small integration flows with *Timer* \(for example, an integration flow with timer, content modifier and mail adapter\), due to fast processing times, multiple schedules are triggered. +> - When you deploy small integration flows with *Timer* \(for example, an integration flow with timer, content modifier and mail adapter\), due to fast processing times, multiple schedules are triggered. When you deploy small integration flows with *Timer* \(for example, an integration flow with timer, content modifier and mail adapter\), due to fast processing times, multiple schedules are triggered. > > - If the *Timer* is configured to trigger message processing at periodic intervals and the processing isn’t completed before the next scheduled interval, then the *Timer* skips the following interval. >
-Self-Service for Administrators to Update Custom Domain Certificate - - - -When configuring a custom virtual host to support TLS, you can specify a keystore or truststore by using a reference. A reference is a variable that holds the name of the keystore or truststore, instead of directly specifying the name. - -See: [Working with References](https://help.sap.com/docs/integration-suite/sap-integration-suite/configuring-references-to-keystore-and-truststore?version=CLOUD) \(SAP API Management customers choose: [Working with References](https://help.sap.com/docs/sap-api-management/sap-api-management/configuring-references-to-keystore-and-truststore?version=Cloud) - - - -Info only - - - -General Availability - - - -New - - - -Technology +Short Text -Not applicable +As an API portal administrator, you now have the ability to include a short introductory text in the *Short Text* field when creating an API proxy. This text will be displayed on the details page of the API proxy once you publish it to the API business hub enterprise. Furthermore, this field will also appear when you copy an API. However, during the copy action, the *Short Text* field will be pre-filled along with all other fields. - +See: -  +- [Create an API Proxy by Referring to an API Provider System](https://help.sap.com/docs/integration-suite/sap-integration-suite/create-api-proxy-by-referring-to-api-provider-system?version=CLOUD) - +- [Create an API Proxy Based on an Existing API Proxy](https://help.sap.com/docs/integration-suite/sap-integration-suite/create-api-proxy-based-on-existing-api-proxy?version=CLOUD) -2024-04-12 +- [Create an API Proxy by Providing a Direct Target Endpoint URL](https://help.sap.com/docs/integration-suite/sap-integration-suite/create-api-proxy-by-providing-direct-target-endpoint-url?version=CLOUD) - +- [Copy an API Proxy](https://help.sap.com/docs/integration-suite/sap-integration-suite/copy-api?version=CLOUD) -2024-04-12 -
+SAP API Management customers choose: -API Management +- [Create an API Proxy by Referring to an API Provider System](https://help.sap.com/docs/sap-api-management/sap-api-management/create-api-proxy-by-referring-to-api-provider-system?version=Cloud) - +- [Create an API Proxy Based on an Existing API Proxy](https://help.sap.com/docs/sap-api-management/sap-api-management/create-api-proxy-based-on-existing-api-proxy?version=Cloud) -- Cloud Foundry +- [Create an API Proxy by Providing a Direct Target Endpoint URL](https://help.sap.com/docs/sap-api-management/sap-api-management/create-api-proxy-by-providing-direct-target-endpoint-url?version=Cloud) +- [Copy an API Proxy](https://help.sap.com/docs/sap-api-management/sap-api-management/copy-api?version=Cloud) - -Flow Variables -When executing API proxies created using the on-prem API provider, the backend response may contain URLs that include the API Provider's internal host and port values. These values should not be revealed to API consumers and are not usable. - -To address this issue, the following flow variables have been added to the on-premise proxy so that the API Provider's internal host and port values can be replaced with the virtual host and port values: - -- onpremise.target.host - -- onpremise.target.port - -- onpremise.target.basepath - - -These variables ensure that API consumers are not exposed to the internal details of the API provider. - -See: [FlowVariables](https://help.sap.com/docs/integration-suite/sap-integration-suite/flow-variables?version=CLOUD) \(SAP API Management customers choose: [Flow Variables](https://help.sap.com/docs/sap-api-management/sap-api-management/flow-variables?locale=en-US&version=Cloud) - - -Info only @@ -206,12 +151,12 @@ Not applicable -2024-12-04 +2024-05-06 -2024-12-04 +2024-05-06
-mTLS Authentication +Self-Service for Administrators to Update Custom Domain Certificate -You can now utilize certificate-based credentials to seamlessly migrate API Management subscriptions from Neo to Cloud Foundry, as well as between same or different Cloud Foundry environments. +When configuring a custom virtual host to support TLS, you can specify a keystore or truststore by using a reference. A reference is a variable that holds the name of the keystore or truststore, instead of directly specifying the name. -See: [Clone API Management Content](https://help.sap.com/docs/integration-suite/sap-integration-suite/clone-api-management-artifacts?version=CLOUD) and [Clone API Management Content for Cloud Foundry to Cloud Foundry Migration](https://help.sap.com/docs/integration-suite/sap-integration-suite/clone-api-management-artifacts-during-cloud-foundry-to-cloud-foundry-migration?version=CLOUD) \(SAP API Management customers choose: [Clone API Management Artifacts](https://help.sap.com/docs/sap-api-management/sap-api-management/clone-api-management-artifacts?version=Cloud)and [Clone API Management Artifacts During Cloud Foundry to Cloud Foundry Migration](https://help.sap.com/docs/sap-api-management/sap-api-management/clone-api-management-artifacts-during-cloud-foundry-to-cloud-foundry-migration?version=Cloud) +See: [Working with References](https://help.sap.com/docs/integration-suite/sap-integration-suite/configuring-references-to-keystore-and-truststore?version=CLOUD) \(SAP API Management customers choose: [Working with References](https://help.sap.com/docs/sap-api-management/sap-api-management/configuring-references-to-keystore-and-truststore?version=Cloud) @@ -272,12 +217,12 @@ Not applicable -2024-04-04 +2024-04-06 -2024-04-04 +2024-04-06
-Client SDK version 1.6.0 +Flow Variables -The outdated libraries in the Client SDK have been upgraded to the latest version. +When executing API proxies created using the on-prem API provider, the backend response may contain URLs that include the API Provider's internal host and port values. These values should not be revealed to API consumers and are not usable. -See the Client SDK version 1.6.0 in: [API Services](https://help.sap.com/docs/integration-suite/sap-integration-suite/api-services?version=CLOUD) \(SAP API Management customers choose: [API Services](https://help.sap.com/docs/sap-api-management/sap-api-management/api-services?q=certificate&version=Cloud)\) +To address this issue, the following flow variables have been added to the on-premise proxy so that the API Provider's internal host and port values can be replaced with the virtual host and port values: + +- onpremise.target.host + +- onpremise.target.port + +- onpremise.target.basepath + + +These variables ensure that API consumers are not exposed to the internal details of the API provider. + +See: [Flow Variables](https://help.sap.com/docs/integration-suite/sap-integration-suite/flow-variables?version=CLOUD) \(SAP API Management customers choose: [Flow Variables](https://help.sap.com/docs/sap-api-management/sap-api-management/flow-variables?locale=en-US&version=Cloud)\) @@ -338,12 +294,12 @@ Not applicable -2024-03-22 +2024-04-06 -2024-04-22 +2024-04-06
-Self-Service for Administrators to Update Custom Domain Certificate +mTLS Authentication -The recent update allows for the configuration of additional virtual hosts in the Cloud Foundry environment. This can be done with either a default domain or a custom domain. Additionally, existing virtual hosts can now have their alias, keystore, keyalias, and truststore updated. This eliminates the need for the SAP Operations team to manually upload certificates in order to complete the configuration. +You can now utilize certificate-based credentials to seamlessly migrate API Management subscriptions from Neo to Cloud Foundry, as well as between same or different Cloud Foundry environments. -See: [Configuring Additional Virtual Host in Cloud Foundry Environment](https://help.sap.com/docs/integration-suite/sap-integration-suite/requesting-additional-virtual-host-in-cloud-foundry-environment?version=CLOUD) \(SAP API Management customers choose: [Configuring Additional Virtual Host in Cloud Foundry Environment](https://help.sap.com/docs/sap-api-management/sap-api-management/configuring-additional-virtual-host-in-cloud-foundry-environment?version=Cloud)\) +See: [Clone API Management Content](https://help.sap.com/docs/integration-suite/sap-integration-suite/clone-api-management-artifacts?version=CLOUD) and [Clone API Management Content for Cloud Foundry to Cloud Foundry Migration](https://help.sap.com/docs/integration-suite/sap-integration-suite/clone-api-management-artifacts-during-cloud-foundry-to-cloud-foundry-migration?version=CLOUD) \(SAP API Management customers choose: [Clone API Management Artifacts](https://help.sap.com/docs/sap-api-management/sap-api-management/clone-api-management-artifacts?version=Cloud)and [Clone API Management Artifacts During Cloud Foundry to Cloud Foundry Migration](https://help.sap.com/docs/sap-api-management/sap-api-management/clone-api-management-artifacts-during-cloud-foundry-to-cloud-foundry-migration?version=Cloud)\) @@ -404,12 +360,12 @@ Not applicable -2024-03-09 +2024-04-04 -2024-03-09 +2024-04-04
-Manage Access in API business hub enterprise +Client SDK version 1.6.0 -As an API business hub enterprise admin, you now have the ability to manage access control checks for users to search, discover, and consume the content. +The outdated libraries in the Client SDK have been upgraded to the latest version. -See: [Manage Access](https://help.sap.com/docs/integration-suite/sap-integration-suite/manage-access?version=CLOUD) \(SAP API Management customers choose: [Manage Access](https://help.sap.com/docs/sap-api-management/sap-api-management/manage-access?version=Cloud&q=Manage%20Access) +See the Client SDK version 1.6.0 in: [API Services](https://help.sap.com/docs/integration-suite/sap-integration-suite/api-services?version=CLOUD) \(SAP API Management customers choose: [API Services](https://help.sap.com/docs/sap-api-management/sap-api-management/api-services?q=certificate&version=Cloud)\) @@ -470,12 +426,12 @@ Not applicable -2024-03-09 +2024-03-22 -2024-03-09 +2024-03-22
-Deprecation of Classic Design +Self-Service for Administrators to Update Custom Domain Certificate -Effective June 2024, the classic design of the API business hub enterprise will be deprecated and will no longer be accessible. The new design of the API business hub enterprise will be set as your default design from March 2024. +The recent update allows for the configuration of additional virtual hosts in the Cloud Foundry environment. This can be done with either a default domain or a custom domain. Additionally, existing virtual hosts can now have their alias, keystore, keyalias, and truststore updated. This eliminates the need for the SAP Operations team to manually upload certificates in order to complete the configuration. -See: [Configure the API business hub enterprise \[New Design\]](https://help.sap.com/docs/integration-suite/sap-integration-suite/configure-api-business-hub-enterprise-new-design?version=CLOUD) \(SAP API Management customers choose: [Configure the API business hub enterprise \[New Design\]](https://help.sap.com/docs/sap-api-management/sap-api-management/configure-api-business-hub-enterprise-new-design?version=Cloud)\) +See: [Configuring Additional Virtual Host in Cloud Foundry Environment](https://help.sap.com/docs/integration-suite/sap-integration-suite/requesting-additional-virtual-host-in-cloud-foundry-environment?version=CLOUD) \(SAP API Management customers choose: [Configuring Additional Virtual Host in Cloud Foundry Environment](https://help.sap.com/docs/sap-api-management/sap-api-management/configuring-additional-virtual-host-in-cloud-foundry-environment?version=Cloud)\) @@ -511,7 +467,7 @@ Info only -Restricted Availability +General Availability @@ -560,14 +516,14 @@ API Management -Threshold Value for Charts in Advanced API Analytics +Manage Access in API business hub enterprise -In the analytics dashboard, the values on the chart for a particular dimension are shown only up to a certain threshold. Any values beyond this threshold are grouped together and labeled as **Others**. By default, the threshold value for the charts is set to 25. +As an API business hub enterprise admin, you now have the ability to manage access control checks for users to search, discover, and consume the content. -See: [Find Your Way around Advanced API Analytics Dashboard](https://help.sap.com/docs/integration-suite/sap-integration-suite/find-your-way-around-advanced-api-analytics-dashboard?version=CLOUD#report-pages) \(SAP API Management customers choose: [Find Your Way around Advanced API Analytics Dashboard](https://help.sap.com/docs/sap-api-management/sap-api-management/find-your-way-around-advanced-api-analytics-dashboard?version=Cloud#report-pages)\) +See: [Manage Access](https://help.sap.com/docs/integration-suite/sap-integration-suite/manage-access?version=CLOUD) \(SAP API Management customers choose: [Manage Access](https://help.sap.com/docs/sap-api-management/sap-api-management/manage-access?version=Cloud&q=Manage%20Access) @@ -602,12 +558,12 @@ Not applicable -2024-01-20 +2024-03-09 -2024-01-20 +2024-03-09
-Deprecation of Weak Client Certificate Chains in API Management +Deprecation of Classic Design -Weak client certificate chains have been deprecated to enhance the security standards. - -Consequently, the OpenSSL security level has been increased to level 2, which means that weak certificates or certificate chains will no longer be accepted by the platform. For a comprehensive definition of security level 2 and further information, please see [https://www.openssl.org/docs/man3.0/man3/SSL\_CTX\_set\_security\_level.html\#DEFAULT-CALLBACK-BEHAVIOURInformation](https://www.openssl.org/docs/man3.0/man3/SSL_CTX_set_security_level.html#DEFAULT-CALLBACK-BEHAVIOURInformation) published on non-SAP site. - -Please note that this change only affects client certificates. If you do not utilize client certificates or mTLS for authentication with the platform, you will not be affected. +Effective June 2024, the classic design of the API business hub enterprise will be deprecated and will no longer be accessible. The new design of the API business hub enterprise will be set as your default design from March 2024. -For additional details on the command, please see [3418201 - Deprecation of Weak Client Certificate Chains in API Management \(sap.corp\)](https://i7p.wdf.sap.corp/sap(bD1lbiZjPTAwMQ==)/bc/bsp/sno/ui_entry/entry.htm?param=69765F6D6F64653D3030312669765F7361706E6F7465735F6E756D6265723D3334313832303126) published on the SAP site. +See: [Configure the API business hub enterprise \[New Design\]](https://help.sap.com/docs/integration-suite/sap-integration-suite/configure-api-business-hub-enterprise-new-design?version=CLOUD) \(SAP API Management customers choose: [Configure the API business hub enterprise \[New Design\]](https://help.sap.com/docs/sap-api-management/sap-api-management/configure-api-business-hub-enterprise-new-design?version=Cloud)\) @@ -647,12 +599,12 @@ Info only -Deprecated +Restricted Availability -Announcement +New @@ -672,12 +624,12 @@ Not applicable -2024-01-20 +2024-03-09 -2024-01-20 +2024-03-09
-Expiration Period for Credentials +Threshold Value for Charts in Advanced API Analytics -The expiration period for the credentials needed to establish a connection to the centralized API business hub enterprise has been extended to 365 days from 65 days. Please make sure to regenerate the credentials and reestablish the connection within this timeframe. However, any credentials generated prior to February 2024 with a validity of 65 days will remain valid for that specific duration. The 365-day timeframe will apply to all newly generated credentials. - -See: - -- [Updating the Connection Request Credentials for a Pending Request](https://help.sap.com/docs/integration-suite/sap-integration-suite/updating-connection-request-credentials-for-pending-request-new-design?q=centralised) - -- [Updating the Connection Request Credentials for an Approved Request](https://help.sap.com/docs/integration-suite/sap-integration-suite/updating-connection-request-credentials-for-approved-request-new-design?version=CLOUD) - - -SAP API Management customers choose: - -- [Updating the Connection Request Credentials for a Pending Request](https://help.sap.com/docs/sap-api-management/sap-api-management/updating-connection-request-credentials-for-pending-request-new-design?version=Cloud) - -- [Updating the Connection Request Credentials for an Approved Request](https://help.sap.com/docs/sap-api-management/sap-api-management/updating-connection-request-credentials-for-approved-request-new-design?version=Cloud) - - +In the analytics dashboard, the values on the chart for a particular dimension are shown only up to a certain threshold. Any values beyond this threshold are grouped together and labeled as **Others**. By default, the threshold value for the charts is set to 25. +See: [Find Your Way around Advanced API Analytics Dashboard](https://help.sap.com/docs/integration-suite/sap-integration-suite/find-your-way-around-advanced-api-analytics-dashboard?version=CLOUD#report-pages) \(SAP API Management customers choose: [Find Your Way around Advanced API Analytics Dashboard](https://help.sap.com/docs/sap-api-management/sap-api-management/find-your-way-around-advanced-api-analytics-dashboard?version=Cloud#report-pages)\) @@ -776,14 +714,18 @@ API Management -Client SDK version 1.5.2 +Deprecation of Weak Client Certificate Chains in API Management -In Cloud Foundry, authentication using X509 certificates and keys is now supported. Instead of using clientid, clientsecret, and tokenurl, you should now use certificate, privateKey, certUrl, and clientid. Additionally, security vulnerabilities reported in the SAP NOTE [https://me.sap.com/notes/3411067](https://me.sap.com/notes/3411067) have been fixed. For more information, please refer to : +Weak client certificate chains have been deprecated to enhance the security standards. + +Consequently, the OpenSSL security level has been increased to level 2, which means that weak certificates or certificate chains will no longer be accepted by the platform. For a comprehensive definition of security level 2 and further information, please see [https://www.openssl.org/docs/man3.0/man3/SSL\_CTX\_set\_security\_level.html\#DEFAULT-CALLBACK-BEHAVIOURInformation](https://www.openssl.org/docs/man3.0/man3/SSL_CTX_set_security_level.html#DEFAULT-CALLBACK-BEHAVIOURInformation) published on non-SAP site. + +Please note that this change only affects client certificates. If you do not utilize client certificates or mTLS for authentication with the platform, you will not be affected. -See the Client SDK version 1.5.2 in: [API Services](https://help.sap.com/docs/integration-suite/sap-integration-suite/api-services?version=CLOUD) \(SAP API Management customers choose: [API Services](https://help.sap.com/docs/sap-api-management/sap-api-management/api-services?q=certificate&version=Cloud)\) +For additional details on the command, please see [3418201 - Deprecation of Weak Client Certificate Chains in API Management \(sap.corp\)](https://i7p.wdf.sap.corp/sap(bD1lbiZjPTAwMQ==)/bc/bsp/sno/ui_entry/entry.htm?param=69765F6D6F64653D3030312669765F7361706E6F7465735F6E756D6265723D3334313832303126) published on the SAP site. @@ -793,12 +735,12 @@ Info only -General Availability +Deprecated -New +Announcement @@ -818,12 +760,12 @@ Not applicable -2023-12-13 +2024-01-20 -2023-12-13 +2024-01-20
-Policy Template - - - -If there are any default fault rules or a post-client flow available within the API proxy, they will also be appended to the policy template. - -See: [Apply a Policy Template](https://help.sap.com/docs/integration-suite/sap-integration-suite/apply-policy-template) \(SAP API Management customers choose: [Apply a Policy Template](https://help.sap.com/docs/sap-api-management/sap-api-management/apply-policy-template)\) - - - -Info only - - - -General Availability - - - -Changed - - - -Technology - - - -Not applicable - - - -  - - - -2023-12-04 +Expiration Period for Credentials -2023-12-04 +The expiration period for the credentials needed to establish a connection to the centralized API business hub enterprise has been extended to 365 days from 65 days. Please make sure to regenerate the credentials and reestablish the connection within this timeframe. However, any credentials generated prior to February 2024 with a validity of 65 days will remain valid for that specific duration. The 365-day timeframe will apply to all newly generated credentials. -
+See: -API Management +- [Updating the Connection Request Credentials for a Pending Request](https://help.sap.com/docs/integration-suite/sap-integration-suite/updating-connection-request-credentials-for-pending-request-new-design?q=centralised) - +- [Updating the Connection Request Credentials for an Approved Request](https://help.sap.com/docs/integration-suite/sap-integration-suite/updating-connection-request-credentials-for-approved-request-new-design?version=CLOUD) -- Cloud Foundry +SAP API Management customers choose: +- [Updating the Connection Request Credentials for a Pending Request](https://help.sap.com/docs/sap-api-management/sap-api-management/updating-connection-request-credentials-for-pending-request-new-design?version=Cloud) - +- [Updating the Connection Request Credentials for an Approved Request](https://help.sap.com/docs/sap-api-management/sap-api-management/updating-connection-request-credentials-for-approved-request-new-design?version=Cloud) -Manage external content in API business hub enterprise - -The new *Manage External Content* option in *Enterprise Manager* enables you to configure additional content, such as Business Data Graphs \(BDGs\), for display on the API business hub enterprise. For more information, see [Manage External Content \(New Design\)](https://help.sap.com/docs/integration-suite/sap-integration-suite/manage-external-content-new-design). @@ -948,1243 +840,12 @@ Not applicable -2023-12-04 - - - -2023-12-04 - -
- -API Management - - - -- Cloud Foundry - - +2024-01-20 -Deprecation of Classic Design of API business hub enterprise - - - -The classic design of the API business hub enterprise will be deprecated soon. Starting from March 2024, the new design of the API business hub enterprise will become the default design. However, you’ll still be able to toggle between the new and old design until June 2024 using the *Set Default Design* feature in *Site Editor*. For more information, see - -See: [Customize the Visual Format of the API business hub enterprise](https://help.sap.com/docs/integration-suite/sap-integration-suite/customize-visual-format-of-api-business-hub-enterprise)\(SAP API Management customers choose: [Customize the Visual Format of the API business hub enterprise](https://help.sap.com/docs/sap-api-management/sap-api-management/customize-visual-format-of-api-business-hub-enterprise)\) - - - -Info only - - - -Deprecated - - - -Announcement - - - -Technology - - - -Not applicable - - - -  - - - -2023-12-04 - - - -2023-12-04 - -
- -API Management - - - -- Cloud Foundry - - - - - -Auto-Registration of developers in API business hub enterprise - - - -If the AuthGroup.API.ApplicationDeveloper role is already assigned to you by the SAP BTP admin or via the IDP Role Collection mapping, you will get automatically registered as an application developer in API business hub enterprise when you logon for the first time. - -See: [Register on API business hub enterprise](register-on-api-business-hub-enterprise-c85fafe.md) \(SAP API Management customers choose: [Register on API business hub enterprise](https://help.sap.com/docs/sap-api-management/sap-api-management/register-on-api-business-hub-enterprise)\) - - - -Info only - - - -General Availability - - - -New - - - -Technology - - - -Not applicable - - - -  - - - -2023-12-04 - - - -2023-12-04 - -
- -API Management - - - -- Cloud Foundry - - - - - -API Revisions - - - -Unique naming pattern for Drafts in API Revisions to clearly differentiate between the deployed draft and the working draft and the drafts originating from revisions. - -See: [Creating API Revisions](https://help.sap.com/docs/integration-suite/sap-integration-suite/creating-api-revisions) \(SAP API Management customers choose: [Creating API Revisions](https://help.sap.com/docs/sap-api-management/sap-api-management/creating-api-revisions-0a0d7d41222e42e4834b30c89609f400)\) - - - -Info only - - - -General Availability - - - -New - - - -Technology - - - -Not applicable - - - -  - - - -2023-10-30 - - - -2023-10-30 - -
- -API Management - - - -- Cloud Foundry - - - - - -API Artifact in Edge Integration Cell - - - -With the introduction of the API artifact and the general availability of the Edge Integration Cell, a few navigation changes have been made to the Integration Suite API Management capability. The APIs and Policy Templates, previously located under *Design* \> *APIs* in the left navigation, have been moved to *Configure* \> *APIs*. Additionally, the term "APIs" is now referred to as "API Proxies." Furthermore, "Products" and "Applications", which were previously found under *Design* \> *APIs* can now be accessed through a new left navigation item called *Engage*. To know more, see [API Development](https://help.sap.com/docs/integration-suite/sap-integration-suite/manage-apis?version=CLOUD). - - - -Info only - - - -General Availability - - - -New - - - -Technology - - - -Not applicable - - - -  - - - -2023-10-30 - - - -2023-10-30 - -
- -API Management - - - -- Cloud Foundry - - - - - -API Revisions - - - -When publishing products, it's important to note that resources are available from the deployed API, rather than from the latest revision or draft of the API. Additionally, if a deployed resource is not available in the latest revision, you won't be able to attach that resource to the product. - -The revision name now includes support for parentheses \(\) as an additional special character in the name. For more information, see . - -- : [API Revisions](https://help.sap.com/docs/integration-suite/sap-integration-suite/api-revisions) -- API Management standalone service: [API Revisions](https://help.sap.com/docs/sap-api-management/sap-api-management/api-revisions) - - - - - -Info only - - - -General Availability - - - -New - - - -Technology - - - -Not applicable - - - -  - - - -2023-09-30 - - - -2023-09-30 - -
- -API Management - - - -- Cloud Foundry - - - - - -Certificate-based Credentials - - - -The connection between the centralised API business hub enterprise and the API portal has been secured with certificate-based authentication. For more information, see [Create a Connection Request for the Centralized API business hub enterprise \[Classic Design\]](APIM-Initial-Setup/create-a-connection-request-for-the-centralized-api-business-hub-enterprise-cla-02f7877.md) and [Create a Connection Request for the Centralized API business hub enterprise \[New Design\]](APIM-Initial-Setup/create-a-connection-request-for-the-centralized-api-business-hub-enterprise-new-c7bda8c.md). - - - -Info only - - - -General Availability - - - -New - - - -Technology - - - -Not applicable - - - -  - - - -2023-09-30 - - - -2023-09-30 - -
- -API Management - - - -- Cloud Foundry - - - - - -Client SDK - - - -In Cloud Foundry, Authentication using the X509 certificate and key is now supported. Instead of clientid, clientsecret and tokenurl, use certificate, privateKey, certUrl and clientid. For more information, refer to the Client SDK version 1.5.0 in [API Services](api-services-007d50f.md). - - - -Info only - - - -General Availability - - - -New - - - -Technology - - - -Not applicable - - - -  - - - -2023-09-13 - - - -2023-09-13 - -
- -API Management - - - -- Cloud Foundry - - - - - -API Revisions - - - -You can now create a new revision of your API and make necessary changes to the API definitions, policies, and resources without causing any disruption to the already published API. - -You can also see all the changes made to the API and restore the API to its previous state. For more information, see [API Revisions](api-revisions-58097ac.md). - - - -Info only - - - -General Availability - - - -New - - - -Technology - - - -Not applicable - - - -  - - - -2023-08-28 - - - -2023-08-28 - -
- -API Management - - - -- Cloud Foundry - - - - - -Graph - - - -Graph is a new and innovative capability of API Management within SAP Integration Suite.It enables you to expose all your business data in the form of a semantically connected data graph, accessed via a single unified and powerful API. For more information, see [Activating and Managing Capabilities](https://help.sap.com/docs/integration-suite/sap-integration-suite/activating-and-managing-capabilities?version=CLOUD). - - - -Info only - - - -General Availability - - - -New - - - -Technology - - - -Not applicable - - - -  - - - -2023-07-17 - - - -2023-07-17 - -
- -API Management - - - -- Cloud Foundry - - - - - -API business hub enterprise: Add Links and Email Addresses Using Markdown - - - -You can use markdown to add links and email addresses to the title and subtitle fields as part of the banner description in *Site Editor*. For more information, see [Customize the Visual Format of the API business hub enterprise](customize-the-visual-format-of-the-api-business-hub-enterprise-2eacd52.md). - - - -Info only - - - -General Availability - - - -New - - - -Technology - - - -Not applicable - - - -  - - - -2023-07-17 - - - -2023-07-17 - -
- -API Management - - - -- Cloud Foundry - - - - - -Latest Version of the Tenant Cloning Tool - - - -The 1.7.2 version of the Tenant Cloning Tool is now available. For more information, see [Clone API Management Content](APIM-Migration/clone-api-management-content-7abd887.md) and [Clone API Management Content for Cloud Foundry to Cloud Foundry Migration](APIM-Migration/clone-api-management-content-for-cloud-foundry-to-cloud-foundry-migration-2e5d127.md). - - - -Info only - - - -General Availability - - - -New - - - -Technology - - - -Not applicable - - - -  - - - -2023-06-23 - - - -2023-06-23 - -
- -API Management - - - -- Cloud Foundry - - - - - -Latest Version of the Tenant Cloning Tool - - - -The 1.7.1 version of the Tenant Cloning Tool is now available. For more information, see [Clone API Management Content](APIM-Migration/clone-api-management-content-7abd887.md) and [Clone API Management Content for Cloud Foundry to Cloud Foundry Migration](APIM-Migration/clone-api-management-content-for-cloud-foundry-to-cloud-foundry-migration-2e5d127.md). - - - -Info only - - - -General Availability - - - -New - - - -Technology - - - -Not applicable - - - -  - - - -2023-05-22 - - - -2023-05-22 - -
- -API Management - - - -- Cloud Foundry - - - - - -Secure options to consume APIs - - - -We have introduced secure options to consume APIs using the API Access Plan for API portal, API business hub enterprise and on-premise connectivity. You can now create service keys with credential types "binding- secret", "instance- secret" and "x509". For more information, see [Accessing API Management APIs Programmatically](APIM-Initial-Setup/accessing-api-management-apis-programmatically-24a2c37.md), [Accessing API business hub enterprise APIs Programmatically](APIM-Initial-Setup/accessing-api-business-hub-enterprise-apis-programmatically-dabee6e.md) and [Accessing On-Premise Systems through API Management](APIM-Initial-Setup/accessing-on-premise-systems-through-api-management-2fc7a5b.md). - - - -Info only - - - -General Availability - - - -New - - - -Technology - - - -Not applicable - - - -  - - - -2023-05-08 - - - -2023-05-08 - -
- -API Management - - - -- Cloud Foundry - - - - - -Short text field in API products. - - - -In the API portal, a new *Short Text* field is now available for products. You can use this field to add an introductory text to your products. When you add the introductory text in this field and publish the product, this short text appears in the product tile on the corresponding API business hub enterprise page and is also available on the API proxy details page. For more information, see [Create a Product](create-a-product-d769622.md). - - - -Info only - - - -General Availability - - - -New - - - -Technology - - - -Not applicable - - - -  - - - -2023-05-08 - - - -2023-05-08 - -
- -API Management - - - -- Cloud Foundry - - - - - -API business hub enterprise \[New Design\] and \[Classic Design\] - - - -If you have defined the external documentation information for an API in the OpenAPI specification, you can access this information under the *Documentation* section in the API details page under the *Overview* tab. - - - -Info only - - - -General Availability - - - -New - - - -Technology - - - -Not applicable - - - -  - - - -2023-04-10 - - - -2023-04-10 - -
- -API Management - - - -- Cloud Foundry - - - - - -API business hub enterprise - - - -\[New DesignThe Manage options \(for example Manage Users, Manage Domain\] Categories, and so on\) on the API business hub enterprise \[New Design\] header are now listed under *\[New DesignEnterprise Manager*. Based on the roles assigned to the users, these options will appear under the *Enterprise Manager* tab. For more information, see [Manage Domain Categories \[New Design\]](manage-domain-categories-new-design-bd9691d.md). - - - -Info only - - - -General Availability - - - - - - - -Technology - - - -Not applicable - - - -  - - - -2023-02-20 - - - -2023-02-20 - -
- -API Management - - - -- Cloud Foundry - - - - - -API business hub enterprise \[New Design\] - - - -You can now configure notifications for providing information to the API business hub enterprise end users on any website updates, events or news items from the API business hub enterprise new user interface. For more information, see [Manage Notifications \[New Design\]](manage-notifications-new-design-df32457.md). - - - -Info only - - - -General Availability - - - -New - - - -Technology - - - -Not applicable - - - -  - - - -2023-02-20 - - - -2023-02-20 - -
- -API Management - - - -- Cloud Foundry - - - - - -API business hub enterprise - - - -The mandatory Client ID and Client Secret fields on *Edit Credentials* popup have been replaced with *\*API Portal Access Credentials* field. For more information, see [Updating the Connection Request Credentials for a Pending Request \[New Design\]](APIM-Initial-Setup/updating-the-connection-request-credentials-for-a-pending-request-new-design-dd37a7b.md) and [Updating the Connection Request Credentials for a Submitted Request \[Classic Design\]](APIM-Initial-Setup/updating-the-connection-request-credentials-for-a-submitted-request-classic-des-eb84854.md). - - - -Info only - - - -General Availability - - - -New - - - -Technology - - - -Not applicable - - - -  - - - -2023-01-17 - - - -2023-01-17 - -
- -API Management - - - -- Cloud Foundry - - - - - -Migrating API Management Subscription from One Cloud Foundry to Another Cloud Foundry Environment - - - -You can choose to migrate an existing API Management subscription that you have in the Cloud Foundry environment to another API Management subscription within the Cloud Foundry environment. This can be done to a different tenant within the same data center or to a tenant in a different data center. For more information, see [Migration of API Management Content between Cloud Foundry Environments](APIM-Migration/migration-of-api-management-content-between-cloud-foundry-environments-17f09f3.md). - - - -Info only - - - -General Availability - - - -New - - - -Technology - - - -Not applicable - - - -API Management - - - -2023-01-04 - - - -2023-01-04 +2024-01-20