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 99107f37..de389140 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 @@ -24,6 +24,9 @@ You’ve created a subaccount in your assigned global account using the SAP BTP 3. In the *New Instance or Subscription* dialog box, select the *Plan* and choose *Create*. Wait for the subscription to complete successfully. + > ### Note: + > For different plans see the SAP Note [2903776](https://help.sap.com/docs/link-disclaimer?site=https://me.sap.com/notes/2903776). + Check the status of the submission in the subscriptions section on the *Instances and Subscriptions* page. If the subscription is successful, you notice the status of the *Integration Suite* shown as *Subscribed*. 4. You must have specific roles to access theIntegration Suite. To assign these roles navigate to *Security* \> *Users*. 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 72a77359..157f1945 100644 --- a/docs/ISuite/30-Assessing_Integration_Strategy/integration-assessment-310067e.md +++ b/docs/ISuite/30-Assessing_Integration_Strategy/integration-assessment-310067e.md @@ -13,3 +13,5 @@ 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-apis-47847b5.md b/docs/ISuite/30-Assessing_Integration_Strategy/integration-assessment-apis-47847b5.md index 15535fe9..6a434f09 100644 --- a/docs/ISuite/30-Assessing_Integration_Strategy/integration-assessment-apis-47847b5.md +++ b/docs/ISuite/30-Assessing_Integration_Strategy/integration-assessment-apis-47847b5.md @@ -1,8 +1,10 @@ + + # Integration Assessment APIs -The following are the list of APIs used in Integration Assessment. For more information, see the [API reference on the SAP Business Accelerator Hub](https://api.sap.com/package/SAPIntegrationAssessment/overview). +The following is the list of APIs used in Integration Assessment. For more information, see the [API Reference on SAP Business Accelerator Hub](https://hub.sap.com/package/SAPIntegrationAssessment/overview). You can also navigate to the API Reference from the Integration Assessment application. Select User Actions from the top toolbar, then choose *API Reference*. Additionally, navigate to the Business Hub by selecting Explore our Ecosystem, then choosing *SAP Business Accelerator Hub*. @@ -64,7 +66,7 @@ Use Case Pattern -Integration use case patterns refine the integration styles identified for your organization's integration strategy. +Integration use-case patterns refine the integration styles identified for your organization's integration strategy. @@ -76,7 +78,7 @@ Integration Pattern -To derive integration guidelines for complex landscapes, Integration patterns combines integration domains and integration styles to derive integration guidelines. +To derive integration guidelines for complex landscapes, Integration patterns combine integration domains and integration styles to derive integration guidelines. You can do an assessment of your integration architecture by adding the integration patterns that are relevant to your organization or that you might want to further evaluate. @@ -90,7 +92,7 @@ Key Characteristic -Key Characteristic help enterprise architects and integration architects to map integration styles to relevant capabilities of integration technologies. +Key Characteristic helps enterprise architects and integration architects to map integration styles to relevant capabilities of integration technologies. @@ -102,7 +104,7 @@ Key Characteristic Group -Key characteristics group, groups key characteristics and offers an additional layer for structuring for the key characteristcs. +Key characteristics group groups key characteristics and offers an additional layer for structuring for the key characteristics. @@ -284,7 +286,7 @@ Integration Flow -An integration flow represents the overall integration of one or more application. +An integration flow represents the overall integration of one or more applications. @@ -331,5 +333,5 @@ This entity describes the decision for a certain technology instance for a speci [Creating Service Instance and Service Key to enable API calling](creating-service-instance-and-service-key-to-enable-api-calling-749897f.md "") -[https://api.sap.com/api/EntitiesAPI/resource/Domain](https://api.sap.com/api/EntitiesAPI/resource/Domain) +[Integration Assessment API Reference on SAP Business Accelerator Hub](https://hub.sap.com/package/SAPIntegrationAssessment/overview) 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 d172b426..8845a99f 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,7 +6,12 @@ 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: [SAP Integration Solution Advisory Methodology](sap-integration-solution-advisory-methodology-a2e17f3.md) +For more information, see: + +- [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 for Integration Assessment](../60-Security/personas-for-integration-assessment-5df5af1.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 b502dc4d..dee4fcda 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,10 +193,6 @@ 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/configuring-inbound-communication-62690e5.md b/docs/ISuite/40-RemoteSystems/configuring-inbound-communication-62690e5.md index 091b3554..d418f279 100644 --- a/docs/ISuite/40-RemoteSystems/configuring-inbound-communication-62690e5.md +++ b/docs/ISuite/40-RemoteSystems/configuring-inbound-communication-62690e5.md @@ -46,6 +46,8 @@ 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. @@ -54,6 +56,8 @@ To enable communication with such a variety of systems, Cloud Integration suppor [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/downloading-a-certificate-signing-request-b199dbe.md b/docs/ISuite/40-RemoteSystems/downloading-a-certificate-signing-request-b199dbe.md index 0bd5da47..2af0f46b 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/inbound-message-level-security-with-openpgp-d2acb9f.md b/docs/ISuite/40-RemoteSystems/inbound-message-level-security-with-openpgp-d2acb9f.md index 10dffbdd..c67bf4ea 100644 --- a/docs/ISuite/40-RemoteSystems/inbound-message-level-security-with-openpgp-d2acb9f.md +++ b/docs/ISuite/40-RemoteSystems/inbound-message-level-security-with-openpgp-d2acb9f.md @@ -72,31 +72,6 @@ To implement message-level security for OpenPGP, you use PGP keys. ![](images/Keys_for_Message_Level_Security_PGP_Inbound_0c58adc.png) - - -## Configuring the Sender - -1. Generate and configure the PGP keys and the storage locations \(PGP secret and public keyrings\) for the sender system. - -2. Import the related public keys from the tenant into the public PGP keyring of the sender and finish the configuration of the sender system. - - - - -Provide the tenant administrator with the public key \(is used to verify messages sent to the tenant\). - - - -## Configuring the Integration Flow Steps for Message-Level Security - -Configure the security-related integration flow steps. - -Configure the **Decryptor** \(PGP\) and **Verifyer** \(PGP\) step. - -When signatures are expected, make sure that you specify the *Signer User ID of Key\(s\) from Public Keyring* for all expected senders. - -Based on the signer user ID of key\(s\) parts, the public key \(for message verification\) is looked up in the PGP public keyring. The signer user ID of key\(s\) key parts specified in this step restrict the list of expected senders and, in this way, act as an authorization check. - **Related Information** @@ -104,5 +79,3 @@ Based on the signer user ID of key\(s\) parts, the public key \(for message veri [Creating OpenPGP Keys](creating-openpgp-keys-6c5846b.md "You use the tool gpg4win to create the required keys for the usage of OpenPGP.") -[Define PGP Decryptor](../50-Development/define-pgp-decryptor-d0dc511.md "") - diff --git a/docs/ISuite/40-RemoteSystems/inbound-message-level-security-with-pkcs-7-xml-digitalsignature-9d6bd42.md b/docs/ISuite/40-RemoteSystems/inbound-message-level-security-with-pkcs-7-xml-digitalsignature-9d6bd42.md index 82c646ea..e4b2d5fb 100644 --- a/docs/ISuite/40-RemoteSystems/inbound-message-level-security-with-pkcs-7-xml-digitalsignature-9d6bd42.md +++ b/docs/ISuite/40-RemoteSystems/inbound-message-level-security-with-pkcs-7-xml-digitalsignature-9d6bd42.md @@ -72,40 +72,6 @@ To implement message-level security for the standards PKCS\#7, WS-Security, and ![](images/Certificates_for_Message_Level_Security_Inbound_dbc7998.png) - - -## Configuring the Sender - -Configure the sender keystore in the following way: - -- Generate a key pair \(and get it signed by a CA\). - -- Import the tenant public key into the sender keystore. - - - - -Provide the tenant administrator with the public key \(is used to verify messages sent to the tenant\). - - - -## Configuring the Integration Flow Steps for Message-Level Security - -Depending on the desired option, configure the security-related integration flow steps. - -- Configure the **Verifyer** \(PKCS7 or XML Signature Verifyer\) step. - - Specify the *Public Key Aliases* in order to select the relevant keys from the tenant keystore. - -- Configure the **Decryptor** \(PKCS7\) step. - - Make sure that you specify the *Public Key Aliases* for all expected senders \(only if you have specified *Enveloped or Signed and Enveloped Data* or *Signed and Enveloped Data* for *Signatures in PKCS7 Message*\). - - These are the public key aliases corresponding to the private keys \(of the expected senders\) that are used to sign the payload. The public key aliases specified in this step restrict the list of expected senders and, in this way, act as an authorization check. - - -In general, an alias is a reference to an entry in a keystore. A keystore can contain multiple public keys. You can use a public key alias to refer to and select a specific public key from a keystore. - **Related Information** @@ -117,5 +83,3 @@ In general, an alias is a reference to an entry in a keystore. A keystore can co [Creating Keys for the Usage of PKCS\#7, XML Digital Signature and WS-Security](creating-keys-for-the-usage-of-pkcs-7-xml-digital-signature-and-ws-security-6f43916.md "To set up message level security scenarios based on PKCS#7, XML Digital Signature or WS-Security, the required keys are created in the same way as for transport level security HTTPS.") -[Define PKCS\#7/CMS Decryptor](../50-Development/define-pkcs-7-cms-decryptor-51d903b.md "") - diff --git a/docs/ISuite/40-RemoteSystems/involved-roles-3968091.md b/docs/ISuite/40-RemoteSystems/involved-roles-3968091.md index f1ed6042..c2f4f3dd 100644 --- a/docs/ISuite/40-RemoteSystems/involved-roles-3968091.md +++ b/docs/ISuite/40-RemoteSystems/involved-roles-3968091.md @@ -4,69 +4,3 @@ The security artifact renewal process requires that different persons perform a sequence of steps in a coordinated way on each side of the communication. The exact sequence depends on the kind of security material which is renewed and on the use case. -**Roles in the Security Artifact Renewal Process** - - - - - - - - - - - - - - - - - - - - - - - -
- -Role - - - -Tasks - -
- -Sender/receiver administrator \(at customer side\) - - - -Updates the security artifacts owned by the sender/receiver back-end system \(for example, the keystore\). - -
- -Integration developer - - - -Updates the integration flow in certain use cases. - -
- -Tenant administrator - - - -Updates the security artifacts of the tenant \(relevant for outbound communication\). - -
- -Load balancer administrator - - - -Updates the security artifacts of the load balancer \(relevant for inbound communication\). - -
- diff --git a/docs/ISuite/40-RemoteSystems/message-level-security-463a908.md b/docs/ISuite/40-RemoteSystems/message-level-security-463a908.md index a03aab8e..cd7576c2 100644 --- a/docs/ISuite/40-RemoteSystems/message-level-security-463a908.md +++ b/docs/ISuite/40-RemoteSystems/message-level-security-463a908.md @@ -201,6 +201,9 @@ Strong encryption is supported for the following algorithms: For these algorithms, the key lengths 192 and 256 are possible. +> ### Caution: +> Algorithms starting with SHA1, MD2, or MD5 are still supported for compatibility reasons, but they no longer meet today's security requirements. Therefore, we recommend using stronger algorithms where possible. Check with your security experts or authorities like NIST for more detailed security recommendations. + ## Recommendations 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 92463997..a2ac4ae1 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,18 +27,13 @@ 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/outbound-message-level-security-with-openpgp-8641a15.md b/docs/ISuite/40-RemoteSystems/outbound-message-level-security-with-openpgp-8641a15.md index cb03f9bc..2d7101d9 100644 --- a/docs/ISuite/40-RemoteSystems/outbound-message-level-security-with-openpgp-8641a15.md +++ b/docs/ISuite/40-RemoteSystems/outbound-message-level-security-with-openpgp-8641a15.md @@ -72,32 +72,6 @@ To implement message-level security for OpenPGP, you use PGP keys. ![](images/Keys_for_Message_Level_Security_PGP_Outbound_8e6a163.png) - - -## Configuring the Receiver - -1. Generate the PGP keys and the storage locations \(PGP secret and public keyrings\) for the receiver system. - -2. Import the related public keys from the tenant into the public PGP keyring of the receiver and finish the configuration of the receiver system. - - - - -Provide tenant administrator with the public key \( used to encrypt messages sent to the receiver\). - - - -## Configuring the Integration Flow Steps for Message-Level Security - -Depending on the desired option, configure the security-related integration flow steps. - -Configure the **Encryptor** \(PGP\) step. - -- Specify the *User ID of Key\(s\) from Public Keyring* in order to select the relevant public receiver keys from the PGP public keyring. - -- If you want to sign the payload, specify the *Signer User ID of Key\(s\) from Secret Keyring* in order to select the relevant private key from the PGP secret keyring. The private key is used to sign the message. - - **Related Information** @@ -105,5 +79,3 @@ Configure the **Encryptor** \(PGP\) step. [Creating OpenPGP Keys](creating-openpgp-keys-6c5846b.md "You use the tool gpg4win to create the required keys for the usage of OpenPGP.") -[Define PGP Encryptor](../50-Development/define-pgp-encryptor-7a07766.md "") - diff --git a/docs/ISuite/40-RemoteSystems/outbound-message-level-security-with-pkcs-7-xml-digitalsignature-57b2b19.md b/docs/ISuite/40-RemoteSystems/outbound-message-level-security-with-pkcs-7-xml-digitalsignature-57b2b19.md index 3a690bb1..d03a70bb 100644 --- a/docs/ISuite/40-RemoteSystems/outbound-message-level-security-with-pkcs-7-xml-digitalsignature-57b2b19.md +++ b/docs/ISuite/40-RemoteSystems/outbound-message-level-security-with-pkcs-7-xml-digitalsignature-57b2b19.md @@ -74,21 +74,6 @@ To implement message-level security for standards PKCS\#7, WS-Security, and XML -## Configuring the Receiver - -Configure the receiver keystore in the following way: - -- Generate a key pair \(and get it signed by a CA\). - -- Import the tenant public key into the receiver keystore. - - - - -Provide the tenant administrator with the public key \(is used to encrypt messages sent to the receiver\). - - - ## Configuring the Integration Flow Steps for Message-Level Security @@ -119,7 +104,3 @@ In general, an alias is a reference to an entry in a keystore. A keystore can co [Creating Keys for the Usage of PKCS\#7, XML Digital Signature and WS-Security](creating-keys-for-the-usage-of-pkcs-7-xml-digital-signature-and-ws-security-6f43916.md "To set up message level security scenarios based on PKCS#7, XML Digital Signature or WS-Security, the required keys are created in the same way as for transport level security HTTPS.") -[Sign the Message Content with PKCS\#7/CMS Signer](../50-Development/sign-the-message-content-with-pkcs-7-cms-signer-cc09e03.md "") - -[Encrypt and Sign the Message Content with PKCS\#7/CMS Encryptor](../50-Development/encrypt-and-sign-the-message-content-with-pkcs-7-cms-encryptor-21fd211.md "") - diff --git a/docs/ISuite/40-RemoteSystems/renewal-of-password-only-84dabed.md b/docs/ISuite/40-RemoteSystems/renewal-of-password-only-84dabed.md index 3d717362..7fc9b5ba 100644 --- a/docs/ISuite/40-RemoteSystems/renewal-of-password-only-84dabed.md +++ b/docs/ISuite/40-RemoteSystems/renewal-of-password-only-84dabed.md @@ -8,10 +8,3 @@ To exchange the password of a user without any downtime, the cloud infrastructur Security artifact renewal has to be performed in the following sequence: -1. Cloud infrastructure provider: Informs the sender administrator that he wants to change the password of a certain user used for HTTPS communication with the tenant and that he has created an **intermediate user** \(`user1`\) and password. -2. Sender administrator: Exchanges the old user/password \(`user0`\) with the intermediate user/password \(`user1`\) in the HTTPS sender client \(back-end system\). -3. Sender administrator: Informs the cloud infrastructure provider that the sender client now uses the intermediate user \(`user1`\). -4. Cloud infrastructure provider: Informs the sender administrator that the password of the original user \(`user0`\) has been changed. -5. Sender administrator: Exchanges the user/password of the intermediate user \(`user1`\) with the original user \(`user0`\) \(and with the new password\). -6. Sender administrator: Informs the cloud infrastructure provider that user and password has been changed. - diff --git a/docs/ISuite/40-RemoteSystems/renewal-of-tenant-client-root-certificate-ca-8dc5877.md b/docs/ISuite/40-RemoteSystems/renewal-of-tenant-client-root-certificate-ca-8dc5877.md index 78850231..8d7ec79d 100644 --- a/docs/ISuite/40-RemoteSystems/renewal-of-tenant-client-root-certificate-ca-8dc5877.md +++ b/docs/ISuite/40-RemoteSystems/renewal-of-tenant-client-root-certificate-ca-8dc5877.md @@ -35,17 +35,6 @@ Certificate renewal has to be performed in the following sequence: 8. Tenant administrator: Informs the receiver administrator that a new client certificate \(signed by another CA than the old one\) is now used. 9. Receiver administrator: Removes the old client certificate and also the old root certificate \(assumed that it is not longer used in any other communication\). -Let us assume, the customer landscape is composed as described under *Connecting a Customer System to Cloud Integration*, section *Technical Landscape for On Premise-On Demand Integration*. In that case, SAP Web Dispatcher is used to receive incoming calls from the cloud. SAP Web Dispatcher \(as reverse proxy\) is the entry point for HTTPS requests into the customer system landscape. The configuration of the receiver \(server\) as indicated in step 2 in the list above comprises the following tasks for that example case: - -- Make sure that the reverse proxy trusts the new CA. A restart is required to finalize the related configuration steps. -- Map the new certificate in AS ABAP back-end for authentication purpose -- Edit the new CA in Web Dispatcher farm. - - This step is performed by SAP IT. - -- Upload the new CA in workcenter under *Edit Certificate Trust List*. -- Update the communication arrangements credentials such way that the new certificate is mapped to the inbound technical user. - ## Receiver does not Accept Different Certificates at the same Time diff --git a/docs/ISuite/40-RemoteSystems/renewal-of-user-and-password-da1eeb1.md b/docs/ISuite/40-RemoteSystems/renewal-of-user-and-password-da1eeb1.md index f6b7d83e..1b7c15c4 100644 --- a/docs/ISuite/40-RemoteSystems/renewal-of-user-and-password-da1eeb1.md +++ b/docs/ISuite/40-RemoteSystems/renewal-of-user-and-password-da1eeb1.md @@ -6,6 +6,3 @@ In this use case, the user \(through which a sender calls the tenant\) is replac Security artifact renewal has to be performed in the following sequence: -1. Sender administrator: Changes the user and password in the HTTPS sender client \(sender back-end\). -2. Sender administrator: Informs SAP that user has been changed in the sender client. - diff --git a/docs/ISuite/40-RemoteSystems/service-key-types-0fc1446.md b/docs/ISuite/40-RemoteSystems/service-key-types-0fc1446.md index d4616a99..c36d2c2e 100644 --- a/docs/ISuite/40-RemoteSystems/service-key-types-0fc1446.md +++ b/docs/ISuite/40-RemoteSystems/service-key-types-0fc1446.md @@ -69,10 +69,6 @@ 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. @@ -114,49 +110,3 @@ 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 ab99fd61..70bb8f7d 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 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 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).") [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 7844790c..fddd0c6f 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 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).") +[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).") [Outbound SFTP With Public Key Authentication](outbound-sftp-with-public-key-authentication-d96b2d7.md "") diff --git a/docs/ISuite/50-Development/IntegrationSettings/generative-ai-0c93c17.md b/docs/ISuite/50-Development/IntegrationSettings/generative-ai-0c93c17.md new file mode 100644 index 00000000..e4f6cc27 --- /dev/null +++ b/docs/ISuite/50-Development/IntegrationSettings/generative-ai-0c93c17.md @@ -0,0 +1,4 @@ + + +# Generative AI + 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 78e1fe84..d8c7e24c 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,7 +39,6 @@ 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/upload-custom-adapters-fc4f957.md b/docs/ISuite/50-Development/IntegrationSettings/upload-custom-adapters-fc4f957.md index 4929bc1e..e6f908db 100644 --- a/docs/ISuite/50-Development/IntegrationSettings/upload-custom-adapters-fc4f957.md +++ b/docs/ISuite/50-Development/IntegrationSettings/upload-custom-adapters-fc4f957.md @@ -26,17 +26,16 @@ 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. **For your custom integration adapters:** In the Upload Custom Integration Adapter dialog box, *Browse* and select the adapter for uploading. +2. 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 successfully uploaded custom adapters will be available in your production tenants after migration. + > The 3.14 runtime compatible adapter can only be uploaded if its 2.24 runtime compatible version is already deployed in the tenant. - **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). +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). > ### Note: - > Autoporting will update your adapter to the latest version. + > - The successfully uploaded custom adapters will be available in your production tenants after migration. -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. +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. diff --git a/docs/ISuite/50-Development/access-control-3f72aea.md b/docs/ISuite/50-Development/access-control-3f72aea.md index c76ed675..248b8070 100644 --- a/docs/ISuite/50-Development/access-control-3f72aea.md +++ b/docs/ISuite/50-Development/access-control-3f72aea.md @@ -177,6 +177,38 @@ The default value is `ALLOW`. + + + + + +ValidateBasedOn \(Optional\) + + + + +To determine which IP addresses should be evaluated, utilize the ValidateBasedOn element when the X-Forwarded-For HTTP header contains multiple IP addresses. + +Valid value: X\_FORWARDED\_FOR\_ALL\_IP, X\_FORWARDED\_FOR\_FIRST\_IP, X\_FORWARDED\_FOR\_LAST\_IP + +The default value is `X_FORWARDED_FOR_FIRST_IP`. + +> ### Sample Code: +> ``` +> +> +> 120.75.68.75 +> +> +> 120.75.68.75 +> +> +> X_FORWARDED_FOR_ALL_IP +> +> ``` + + + diff --git a/docs/ISuite/50-Development/access-logs-c1649cd.md b/docs/ISuite/50-Development/access-logs-c1649cd.md index dd2ed445..1a15627d 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 is 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 ist not yet enabled on all data centers. **Related Information** diff --git a/docs/ISuite/50-Development/accessing-trust-and-key-managers-8518837.md b/docs/ISuite/50-Development/accessing-trust-and-key-managers-8518837.md index 336c09d7..15cc6568 100644 --- a/docs/ISuite/50-Development/accessing-trust-and-key-managers-8518837.md +++ b/docs/ISuite/50-Development/accessing-trust-and-key-managers-8518837.md @@ -12,27 +12,9 @@ Follow the procedure below to get trust and key managers in an ADK project. ## Procedure -1. Download the latest ADK API from the [Adapter Development Kit](https://tools.hana.ondemand.com/#cloudintegration) section. +1. Add the `com.sap.it.public` group ID to the ``. -2. Add the `com.sap.it.public.generic.api.jar` file to the `resources` folder that is in your ADK project. - -3. Open the `pom.xml` file and add the dependency below: - - > ### Source Code: - > ```xml - > - > com.sap.it.public - > api - > 2.8.0 - > system - > ${project.basedir}/src/main/resources/com.sap.it.public.generic.api-2.8.0.jar - > - > - > ``` - -4. Add the `com.sap.it.public` group ID to the ``. - -5. Depending on your requirements, add the code below to either the `*Producer.java` \(receiver adapter\) or `*Consumer.java` \(sender adapter\) file. This allows you to import all the trust managers. +2. Depending on your requirements, add the code below to either the `*Producer.java` \(receiver adapter\) or `*Consumer.java` \(sender adapter\) file. This allows you to import all the trust managers. > ### Source Code: > ```java @@ -55,7 +37,7 @@ Follow the procedure below to get trust and key managers in an ADK project. > > ``` -6. To import all the key managers, use the code below: +3. To import all the key managers, use the code below: > ### Source Code: > ```java diff --git a/docs/ISuite/50-Development/accessing-user-credentials-e4e4edc.md b/docs/ISuite/50-Development/accessing-user-credentials-e4e4edc.md index 1a29a304..0c48c5c4 100644 --- a/docs/ISuite/50-Development/accessing-user-credentials-e4e4edc.md +++ b/docs/ISuite/50-Development/accessing-user-credentials-e4e4edc.md @@ -12,27 +12,9 @@ Follow the procedure below to get user credentials in an ADK project. ## Procedure -1. Download the latest ADK API from the [Adapter Development Kit](https://tools.hana.ondemand.com/#cloudintegration) section. +1. Add the `com.sap.it.public` group ID to the ``. -2. Add the `com.sap.it.public.generic.api.jar` file to the `resources` folder that is in your ADK project. - -3. Open the `pom.xml` file and add the dependency below: - - > ### Source Code: - > ```xml - > - > com.sap.it.public - > api - > 2.8.0 - > system - > ${project.basedir}/src/main/resources/com.sap.it.public.generic.api-2.8.0.jar - > - > - > ``` - -4. Add the `com.sap.it.public` group ID to the ``. - -5. To import user credentials, use the code below: +2. To import user credentials, use the code below: > ### Source Code: > ```java 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 2723ce8a..7f722d93 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/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: +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: 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 c7718b09..a6e9ba57 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/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: +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: 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 829e0733..a62406ac 100644 --- a/docs/ISuite/50-Development/advanced-event-mesh-adapter-dd7e034.md +++ b/docs/ISuite/50-Development/advanced-event-mesh-adapter-dd7e034.md @@ -9,13 +9,6 @@ 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/analytics-dashboard-ee416ac.md b/docs/ISuite/50-Development/analytics-dashboard-ee416ac.md index 0fb8fdb0..d10896ef 100644 --- a/docs/ISuite/50-Development/analytics-dashboard-ee416ac.md +++ b/docs/ISuite/50-Development/analytics-dashboard-ee416ac.md @@ -18,6 +18,9 @@ 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-api-proxies-7712c61.md b/docs/ISuite/50-Development/analyze-apis-7712c61.md similarity index 89% rename from docs/ISuite/50-Development/analyze-api-proxies-7712c61.md rename to docs/ISuite/50-Development/analyze-apis-7712c61.md index 7227b5b8..fab45b9e 100644 --- a/docs/ISuite/50-Development/analyze-api-proxies-7712c61.md +++ b/docs/ISuite/50-Development/analyze-apis-7712c61.md @@ -1,8 +1,8 @@ -# Analyze API Proxies +# Analyze APIs -Use the capabilities of API Analytics to analyze API proxy usage and performance. +Use the capabilities of API Analytics to analyze API 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/ec9c3ac6441e4b03a59ef82e10471763/Development/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/38c3df3f8da44a809f937220b3579607/Cloud/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 new file mode 100644 index 00000000..949483dc --- /dev/null +++ b/docs/ISuite/50-Development/anomaly-detection-7a4fe7d.md @@ -0,0 +1,40 @@ + + +# Anomaly Detection + +Anomaly detection is an AI-based feature that involves the identification of patterns or data points that deviate significantly from normal behavior or expected patterns. This feature allows you to proactively identify and respond to unusual patterns or deviations in API proxy calls, thereby ensuring the security, reliability, and optimal performance of APIs. + +> ### Note: +> The availability of the anomaly detection feature 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://me.sap.com/notes/2903776) and [3463620](https://me.sap.com/notes/3463620). + + + + + +## How it works + +Anomaly detection involves training an AI model to understand the behavior of your API proxies \(“proxified” API endpoints\). It works by comparing a current timeframe \(referred to as a 'window'\) of API proxy calls with the corresponding past time-series data. The AI model will be automatically trained using API data from the previous 3 months. Therefore, a minimum of 3 months' worth of API data on an API proxy is required to train the model and reliably detect anomalies. The detection capability improves over time. + +On average, the training process takes approximately 3 hours to complete. + +Anomaly detection is currently offered for the following behaviors: + +- API Traffic \(API Call Count\) + +- Latency \(Total Response Time\) +- API Error Count \(4XX and 5XX Error Count\) + +Once activated, the anomaly detection feature automatically collects a time series of the aggregate set of API proxy calls in the tenant that have a sufficient amount of past API call data. This enables it to identify anomalies in the aggregate set of all configured API proxies. + +In addition, you can select up to five individual APIs, and track call behavior for these APIs. For instance, you may be interested in tracking client errors to a specific, sensitive API, in addition to the number of errors in total for the tenant. + + + + + +## Benefits + +- **Active Monitoring**: Enables active monitoring by highlighting potential anomalies, helping address the issues promptly. +- **Identification of Irregularities**: Visualizing the data enables quick identification of irregularities or patterns that deviate from normal behavior. +- **E-mail Alerts**: You have the option to subscribe to the **SAP Alert Notification Service**, which offers automated email notifications whenever an anomaly is detected. This enables immediate action, minimizing the potential impact of the anomaly and ensuring timely resolution of any issues. For more information, see [Subscribing to Email Notification Alerts](subscribing-to-email-notification-alerts-88e96f4.md). + diff --git a/docs/ISuite/50-Development/api-documentation-3fd9fc9.md b/docs/ISuite/50-Development/api-documentation-3fd9fc9.md index b994ae98..711f48fc 100644 --- a/docs/ISuite/50-Development/api-documentation-3fd9fc9.md +++ b/docs/ISuite/50-Development/api-documentation-3fd9fc9.md @@ -30,21 +30,3 @@ APIs can be accessed using either Groovy Script or Java Script as the programmin OData APIs are implemeted as REST API and use the Open Data Protocol as a technical protocol. For more information, see [OData API](odata-api-a617d6f.md). - - - - -## OData APIs on SAP Business Accelerator Hub - -Cloud Integration OData APIs can be tested and explored on SAP Business Accelerator Hub under [https://api.sap.com/package/CloudIntegrationAPI/odata](https://api.sap.com/package/CloudIntegrationAPI/odata). They are structured around entity types or resources. Click on the tiles below to find more information on the entity types and aspects. - -![](images/CPI_ODataAPI_a325b4e.png) - -The OData APIs are protected by basic authentication \(username and password\). For more information, click on the tile below: - -![](images/CPI_OData_Authentication_2fc6272.png) - -Additionally, the OData APIs make use of common query options: - -![](images/CPI_OData_Query2_6dae5cb.png) - 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 deleted file mode 100644 index 1a506a83..00000000 --- a/docs/ISuite/50-Development/approve-the-pending-connection-requests-classic-design-b4e6f56.md +++ /dev/null @@ -1,50 +0,0 @@ - - - - -# Approve the Pending Connection Requests \[Classic Design\] - -As an API business hub enterprise administrator, you must approve or reject the connection request after you receive them. - - - - - -## Prerequisites - -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). - - - -## Procedure - -1. Log on to the *API Business Hub Enterprise*. - -2. Navigate to the *Manage* tab and choose *Manage API Portal Connections* tile. - - The connection requests that are pending for approval are listed on the *Manage API Portal Connections* page. - -3. Choose *View* to read the comments from the requester before approving or rejecting a connection request. - -4. Choose Manage Connections icon in the *Actions* column and choose *Approve*. - - - - - - -## Results - -The connection has been set up between the Integration Suite API Management tenant and the API business hub enterprise. - -**Related Information** - - -[Create a Connection Request for the Centralized API business hub enterprise \[Classic Design\]](create-a-connection-request-for-the-centralized-api-business-hub-enterprise-classic-desig-02f7877.md "Create a request to connect the Integration Suite API Management tenant to the API business hub enterprise. You need to establish this connection to publish the content of the Integration Suite API Management tenant on 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 deleted file mode 100644 index 46486348..00000000 --- a/docs/ISuite/50-Development/archiving-payload-data-b927e01.md +++ /dev/null @@ -1,22 +0,0 @@ - - -# 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/assign-permission-to-a-product-via-ui-09fb892.md b/docs/ISuite/50-Development/assign-permission-to-a-product-via-ui-09fb892.md index e0d67f4f..a34eb432 100644 --- a/docs/ISuite/50-Development/assign-permission-to-a-product-via-ui-09fb892.md +++ b/docs/ISuite/50-Development/assign-permission-to-a-product-via-ui-09fb892.md @@ -22,7 +22,7 @@ Whenever you create a product or edit a draft product, permissions can be added > ### Note: > Currently, we do not support assigning of permissions to the products defined in the remote API portals that are connected to a centralised API business hub enterprise. > -> \*Remote API portals are those that are not in the same subaccount as the centralised API business hub enterprise and are configured via the manage connections. For more information, [Centralized API business hub enterprise \[New Design\]](centralized-api-business-hub-enterprise-new-design-38422de.md) and [Centralized API business hub enterprise \[Classic Design\]](centralized-api-business-hub-enterprise-classic-design-33b706f.md). +> \*Remote API portals are those that are not in the same subaccount as the centralised API business hub enterprise and are configured via the manage connections. For more information, [Centralized API business hub enterprise](../centralized-api-business-hub-enterprise-38422de.md) and [Centralized API business hub enterprise \[Classic Design\]](https://help.sap.com/viewer/de4066bb3f9240e3bfbcd5614e18c2f9/Cloud/en-US/33b706f4f2e148ffb1cb9289d5cda27d.html "The centralized API business hub enterprise is a central API catalog, allowing application developers to consume APIs and other assets, from a common platform.") :arrow_upper_right:. diff --git a/docs/ISuite/50-Development/assigning-codelists-to-leaf-nodes-770f7be.md b/docs/ISuite/50-Development/assigning-codelists-to-leaf-nodes-770f7be.md index 0ca05ebd..b600af96 100644 --- a/docs/ISuite/50-Development/assigning-codelists-to-leaf-nodes-770f7be.md +++ b/docs/ISuite/50-Development/assigning-codelists-to-leaf-nodes-770f7be.md @@ -24,10 +24,11 @@ You've included the leaf node that you want to assign a codelist to in your MIG 2. Choose the *Codelist* tab in the resulting panel. -3. Choose *Add* to select a codelist through one of the following options. +3. Choose the add :heavy_plus_sign: icon to select a codelist through one of the following options. - Choose *MIG Codelists*, if you want to assign a MIG codelist to the leaf node. - Choose *From Type System* and select the desired codelist from the drop-down box, if you want to assign a type system-based codelist to the leaf node. + - Choose *From Custom Type System* and select the desired custom type system from the drop-down field nearby. On selecting the custom codelists, the list of available codelists will be displayed in the table below. Choose the relevant codelist from the list. The *Selected Codelist* drop down box shows the list of codelists assigned to the leaf node. 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 acf7880b..babfcf4f 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,14 +16,10 @@ Attach a rate plan to a product using the SAP Integration Suite. > ### Note: -> A product can only be associated with one rate plan. You can also attach a rate plan to a product during the product creation. +> 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. > ### Note: -> 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. +> 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. @@ -37,9 +33,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 *Configure* \> *APIs*. +2. Choose the navigation icon on the left and choose *Design* \> *APIs*. -3. On the *Configure* \> *APIs* page, choose *Products*. +3. On the *Design* \> *APIs* page, choose *Products*. 4. From the list of products available, select the product to which you want to add the rate plan. @@ -59,9 +55,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 a9c2887c..de2a691a 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 288ee04f..28b2cf42 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/4425026877144cc2b15505ed30215167/IAT/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/66d066d903c2473f81ec33acfe2ccdb4/Cloud/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/configure-1c90aea.md b/docs/ISuite/50-Development/configure-1c90aea.md new file mode 100644 index 00000000..8ef61ddc --- /dev/null +++ b/docs/ISuite/50-Development/configure-1c90aea.md @@ -0,0 +1,13 @@ + + +# Configure + +In this section, you can: + +- Create, and configure API proxies, API providers, certificates, key-value maps, and policy templates in SAP Integration Suite. + +- + +- Create queues, topics, and topic subscriptions for your event-driven integration requirements. + + diff --git a/docs/ISuite/50-Development/configure-a-message-client-867c517.md b/docs/ISuite/50-Development/configure-a-message-client-867c517.md new file mode 100644 index 00000000..a71ba9ad --- /dev/null +++ b/docs/ISuite/50-Development/configure-a-message-client-867c517.md @@ -0,0 +1,46 @@ + + +# Configure A Message Client + +Understand how to create a message client. + + + +## Context + +The service instance *Event Mesh Message Client* on the SAP BTP cockpit provides access to the message client of Event Mesh's capability. + +By creating a service instance on the SAP BTP cockpit, you trigger the creation of a message client and bind it to the Event Mesh capability. By binding the service instance, you enable the automatic delivery of credentials needed to access the service instance from the Event Mesh capability. Later, all the events publishing and consuming applications are authenticated via OAuth client credentials for all technical commnications. + +You can create any number of message clients and use each one of them for unique purposes. + +Configuring a message client is a two-step process. First, you create a service instance and then create a binding to the Event Mesh capability. + + + +## Procedure + +Create a service instance: + +1. In the SAP BTP cockpit, choose *Instances and Subscriptions* \> *Create*. + +2. Select the service plan *Event Mesh Message Client*. + +3. Provide a name for the instance. + +4. Choose *Create*. + + A service instance with the name you provided is created under the section *Instances*. + + +Create a service binding: + +5. From the context menu of the created service instance, choose *Create Service Binding*. + +6. Provide a name for the service binding. + +7. Choose *Create*. + + A binding of the service instance is created to the Event Mesh capability. + + diff --git a/docs/ISuite/50-Development/configure-event-mesh-77e213c.md b/docs/ISuite/50-Development/configure-event-mesh-77e213c.md new file mode 100644 index 00000000..df15bc64 --- /dev/null +++ b/docs/ISuite/50-Development/configure-event-mesh-77e213c.md @@ -0,0 +1,6 @@ + + +# Configure Event Mesh + +Learn how to configure message clients, queues, and topic subscriptions. + 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 b7f18e2e..0cef4a26 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,48 +199,6 @@ 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* @@ -342,39 +300,6 @@ 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 0380a464..74de68ad 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,48 +362,6 @@ 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* @@ -584,39 +542,6 @@ 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 cd98038b..20c69a70 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 @@ -312,6 +312,10 @@ The alias of the OAuth2 Refresh token URL, stored as Secure Parameter. A map of key-value pairs to configure additional connection properties. For more information, see the product documentation on Solace PubSub+ Platform. +When using the `client_name` property, the provided value is always appended with a unique 10-character alphanumeric string separated by a `/`. + +For example, if the provided value is `iflow_x_sender`, the client\_name is `iflow_x_sender/az077ylyln`. + > ### Note: > JCSMP channel property keys must be prepended by `CLIENT_CHANNEL_PROPERTIES`. @@ -718,3 +722,5 @@ 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. +Additionally, the header `SAP_MplCorrelationId` is propagated in every outgoing message as an entry in the UserProperties. + 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 0ee5a0d1..7d92d1ca 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 @@ -310,6 +310,10 @@ The alias of the OAuth2 Refresh token URL, stored as Secure Parameter. A map of key-value pairs to configure additional connection properties. For more information, see the product documentation on Solace PubSub+ Platform. +When using the `client_name` property, the provided value is always appended with a unique 10-character alphanumeric string separated by a `/`. + +For example, if the provided value is `iflow_x_sender`, the client\_name is `iflow_x_sender/az077ylyln`. + > ### Note: > JCSMP channel property keys must be prepended by \`CLIENT\_CHANNEL\_PROPERTIES.\`. For example: > @@ -409,7 +413,7 @@ The list of AEM topic subscriptions from which messages will be consumed. The number of concurrent consumer flows. > ### Note: -> If the IFlow is running with more than 1 worker, this will be a multiple of the number of workers. For eg. if you configure this value to 3 and the IFlow is running with 2 workers, in total there will be 6 consumers. +> If the integration flow is processed with more than 1 worker, this will be a multiple of the number of workers. For example, if you configure this value to 3 and the integration flow is running with 2 workers, in total there will be 6 consumers. @@ -600,6 +604,8 @@ In addition to the SMF headers there are some non-SMF headers as well that are a 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. +3. The sender supports the propagation of `SAP_MplCorrelationId`. If the incoming message already contains header `SAP_MplCorrelationId`, the same value is propagated to the exchange. + 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. 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 7bd1b7a2..0c15d605 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* 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 88248107..b4229c73 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 @@ -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* diff --git a/docs/ISuite/50-Development/configure-the-api-business-hub-enterprise-classic-design-7b71b16.md b/docs/ISuite/50-Development/configure-the-api-business-hub-enterprise-classic-design-7b71b16.md deleted file mode 100644 index 3cd7a4fa..00000000 --- a/docs/ISuite/50-Development/configure-the-api-business-hub-enterprise-classic-design-7b71b16.md +++ /dev/null @@ -1,207 +0,0 @@ - - -# Configure the API business hub enterprise \[Classic Design\] - -You can configure the API business hub enterprise to personalize it for your organization. - -> ### 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 [Configure the API business hub enterprise \[New Design\]](configure-the-api-business-hub-enterprise-new-design-54b4607.md). - - - -Select *Manage* from the banner. Modify the following sections to personalize the API business hub enterprise. - -The prerequisite varies for each section. Sections are visible to the user based on the role assigned to the user. For example, *General* section is visible to only users assigned with site admin role. For more information on API business hub enterprise user roles, see [Assigning User Roles](https://help.sap.com/docs/SAP_CLOUD_PLATFORM_API_MANAGEMENT/66d066d903c2473f81ec33acfe2ccdb4/911ca5a620e94ab581fa159d76b3b108.html?q=Assign%20User%20Roles). - - - -### General - -Prerequisite: You are assigned the site admin role. - - - - - - - - - - - - - - - -
- -Section - - - -Description - -
- -Company Logo - - - -Upload an image file for your logo, and save the changes. - -
- -Color Scheme - - - -Information about the color scheme used. - -When you upload a logo, the dark color of the navigation area at the top of the screens is replaced with white, since many logos require a white background. - -Other colors on the Web site are changed to neutral tones to avoid visual conflicts with your company's logo colors. - -
- - - -### *Home Page* - -Prerequisite: - -- You are assigned the *AuthGroup.Site.Admin* role to view the following sections: *Name and Description* and *Updates*. - -- You are assigned the content admin role to view *Navigation Categories*. - - -From the homepage, you can view and search the categories, APIs, and products. - - - - - - - - - - - - - - - - - - - -
- -Section - - - -Description - -
- -Name and Description - - - -Edit the default name and description for your application. - -
- -Updates - - - -Configure updates to be displayed on the Home page. For more information on how to add, edit, or delete an update, see [Manage Updates \[Classic Design\]](manage-updates-classic-design-94e37b4.md). - -
- -Navigation Categories - - - -Configure navigation categories to be displayed on the Home page. For more information on how to add, edit, or delete a category, see [Manage Navigation Categories \[Classic Design\]](manage-navigation-categories-classic-design-7f1a44b.md). - -
- - - -### *Manage Users* - -Prerequisite: You are assigned the admin role. - - - - - - - - - - - - - - - - - - - -
- -Section - - - -Description - -
- -E-mail Configuration - - - -Provide the administrators e-mail id. - -
- -Pending Requests - - - -Information about pending user requests. You can either accept or reject the requests. For more information, see [Managing the Access Request of the Users \[Classic Design\]](managing-the-access-request-of-the-users-classic-design-5b3e2f6.md). - -
- -Registered Users - - - -Information about users registered. You can either edit the roles for an existing user or register a new user. For more information, see [Managing the Access Request of the Users \[Classic Design\]](managing-the-access-request-of-the-users-classic-design-5b3e2f6.md). - -
- - - -### *Manage API Portal Connection* - -Prerequisite: You’re assigned the *AuthGroup.API.Admin* role. - -As an API business hub enterprise administrator, you can approve or reject the connection requests from this page. You can also view the requests that you have previously approved or rejected. - - - -### *Reference Links* - -Prerequisite: You are assigned the site admin role. - -You can add, edit, and customize the links that appear at the bottom of the page here. Links are grouped into sets of three. Click *\+* to add and edit Web site updates and news. In the *Add Link* dialog window, enter the link title and URL, and choose *Save*. - diff --git a/docs/ISuite/50-Development/configure-the-api-business-hub-enterprise-new-design-54b4607.md b/docs/ISuite/50-Development/configure-the-api-business-hub-enterprise-new-design-54b4607.md deleted file mode 100644 index ef7db9f7..00000000 --- a/docs/ISuite/50-Development/configure-the-api-business-hub-enterprise-new-design-54b4607.md +++ /dev/null @@ -1,256 +0,0 @@ - - -# Configure the API business hub enterprise \[New Design\] - -You can configure the API business hub enterprise to personalize it for your organization. - -> ### Note: -> This document describes the new design of the API business hub enterprise. To view the documentation for the classic design, see [Configure the API business hub enterprise \[Classic Design\]](configure-the-api-business-hub-enterprise-classic-design-7b71b16.md). - -Modify the following to personalize the API business hub enterprise: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -You can use the… - - - -To… - - - -Role that you must be assigned to… - - - -For more information, see… - -
- -*Home Page* - - - -View and search the categories, APIs, and products - - - -AuthGroup.API.Admin - -AuthGroup.API.ApplicationDeveloper - -> ### Note: -> The *AuthGroup.API.ApplicationDeveloper* role is assigned by default to a user who onboards to the API business hub enterprise using the Self-registration process or via *Add User* flow. - - - - - -[Register on API business hub enterprise](register-on-api-business-hub-enterprise-c85fafe.md) - -
- -*Site Editor* - - - -Customize the visual layout of the API business hub enterprise - - - -- AuthGroup.Site.Admin - -- AuthGroup.API.Admin - - - - - - -[Customize the Visual Format of the API business hub enterprise](customize-the-visual-format-of-the-api-business-hub-enterprise-2eacd52.md) - -
- -*Enterprise Manager* \> *Manage API Management Connections* - - - -Approve and reject the pending connection requests and update the API portal access credentials - - - -- AuthGroup.APIPortalRegistration - - - - - - -[Approve the Pending Connection Requests \[New Design\]](approve-the-pending-connection-requests-new-design-e296f80.md) - -
- -*Enterprise Manager* \> *Manage Users* - - - -Add and Revoke user access to the API Business Hub Enterprise - - - -AuthGroup.API.Admin - - - -[Managing the Access Request of the Users \[New Design\]](managing-the-access-request-of-the-users-new-design-8b79ee8.md) - -[Revoke Access \[New Design\]](revoke-access-new-design-ce609bb.md) - -
- -*Enterprise Manager* \> *Manage Domain Categories* - - - -Create and edit domain specific categories. - - - -- AuthGroup.Content.Admin - -- AuthGroup.API.Admin - - - - - - -[Manage Domain Categories \[New Design\]](manage-domain-categories-new-design-bd9691d.md) - -Also, to add the *AuthGroup.Content.Admin* role, see the table in [Manage Domain Categories \[New Design\]](manage-domain-categories-new-design-bd9691d.md). - -
- -*Enterprise Manager* \> *Manage Notifications* - - - -Configure notifications for providing information to the API business hub enterprise end users on any website updates or news items. - - - -- AuthGroup.Site.Admin - - - - - - -[Manage Notifications \[New Design\]](manage-notifications-new-design-df32457.md) - -
- -*My Workspace* - - - -Create applications and view your applications, costs and analyze reports. - - - -AuthGroup.API.Admin - -> ### Note: -> Administrators can create applications on behalf of a developer and can see all the applications across developers. - -> ### Note: -> AuthGroup.API.ApplicationDeveloper -> -> > ### Note: -> > Application developers can create applications and see only the applications created by him. - - - - - -[Create an Application \[New Design\]](create-an-application-new-design-a501a6d.md) - -
- -*Test Environment* - - - -Test the runtime behaviour of APIs - - - -AuthGroup.API.ApplicationDeveloper - -> ### Note: -> Application developers can test the runtime behaviour of APIs. - - - - - -[Test Runtime Behavior of APIs \[New Design\]](test-runtime-behavior-of-apis-new-design-15c7d52.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 aae8144e..8e6029f8 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 @@ -159,9 +159,14 @@ To know more about using the adapter from external clients, see: - [Use CSRF Protection](use-csrf-protection-a0765d5.md) -- [OAuth with Client Credentials Grant for API Clients](../40-RemoteSystems/oauth-with-client-credentials-grant-for-api-clients-20e26a8.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: > ### 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 e86663fc..1e3cfb51 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 – 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 incoming payload in JSON format. 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 7238651b..7ecd9b51 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 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\). +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\). > ### 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 5d51bbaf..ccc4b9d2 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 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\). +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\). > ### 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 f750ee18..0b9d2970 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 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\). +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\). > ### 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 7aa8732a..2420fcb5 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,11 +195,13 @@ 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) -[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.") +[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: diff --git a/docs/ISuite/50-Development/configuring-apis-for-anomaly-detection-9e7e5d1.md b/docs/ISuite/50-Development/configuring-apis-for-anomaly-detection-9e7e5d1.md new file mode 100644 index 00000000..80d600b2 --- /dev/null +++ b/docs/ISuite/50-Development/configuring-apis-for-anomaly-detection-9e7e5d1.md @@ -0,0 +1,50 @@ + + +# Configuring APIs for Anomaly Detection + +View or configure APIs for anomaly detection. + + + + + +## Context + +> ### Note: +> The availability of the anomaly detection feature 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://me.sap.com/notes/2903776) and [3463620](https://me.sap.com/notes/3463620). + +To view or modify the APIs for anomaly detection, follow the steps below: + + + +## Procedure + +1. Log on to the SAP Integration Suite. + +2. Click on the navigation icon on the left and select *Settings* \> *APIs*. + +3. Go to the *Anomaly Detection* tab. + +4. If anomaly detection is not already enabled, switch the radio button to the *ON* position. This will display the **API Selection** section. + +5. In the **API Selection** section, when you enable anomaly detection for the first time, by default, the system will automatically select and display the top 5 APIs that have received the highest amount of traffic in the past 6 months. + +6. To make changes to the selection of APIs, click *Modify*. + +7. The *Modify APIs* window displays a list of APIs that meet the minimum data requirement \(at least 3 months\) and are available for training. Currently, you can select up to five individual APIs for anomaly detection. Use the checkboxes to select or deselect the desired APIs, and then click on *Modify*. + +8. In the dialog box that appears, click on *Confirm* to save your changes. + + > ### Note: + > Each time you modify the configuration, the AI model needs to be retrained to effectively detect anomalies. On average, the training process takes approximately 3 hours to complete. Therefore, it is not recommended to make frequent configuration changes. + + +**Related Information** + + +[Enabling Anomaly Detection](enabling-anomaly-detection-98534a0.md "To detect anomalies for API proxy calls, you need to enable the anomaly detection setting.") + +[Working with Detected Anomalies](working-with-detected-anomalies-1c677b2.md "Access and analyze anomalies in the analytics dashboard. Discover details about the various types of anomalies, evaluate and resolve them.") + +[Subscribing to Email Notification Alerts](subscribing-to-email-notification-alerts-88e96f4.md "Receive real-time email alerts for anomaly detection services.") + 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 749a1b61..58f2f7fe 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,39 +270,6 @@ 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* @@ -370,48 +337,6 @@ 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 6ddf8651..762fdf14 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,39 +234,6 @@ 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* @@ -358,48 +325,6 @@ 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 8677bd61..c957a9c9 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,39 +120,6 @@ 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* @@ -352,12 +319,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**JMS Queue* is selected\) +\(only if as *Temporary Storage* the option *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. the option +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. 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*. @@ -381,7 +348,7 @@ Select this option in case the messages should be stored in an encrypted way dur -Select the *Conditions* the option tab and provide values in the fields as follows. +Select the *Conditions* tab and provide values in the fields as follows. **Conditions** diff --git a/docs/ISuite/50-Development/consuming-imported-archives-e7562a7.md b/docs/ISuite/50-Development/consuming-imported-archives-e7562a7.md deleted file mode 100644 index e7d3a7eb..00000000 --- a/docs/ISuite/50-Development/consuming-imported-archives-e7562a7.md +++ /dev/null @@ -1,102 +0,0 @@ - - -# 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/content-transport-using-cloud-transport-management-d458b17.md b/docs/ISuite/50-Development/content-transport-using-cloud-transport-management-d458b17.md index da49b30d..d95df648 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 [Tasks and Permissions for Cloud Integration](../60-Security/tasks-and-permissions-for-cloud-integration-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 [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 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 563e455f..2771ebae 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 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 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 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 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 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 [Tasks and Permissions for Cloud Integration](../60-Security/tasks-and-permissions-for-cloud-integration-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 [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 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 6b2128d8..e6c7efc6 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 [Tasks and Permissions for Cloud Integration](../60-Security/tasks-and-permissions-for-cloud-integration-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 [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 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 2e723107..e7ad4c8c 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/coupa-receiver-adapter-648ac01.md b/docs/ISuite/50-Development/coupa-receiver-adapter-648ac01.md deleted file mode 100644 index c3fe72ca..00000000 --- a/docs/ISuite/50-Development/coupa-receiver-adapter-648ac01.md +++ /dev/null @@ -1,407 +0,0 @@ - - -# 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 deleted file mode 100644 index 966b73c6..00000000 --- a/docs/ISuite/50-Development/create-a-connection-request-for-the-centralized-api-business-hub-enterprise-classic-desig-02f7877.md +++ /dev/null @@ -1,180 +0,0 @@ - - - - -# Create a Connection Request for the Centralized API business hub enterprise \[Classic Design\] - -Create a request to connect the Integration Suite API Management tenant to the API business hub enterprise. You need to establish this connection to publish the content of the Integration Suite API Management tenant on the API business hub enterprise. - - - - - -## 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 . - -- The following role collections should be assigned to you: - - *AuthGroup.API.Admin* - - - *APIPortal.Administrator* - - - *AuthGroup.APIPortalRegistration*: You can't create a connection request, without the *AuthGroup.APIPortalRegistration* role. - - - *APIPortal Service.CatalogIntegration* - - -- Generate the access credentials to establish the connection. To generate the credentials from the Integration Suite API Management tenant, you must have the *APIPortal. Administrator* role assigned to you. - - 1. Log in to the Integration Suite. - - 2. Choose the navigation icon on the left and choose *Settings* \> *APIs*. - - 3. Choose the *Connection* tab. - - 4. Follow the onscreen instructions under *Connect the API Portal to the centralized API Business Hub Enterprise* to generate the Integration Suite API Management tenant access credentials. - - ![](images/ABHE_Connection_a5eb276.png) - - - > ### Note: - > The client credentials get generated for the *APIPortal .Service.CatalogIntegration* role. - - - - -## Context - -The API business hub enterprise administrator identifies which existing or new API business hub enterprise application can accept content from multiple Integration Suite API Management tenants. - -> ### Note: -> Only new API Management subscriptions are allowed to set up a connection with the centralized API business hub enterprise. - -> ### Note: -> You can connect a maximum number of 3 Integration Suite API Management tenants to the centralized API business hub enterprise. - -Create a new subaccount in Cloud Foundry and set up only the Integration Suite API Management tenant. - -For the newly set up Integration Suite API Management tenant, you can request for the API business hub enterprise connection to be established. - -> ### Note: -> The option to disconnect an Integration Suite API Management tenant from an existing API business hub enterprise isn’t supported currently. - -> ### Note: -> Once this connection is set up, you can't place a request to severe this connection and establish a new connection with any other centralized API business hub enterprise. - -> ### Note: -> This document describes the classic design of the API business hub enterprise. To view the documentation for the new design, see [Create a Connection Request for the Centralized API business hub enterprise \[New Design\]](create-a-connection-request-for-the-centralized-api-business-hub-enterprise-new-design-c7bda8c.md). - - - -## Procedure - -1. Log on to the *API Business Hub Enterprise*. - -2. Navigate to the *Manage* tab and choose *Establish API Portal Connectivity with API Business Hub Enterprise* tile. - -3. Choose :heavy_plus_sign: icon to create a request to connect the Integration Suite API Management tenant to the centralized API business hub enterprise. - - > ### Note: - > Once this connection is set up, you can't place a request to severe this connection and establish a new connection with any other centralized API business hub enterprise. - - Choose *OK* on the *Confirmation* screen to proceed. - -4. Fill in the following details on the *Submit Connection Request* page. - - - - - - - - - - - - - - - - - - - -
- - Parameters - - - - Values - -
- - API Portal Alias Name - - - - Enter the Integration Suite API Management tenant name that gets displayed on the API Business Hub Enterprise. This name is used to distinguish products that are published from the API portal and likewise for applications created for the product. - -
- - API Portal Access Credentials - - - - Enter the Integration Suite API Management tenant access credentials that you generated earlier. These credentials are used by the API business hub enterprise to establish the connection. - - Sample credentials: - - ``` - { - "url": "https://.cfapps.sap.hana.ondemand.com", - "tokenurl": "https://.authentication.sap.hana.ondemand.com/oauth/token", - "certurl": "https://xxxxxx.authentication.cert.sap.hana.ondemand.com", - "certificate": "xxxxxxxxxxxxxxxxxxx", - "key": "xxxxxxxxxxxxxx" - } - ``` - - > ### Note: - > These credentials will remain valid for a period of 65 days. Please make sure to regenerate them and reestablish the connection within this timeframe. - - - -
- - Comment - - - - Provide the details to the approver about the need for the connection request. - -
- -5. Choose *Submit*. - - - - - - -## Results - -You've submitted the connection request to the API business hub enterprise administrator. Once the connection request is approved by the administrator, you can start publishing the Integration Suite API Management tenant content to the API business hub enterprise. - -> ### Note: -> You can log on to the Integration Suite API Management tenant and check the connection status. Navigate to :gear: and choose *Connection*. -> -> You can also choose *Test Connection* to get the details about the connectivity status once your connection request is approved. You will get a connection error, if the destination is deleted or configured incorrectly. In case of an error, retry after revalidating the destination configuration. - -**Related Information** - - -[Approve the Pending Connection Requests \[Classic Design\]](approve-the-pending-connection-requests-classic-design-b4e6f56.md "As an API business hub enterprise administrator, you must approve or reject the connection request after you receive them.") - diff --git a/docs/ISuite/50-Development/create-a-product-d769622.md b/docs/ISuite/50-Development/create-a-product-d769622.md index 0cb64854..e2bc60ff 100644 --- a/docs/ISuite/50-Development/create-a-product-d769622.md +++ b/docs/ISuite/50-Development/create-a-product-d769622.md @@ -101,7 +101,7 @@ You create a product when you want to expose one or more API proxies to the Appl The OAuth 2.0 policy provides a way to limit the amount of access that is granted to an access token. For example, an access token issued to a client app may be granted READ and WRITE access to protected resources, or just READ access. You can implement your APIs to enforce any scope or combination of scopes you wish. So, if a client receives a token that has READ scope, and it tries to call an API endpoint that requires WRITE access, the call will fail. - Each product can have zero to many scopes assigned. These scopes can be assigned when the product is created or later. Scopes exist as a list of names and are included in the metadata associated with each product. + The maximum character limit for specifying scopes is 4K characters. Each product can have zero or multiple scopes assigned, as long as the total length of all the scopes does not exceed 4K characters. These scopes can be assigned when the product is created or later. Scopes exist as a list of names and are included in the metadata associated with each product. 8. In the *APIs* section, choose *Add*. 9. In the *Add APIs* window, select the required APIs and the corresponding resources. diff --git a/docs/ISuite/50-Development/create-a-queue-95357fa.md b/docs/ISuite/50-Development/create-a-queue-95357fa.md new file mode 100644 index 00000000..cc29167c --- /dev/null +++ b/docs/ISuite/50-Development/create-a-queue-95357fa.md @@ -0,0 +1,58 @@ + + +# Create A Queue + +Understand how to create queues. + + + + + +## Context + +When you send a message via AMQP 1.0 over WebSocket, it can be published to a queue or topic. To send messages to a queue, create a queue with the correct naming syntax as follows: + +- The queue name must be limited to 164 characters. + +- The queue name can include these characters: alphanumeric, underscore \( \_ \), period \( . \), and hyphen \( - \). + +- The queue name can contain forward slash \( / \) only as segment separator. + + + + +## Procedure + +1. Choose *Configure* \> *Event Mesh*. Navigate to the *Queues* tab. + +2. Choose *Create*. + + The *Create Queue* wizard comes up. + +3. Provide a name for the queue. + +4. Select an access type: + + - *NON EXCLUSIVE* – any number of consumers can receive messages at any time from the queue. + + - *EXCLUSIVE* – only one consumer can receive messages at any time from the queue. + + +5. Define the *Queue Size* in bytes. The default and maximum supported queue size are 1.5 GB \(in bytes\). + +6. Define the *Message Size* in bytes. The message size is the maximum amount of data per message that can be spooled in the queue. The default and maximum supported size are 1 MB \(in bytes\). + +7. Define the *Max Unacknowledged Messages Per Consumer* which is the threshold for the number of unacknowledged messages. If there are more unacknowledged messages than the threshold, all subsequent messages are not delivered. + +8. Define the *Max Redelivery Count* which is the maximum number of times the queue attempts redelivery of a message before discarding it. If you define a dead message queue, then the queue moves the undelivered messages to the same. By default, the value is set to zero. The maximum value that you can define is 255. + +9. Select a *Dead Message Queue*. Unacknowledged messages that have either reached maximum redelivery count or maximum time-to-live in the queue are moved to the dead message queue. + + > ### Note: + > You must first create a queue to use it as a dead message queue. + +10. Define the *Max Time-to-live* in seconds which is the duration that a message can stay in the queue without being consumed. The default and maximum supported duration are 7 days \(in seconds\). + +11. Choose *Create*. + + 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 fb80a947..d59c0a82 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-a-topic-subscription-6fe6358.md b/docs/ISuite/50-Development/create-a-topic-subscription-6fe6358.md new file mode 100644 index 00000000..9615741d --- /dev/null +++ b/docs/ISuite/50-Development/create-a-topic-subscription-6fe6358.md @@ -0,0 +1,54 @@ + + +# Create A Topic Subscription + +Understand how to create a topic subsciption from a queue. + + + +## Context + +When you send a message via AMQP 1.0 over WebSocket, it can be published to a queue or topic. Topics form a logical tree to organize messages in a folder-like hierarchy in a file system. Therefore, topics appear as strings, consisting of multiple segments, separated by one defined delimiter. A topic syntax depends on the protocol that is used. The topic syntax must follow the mechanisms defined by individual messaging protocols. + +To send messages to a topic, create a topic or topic pattern with the correct naming syntax as follows: + +- **Topic** + + - A topic name must be limited to 150 characters. + + - A topic name can include these characters: alphanumeric, underscore \( \_ \), period \( . \), and hyphen \( - \). + + - A topic name can contain forward slash \( / \) only as segment separator. + + Also, the segment separator must not appear at the beginning or ending. + + - A maximum of 20 segments can be used. + + - Empty segments aren't allowed. + + +- **Topic Pattern** + + - Use asterisk \( \* \) as a wildcard to represent a subtree of segments only at the end of the name. + + - Use plus \( + \) as a wildcard to represent a single segment with any content that is valid, but always the whole segment. + + + + + +## Procedure + +1. Choose *Configure* \> *Event Mesh*. Navigate to the *Queues* tab. + +2. Choose the queue for which you want to create a topic subscription. + +3. Navigate to the *Subscriptions* tab. + +4. Choose *Create*. + +5. Provide a name or a pattern. + +6. Choose *Create*. + + 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 942071d8..9905e969 100644 --- a/docs/ISuite/50-Development/create-an-api-provider-6b263e2.md +++ b/docs/ISuite/50-Development/create-an-api-provider-6b263e2.md @@ -51,11 +51,7 @@ If you want to configure the API Management solution to access data from a serve 3. Choose *Create*. - ![](images/CreateImage1_3bf6c81.png) - -4. Enter a name and a description for the API provider in the *Overview* section. - - ![](images/OverviewImage2_9550dd7.png) +4. Enter a name and a description for the API provider. > ### Note: > Do not use the names mentioned in following list: @@ -83,12 +79,8 @@ 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** @@ -431,8 +423,6 @@ 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** @@ -507,11 +497,9 @@ 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. - - 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*. +7. Save the changes. - ![](images/TestConnectionImage6_82dccf5.png) + 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*. > ### Note: > The following table lists the attributes considered for testing the connection: 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 d12ca823..dbe6c3f2 100644 --- a/docs/ISuite/50-Development/create-an-api-proxy-c0842d5.md +++ b/docs/ISuite/50-Development/create-an-api-proxy-c0842d5.md @@ -258,7 +258,7 @@ 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. To define target endpoint properties, navigate to the *Target EndPoint* tab and choose *Add*. +10. To define multiple target endpoints, navigate to the *Target EndPoint* tab and choose *Add*. Enter the *Property Name* and the *Values*. For the Target Endpoint property specifications, see [Target Endpoint Properties](target-endpoint-properties-edeed6a.md). 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 deleted file mode 100644 index d1572cdd..00000000 --- a/docs/ISuite/50-Development/create-an-application-classic-design-7b4e71b.md +++ /dev/null @@ -1,141 +0,0 @@ - - -# Create an Application \[Classic Design\] - -Create an Application to consume the required APIs. - -> ### 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 [Create an Application \[New Design\]](create-an-application-new-design-a501a6d.md). - -**Prerequisites** - -- 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. - > - > This role is assigned by default to a user who onboards to the API business hub enterprise using the Self-registration process or via Add User flow. - > - > A user must be onboarded to API business hub enterprise only via Self-registration or Add User flow. For more information on registering in API business hub enterprise, see [Register on API business hub enterprise](register-on-api-business-hub-enterprise-c85fafe.md). In the Add User flow, the API business hub enterprise admin adds a user who wants to be onboarded to API business hub enterprise. However, the user who is requesting to be onboarded must ensure that the user details provided to the admin matches the user details obtained from the response of /api/1.0/users. - - -An application is a discrete representation of the actual developer’s application. It provides the developer with an API key to pass-in with every request to the API. - -In API Management, similar APIs are bundled together to form products, which are published in the Catalog. An application developer enters necessary details to register to the API business hub enterprise. After successful registration, the Application Developer can explore the required products and APIs to create an application. Once the application has been created successfully, the system generates an AppIication Key and Application Secret. If APIs in the application you created are protected via Verify API Key policy, then to access those APIs, you must pass the generated Application Key. Whereas, if APIs are protected via OAuth policy, then to access those APIs, you must pass an OAuth token that can be obtained by using the combination of generated Application Key and Application Secret. - - - -## Creating an Application with Application Developer Role - -1. Log on to the API business hub enterprise. -2. Navigate to the *My Workspace* page. - - If you have created applications earlier, they’re displayed under the *Applications* section. For a created application, you can view the total number of calls made in the current month. - - > ### Note: - > By default, the *Cost* section displays the cost incurred in the last 6 months and the cost incurred in the current month. However, you can choose a month to view the cost incurred for that month. - - You can choose ![](images/Refresh_icon_ba1b5ab.png) to obtain the latest metering data. - - > ### Note: - > You might experience some delay before you see the latest metering data. - - Notation used to display the data is as per metric specifications, for example: - - - 999 shows as 999 and 1000 shows as 1k - - 999000 shows as 999K and 1000000 shows as 1M - - 1500000 shows as 1.5M and 1000000000 shows as 1G - -3. To create an application, choose ![](images/Add_icon_587bccc.png) in the *Applications* section. -4. In the *Create an Application* dialog, enter a `Title`, a `Description` \(optional\), and a `Callback URL` \(optional\) for the application. -5. Choose ![](images/Add_icon_587bccc.png) to add products to this application. -6. In the *Add Products* dialog, select the products that you want to associate with the application. - - > ### Note: - > You can select multiple products published from the same portal but you can't select products published from different portals. For example, you can select products P1 and P2 from API portal A1. But you can't choose products, P3 and P4 from API portal A2 if you've already selected P1 and P2 from A1. - -7. Choose *OK*. -8. Choose *Save*. - - > ### Note: - > While creating an application, if you’ve selected the *Take me to this new application now* checkbox, you’re directly navigated to the newly created application. - - The application you have created appears under the *Applications* section, and also under the *Applications* tab in API portal. - - > ### Note: - > If you open any created application, you notice that the system has generated an *API Key* automatically. Use this value to access the API. At any point in time, you can regenerate the API Key using *Regenerate Key* option. When you regenerate the key, both Application key and Secret key are changed. When you trigger API using the old key, then the response is negative. The old API key becomes invalid on regeneration. - - - - - - -## Creating an Application with API business hub enterprise Administrator Role - -A API business hub enterprise administrator can perform the following tasks: - -- Create an application on behalf of a user \(Application Developer\) and handover the application key and secret to that user. -- Create new applications in different landscapes\(example: production, nonproduction\) by maintaining the same application key and secret. -- Create custom attributes at application level and regulate the API call logic - -1. Log on to the API business hub enterprise. -2. Navigate to the *My Workspace* page. - - ![](images/My_Workspace_315b2dc.png) If you or other application developers have created applications earlier, they’re displayed under the *Applications* section. For a created application, you can view the total number of calls made in the current month. - - > ### Note: - > By default, the *Cost* section displays the cost incurred in the last 6 months and the cost incurred in the current month. However, you can choose a month to view the cost incurred for that month. - - > ### Note: - > For API business hub enterprise administrators, analytics data is unavailable for those applications that they created on behalf of other users or application developers. - - You can choose ![](images/Refresh_icon_ba1b5ab.png) to obtain the latest metering data. - - > ### Note: - > You might experience some delay before you see the latest metering data. - - Notion used to display the data is as per metric specifications, for example: - - - 999 shows as 999 and 1000 shows as 1k - - 999000 shows as 999K and 1000000 shows as 1M - - 1500000 shows as 1.5M and 1000000000 shows as 1G - -3. To create an application, under *Applications* section, choose ![](images/Add_icon_587bccc.png). -4. In the *Create an Application* dialog, enter a `Title`, a `Description` \(optional\), and a `Callback URL` \(optional\) for the application. -5. As an administrator, you have the option to create an application on behalf of a user \(Application Developer\). To achieve this task, select the *Create this application on behalf of someone else* checkbox and enter the `User ID` of the user on behalf of whom you are creating the application. If you already possess an application key and secret, then select the *Already have Application Key and Secret* checkbox and enter the `Application Key` and `Application Secret` . - - > ### Note: - > Application key and secret of an existing org can't be used in a new application in a new org. This implies that you'll not be able to use the same application key and secret in multiple orgs within the same data center and region. - -6. Choose ![](images/Add_icon_587bccc.png) to add products to this application. -7. In the *Add Products* dialog, select the products that you want to associate with the application. - - > ### Note: - > You can select multiple products. - -8. Choose *OK*. -9. Choose *Save*. - - > ### Note: - > While creating an application, if you’ve selected the *Take me to this new application now* checkbox, you’re directly navigated to the newly created application. - - The application you created appears under the *Applications* section, and also under the *Applications* tab in API portal. - - > ### Note: - > If you open any created application, you notice that the system has generated an *API Key* automatically. Use this value to access the API. At any point in time, you can regenerate the API Key using *Regenerate Key* option. When you regenerate the key, both Application key and Secret key are changed. When you trigger API using the old key, then the response is negative. The old API key becomes invalid on regeneration. - -10. Specify custom attributes. - 1. Under *My Workspace*, choose an application for which you want to add custom attributes. - 2. In the *Application Info* screen, under *Custom Attributes* section, choose ![](images/Add_icon_587bccc.png) to add a custom attribute. - 3. In the *Add Custom Attribute* dialog, enter a name and a value for your custom attribute and choose *Add*. - - > ### Note: - > You can create a maximum of 18 custom attributes per application. You cannot modify the name of a created custom attribute. However, you can modify its value whenever required. You can delete a custom attribute if it is no longer needed. - - For more information on the usage of custom attributes in an application, see [Example: Accessing the Custom Attributes of an Application](example-accessing-the-custom-attributes-of-an-application-1cbd94c.md). - - - 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 773d8a0f..5d462b59 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 *Configure* \> *APIs*. +4. Choose the navigation icon on the left and choose *Design* \> *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-new-message-implementation-guideline-b894de0.md b/docs/ISuite/50-Development/creating-a-new-message-implementation-guideline-b894de0.md index 7cda194d..24c37c6e 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 [Glossary for SAP Integration Advisor](../glossary-for-sap-integration-advisor-9c221b4.md). + 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:. 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 97267025..f4852ba5 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 @@ -363,54 +363,63 @@ 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. 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\)*. +21. The *Enable Syntax Validation* checkbox allows the system to validate the syntax using EDI splitter and this option is selected by default. Check/Uncheck the option if you want to enable or disable the syntax validation. + + > ### Note: + > This option applies only to the following sender type systems: + > + > - ASC X12 + > + > - UN/EDIFACT + +22. To archive the sender payload, select the checkbox for the field *Archive Sender Payload*. To know more about archiving data, see . +23. Choose the *Mapping* step. +24. 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. -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. +25. 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) -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*. +26. Choose the *Communication Channel* on the receiver side and select a value from the drop-down list for the field *Communication*. +27. 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) -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*. +28. Select the *Interchange* shape on the receiver side. +29. 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. -29. Select a value from the drop-down list for the field *Number Range*. +30. 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). -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*. +31. 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) -31. Provide the address path of your custom integration flow in the *Process Direct Address* field. +32. 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) -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. +33. 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. +34. To archive the receiver payload, select the checkbox for the field *Archive Receiver Payload*. To know more about archiving data, see . +35. 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. +36. 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: @@ -421,12 +430,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: +37. 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. +38. 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* @@ -437,7 +446,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*. +39. Choose *Save*. @@ -795,53 +804,64 @@ 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. 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\)*. +24. The *Enable Syntax Validation* checkbox allows the system to validate the syntax using EDI splitter and this option is selected by default. Check/Uncheck the option if you want to enable or disable the syntax validation. + + > ### Note: + > This option applies only to the following sender type systems: + > + > - ASC X12 + > + > - UN/EDIFACT + > + > This option is not editable if you have created the agreement with reference mode \(created using *Bind with Template* option\). + +25. To archive the sender payload, select the checkbox for the field *Archive Sender Payload*. To know more about archiving data, see +26. Choose the *Mapping* step. +27. 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. -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. +28. 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) -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*. +29. Choose the *Communication Channel* on the receiver side and select a value from the drop-down list for the field *Communication*. +30. 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) -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*. +31. Select the *Interchange* shape on the receiver side. +32. 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. -32. Select a value from the drop-down list for the field *Number Range*. +33. 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). -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*. +34. 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) -34. Provide the address path of your custom integration flow in the *Process Direct Address* field. +35. 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) -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. +36. 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. +37. To archive the receiver payload, select the checkbox for the field *Archive Receiver Payload*. To know more about archiving data, see +38. 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: @@ -852,12 +872,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. -38. If you have enabled *Receiver Functional Acknowledgement*, choose *Communication* on the receiver side and set the following values: +39. 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 -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. +40. 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* @@ -868,7 +888,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. -40. Choose *Save*. +41. 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 308baf2b..aef3468c 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 @@ -18,8 +18,9 @@ Follow the procedure below to create a trading partner profile 1. Log on to your Integration Suite . 2. Choose *Design* \> *B2B Scenarios*. -3. Navigate to the *Trading Partners* tab and choose *Create* to add a new trading partner. -4. Under the *Overview* tab, maintain the following fields under the *Details* section +3. Navigate to the *Partner Profiles* tab. +4. Choose *Create* and select *Trading Partner* to add a new trading partner. +5. Under the *Overview* tab, maintain the following fields under the *Details* section **Details** @@ -75,8 +76,8 @@ Follow the procedure below to create a trading partner profile -5. You can also provide the address of your company under the *Address* section. -6. Choose *Save* . +6. You can also provide the address of your company under the *Address* section. +7. Choose *Save* . > ### Note: > The *Logo* field is disabled initially. You can upload an image after saving the above mentioned entries. To do so, choose *Edit* and select *Browse* to search and upload your company logo. 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 124e7e57..75ea239b 100644 --- a/docs/ISuite/50-Development/creating-an-agreement-template-9692cb1.md +++ b/docs/ISuite/50-Development/creating-an-agreement-template-9692cb1.md @@ -30,7 +30,11 @@ Follow the next procedure to create an agreement template. 3. Navigate to the *Agreement Templates* tab and choose *Create*. -4. In the *Overview* tab, enter the following details under the *Details* section: +4. In the *Create Agreement Template* dialog, enable the *Include Communication Partner* toggle button if you want to include a communication partner in the agreement templet. + +5. If the *Include Communication Partner* is selected, the field *Communication Partners* gets enabled. Select a communication partner from the drop-down list and choose *Create*. + +6. In the *Overview* tab, enter the following details under the *Details* section: @@ -84,7 +88,7 @@ Follow the next procedure to create an agreement template.
-5. Maintain the following fields under *My Company Details* section +7. Maintain the following fields under *My Company Details* section. The field *Company Name* is autofilled by default. @@ -181,7 +185,7 @@ Follow the next procedure to create an agreement template.
-6. Under *Common Trading Partner Details* fill in the following details: +8. Under *Common Details* fill in the following details: @@ -200,7 +204,7 @@ Follow the next procedure to create an agreement template.
- **Alias for System** + **System Alias** @@ -271,13 +275,11 @@ Follow the next procedure to create an agreement template.
-7. Choose *Save*. Once you save the agreement template, the template also displays the *Purpose* of the type system you chose. - -8. Navigate to the *B2B Scenarios* tab and choose *Edit*. +9. Choose *Save*. Once you save the agreement template, the template also displays the *Purpose* of the type system you chose. -9. Choose *Create Business Transaction*. +10. Navigate to the *B2B Scenarios* tab and choose *Create Business Transaction*. -10. Maintain the following details: +11. In the *Create Business Transaction* dialog, maintain the following details: @@ -331,21 +333,21 @@ Follow the next procedure to create an agreement template.
-11. Choose *Save*. A new entry gets created. +12. Choose *Save*. A new entry gets created. -12. In the newly created transaction, choose the *Communication Channel* step on the sender side. +13. In the newly created transaction, choose the *Communication Channel* step on the sender side. -13. Select a value from the drop-down list for the field *Communication*. +14. Select a value from the drop-down list for the field *Communication*. -14. Select a value from the drop-down list for the field *Communication for Sender Functional Acknowledgement*. +15. Select a value from the drop-down list for the field *Communication for Sender Functional Acknowledgement*. This field appears only for AS2 adapter. -15. Select the *Interchange* step on the sender side. +16. Select the *Interchange* step on the sender side. -16. Choose the value help provided for the *Message Implementation Guideline \(MIG\)* field. +17. Choose the value help provided for the *Message Implementation Guideline \(MIG\)* field. -17. Select a MIG from the list along with the required version and select *Choose*. +18. Select a MIG from the list along with the required version 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. You can also directly view the message type used in the MIG displayed under the *Message Type* field. @@ -364,9 +366,9 @@ Follow the next procedure to create an agreement template. > > Tradacoms is supported only in the 2.0 version of the integration package *Cloud Integration - Trading Partner Management V2* -18. For Type Systems *ASC X12* and *UN/EDIFACT*, you can edit their version numbers in the *Type System Version* field. +19. For Type Systems *ASC X12* and *UN/EDIFACT*, you can edit their version numbers in the *Type System Version* field. -19. Select a value from the drop-down list for the field *Create Functional Acknowledgement*. +20. Select a value from the drop-down list for the field *Create Functional Acknowledgement*. This field appears only for the following type systems: @@ -376,42 +378,50 @@ 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) -20. If you are planning to use custom integration flows for Pre-Processing of your interchange step, then enable the checkbox under *Custom Integration Flow*. +21. If you are planning to use custom integration flows for Pre-Processing of your interchange step, then enable the checkbox under *Custom Integration Flow*. -21. Provide the address of your custom integration flow in the *Process Direct Address* field. +22. 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). -22. If you want to enable the payload validation, select the checkbox under *Validation Option*. +23. If you want to enable the payload validation, select the checkbox under *Validation Option*. + +24. The *Syntax Validation* checkbox is selected by default to enable syntax validation through the EDI splitter. If you do not want to use this validation, you can disable this option. + + This field appears only for the following type systems: + + - UN/EDIFACT + + - ASC X12 -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) +25. To archive the sender payload, select the checkbox for the field *Archive Sender Payload*. To know more about archiving data, see -24. Similarly, choose the *Communication Channel* on the receiver side and enter a value for the field *Alias for Communication*. +26. 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*. +27. Select a value from the drop-down list for the field *Receiver Functional Acknowledgement Channel*. This field appears only for AS2 adapter. -26. Select the *Interchange* shape on the receiver side. +28. 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*. +29. 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. -28. Enter an alias value for the field *Number Range Alias*. +30. 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). -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*. +31. 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*. -30. Provide the address of your custom integration flow in the *Process Direct Address* field. +32. 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) -31. Select the *Enable* checkbox under *Receiver Functional Acknowledgement* if you want to enable the functional acknowledgement for the receiver. +33. 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: @@ -421,23 +431,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) -32. If you want to enable the payload validation, select the checkbox under *Validation Option*. +34. 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). +35. To archive the receiver payload, select the checkbox for the field *Archive Receiver Payload*. To know more about archiving data, see . -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. +36. 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 *Mapping* step of the transaction. +37. Select the *Mapping* step of the transaction. -36. Select a mapping guideline and its corresponding version using the value help for the *Mapping Guideline\(MAG\)* field. +38. Select a mapping guideline and its corresponding version using the value help for the *Mapping Guideline\(MAG\)* field. -37. If you want to custom integration flow for the mapping processing, enable the checkbox for the field *Customized Mapping Processing*. +39. If you want to custom integration flow for the mapping processing, enable the checkbox for the field *Customized Mapping Processing*. -38. Provide the address of your integration flow in the *Process Direct Address* field. +40. Provide the address of your integration flow in the *Process Direct Address* field. -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. +41. 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. -40. Choose *Add Parameters*. This will display the following options: +42. 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*. @@ -449,11 +459,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*. -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. +43. 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). -42. Choose *Add* and maintain the following fields: +44. Choose *Add* and maintain the following fields: @@ -531,7 +541,7 @@ Follow the next procedure to create an agreement template.
-43. Choose *Save*. +45. Choose *Save*. 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 deleted file mode 100644 index 612715bc..00000000 --- a/docs/ISuite/50-Development/creating-an-imported-archives-artifact-e555caf.md +++ /dev/null @@ -1,104 +0,0 @@ - - -# 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 578c3d56..2684173c 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/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 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:. diff --git a/docs/ISuite/50-Development/creating-data-types-and-message-types-d5bbbee.md b/docs/ISuite/50-Development/creating-data-types-and-message-types-d5bbbee.md index bac4433e..208eb878 100644 --- a/docs/ISuite/50-Development/creating-data-types-and-message-types-d5bbbee.md +++ b/docs/ISuite/50-Development/creating-data-types-and-message-types-d5bbbee.md @@ -29,7 +29,7 @@ You can use the Message Type artifacts in message mapping and integration flows 3. Navigate to the *Artifacts* tab and choose *Add* \> *Data Type* or *Add* \> *Message Type* to add a data Type or message Type artifact. -4. In the dialog box, *ES Repository* appears as the *Source*. You see the details populated in *Name* and *Address* fields. +4. In the dialog box, *ES Repository* appears as the *Source*. Choose the ES Repository *Name*. The *Address* is automaticaly populated. 5. Choose *Connect*. A list of available data types or message types in ES repository appears. 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 78f87269..0cd60c5f 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,8 +145,6 @@ 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. 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 fa216c29..820cb228 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 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. +- 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). + @@ -167,37 +167,21 @@ 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 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. +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*. - -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. +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. 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). - > ### 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*. +8. Choose *Add*. A message mapping artifact is created. - If there are dependent objects, they are imported appropriately. References to the dependent objects are also 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. -11. Open the message mapping artifact and choose *Edit* to change the source and target messages, create mappings, and perform operations. Choose *Save*. +9. Open the message mapping artifact and choose *Edit* to change the source and target messages, create mappings, and perform operations. Choose *Save*. -12. Choose *Deploy*. +10. 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 deleted file mode 100644 index ca8b8d0f..00000000 --- a/docs/ISuite/50-Development/creating-oauth-client-credentials-for-cloud-foundry-environment-50b63c6.md +++ /dev/null @@ -1,71 +0,0 @@ - - - - -# 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/cross-actions-69bec18.md b/docs/ISuite/50-Development/cross-actions-69bec18.md index 8f4d4a9a..bf7764cd 100644 --- a/docs/ISuite/50-Development/cross-actions-69bec18.md +++ b/docs/ISuite/50-Development/cross-actions-69bec18.md @@ -9,4 +9,5 @@ You can now perform cross actions on Agreements such as, import and export. - [Update MIGs/MAGs](update-migs-mags-c47533b.md) - [Activate/Deactivate Agreements](activate-deactivate-agreements-e068e37.md) +- diff --git a/docs/ISuite/50-Development/custom-type-systems-884bb25.md b/docs/ISuite/50-Development/custom-type-systems-884bb25.md index c3aaf0fa..035d5423 100644 --- a/docs/ISuite/50-Development/custom-type-systems-884bb25.md +++ b/docs/ISuite/50-Development/custom-type-systems-884bb25.md @@ -4,15 +4,16 @@ # Custom Type Systems -The library of custom type systems allows you to upload custom messages, IDocs and SOA messages – this enables you to create MIGs and MAGs based on your own message structures. Use cases for this could be proprietary messages, standard messages extended by you and messages from B2B standards not available in the system. Within each custom type system, you can: +The library of custom type systems allows you to upload custom messages, IDocs, SOA messages and custom codelists – this enables you to create MIGs and MAGs based on your own message structures. Use cases for this could be proprietary messages, standard messages extended by you and messages from B2B standards not available in the system. Within each custom type system, you can: - Create custom messages based on xsd and wsdl files +- Create custom codelists - Create MIG and MAG - Customize your MIG - View the list of your custom messages -To upload and use custom messages, you need to have a custom type system. Follow the procedure given below to do the same. +To upload and use custom messages/codelists, you need to have a custom type system. Follow the procedure given below to do the same. @@ -25,7 +26,7 @@ To upload and use custom messages, you need to have a custom type system. Follow 2. Choose *Add* to create a custom type system. > ### Note: - > Currently the application supports only one custom type system for each kind \(XML/IDoc/SOA\). + > Currently the application supports only one custom type system for each kind \(XML/IDoc/SOA/Codelists\). 3. Choose and open the type system. The *Overview* tab provides you with the following details : - General information @@ -36,3 +37,5 @@ To upload and use custom messages, you need to have a custom type system. Follow To know how to add a message to the custom type system, see: [Adding a Custom Message](adding-a-custom-message-8b7eb45.md). +To know how to add a codelist to the custom type system, see: [Adding a Custom Codelist](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/fa0c76f3a3834580be89674c25c5a230.html "Create and add a codelist to the Custom Codelist.") :arrow_upper_right:. + diff --git a/docs/ISuite/50-Development/data-storages-31efe35.md b/docs/ISuite/50-Development/data-storages-31efe35.md index a556b774..92e5334c 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 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. +During the processing of an integration flow, Cloud IntegrationCloud Integration 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\). +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 As soon as the message has been consumed successfully, it isn't available anymore in the queue. diff --git a/docs/ISuite/50-Development/data-types-97ad101.md b/docs/ISuite/50-Development/data-types-97ad101.md index c0343187..273092ab 100644 --- a/docs/ISuite/50-Development/data-types-97ad101.md +++ b/docs/ISuite/50-Development/data-types-97ad101.md @@ -97,7 +97,11 @@ Displays the restriction of the value range of a built-in data type for simple d -Select a row to view the following details. To edit a data type, choose *Edit* and select the node to edit its details: + + +### + +Select a row to view the following details. To edit a data type, select the respective node and choose *Edit*. **Element/Attribute Details** @@ -163,10 +167,10 @@ Choose a type for an element or attribute: - Primitive Type: From the *Value* field, select a built-in data type \(example string, decimal, or integer\) -- Data Type: Choose *Select* to assign a referenced data type from the existing data types. The structure of the selected data type gets loaded in the tree table. +- Data Type: To assign a user defined data type, choose *Select*. Choose the integration packages from which you wish to list the data type and select the one to be reused. The structure of the selected data type gets loaded in the tree table. > ### Note: - > For root node and for child attribute nodes only Simple Type data types can be assigned. Hence, only Simple Type data types from the selected packages are listed. The data types that are currently being edited are excluded from the list. + > While referencing, only Simple Type data types can be assigned for root node and child attribute nodes. Hence, only Simple Type data types from the selected packages are listed. The data types that are currently being edited are excluded from the list. > ### Note: @@ -188,7 +192,7 @@ Namespace -Displays the namespace to which the referenced data type belongs to or where it's created. +Displays the namespace to which the user defined data type belongs to or where it's created. @@ -202,7 +206,7 @@ Package Name -Displays the package name of the data type reference assigned to the node. +Displays the package name of the user defined data type assigned to the node. @@ -374,6 +378,244 @@ collapse: Similar to replace but subsequent blanks are replaced by a single blan +**Adding Child Nodes** + +To add elements and attributes while editing the data type, follow these steps: + +1. Select the node where you want to add a child element or attribute. +2. Choose *Edit*. +3. Choose *Add* and select whether you wish to add Element or Attribute. If you wish to add multiple row of element or attributes, choose *Rows*. Specify the number of rows to be added and choose *Add*. Refer the following table to understand when and where can you add the elements and attributes. + + **** + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + Node + + + + Category + + + + Type + + + + Add Element + + + + Add Attribute + +
+ + Root + + + + Complex + + + + Assigned \(Any\) + + + + No + + + + Yes + +
+ + Root + + + + Complex + + + + Not Assigned + + + + Yes + + + + Yes + +
+ + Any + + + + Simple + + + + Any + + + + No + + + + No + +
+ + Child + + + + Element + + + + Primitive or User defined Simple Data Type + + + + No + + + + Yes + +
+ + Child + + + + Element + + + + User Defined Complex Data Type + + + + No + + + + No + +
+ + Child + + + + Element + + + + Not Assigned + + + + Yes + + + + Yes + +
+ + Child + + + + Attribute + + + + Any + + + + No + + + + No + +
+ + +**Saving Data Types** + +Choose *Save* to save the draft. Choose*Save as version* to save the data type with a new version. All modifications are reflected in XSD tab. + +> ### Note: +> You can save te artifact even if you have validation errors in your *Structure* tab. + @@ -498,19 +740,6 @@ ES Repository Information Displays the XML Schema Definition \(XSD\) that is, the text view of the data type in read-only mode. - - - - -## Saving Data Types - -Choose *Save* to save the draft. All modifications are refelcted in XSD tab. - -Choose*Save as version* to save the Data Type with a new version. All modifications are reflected in XSD tab. - -> ### Note: -> You can use *Save* and*Save as version* even if you have validation errors in your *Structure* tab. - **Related Information** 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 24d0abc0..5711d35f 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.14 +1.7 R4 diff --git a/docs/ISuite/50-Development/define-content-modifier-8f04a70.md b/docs/ISuite/50-Development/define-content-modifier-8f04a70.md index 1ad94153..12c0905f 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 *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*. + 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*. > ### 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 52d17edb..cf13150b 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 a database. Note that there's an overall database size limit of 32 GB. +This component stores data on your tenant \(using SAP ASE Platform Edition\). Note that there is an overall DB space 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 57ec2893..ac8381c6 100644 --- a/docs/ISuite/50-Development/define-edi-splitter-584a3be.md +++ b/docs/ISuite/50-Development/define-edi-splitter-584a3be.md @@ -364,7 +364,28 @@ You use the EDI splitter to split inbound bulk EDI messages, and configure the s - Number range + Unique Interchange Number + + + + + Following are the options to generate a unique interchange number while generating a acknowledgment message: + + - *Required*: EDI Splitter can generate a unique interchange number, which is the incremented value from the number range object and does not depend on the interchange number of the incoming payload. + - *Not Required*: Does not generate a unique interchange number. + - *Dynamic*: You can also set this field using the header `SAP_EDISPLITTER_EDIFACT_UNIQUE_INTERCHANGE_NUMBER`. The values for the headers can be one of the following: + - `required` + - `notRequired` + + + + + + + + + + Number Range @@ -606,6 +627,27 @@ You use the EDI splitter to split inbound bulk EDI messages, and configure the s + + + + + + Unique Interchange Number + + + + + Following are the options to generate a unique interchange number while generating a acknowledgment message: + + - *Required*: EDI Splitter can generate a unique interchange number, which is the incremented value from the number range object and does not depend on the interchange number of the incoming payload. + - *Not Required*: Does not generate a unique interchange number. + - *Dynamic*: You can also set this field using the header `SAP_EDISPLITTER_EDIFACT_UNIQUE_INTERCHANGE_NUMBER`. The values for the headers can be one of the following: + - `required` + - `notRequired` + + + + diff --git a/docs/ISuite/50-Development/define-message-digest-e5d2867.md b/docs/ISuite/50-Development/define-message-digest-e5d2867.md index bd53dd49..0cda2748 100644 --- a/docs/ISuite/50-Development/define-message-digest-e5d2867.md +++ b/docs/ISuite/50-Development/define-message-digest-e5d2867.md @@ -101,6 +101,14 @@ You can use this feature to implement scenarios like the following ones: More information: [http://www.w3.org/2001/10/xml-exc-c14n\#WithComments](http://www.w3.org/2001/10/xml-exc-c14n#WithComments) + - *XML Canonicalization Version 1.1* + + More information: [http://www.w3.org/2006/12/xml-c14n11](http://www.w3.org/2006/12/xml-c14n11) + + - *XML Canonicalization with Comments Version 1.1* + + More information: [http://www.w3.org/2006/12/xml-c14n11\#WithComments](http://www.w3.org/2006/12/xml-c14n11#WithComments) + - *None* @@ -126,6 +134,9 @@ You can use this feature to implement scenarios like the following ones: - *SHA-384* - *SHA-512* + > ### Caution: + > Algorithms starting with SHA1, MD2, or MD5 are still supported for compatibility reasons, but they no longer meet today's security requirements. Therefore, we recommend using stronger algorithms where possible. Check with your security experts or authorities like NIST for more detailed security recommendations. + diff --git a/docs/ISuite/50-Development/define-multicast-17de3ea.md b/docs/ISuite/50-Development/define-multicast-17de3ea.md index 27e69f99..c5801a50 100644 --- a/docs/ISuite/50-Development/define-multicast-17de3ea.md +++ b/docs/ISuite/50-Development/define-multicast-17de3ea.md @@ -10,21 +10,6 @@ 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-pgp-encryptor-7a07766.md b/docs/ISuite/50-Development/define-pgp-encryptor-7a07766.md index ce7ae4ae..438441bb 100644 --- a/docs/ISuite/50-Development/define-pgp-encryptor-7a07766.md +++ b/docs/ISuite/50-Development/define-pgp-encryptor-7a07766.md @@ -181,6 +181,11 @@ You use the PGP Encryptor to encrypt or sign and encrypt the payload using OpenP The signature is created by transferring the message content into a digest \(hash value\) using a digest algorithm. Supported signature algorithms for PGP signing: MD5, RIPE-MD/160, SHA-1, SHA224, SHA256, SHA384, SHA512. + + > ### Caution: + > Algorithms starting with SHA1, MD2, or MD5 are still supported for compatibility reasons, but they no longer meet today's security requirements. Therefore, we recommend using stronger algorithms where possible. Check with your security experts or authorities like NIST for more detailed security recommendations. + + 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 f33b9388..102c8b86 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 @@ -32,11 +32,6 @@ XML to EDI Converter version 2.0 and above supports the TRADACOMS standard \(*TR - Tab - - - - Field @@ -47,11 +42,13 @@ XML to EDI Converter version 2.0 and above supports the TRADACOMS standard \(*TR - + - General + **General** + + Name @@ -64,11 +61,13 @@ XML to EDI Converter version 2.0 and above supports the TRADACOMS standard \(*TR - + - EDIFACT + **EDIFACT** + + Source Encoding @@ -76,7 +75,12 @@ XML to EDI Converter version 2.0 and above supports the TRADACOMS standard \(*TR - Select encoding format for the incoming payload. + Select encoding format for the incoming payload. The following encoding formats are available: + + - UTF-8 + - ISO-8859-1 + + @@ -88,7 +92,7 @@ XML to EDI Converter version 2.0 and above supports the TRADACOMS standard \(*TR - Select encoding format for the outgoing payload. If you select 'Dynamic', you must define either of the values in SAP\_XMLTOEDI\_EDIFACT\_TARGET\_ENCODING exchange header: + Select encoding format for the outgoing payload. If you select 'Dynamic', you must define either of the following values in SAP\_XMLTOEDI\_EDIFACT\_TARGET\_ENCODING exchange header: - UTF-8 - ISO-8859-1 to ISO-8859-9 @@ -106,7 +110,13 @@ XML to EDI Converter version 2.0 and above supports the TRADACOMS standard \(*TR - Select the source of schema definition. + Select the source of schema definition. To specify the schema definition, there are the following options: + + - Integration Flow + + - Header + + @@ -118,7 +128,7 @@ XML to EDI Converter version 2.0 and above supports the TRADACOMS standard \(*TR - 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. + If you select `Integration Flow` as *EDI Schema Definition*, then you can see the table *Schemas*, in *Properties* view. Choose *Add* \> *Select* to 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 the topic **Validating Message Payload against XML Schema**, in developer's guide. @@ -150,7 +160,7 @@ XML to EDI Converter version 2.0 and above supports the TRADACOMS standard \(*TR - If you select Header as *EDI Schema Definition*, then you can see the field *HeaderName*, in *Properties* view. Enter a valid header name for the field. + If you select Header as *EDI Schema Definition*, then you can see the field *HeaderName*. Enter a valid header name for the field. > ### Note: > This header name is fetched from Camel header. The header is added in script element. This script element is added before the converter element. You can add value for this header in the script element. @@ -169,7 +179,13 @@ 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 type. + 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: + + - *Segment Terminator*: This character is used to indicate the end of a segment. + - *Composite Separator*: This is a separator between component data elements within a composite data element. + - *Data Element Separator*: This is a separator between two simple or composite data element. + - *Escape Character*: This is used when one of the separator characters is to be used within a data element or to restore separator and terminator signs to their normal meaning. + - *Decimal Character*: This is used to determine decimal character of outgoing payload. You can choose the value as *Comma \(,\)*, *Dot \(.\)* or *Dynamic* for the converted message. If you select 'Dynamic', you must define the hexadecimal value ‘\#x2e’ for dot or ‘\#x2c’ for comma in `SAP_XMLTOEDI_DECIMAL_CHARACTER` header. > ### Note: > You can also manually specify the custom separator. @@ -182,11 +198,13 @@ XML to EDI Converter version 2.0 and above supports the TRADACOMS standard \(*TR - + - X12 + **X12** + + Source Encoding @@ -194,7 +212,12 @@ XML to EDI Converter version 2.0 and above supports the TRADACOMS standard \(*TR - Select encoding format for the incoming payload. + Select encoding format for the incoming payload. The following encoding formats are available: + + - UTF-8 + - ISO-8859-1 + + @@ -206,7 +229,24 @@ XML to EDI Converter version 2.0 and above supports the TRADACOMS standard \(*TR - 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. + Select the source of schema definition. To specify the schema definition, there are the following options: + + - Integration Flow + - Header + + + + + + + + + Schemas + + + + + If you select Integration Flow as *EDI Schema Definition*, then you can see the table *Schemas*, in *Properties* view. Choose *Add* \> *Select* to 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 the topic *Validating Message Payload against XML Schema*, in developer's guide. @@ -230,7 +270,7 @@ XML to EDI Converter version 2.0 and above supports the TRADACOMS standard \(*TR - If you select Header as *EDI Schema Definition*, then you can see the field *HeaderName*, in *Properties* view. Enter a valid header name for the field. + If you select Header as *EDI Schema Definition*, then you can see the field *HeaderName*. Enter a valid header name for the field. > ### Note: > This header name is fetched from camel header. The header is added in script element. This script element is added before converter element. You can add value for this header in the script element. 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 5c625404..3c8e4e28 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 249f9449..10050ca4 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/developing-script-and-script-collection-e60f706.md b/docs/ISuite/50-Development/developing-script-and-script-collection-e60f706.md index 898319ef..4036e287 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. +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:. diff --git a/docs/ISuite/50-Development/development-de1ae81.md b/docs/ISuite/50-Development/development-de1ae81.md index b589b19c..831deb85 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/4425026877144cc2b15505ed30215167/IAT/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/66d066d903c2473f81ec33acfe2ccdb4/Cloud/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 API Proxies](analyze-api-proxies-7712c61.md) +[Analyze APIs](analyze-apis-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: @@ -458,7 +458,7 @@ Documentation template for MIGs and MAGs. -[Documentation Export and Settings](documentation-export-and-settings-4c442af.md) +[Settings for MIGs and MAGs](settings-for-migs-and-mags-4c442af.md) diff --git a/docs/ISuite/50-Development/enabling-anomaly-detection-98534a0.md b/docs/ISuite/50-Development/enabling-anomaly-detection-98534a0.md new file mode 100644 index 00000000..fe2ece65 --- /dev/null +++ b/docs/ISuite/50-Development/enabling-anomaly-detection-98534a0.md @@ -0,0 +1,60 @@ + + +# Enabling Anomaly Detection + +To detect anomalies for API proxy calls, you need to enable the anomaly detection setting. + + + + + +## Prerequisites + +The role collection *APIPortal.Administrator* should be assigned to you. + +> ### Note: +> The availability of the anomaly detection feature 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://me.sap.com/notes/2903776) and [3463620](https://me.sap.com/notes/3463620). + + + + + +## Context + +To enable anomaly detection through the SAP Integration Suite, follow the steps below: + + + +## Procedure + +1. Log on to the SAP Integration Suite. + +2. Click on the navigation icon on the left and select *Settings* \> *APIs*. + +3. Go to the *Anomaly Detection* tab. + +4. Toggle the radio button to the *ON* position. + + ![](images/EnablingAD_e6005c2.png) + + > ### Note: + > Disabling the Anomaly Detection feature will delete all associated anomaly data. + + + + + + +## Results + +Anomaly Detection for API proxy calls is now enabled. + +**Related Information** + + +[Configuring APIs for Anomaly Detection](configuring-apis-for-anomaly-detection-9e7e5d1.md "View or configure APIs for anomaly detection.") + +[Working with Detected Anomalies](working-with-detected-anomalies-1c677b2.md "Access and analyze anomalies in the analytics dashboard. Discover details about the various types of anomalies, evaluate and resolve them.") + +[Subscribing to Email Notification Alerts](subscribing-to-email-notification-alerts-88e96f4.md "Receive real-time email alerts for anomaly detection services.") + 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 c0012963..01816c8f 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/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 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 **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/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 **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:. diff --git a/docs/ISuite/50-Development/encrypt-and-sign-the-message-content-with-pkcs-7-cms-encryptor-21fd211.md b/docs/ISuite/50-Development/encrypt-and-sign-the-message-content-with-pkcs-7-cms-encryptor-21fd211.md index 952b8800..e521422f 100644 --- a/docs/ISuite/50-Development/encrypt-and-sign-the-message-content-with-pkcs-7-cms-encryptor-21fd211.md +++ b/docs/ISuite/50-Development/encrypt-and-sign-the-message-content-with-pkcs-7-cms-encryptor-21fd211.md @@ -170,6 +170,9 @@ In addition to encrypting the message content, you can also sign the content to Signature algorithms: MD5/RSA, RIPEMD128/RSA, RIPEMD160/RSA, RIPEMD256/RSA, SHA/RSA, SHA224/RSA, SHA256/RSA, SHA384/RSA, SHA512/RSA. + > ### Caution: + > Algorithms starting with SHA1, MD2, or MD5 are still supported for compatibility reasons, but they no longer meet today's security requirements. Therefore, we recommend using stronger algorithms where possible. Check with your security experts or authorities like NIST for more detailed security recommendations. + - *Include Certificates* If you activate this option \(value `true`\), the certificate chain corresponding to the private key will be added to the SignedAndEnvelopedData element. diff --git a/docs/ISuite/50-Development/engage-1036845.md b/docs/ISuite/50-Development/engage-1036845.md index 3f8256a1..c8c603c4 100644 --- a/docs/ISuite/50-Development/engage-1036845.md +++ b/docs/ISuite/50-Development/engage-1036845.md @@ -29,7 +29,7 @@ Applicable to: API Administrator -[Consume API Proxies](consume-api-proxies-ea561e4.md) +[Consume API Proxies](../consume-api-proxies-ea561e4.md) diff --git a/docs/ISuite/50-Development/example-accessing-the-custom-attributes-of-an-application-1cbd94c.md b/docs/ISuite/50-Development/example-accessing-the-custom-attributes-of-an-application-1cbd94c.md deleted file mode 100644 index e45aa164..00000000 --- a/docs/ISuite/50-Development/example-accessing-the-custom-attributes-of-an-application-1cbd94c.md +++ /dev/null @@ -1,80 +0,0 @@ - - -# Example: Accessing the Custom Attributes of an Application - -Let’s say as a Developer Portal Administrator, you would want to restrict the number of calls to an application based on Application Key. To achieve this result, you create two applications `Application_1` and `Application_2`. - -`Application_1` contains two products namely `Prod_1` and `Prod_2`. - -`Application_2` contains two products namely `Prod_3` and `Prod_4`. - -`Prod_1` and `Prod_2`contain two common APIs namely `API_1` and `API_2`. - -For `Application_1`, add the following custom attributes and its corresponding values: - -- app\_time\_unit = minute -- app\_quota\_interval = 1 -- app\_quota\_count = 9 - -For `Application_2`, add the following custom attributes and its corresponding values: - -- app\_time\_unit = minute -- app\_quota\_interval = 1 -- app\_quota\_count = 5 - -To leverage these custom attributes in your API proxy execution, you must: - -- add a verify API Key policy to the APIs that are part of your application. -- add a Quota policy to APIs that are part of your application. - -For `API_1` and `API_2`, add the following sample policy payloads: - -Sample payload for Verify API Key policy: - -> ### Sample Code: -> ``` -> -> xmlns='http://www.sap.com/apimgmt'> -> -> -> ``` - -Sample payload for Quota policy: - -> ### Sample Code: -> ``` -> -> -> -> -> -> -> -> -> -> true -> -> 2015-2-11 12:00:00 -> -> true -> -> -> -> -> -> ``` - -> ### Note: -> The attribute names `app_quota_interval`, `app_quota_count`, and `app_time_unit` must be the same attributes that you have added while creating the application. - -To verify if the custom attributes are used in runtime, make an API call with `` passed as a query parameter. For example, `https://?apikey=`. - -Call the same URL repeatedly and after 9 successive calls, your API proxy must return a Quota violation message. - -Similarly, make an API call with `` passed as a query parameter. For example,`https://?apikey=`. - -Call the same URL repeatedly and after 6 successive calls, your API proxy must return a Quota violation message. - diff --git a/docs/ISuite/50-Development/externally-managed-apis-848015d.md b/docs/ISuite/50-Development/externally-managed-apis-848015d.md index e94c403e..d2c6433d 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 add and view APIs that are not managed by SAP Integration Suite but by some other API Management solution. +You can manage 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,8 +21,3 @@ 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/general-scripting-guidelines-fcbf0f2.md b/docs/ISuite/50-Development/general-scripting-guidelines-fcbf0f2.md index e4cdc3fe..f9da222e 100644 --- a/docs/ISuite/50-Development/general-scripting-guidelines-fcbf0f2.md +++ b/docs/ISuite/50-Development/general-scripting-guidelines-fcbf0f2.md @@ -96,4 +96,33 @@ Follow these general guidelines when using the *Script* step. To learn what to do instead of using this method, see SAP note [3289679](https://me.sap.com/notes/3289679). +- Define your script’s import statement so that it consumes native APIs from one of the following APIs: + + - SDK Groovy API + + See: + + [SDK API](sdk-api-c5c7933.md) + + [Groovy SDK Java doc](https://help.sap.com/doc/a56f52e1a58e4e2bac7f7adbf45b2e26/Cloud/en-US/index.html) + + - Native Groovy APIs + + See: [Groovy JDK API Documentation](https://groovy-lang.org/gdk.html) + + In particular, all supported APIs up to Groovy runtime version 2.4.21 are supported. + + See also: [Define a Local Script Step](define-a-local-script-step-03b32eb.md) + + - APIs from the Cloud Integration stack, that means, jar files that are bundled in the Cloud Integration software assembly + + + We don’t recommend to consume external code \(uploaded as integration flow resource\). If you do so, a warning is raised. + +- Use CodeNarc to analyze your Groovy code for defects, bad practices, inconsistencies, and style issues, for example \(static check\). + + Supported CodeNarc version: 3.4.0 + + See: [CodeNarc](https://github.com/CodeNarc/CodeNarc) + diff --git a/docs/ISuite/50-Development/getting-started-with-b2b-scenarios-in-sap-integration-suite-ba066bb.md b/docs/ISuite/50-Development/getting-started-with-b2b-scenarios-in-sap-integration-suite-ba066bb.md index 97b63f96..07b9a762 100644 --- a/docs/ISuite/50-Development/getting-started-with-b2b-scenarios-in-sap-integration-suite-ba066bb.md +++ b/docs/ISuite/50-Development/getting-started-with-b2b-scenarios-in-sap-integration-suite-ba066bb.md @@ -7,7 +7,8 @@ Let us get started with creating B2B scenarios in SAP Integration Suite. The ste 1. Creating a company profile 2. Creating a trading partner profile -3. Creating a trading partner agreement template +3. Creating a communication partner profile +4. Creating a trading partner agreement template **Related Information** @@ -16,5 +17,7 @@ Let us get started with creating B2B scenarios in SAP Integration Suite. The ste [Creating a Trading Partner Profile](creating-a-trading-partner-profile-542fb11.md "A trading partner is a company, organization, or a subsidiary that conducts e-business (B2B) with other companies, organizations or subsidiaries.") + + [Creating an Agreement Template](creating-an-agreement-template-9692cb1.md "An agreement template is a template of a semantical choreography definition consisting of one or more business transactions. The configurations at the template level serve as defaults that can then be reused and overridden when creating the trading partner agreement.") 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 a90f378f..0ced7842 100644 --- a/docs/ISuite/50-Development/guidelines-on-role-assignments-fc409e8.md +++ b/docs/ISuite/50-Development/guidelines-on-role-assignments-fc409e8.md @@ -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 for Cloud Integration](../60-Security/tasks-and-permissions-for-cloud-integration-556d557.md)\) +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:\) diff --git a/docs/ISuite/50-Development/images/ABHE_Connection_a5eb276.png b/docs/ISuite/50-Development/images/ABHE_Connection_a5eb276.png deleted file mode 100644 index 464e02e3..00000000 Binary files a/docs/ISuite/50-Development/images/ABHE_Connection_a5eb276.png and /dev/null differ diff --git a/docs/ISuite/50-Development/images/ActionBar_4479fe3.png b/docs/ISuite/50-Development/images/ActionBar_4479fe3.png new file mode 100644 index 00000000..ffd7bbb0 Binary files /dev/null and b/docs/ISuite/50-Development/images/ActionBar_4479fe3.png differ diff --git a/docs/ISuite/50-Development/images/Add_icon_587bccc.png b/docs/ISuite/50-Development/images/Add_icon_587bccc.png deleted file mode 100644 index ca9c9347..00000000 Binary files a/docs/ISuite/50-Development/images/Add_icon_587bccc.png and /dev/null differ diff --git a/docs/ISuite/50-Development/images/CPI_ODataAPI_a325b4e.png b/docs/ISuite/50-Development/images/CPI_ODataAPI_a325b4e.png deleted file mode 100644 index 95231626..00000000 Binary files a/docs/ISuite/50-Development/images/CPI_ODataAPI_a325b4e.png and /dev/null differ diff --git a/docs/ISuite/50-Development/images/CPI_OData_Authentication_2fc6272.png b/docs/ISuite/50-Development/images/CPI_OData_Authentication_2fc6272.png deleted file mode 100644 index b5bcfc50..00000000 Binary files a/docs/ISuite/50-Development/images/CPI_OData_Authentication_2fc6272.png and /dev/null differ diff --git a/docs/ISuite/50-Development/images/CPI_OData_Query2_6dae5cb.png b/docs/ISuite/50-Development/images/CPI_OData_Query2_6dae5cb.png deleted file mode 100644 index 5afb1356..00000000 Binary files a/docs/ISuite/50-Development/images/CPI_OData_Query2_6dae5cb.png and /dev/null differ diff --git a/docs/ISuite/50-Development/images/CatalogImage5_49e100b.png b/docs/ISuite/50-Development/images/CatalogImage5_49e100b.png deleted file mode 100644 index 4903eca9..00000000 Binary files a/docs/ISuite/50-Development/images/CatalogImage5_49e100b.png and /dev/null differ diff --git a/docs/ISuite/50-Development/images/ConnectListImage3_06ef74d.png b/docs/ISuite/50-Development/images/ConnectListImage3_06ef74d.png deleted file mode 100644 index ab698686..00000000 Binary files a/docs/ISuite/50-Development/images/ConnectListImage3_06ef74d.png and /dev/null 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 deleted file mode 100644 index 8ccc5dc4..00000000 Binary files a/docs/ISuite/50-Development/images/Coupa_Receiver_Adapter_dccbe44.png and /dev/null differ diff --git a/docs/ISuite/50-Development/images/CreateImage1_3bf6c81.png b/docs/ISuite/50-Development/images/CreateImage1_3bf6c81.png deleted file mode 100644 index 4b1d7431..00000000 Binary files a/docs/ISuite/50-Development/images/CreateImage1_3bf6c81.png and /dev/null differ diff --git a/docs/ISuite/50-Development/images/EnablingAD_e6005c2.png b/docs/ISuite/50-Development/images/EnablingAD_e6005c2.png new file mode 100644 index 00000000..73169635 Binary files /dev/null and b/docs/ISuite/50-Development/images/EnablingAD_e6005c2.png differ diff --git a/docs/ISuite/50-Development/images/GraphImage_7289bd3.png b/docs/ISuite/50-Development/images/GraphImage_7289bd3.png new file mode 100644 index 00000000..b7b8a05a Binary files /dev/null and b/docs/ISuite/50-Development/images/GraphImage_7289bd3.png differ diff --git a/docs/ISuite/50-Development/images/InternetImage4_354b74e.png b/docs/ISuite/50-Development/images/InternetImage4_354b74e.png deleted file mode 100644 index 99b3bde5..00000000 Binary files a/docs/ISuite/50-Development/images/InternetImage4_354b74e.png and /dev/null differ diff --git a/docs/ISuite/50-Development/images/My_Workspace_315b2dc.png b/docs/ISuite/50-Development/images/My_Workspace_315b2dc.png deleted file mode 100644 index 63adb654..00000000 Binary files a/docs/ISuite/50-Development/images/My_Workspace_315b2dc.png and /dev/null differ diff --git a/docs/ISuite/50-Development/images/OverviewImage2_9550dd7.png b/docs/ISuite/50-Development/images/OverviewImage2_9550dd7.png deleted file mode 100644 index 8986e17d..00000000 Binary files a/docs/ISuite/50-Development/images/OverviewImage2_9550dd7.png and /dev/null differ diff --git a/docs/ISuite/50-Development/images/Refresh_icon_ba1b5ab.png b/docs/ISuite/50-Development/images/Refresh_icon_ba1b5ab.png deleted file mode 100644 index 44a100aa..00000000 Binary files a/docs/ISuite/50-Development/images/Refresh_icon_ba1b5ab.png and /dev/null differ diff --git a/docs/ISuite/50-Development/images/Swagger_definition_0fffa2e.png b/docs/ISuite/50-Development/images/Swagger_definition_0fffa2e.png index f4042dc8..621bba7c 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 deleted file mode 100644 index e9956606..00000000 Binary files a/docs/ISuite/50-Development/images/TestConnectionImage6_82dccf5.png and /dev/null 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 2f8bfac4..ddfd11f8 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,9 +21,13 @@ 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. @@ -44,7 +48,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 the resource pane. + The selected function library object gets imported to resource pane. 6. Choose the imported object. @@ -52,8 +56,4 @@ 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/inject-mapping-artifacts-to-sap-cloud-integration-47ad97e.md b/docs/ISuite/50-Development/inject-mapping-artifacts-to-sap-cloud-integration-47ad97e.md index cf2f3e1e..53044a40 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,7 +127,9 @@ 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 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). + > 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:. diff --git a/docs/ISuite/50-Development/integration-artifact-types-bf932e0.md b/docs/ISuite/50-Development/integration-artifact-types-bf932e0.md index 0bdff475..8b663015 100644 --- a/docs/ISuite/50-Development/integration-artifact-types-bf932e0.md +++ b/docs/ISuite/50-Development/integration-artifact-types-bf932e0.md @@ -32,13 +32,9 @@ 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 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)\). + Contains functions that can be used in a mapping \(see [Working with Function Libraries](working-with-function-libraries-dd8c30d.md)\). - Integration adapter diff --git a/docs/ISuite/50-Development/json-threat-protection-c4991a6.md b/docs/ISuite/50-Development/json-threat-protection-c4991a6.md index c043cea2..deb0f41d 100644 --- a/docs/ISuite/50-Development/json-threat-protection-c4991a6.md +++ b/docs/ISuite/50-Development/json-threat-protection-c4991a6.md @@ -4,7 +4,7 @@ Minimizes the risk posed by content-level attacks by enabling specific limits on various JSON structures, such as arrays and strings. -**** +**Policy Settings** 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 08bdfdba..b3dfc5ad 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 [Glossary for SAP Integration Advisor](../glossary-for-sap-integration-advisor-9c221b4.md) 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 [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. ![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 04aa0633..72e9ec0d 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 32b1d6ca..e0423983 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 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. +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. You can retrieve cached values with the Lookup Cache policy. @@ -71,7 +71,7 @@ Scope @@ -115,6 +115,8 @@ 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** +
-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. +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.
diff --git a/docs/ISuite/50-Development/manage-certificates-c665875.md b/docs/ISuite/50-Development/manage-certificates-c665875.md index 8b39bafd..25174807 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-navigation-categories-classic-design-7f1a44b.md b/docs/ISuite/50-Development/manage-navigation-categories-classic-design-7f1a44b.md deleted file mode 100644 index 45cf5120..00000000 --- a/docs/ISuite/50-Development/manage-navigation-categories-classic-design-7f1a44b.md +++ /dev/null @@ -1,103 +0,0 @@ - - -# Manage Navigation Categories \[Classic Design\] - -Manage and configure the navigation categories. - - - - - -## Prerequisites - -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). - -Use the following procedure to configure navigation categories. - - - - - -## Procedure - -1. Log on to the API business hub enterprise, and navigate to *Manage* \> *Home Page* \> *Navigation Categories*. - -2. To add a category, choose *Add Category* icon. In the *Add Category* screen that opens, enter the following details: - - -
- - - - - - - - - - - - - - - - -
- - Name - - - - Description - -
- - **Category Name** - - - - Provide a name for the category. - -
- - **Category Title** - - - - Provide a title for the category. Categories are identified by their title on the home screen. - -
- - **Description** - - - - Provide a description for the category. - -
- -3. To add products, choose *Add Products*button. In the *Add Products* window that opens, select the products that you want to add to this category. - -4. Save the changes. - - Newly configured category is visible in the *Navigation Categories* section. In this section, you can perform the following: - - - Reorder the updates by using the *Move Up* and *Move Down* action icons. - - Edit a category by choosing the edit action icon. - - Delete a category by choosing the delete action icon. - - diff --git a/docs/ISuite/50-Development/manage-updates-classic-design-94e37b4.md b/docs/ISuite/50-Development/manage-updates-classic-design-94e37b4.md deleted file mode 100644 index 523ab671..00000000 --- a/docs/ISuite/50-Development/manage-updates-classic-design-94e37b4.md +++ /dev/null @@ -1,92 +0,0 @@ - - -# Manage Updates \[Classic Design\] - -Manage and configure updates. - - - - - -## Prerequisites - -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 - -Configure the updates to be displayed in the *Updates* section on the home page. Use the following procedure to configure updates. - - - -## Procedure - -1. Log on to the API business hub enterprise, and navigate to *Manage* \> *Home Page* \> *Updates* \> *Configure Updates*. - -2. To add an update, click *Add Update* icon. In the *Add Update* screen that opens, enter the following details: - - - - - - - - - - - - - - - - - - - -
- - Name - - - - Description - -
- - **Title** - - - - Provide a title for the update. - -
- - **Description** - - - - Provide a description for the update. - -
- - **Link** - - - - Provide the details of a reference link. Link is an optional field to provide more information on the update. - -
- -3. Save the changes. - - Newly configured update is visible in the *Configured Updates* section. In this section, you can perform the following: - - - Reorder the updates by using the *Move Up* and *Move Down* action icons. - - Edit an update by choosing the edit action icon. - - Delete an update by choosing the delete action icon. - - 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 42732911..50e8de11 100644 --- a/docs/ISuite/50-Development/managing-jdbc-data-sources-4c873fa.md +++ b/docs/ISuite/50-Development/managing-jdbc-data-sources-4c873fa.md @@ -223,11 +223,8 @@ 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 deleted file mode 100644 index 18cd8c6f..00000000 --- a/docs/ISuite/50-Development/managing-the-access-request-of-the-users-classic-design-5b3e2f6.md +++ /dev/null @@ -1,131 +0,0 @@ - - - - -# Managing the Access Request of the Users \[Classic Design\] - -Procedure to provide or reject access to an Application developer for using the API business hub enterprise. - - - - - -## Prerequisites - -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). - - - - - -## Procedure - -1. Log on to the API business hub enterprise. - -2. Choose *Manage* \> *Manage Users*. - - Use the *Manage Users* page to onboard the application developers. For assigning roles to other users, use the SAP BTP Cockpit. - -3. Add the email id in the textbox. - - This email id is used to receive email notification of the pending requests and send approvals. - -4. To view the pending requests, navigate to *Pending* section . - -5. In the pending section, **Approve** or **Reject** the request by choosing the corresponding action item in the *Actions* column. - - On accepting the request, an approval email is sent to the requester. On rejecting a request, you need to provide a reason and an email notification is sent to the requester with the mentioned reason. - - To view registered users, navigate to *Registered Users* section. - - In the *Registered Users*section, you can perform the following: - - - Edit an existing user to add or remove user roles. - - Register a new user by selecting the :heavy_plus_sign: icon. - - In the *Add User* dialog: - - 1. Enter the *User ID* and the user details like *First Name*, *Last Name* and *Email ID*. - - 2. Under *Assigned Roles*, identify the needed scope and select the roles accordingly: - - - - - - - - - - - - - - - - - - - - - - - -
- - Roles - - - - Descrition - -
- - Administrator - - - - Manages user registration. Create and delete applications on behalf of application developers. In addition, create custom attributes and import the app key. - -
- - Developer - - - - Create applications and check billing and metering data. Test APIs and view analytics data. - -
- - Site Administrator - - - - Configure updates, and perform portal changes like uploading the logo, changing the name and the description, and changing the footer links for the site. - -
- - Content Administrator - - - - Manages content categories. - -
- - - - - -**Related Information** - - -[Configure the API business hub enterprise \[Classic Design\]](configure-the-api-business-hub-enterprise-classic-design-7b71b16.md "You can configure the API business hub enterprise to personalize it for your organization.") - -[Revoke Access \[Classic Design\]](revoke-access-classic-design-147fb9d.md "Revoke the access of an application developer.") - diff --git a/docs/ISuite/50-Development/message-types-2eb71b8.md b/docs/ISuite/50-Development/message-types-2eb71b8.md index 88e2f3c5..56f59c78 100644 --- a/docs/ISuite/50-Development/message-types-2eb71b8.md +++ b/docs/ISuite/50-Development/message-types-2eb71b8.md @@ -360,21 +360,22 @@ ES Repository Information - + -## XSD +## Saving Message Type -Displays the XML Schema Definition \(XSD\) that is, the text view of the message type in read-only mode. +Choose *Save* to save the draft. Choose*Save as version* to save the message type with a new version. All modifications are reflected in XSD tab. +> ### Note: +> You can save te artifact even if you have validation errors in your Structure tab. - -## Saving Message Type + -Choose *Save* to save the draft. All modifications are refelcted in XSD tab. +## XSD -Choose*Save as version* to save the Message Type with a new version. All modifications are reflected in XSD tab. +Displays the XML Schema Definition \(XSD\) that is, the text view of the message type in read-only mode. **Related Information** diff --git a/docs/ISuite/50-Development/message-validation-policy-e68da2f.md b/docs/ISuite/50-Development/message-validation-policy-e68da2f.md index d8443adb..ea2334e0 100644 --- a/docs/ISuite/50-Development/message-validation-policy-e68da2f.md +++ b/docs/ISuite/50-Development/message-validation-policy-e68da2f.md @@ -21,9 +21,8 @@ An example payload for the policy is as follows > contain a element with name "msg" and type string --> > > -> string -> -> request +> string +> response > xsd://validation.xsd > > @@ -33,68 +32,36 @@ An example payload for the policy is as follows > > ``` -**Attributes of the `` element** - - - - - - - - - -
-Attribute - - - -Default - - - -Type +**Elements and Attributes** -Description +**Description**
-`async` - - - -false +Name -String - - - -This attribute is deprecated. +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.
-`continueOnError` - - - -false - - - -String +continueOnError @@ -106,17 +73,7 @@ Set to false to return an error when a policy fails. This is expected behavior f
-`enabled` - - - -true - - - -String +enabled @@ -125,212 +82,88 @@ Set to true to enforce the policy. Set to false to "turn off" the policy. The po
- -**`` element** - - - - - - - - - + + -
- -Element - - - -Default - - - -Type - - - -Description - -
-`Element` \(Mandatory\) +async -N/A +This attribute is deprecated.
-N/A +DisplayName -Specifies the root, or parent, element of the messages to be validated. - -> ### Sample Code: -> ``` -> PurchaseOrder -> ``` - - +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.
- -**`namespace` attribute of the `` element** - - - - - - - - - - - -
- -Attribute - - - -Default - - - -Type - - - -Description - -
-`namespace` +Source -http://sample.com +Identifies the source message to be validated. - +If you do not provide a value, a value of message is used. -String +If the variable cannot be resolved, or resolves to a non-message type, then one of the following occurs: - +If the source variable resolves to a null value in the message flow, a steps.messagevalidation.SourceMessageNotAvailable error code is thrown. -Provides the namespace of the root, or parent, element of the messages to be validated. +If the source variable resolves to a non-message value, a steps.messagevalidation.NonMessageVariable error code is thrown.
- -**`` element** - - - - - - - - - - - -
- -Element - - - -Default - - - -Type - - - -Description - -
-`SOAPMessage` \(Mandatory\) +ResourceURL -N/A - - +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. -Provides the SOAP version against which to validate SOAP messages. - -> ### Sample Code: -> ``` -> -> ``` +Default: wsdl:// +Presence: Optional +Type: String
- -**`version` attribute of the `` element** - - - - - - - - - + + -
- -Attribute - - - -Default - - - -Type - - - -Description - -
-`version` +SOAPMessage -N/A +Provides the SOAP version against which to validate SOAP messages.
-N/A +Version @@ -339,129 +172,31 @@ Identifies the SOAP version against which to validate SOAP messages. Valid value
- -**`` element** - - - - - - - - - - - -
- -Element - - - -Default - - - -Type - - - -Description - -
-`Source` - - - -N/A - - - -N/A +Element -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 -> ``` +Specifies the root, or parent, element of the messages to be validated. +PurchaseOrder +PurchaseOrder
- -**`` element** - - - - - - - - - - - diff --git a/docs/ISuite/50-Development/monetize-49b7841.md b/docs/ISuite/50-Development/monetize-49b7841.md index 39494da1..3d5e715b 100644 --- a/docs/ISuite/50-Development/monetize-49b7841.md +++ b/docs/ISuite/50-Development/monetize-49b7841.md @@ -4,5 +4,5 @@ Monetize artifacts created in SAP Integration Suite. -To know more about monetizing APIs, see . +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:. diff --git a/docs/ISuite/50-Development/monetize-apis-f6ab151.md b/docs/ISuite/50-Development/monetize-apis-f6ab151.md index 76b7a1a7..380689a6 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 +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: diff --git a/docs/ISuite/50-Development/monitor-650995c.md b/docs/ISuite/50-Development/monitor-650995c.md index fc417b48..0b4f84b7 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/monitor-event-mesh-d975934.md b/docs/ISuite/50-Development/monitor-event-mesh-d975934.md new file mode 100644 index 00000000..41dfea82 --- /dev/null +++ b/docs/ISuite/50-Development/monitor-event-mesh-d975934.md @@ -0,0 +1,4 @@ + + +# Monitor Event Mesh + diff --git a/docs/ISuite/50-Development/monitoring-b2b-messages-b5e1fc9.md b/docs/ISuite/50-Development/monitoring-b2b-messages-b5e1fc9.md index 4f30a224..62d54210 100644 --- a/docs/ISuite/50-Development/monitoring-b2b-messages-b5e1fc9.md +++ b/docs/ISuite/50-Development/monitoring-b2b-messages-b5e1fc9.md @@ -24,28 +24,27 @@ 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. 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*. +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*. > ### 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. -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 +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 1. General Information 2. Custom Attributes \(if defined in the agreement transaction\) 3. Sender 4. Receiver -17. The *Events* tab displays the list of business transaction events with the following details +16. The *Events* tab displays the list of business transaction events with the following details 1. *ID* Provides the unique identification number for the event @@ -63,21 +62,21 @@ An interchange is the incoming payload for B2B transactions. It is a bulk messag Provides you a reference link to the message details -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 +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 - Error Date Time - Error Category - Error Information - MPL ID -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. +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. diff --git a/docs/ISuite/50-Development/naming-conventions-7c00e9b.md b/docs/ISuite/50-Development/naming-conventions-7c00e9b.md index fde85f40..aaf62fb4 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 [Creating an Integration Package](creating-an-integration-package-9126d79.md). +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 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. +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:. 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 d5e87b15..2ff2d91d 100644 --- a/docs/ISuite/50-Development/oauth-v2-0-09b5abb.md +++ b/docs/ISuite/50-Development/oauth-v2-0-09b5abb.md @@ -925,59 +925,6 @@ fault.name = "invalid\_request"
- -Element - - - -Default - - - -Type - - - -Description - -
-`ResourceURL` \(Optional\) - - - -wsdl:// - - - -String +namespace -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 -> ``` - - +Provides the namespace of the root, or parent, element of the messages to be validated. Default: "http://sample.com"
-[Analyze API Proxies](analyze-api-proxies-7712c61.md) +[Analyze APIs](analyze-apis-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/overview-of-integration-flow-editor-db10beb.md b/docs/ISuite/50-Development/overview-of-integration-flow-editor-db10beb.md index 8690a9d3..7fe7a54d 100644 --- a/docs/ISuite/50-Development/overview-of-integration-flow-editor-db10beb.md +++ b/docs/ISuite/50-Development/overview-of-integration-flow-editor-db10beb.md @@ -34,7 +34,7 @@ The editor comes with a simplified approach and provides you the following benef - Availability of simulation tool in the palette helps you to simulate the integration flow during any phase of the development. -- The search field in the palette helps you to search or choose the flow steps. It reduces your development time. +- The search field in the palette helps you to search or choose the flow steps and message flows \(adapters\). It reduces your development time. @@ -373,7 +373,7 @@ Access the help information of a particular Flow step. It gives direct access to -Easy way to search a required flow step. You can either search it using the search field or scroll down to select the flow step. +Easy way to search a required flow step and message flow \(adapter\). You can either search it using the search field or scroll down to select the flow step. @@ -427,7 +427,7 @@ The editor also prevents you from adding multiple incoming messages to integrati ### Search for Steps -In the edit mode, you can find the required flow step during the development of an integration scenario. You can search the step with free text. For example, filter, sender, content modifier etc. When you enter a text as a search, the system looks for it and displays the flow step. You can just select and drop it in the modeling area. For information about finding an already existing flow step, see [Search Existing Flow Steps](overview-of-integration-flow-editor-db10beb.md#loiodb10bebf11fe4dc48bd97d2c4011485c__search). +In the edit mode, you can find the required flow step and message flow \(adapter\) during the development of an integration scenario. You can search the step and adapter with free text. For example, filter, sender, content modifier, HTTP etc. When you enter a text as a search, the system looks for it and displays the flow step and message flow. You can just select and drop it in the modeling area. For information about finding an already existing flow step, see [Search Existing Flow Steps](overview-of-integration-flow-editor-db10beb.md#loiodb10bebf11fe4dc48bd97d2c4011485c__search). @@ -609,34 +609,34 @@ Consider a scenario where you need to know more about how to define a script for -## Search Existing Flow Steps +## Search Existing Flow Steps and Message Flows -You can search for an existing flow step in the design time and runtime views of an integration flow. +You can search for an existing flow step and message flow in the design time and runtime views of an integration flow. ### Design Time Search -You can search for a flow step in both edit and read modes of an integration flow using the search field in the palette. In read mode, the search field is labelled *Search Step*. +You can search for a flow step and message flow \(adapter\) in both edit and read modes of an integration flow using the search field in the palette. In read mode, the search field is labelled *Search Step*. You can execute a search by: -- Type of the flow step. For example, Groovy Script or Content Modifier +- Type of the flow step and message flow. For example, Groovy Script, Content Modifier, or HTTP -- Name of the flow step +- Name \(applicable only for flow step\) -- ID of the flow step +- ID of the flow step and message flow -As soon as you execute a search, matching flow steps are shown below the search field. If there is an icon against a flow step, it means that the flow step is used in the integration flow. Choose the icon to identify where the flow steps are used. +As soon as you execute a search, matching flow steps and message flows are shown below the search field. If there is an icon against a flow step, it means that the flow step is used in the integration flow. Choose the icon to identify where the flow steps are used. -You see the search results at the bottom of the editor. If one or more flow steps are available, you can move across the flow steps using the arrows in the search results. +You see the search results at the bottom of the editor. If one or more flow steps and message flows are available, you can move across the flow steps using the arrows in the search results. -Additionally, in edit mode, the search field is labelled *Search and Add a Step*. In edit mode, when you execute a search, you can also add the flow step to the integration flow. +Additionally, in edit mode, the search field is labelled *Search and Add a Step*. In edit mode, when you execute a search, you can also add a flow step to the integration flow. ### Runtime Search -You can navigate from the *Monitoring* screen and *Inspect* screen to view the deployed artifact and search for flow steps. +You can navigate from the *Monitoring* screen and *Inspect* screen to view the deployed artifact and search for flow steps and message flow. diff --git a/docs/ISuite/50-Development/package-details-f0bf802.md b/docs/ISuite/50-Development/package-details-f0bf802.md index f4aeabb9..ee3ca9f0 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 *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 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 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*. + 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*. - **Documents** diff --git a/docs/ISuite/50-Development/policies-7e4f3e5.md b/docs/ISuite/50-Development/policies-7e4f3e5.md index ba747791..814971a2 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, click "+" against the required policy in the *Created Policies* area. +To attach a policy to multiple flows, select Add "+" 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 e0a833fa..ccccc364 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 \(including the policies associated with the default fault rules or a post-client flow\). +Contains the header information of all the available policies. diff --git a/docs/ISuite/50-Development/publish-and-consume-events-8e296d9.md b/docs/ISuite/50-Development/publish-and-consume-events-8e296d9.md new file mode 100644 index 00000000..b17e574d --- /dev/null +++ b/docs/ISuite/50-Development/publish-and-consume-events-8e296d9.md @@ -0,0 +1,18 @@ + + +# Publish and Consume Events + +Event Mesh capability supports the following messaging protocol: + + + + + +## Advanced Message Queuing Protocol \(AMQP\) 1.0 over WebSocket + +The Advanced Message Queuing Protocol \(AMQP\) is an open standard for passing business messages between applications or organizations. It connects systems, feeds business processes with the information they need, and reliably transmits onward the instructions that achieve their goals. Event Mesh supports the use of AMQP 1.0 over websocket for messaging between applications. + +Refer to the [Specifications for AMQP 1.0 over Websocket](https://docs.oasis-open.org/amqp-bindmap/amqp-wsb/v1.0/amqp-wsb-v1.0.html) to publish and consume messages. + +Also, refer to the [protocal implementation for AMQP 1.0](https://www.npmjs.com/package/@sap/xb-msg-amqp-v100) that SAP provides. + diff --git a/docs/ISuite/50-Development/python-script-8703aa8.md b/docs/ISuite/50-Development/python-script-8703aa8.md index 6343fd77..8cc8c9c8 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. -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. +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. You can attach this policy in the following locations: ![](images/Flow_policy_116062b.png) @@ -32,8 +32,7 @@ An example payload for the policy is as follows: > > ``` > -> > ### Example: -> > mainscript.py +> An example of a mainscript.py script > > > ### Code Syntax: > > ``` @@ -44,181 +43,87 @@ An example payload for the policy is as follows: > > print "x is 1." > > ``` -**`timeLimit` attribute of the ` -> ``` - - - - - - - -**`` element** - - - - - - - - - - - + + + @@ -262,10 +167,22 @@ 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\) +You can include multiple dependency python files with additional `IncludeURL` attributes. The scripts are evaluated in the order in which they are listed in the policy. -N/A +Optional
-N/A +`ResourceURL` -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: -> Security API Management python runtime executes in a restricted mode, where import is not allowed for os, sys, and java.lang. +> For added 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 e5150232..e5937861 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 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. +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. -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. +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. -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. +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. You can attach this policy in the following locations:![](images/Flow_policy_116062b.png) @@ -31,425 +31,45 @@ An example payload for the policy is as follows:: > > ``` -**`` element** - - - - - - - - - - - - - - - -
- -Element - - - -Default - - - -Type - - - -Description - -
- -`FaultResponse` - - - -N/A - - - -N/A - - - -Defines the response message returned to the requesting application. - -> ### Sample Code: -> ``` -> -> -> -> -> -> 500 -> Server Error -> -> -> ``` - - - -
- -**``/`` element** - - - - - - - - - - - - - - - -
- -Element - - - -Default - - - -Type - - - -Description - -
- -`Set` - - - -N/A - - - -N/A - - - -Sets information in the error message. - -> ### Sample Code: -> ``` -> -> -> -> -> 500 -> Server Error -> -> ``` - - - -
- -**``/``/`` element** - - - - - -
-Element - - - -Default - - - -Type +**Field Name** -Description +**Description**
-`Headers` \(Optional\) - - - -N/A +IgnoreUnresolvedVariables\(Optional\) -String - - - -Sets or overwrites HTTP headers in the error message. - -> ### Sample Code: -> ``` -> -> -> -> -> ``` +Ignores any unresolved variable error in the flow. +Valid values: `true` or `false` +Default value: `true`
- -**``/``/`` element** - - - - - - - - - - - - -
- -Element - - - -Default - - - -Type - - - -Description - -
-`Payload` \(Optional\) +FaultResponse\(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 c2452f8a..0674d504 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 e47be572..e5bc2d1e 100644 --- a/docs/ISuite/50-Development/reset-quota-e18ccb8.md +++ b/docs/ISuite/50-Development/reset-quota-e18ccb8.md @@ -18,452 +18,85 @@ An example payload for the policy is as follows: > > > -> -Element - - - - - - - -
- -Element - - - -Default - - - -Type - - - -Description - -
- -`IgnoreUnresolvedVariables` - - - -true - - - -Boolean - - - -Ignores any unresolved variable error in the Flow - -> ### Sample Code: -> ``` -> -> true -> -> ``` - - +Defines the response message returned to the requesting application.
- -Default - - - -Type +**Elements and Attributes** -Description +**Description**
-`Quota` \(Mandatory\) - - - -N/A - - - -N/A +Quota \(Mandatory\) Specifies the name of the Quota policy whose counter should 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 - - +The ref attribute identifies the variable that fetches the Quota policy that has to be reset, -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. +Both name and ref are optional but at least one of attributes should be used.
- -**`` element** - -> ### Note: -> Both `name` and `ref` are optional but at least one of the attributes should be used. - - - - - - - - - - - -
- -Element - - - -Default - - - -Type - - - -Description - -
-`Identifier` \(Mandatory\) - - - -N/A - - - -String +Identifier \(Optional\) Specifies the name of the client. -> ### Sample Code: -> ``` -> -> -> 100 -> -> -> ``` - +The ref attribute is the variable used for uniquely identifying the client, for example client\_id. +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\) - - -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 +Allow \(Allow 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 deleted file mode 100644 index 3b817309..00000000 --- a/docs/ISuite/50-Development/reuse-imported-archives-objects-from-es-repository-4196091.md +++ /dev/null @@ -1,61 +0,0 @@ - - -# 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 deleted file mode 100644 index a496ef4f..00000000 --- a/docs/ISuite/50-Development/revoke-access-classic-design-147fb9d.md +++ /dev/null @@ -1,50 +0,0 @@ - - -# Revoke Access \[Classic Design\] - -Revoke the access of an application developer. - - - - - -## Prerequisites - -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 - -As an API administrator, you use this procedure to revoke an application developer's access for using the API business hub enterprise. - -> ### Note: -> This document describes the classic design of the API business hub enterprise. To view the documentation for the new design, see [Revoke Access \[New Design\]](revoke-access-new-design-ce609bb.md). - - - -## Procedure - -1. Log on to the API business hub enterprise. - -2. Choose *Manage* \> *Manage Users*. - -3. Go to the *Registered* section. From the list of application developers, select the application developer whose access you want to revoke and choose the revoke user action item under the *Actions* column. - -4. In the *Revoke* window, provide a reason for revoking the access. - - > ### Note: - > By revoking roles, user will lose all the roles assigned. However, user account will be retained. - - - - - - -## Results - -You have revoked the access of the user from using API business hub enterprise successfully. - 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 937298fc..28761a6a 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,13 +16,6 @@ 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/setting-up-api-management-capability-f34e86c.md b/docs/ISuite/50-Development/setting-up-api-management-capability-f34e86c.md index 11b32960..5a166a12 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 @@ -92,7 +92,7 @@ To publish the Integration Suite API portal content on the **API business hub en > ### Note: > If you've activated API business hub enterprise while enabling API Management capability, the connection to API business hub enterprise is established automatically. You can test the connection using *Test Connection*. > -> If you want to connect Integration Suite to a centralized API business hub enterprise, you must create a connection request. For more information, see [Create a Connection Request for the Centralized API business hub enterprise \[Classic Design\]](create-a-connection-request-for-the-centralized-api-business-hub-enterprise-classic-desig-02f7877.md) or [Create a Connection Request for the Centralized API business hub enterprise \[New Design\]](create-a-connection-request-for-the-centralized-api-business-hub-enterprise-new-design-c7bda8c.md). +> If you want to connect Integration Suite to a centralized API business hub enterprise, you must create a connection request. For more information, see [Create a Connection Request for the Centralized API business hub enterprise \[Classic Design\]](https://help.sap.com/viewer/de4066bb3f9240e3bfbcd5614e18c2f9/Cloud/en-US/02f7877360a64c6b8d853fed9b2d9cc6.html "To publish the API portal content on the API business hub enterprise, you must create a request to connect the API portal to the API business hub enterprise.") :arrow_upper_right: or [Create a Connection Request for the Centralized API business hub enterprise](../create-a-connection-request-for-the-centralized-api-business-hub-enterprise-c7bda8c.md). > ### Note: > You can navigate to the **API business hub enterprise** by choosing the Explore our Ecosystem icon on the header bar. 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 1b8b9928..427a57ee 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 next: +Now, for the created service instance, generate a service key from the steps given below: @@ -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 08d506f2..18ec6c3b 100644 --- a/docs/ISuite/50-Development/settings-9e64d05.md +++ b/docs/ISuite/50-Development/settings-9e64d05.md @@ -74,7 +74,7 @@ MIGs and MAGs diff --git a/docs/ISuite/50-Development/documentation-export-and-settings-4c442af.md b/docs/ISuite/50-Development/settings-for-migs-and-mags-4c442af.md similarity index 99% rename from docs/ISuite/50-Development/documentation-export-and-settings-4c442af.md rename to docs/ISuite/50-Development/settings-for-migs-and-mags-4c442af.md index 2a84aac1..101ed530 100644 --- a/docs/ISuite/50-Development/documentation-export-and-settings-4c442af.md +++ b/docs/ISuite/50-Development/settings-for-migs-and-mags-4c442af.md @@ -2,7 +2,7 @@ -# Documentation Export and Settings +# Settings for MIGs and MAGs You can maintain a template for documentation export which is later picked by the system whenever you export a Message Implementation Guideline \(MIG\) or a Mapping Guideline \(MAG\). diff --git a/docs/ISuite/50-Development/sftp-adapter-e3dce88.md b/docs/ISuite/50-Development/sftp-adapter-e3dce88.md index 741027ef..b02838ff 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 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 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 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).") +[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).") diff --git a/docs/ISuite/50-Development/sign-the-message-content-with-simple-signer-9879fc3.md b/docs/ISuite/50-Development/sign-the-message-content-with-simple-signer-9879fc3.md index 11d8b07a..63c28d1c 100644 --- a/docs/ISuite/50-Development/sign-the-message-content-with-simple-signer-9879fc3.md +++ b/docs/ISuite/50-Development/sign-the-message-content-with-simple-signer-9879fc3.md @@ -91,6 +91,11 @@ You work with the Simple Signer to make the identity of the sender known to the Select a signature algorithm for the RSA or DSA private key type. Supported algorithms for content signing \(digest and encryption algorithm\): MD5/RSA, MD2/RSA, RIPEMD160andMGF1/RSA-ISO9796-2-2-3, RIPEMD128/RSA, RIPEMD160/RSA, RIPEMD256/RSA, SHA/RSA, SHA/DSA, SHA224/RSA, SHA256/RSA, SHA384/RSA, SHA512/RSA, SHAandMGF1/RSA-ISO9796-2-2-3, SHA256withDSA, SHA224withDSA, SHA3-224/RSA, SHA3-256/RSA, SHA3-384/RSA, SHA3-512/RSA, SHA3-512/DSA, SHA3-384/DSA, SHA3-256/DSA, SHA3-224/DSA, SHA512/DSA, SHA384/DSA, SHA3-224/ECDSA, SHA3-256/ECDSA, SHA3-384/ECDSA, SHA3-512/ECDSA, SHA512/ECDSA, SHA384/ECDSA, SHA256/ECDSA, SHA224/ECDSA, SHA1/ECDSA. + + > ### Caution: + > Algorithms starting with SHA1, MD2, or MD5 are still supported for compatibility reasons, but they no longer meet today's security requirements. Therefore, we recommend using stronger algorithms where possible. Check with your security experts or authorities like NIST for more detailed security recommendations. + + diff --git a/docs/ISuite/50-Development/sign-the-message-content-with-xml-digital-signature-9a013db.md b/docs/ISuite/50-Development/sign-the-message-content-with-xml-digital-signature-9a013db.md index 3dcbc36b..7cc3315c 100644 --- a/docs/ISuite/50-Development/sign-the-message-content-with-xml-digital-signature-9a013db.md +++ b/docs/ISuite/50-Development/sign-the-message-content-with-xml-digital-signature-9a013db.md @@ -93,6 +93,11 @@ You sign a message with an XML digital signature to ensure authenticity and data Using the private key, the sender encrypts the digest. Supported signature algorithms: SHA1/DSA, SHA1/RSA, SHA256/RSA, SHA384/RSA, SHA512/RSA, SHA224/ECDSA, SHA256/ECDSA, SHA384/ECDSA, SHA512/ECDSA. + + > ### Caution: + > Algorithms starting with SHA1, MD2, or MD5 are still supported for compatibility reasons, but they no longer meet today's security requirements. Therefore, we recommend using stronger algorithms where possible. Check with your security experts or authorities like NIST for more detailed security recommendations. + + 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 771d06b8..0b73af0a 100644 --- a/docs/ISuite/50-Development/specify-the-runtime-configuration-0c1c96e.md +++ b/docs/ISuite/50-Development/specify-the-runtime-configuration-0c1c96e.md @@ -93,9 +93,6 @@ 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 19b9b50b..d1e8fba9 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 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. +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. -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. +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. -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. +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. You can attach the policy in the following locations: ![](images/flow_policy_1_1aa837c.png) @@ -24,348 +24,61 @@ An example payload for the policy is as follows: > > > 30pm -> true > > > ``` -**`` element** -
- -Attribute - - - -Default - - - -Type - - - -Description - -
-`ref` \(Optional\) +Class\(Optional\) -N/A +Refers to the class for which the quota counter will be reset. - +`` - -A flow variable that contains the name of the count identifier in the target Quota policy.
-[Documentation Export and Settings](documentation-export-and-settings-4c442af.md) +[Settings for MIGs and MAGs](settings-for-migs-and-mags-4c442af.md)
- - - - - -
-Element +**Elements and Attributes** -Default - - - -Type - - - -Description +**Description**
-`Identifier` \(Optional\) - - - -N/A +Identifier ref -String +Variable used for uniquely identifying the application or client. - -Flow variable used for identifying the application or client. - -> ### Sample Code: -> ``` -> -> -> -> ``` - - - -
- -**`ref` attribute of the `` element** - - - - - - - - - - - - -
- -Attribute - - - -Default - - - -Type - - - -Description - -
-`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 +MessageWeight ref Specifies the weight defined for each message. -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: -> ``` -> -> -> -> ``` - - +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.
- -**`ref` attribute of the `` element** - - - - - - - - - - - - - -
- -Attribute - - - -Default - - - -Type - - - -Description - -
- -`ref` \(Required\) - - -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 +Rate Specifies the rate at which to limit the traffic spike \(or burst\). -Valid value: integer per or or - -> ### Sample Code: -> ``` -> -> 30pm -> -> ``` - - - -
- -**`` element** - - - - - - - - - - - - - - @@ -495,28 +208,11 @@ 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 -> -> ``` - - +Valid value: integer per or or .
- -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. -
-The following fault variables are set when the policy triggers an error at runtime: +Following fault variables are set when the policy triggers an error at runtime: **Fault Variables** @@ -547,7 +243,7 @@ Example -The fault variable \[prefix\] is rate limit. +The fault variable \[prefix\] is ratelimit. The \[policy\_name\] is the name of the policy that threw the error. diff --git a/docs/ISuite/50-Development/subscribe-to-a-product-classic-design-2e586e1.md b/docs/ISuite/50-Development/subscribe-to-a-product-classic-design-2e586e1.md deleted file mode 100644 index 1362459e..00000000 --- a/docs/ISuite/50-Development/subscribe-to-a-product-classic-design-2e586e1.md +++ /dev/null @@ -1,38 +0,0 @@ - - -# Subscribe to a Product \[Classic Design\] - -You can subscribe to a product and add it to an existing application or create a new application. - - - -## Context - -On the homepage, you can find the list of products. You can also view the various resources that each product has to offer. - -> ### 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 [Subscribe to a Product \[New Design\]](subscribe-to-a-product-new-design-486d263.md). - - - -## Procedure - -1. Log on to the API business hub enterprise. - -2. You can either look for the product on the homepage, or use the search bar to search for the product. - -3. In the product details screen, choose *Subscribe*. - - You can subscribe to: - - - *Add to Existing Application*: The list of applications appears. Choose the required application. - - - *Create New Application*: Create an application by entering the name and title. The selected Product is added to the application by default. - - -4. Choose *Save* . - - diff --git a/docs/ISuite/50-Development/subscribing-to-email-notification-alerts-88e96f4.md b/docs/ISuite/50-Development/subscribing-to-email-notification-alerts-88e96f4.md new file mode 100644 index 00000000..5a60f490 --- /dev/null +++ b/docs/ISuite/50-Development/subscribing-to-email-notification-alerts-88e96f4.md @@ -0,0 +1,29 @@ + + +# Subscribing to Email Notification Alerts + +Receive real-time email alerts for anomaly detection services. + +> ### Note: +> The availability of the anomaly detection feature 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://me.sap.com/notes/2903776) and [3463620](https://me.sap.com/notes/3463620). + +Subscribe to the **SAP Alert Notification Service** and start receiving automated email alerts for anomaly detection. + +For the initial setup and detailed instructions on configuring and subscribing to email alerts, see [SAP Alert Notification Service for SAP BTP](https://help.sap.com/docs/alert-notification/sap-alert-notification-for-sap-btp/what-is-sap-alert-notification-service-for-sap-btp?version=Cloud). + +Once the **SAP Alert Notification Service** is setup or configured successfully, you can activate the following events for anomaly detection: + +- **API Management Alert Anomaly Detected**: When enabled, you will receive an email notification whenever an anomaly is detected. To learn more about this event, see [API Management Alert Anomaly Detected](https://help.sap.com/docs/alert-notification/sap-alert-notification-for-sap-btp/sap-api-management-alert-anomaly-detected?version=Cloud). + +- **API Management Alert Training Completed**: When enabled, you will receive an email notification when the training for anomaly detection is completed. To learn more about this event, see [API Management Alert Training Completed](https://help.sap.com/docs/alert-notification/sap-alert-notification-for-sap-btp/sap-api-management-alert-training-completed?version=Cloud). + + +**Related Information** + + +[Enabling Anomaly Detection](enabling-anomaly-detection-98534a0.md "To detect anomalies for API proxy calls, you need to enable the anomaly detection setting.") + +[Configuring APIs for Anomaly Detection](configuring-apis-for-anomaly-detection-9e7e5d1.md "View or configure APIs for anomaly detection.") + +[Working with Detected Anomalies](working-with-detected-anomalies-1c677b2.md "Access and analyze anomalies in the analytics dashboard. Discover details about the various types of anomalies, evaluate and resolve them.") + diff --git a/docs/ISuite/50-Development/test-69499e8.md b/docs/ISuite/50-Development/test-69499e8.md index 38e93ed8..bd62bffc 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/4425026877144cc2b15505ed30215167/IAT/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/66d066d903c2473f81ec33acfe2ccdb4/Cloud/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 f40e23ec..cb86f86d 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/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: +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: 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 d9d0f951..42fc304c 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/update-migs-mags-c47533b.md b/docs/ISuite/50-Development/update-migs-mags-c47533b.md index b2711e84..da780243 100644 --- a/docs/ISuite/50-Development/update-migs-mags-c47533b.md +++ b/docs/ISuite/50-Development/update-migs-mags-c47533b.md @@ -31,14 +31,15 @@ If you chose *Update MIG*, 5. Select the version from the drop-down list provided next to the MIG name. 6. The *MIG Version* field under the *Target MIG* section gets auto-filled with the MIG name. You need to choose the target MIG version from the drop-down list. 7. Choose *Next*. -8. The next screen allows you to select the impacted Agreements to be updated. Choose *Go* to view all the impacted agreements. +8. In the next screen, select the checkbox of the field *Update MIG information in source templates* if you want to update the MIG information in the corresponding agreement templates. +9. Under *Filters* section, choose *Go* button to view all the agreements that use the selected MIG. > ### Note: > You can also filter the Agreements further by their status, trading partner details and timestamps. After maintaining the necessary filters, choose *Go* to see the results. -9. In the *Agreements* table, select the Agreements that require the MIG version update and choose *Next*. -10. The next step displays a summary of your selection. Choose *Finish* to execute the update. -11. The *Actions Logs* table displays the progress of your task. Choose and open your log to view the task in detail. +10. In the *Agreements* table, select the Agreements that require the MIG version update and choose *Next*. +11. The next step displays a summary of your selection. Choose *Finish* to execute the update. +12. The *Actions Logs* table displays the progress of your task. Choose and open your log to view the task in detail. @@ -55,14 +56,15 @@ If you chose *Update MAG*, 4. The value help allows you to search and filter your MAG based on the name, version and status. After selecting a MAG from the list, choose *Select*. 5. Select the version from the drop-down list provided next to the MAG name. 6. The *MAG Version* field under the *Target MAG* section gets auto-filled with the MAG name. You need to choose the target MAG version from the drop-down list. -7. If the target MAG version that you chose contains a different version of MIG references and if you want to include the MIG references update, select the *Include MIG Versions Update* radio button. Or choose *Keep Current MAG Version*. +7. If the target MAG version that you chose contains a different version of MIG references and if you want to include the MIG references update, select the *Include MIG Versions Update* radio button. Or choose *Skip MIG Versions Update*. 8. Choose *Next*. -9. The next screen allows you to select the impacted Agreements to be updated. Choose *Go* to view all the impacted agreements. +9. In the next screen, select the checkbox of the field *Update MAG information in source templates* if you want to update the MAG iinformation in the corresponding agreement templates. +10. Under the *Filters* section, choose *Go* to view all the agreements that use the selected MAG. > ### Note: > You can also filter the Agreements further by their status, trading partner details and timestamps. After maintaining the necessary filters, choose *Go* to see the results. -10. In the *Agreements* table, select the Agreements that require the MAG version update and choose *Next*. -11. The next step displays a summary of your selection. Choose *Finish* to execute the update. -12. The *Actions Logs* table displays the progress of your task. Choose and open your log to view the task in detail. +11. In the *Agreements* table, select the Agreements that require the MAG version update and choose *Next*. +12. The next step displays a summary of your selection. Choose *Finish* to execute the update. +13. The *Actions Logs* table displays the progress of your task. Choose and open your log to view the task in detail. 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 deleted file mode 100644 index 8e05f49c..00000000 --- a/docs/ISuite/50-Development/updating-the-connection-request-credentials-for-a-submitted-request-classic-design-eb84854.md +++ /dev/null @@ -1,88 +0,0 @@ - - -# Updating the Connection Request Credentials for a Submitted Request \[Classic Design\] - -Update the credentials you've used to establish a connection between the Integration Suite API Management tenant and the API business hub enterprise. - - - - - -## 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. - - 1. Log in to the Integration Suite. - - 2. Choose the navigation icon on the left and choose *Settings* \> *APIs*. - - 3. Choose the *Connection* tab. - - 4. Choose *Generate Credentials* under *Connect the API Portal to the centralized API Business Hub Enterprise* and *Copy* the Integration Suite API Management tenant access credentials. - - - > ### Note: - > The client credentials get generated for the *APIPortal .Service.CatalogIntegration* role. - - -You must also have the *AuthGroup.APIPortalRegistration* role assigned to you. - - - -## Context - -The credentials required to access the Integration Suite API Management tenant are shared during the connection request process. - -If you encounter one of the following situations when your connection request is in the submitted state, you have to update the credentials: - -- You have submitted incorrect credentials while raising a connection request, and your request is in pending approval or submitted state. - -- You've deleted the service instance, or the service key, after the connection request was submitted. In this case, the credentials you used before deleting the service instance or the service key becomes invalid. - - -> ### Note: -> This document describes the classic design of the API business hub enterprise. To view the documentation for the new design, see [Updating the Connection Request Credentials for a Pending Request \[New Design\]](updating-the-connection-request-credentials-for-a-pending-request-new-design-dd37a7b.md). - - - -## Procedure - -1. Log on to the *API Business Hub Enterprise*. - -2. Navigate to the *Manage* tab and choose *Establish API Portal Connectivity with API Business Hub Enterprise* tile. - -3. Go to the *Actions* column of the connection request that you want to edit and choose *Edit Credentials*. - -4. On the *Edit Credentials for <* Integration Suite API Management tenant*Alias Name \>* popup, enter the mandatory *API Portal Access Credentials* that you copied earlier from the Integration Suite API Management tenant. - - Sample credentials: - - ``` - { - "url": "https://.cfapps.sap.hana.ondemand.com", - "tokenurl": "https://.authentication.sap.hana.ondemand.com/oauth/token", - "certurl": "https://xxxxxx.authentication.cert.sap.hana.ondemand.com", - "certificate": "xxxxxxxxxxxxxxxxxxx", - "key": "xxxxxxxxxxxxxx" - } - ``` - - > ### Note: - > The credentials required to establish the connection will be valid for 365 days. Please remember to regenerate them 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. - -5. Choose *Save*. - - - - - - -## Results - -You’ve updated the Integration Suite API Management tenant access credentials successfully. - 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 deleted file mode 100644 index 55eafeef..00000000 --- a/docs/ISuite/50-Development/updating-the-connection-request-credentials-for-an-approved-request-classic-design-b583b7a.md +++ /dev/null @@ -1,87 +0,0 @@ - - -# Updating the Connection Request Credentials for an Approved Request \[Classic Design\] - -There can be instances where you have to update the credentials once the connection request is approved by the API business hub enterprise admin. - - - - - -## 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. - -2. Choose the navigation icon on the left and choose *Settings* \> *APIs*. - -3. Choose the *Connection* tab. - -4. Choose *Regenerate Credentials* and *Copy* the access credentials. - - -> ### Note: -> The client credentials get generated for *APIPortal .Service.CatalogIntegration* role. - - - - - -## Context - -To establish the connection between the API Management tenant and the API business hub enterprise, the Client ID and Client Secret created for the API Management tenant is shared during the connection request process. - -If you encounter one of the following situations after the connection request has already been approved by the API business hub enterprise admin, you have to update the credentials: - -- The service instance, or the service key gets deleted after the connection between the API Management tenant and the API business hub enterprise was established. In this case, the credentials you were using before the service instance or the service key got deleted becomes invalid. - -- Similarly, if the destination that fetches the API content from theAPI Management tenant workspace gets deleted, the credentials you were using before the destination got deleted becomes invalid. - - -> ### Note: -> This document describes the classic design of the API business hub enterprise. To view the documentation for the new design, see [Updating the Connection Request Credentials for an Approved Request \[New Design\]](updating-the-connection-request-credentials-for-an-approved-request-new-design-882e1d9.md). - - - - - -## Procedure - -1. Log on to the *API Business Hub Enterprise*. - -2. Navigate to the *Manage* tab and choose *Establish API Portal Connectivity with API Business Hub Enterprise* tile. - -3. Go to the *Actions* column and select the approved connection request that you want to edit and choose *Re-establish Connection*. - -4. On the *Submit Connection Request* page, enter the *Client ID* and *Client Secret* that you copied earlier from the API Portal. - - Sample credentials: - - ``` - { - "url": "https://.cfapps.sap.hana.ondemand.com", - "tokenurl": "https://.authentication.sap.hana.ondemand.com/oauth/token", - "certurl": "https://xxxxxx.authentication.cert.sap.hana.ondemand.com", - "certificate": "xxxxxxxxxxxxxxxxxxx", - "key": "xxxxxxxxxxxxxx" - } - ``` - - > ### Note: - > The credentials required to establish the connection will be valid for 365 days. Please remember to regenerate them 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. - -5. Choose *Save*. - - - - - - -## Results - -You’ve updated the Integration Suite API portal access credentials successfully. - diff --git a/docs/ISuite/50-Development/view-applications-feac368.md b/docs/ISuite/50-Development/view-applications-feac368.md index d3029f60..b422af48 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 application 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 developers have created in the API business hub enterprise, along with the developer details, associated products and AppKey and secret. @@ -41,5 +41,5 @@ As an admin, you can view the list of applications that the application develope **Related Information** -[Create an Application \[Classic Design\]](create-an-application-classic-design-7b4e71b.md "Create an Application to consume the required APIs.") +[Create an Application \[Classic Design\]](https://help.sap.com/viewer/de4066bb3f9240e3bfbcd5614e18c2f9/Cloud/en-US/7b4e71b3887f4396aa22ce3e2ed7e0c3.html "Create an Application to consume the required APIs.") :arrow_upper_right: 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 0490afa9..6f35cefc 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 [Configuring User Access to SAP Integration Suite](../configuring-user-access-to-sap-integration-suite-2c6214a.md) + > 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: 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 66de82f2..5bdf7a55 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 [Configuring User Access to SAP Integration Suite](../configuring-user-access-to-sap-integration-suite-2c6214a.md) + > 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: 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 [Glossary for SAP Integration Advisor](../glossary-for-sap-integration-advisor-9c221b4.md) to get an understanding of Qualifier, Notes and Codelist. + > 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. 5. Review the *Message Implementation Guideline* by setting a review status, or comparing the MIG diff --git a/docs/ISuite/50-Development/working-with-detected-anomalies-1c677b2.md b/docs/ISuite/50-Development/working-with-detected-anomalies-1c677b2.md new file mode 100644 index 00000000..e667827b --- /dev/null +++ b/docs/ISuite/50-Development/working-with-detected-anomalies-1c677b2.md @@ -0,0 +1,237 @@ + + + + +# Working with Detected Anomalies + +Access and analyze anomalies in the analytics dashboard. Discover details about the various types of anomalies, evaluate and resolve them. + +> ### Note: +> The availability of the anomaly detection feature 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://me.sap.com/notes/2903776) and [3463620](https://me.sap.com/notes/3463620). + + + + + +## Viewing Anomalies + +After enabling the anomaly detection setting and configuring the API selection, the system will display the details of any detected anomalies in the Analytics dashboard. Additionally, if you have subscribed to the **SAP Alert Notification Service**, you will receive an automated email alert notifying you of the detected anomaly. + +To view the detected anomalies from the Analytics dashboard, you can use the following methods: + +- In the analytics dashboard, you can find the anomaly notification bar located at the top of the **Overview** page. Click *View* to quickly navigate to the **API Anomaly** page. + +- In the analytics dashboard, click the *API Anomaly* tab to view the detected anomalies. + + + + + + +## API Anomaly Page + +The **API Anomaly** page provides detailed information about any anomalies that have been detected. The information is displayed across screens: + + + +### **Screen 1** + +You can see a list of detected anomalies based on the anomaly type. The detected anomalies are categorized in two levels: System level and API level. + +Each anomaly is accompanied by the following details: + +- Type: Displays the anomaly type. The following table describes the possible anomaly types: + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + Anomaly Types + + + + Values Displayed + +
+ + API Traffic + + + + **API Traffic Increase:** This value is displayed when there is an increase in the number of API calls made to a specific API. + +
+ + **API Traffic Decrease:** This value is displayed when there is a decrease in the number of API calls made to a specific API. + +
+ + API Response Time + + + + **API Response Time Increase:** This value is displayed when there is an increase in the total response time for a specific API. + +
+ + **API Response Time Decrease:** This value is displayed when there is a decrease in the total response time for a specific API. + +
+ + API Errors + + + + **API Client Error Increase:** This value is displayed when there is an increase in the API client errors. + +
+ + **API Server Error Increase:** This value is displayed when there is an increase in the API server errors. + +
+ +- Time Stamp: Displays the date and time of the issue detection. +- Affected Entity: Displays the name of the affected API. If there are multiple affected APIs, it will be shown as **Multiple APIs**. +- Details: This field describes the issue detected by the system. + +Click on an anomaly to view more in-depth information on the next screen. + + + +### Screen 2 + +In this screen, you can view the anomaly type that describes the issue, along with a graphical representation. You can perform the following actions: + +1. **View Details:** + + - Click on the red dot on the graph, and choose *View Details* to find more information on the next screen. + + For multiple APIs: Click on the red dot on the graph, select the anomaly type from the list, and choose *View Details*. + + +2. **Evaluate Anomaly:** Evaluating anomalies helps the AI training model distinguish between genuine anomalies and similar fluctuations, thereby assisting the learning process and reducing the occurrence of false positives and false negatives in future classifications. + + To evaluate, follow these steps: + + 1. Click on the red dot on the graph, and choose *Evaluate Anomaly*. + + 2. In the *Evaluate Anomaly* window: + - Select *Yes* if the detected anomaly appears to be abnormal and to confirm it as a true anomaly. + + - Select *No* if the detected anomaly seems to be normal and to confirm it as not an anomaly. + - Click on *Save* to confirm your changes. + + + You can also evaluate an anomaly on the next screen by clicking on the *Evaluate* button. Once evaluated, the status will be displayed right below the **Evaluation** field. + + +![](images/GraphImage_7289bd3.png) + + + +### **Screen 3** + +In this screen, you can access the following information: + +- Evaluation: Displays the status of an anomaly whether it has been evaluated or not. To evaluate, click on the *Evaluate* button. + +- API Anomaly Type: A red arrow is displayed to indicate a surge or drop, depending on the anomaly type. The possible anomaly types include API Traffic \(Increase or Decrease\), API Response Time \(Increase or Decrease\), or API Error Count Increase \(client or server errors\). +- Description: Displays the observed percentage variation. +- Time Stamp: Displays the date and time of issue detection. +- Details: + - API causing this anomaly: Displays the name of the API that is causing the anomaly. + + - Affected Target Hosts: Displays the name of the affected API provider. + - Developer Details: Displays the name of the developer. + +- Suggestions: In this tab, you can view suggestions to help resolve the anomaly. Click *View APIs* to be redirected to the *Configure* \> *APIs* page, where you can review the API that is causing the anomaly and conduct further investigation to resolve it. + +> ### Note: +> Anomaly Detection is an AI-based feature, and there is a possibility of receiving inaccurate responses. If you encounter any discrepancies, please share your valuable feedback by clicking on \(**Give feedback**\) icon. + + + + + +## Graph: Actual vs. Expected Patterns for API Calls + +The graph provides a visualization of actual and expected patterns for different types of API calls over a specified timeframe, focusing on key metrics such as **API Traffic** \(Increase or Decrease\), **API Response Time** \(Increase or Decrease\), and **API Error Count Increase** \(Client or Server errors\). The x-axis represents time intervals, while the y-axis reflects the respective metrics' values. + +**API Traffic** + +**Actual**: The solid blue line on the graph represents the actual volume of API calls observed during the selected period. Peaks indicate surge in API traffic, while troughs signify decreased activity, a drop in the call count. + +**Expected**: The expected pattern is represented by a dotted line on the graph. Deviations from this line may signify anomalies in the API call behavior. + +**Action**: A consistent alignment between the actual and expected patterns suggests normal and expected API behavior, while variation, especially sudden spikes or drops, may indicate anomalies that require further investigation. + +**API Response Time** + +**Actual**: The solid blue line on the graph represents the actual response time in seconds for API calls observed during the selected period. Peaks indicate an increase in the API response time, while troughs signify a decrease. + +**Expected**: The expected pattern is represented by a dotted line on the graph. Deviations from this line may signify anomalies in the API call behavior. + +**Action**: A consistent alignment between the actual and expected patterns suggests normal and expected API behavior, while variation, especially sudden increase or decrease, may indicate anomalies that require further investigation. + +**API Errors \(Client or Server Errors\)** + +**Actual**: The solid blue line on the graph represents the actual error count \(client or server errors\) observed during the selected period. Peaks indicate an increase in the error count, while troughs signify a decrease. + +**Expected**: The expected pattern is represented by a dotted line on the graph. Deviations from this line may signify anomalies in the API call behavior. + +**Action**: A consistent alignment between the actual and expected patterns suggests normal and expected API errors, while variation, especially sudden increase or decrease, may indicate anomalies that require further investigation. + + + + + +## Action Bar + +![](images/ActionBar_4479fe3.png) + +The Action Bar is located in the top right corner of **Anomalies** window. It provides controls that allow you to interact with the displayed data. These controls enable you to switch between graphical and tabular views, select the time period you wish to analyze for anomalies, and perform other actions as described below: + +Click to switch between full screen view and default screen view. + +Click the drop-down to select the time period. The data can be viewed for a maximum of 6 months. + +Click for graphical view. + +Click for tabular view. + +Click or to zoom in or out the graph. This option is helpful for accessing the red dot, which indicates an anomaly on the graph. + +**Related Information** + + +[Enabling Anomaly Detection](enabling-anomaly-detection-98534a0.md "To detect anomalies for API proxy calls, you need to enable the anomaly detection setting.") + +[Configuring APIs for Anomaly Detection](configuring-apis-for-anomaly-detection-9e7e5d1.md "View or configure APIs for anomaly detection.") + +[Subscribing to Email Notification Alerts](subscribing-to-email-notification-alerts-88e96f4.md "Receive real-time email alerts for anomaly detection services.") + diff --git a/docs/ISuite/50-Development/working-with-imported-archives-e00e81d.md b/docs/ISuite/50-Development/working-with-imported-archives-e00e81d.md deleted file mode 100644 index b45dee1e..00000000 --- a/docs/ISuite/50-Development/working-with-imported-archives-e00e81d.md +++ /dev/null @@ -1,28 +0,0 @@ - - -# 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/50-Development/xi-receiver-handles-duplicates-based-on-unique-id-in-payload-3add2bf.md b/docs/ISuite/50-Development/xi-receiver-handles-duplicates-based-on-unique-id-in-payload-3add2bf.md index 6b53aa4f..f701b97c 100644 --- a/docs/ISuite/50-Development/xi-receiver-handles-duplicates-based-on-unique-id-in-payload-3add2bf.md +++ b/docs/ISuite/50-Development/xi-receiver-handles-duplicates-based-on-unique-id-in-payload-3add2bf.md @@ -174,9 +174,8 @@ To test the scenario, perform the following steps: 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) - - [Setting Up Inbound HTTP Connections (with Basic Authentication), Neo Environment](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/391c45cfcd0f4435952ab085283b7f7d.html "") :arrow_upper_right: + - [Basic Authentication with clientId and clientsecret for Integration Flow Processing](../40-RemoteSystems/basic-authentication-with-clientid-and-clientsecret-for-integration-flow-processing-647eeb3.md) + - [Setting Up Inbound HTTP Connections (with Basic Authentication), Neo Environment](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/391c45cfcd0f4435952ab085283b7f7d.html "") :arrow_upper_right: 2. Deploy a *User Credentials* artifact with the following parameters using the *Monitor* application \(*Security Material* tile under *Manage Security*\). diff --git a/docs/ISuite/60-Security/auditing-and-logging-information-for-api-management-77024b3.md b/docs/ISuite/60-Security/auditing-and-logging-information-for-api-management-77024b3.md index ca80986f..cd46c224 100644 --- a/docs/ISuite/60-Security/auditing-and-logging-information-for-api-management-77024b3.md +++ b/docs/ISuite/60-Security/auditing-and-logging-information-for-api-management-77024b3.md @@ -320,7 +320,7 @@ Example: -[Create an Application \[Classic Design\]](../50-Development/create-an-application-classic-design-7b4e71b.md) +[Create an Application \[Classic Design\]](https://help.sap.com/viewer/de4066bb3f9240e3bfbcd5614e18c2f9/Cloud/en-US/7b4e71b3887f4396aa22ce3e2ed7e0c3.html "Create an Application to consume the required APIs.") :arrow_upper_right: @@ -572,7 +572,7 @@ Example: -[Onboard an Application Developer](../50-Development/onboard-an-application-developer-786d107.md) +[Onboard an Application Developer](../onboard-an-application-developer-786d107.md) diff --git a/docs/ISuite/60-Security/auditing-and-logging-information-for-event-mesh-981d7eb.md b/docs/ISuite/60-Security/auditing-and-logging-information-for-event-mesh-981d7eb.md new file mode 100644 index 00000000..0959e4d2 --- /dev/null +++ b/docs/ISuite/60-Security/auditing-and-logging-information-for-event-mesh-981d7eb.md @@ -0,0 +1,132 @@ + + +# Auditing and Logging Information for Event Mesh + +Find a list of the security events that are logged by Event Mesh. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +Event Grouping + + + +What Events are Logged + + + +How to Identify Related Log Events + +
+ +Activate capability + + + +Activate or deactivate Event Mesh + + + +`emis-tenant-subscribed`: tracks activation of theEvent Mesh capability + +`emis-tenant-unsubscribed`: tracks deactivation of Event Mesh capability + +
+ +Upgrade SAP Integration Suite service plan + + + +Change the service plan from a lower plan to higher plan + + + +`emis-tenant-updated`: tracks the SAP Integration Suite plan upgrade. + +
+ +Managing Event Mesh broker + + + +Creating, updating, or deleting the message broker + + + +`emis-messaging-domain-created`: tracks creation of a message broker + +`emis-messaging-domain-updated`: tracks update of a message broker + +`emis-messaging-domain-deleted`: tracks deletion of a message broker + +
+ +Managing service instance for the message client + + + +Creating, updating, or deleting service instances + + + +`emis-service-instance-created`: tracks creation of a service instance + +`emis-service-instance-updated`: tracks update of a service instance + +`emis-service-instance-deleted`: tracks deletion of a service instance + +`emis-service-binding-created`: tracks a binding creation with the service instance + +`emis-service-binding-deleted`: tracks a binding deletion with the service instance + +
+ +Managing queues and topic subscription + + + +Creating, updating, or deleting queues and topic subscriptions + + + +`emis-queue-upserted`: tracks creation or update of a queue + +`emis-queue-deleted`: tracks deletion of a queue + +`emis-topic-subscription-upserted`: tracks creation/update of a topic subscription for a queue + +`emis-topic-subscription-deleted`: tracks deletion of a topic subscription for a queue + +
+ diff --git a/docs/ISuite/60-Security/data-collection-for-knowledge-base-e5bd17f.md b/docs/ISuite/60-Security/data-collection-for-knowledge-base-e5bd17f.md new file mode 100644 index 00000000..73044f56 --- /dev/null +++ b/docs/ISuite/60-Security/data-collection-for-knowledge-base-e5bd17f.md @@ -0,0 +1,78 @@ + + +# Data Collection for Knowledge Base + +Information about the data that is collected by the knowledge base for generating proposals. + +To generate and provide better proposals, SAP Integration Advisor collects some data respective to each artifact for its knowledge base. To know more about the contract information, refer to the section **SAP Integration Suite** here: [SAP Cloud Service Description Guide](https://cloudplatform.sap.com/support/service-description.html#section_11). + +The sections below pertaining to each artifact mention the details of the data which will and which will not be a part of the knowledge base. + + + + + +## Message Implementation Guidelines + +The following information of MIGs will not be part of the knowledge base: + +- Textual documentation \(names, definitions, notes, summaries\) of all components, such as messages, nodes, code values, etc. + +- MIG codelists +- Example values +- User-defined XSD Patterns +- User-defined XSD Asserts +- User review information +- Administrative data such as Created By, Modified By + +All other information including the following will be a part of the knowledge base: + +- Node properties, such as cardinality and length + +- Selected code values \(without textual documentation\) +- Qualification details + + + + + +## Mapping Guidelines + +The following information of MAGs will not be part of the knowledge base: + +- Textual documentation \(names, definitions, notes, summaries\) of all components, such as mapping elements, global parameters, shared code, code values, etc. + +- XSLT code of functions and XPath conditions explicitly marked as confidential +- XSLT code of functions and XPath conditions containing global parameters +- Status and status comments +- Administrative data such as Created By, Modified By + +All other information including the following will be a part of the knowledge base: + +- Mapping lines between source and target nodes + +- Constants +- Code value mappings +- XSLT code of functions and XPath conditions that are not marked confidential +- XSLT code of shared code + + + + + +## Custom Messages + +The following information of custom messages will not be part of the knowledge base: + +- Textual documentation \(names, definitions, notes, summaries\) of all components, such as messages, nodes, code values, etc. + +- Administrative data such as Created By, Modified By + +All other information including the following will be a part of the knowledge base: + +- Identification of message and codelists + +- Identification of all nodes and types +- Identification of code values +- Node properties, such as cardinality and length + diff --git a/docs/ISuite/60-Security/data-protection-and-privacy-for-api-management-d50613e.md b/docs/ISuite/60-Security/data-protection-and-privacy-for-api-management-d50613e.md index 57d0952e..5dddd158 100644 --- a/docs/ISuite/60-Security/data-protection-and-privacy-for-api-management-d50613e.md +++ b/docs/ISuite/60-Security/data-protection-and-privacy-for-api-management-d50613e.md @@ -204,7 +204,7 @@ API Management stores the API portal administrator’s user ID. Storing the user API Management stores personal information such as first name, last name, user ID, and e-mail ID of users who have logged on to the Developer Portal. All the personal information stored in the application is deleted when the access for the corresponding user is revoked. -In API Management, application developers can contact their developer portal administrators to have their personal data erased and access revoked. For more information, see [Revoke Access \[Classic Design\]](../50-Development/revoke-access-classic-design-147fb9d.md) and [Delete Data of Unregistered Users](../50-Development/delete-data-of-unregistered-users-d548233.md). +In API Management, application developers can contact their developer portal administrators to have their personal data erased and access revoked. For more information, see [Revoke Access \[Classic Design\]](https://help.sap.com/viewer/de4066bb3f9240e3bfbcd5614e18c2f9/Cloud/en-US/147fb9dca1414f6a956dd05b4c86d74d.html "Revoke the access of an application developer.") :arrow_upper_right: and [Delete Data of Unregistered Users](../delete-data-of-unregistered-users-d548233.md). diff --git a/docs/ISuite/60-Security/data-protection-and-privacy-for-event-mesh-274de7b.md b/docs/ISuite/60-Security/data-protection-and-privacy-for-event-mesh-274de7b.md new file mode 100644 index 00000000..bee7c211 --- /dev/null +++ b/docs/ISuite/60-Security/data-protection-and-privacy-for-event-mesh-274de7b.md @@ -0,0 +1,19 @@ + + +# Data Protection and Privacy for Event Mesh + +Understand how Event Mesh handles data protection and privacy. + +Event Mesh doesn't read, enrich, or process the events that are sent. As a plain infrastructure component, Event Mesh offers transport and storage of messages. + +Message content and storage duration are customer's responsibility. Messages are stored until they’re received by subscribing applications. Event Mesh doesn’t access the content of the messages. + +In case, messages are being sent that contain personal data, it’s recommended to: + +- Enable only trusted applications subscribe the messages + +- Ensure that proper access control is implemented within the publishing and subscribing applications. + +- Ensure that messages aren’t stored longer than necessary in queues. For example, by consuming the messages instantly or by specifying a "time to live" either for the message \(supported with AMQP 1.0\) or for the queue \(supported by Event Mesh\). + + 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 c29e3f9d..49daaf31 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 [Tasks and Corresponding Role Collections](../tasks-and-corresponding-role-collections-911ca5a.md). +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). diff --git a/docs/ISuite/60-Security/identity-and-access-management-for-event-mesh-7a91c65.md b/docs/ISuite/60-Security/identity-and-access-management-for-event-mesh-7a91c65.md new file mode 100644 index 00000000..7b5bafe0 --- /dev/null +++ b/docs/ISuite/60-Security/identity-and-access-management-for-event-mesh-7a91c65.md @@ -0,0 +1,72 @@ + + +# Identity and Access Management for Event Mesh + +Learn about identity and access management for Event Mesh. + + + + + +## Authentication and Authorization + + + +### Authentication + +Users who access Event Mesh related features in SAP Integration Suite are authenticated against an identity provider. SAP Identity Service \(ID Service\) is used by default. SAP ID Service is the central service for the process of managing identities and their lifecycles. + +User authentication is provided by the authentication methods supported by SAP BTP, which uses the Security Assertion Markup Language \(SAML\) 2.0 protocol for both authentication and single sign-on. + + + +### Authorization + +Authorization for Event Mesh determines the level of access. Administrators generally authorize users with appropriate roles and role collections. + + + +### Authentication for Components + +The following table describes the components and their associated authentication actions: + + + + + + + + + + + + + + + +
+ +Component + + + +Description + +
+ +Messaging gateways + + + +The consumer application, for example SAP S/4 HANA, calls the messaging gateways with the OAuth token of the OAuth client. The OAuth token is created when you create a service instance of *Event Mesh Message Client* in the SAP Business Technology Platform cockpit. + +
+ +Integration Suite user interface + + + +An integration developer or administrator of the Event Mesh capability accesses the Integration Suite user interface. While doing so, the user initiates an OAuth-based login and forwards the OAuth token to the Event Mesh backend. The backend component validates the token and checks for appropriate scope. + +
+ diff --git a/docs/ISuite/60-Security/personas-in-event-mesh-ee79946.md b/docs/ISuite/60-Security/personas-in-event-mesh-ee79946.md new file mode 100644 index 00000000..66e45663 --- /dev/null +++ b/docs/ISuite/60-Security/personas-in-event-mesh-ee79946.md @@ -0,0 +1,112 @@ + + +# Personas in Event Mesh + +When you perform user management tasks using SAP BTP cockpit, you can find a set of predefined roles that you can assign to users of the account. These roles are associated to certain personas relevant for an event-driven integration project. + +Personas cover the different tasks associated with an integration project. To assign the applicable role collections for a user, see [Configuring User Access to SAP Integration Suite](../configuring-user-access-to-sap-integration-suite-2c6214a.md). + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +Persona + + + +Authentication + + + +Authorization + + + +Associated Role Collection + +
+ +Integration Developer in Event Mesh + + + +OAuth \(Authorization code flow\) + + + +- Manage queues, topic subscriptions + +- Monitor usage of message brokers and queues + + + + + + +EventMeshDeveloper + +
+ +Administrator for Event Mesh + + + +OAuth \(Authorization code flow\) + + + +- Manage message brokers + +- Manage queues, topic subscriptions + +- Monitor usage of message broker and queues + + + + + + +EventMeshAdmin + +
+ +OAuth Client + + + +OAuth \(Client credentials flow\) + + + +Handle technical communication with the publishing and subscribing applications during binding + + + +Not applicable + +
+ diff --git a/docs/ISuite/60-Security/security-aspects-of-data-data-flow-for-event-mesh-8713813.md b/docs/ISuite/60-Security/security-aspects-of-data-data-flow-for-event-mesh-8713813.md new file mode 100644 index 00000000..c8523671 --- /dev/null +++ b/docs/ISuite/60-Security/security-aspects-of-data-data-flow-for-event-mesh-8713813.md @@ -0,0 +1,14 @@ + + +# Security Aspects of Data, Data Flow for Event Mesh + +All data in transit are protected by methods such as encryption. + + + + + +## Transport-Level Security + +All outbound communication channels \(calls to messaging gateway\) are encrypted via Transport Layer Security. + diff --git a/docs/ISuite/60-Security/specific-data-assets-a6491d2.md b/docs/ISuite/60-Security/specific-data-assets-a6491d2.md index 97d9d305..18f407fc 100644 --- a/docs/ISuite/60-Security/specific-data-assets-a6491d2.md +++ b/docs/ISuite/60-Security/specific-data-assets-a6491d2.md @@ -2,10 +2,12 @@ # Specific Data Assets -There are two data assets that are stored by Integration Advisor: +There are four data assets that are stored by Integration Advisor: - Message Implementation Guidelines - Mapping Guidelines +- Custom Messages +- Codelists These assets are stored by the application till the contract for usage of application is valid. After the contract ends, the assets are deleted. diff --git a/docs/ISuite/60-Security/tasks-and-permissions-for-cloud-integration-556d557.md b/docs/ISuite/60-Security/tasks-and-permissions-for-cloud-integration-556d557.md index c94eeeda..0993531d 100644 --- a/docs/ISuite/60-Security/tasks-and-permissions-for-cloud-integration-556d557.md +++ b/docs/ISuite/60-Security/tasks-and-permissions-for-cloud-integration-556d557.md @@ -439,6 +439,70 @@ Partner Directory configurator +Design + + + + +Delete design time artifact locks + + + + +WebToolingWorkspace.Read + +WorkspaceArtifactLocks.Delete + + + + +WorkspaceArtifactLocksDelete + + + + +Tenant Administrator + + + + + + +Design + + + + +Read design time artifact locks + + + + +WebToolingWorkspace.Read + +WorkspaceArtifactLocks.Read + + + + +WorkspaceArtifactLocksRead + + + + +Integration Developer + +Business Expert + +Read-Only Persona/System Developer + +Tenant Administrator + + + + + + Monitor @@ -1145,7 +1209,7 @@ AccessPolicies.Read -  +AccessPoliciesRead @@ -1178,7 +1242,7 @@ AccessPolicies.Write -  +AccessPoliciesEdit @@ -1319,6 +1383,35 @@ Monitor +Configure data stores and queues + + + + +IntegrationOperationServer.read + +ESBDataStore.Config + + + + +DataStoresAndQueuesConfig + + + + +Tenant Administrator + + + + + + +Monitor + + + + View payload of stored messages from message store @@ -1424,7 +1517,7 @@ Monitor Override access policies -Get access to data \(for example, JMS queues, message processing log attachments\) although the data is protected by access policies. Note that when this role is assigned to a user, it overrides all access policies that might prevent the user from accessing data processed by certain artifacts \(for example, integration flows\). However, the role AccessPoliciesArtifacts.AccessAll doesn't grant permission to access payload data. +Get access to data \(for example, JMS queues, message processing log attachments\) although the data is protected by access policies. Note that when this role is assigned to a user, it overrides all access policies that might prevent the user from accessing data processed by certain artifacts \(for example, integration flows\). However, this role doesn't grant permission to access payload data. @@ -1434,7 +1527,7 @@ AccessPoliciesArtifacts.AccessAll -AccessPoliciesArtifacts.AccessAll +AccessAllAccessPoliciesArtifacts @@ -1451,6 +1544,35 @@ Monitor +Activate or deactivate queues + + + + +IntegrationOperationServer.read + +ESBDataStore.Activate + + + + +QueuesActivate + + + + +Tenant Administrator + + + + + + +Monitor + + + + View runtime processing locks @@ -1575,6 +1697,70 @@ Monitor +Activate external logging + + + + +IntegrationOperationServer.read + +ExternalLogging.Activate + + + + +ExternalLoggingActivate + + + + +Tenant Administrator + + + + + + +Monitor + + + + +Read the activation state of external logging + + + + +IntegrationOperationServer.read + +ExternalLoggingActivation.Read + + + + +ExternalLoggingActivationRead + + + + +Integration Developer + +Business Expert + +Read-Only Persona/System Developer + +Tenant Administrator + + + + + + +Monitor + + + + Change log level @@ -1787,6 +1973,101 @@ Tenant Administrator +Monitor + + + + +Read data metrics for the health check monitoring API. This covers, for example, JMS queue statistics, certificate expiry dates\) + + + + +ESBDataStore.read + +NodeManager.read + +ResourceUsageData.Read + + + + +HealthCheckMonitoringDataRead + + + + +  + + + + + + +Operate + + + + +Get read-only access to Operations Cockpit. + +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. + + + + +n.a. + + + + +IntegrationCellOperationCockpitRead + + + + +Integration Developer + +Business Expert + +Read-Only Persona/System Developer + +Tenant Administrator + + + + + + +Operate + + + + +Get full access to the Operations Cockpit. + +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. + + + + +n.a. + + + + +IntegrationCellOperationCockpitWrite + + + + +Tenant Administrator + + + + + + Inspect @@ -1825,7 +2106,7 @@ Settings -View/change runtime profile +View and change runtime profile @@ -1869,6 +2150,33 @@ WebToolingSettingsProductProfiles.savetenantconfiguration Tenant Administrator + + + + + +Settings + + + + +Configure *Design Guidelines* settings + + + + +WorkspaceDesignGuidelines.Configure + + + + +WorkspaceDesignGuidelinesConfigure + + + + +Tenant Administrator + diff --git a/docs/ISuite/60-Security/tasks-and-permissions-in-event-mesh-b497c6d.md b/docs/ISuite/60-Security/tasks-and-permissions-in-event-mesh-b497c6d.md new file mode 100644 index 00000000..ecc35042 --- /dev/null +++ b/docs/ISuite/60-Security/tasks-and-permissions-in-event-mesh-b497c6d.md @@ -0,0 +1,118 @@ + + +# Tasks and Permissions in Event Mesh + +Overview of roles that are required to accomplish various tasks related to Event Mesh. It's also indicated how the tasks and roles are mapped to the personas defined for Event Mesh. + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +Role + + + +Tasks + + + +Available in Role Collection + + + +Persona + +
+ +EventMeshManageResources + + + +Manage queues and topic subscriptions + + + +- EvenMeshAdmin + +- EventMeshDeveloper + + + + + + +- Administrator + +- Integration Developer + + + + +
+ +EventMeshManageBroker + + + +Manage the lifecycle of the message broker + + + +EvenMeshAdmin + + + +Administrator + +
+ +EventMeshMonitor + + + +Monitor the usage of message broker and queues + + + +- EvenMeshAdmin + +- EventMeshDeveloper + + + + + + +- Administrator + +- Integration Developer + + + + +
+ diff --git a/docs/ISuite/60-Security/technical-landscape-daea676.md b/docs/ISuite/60-Security/technical-landscape-daea676.md index 846b4809..df952abd 100644 --- a/docs/ISuite/60-Security/technical-landscape-daea676.md +++ b/docs/ISuite/60-Security/technical-landscape-daea676.md @@ -42,6 +42,8 @@ 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: 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 46d0023a..4f6e8923 100644 --- a/docs/ISuite/APIM-Migration/clone-api-management-content-7abd887.md +++ b/docs/ISuite/APIM-Migration/clone-api-management-content-7abd887.md @@ -4,7 +4,7 @@ Clone the API Management content using the Tenant Cloning tool. -Once you have your source and target system ready, you can clone your API Management content to the target system by running the Tenant Cloning Tool that you downloaded from [here](https://help.sap.com/docs/link-disclaimer?site=https%3A%2F%2Frepo1.maven.org%2Fmaven2%2Fcom%2Fsap%2Fapimgmt%2Fapim-tct-sdk%2F1.8.2%2Fapim-tct-sdk-1.8.2.zip). +Once you have your source and target system ready, you can clone your API Management content to the target system by running the Tenant Cloning Tool that you downloaded from [here](https://help.sap.com/docs/link-disclaimer?site=https%3A%2F%2Frepo1.maven.org%2Fmaven2%2Fcom%2Fsap%2Fapimgmt%2Fapim-tct-sdk%2F1.8.3%2Fapim-tct-sdk-1.8.3.zip). @@ -63,7 +63,38 @@ Once you have your source and target system ready, you can clone your API Manage - + + +## Context + +To migrate all API Management entities, you need to complete the apim-tct-input.json file in the tenant cloning tool by providing all the necessary details. + +In case you want to migrate selected API proxies from the source API Management tenant to the target API Management tenant, make the following configurations in the `apim-tct-input.json` file: + +- Set `selectiveEntityMigration` to `true` + +- Provide the names of the API proxies in `selectiveEntities`, separated by commas. + + +For more information, see [selectiveEntityMigration](clone-api-management-content-7abd887.md#loio7abd887d54604e699543ef57c618c8d7__selective_entity_migration) and [selectiveEntities](clone-api-management-content-7abd887.md#loio7abd887d54604e699543ef57c618c8d7__selective_entities). + +By enabling this feature, you can explicitly clone the API proxies mentioned in the configuration file from the source to the target tenant. The cloning process will occur in the following sequence: + +- Certificate stores + +- Key value maps entries + +- API providers + +- API proxies + + +> ### Note: +> If `selectiveEntityMigration` is set to `true`, only the certificate stores, key-value maps, API providers, and API proxies will be migrated. Other entities such as products and applications will not be migrated. If it is set to `false` or not available in the `apim-tct-input.json` file, all entities will be considered for migration. +> +> The `selectiveEntityMigration` parameter is optional. + + ## Procedure @@ -149,7 +180,7 @@ Once you have your source and target system ready, you can clone your API Manage URL of the source API management, API portal in the Neo environment - Example: `https://-.` + `https://-.` @@ -1315,6 +1346,107 @@ Once you have your source and target system ready, you can clone your API Manage The supported values for this parameter is either default or switchover. + + + + + + selectiveEntityMigration + + + + +   + + + + +   + + + + +   + + + + + Boolean + + + + + Supported values: true/false + + + + + Optional + + + + + If you want to migrate API proxies selectively, please set this flag to 'true'. + + > ### Note: + > Once this flag is set to 'true', please ensure that the *selectiveEntities* parameter is not left empty. + + + + + + + + + selectiveEntities + + + + + API proxies + + + + +   + + + + +   + + + + + Enter the list of API proxy names in a comma-separated manner as shown below. + + + + +   + + + + + Optional + + + + + Enter the API proxies that you want to migrate. + + > ### Sample Code: + > ``` + > "selectiveEntityMigration": true, + > "selectiveEntities": { + > "APIProxies": [ + > "SCpayload", "SetTLSPropertiesAsPayload", "newproxy" + > ] + > } + > ``` + + + @@ -1385,7 +1517,7 @@ Once you have your source and target system ready, you can clone your API Manage 2. Run the following commands from your Java command-line interface to verify the setup and check the version of the tool. This is an optional step. - To verify the setup: - `java -jar apim-tct-client-.jar verify` + `java -jar apim-tct-client-.jar verifyExample:` - To check the version of the tenant cloning tool you’re using: @@ -1400,7 +1532,7 @@ Once you have your source and target system ready, you can clone your API Manage Your API Management entities are now cloned to your target system. - An excel file named `apimtct-output.xlsx` and a log file named `apimtct-logs.log` are generated in the same folder where the .jar file is present. + Example:An excel file named `apimtct-output.xlsx` and a log file named `apimtct-logs.log` are generated in the same folder where the .jar file is present. The status of each cloned entity is stored in a separate worksheet within the output excel file. diff --git a/docs/ISuite/APIM-Migration/clone-api-management-content-between-cloud-foundry-environments-2e5d127.md b/docs/ISuite/APIM-Migration/clone-api-management-content-between-cloud-foundry-environments-2e5d127.md index 276ea1c1..91419f89 100644 --- a/docs/ISuite/APIM-Migration/clone-api-management-content-between-cloud-foundry-environments-2e5d127.md +++ b/docs/ISuite/APIM-Migration/clone-api-management-content-between-cloud-foundry-environments-2e5d127.md @@ -4,7 +4,7 @@ Clone the API Management content using the Tenant Cloning Tool. -Once you have your source and target system ready, you can clone your API Management content to the target system by running the Tenant Cloning Tool that you downloaded from [here](https://help.sap.com/docs/link-disclaimer?site=https%3A%2F%2Frepo1.maven.org%2Fmaven2%2Fcom%2Fsap%2Fapimgmt%2Fapim-tct-sdk%2F1.8.2%2Fapim-tct-sdk-1.8.2.zip). +Once you have your source and target system ready, you can clone your API Management content to the target system by running the Tenant Cloning Tool that you downloaded from [here](https://help.sap.com/docs/link-disclaimer?site=https%3A%2F%2Frepo1.maven.org%2Fmaven2%2Fcom%2Fsap%2Fapimgmt%2Fapim-tct-sdk%2F1.8.3%2Fapim-tct-sdk-1.8.3.zip). @@ -52,7 +52,7 @@ Once you have your source and target system ready, you can clone your API Manage - Open the default terminal from your system. - Go to the `apim-tct` folder in the terminal. -- Run the `chmod +x download_dependencies.sh` command to make the file executable. +- Run the `chmod +x download_dependencies.sh` - Run the `.\download_dependencies.sh` command. The required libraries are downloaded to the `lib` folder. @@ -63,7 +63,38 @@ Once you have your source and target system ready, you can clone your API Manage - + + +## Context + +To migrate all API Management entities, you need to complete the apim-tct-input.json file in the tenant cloning tool by providing all the necessary details. command to make the file executable. + +In case you want to migrate selected API proxies from the source API Management tenant to the target API Management tenant, make the following configurations in the `apim-tct-input.json` file: + +- Set `selectiveEntityMigration` to `true` + +- Provide the names of the API proxies in `selectiveEntities`, separated by commas. + + +For more informarmation, see [selectiveEntityMigration](clone-api-management-content-between-cloud-foundry-environments-2e5d127.md#loio2e5d127a13fc4a3cbba26bfd5ae44e69__selective_entity_migration) and [selectiveEntities](clone-api-management-content-between-cloud-foundry-environments-2e5d127.md#loio2e5d127a13fc4a3cbba26bfd5ae44e69__selective_entities). + +By enabling this feature, you can explicitly clone the API proxies mentioned in the configuration file from the source to the target. The cloning process will occur in the following sequence: + +- Certificate stores + +- Key value maps + +- API providers + +- API proxies + + +> ### Note: +> If `selectiveEntityMigration` is set to `true`, only the above entities will be migrated. Other entities such as products and applications will not be migrated. If it is set to `false` or not available in the `apim-tct-input.json` file, all entities will be considered for migration. +> +> The `selectiveEntityMigration` parameter is optional. + + ## Procedure @@ -1313,6 +1344,107 @@ Once you have your source and target system ready, you can clone your API Manage The default values for this parameter is supported. Switchover is not applicable for this scenario. + + + + + + selectiveEntityMigration + + + + +   + + + + +   + + + + +   + + + + + Boolean + + + + + Supported values: true/false + + + + + Optional + + + + + If you want to migrate API proxies selectively, please set this flag to 'true'. + + > ### Note: + > Once this flag is set to 'true', please ensure that the *selectiveEntities* parameter is not left empty. + + + + + + + + + selectiveEntities + + + + + API proxies + + + + +   + + + + +   + + + + + Enter the list of API proxy names in a comma-separated manner as shown below. + + + + +   + + + + + Optional + + + + + Enter the API proxies that you want to migrate. + + > ### Sample Code: + > ``` + > "selectiveEntityMigration": true, + > "selectiveEntities": { + > "APIProxies": [ + > "SCpayload", "SetTLSPropertiesAsPayload", "newproxy" + > ] + > } + > ``` + + + @@ -1508,8 +1640,6 @@ Once you have your source and target system ready, you can clone your API Manage - - ## Next Steps After the cloning process completes, you must perform the tasks mentioned in the `User Actions` worksheet within the output excel file `apimtct-output.xlsx`. 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 76dfdfeb..9418b1da 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 can be cloned: +The following list displays the API Management entities that are cloned: - Certificates and Certificate Store - Rate Plans @@ -62,8 +62,6 @@ The following list displays the API Management entities that can be 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 562b08d2..965d674d 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 can be cloned: +The following list displays the API Management entities that are cloned: - Certificates and Certificate Store - Rate Plans @@ -62,7 +62,6 @@ The following list displays the API Management entities that can be 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 a8ed3802..c59eb654 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](../unbinding-a-cloud-foundry-application-from-an-api-management-api-portal-service-instance-09fd33a.md) +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) 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](../unbinding-a-cloud-foundry-application-from-an-api-management-api-portal-service-instance-09fd33a.md) +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) 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/tenant-cloning-tool-behavior-6d15ffd.md b/docs/ISuite/APIM-Migration/tenant-cloning-tool-behavior-6d15ffd.md index 64348c0f..8f9e33be 100644 --- a/docs/ISuite/APIM-Migration/tenant-cloning-tool-behavior-6d15ffd.md +++ b/docs/ISuite/APIM-Migration/tenant-cloning-tool-behavior-6d15ffd.md @@ -44,3 +44,6 @@ 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 bc652118..74dcb361 100644 --- a/docs/ISuite/APIM-Migration/tenant-cloning-tool-behavior-b23c603.md +++ b/docs/ISuite/APIM-Migration/tenant-cloning-tool-behavior-b23c603.md @@ -44,3 +44,6 @@ 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 3147c516..632c1c1c 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. This is required to access the XSUAA APIs for authorization and trust mangement services. +- You have created a destination of type `OAuth2Credentials` to the XSUAA APIs by using the credentials you derived from creating the service key. 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. @@ -131,8 +131,8 @@ Create a service instance using API Access plan. > > See the section below to know how to obtain your `developerId`. > - > - If you have not registered to the API Management, API business hub enterprise application, follow the steps in [Register on API business hub enterprise](50-Development/register-on-api-business-hub-enterprise-c85fafe.md) and try again. - > - If you are not registered to the API Management, API business hub enterprise application, and require your admin to onboard you, contact your admin. See [Onboard an Application Developer](50-Development/onboard-an-application-developer-786d107.md). + > - If you have not registered to the API Management, API business hub enterprise application, follow the steps in [Register on API business hub enterprise](register-on-api-business-hub-enterprise-c85fafe.md) and try again. + > - If you are not registered to the API Management, API business hub enterprise application, and require your admin to onboard you, contact your admin. See [Onboard an Application Developer](onboard-an-application-developer-786d107.md). > > **How to obtain the `developerId`**: > diff --git a/docs/ISuite/accessing-api-management-apis-programmatically-24a2c37.md b/docs/ISuite/accessing-api-management-apis-programmatically-24a2c37.md index 6114d518..e4e725a4 100644 --- a/docs/ISuite/accessing-api-management-apis-programmatically-24a2c37.md +++ b/docs/ISuite/accessing-api-management-apis-programmatically-24a2c37.md @@ -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/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:. + 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:. - 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. 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 86a88645..6925a330 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 @@ -13,7 +13,7 @@ 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). +> The API Management platform incorporates the circuit breaker pattern to enhance the resilience of the back-end. For more information, see [Circuit Breaker for On-Premise Provider](https://help.sap.com/viewer/66d066d903c2473f81ec33acfe2ccdb4/Cloud/en-US/bd3c2d5be9ec4051ac6c0295173b4c22.html "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.") :arrow_upper_right:. ![](images/On-prem_Connectivity_1067d7f.png) diff --git a/docs/ISuite/activate-and-configure-api-management-capability-f6eb433.md b/docs/ISuite/activate-and-configure-api-management-capability-f6eb433.md index caa2849a..24f7a6ec 100644 --- a/docs/ISuite/activate-and-configure-api-management-capability-f6eb433.md +++ b/docs/ISuite/activate-and-configure-api-management-capability-f6eb433.md @@ -76,7 +76,7 @@ To access the *API Settings*, the *APIManagement.Selfservice.Administrator* role **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.") +[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.") diff --git a/docs/ISuite/activate-edge-integration-cell-a8e497f.md b/docs/ISuite/activate-edge-integration-cell-a8e497f.md index c30f429c..b66ace48 100644 --- a/docs/ISuite/activate-edge-integration-cell-a8e497f.md +++ b/docs/ISuite/activate-edge-integration-cell-a8e497f.md @@ -21,11 +21,6 @@ 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 @@ -35,6 +30,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 95857c51..984cf793 100644 --- a/docs/ISuite/activating-and-managing-capabilities-2ffb343.md +++ b/docs/ISuite/activating-and-managing-capabilities-2ffb343.md @@ -13,7 +13,7 @@ Activate capabilities for the SAP Integration Suite. ## Prerequisites - You have access to the Integration Suite home page. See [Working with Integration Suite Home](20-Working_with_SAP_Integration_Suite_Home/working-with-integration-suite-home-a53dce3.md). -- You have the Integration\_Provisioner role assigned to your user. 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 collection assigned to your user. See [Subscribing and Configuring Initial Access to SAP Integration Suite](10-InitialSetup/subscribing-and-configuring-initial-access-to-sap-integration-suite-8a3c8b7.md). @@ -29,6 +29,8 @@ This topic describes how to add and activate relevant capabilities in Integratio - Graph +- Event Mesh + - Open Connectors - Integration Advisor @@ -118,6 +120,18 @@ This topic describes how to add and activate relevant capabilities in Integratio + Event Mesh + + + + + *Manage Business Events* + + + + + + Open Connectors @@ -187,11 +201,9 @@ This topic describes how to add and activate relevant capabilities in Integratio > ### 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. > - > - After activating Cloud Integration, create a service broker instance. See [Creating Service Instances](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/883f025c30a64373b4e4102238a39fd4.html). + > - You can choose *Manage Capabilities* to activate additional capabilities at a later point in time. > - > - 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-to-sap-integration-suite-2c6214a.md). + > - After activation, assign the required role collections to users for accessing the individual capabilities. See [Configuring User Access](configuring-user-access-to-sap-integration-suite-2c6214a.md). @@ -200,11 +212,15 @@ 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 to SAP Integration Suite](configuring-user-access-to-sap-integration-suite-2c6214a.md). +- Capabilities are displayed on the home page as tiles. To access the functionalities offered by these capabilities, users must have the required role collections assigned. See [Configuring User Access to SAP Integration Suite](configuring-user-access-to-sap-integration-suite-2c6214a.md). +- After activating Cloud Integration, create a service broker instance. See [Creating Service Instances](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/883f025c30a64373b4e4102238a39fd4.html). + - 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). +- The Event Mesh capability needs an additional configuration step before usage. See: [Initiating the Message Broker](initiating-the-message-broker-61eb5dd.md). + **Related Information** -[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.") +[Centralized API business hub enterprise](centralized-api-business-hub-enterprise-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/activating-api-business-hub-enterprise-a0fb69b.md b/docs/ISuite/activating-api-business-hub-enterprise-a0fb69b.md new file mode 100644 index 00000000..0b9ab790 --- /dev/null +++ b/docs/ISuite/activating-api-business-hub-enterprise-a0fb69b.md @@ -0,0 +1,70 @@ + + +# Activating API Business Hub Enterprise + +Steps to activate API business hub enterprise in SAP Integration Suite. API business hub enterprise is one of the the sub-capabilities of API Management with SAP Integration Suite + + + + + + + + + + + + + + + + + + + +
+ +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 API business hub enterprise + + + +Add and activate API business hub enterprise in Integration Suite. For more information, see [Activating and Managing Capabilities](activating-and-managing-capabilities-2ffb343.md). + +> ### Note: +> The API business hub enterprise checkbox is selected by default if you've subscribed to the premium/standard plan and have activated API Management. + + + +
+ +Access API business hub enterprise + + + +To access the *API Settings*, the *APIManagement.Selfservice.Administrator* role must me assigned to you. + +
+ diff --git a/docs/ISuite/50-Development/analyze-applications-deb57dd.md b/docs/ISuite/analyze-applications-deb57dd.md similarity index 100% rename from docs/ISuite/50-Development/analyze-applications-deb57dd.md rename to docs/ISuite/analyze-applications-deb57dd.md diff --git a/docs/ISuite/api-business-hub-enterprise-41f7c45.md b/docs/ISuite/api-business-hub-enterprise-41f7c45.md new file mode 100644 index 00000000..660352d5 --- /dev/null +++ b/docs/ISuite/api-business-hub-enterprise-41f7c45.md @@ -0,0 +1,69 @@ + + +# API Business Hub Enterprise + +The API business hub enterprise is a web-based platform designed for developers to discover, explore, and utilize APIs offered by an organization. + +To enable external application developers to consume APIs from different business systems, it is essential to publish these APIs. Publishing involves presenting the API proxies in a structured manner, essentially treating them as products. As an API administrator, you can accomplish this by creating a product in Integration Suite and then publishing it on the API business hub enterprise. This allows you to expose one or more API proxies to application developers. Furthermore, content administrators on theAPI business hub enterprise also have the ability to publish their APIs, complete with relevant documentation, to a catalog that developers can access. + +Through this interface, developers can easily browse through the available APIs, access comprehensive documentation, and gain a clear understanding of how to effectively utilize them. They can also use the API testing console to make test calls to APIs and observe the corresponding responses. + +In addition to its documentation and testing capabilities, the API business hub enterprise incorporates features like self-registration, providing developers with the ability to create accounts and obtain API keys for accessing protected APIs. Furthermore, it offers functionalities for application management, including analytics and usage statistics. + +There are two subscription plans available for API business hub enterprise: + + + + + + + + + + + + + + + + + + +
+ +Subscription Plans + + + +Plan Details + + + +Reference Links + +
+ +Developer Plan + + + +By subscribing to the Developer Edition, you can build a catalog by creating products that consume APIs from different business systems. + + + + + +
+ +Standard/Premium Plan + + + +On the other hand, the Standard/Premium edition provides additional features and capabilities beyond the developer edition. It is designed for organizations that want to expose their APIs to external developers and partners, enabling them to consume and integrate with the APIs. This plan includes features such as publishing API proxies as products from Integration Suite, subscribing to these products on API business hub enterprise to create applications, access control, analytics, and monetization options. + + + + + +
+ diff --git a/docs/ISuite/api-lifecycle-5e8ea7d.md b/docs/ISuite/api-lifecycle-5e8ea7d.md index 5108bd81..6a8690f2 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/4425026877144cc2b15505ed30215167/IAT/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/66d066d903c2473f81ec33acfe2ccdb4/Cloud/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.") +[Consume API Proxies](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 API Proxies](50-Development/analyze-api-proxies-7712c61.md "Use the capabilities of API Analytics to analyze API proxy usage and performance.") +[Analyze APIs](50-Development/analyze-apis-7712c61.md "Use the capabilities of API Analytics to analyze API usage and performance.") diff --git a/docs/ISuite/api-management-service-plans-e064663.md b/docs/ISuite/api-management-service-plans-e064663.md index d5c9c375..df62f704 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 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 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/ISuite/50-Development/approve-the-pending-connection-requests-new-design-e296f80.md b/docs/ISuite/approve-the-pending-connection-requests-e296f80.md similarity index 74% rename from docs/ISuite/50-Development/approve-the-pending-connection-requests-new-design-e296f80.md rename to docs/ISuite/approve-the-pending-connection-requests-e296f80.md index 6ec82cdc..f523ba1d 100644 --- a/docs/ISuite/50-Development/approve-the-pending-connection-requests-new-design-e296f80.md +++ b/docs/ISuite/approve-the-pending-connection-requests-e296f80.md @@ -1,8 +1,8 @@ - + -# Approve the Pending Connection Requests \[New Design\] +# Approve the Pending Connection Requests As an API business hub enterprise administrator, you must approve or reject the connection request after you receive them. @@ -16,9 +16,6 @@ You’re assigned the *AuthGroup.API.Admin* role. You’re assigned the *AuthGroup.APIPortalRegistration* role. -> ### Note: -> This document describes the new design of the API business hub enterprise. To view the documentation for the classic design, see [Approve the Pending Connection Requests \[Classic Design\]](approve-the-pending-connection-requests-classic-design-b4e6f56.md). - diff --git a/docs/ISuite/assigning-role-collections-to-users-80bb02e.md b/docs/ISuite/assigning-role-collections-to-users-80bb02e.md index 7590bd89..15a1521f 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/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 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 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: +[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: -[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: +[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: diff --git a/docs/ISuite/business-data-graph-894e28c.md b/docs/ISuite/business-data-graph-894e28c.md new file mode 100644 index 00000000..fcfab4a0 --- /dev/null +++ b/docs/ISuite/business-data-graph-894e28c.md @@ -0,0 +1,48 @@ + + +# Business Data Graph + +The business data graph is a connected graph of all your business data. + +Business data is by nature richly connected. For example, a sales order has many items, and each item references a product. Still, traditional APIs \(based on SOAP, or plain REST\) access data as individual endpoints. Developers don't only use separate API calls to access different types of data, but they must also learn and remember how to reconstruct the connection between different types of data in their code. This leads to error-prone code and fragile, non-portable applications. + +More recent modeling methodologies, such as SAP's Cloud Application Programming model \(CAP\), introduce semantic, graph-like, relationships between different data types. In the past few years, modern open-standard query protocols emerged that can take advantage of these graph-like data models. OData, based on REST principles, was one of the first such protocols, and GraphQL, developed by Facebook, is growing in popularity. + +With Graph, developers use a single API, and the most up-to-date OData V4 and GraphQL protocols, to efficiently access all business data in a landscape of data sources. + +Graph's data graph is constructed as a projection on these data sources. The nodes of the graph represent entities. Entities are composed of attributes – the data fields. Entity-connecting attributes, the edges of the graph, are referred to as associations. This graph is effectively an abstract data model, whose entities are defined as projections on entities from actual data sources \(back-end applications, systems, and microservices\) with one or more APIs. The data graph is constructed at design time in three steps: + +1. [Mirrored Entities](https://help.sap.com/viewer/15e49174b4ed461e8d8b071ba13af3de/PROD/en-US/720a1d89c0294786b8bef822a4201f5e.html "") :arrow_upper_right: + + ![](images/bdg_mirrored_enitites_38ef78c.png) + + Graph automatically creates projections from each of the entities of the discovered data sources in the landscape. We call these automatic data projections *mirrored entities*. + + Graph distinguishes known data source types \(for example, SAP S/4HANA, SAP SuccessFactors, and SAP C4C\) and unknown data sources. The mirrored entities of supported SAP data sources are added to the data graph under a reserved SAP namespace \(`sap.s4`, `sap.c4c`, and `sap.hcm`\) and then connected to each other by potentially hundreds of additional semantic associations. Entities from unsupported data sources are mirrored under custom namespaces. + +2. [Unified Entities](https://help.sap.com/viewer/15e49174b4ed461e8d8b071ba13af3de/PROD/en-US/1cded7b0394642a6b8c88b20a03f5f21.html "") :arrow_upper_right: + + ![](images/bdg_unified_entities_23be9b3.png) + + Graph then adds additional projections on top of the mirrored entities from supported SAP systems, which we call *unified entities*. Unlike the mirrored entities, these are thoughtfully designed and constructed projections, created by SAP experts under the reserved namespace `sap.graph`. Unified entities follow the SAP One Domain Model compatibility guidelines and are designed to bridge and connect semantically common business concepts from multiple data sources \(for example, `Business Partner`, and `Product`\). This allows client apps to get started with cross-system queries. + +3. [Custom Entities](https://help.sap.com/viewer/15e49174b4ed461e8d8b071ba13af3de/PROD/en-US/b6318bf4cb5f42149470361d70a63a48.html "") :arrow_upper_right: + + ![](images/bdg_custom_entities_e1829c4.png) + + Graph adds the final set of projections, *custom entities*. Custom entities are created by a skilled customer modeler to extend the data graph, through the design and addition of their own projections as a collection of attribute mappings from available SAP and non-SAP data source entities. The modeler can submit a set of custom entity definition files, developed with any text editor. + +4. To complete the process, customer administrators create a *Business Data Graph*: a runtime manifestation of the data graph based on a concrete configuration and version, accessible as a unified API by activating the data graph. The business data graph provides a connected 360° view of the data in the landscape. + + ![](images/Business_Data_Graph_3463b6a.png) + + +Graph functions as a runtime mediation layer. From the perspective of the API consumer, the nodes of a business data graph look like data entities. Client applications use the business data graph API and graph protocols, such as OData V4 or GraphQL, to issue powerful cross-entity requests like "get a list of products sold to customer C in August, ordered by value" or "what is the address of the top supplier of product P?". Graph interprets and deconstructs complex access requests into simpler query components that typically refer to a single data item \(such as `product`, and `supplier`\). It consults the business data graph configuration to determine which data sources hold the pertinent data for these simpler queries, in order to execute the access request and return the response. Here, Graph must select the appropriate native API that is exposed by the data source, implement its technical API protocol, and work around the specific limitations and capabilities of the native API. + +**Related Information** + + +[Data Locating Policy](https://help.sap.com/viewer/15e49174b4ed461e8d8b071ba13af3de/PROD/en-US/28d2c2cd55454c968661b60c0a829abe.html "Data in the business data graph is connected via key-based references.") :arrow_upper_right: + +[Modeling Guide](https://help.sap.com/viewer/15e49174b4ed461e8d8b071ba13af3de/PROD/en-US/5e0bb49f4d52434bb8377e06dda72c75.html#loio5e0bb49f4d52434bb8377e06dda72c75 "SAP employs a set of best-practice modeling guidelines, known as the SAP One Domain Model guidelines. These guidelines are for the data models of new SAP applications, and are used in this guide as recommendations for creating custom entities.") :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 16d46aaf..26b88686 100644 --- a/docs/ISuite/cancel-api-management-service-subscription-df6df2b.md +++ b/docs/ISuite/cancel-api-management-service-subscription-df6df2b.md @@ -42,7 +42,7 @@ 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.") -[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 \(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.") [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.") diff --git a/docs/ISuite/capabilities-of-sap-integration-suite-e1c5b90.md b/docs/ISuite/capabilities-of-sap-integration-suite-e1c5b90.md index 9b6958e0..14b1ab22 100644 --- a/docs/ISuite/capabilities-of-sap-integration-suite-e1c5b90.md +++ b/docs/ISuite/capabilities-of-sap-integration-suite-e1c5b90.md @@ -4,7 +4,7 @@ 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. +SAP Integration Suite brings together the features and functionality of various capabilities such as Cloud Integration, API Management, Graph, , Event Mesh, Trading Partner Management, Integration Advisor, Open Connectors, Integration Assessment, and Migration Assessment. To work with these capabilities, you must: diff --git a/docs/ISuite/50-Development/centralized-api-business-hub-enterprise-new-design-38422de.md b/docs/ISuite/centralized-api-business-hub-enterprise-38422de.md similarity index 89% rename from docs/ISuite/50-Development/centralized-api-business-hub-enterprise-new-design-38422de.md rename to docs/ISuite/centralized-api-business-hub-enterprise-38422de.md index 72f6d6d7..1daf1e31 100644 --- a/docs/ISuite/50-Development/centralized-api-business-hub-enterprise-new-design-38422de.md +++ b/docs/ISuite/centralized-api-business-hub-enterprise-38422de.md @@ -1,13 +1,11 @@ -# Centralized API business hub enterprise \[New Design\] +# Centralized API business hub enterprise 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 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: > 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. diff --git a/docs/ISuite/components-of-api-management-e02ae53.md b/docs/ISuite/components-of-api-management-e02ae53.md index e0bef766..fa4396d7 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) [Analyze API Proxies](50-Development/analyze-api-proxies-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) [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 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 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](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 API Proxies](50-Development/analyze-api-proxies-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 APIs](50-Development/analyze-apis-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/concepts-324507c.md b/docs/ISuite/concepts-324507c.md index 3d993021..b99ad7bf 100644 --- a/docs/ISuite/concepts-324507c.md +++ b/docs/ISuite/concepts-324507c.md @@ -64,7 +64,7 @@ Extraction status -A state that designates if issues occurred during a data extraction that could impact the scenario evaluation. The followings extraction statuses exist: +A state that designates if issues occurred during a data extraction that could impact the scenario evaluation. The following extraction statuses exist: - *Completed*: Your data was extracted without issues and is ready for evaluation. @@ -75,6 +75,20 @@ A state that designates if issues occurred during a data extraction that could i + + + + + +Modernization recommendation + + + + +A suggestion aimed at improving your integration practices, for example, regarding scalability, maintenance, flexibility, and responsiveness. The modernization recommendations often include transitioning from custom legacy content to predelivered packages or modern integration styles, as well as open and standardized protocols like SOAP, REST, and OData. For a list of all recommendations, see [Modernization Recommendations](https://help.sap.com/docs/help/90c8ad90cb684ee5979856093efe7462/d337a6f0d324405f9ef0c410fd0d3739.html). + +Once you've completed a scenario evaluation, you can find the modernization recommendations for your scenarios in the downloadable reports or the dashboard. Be aware that based on your data and the current ruleset of the application, you might not receive any modernization recommendations. See [Create a Scenario Evaluation Request](create-a-scenario-evaluation-request-435ec61.md). + diff --git a/docs/ISuite/configure-api-business-hub-enterprise-54b4607.md b/docs/ISuite/configure-api-business-hub-enterprise-54b4607.md new file mode 100644 index 00000000..a7183d9a --- /dev/null +++ b/docs/ISuite/configure-api-business-hub-enterprise-54b4607.md @@ -0,0 +1,243 @@ + + +# Configure API business hub enterprise + +You can configure and customize the API business hub enterprise to suit your organization's needs. + + + + + +## Key Actions for Admins in API business hub enterprise + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +As... + + + +You can use the… + + + +For more information, see… + +
+ +An *API Admin*, you already have the *AuthGroup.API.Admin* role assigned to you. + + + +*Home Page* to browse and search through the various categories, APIs, and products available. + + + +[Register on API business hub enterprise](register-on-api-business-hub-enterprise-c85fafe.md) + +
+ +*My Workspace* to perform the following actions on behalf of an application developer: + +- Create, update, and delete applications + +- Create custom attributes for applications + +- Provide app key and secret, while creating or updating an application + +- View and access all the applications created in API business hub enterprise +- Monitor costs + +- Analyze reports + + + + + + +[Creating an Application with API business hub enterprise Administrator Role](creating-an-application-with-api-business-hub-enterprise-administrator-role-df4f777.md) + +
+ +*Enterprise Manager* \> *Manage External Content* to adjust the visibility of the Graph navigator on the API business hub enterprise. + + + +[Manage External Content](https://help.sap.com/docs/integration-suite/sap-integration-suite/manage-external-content-new-design?version=CLOUD&q=Exyternal%20Content) + +
+ +*Enterprise Manager* \> *Manage Access* 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. + + + +[Manage Developer Access](manage-developer-access-9df3ece.md) + +
+ +*Enterprise Manager* \> *Manage Users* to add and revoke user access to the API business hub enterprise. + + + +[Managing the Access Request of the Users \[New Design\]](managing-the-access-request-of-the-users-new-design-8b79ee8.md) + +[Revoke Access \[New Design\]](revoke-access-new-design-ce609bb.md) + +
+ +*Enterprise Manager* \> *Manage API Management Connections* to approve and reject the pending connection requests and update the API portal access credentials. + +> ### Note: +> Additinally, the *AuthGroup.APIPortalRegistration* role must be assigned to you to perform the above actions. + + + + + +[Approve the Pending Connection Requests](approve-the-pending-connection-requests-e296f80.md) + +
+ +A *Site Admin* you already have the *AuthGroup.Site.Admin* role assigned to you. + + + +*Site Editor* to customize the visual layout of the API business hub enterprise. + + + +[Customize the Visual Format of the API business hub enterprise](customize-the-visual-format-of-the-api-business-hub-enterprise-2eacd52.md) + +
+ +*Enterprise Manager* \> *Manage Notifications* to configure notifications to keep the end users of the API business hub enterprise informed about website updates and news items. + + + +[Manage Notifications](manage-notifications-df32457.md) + +
+ +A *Content Admin* you already have the *AuthGroup.Content.Admin* role assigned to you. + + + +*Enterprise Manager* \> *Manage Domain Categories* to create domain categories and add the related products into relevant categories. + +> ### Note: +> Additinally, the *AuthGroup.API.Admin* role must be assigned to you to perform the above actions. + + + + + +[Manage Domain Categories](manage-domain-categories-bd9691d.md) + +
+ + + + + +## Key Actions for Application Developers inAPI business hub enterprise + + + + + + + + + + + + + + + + + +
+ +As... + + + +You can use… + + + +For more information, see… + +
+ +An *Application Developer* you already have the *AuthGroup.API.ApplicationDeveloper* role assigned to you. + +> ### Note: +> The *AuthGroup.API.ApplicationDeveloper* role is assigned by default to a user who onboards to the API business hub enterprise using the Self-registration process or via *Add User* flow. + + + + + +*My Workspace* to create applications, view your applications, monitor costs, and analyze reports. + + + +[Creating an Application with Application Developer Role](creating-an-application-with-application-developer-role-99515fc.md) + +
+ +*Test Environment* to test the runtime behaviour of APIs. + + + +[Test Runtime Behavior of APIs](test-runtime-behavior-of-apis-15c7d52.md) + +
+ 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 1fb2b6f8..3d9b4a59 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,7 +11,7 @@ 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.") -[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 \(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.") [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.") diff --git a/docs/ISuite/configuring-user-access-to-sap-integration-suite-2c6214a.md b/docs/ISuite/configuring-user-access-to-sap-integration-suite-2c6214a.md index 696238ec..d3e3158a 100644 --- a/docs/ISuite/configuring-user-access-to-sap-integration-suite-2c6214a.md +++ b/docs/ISuite/configuring-user-access-to-sap-integration-suite-2c6214a.md @@ -71,7 +71,7 @@ For more information on role collections, see [Roles and Role Collections](https - *PI\_Read\_Only* + *PI\_Read\_Only* @@ -83,7 +83,7 @@ For more information on role collections, see [Roles and Role Collections](https - *PI\_Business\_Expert* + *PI\_Business\_Expert* @@ -95,7 +95,7 @@ For more information on role collections, see [Roles and Role Collections](https - *PI\_Integration\_Developer* + *PI\_Integration\_Developer* @@ -107,7 +107,7 @@ For more information on role collections, see [Roles and Role Collections](https - *PI\_Administrator* + *PI\_Administrator* @@ -119,7 +119,7 @@ For more information on role collections, see [Roles and Role Collections](https - API Management + API Management @@ -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 [Tasks and Corresponding Role Collections](tasks-and-corresponding-role-collections-911ca5a.md). + For more information on relevant roles, see [User Roles in API Management \(New\)](user-roles-in-api-management-new-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). @@ -141,7 +141,7 @@ For more information on role collections, see [Roles and Role Collections](https - Role Collection for API business hub enterprise: *AuthGroup.SelfService.Admin* + Role Collection for API business hub enterprise: *AuthGroup.SelfService.Admin* @@ -156,7 +156,7 @@ For more information on role collections, see [Roles and Role Collections](https - Role Collection for Graph: *Graph.KeyUser* + Role Collection for Graph: *Graph.KeyUser* @@ -171,13 +171,68 @@ For more information on role collections, see [Roles and Role Collections](https - Role Collection for Graph: *GraphNavigator.Viewer* + Role Collection for Graph: *GraphNavigator.Viewer* Use the Graph Navigator in SAP API business hub enterprise to inspect business data graphs. See [Define Users](https://help.sap.com/docs/graph/initial-setup#2.-define-users-for-graph). + + + + + + - APIFullAccess. + + + + + + + - Provides runtime access to the registered OData services. + + + + + + + + + Event Mesh + + + + + *EventMeshDeveloper* + + + + + - Manage queues and topic subscriptions + + - Monitor event mesh and queues + + + + + + + + + + *EvenMeshAdmin* + + + + + - Do *EventMeshDeveloper* tasks. + + - Manage event mesh lifecycle + + + + diff --git a/docs/ISuite/connect-to-your-business-systems-ea9b75c.md b/docs/ISuite/connect-to-your-business-systems-ea9b75c.md new file mode 100644 index 00000000..5c62a637 --- /dev/null +++ b/docs/ISuite/connect-to-your-business-systems-ea9b75c.md @@ -0,0 +1,82 @@ + + +# Connect to Your Business Systems + +As an administrator, you need to set up the data sources you want to use in your business data graphs, setup the connectivity between Graph and your business systems, and create destinations. + +Graph supports data sources based on SAP S/4HANA \(all editions, cloud and on-premise\), SAP SuccessFactors, and SAP Sales Cloud. + +> ### Note: +> Graph supports SAP ERP Central Component \(ECC\) content which has been prepared and exposed as an OData service. To create the service interface, you can use Gateway Builder starting from SAP Gateway version GW\_FND 7.52 and the latest SP \(refer to [2217489 - Maintenance and Update Strategy for SAP Fiori Front-End Server](https://me.sap.com/notes/2217489 - Maintenance and Update Strategy for SAP Fiori Front-End Server)\) or OData Provisioning. + + + + + +## Set Up Data Sources + +To create a business data graph, you must have data sources \(business systems\). Adding data sources to your subaccount consists of two steps for each data source: + +1. Establish trust between the business systems and the SAP BTP subaccount. You can include various SAP systems into a formation and thus combine diverse SAP solutions into an extended business scenario. + + For more information, see [Including SAP Systems in a Formation](https://help.sap.com/docs/BTP/65de2977205c403bbc107264b8eccf4b/68b04fa73aa740cb96ed380a85a4761a.html). + +2. Create a destination for each service of these data sources that is exposed to client applications. + + + + + +## Custom SAP BTP Destination Annotations + +Graph supports custom annotations for SAP BTP destinations. + +In the SAP BTP cockpit, you can add *Additional Properties* to destinations. The properties provide additional configuration options. You can add predefined properties forSAP BTP or add freestyle properties using any name and value. + +The following table provides an overview of the custom annotations that Graph supports for SAP BTP destinations: + + + + + + + + + + + + + +
+ +**Name** + + + +**Value** + + + +**Description** + +
+ +`Graph.Ignore` + + + +true + + + +A destination is ignored during Graph configuration, generation, and activation. + +
+ +**Related Information** + + +[Create a Business Data Graph in Integration Suite](https://help.sap.com/viewer/15e49174b4ed461e8d8b071ba13af3de/PROD/en-US/42daf3bfd4f04e60b8967d730c502670.html "As Tenant administrator in the SAP Integration Suite, you can create a new business data graph. You can also use an existing configuration file to create a business data graph.") :arrow_upper_right: + +[Actions and Functions](https://help.sap.com/viewer/15e49174b4ed461e8d8b071ba13af3de/PROD/en-US/3572dfb79f30498d8bd4e5d356efee8c.html "Actions and functions provide a way to introduce server-side behaviors into the otherwise data-centric model. Graph mirrors actions and functions as provided by connected business systems.") :arrow_upper_right: + diff --git a/docs/ISuite/50-Development/consume-api-proxies-ea561e4.md b/docs/ISuite/consume-api-proxies-ea561e4.md similarity index 86% rename from docs/ISuite/50-Development/consume-api-proxies-ea561e4.md rename to docs/ISuite/consume-api-proxies-ea561e4.md index 87213352..21f93584 100644 --- a/docs/ISuite/50-Development/consume-api-proxies-ea561e4.md +++ b/docs/ISuite/consume-api-proxies-ea561e4.md @@ -5,7 +5,7 @@ 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. > ### 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). +> 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 API business hub enterprise](configure-api-business-hub-enterprise-54b4607.md). If you've added API business hub enterprise as a capability with Integration suite, or if you’ve subscribed to the API business hub enterprise as part of the standalone API Management subscription, you have the option to experience the new design of the API business hub enterprise user interface along with the classic design. @@ -36,7 +36,7 @@ The API business hub enterprise supports the following features: **Related Information** -[Configure the API business hub enterprise \[Classic Design\]](configure-the-api-business-hub-enterprise-classic-design-7b71b16.md "You can configure the API business hub enterprise to personalize it for your organization.") +[Configure the API business hub enterprise \[Classic Design\]](https://help.sap.com/viewer/de4066bb3f9240e3bfbcd5614e18c2f9/Cloud/en-US/7b71b166d6984e8f81a212568af5ce94.html "You can configure the API business hub enterprise to personalize it for your organization.") :arrow_upper_right: -[Configure the API business hub enterprise \[New Design\]](configure-the-api-business-hub-enterprise-new-design-54b4607.md "You can configure the API business hub enterprise to personalize it for your organization.") +[Configure API business hub enterprise](configure-api-business-hub-enterprise-54b4607.md "You can configure and customize the API business hub enterprise to suit your organization's needs.") diff --git a/docs/ISuite/50-Development/consume-api-proxies-using-sap-business-application-studio-15732eb.md b/docs/ISuite/consume-api-proxies-using-sap-business-application-studio-15732eb.md similarity index 100% rename from docs/ISuite/50-Development/consume-api-proxies-using-sap-business-application-studio-15732eb.md rename to docs/ISuite/consume-api-proxies-using-sap-business-application-studio-15732eb.md diff --git a/docs/ISuite/50-Development/consume-applications-d4f6fda.md b/docs/ISuite/consume-applications-d4f6fda.md similarity index 100% rename from docs/ISuite/50-Development/consume-applications-d4f6fda.md rename to docs/ISuite/consume-applications-d4f6fda.md diff --git a/docs/ISuite/50-Development/create-a-connection-request-for-the-centralized-api-business-hub-enterprise-new-design-c7bda8c.md b/docs/ISuite/create-a-connection-request-for-the-centralized-api-business-hub-enterprise-c7bda8c.md similarity index 94% rename from docs/ISuite/50-Development/create-a-connection-request-for-the-centralized-api-business-hub-enterprise-new-design-c7bda8c.md rename to docs/ISuite/create-a-connection-request-for-the-centralized-api-business-hub-enterprise-c7bda8c.md index aa40d197..2f73875c 100644 --- a/docs/ISuite/50-Development/create-a-connection-request-for-the-centralized-api-business-hub-enterprise-new-design-c7bda8c.md +++ b/docs/ISuite/create-a-connection-request-for-the-centralized-api-business-hub-enterprise-c7bda8c.md @@ -1,6 +1,6 @@ -# Create a Connection Request for the Centralized API business hub enterprise \[New Design\] +# Create a Connection Request for the Centralized API business hub enterprise Create a request to connect the Integration Suite API Management tenant to the API business hub enterprise. You need to establish this connection to publish the content of the Integration Suite API Management tenant on the API business hub enterprise. @@ -65,9 +65,6 @@ For the newly set up Integration Suite API Management tenant, you can request fo To create a request to connect the Integration Suite API Management tenant to the centralized API business hub enterprise. -> ### Note: -> This document describes the new design of the API business hub enterprise. To view the documentation for the classic design, see [Create a Connection Request for the Centralized API business hub enterprise \[Classic Design\]](create-a-connection-request-for-the-centralized-api-business-hub-enterprise-classic-desig-02f7877.md). - diff --git a/docs/ISuite/create-a-data-extraction-request-ce0ad0e.md b/docs/ISuite/create-a-data-extraction-request-ce0ad0e.md index ef6b32aa..f06b070b 100644 --- a/docs/ISuite/create-a-data-extraction-request-ce0ad0e.md +++ b/docs/ISuite/create-a-data-extraction-request-ce0ad0e.md @@ -40,7 +40,7 @@ You've configured a source system as described in [Add an SAP Process Orchestrat In the list of integration scenarios that were retrieved from the system, all are selected by default. Customize the list by deselecting and selecting integration scenarios to fit your needs. You can use the search function to find specific integration scenarios. - ![When creating a new data extraction, you can choose between Complete Extraction and Custom Extraction. If you choose Custom Extraction, a list of all integration scenarios available in the selected system is retrieved. Select and deselect integration scenarios in this list to customize the selection of integration scenarios you want to extract.](images/MigAss_CreateDataExtraction_Custom_SUI_1118568.png) + ![When creating a new data extraction, you can choose between Complete Extraction and Custom Extraction. If you choose Custom Extraction, a list of all integration scenarios available in the selected system is retrieved. Select and deselect integration scenarios in this list to customize the selection of integration scenarios you want to extract.](images/IntegrationSuite_PIMAS_Request_DataExtraction_CustomExtraction_87f8c8d.png) 5. Choose *Create*. diff --git a/docs/ISuite/create-a-scenario-evaluation-request-435ec61.md b/docs/ISuite/create-a-scenario-evaluation-request-435ec61.md index ee2d127a..2a6bfb13 100644 --- a/docs/ISuite/create-a-scenario-evaluation-request-435ec61.md +++ b/docs/ISuite/create-a-scenario-evaluation-request-435ec61.md @@ -37,16 +37,18 @@ You've created at least one data extraction request as described in [Create a Da 6. The following additional *Actions* can be performed for a scenario evaluation request: - - *Open Dashboard*: Access and download an analysis of your scenario evaluation runs with details specific to your integration scenarios, for example, adapters and an overview of the rules used in the evaluation. You can switch between the data of all runs performed for the scenario evaluation request so far. + - *Open Dashboard*: Access and download an analysis of your scenario evaluation runs with details specific to your integration scenarios, for example, adapters,modernization recommendations, and an overview of the rules used in the evaluation. You can switch between the data of all runs performed for the scenario evaluation request so far. + + For more information, see [Modernization Recommendations](https://help.sap.com/docs/help/90c8ad90cb684ee5979856093efe7462/d337a6f0d324405f9ef0c410fd0d3739.html). Be aware that depending on your data and the current ruleset, you might not receive any recommendations. - *Trigger Analysis*: Schedule a new evaluation run based on current data. - *Download*: Download details about the latest evaluation run in one of two formats: - - The option *as .xlsx file* lists all integration scenarios that were part of the request. It includes details such as migration effort, migration status, and the rules applied to the integration scenarios during the evaluation. - - The option *as .pdf file* features the previously mentioned details about the integration scenarios while also providing a written summary of adapters and the assessment in general, with charts and tables as visual aids. This file is suited as a summarizing report, for example, for management. + - The option *as .xlsx file* lists all integration scenarios that were part of the request. It includes details such as migration effort, migration status, modernization recommendations, and the rules applied to the integration scenarios during the evaluation. For more information, see [Modernization Recommendations](https://help.sap.com/docs/help/90c8ad90cb684ee5979856093efe7462/d337a6f0d324405f9ef0c410fd0d3739.html). + - The option *as .pdf file* features the previously mentioned details about the integration scenarios while also providing a written summary of adapters and the assessment in general, with charts and tables as visual aids. It also features a section on modernization recommendations for your scenarios. This file is suited as a summarizing report, for example, for management. - ![The actions available for a scenario evaluation are Open Dashboard, Trigger Analysis, and Download as .xlsx file and as .pdf file.](images/MigAss_ScenarioEvaluation_Action_SUI_8960e4c.png) + ![Screenshot of the Scenario Evaluation interface. It shows the options to download the details on the latest evaluation run either As .xlsx fileor As .pdf file. These options are displayed after navigating through Additional Options \> Download on the respective scenario evaluation listed item.](images/IntegrationSuite_PIMAS_Request_ScenarioEvaluation_Download_d394c4f.png) diff --git a/docs/ISuite/50-Development/create-an-application-new-design-a501a6d.md b/docs/ISuite/create-an-application-a501a6d.md similarity index 85% rename from docs/ISuite/50-Development/create-an-application-new-design-a501a6d.md rename to docs/ISuite/create-an-application-a501a6d.md index feff4690..b0688eb2 100644 --- a/docs/ISuite/50-Development/create-an-application-new-design-a501a6d.md +++ b/docs/ISuite/create-an-application-a501a6d.md @@ -1,12 +1,9 @@ -# Create an Application \[New Design\] +# Create an Application Create an Application to consume the required APIs. -> ### Note: -> This document describes the new design of the API business hub enterprise. To view the documentation for the classic design, see [Create an Application \[Classic Design\]](create-an-application-classic-design-7b4e71b.md). - An application is a discrete representation of the actual developer’s application. It provides the developer with an API key to pass-in with every request to the API. In API Management, similar APIs are bundled together to form products, which are published in the catalog. An application developer enters necessary details to register to the API business hub enterprise. After successful registration, the application developer can explore the required products and APIs to create an application. Once the application has been created successfully, the system generates an appIication key and application secret. If APIs in the application you created are protected via **Verify API Key** policy, then to access those APIs, you must pass the generated application key. Whereas, if APIs are protected via **OAuth** policy, then to access those APIs, you must pass an OAuth token that can be obtained by using the combination of generated appIication key and application secret. diff --git a/docs/ISuite/creating-a-custom-role-9d827cd.md b/docs/ISuite/creating-a-custom-role-9d827cd.md index eef7e9db..d29b1459 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.") -[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 \(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.") diff --git a/docs/ISuite/50-Development/creating-an-application-with-api-business-hub-enterprise-administrator-role-new-design-df4f777.md b/docs/ISuite/creating-an-application-with-api-business-hub-enterprise-administrator-role-df4f777.md similarity index 93% rename from docs/ISuite/50-Development/creating-an-application-with-api-business-hub-enterprise-administrator-role-new-design-df4f777.md rename to docs/ISuite/creating-an-application-with-api-business-hub-enterprise-administrator-role-df4f777.md index 565d4964..2c3ac0e8 100644 --- a/docs/ISuite/50-Development/creating-an-application-with-api-business-hub-enterprise-administrator-role-new-design-df4f777.md +++ b/docs/ISuite/creating-an-application-with-api-business-hub-enterprise-administrator-role-df4f777.md @@ -1,6 +1,6 @@ -# Creating an Application with API business hub enterprise Administrator Role \[New Design\] +# Creating an Application with API business hub enterprise Administrator Role With the API business hub enterprise administrator role you can create an application on behalf of a user \(application developer\), and view the existing application details, and its associated products, custom attributes, and analytics data. @@ -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 [Tasks and Corresponding Role Collections](../tasks-and-corresponding-role-collections-911ca5a.md). +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). @@ -65,6 +65,6 @@ An API business hub enterprise administrator can perform the following tasks: > ### Note: > You can create a maximum of 18 custom attributes per application. You cannot modify the name of a created custom attribute. However, you can modify its value whenever required. You can delete a custom attribute if it is no longer needed. - For more information on the usage of custom attributes in an application, see [Example: Accessing the Custom Attributes of an Application](example-accessing-the-custom-attributes-of-an-application-1cbd94c.md). + For more information on the usage of custom attributes in an application, see [Example: Accessing the Custom Attributes of an Application](https://help.sap.com/viewer/de4066bb3f9240e3bfbcd5614e18c2f9/Cloud/en-US/1cbd94c86c054d66b3826f6cd91e0df8.html "") :arrow_upper_right:. diff --git a/docs/ISuite/50-Development/creating-an-application-with-application-developer-role-new-design-99515fc.md b/docs/ISuite/creating-an-application-with-application-developer-role-99515fc.md similarity index 87% rename from docs/ISuite/50-Development/creating-an-application-with-application-developer-role-new-design-99515fc.md rename to docs/ISuite/creating-an-application-with-application-developer-role-99515fc.md index 75b71171..f67f6e1f 100644 --- a/docs/ISuite/50-Development/creating-an-application-with-application-developer-role-new-design-99515fc.md +++ b/docs/ISuite/creating-an-application-with-application-developer-role-99515fc.md @@ -1,6 +1,6 @@ -# Creating an Application with Application Developer Role \[New Design\] +# Creating an Application with Application Developer Role As an application developer you can create an application, and view the existing application details, and its associated products, custom attributes and analytics data. @@ -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 [Tasks and Corresponding Role Collections](../tasks-and-corresponding-role-collections-911ca5a.md). +- 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). > ### 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. @@ -24,7 +24,7 @@ As an application developer you can create an application, and view the existing ## Context -You are about to create an application and add products to your application. You can also select an existing application and view its details under the *Application Details* tab. Navigate to the *Products* tab to view the products and the rate plan associated with this application. You can add custom attributes to your applications, and manage them from the *Custom Attributes* tab. For more information, see [Add Custom Attributes to an Application](add-custom-attributes-to-an-application-39c3cbd.md). Navigate to the *Analytics* tab to analyze application usage, performance, and error count. For more information, see [Analyze Applications](analyze-applications-deb57dd.md). +You are about to create an application and add products to your application. You can also select an existing application and view its details under the *Application Details* tab. Navigate to the *Products* tab to view the products and the rate plan associated with this application. You can add custom attributes to your applications, and manage them from the *Custom Attributes* tab. For more information, see [Add Custom Attributes to an Application](50-Development/add-custom-attributes-to-an-application-39c3cbd.md). Navigate to the *Analytics* tab to analyze application usage, performance, and error count. For more information, see [Analyze Applications](analyze-applications-deb57dd.md). @@ -64,6 +64,6 @@ You are about to create an application and add products to your application. You > ### Note: > You can create a maximum of 18 custom attributes per application. You cannot modify the name of a created custom attribute. However, you can modify its value whenever required. You can delete a custom attribute if it is no longer needed. - For more information on the usage of custom attributes in an application, see [Example: Accessing the Custom Attributes of an Application](example-accessing-the-custom-attributes-of-an-application-1cbd94c.md). + For more information on the usage of custom attributes in an application, see [Example: Accessing the Custom Attributes of an Application](https://help.sap.com/viewer/de4066bb3f9240e3bfbcd5614e18c2f9/Cloud/en-US/1cbd94c86c054d66b3826f6cd91e0df8.html "") :arrow_upper_right:. diff --git a/docs/ISuite/css/SAP-icons-TNT-V3.woff b/docs/ISuite/css/SAP-icons-TNT-V3.woff index a1c9f187..cf3cb169 100644 Binary files a/docs/ISuite/css/SAP-icons-TNT-V3.woff and b/docs/ISuite/css/SAP-icons-TNT-V3.woff differ diff --git a/docs/ISuite/css/SAP-icons-V5.woff b/docs/ISuite/css/SAP-icons-V5.woff index 40ce00c5..b84e8940 100644 Binary files a/docs/ISuite/css/SAP-icons-V5.woff and b/docs/ISuite/css/SAP-icons-V5.woff differ diff --git a/docs/ISuite/custom-entities-af8dcd6.md b/docs/ISuite/custom-entities-af8dcd6.md new file mode 100644 index 00000000..42fadfbd --- /dev/null +++ b/docs/ISuite/custom-entities-af8dcd6.md @@ -0,0 +1,72 @@ + + +# Custom Entities + +Custom entities are created by a skilled customer modeler to extend the data graph, by designing and adding their own projections as a collection of attribute mappings from available SAP and non-SAP data source entities. The modeler can submit a set of custom entity definition files, developed with a text editor of their choice. + +The ability to extend the SAP data graph with custom entities is a powerful capability – customers can essentially design their own corporate data model. Here are some of the advantages: + + + + + +## Use the Same Protocols + +By mediating your data sources as a data graph, developers enjoy the use of a single data endpoint, a simplification of access and security, and the consistent use of the same query language and protocol. Investments in client-side SDKs, frameworks, and data access abstractions apply to all of the data sources. + + + + + +## Create Your Own API Shape + +From simple renaming, to more powerful transformations, custom entities allow you to control how the data is perceived by app developers. You can: + +- Replace an existing entity with one that is simpler to understand, by filtering out unnecessary or undesired attributes. + +- Rename entities and attributes to match a consistent corporate or SAP data naming convention. + +- Design your interface to precisely match the API expectations of application developers, or of existing applications. + + + + + + +## Hide Landscape Inconsistencies + +Hide incompatibilities between data-source variations or versions as an abstraction. This is useful while preparing for major system upgrades or migrations involving API incompatibilities. Custom entities can hide such API changes, providing you with more control over how to implement the migration, while not breaking dependent applications. + + + + + +## Add or Change Semantics + +- Replace a hard-to-understand normalized data representation \(often representing the way that the data is stored\) into a denormalized view that is easier to consume by client applications. + +- Connect separate entities \(with string-type foreign keys\) into a navigable graph of entities, by introducing associations and compositions into the graph. + +- Turn associations into compositions \(to many\) or a structured type \(of one\), making the semantics of the relationship more obvious to understand for consumers. + +- Combine attributes from separate source entities into one virtual, composed entity. Combine data attributes into compositions that hide underlying implementation technicalities. A common example is a side-car extension, such as a CAP-created application that extends an SAP S/4HANA data model, such as a `BusinessPartner`. Using custom entities, you can present a new natural entity with attributes from both. + + > ### Note: + > Certain restrictions apply, such as the inability to guarantee atomic data modification, when writing back to two separate data sources. + + + + + + +## Introduce More Control and Security + +In many cases, IT administrators can use Graph to avoid the need to create data copies, replications, and complex ETLs \(Extract Transform Load\) to serve the need for simpler data APIs for certain application developers and use cases. Administrators can do the following: + +- Secure their data, by only exposing data that is safe to use. + +- Using a data-filter, custom entities can be used to systematically access only a subset of.data. + +- Projections can support finer-grain authorization: a custom entity can be read-only, for example, while the underlying entities are not. + + diff --git a/docs/ISuite/custom-odata-services-1e0a6cb.md b/docs/ISuite/custom-odata-services-1e0a6cb.md new file mode 100644 index 00000000..b8de2425 --- /dev/null +++ b/docs/ISuite/custom-odata-services-1e0a6cb.md @@ -0,0 +1,28 @@ + + +# Custom OData Services + +In addition to connecting to SAP business systems, you can set up a custom datasource that supports OData protocol to enable Graph to communicate with your API service. + +As an administrator of your OData API service, you need to configure the communication between Graph and your business system. + + + + + +## Setup Connectivity + +Make sure your OData API service is publicly accessible. All the necessary setup should be considered for your custom API service, such as secure communication. + + + + + +## Create Destinations + +Create a destination to enable the communication between your business system and Graph. As the SAP BTP administrator, you need to create an HTTP destination to be able to make calls to OData APIs from Graph. The authentication type is based on your setup for that specific business system. + +You can create destinations to your API service using BasicAuthentication, or even using NoAuthentication for public services \(mainly for testing purposes and not recommended for production\). + +Destinations to services that require special HTTP headers can be defined with additional URL.headers. Use XXX properties for this purpose. For more information, see [HTTP Destinations](https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/http-destinations?version=Cloud). + diff --git a/docs/ISuite/50-Development/customize-the-visual-format-of-the-api-business-hub-enterprise-2eacd52.md b/docs/ISuite/customize-the-visual-format-of-the-api-business-hub-enterprise-2eacd52.md similarity index 100% rename from docs/ISuite/50-Development/customize-the-visual-format-of-the-api-business-hub-enterprise-2eacd52.md rename to docs/ISuite/customize-the-visual-format-of-the-api-business-hub-enterprise-2eacd52.md diff --git a/docs/ISuite/50-Development/delete-data-of-unregistered-users-d548233.md b/docs/ISuite/delete-data-of-unregistered-users-d548233.md similarity index 100% rename from docs/ISuite/50-Development/delete-data-of-unregistered-users-d548233.md rename to docs/ISuite/delete-data-of-unregistered-users-d548233.md diff --git a/docs/ISuite/edge-integration-cell-runtime-scope-144c64a.md b/docs/ISuite/edge-integration-cell-runtime-scope-144c64a.md index 43ecd575..08f13eac 100644 --- a/docs/ISuite/edge-integration-cell-runtime-scope-144c64a.md +++ b/docs/ISuite/edge-integration-cell-runtime-scope-144c64a.md @@ -181,6 +181,7 @@ Operations - Job scheduler +- Simulation For more information about restrictions with regard to monitoring, see: [Application Monitoring](application-monitoring-c9863ba.md). diff --git a/docs/ISuite/event-mesh-3129673.md b/docs/ISuite/event-mesh-3129673.md new file mode 100644 index 00000000..781c872c --- /dev/null +++ b/docs/ISuite/event-mesh-3129673.md @@ -0,0 +1,6 @@ + + +# Event Mesh + +The Event Mesh capability in SAP Integration Suite helps you manage your business events. You can publish and consume events across applications using Event Mesh. + diff --git a/docs/ISuite/event-mesh-scope-4a89370.md b/docs/ISuite/event-mesh-scope-4a89370.md new file mode 100644 index 00000000..0abc66f1 --- /dev/null +++ b/docs/ISuite/event-mesh-scope-4a89370.md @@ -0,0 +1,165 @@ + + +# Event Mesh Scope + +Understand the scope and limitations of the Event Mesh capability. + + + + + +## Region Availability + +For more information about region availability, see SAP Note [3461547](https://me.sap.com/notes/3461547). + + + + + +## Messaging Protocols + +Event Mesh supports the following protocols: + +- AMQP + + + + + + +## Allowed Limits + + + +### Message Size + +- The maximum allowed message size is 1 MB. + +- The maximum storage space \(spool size\) for all messages in all the queues is 2 GB. + + + + +### Messaging Resources + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +Messaging Resource + + + +Default + + + +Maximum + +
+ +Connections + + + +200 + + + +200 + +
+ +Producers + + + +600 + + + +600 + +The maximum number of producers allowed per connection is 3. + +
+ +Consumers + + + +600 + + + +600 + +The maximum number of consumers allowed per connection is 3. + +
+ +Queues + + + +250 + + + +250 + +
+ +Topic Subscriptions + + + +3000 + + + +3000 + +
+ + + + + +## Parity With SAP Event Mesh + +SAP Event Mesh users can refer to the SAP Note [3461547](https://me.sap.com/notes/3461547) to understand the parity of functional and non-functional qualities. + +> ### Remember: +> An one-to-one parity between the Event Mesh capability and the standalone offering SAP Event Mesh is not in scope. + diff --git a/docs/ISuite/fix-connectivity-issues-59e80e4.md b/docs/ISuite/fix-connectivity-issues-59e80e4.md index 77311971..76be4d4f 100644 --- a/docs/ISuite/fix-connectivity-issues-59e80e4.md +++ b/docs/ISuite/fix-connectivity-issues-59e80e4.md @@ -37,12 +37,10 @@ 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. - 1. Enter the command `kubectl rollout restart deployment/edc -n edge-icell`, to restart Edge Deployment Controller. + - Next, enter the command `kubectl rollout restart deployment edc -n edge-icell`, to restart Policy Engine. - 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. + - 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. diff --git a/docs/ISuite/fix-integration-flow-deployment-issues-d2d5586.md b/docs/ISuite/fix-integration-flow-deployment-issues-d2d5586.md index c8b0b3c8..d2c6dcc3 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 -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). +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). diff --git a/docs/ISuite/glossary-for-event-mesh-501ba2d.md b/docs/ISuite/glossary-for-event-mesh-501ba2d.md new file mode 100644 index 00000000..6ff929f9 --- /dev/null +++ b/docs/ISuite/glossary-for-event-mesh-501ba2d.md @@ -0,0 +1,154 @@ + + +# Glossary for Event Mesh + +Learn about the commonly used terms in Event Mesh. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +Term + + + +Explanation + +
+ +Event + + + +A change in state of data + +
+ +Message + + + +A communication of data about events + +
+ +Message Broker + + + +A messaging infrastructure that mediates the communication of event messages between producers and consumers. + +
+ +Message Client + + + +A gateway that authenticates all the events publishing and consuming applications via OAuth client credentials for all technical commnications. + +
+ +Endpoint + + + +An object created on the broker to persist messages + +
+ +Topic + + + +A means of classifying the information contained in the event message. + +
+ +Topic Subscription + + + +A set of strings used to attract the events published to a topic. + +
+ +Queue + + + +An endpoint configured with or without topic subscriptions to which you can publish messages to and consume messages from. + +
+ +Connection + + + +The sum of all active contacts made by consumers and producers with Event Mesh. + +
+ +Producer + + + +An application that publishes messages about events to Event Mesh. + +
+ +Consumer + + + +An application that consumes messages about events from Event Mesh. + +
+ diff --git a/docs/ISuite/glossary-for-sap-integration-advisor-9c221b4.md b/docs/ISuite/glossary-for-sap-integration-advisor-9c221b4.md deleted file mode 100644 index f8ec9519..00000000 --- a/docs/ISuite/glossary-for-sap-integration-advisor-9c221b4.md +++ /dev/null @@ -1,183 +0,0 @@ - - -# 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/graph-e03300f.md b/docs/ISuite/graph-e03300f.md new file mode 100644 index 00000000..19fef679 --- /dev/null +++ b/docs/ISuite/graph-e03300f.md @@ -0,0 +1,6 @@ + + +# Graph + +Extending traditional API Management, Graph 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. + diff --git a/docs/ISuite/50-Development/images/ABHE_Block_509b298.png b/docs/ISuite/images/ABHE_Block_509b298.png similarity index 100% rename from docs/ISuite/50-Development/images/ABHE_Block_509b298.png rename to docs/ISuite/images/ABHE_Block_509b298.png diff --git a/docs/ISuite/images/Additional_Connections_4f17ccb.png b/docs/ISuite/images/Additional_Connections_4f17ccb.png new file mode 100644 index 00000000..a0d6022b Binary files /dev/null and b/docs/ISuite/images/Additional_Connections_4f17ccb.png differ diff --git a/docs/ISuite/images/Business_Data_Graph_3463b6a.png b/docs/ISuite/images/Business_Data_Graph_3463b6a.png new file mode 100644 index 00000000..ee14fc77 Binary files /dev/null and b/docs/ISuite/images/Business_Data_Graph_3463b6a.png differ diff --git a/docs/ISuite/images/CBR_ASYNC_0001_c25af87.png b/docs/ISuite/images/CBR_ASYNC_0001_c25af87.png deleted file mode 100644 index a606e434..00000000 Binary files a/docs/ISuite/images/CBR_ASYNC_0001_c25af87.png and /dev/null differ diff --git a/docs/ISuite/images/CBR_ASYNC_0002_a5acb3b.png b/docs/ISuite/images/CBR_ASYNC_0002_a5acb3b.png deleted file mode 100644 index b6bf35fe..00000000 Binary files a/docs/ISuite/images/CBR_ASYNC_0002_a5acb3b.png and /dev/null differ diff --git a/docs/ISuite/images/CBR_ASYNC_0003_b742101.png b/docs/ISuite/images/CBR_ASYNC_0003_b742101.png deleted file mode 100644 index 2a2b0394..00000000 Binary files a/docs/ISuite/images/CBR_ASYNC_0003_b742101.png and /dev/null differ diff --git a/docs/ISuite/images/CM_ASYNC_0001_7525f27.png b/docs/ISuite/images/CM_ASYNC_0001_7525f27.png deleted file mode 100644 index 130d8a4a..00000000 Binary files a/docs/ISuite/images/CM_ASYNC_0001_7525f27.png and /dev/null differ diff --git a/docs/ISuite/images/CM_ASYNC_0002_3b517b4.png b/docs/ISuite/images/CM_ASYNC_0002_3b517b4.png deleted file mode 100644 index 794eea76..00000000 Binary files a/docs/ISuite/images/CM_ASYNC_0002_3b517b4.png and /dev/null differ diff --git a/docs/ISuite/images/IntegrationSuite_PIMAS_Request_DataExtraction_CustomExtraction_87f8c8d.png b/docs/ISuite/images/IntegrationSuite_PIMAS_Request_DataExtraction_CustomExtraction_87f8c8d.png new file mode 100644 index 00000000..e3bf2e79 Binary files /dev/null and b/docs/ISuite/images/IntegrationSuite_PIMAS_Request_DataExtraction_CustomExtraction_87f8c8d.png differ diff --git a/docs/ISuite/images/IntegrationSuite_PIMAS_Request_ScenarioEvaluation_Download_d394c4f.png b/docs/ISuite/images/IntegrationSuite_PIMAS_Request_ScenarioEvaluation_Download_d394c4f.png new file mode 100644 index 00000000..1a701fd3 Binary files /dev/null and b/docs/ISuite/images/IntegrationSuite_PIMAS_Request_ScenarioEvaluation_Download_d394c4f.png differ diff --git a/docs/ISuite/images/MF_ASYNC_0001_15d8925.png b/docs/ISuite/images/MF_ASYNC_0001_15d8925.png deleted file mode 100644 index b39e6a99..00000000 Binary files a/docs/ISuite/images/MF_ASYNC_0001_15d8925.png and /dev/null differ diff --git a/docs/ISuite/50-Development/images/Manage_Access_SUI_492ece2.png b/docs/ISuite/images/Manage_Access_SUI_492ece2.png similarity index 100% rename from docs/ISuite/50-Development/images/Manage_Access_SUI_492ece2.png rename to docs/ISuite/images/Manage_Access_SUI_492ece2.png diff --git a/docs/ISuite/images/MigAss_CreateDataExtraction_Custom_SUI_1118568.png b/docs/ISuite/images/MigAss_CreateDataExtraction_Custom_SUI_1118568.png deleted file mode 100644 index 7370ca97..00000000 Binary files a/docs/ISuite/images/MigAss_CreateDataExtraction_Custom_SUI_1118568.png and /dev/null differ diff --git a/docs/ISuite/images/MigAss_ScenarioEvaluation_Action_SUI_8960e4c.png b/docs/ISuite/images/MigAss_ScenarioEvaluation_Action_SUI_8960e4c.png deleted file mode 100644 index 09e90382..00000000 Binary files a/docs/ISuite/images/MigAss_ScenarioEvaluation_Action_SUI_8960e4c.png and /dev/null differ diff --git a/docs/ISuite/images/Mirrored_Entities_9bba72e.png b/docs/ISuite/images/Mirrored_Entities_9bba72e.png new file mode 100644 index 00000000..06256f8a Binary files /dev/null and b/docs/ISuite/images/Mirrored_Entities_9bba72e.png differ diff --git a/docs/ISuite/images/P2P_ASYNC_0001_466d25a.png b/docs/ISuite/images/P2P_ASYNC_0001_466d25a.png deleted file mode 100644 index 3c8cfc87..00000000 Binary files a/docs/ISuite/images/P2P_ASYNC_0001_466d25a.png and /dev/null differ diff --git a/docs/ISuite/images/P2P_ASYNC_0003_acd1a5f.png b/docs/ISuite/images/P2P_ASYNC_0003_acd1a5f.png deleted file mode 100644 index 9ec06e44..00000000 Binary files a/docs/ISuite/images/P2P_ASYNC_0003_acd1a5f.png and /dev/null differ diff --git a/docs/ISuite/images/P2P_ASYNC_0004_164a6a3.png b/docs/ISuite/images/P2P_ASYNC_0004_164a6a3.png deleted file mode 100644 index 5ef12fad..00000000 Binary files a/docs/ISuite/images/P2P_ASYNC_0004_164a6a3.png and /dev/null differ diff --git a/docs/ISuite/images/P2P_ASYNC_0005_f42d898.png b/docs/ISuite/images/P2P_ASYNC_0005_f42d898.png deleted file mode 100644 index f0312588..00000000 Binary files a/docs/ISuite/images/P2P_ASYNC_0005_f42d898.png and /dev/null differ diff --git a/docs/ISuite/images/P2P_ASYNC_0006_82b624b.png b/docs/ISuite/images/P2P_ASYNC_0006_82b624b.png deleted file mode 100644 index b6aa0789..00000000 Binary files a/docs/ISuite/images/P2P_ASYNC_0006_82b624b.png and /dev/null differ diff --git a/docs/ISuite/images/P2P_ASYNC_0007_630a053.png b/docs/ISuite/images/P2P_ASYNC_0007_630a053.png deleted file mode 100644 index c919f27b..00000000 Binary files a/docs/ISuite/images/P2P_ASYNC_0007_630a053.png and /dev/null differ diff --git a/docs/ISuite/images/P2P_ASYNC_ATTACH_0001_ad32168.png b/docs/ISuite/images/P2P_ASYNC_ATTACH_0001_ad32168.png deleted file mode 100644 index beb2e256..00000000 Binary files a/docs/ISuite/images/P2P_ASYNC_ATTACH_0001_ad32168.png and /dev/null differ diff --git a/docs/ISuite/images/P2P_ASYNC_BRIDGE_0001_55747be.png b/docs/ISuite/images/P2P_ASYNC_BRIDGE_0001_55747be.png deleted file mode 100644 index 4e467d44..00000000 Binary files a/docs/ISuite/images/P2P_ASYNC_BRIDGE_0001_55747be.png and /dev/null differ diff --git a/docs/ISuite/images/P2P_ASYNC_CSV_0001_7872efd.png b/docs/ISuite/images/P2P_ASYNC_CSV_0001_7872efd.png deleted file mode 100644 index 649cc1bd..00000000 Binary files a/docs/ISuite/images/P2P_ASYNC_CSV_0001_7872efd.png and /dev/null differ diff --git a/docs/ISuite/images/P2P_ASYNC_CSV_0002_4450364.png b/docs/ISuite/images/P2P_ASYNC_CSV_0002_4450364.png deleted file mode 100644 index 2a332c9c..00000000 Binary files a/docs/ISuite/images/P2P_ASYNC_CSV_0002_4450364.png and /dev/null differ diff --git a/docs/ISuite/images/P2P_ASYNC_CSV_0003_fd2ea7c.png b/docs/ISuite/images/P2P_ASYNC_CSV_0003_fd2ea7c.png deleted file mode 100644 index afa77e2d..00000000 Binary files a/docs/ISuite/images/P2P_ASYNC_CSV_0003_fd2ea7c.png and /dev/null differ diff --git a/docs/ISuite/images/P2P_ASYNC_JSON_0001_8af626e.png b/docs/ISuite/images/P2P_ASYNC_JSON_0001_8af626e.png deleted file mode 100644 index 0c031a00..00000000 Binary files a/docs/ISuite/images/P2P_ASYNC_JSON_0001_8af626e.png and /dev/null differ diff --git a/docs/ISuite/images/P2P_ASYNC_JSON_REC_0001_143627c.png b/docs/ISuite/images/P2P_ASYNC_JSON_REC_0001_143627c.png deleted file mode 100644 index 10881e78..00000000 Binary files a/docs/ISuite/images/P2P_ASYNC_JSON_REC_0001_143627c.png and /dev/null differ diff --git a/docs/ISuite/images/P2P_ASYNC_JSON_SND_0001_a9cd3b5.png b/docs/ISuite/images/P2P_ASYNC_JSON_SND_0001_a9cd3b5.png deleted file mode 100644 index 3317f523..00000000 Binary files a/docs/ISuite/images/P2P_ASYNC_JSON_SND_0001_a9cd3b5.png and /dev/null differ diff --git a/docs/ISuite/images/P2P_SYNC_0001_235445d.png b/docs/ISuite/images/P2P_SYNC_0001_235445d.png deleted file mode 100644 index ce978386..00000000 Binary files a/docs/ISuite/images/P2P_SYNC_0001_235445d.png and /dev/null differ diff --git a/docs/ISuite/images/P2P_SYNC_0002_9a2f00a.png b/docs/ISuite/images/P2P_SYNC_0002_9a2f00a.png deleted file mode 100644 index e2d67b8f..00000000 Binary files a/docs/ISuite/images/P2P_SYNC_0002_9a2f00a.png and /dev/null differ diff --git a/docs/ISuite/images/P2P_SYNC_JSON_REC_0001_b23d382.png b/docs/ISuite/images/P2P_SYNC_JSON_REC_0001_b23d382.png deleted file mode 100644 index 4ff0bd7b..00000000 Binary files a/docs/ISuite/images/P2P_SYNC_JSON_REC_0001_b23d382.png and /dev/null differ diff --git a/docs/ISuite/images/P2P_SYNC_JSON_SND_0001_231604c.png b/docs/ISuite/images/P2P_SYNC_JSON_SND_0001_231604c.png deleted file mode 100644 index 788a8196..00000000 Binary files a/docs/ISuite/images/P2P_SYNC_JSON_SND_0001_231604c.png and /dev/null differ diff --git a/docs/ISuite/images/RL_ASYNC_0001_0f9d278.png b/docs/ISuite/images/RL_ASYNC_0001_0f9d278.png deleted file mode 100644 index f6fde20e..00000000 Binary files a/docs/ISuite/images/RL_ASYNC_0001_0f9d278.png and /dev/null differ diff --git a/docs/ISuite/images/RL_ASYNC_0002_14bc64f.png b/docs/ISuite/images/RL_ASYNC_0002_14bc64f.png deleted file mode 100644 index b5639f3f..00000000 Binary files a/docs/ISuite/images/RL_ASYNC_0002_14bc64f.png and /dev/null differ diff --git a/docs/ISuite/images/RL_ASYNC_0003_5163d0f.png b/docs/ISuite/images/RL_ASYNC_0003_5163d0f.png deleted file mode 100644 index 8f52664b..00000000 Binary files a/docs/ISuite/images/RL_ASYNC_0003_5163d0f.png and /dev/null differ diff --git a/docs/ISuite/images/Unified_Entities_be6c8d3.png b/docs/ISuite/images/Unified_Entities_be6c8d3.png new file mode 100644 index 00000000..7f613a0c Binary files /dev/null and b/docs/ISuite/images/Unified_Entities_be6c8d3.png differ diff --git a/docs/ISuite/images/bdg_custom_entities_e1829c4.png b/docs/ISuite/images/bdg_custom_entities_e1829c4.png new file mode 100644 index 00000000..1723b3d5 Binary files /dev/null and b/docs/ISuite/images/bdg_custom_entities_e1829c4.png differ diff --git a/docs/ISuite/images/bdg_mirrored_enitites_38ef78c.png b/docs/ISuite/images/bdg_mirrored_enitites_38ef78c.png new file mode 100644 index 00000000..0b2f22fb Binary files /dev/null and b/docs/ISuite/images/bdg_mirrored_enitites_38ef78c.png differ diff --git a/docs/ISuite/images/bdg_unified_entities_23be9b3.png b/docs/ISuite/images/bdg_unified_entities_23be9b3.png new file mode 100644 index 00000000..064e9472 Binary files /dev/null and b/docs/ISuite/images/bdg_unified_entities_23be9b3.png differ diff --git a/docs/ISuite/index.md b/docs/ISuite/index.md index f01a7d5c..dc496daf 100644 --- a/docs/ISuite/index.md +++ b/docs/ISuite/index.md @@ -7,10 +7,8 @@ - [Hybrid Deployment Using Edge Integration Cell](hybrid-deployment-using-edge-integration-cell-7a6c267.md) - [Technical Landscape \(Edge Integration Cell\)](technical-landscape-edge-integration-cell-f60efc1.md) - [Edge Integration Cell Runtime Scope](edge-integration-cell-runtime-scope-144c64a.md) -- [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) - - [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) @@ -24,56 +22,108 @@ - [Activating and Managing Capabilities](activating-and-managing-capabilities-2ffb343.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) - - [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) - - [Configure APIs](configure-apis-fdf5373.md) - - [API Services](api-services-007d50f.md) - - [API Management Service Plans](api-management-service-plans-e064663.md) - - [Accessing API Management APIs Programmatically](accessing-api-management-apis-programmatically-24a2c37.md) - - [Deleting an API Management, API Portal Service Instance](deleting-an-api-management-api-portal-service-instance-59408e8.md) - - [Accessing API business hub enterprise APIs Programmatically](accessing-api-business-hub-enterprise-apis-programmatically-dabee6e.md) - - [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) - - [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) - - [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) - - [Migrating API Management from Neo to Cloud Foundry Environment](APIM-Migration/migrating-api-management-from-neo-to-cloud-foundry-environment-92f2da1.md) - - [Prerequisites](APIM-Migration/prerequisites-c1904bc.md) - - [Clone API Management Content](APIM-Migration/clone-api-management-content-7abd887.md) - - [Cloned and Uncloned Entities](APIM-Migration/cloned-and-uncloned-entities-8973ca0.md) - - [Tenant Cloning Tool Behavior](APIM-Migration/tenant-cloning-tool-behavior-6d15ffd.md) - - [Post Cloning Tasks](APIM-Migration/post-cloning-tasks-116d82c.md) - - [Recommendations](APIM-Migration/recommendations-ff61cef.md) - - [Security Features of the Tenant Cloning Tool](APIM-Migration/security-features-of-the-tenant-cloning-tool-a6969cc.md) - - [Migrating API Management Subscription Created Using the Starter Plan Service Instance](APIM-Migration/migrating-api-management-subscription-created-using-the-starter-plan-service-instance-9778a36.md) - - [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 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) - - [Recommendations](APIM-Migration/recommendations-ebe528a.md) - - [Security Features of the Tenant Cloning Tool](APIM-Migration/security-features-of-the-tenant-cloning-tool-41702e8.md) + - [Working with API Management](working-with-api-management-321fb4d.md) + - [API Lifecycle](api-lifecycle-5e8ea7d.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) + - [Configure APIs](configure-apis-fdf5373.md) + - [API Services](api-services-007d50f.md) + - [API Management Service Plans](api-management-service-plans-e064663.md) + - [Accessing API Management APIs Programmatically](accessing-api-management-apis-programmatically-24a2c37.md) + - [Deleting an API Management, API Portal Service Instance](deleting-an-api-management-api-portal-service-instance-59408e8.md) + - [Accessing API business hub enterprise APIs Programmatically](accessing-api-business-hub-enterprise-apis-programmatically-dabee6e.md) + - [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) + - [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) + - [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) + - [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) + - [Migrating API Management from Neo to Cloud Foundry Environment](APIM-Migration/migrating-api-management-from-neo-to-cloud-foundry-environment-92f2da1.md) + - [Prerequisites](APIM-Migration/prerequisites-c1904bc.md) + - [Clone API Management Content](APIM-Migration/clone-api-management-content-7abd887.md) + - [Cloned and Uncloned Entities](APIM-Migration/cloned-and-uncloned-entities-8973ca0.md) + - [Tenant Cloning Tool Behavior](APIM-Migration/tenant-cloning-tool-behavior-6d15ffd.md) + - [Post Cloning Tasks](APIM-Migration/post-cloning-tasks-116d82c.md) + - [Recommendations](APIM-Migration/recommendations-ff61cef.md) + - [Security Features of the Tenant Cloning Tool](APIM-Migration/security-features-of-the-tenant-cloning-tool-a6969cc.md) + - [Migrating API Management Subscription Created Using the Starter Plan Service Instance](APIM-Migration/migrating-api-management-subscription-created-using-the-starter-plan-service-instance-9778a36.md) + - [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 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) + - [Recommendations](APIM-Migration/recommendations-ebe528a.md) + - [Security Features of the Tenant Cloning Tool](APIM-Migration/security-features-of-the-tenant-cloning-tool-41702e8.md) + - [Graph](graph-e03300f.md) + - [What Is Graph?](what-is-graph-ad1c48d.md) + - [Business Data Graph](business-data-graph-894e28c.md) + - [Mirrored Entities](mirrored-entities-07fdc7a.md) + - [Unified Entities](unified-entities-9bcd2ec.md) + - [Custom Entities](custom-entities-af8dcd6.md) + - [Initial Setup](initial-setup-17ab4a2.md) + - [Connect to Your Business Systems](connect-to-your-business-systems-ea9b75c.md) + - [SAP S/4HANA Cloud](sap-s-4hana-cloud-c099a42.md) + - [SAP S/4HANA](sap-s-4hana-a911638.md) + - [SAP Sales Cloud](sap-sales-cloud-5c50b2b.md) + - [SAP SuccessFactors](sap-successfactors-a6b5934.md) + - [Custom OData Services](custom-odata-services-1e0a6cb.md) + - [API Business Hub Enterprise](api-business-hub-enterprise-41f7c45.md) + - [Activating API Business Hub Enterprise](activating-api-business-hub-enterprise-a0fb69b.md) + - [Centralized API business hub enterprise](centralized-api-business-hub-enterprise-38422de.md) + - [Create a Connection Request for the Centralized API business hub enterprise](create-a-connection-request-for-the-centralized-api-business-hub-enterprise-c7bda8c.md) + - [Updating the Connection Request Credentials for a Pending Request](updating-the-connection-request-credentials-for-a-pending-request-dd37a7b.md) + - [Approve the Pending Connection Requests](approve-the-pending-connection-requests-e296f80.md) + - [Updating the Connection Request Credentials for an Approved Request](updating-the-connection-request-credentials-for-an-approved-request-882e1d9.md) + - [Consume API Proxies](consume-api-proxies-ea561e4.md) + - [Onboard an Application Developer](onboard-an-application-developer-786d107.md) + - [Register on API business hub enterprise](register-on-api-business-hub-enterprise-c85fafe.md) + - [Managing the Access Request of the Users \[New Design\]](managing-the-access-request-of-the-users-new-design-8b79ee8.md) + - [Revoke Access \[New Design\]](revoke-access-new-design-ce609bb.md) + - [Delete Data of Unregistered Users](delete-data-of-unregistered-users-d548233.md) + - [Configure API business hub enterprise](configure-api-business-hub-enterprise-54b4607.md) + - [Customize the Visual Format of the API business hub enterprise](customize-the-visual-format-of-the-api-business-hub-enterprise-2eacd52.md) + - [Manage Domain Categories](manage-domain-categories-bd9691d.md) + - [Manage Notifications](manage-notifications-df32457.md) + - [Manage External Content](manage-external-content-f5bd17d.md) + - [Manage Developer Access](manage-developer-access-9df3ece.md) + - [Subscribe to a Product](subscribe-to-a-product-486d263.md) + - [View Applications, Costs, and Analyze Reports](view-applications-costs-and-analyze-reports-fca4d8c.md) + - [Create an Application](create-an-application-a501a6d.md) + - [Creating an Application with Application Developer Role](creating-an-application-with-application-developer-role-99515fc.md) + - [Creating an Application with API business hub enterprise Administrator Role](creating-an-application-with-api-business-hub-enterprise-administrator-role-df4f777.md) + - [Consume Applications](consume-applications-d4f6fda.md) + - [Analyze Applications](analyze-applications-deb57dd.md) + - [Consume API Proxies Using SAP Business Application Studio](consume-api-proxies-using-sap-business-application-studio-15732eb.md) + - [Test Runtime Behavior of APIs](test-runtime-behavior-of-apis-15c7d52.md) + - [Event Mesh](event-mesh-3129673.md) + - [Understanding Event Driven Architecture](understanding-event-driven-architecture-2604955.md) + - [What Are Events](what-are-events-9a5bf90.md) + - [What Is Messaging](what-is-messaging-0ef235f.md) + - [Message Exchange Patterns](message-exchange-patterns-9bcbf3b.md) + - [What Are Event Brokers](what-are-event-brokers-f72428f.md) + - [What Are Topics and Topic Subscriptions?](what-are-topics-and-topic-subscriptions-1712c0d.md) + - [Queues](queues-99b7501.md) + - [Event Mesh Scope](event-mesh-scope-4a89370.md) + - [Glossary for Event Mesh](glossary-for-event-mesh-501ba2d.md) + - [Initiating the Message Broker](initiating-the-message-broker-61eb5dd.md) - [Setting Up and Managing Edge Integration Cell](setting-up-and-managing-edge-integration-cell-8f7abc2.md) - [Operating Model](operating-model-db1e7cc.md) - [Initial Setup](initial-setup-64ac761.md) @@ -123,7 +173,6 @@ - [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) @@ -157,42 +206,14 @@ - [What Is Migration Tooling?](what-is-migration-tooling-1a3bfbc.md) - [Connecting an SAP Process Orchestration System](connecting-an-sap-process-orchestration-system-4120ecb.md) - [Supported Components](supported-components-46b27d1.md) - - [Migration Templates](migration-templates-40c080f.md) - - [Modularizing Supported Templates](modularizing-supported-templates-59515e5.md) - - [Supported Templates](supported-templates-ad867ae.md#loioad867aea1fc749a99abc2cf643c94038) - - [P2P\_ASYNC\_0001](supported-templates-ad867ae.md#loioe8d017d05d5c47f18e47df647da7df4d) - - [P2P\_ASYNC\_0002](supported-templates-ad867ae.md#loio8942adf6a9c84a7697ce2d1fe9a559bb) - - [P2P\_ASYNC\_0003](supported-templates-ad867ae.md#loio5c1c1d57301c42218937a59c0a17c57c) - - [P2P\_ASYNC\_0004](supported-templates-ad867ae.md#loio7b31c50701c141f2a0b6fd1ecbbe2f22) - - [P2P\_ASYNC\_0005](supported-templates-ad867ae.md#loio879d9d3493a34d8ca6e71108fc1d4a3f) - - [P2P\_ASYNC\_0006](supported-templates-ad867ae.md#loio49489bc6838e4421a8c5bf0f1eb3e682) - - [P2P\_ASYNC\_0007](supported-templates-ad867ae.md#loio3476b56fd6ff4ff4a696e93779f16582) - - [P2P\_ASYNC\_ATTACH\_0001](supported-templates-ad867ae.md#loio4a99014687f04ccf904b873b5825b342) - - [P2P\_ASYNC\_BRIDGE\_0001](supported-templates-ad867ae.md#loio59ec0b211a784a5eabdb6218cca568b0) - - [P2P\_ASYNC\_CSV\_0001](supported-templates-ad867ae.md#loio468e43826e1b42549baaf1e0771e3521) - - [P2P\_ASYNC\_CSV\_0002](supported-templates-ad867ae.md#loiod03185fa66674bec8b258de8352325ce) - - [P2P\_ASYNC\_CSV\_0003](supported-templates-ad867ae.md#loio2bb532d7b4b24bb2a34219f6e62e4ede) - - [P2P\_ASYNC\_JSON\_0001](supported-templates-ad867ae.md#loio588d1929b5484e8aafffa000f509a58c) - - [P2P\_ASYNC\_JSON\_REC\_0001](supported-templates-ad867ae.md#loio9727906919ab46a1b347dfe23482be7d) - - [P2P\_ASYNC\_JSON\_SND\_0001](supported-templates-ad867ae.md#loio314e955712014bacaf13af1e655d825f) - - [P2P\_SYNC\_0001](supported-templates-ad867ae.md#loiob6c40c07089e4eb5b64095c016b9a7f3) - - [P2P\_SYNC\_0002](supported-templates-ad867ae.md#loioc61978ac369844919e082a1ad9f485b0) - - [P2P\_SYNC\_0003](supported-templates-ad867ae.md#loio424935ae670347449f6ecee9e2087d72) - - [P2P\_SYNC\_JSON\_REC\_0001](supported-templates-ad867ae.md#loiob236bf3e723b46d0a0af0ce220515a90) - - [P2P\_SYNC\_JSON\_SND\_0001](supported-templates-ad867ae.md#loio0033dfdc1c0b40cb81d71151c2c3c34b) - - [CBR\_ASYNC\_0001](supported-templates-ad867ae.md#loio2702807ac44d4a28a45069a7c371a2b4) - - [CBR\_ASYNC\_0002](supported-templates-ad867ae.md#loiof09058b58304481886657df51c22b8ff) - - [CBR\_ASYNC\_0003](supported-templates-ad867ae.md#loio467a2272e10d431688ab36b7f50ba383) - - [CM\_ASYNC\_0001](supported-templates-ad867ae.md#loio157f24c29b3f4f148c8c2d17f7f925b0) - - [CM\_ASYNC\_0002](supported-templates-ad867ae.md#loiofc1d4c52c5cd40988b66f5494cee3aca) - - [MF\_ASYNC\_0001](supported-templates-ad867ae.md#loio7979d72f8f094ea28144c68d805f4bae) - - [RL\_ASYNC\_0001](supported-templates-ad867ae.md#loio514734ab903f47ceb4838504d0a50e82) - - [RL\_ASYNC\_0002](supported-templates-ad867ae.md#loioc8e5653e6ecc41e6a461951152862a55) - - [RL\_ASYNC\_0003](supported-templates-ad867ae.md#loio4a9041be9c344a07bba2d71a96f3844e) - - [RL\_ASYNC\_0004](supported-templates-ad867ae.md#loio57a9d28514574a30a61751409db4cd12) - - [RL\_ASYNC\_0005](supported-templates-ad867ae.md#loio7dc60062b6aa47d0b6d8282171a8d98f) + - [Migration Patterns](migration-patterns-40c080f.md) + - [Modularizing Supported Patterns](modularizing-supported-patterns-59515e5.md) + - [Supported Patterns](supported-patterns-ad867ae.md#loioad867aea1fc749a99abc2cf643c94038) + - [Point-to-Point Asynchronous](supported-patterns-ad867ae.md#loio270776550dc34dbe97cb95403810f93f) + - [Point-to-Point Synchronous](supported-patterns-ad867ae.md#loioab015e027d85473f81e4323e370ac0a1) + - [Recipient List Asynchronous](supported-patterns-ad867ae.md#loiob5d43f624696473b93b812cdc36277ad) - [Known Limitations](known-limitations-7a552d4.md) - - [Migrate Integrated Configuration Objects](migrate-integrated-configuration-objects-7e7909e.md) + - [Migrate Integrated Configuration Objects](migrate-integrated-configuration-objects-7e7909e.md) - [Integrating SAP Integration Suite with Remote Systems](40-RemoteSystems/integrating-sap-integration-suite-with-remote-systems-7004541.md) - [Introduction](40-RemoteSystems/introduction-10dc4a3.md) - [Connecting to an On-Premise Landscape \(Example Setup\)](40-RemoteSystems/connecting-to-an-on-premise-landscape-example-setup-a15af84.md) @@ -437,7 +458,6 @@ - [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) @@ -572,10 +592,6 @@ - [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) @@ -1068,7 +1084,6 @@ - [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) @@ -1103,7 +1118,6 @@ - [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) @@ -1174,210 +1188,186 @@ - [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) - [Test API Proxies](50-Development/test-api-proxies-75cccc3.md) - - [Configure](50-Development/configure-0bb111e.md) - - [Build API Proxies](50-Development/build-api-proxies-74c042b.md) - - [Key Components of an API](50-Development/key-components-of-an-api-19c0654.md) - - [API Proxy](50-Development/api-proxy-8962643.md) - - [Flow](50-Development/flow-08b40d9.md) - - [Condition Strings](50-Development/condition-strings-6656100.md) - - [Policies](50-Development/policies-7e4f3e5.md) - - [Policy Types](50-Development/policy-types-c918e28.md) - - [Access Control](50-Development/access-control-3f72aea.md) - - [Access Entity](50-Development/access-entity-e5837f4.md) - - [Assign Message](50-Development/assign-message-523efe6.md) - - [Basic Authentication](50-Development/basic-authentication-693c0d1.md) - - [Concurrent Rate Limit](50-Development/concurrent-rate-limit-8f22baa.md) - - [Replace Concurrent Rate Limit Policy with Alternative Policies](50-Development/replace-concurrent-rate-limit-policy-with-alternative-policies-b70e0d2.md) - - [Extract Variables](50-Development/extract-variables-dad6ef6.md) - - [Examples](50-Development/examples-6f56308.md) - - [Caching Policies](50-Development/caching-policies-c8bf1a5.md) - - [Populate Cache](50-Development/populate-cache-17d6ad5.md) - - [Lookup Cache](50-Development/lookup-cache-dcb1507.md) - - [Invalidate Cache](50-Development/invalidate-cache-82fab59.md) - - [Response Cache](50-Development/response-cache-8df3fac.md) - - [JavaScript](50-Development/javascript-5b63ed7.md) - - [Java Script Object Model](50-Development/java-script-object-model-e4d04da.md) - - [JSON to XML](50-Development/json-to-xml-908598d.md) - - [JSON Threat Protection](50-Development/json-threat-protection-952cbd7.md) - - [JSON Web Tokens](50-Development/json-web-tokens-bb1e955.md) - - [Generate JWT](50-Development/generate-jwt-c28be0e.md) - - [Verify JWT](50-Development/verify-jwt-277635d.md) - - [Decode JWT](50-Development/decode-jwt-2d79eba.md) - - [Key Value Map Operations](50-Development/key-value-map-operations-b72dc3f.md) - - [Message Logging Policy](50-Development/message-logging-policy-6407ae7.md) - - [Quota](50-Development/quota-1f742c1.md) - - [Types of Quota](50-Development/types-of-quota-3e32f19.md) - - [Static and Dynamic Settings](50-Development/static-and-dynamic-settings-f21c01f.md) - - [Designing Quota Policy](50-Development/designing-quota-policy-2539fb2.md) - - [Raise Fault](50-Development/raise-fault-c7f2e8d.md) - - [Reset Quota](50-Development/reset-quota-e18ccb8.md) - - [Service Callout](50-Development/service-callout-6b40873.md) - - [Spike Arrest](50-Development/spike-arrest-bf441dc.md) - - [OAuth v2.0](50-Development/oauth-v2-0-09b5abb.md) - - [Generate Access Token](50-Development/generate-access-token-f6f84ee.md) - - [Generate Authorization Code](50-Development/generate-authorization-code-46d9bb6.md) - - [Verify Access Tokens](50-Development/verify-access-tokens-744ce8a.md) - - [Designing OAuth v2.0 Policies](50-Development/designing-oauth-v2-0-policies-68f0246.md) - - [OAuth 2.0 Grant Types](50-Development/oauth-2-0-grant-types-308a18a.md) - - [OAuth v2.0 GET](50-Development/oauth-v2-0-get-2e507ea.md) - - [OAuth v2.0 SET](50-Development/oauth-v2-0-set-161c1e3.md) - - [Python Script](50-Development/python-script-8703aa8.md) - - [SAML Assertion Policy](50-Development/saml-assertion-policy-3882208.md) - - [Message Validation Policy](50-Development/message-validation-policy-e68da2f.md) - - [Verify API Key](50-Development/verify-api-key-4d15a04.md) - - [XML to JSON](50-Development/xml-to-json-72d9d22.md) - - [XSL Transform](50-Development/xsl-transform-a0615a5.md) - - [XML Threat Protection](50-Development/xml-threat-protection-3de6615.md) - - [Regular Expression Protection](50-Development/regular-expression-protection-0118f91.md) - - [Statistics Collector Policy](50-Development/statistics-collector-policy-1dee3c9.md) - - [Open Connectors](50-Development/open-connectors-3446d59.md) - - [Variable References](50-Development/variable-references-4f8993f.md) - - [Flow Variables](50-Development/flow-variables-47f27da.md) - - [Request Message Variables](50-Development/request-message-variables-ad60e66.md) - - [System Variables](50-Development/system-variables-7806ebf.md) - - [Configuration Variables](50-Development/configuration-variables-12d3ea6.md) - - [Error Variables](50-Development/error-variables-edf281e.md) - - [TLS/SSL Connection Information Variables](50-Development/tls-ssl-connection-information-variables-9326107.md) - - [API Proxy Flows Variables](50-Development/api-proxy-flows-variables-9a4fb46.md) - - [Message Variables](50-Development/message-variables-aaf8bae.md) - - [Response Message Variables](50-Development/response-message-variables-11bebe1.md) - - [Path Variables](50-Development/path-variables-4821925.md) - - [Multi-value HTTP Headers in an API Proxy](50-Development/multi-value-http-headers-in-an-api-proxy-5eb7100.md) - - [CSRF Token Handling in API Management](50-Development/csrf-token-handling-in-api-management-9881a45.md) - - [File Resource](50-Development/file-resource-79299d3.md) - - [API Proxy Structure](50-Development/api-proxy-structure-4dfd54a.md) - - [Endpoint Property Reference](50-Development/endpoint-property-reference-c196cf0.md) - - [Proxy Endpoint Properties](50-Development/proxy-endpoint-properties-1705a92.md) - - [Target Endpoint Properties](50-Development/target-endpoint-properties-edeed6a.md) - - [Different Methods of Creating an API Proxy](50-Development/different-methods-of-creating-an-api-proxy-4ac0431.md) - - [Create an API Proxy](50-Development/create-an-api-proxy-c0842d5.md) - - [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) - - [Adding Input Parameters - Headers and Queries](50-Development/adding-input-parameters-headers-and-queries-d460d43.md) - - [Adding Responses](50-Development/adding-responses-ea40cd7.md) - - [Adding Responses without a Body](50-Development/adding-responses-without-a-body-61d83d6.md) - - [Responses with a Body](50-Development/responses-with-a-body-37f9ad1.md) - - [Response Headers](50-Development/response-headers-88db307.md) - - [Error Response](50-Development/error-response-fe19d58.md) - - [Adding Security Definitions](50-Development/adding-security-definitions-092f7f2.md) - - [Additional Attributes in OpenAPI Specification](50-Development/additional-attributes-in-openapi-specification-35f357c.md) - - [Perform Additional Tasks in API Designer](50-Development/perform-additional-tasks-in-api-designer-a92cf80.md) - - [Export and Import of API Definition](50-Development/export-and-import-of-api-definition-901fbde.md) - - [Export an API Definition](50-Development/export-an-api-definition-420abb6.md) - - [Import an API Definition](50-Development/import-an-api-definition-9342a93.md) - - [Additional Configurations](50-Development/additional-configurations-de7285c.md) - - [API Providers](50-Development/api-providers-42e13b2.md) - - [Create an API Provider](50-Development/create-an-api-provider-6b263e2.md) - - [Setting Up OAuth for Cloud Integration in Cloud Foundry](50-Development/setting-up-oauth-for-cloud-integration-in-cloud-foundry-641c56b.md) - - [Principal Propagation](50-Development/principal-propagation-e2f3313.md) - - [Principal Propagation from the Neo to the Cloud Foundry Environment](50-Development/principal-propagation-from-the-neo-to-the-cloud-foundry-environment-da0e97b.md) - - [Principal Propagation from the Same Cloud Foundry Subaccount](50-Development/principal-propagation-from-the-same-cloud-foundry-subaccount-0e3d3e7.md) - - [Principal Propagation Between Two Different Subaccounts in Cloud Foundry Environment](50-Development/principal-propagation-between-two-different-subaccounts-in-cloud-foundry-environment-4159fb0.md) - - [Key Value Map](50-Development/key-value-map-3722a39.md) - - [Create a Key Value Map](50-Development/create-a-key-value-map-90d8d41.md) - - [Update a Key Value Map](50-Development/update-a-key-value-map-4961431.md) - - [Delete a Key Value Map](50-Development/delete-a-key-value-map-24fbb01.md) - - [Manage Certificates](50-Development/manage-certificates-c665875.md) - - [Working with References](50-Development/working-with-references-6f96b64.md) - - [Creating the References](50-Development/creating-the-references-ddc5fdf.md) - - [Updating the References](50-Development/updating-the-references-e2a9ec4.md) - - [Reading the References](50-Development/reading-the-references-4f3d168.md) - - [Deleting the References](50-Development/deleting-the-references-bd809db.md) - - [Create a Policy Template](50-Development/create-a-policy-template-c5d1872.md) - - [Apply a Policy Template](50-Development/apply-a-policy-template-2ceab71.md) - - [Update a Policy Template](50-Development/update-a-policy-template-269442f.md) - - [Import a Policy Template](50-Development/import-a-policy-template-52263ad.md) - - [Export a Policy Template](50-Development/export-a-policy-template-d27df04.md) - - [Delete a Policy Template](50-Development/delete-a-policy-template-f8b3c9b.md) - - [Policy Template Structure](50-Development/policy-template-structure-a0210da.md) - - [API Versioning](50-Development/api-versioning-b3cda3b.md) - - [Creating a Versioned API](50-Development/creating-a-versioned-api-57abb00.md) - - [API Revisions](50-Development/api-revisions-58097ac.md) - - [Creating API Revisions](50-Development/creating-api-revisions-0a0d7d4.md) - - [API Proxy States](50-Development/api-proxy-states-091cda4.md) - - [Deploy an API Proxy](50-Development/deploy-an-api-proxy-525f0dd.md) - - [Copy an API Proxy](50-Development/copy-an-api-proxy-23974d6.md) - - [Create a Policy](50-Development/create-a-policy-c90b895.md) - - [Create a Script](50-Development/create-a-script-8938a24.md) - - [Edit an API Proxy](50-Development/edit-an-api-proxy-a64b952.md) - - [Delete an API Proxy](50-Development/delete-an-api-proxy-5cd89a3.md) - - [Externally Managed APIs](50-Development/externally-managed-apis-848015d.md) - - [Adding Externally Managed APIs](50-Development/adding-externally-managed-apis-523ff94.md) - - [Converting Externally Managed APIs to Internally Managed APIs](50-Development/converting-externally-managed-apis-to-internally-managed-apis-1fc41ac.md) - - [Handling URL Redirects in an API Proxy Using Policies](50-Development/handling-url-redirects-in-an-api-proxy-using-policies-9e63c01.md) - - [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) - - [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) - - [Restoring Application ID across SAP Integration Suite Landscapes](50-Development/restoring-application-id-across-sap-integration-suite-landscapes-d0d1a3c.md) - - [Load Balancing Across API Providers](50-Development/load-balancing-across-api-providers-7ac0c09.md) - - [Configure Load Balancing During Import](50-Development/configure-load-balancing-during-import-2cd47e2.md) - - [Configuring Load Balancing](50-Development/configuring-load-balancing-503a3aa.md) - - [Transport APIs and Its Related Artifacts](50-Development/transport-apis-and-its-related-artifacts-eb83118.md) - - [Enabling Content Transport Using SAP Cloud Transport Management Service](50-Development/enabling-content-transport-using-sap-cloud-transport-management-service-4f55441.md) - - [Creating an Instance of Content Agent](50-Development/creating-an-instance-of-content-agent-359ecd7.md) - - [Creating Content Assembly Service Destination](50-Development/creating-content-assembly-service-destination-3a6a81e.md) - - [Creating an Instance of API portal, API Management](50-Development/creating-an-instance-of-api-portal-api-management-6129172.md) - - [Creating API Management Destination](50-Development/creating-api-management-destination-3fd86c7.md) - - [Creating an Instance of SAP Cloud Transport Management Service](50-Development/creating-an-instance-of-sap-cloud-transport-management-service-69a41e2.md) - - [Adding a Source Node in Transport Management Applications](50-Development/adding-a-source-node-in-transport-management-applications-dc24ea2.md) - - [Creating Transport Management Destination](50-Development/creating-transport-management-destination-6c94d89.md) - - [Create a Deploy Service Destination in Cloud Transport Management Service Subaccount](50-Development/create-a-deploy-service-destination-in-cloud-transport-management-service-subaccount-09b1eec.md) - - [Adding a Destination Node in Cloud Transport Management Applications](50-Development/adding-a-destination-node-in-cloud-transport-management-applications-681bb1a.md) - - [Connecting the Source and the Destination Nodes](50-Development/connecting-the-source-and-the-destination-nodes-4840f03.md) - - [Triggering Content Transport Using SAP Cloud Transport Management Service](50-Development/triggering-content-transport-using-sap-cloud-transport-management-service-cc36fab.md) - - [Transporting an API Proxy from Source to Destination](50-Development/transporting-an-api-proxy-from-source-to-destination-2fe1aa2.md) - - [Transporting an API Provider from Source to Destination](50-Development/transporting-an-api-provider-from-source-to-destination-1bcf79b.md) - - [Transporting a Certificate from Source to Destination](50-Development/transporting-a-certificate-from-source-to-destination-115d173.md) - - [Transporting a Key Value Map from Source to Destination](50-Development/transporting-a-key-value-map-from-source-to-destination-bea14c9.md) - - [Transporting a Product from Source to Destination](50-Development/transporting-a-product-from-source-to-destination-3a4cdd2.md) - - [Editing the Security Fields for the Imported API Entities](50-Development/editing-the-security-fields-for-the-imported-api-entities-0c184e3.md) + - [Configure](50-Development/configure-1c90aea.md) + - [Configure](50-Development/configure-0bb111e.md) + - [Build API Proxies](50-Development/build-api-proxies-74c042b.md) + - [Key Components of an API](50-Development/key-components-of-an-api-19c0654.md) + - [API Proxy](50-Development/api-proxy-8962643.md) + - [Flow](50-Development/flow-08b40d9.md) + - [Condition Strings](50-Development/condition-strings-6656100.md) + - [Policies](50-Development/policies-7e4f3e5.md) + - [Policy Types](50-Development/policy-types-c918e28.md) + - [Access Control](50-Development/access-control-3f72aea.md) + - [Access Entity](50-Development/access-entity-e5837f4.md) + - [Assign Message](50-Development/assign-message-523efe6.md) + - [Basic Authentication](50-Development/basic-authentication-693c0d1.md) + - [Concurrent Rate Limit](50-Development/concurrent-rate-limit-8f22baa.md) + - [Replace Concurrent Rate Limit Policy with Alternative Policies](50-Development/replace-concurrent-rate-limit-policy-with-alternative-policies-b70e0d2.md) + - [Extract Variables](50-Development/extract-variables-dad6ef6.md) + - [Examples](50-Development/examples-6f56308.md) + - [Caching Policies](50-Development/caching-policies-c8bf1a5.md) + - [Populate Cache](50-Development/populate-cache-17d6ad5.md) + - [Lookup Cache](50-Development/lookup-cache-dcb1507.md) + - [Invalidate Cache](50-Development/invalidate-cache-82fab59.md) + - [Response Cache](50-Development/response-cache-8df3fac.md) + - [JavaScript](50-Development/javascript-5b63ed7.md) + - [Java Script Object Model](50-Development/java-script-object-model-e4d04da.md) + - [JSON to XML](50-Development/json-to-xml-908598d.md) + - [JSON Threat Protection](50-Development/json-threat-protection-952cbd7.md) + - [JSON Web Tokens](50-Development/json-web-tokens-bb1e955.md) + - [Generate JWT](50-Development/generate-jwt-c28be0e.md) + - [Verify JWT](50-Development/verify-jwt-277635d.md) + - [Decode JWT](50-Development/decode-jwt-2d79eba.md) + - [Key Value Map Operations](50-Development/key-value-map-operations-b72dc3f.md) + - [Message Logging Policy](50-Development/message-logging-policy-6407ae7.md) + - [Quota](50-Development/quota-1f742c1.md) + - [Types of Quota](50-Development/types-of-quota-3e32f19.md) + - [Static and Dynamic Settings](50-Development/static-and-dynamic-settings-f21c01f.md) + - [Designing Quota Policy](50-Development/designing-quota-policy-2539fb2.md) + - [Raise Fault](50-Development/raise-fault-c7f2e8d.md) + - [Reset Quota](50-Development/reset-quota-e18ccb8.md) + - [Service Callout](50-Development/service-callout-6b40873.md) + - [Spike Arrest](50-Development/spike-arrest-bf441dc.md) + - [OAuth v2.0](50-Development/oauth-v2-0-09b5abb.md) + - [Generate Access Token](50-Development/generate-access-token-f6f84ee.md) + - [Generate Authorization Code](50-Development/generate-authorization-code-46d9bb6.md) + - [Verify Access Tokens](50-Development/verify-access-tokens-744ce8a.md) + - [Designing OAuth v2.0 Policies](50-Development/designing-oauth-v2-0-policies-68f0246.md) + - [OAuth 2.0 Grant Types](50-Development/oauth-2-0-grant-types-308a18a.md) + - [OAuth v2.0 GET](50-Development/oauth-v2-0-get-2e507ea.md) + - [OAuth v2.0 SET](50-Development/oauth-v2-0-set-161c1e3.md) + - [Python Script](50-Development/python-script-8703aa8.md) + - [SAML Assertion Policy](50-Development/saml-assertion-policy-3882208.md) + - [Message Validation Policy](50-Development/message-validation-policy-e68da2f.md) + - [Verify API Key](50-Development/verify-api-key-4d15a04.md) + - [XML to JSON](50-Development/xml-to-json-72d9d22.md) + - [XSL Transform](50-Development/xsl-transform-a0615a5.md) + - [XML Threat Protection](50-Development/xml-threat-protection-3de6615.md) + - [Regular Expression Protection](50-Development/regular-expression-protection-0118f91.md) + - [Statistics Collector Policy](50-Development/statistics-collector-policy-1dee3c9.md) + - [Open Connectors](50-Development/open-connectors-3446d59.md) + - [Variable References](50-Development/variable-references-4f8993f.md) + - [Flow Variables](50-Development/flow-variables-47f27da.md) + - [Request Message Variables](50-Development/request-message-variables-ad60e66.md) + - [System Variables](50-Development/system-variables-7806ebf.md) + - [Configuration Variables](50-Development/configuration-variables-12d3ea6.md) + - [Error Variables](50-Development/error-variables-edf281e.md) + - [TLS/SSL Connection Information Variables](50-Development/tls-ssl-connection-information-variables-9326107.md) + - [API Proxy Flows Variables](50-Development/api-proxy-flows-variables-9a4fb46.md) + - [Message Variables](50-Development/message-variables-aaf8bae.md) + - [Response Message Variables](50-Development/response-message-variables-11bebe1.md) + - [Path Variables](50-Development/path-variables-4821925.md) + - [Multi-value HTTP Headers in an API Proxy](50-Development/multi-value-http-headers-in-an-api-proxy-5eb7100.md) + - [CSRF Token Handling in API Management](50-Development/csrf-token-handling-in-api-management-9881a45.md) + - [File Resource](50-Development/file-resource-79299d3.md) + - [API Proxy Structure](50-Development/api-proxy-structure-4dfd54a.md) + - [Endpoint Property Reference](50-Development/endpoint-property-reference-c196cf0.md) + - [Proxy Endpoint Properties](50-Development/proxy-endpoint-properties-1705a92.md) + - [Target Endpoint Properties](50-Development/target-endpoint-properties-edeed6a.md) + - [Different Methods of Creating an API Proxy](50-Development/different-methods-of-creating-an-api-proxy-4ac0431.md) + - [Create an API Proxy](50-Development/create-an-api-proxy-c0842d5.md) + - [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) + - [Adding Input Parameters - Headers and Queries](50-Development/adding-input-parameters-headers-and-queries-d460d43.md) + - [Adding Responses](50-Development/adding-responses-ea40cd7.md) + - [Adding Responses without a Body](50-Development/adding-responses-without-a-body-61d83d6.md) + - [Responses with a Body](50-Development/responses-with-a-body-37f9ad1.md) + - [Response Headers](50-Development/response-headers-88db307.md) + - [Error Response](50-Development/error-response-fe19d58.md) + - [Adding Security Definitions](50-Development/adding-security-definitions-092f7f2.md) + - [Additional Attributes in OpenAPI Specification](50-Development/additional-attributes-in-openapi-specification-35f357c.md) + - [Perform Additional Tasks in API Designer](50-Development/perform-additional-tasks-in-api-designer-a92cf80.md) + - [Export and Import of API Definition](50-Development/export-and-import-of-api-definition-901fbde.md) + - [Export an API Definition](50-Development/export-an-api-definition-420abb6.md) + - [Import an API Definition](50-Development/import-an-api-definition-9342a93.md) + - [Additional Configurations](50-Development/additional-configurations-de7285c.md) + - [API Providers](50-Development/api-providers-42e13b2.md) + - [Create an API Provider](50-Development/create-an-api-provider-6b263e2.md) + - [Setting Up OAuth for Cloud Integration in Cloud Foundry](50-Development/setting-up-oauth-for-cloud-integration-in-cloud-foundry-641c56b.md) + - [Principal Propagation](50-Development/principal-propagation-e2f3313.md) + - [Principal Propagation from the Neo to the Cloud Foundry Environment](50-Development/principal-propagation-from-the-neo-to-the-cloud-foundry-environment-da0e97b.md) + - [Principal Propagation from the Same Cloud Foundry Subaccount](50-Development/principal-propagation-from-the-same-cloud-foundry-subaccount-0e3d3e7.md) + - [Principal Propagation Between Two Different Subaccounts in Cloud Foundry Environment](50-Development/principal-propagation-between-two-different-subaccounts-in-cloud-foundry-environment-4159fb0.md) + - [Key Value Map](50-Development/key-value-map-3722a39.md) + - [Create a Key Value Map](50-Development/create-a-key-value-map-90d8d41.md) + - [Update a Key Value Map](50-Development/update-a-key-value-map-4961431.md) + - [Delete a Key Value Map](50-Development/delete-a-key-value-map-24fbb01.md) + - [Manage Certificates](50-Development/manage-certificates-c665875.md) + - [Working with References](50-Development/working-with-references-6f96b64.md) + - [Creating the References](50-Development/creating-the-references-ddc5fdf.md) + - [Updating the References](50-Development/updating-the-references-e2a9ec4.md) + - [Reading the References](50-Development/reading-the-references-4f3d168.md) + - [Deleting the References](50-Development/deleting-the-references-bd809db.md) + - [Create a Policy Template](50-Development/create-a-policy-template-c5d1872.md) + - [Apply a Policy Template](50-Development/apply-a-policy-template-2ceab71.md) + - [Update a Policy Template](50-Development/update-a-policy-template-269442f.md) + - [Import a Policy Template](50-Development/import-a-policy-template-52263ad.md) + - [Export a Policy Template](50-Development/export-a-policy-template-d27df04.md) + - [Delete a Policy Template](50-Development/delete-a-policy-template-f8b3c9b.md) + - [Policy Template Structure](50-Development/policy-template-structure-a0210da.md) + - [API Versioning](50-Development/api-versioning-b3cda3b.md) + - [Creating a Versioned API](50-Development/creating-a-versioned-api-57abb00.md) + - [API Revisions](50-Development/api-revisions-58097ac.md) + - [Creating API Revisions](50-Development/creating-api-revisions-0a0d7d4.md) + - [API Proxy States](50-Development/api-proxy-states-091cda4.md) + - [Deploy an API Proxy](50-Development/deploy-an-api-proxy-525f0dd.md) + - [Copy an API Proxy](50-Development/copy-an-api-proxy-23974d6.md) + - [Create a Policy](50-Development/create-a-policy-c90b895.md) + - [Create a Script](50-Development/create-a-script-8938a24.md) + - [Edit an API Proxy](50-Development/edit-an-api-proxy-a64b952.md) + - [Delete an API Proxy](50-Development/delete-an-api-proxy-5cd89a3.md) + - [Externally Managed APIs](50-Development/externally-managed-apis-848015d.md) + - [Adding Externally Managed APIs](50-Development/adding-externally-managed-apis-523ff94.md) + - [Converting Externally Managed APIs to Internally Managed APIs](50-Development/converting-externally-managed-apis-to-internally-managed-apis-1fc41ac.md) + - [Handling URL Redirects in an API Proxy Using Policies](50-Development/handling-url-redirects-in-an-api-proxy-using-policies-9e63c01.md) + - [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) + - [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) + - [Restoring Application ID across SAP Integration Suite Landscapes](50-Development/restoring-application-id-across-sap-integration-suite-landscapes-d0d1a3c.md) + - [Load Balancing Across API Providers](50-Development/load-balancing-across-api-providers-7ac0c09.md) + - [Configure Load Balancing During Import](50-Development/configure-load-balancing-during-import-2cd47e2.md) + - [Configuring Load Balancing](50-Development/configuring-load-balancing-503a3aa.md) + - [Transport APIs and Its Related Artifacts](50-Development/transport-apis-and-its-related-artifacts-eb83118.md) + - [Enabling Content Transport Using SAP Cloud Transport Management Service](50-Development/enabling-content-transport-using-sap-cloud-transport-management-service-4f55441.md) + - [Creating an Instance of Content Agent](50-Development/creating-an-instance-of-content-agent-359ecd7.md) + - [Creating Content Assembly Service Destination](50-Development/creating-content-assembly-service-destination-3a6a81e.md) + - [Creating an Instance of API portal, API Management](50-Development/creating-an-instance-of-api-portal-api-management-6129172.md) + - [Creating API Management Destination](50-Development/creating-api-management-destination-3fd86c7.md) + - [Creating an Instance of SAP Cloud Transport Management Service](50-Development/creating-an-instance-of-sap-cloud-transport-management-service-69a41e2.md) + - [Adding a Source Node in Transport Management Applications](50-Development/adding-a-source-node-in-transport-management-applications-dc24ea2.md) + - [Creating Transport Management Destination](50-Development/creating-transport-management-destination-6c94d89.md) + - [Create a Deploy Service Destination in Cloud Transport Management Service Subaccount](50-Development/create-a-deploy-service-destination-in-cloud-transport-management-service-subaccount-09b1eec.md) + - [Adding a Destination Node in Cloud Transport Management Applications](50-Development/adding-a-destination-node-in-cloud-transport-management-applications-681bb1a.md) + - [Connecting the Source and the Destination Nodes](50-Development/connecting-the-source-and-the-destination-nodes-4840f03.md) + - [Triggering Content Transport Using SAP Cloud Transport Management Service](50-Development/triggering-content-transport-using-sap-cloud-transport-management-service-cc36fab.md) + - [Transporting an API Proxy from Source to Destination](50-Development/transporting-an-api-proxy-from-source-to-destination-2fe1aa2.md) + - [Transporting an API Provider from Source to Destination](50-Development/transporting-an-api-provider-from-source-to-destination-1bcf79b.md) + - [Transporting a Certificate from Source to Destination](50-Development/transporting-a-certificate-from-source-to-destination-115d173.md) + - [Transporting a Key Value Map from Source to Destination](50-Development/transporting-a-key-value-map-from-source-to-destination-bea14c9.md) + - [Transporting a Product from Source to Destination](50-Development/transporting-a-product-from-source-to-destination-3a4cdd2.md) + - [Editing the Security Fields for the Imported API Entities](50-Development/editing-the-security-fields-for-the-imported-api-entities-0c184e3.md) + - [Configure Event Mesh](50-Development/configure-event-mesh-77e213c.md) + - [Configure A Message Client](50-Development/configure-a-message-client-867c517.md) + - [Create A Queue](50-Development/create-a-queue-95357fa.md) + - [Create A Topic Subscription](50-Development/create-a-topic-subscription-6fe6358.md) + - [Publish and Consume Events](50-Development/publish-and-consume-events-8e296d9.md) - [Engage](50-Development/engage-1036845.md) - [Publish API Proxies](50-Development/publish-api-proxies-75a4a11.md) - [Create a Product](50-Development/create-a-product-d769622.md) - [Assign Permission to a Product via UI](50-Development/assign-permission-to-a-product-via-ui-09fb892.md) - [View Applications](50-Development/view-applications-feac368.md) - - [Consume API Proxies](50-Development/consume-api-proxies-ea561e4.md) - - [Onboard an Application Developer](50-Development/onboard-an-application-developer-786d107.md) - - [Register on API business hub enterprise](50-Development/register-on-api-business-hub-enterprise-c85fafe.md) - - [Managing the Access Request of the Users \[Classic Design\]](50-Development/managing-the-access-request-of-the-users-classic-design-5b3e2f6.md) - - [Managing the Access Request of the Users \[New Design\]](50-Development/managing-the-access-request-of-the-users-new-design-8b79ee8.md) - - [Revoke Access \[Classic Design\]](50-Development/revoke-access-classic-design-147fb9d.md) - - [Revoke Access \[New Design\]](50-Development/revoke-access-new-design-ce609bb.md) - - [Delete Data of Unregistered Users](50-Development/delete-data-of-unregistered-users-d548233.md) - - [Configure the API business hub enterprise \[Classic Design\]](50-Development/configure-the-api-business-hub-enterprise-classic-design-7b71b16.md) - - [Manage Updates \[Classic Design\]](50-Development/manage-updates-classic-design-94e37b4.md) - - [Manage Navigation Categories \[Classic Design\]](50-Development/manage-navigation-categories-classic-design-7f1a44b.md) - - [Configure the API business hub enterprise \[New Design\]](50-Development/configure-the-api-business-hub-enterprise-new-design-54b4607.md) - - [Customize the Visual Format of the API business hub enterprise](50-Development/customize-the-visual-format-of-the-api-business-hub-enterprise-2eacd52.md) - - [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 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) - - [Example: Accessing the Custom Attributes of an Application](50-Development/example-accessing-the-custom-attributes-of-an-application-1cbd94c.md) - - [View Applications, Costs, and Analyze Reports \[New Design\]](50-Development/view-applications-costs-and-analyze-reports-new-design-fca4d8c.md) - - [Create an Application \[New Design\]](50-Development/create-an-application-new-design-a501a6d.md) - - [Creating an Application with Application Developer Role \[New Design\]](50-Development/creating-an-application-with-application-developer-role-new-design-99515fc.md) - - [Creating an Application with API business hub enterprise Administrator Role \[New Design\]](50-Development/creating-an-application-with-api-business-hub-enterprise-administrator-role-new-design-df4f777.md) - - [Consume Applications](50-Development/consume-applications-d4f6fda.md) - - [Analyze Applications](50-Development/analyze-applications-deb57dd.md) - - [Consume API Proxies Using SAP Business Application Studio](50-Development/consume-api-proxies-using-sap-business-application-studio-15732eb.md) - - [Test Runtime Behavior of APIs \[New Design\]](50-Development/test-runtime-behavior-of-apis-new-design-15c7d52.md) - [Monitor](50-Development/monitor-650995c.md) - [Monitor Integrations](50-Development/monitor-integrations-05446d0.md) - [Monitor Message Processing](50-Development/monitor-message-processing-314df3f.md) @@ -1478,7 +1468,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 API Proxies](50-Development/analyze-api-proxies-7712c61.md) + - [Analyze APIs](50-Development/analyze-apis-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) @@ -1488,10 +1478,16 @@ - [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) + - [Configuring APIs for Anomaly Detection](50-Development/configuring-apis-for-anomaly-detection-9e7e5d1.md) + - [Working with Detected Anomalies](50-Development/working-with-detected-anomalies-1c677b2.md) + - [Subscribing to Email Notification Alerts](50-Development/subscribing-to-email-notification-alerts-88e96f4.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) - [Payload Indicator in Integration Flow Message Processing](50-Development/payload-indicator-in-integration-flow-message-processing-7f322c0.md) + - [Monitor Event Mesh](50-Development/monitor-event-mesh-d975934.md) - [Inspect](50-Development/inspect-a4d5e49.md) - [Inspect Data Store Usage](50-Development/inspect-data-store-usage-fcc08f6.md) - [Inspect Top Local Data Stores by Usage](50-Development/inspect-top-local-data-stores-by-usage-55670e6.md) @@ -1536,60 +1532,58 @@ - [Validating Adapters](50-Development/IntegrationSettings/validating-adapters-82a5010.md) - [Upload Custom Adapters](50-Development/IntegrationSettings/upload-custom-adapters-fc4f957.md) - [Post Migration Tasks](50-Development/IntegrationSettings/post-migration-tasks-809210a.md) + - [Generative AI](50-Development/IntegrationSettings/generative-ai-0c93c17.md) - [Design Guidelines](50-Development/IntegrationSettings/design-guidelines-4d1c84f.md) - [Setting Up API Management Capability](50-Development/setting-up-api-management-capability-f34e86c.md) - - [Centralized API business hub enterprise \[Classic Design\]](50-Development/centralized-api-business-hub-enterprise-classic-design-33b706f.md) - - [Create a Connection Request for the Centralized API business hub enterprise \[Classic Design\]](50-Development/create-a-connection-request-for-the-centralized-api-business-hub-enterprise-classic-desig-02f7877.md) - - [Updating the Connection Request Credentials for a Submitted Request \[Classic Design\]](50-Development/updating-the-connection-request-credentials-for-a-submitted-request-classic-design-eb84854.md) - - [Approve the Pending Connection Requests \[Classic Design\]](50-Development/approve-the-pending-connection-requests-classic-design-b4e6f56.md) - - [Updating the Connection Request Credentials for an Approved Request \[Classic Design\]](50-Development/updating-the-connection-request-credentials-for-an-approved-request-classic-design-b583b7a.md) - - [Centralized API business hub enterprise \[New Design\]](50-Development/centralized-api-business-hub-enterprise-new-design-38422de.md) - - [Create a Connection Request for the Centralized API business hub enterprise \[New Design\]](50-Development/create-a-connection-request-for-the-centralized-api-business-hub-enterprise-new-design-c7bda8c.md) - - [Updating the Connection Request Credentials for a Pending Request \[New Design\]](50-Development/updating-the-connection-request-credentials-for-a-pending-request-new-design-dd37a7b.md) - - [Approve the Pending Connection Requests \[New Design\]](50-Development/approve-the-pending-connection-requests-new-design-e296f80.md) - - [Updating the Connection Request Credentials for an Approved Request \[New Design\]](50-Development/updating-the-connection-request-credentials-for-an-approved-request-new-design-882e1d9.md) - - [Documentation Export and Settings](50-Development/documentation-export-and-settings-4c442af.md) + - [Settings for MIGs and MAGs](50-Development/settings-for-migs-and-mags-4c442af.md) - [Runtime](50-Development/runtime-b833f5a.md) - [Security](60-Security/security-a58b240.md) - [Technical Landscape](60-Security/technical-landscape-daea676.md) - [Security Aspects of Processes](60-Security/security-aspects-of-processes-51e36ff.md) - [Security Aspects of Data, Data Flow](60-Security/security-aspects-of-data-data-flow-55c45ab.md) - - [Security Aspects of Data, Data Flow for API Management](60-Security/security-aspects-of-data-data-flow-for-api-management-27a7f63.md) - [Security Aspects of Data, Data Flow for Cloud Integration](60-Security/security-aspects-of-data-data-flow-for-cloud-integration-7895724.md) + - [Security Aspects of Data, Data Flow for API Management](60-Security/security-aspects-of-data-data-flow-for-api-management-27a7f63.md) + - [Security Aspects of Data, Data Flow for Event Mesh](60-Security/security-aspects-of-data-data-flow-for-event-mesh-8713813.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 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 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) - [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 API Management](60-Security/identity-and-access-management-for-api-management-016556f.md) + - [Identity and Access Management for Event Mesh](60-Security/identity-and-access-management-for-event-mesh-7a91c65.md) + - [Personas in Event Mesh](60-Security/personas-in-event-mesh-ee79946.md) + - [Tasks and Permissions in Event Mesh](60-Security/tasks-and-permissions-in-event-mesh-b497c6d.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) - [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) + - [Identity and Access Management for Integration Assessment](60-Security/identity-and-access-management-for-integration-assessment-9a09cdd.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 for Migration Assessment](60-Security/tasks-and-permissions-for-migration-assessment-2714db1.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) - - [Data Protection and Privacy for API Management](60-Security/data-protection-and-privacy-for-api-management-d50613e.md) - - [Service to View User Details on API business hub enterprise](60-Security/service-to-view-user-details-on-api-business-hub-enterprise-a49c05f.md) - [Data Protection and Privacy for Cloud Integration](60-Security/data-protection-and-privacy-for-cloud-integration-0e13ece.md) - [Types of Stored Data](60-Security/types-of-stored-data-183637c.md) - [Specific Data Assets](60-Security/specific-data-assets-0e4e511.md) + - [Data Protection and Privacy for API Management](60-Security/data-protection-and-privacy-for-api-management-d50613e.md) + - [Service to View User Details on API business hub enterprise](60-Security/service-to-view-user-details-on-api-business-hub-enterprise-a49c05f.md) + - [Data Protection and Privacy for Event Mesh](60-Security/data-protection-and-privacy-for-event-mesh-274de7b.md) - [Data Protection and Privacy for Integration Advisor](60-Security/data-protection-and-privacy-for-integration-advisor-b1b3627.md) - [Specific Data Assets](60-Security/specific-data-assets-a6491d2.md) - [Security-Relevant Logging and Tracing](60-Security/security-relevant-logging-and-tracing-509c20e.md) + - [Data Collection for Knowledge Base](60-Security/data-collection-for-knowledge-base-e5bd17f.md) - [Data Protection and Privacy for Trading Partner Management](60-Security/data-protection-and-privacy-for-trading-partner-management-ca3bb43.md) - [Types of Stored Data](60-Security/types-of-stored-data-c36c7c6.md) - [Specific Data Assets](60-Security/specific-data-assets-16077ce.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) - [Auditing and Logging Information](60-Security/auditing-and-logging-information-86a75cd.md) - - [Auditing and Logging Information for Integration Assessment](60-Security/auditing-and-logging-information-for-integration-assessment-e7a795f.md) - - [Auditing and Logging Information for API Management](60-Security/auditing-and-logging-information-for-api-management-77024b3.md) - [Auditing and Logging Information for Cloud Integration](60-Security/auditing-and-logging-information-for-cloud-integration-d1c7bfe.md) + - [Auditing and Logging Information for API Management](60-Security/auditing-and-logging-information-for-api-management-77024b3.md) + - [Auditing and Logging Information for Event Mesh](60-Security/auditing-and-logging-information-for-event-mesh-981d7eb.md) - [Auditing and Logging Information for Integration Advisor](60-Security/auditing-and-logging-information-for-integration-advisor-3dbe557.md) - [Auditing and Logging Information for Trading Partner Management](60-Security/auditing-and-logging-information-for-trading-partner-management-0503127.md) + - [Auditing and Logging Information for Integration Assessment](60-Security/auditing-and-logging-information-for-integration-assessment-e7a795f.md) - [Security for Edge Integration Cell](60-Security/security-for-edge-integration-cell-b9871b2.md) - [User Authentication and Authorization](60-Security/user-authentication-and-authorization-bff88cd.md) - [Network and Communication Security for Edge Integration Cell](60-Security/network-and-communication-security-for-edge-integration-cell-7051f88.md) @@ -1608,5 +1602,4 @@ - [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-17ab4a2.md b/docs/ISuite/initial-setup-17ab4a2.md new file mode 100644 index 00000000..928e81ca --- /dev/null +++ b/docs/ISuite/initial-setup-17ab4a2.md @@ -0,0 +1,142 @@ + + +# Initial Setup + +As a Subaccount or Tenant Administrator, you need to add Graph as a capability of API Management within SAP Integration Suite. + + + + + +## Prerequisites + +1. Your SAP BTP Global Account administrator has already created a subaccount. For more information, see [Create a Subaccount.](https://help.sap.com/docs/BTP/65de2977205c403bbc107264b8eccf4b/05280a123d3044ae97457a25b3013918.html) + +2. An SAP Integration Suite entitlement has been created for your subaccount. For more information, see [Configure Entitlements](https://help.sap.com/docs/BTP/65de2977205c403bbc107264b8eccf4b/37f8871865114f44aebee3db6ac64b72.html). + +3. You have subscribed to the SAP Integration Suite and assigned the *Integration\_Provisioner* role collection to yourself. You must assign this role to add capabilities, such as API Management and Graph, on the Integration Suite home page. + + For more information, see [Set Up API Management from Integration Suite](https://developers.sap.com/tutorials/api-mgmt-isuite-initial-setup.html#0bc64de0-ed01-4d11-a675-6dd6942f909e)\(Steps 1–3\). + +4. You have activated Graph on the Integration Suite home page and assigned yourself to the following Graph role collection: + + - *Graph.KeyUser* + + When you assign yourself to this role collection, you are automatically assigned to the following roles: + + - *Graph\_Key\_User* + + - *Graph\_Navigator\_Viewer* + + + + + + + + +## 1. Configure Entitlement for Graph + +Your global account administrator is responsible for configuring the Graph entitlement as follows: + +1. Go to *Entitlements* in the SAP BTP cockpit. + +2. Choose *Configure Entitlements* \> *Add Service Plans*. + +3. Search for and choose *SAP Graph* and do the following: + + 1. Choose one or more of the following plans: + + - *api* for business data graph consumption + + - *configuration* to configure business data graphs using the Graph Configuration API. + + + 2. Choose *Add Service Plan*. + + 3. Choose *Save*. + + + + + + + +## 2. Configure Graph + +1. Go to the *Integration Suite* home page, and under *Capabilities*, choose *Add Capabilities*. +2. On the *Activate Capabilities* dialog, under *Select Capabilities*, choose *Design, Develop, and Manage APIs* and choose *Next*. +3. To activate *Graph*, select the following, and choose *Next*: + + 1. *Enable SAP API Business Hub Enterprise* + + 2. *Graph* + + > ### Note: + > If you have already set up API Management, choose *Edit*, and select *Graph*. You must select *SAP API Business Hub Enterprise* to activate *Graph*. + +4. Choose *Activate* and once the status on the *Summary* changes from *In Progress* to *Active*, choose *OK*. + + + + + +## 3. Define Users for Graph + +Graph doesn't manage user identities and it can't directly authenticate clients. Instead, it relies on XSUAA, the SAP Authorization and Trust Management Service. + +There are two ways to define users: + +- Add users, one-by-one, for the purpose of bootstraps, demos, and proofs of concepts \(PoCs\) to the SAP BTP subaccount \(for example, via the SAP BTP cockpit\). + +- Use your own user base and Identity Provider \(IdP\). For this, you must establish a trust relationship with a SAML 2.0 IdP in your subaccount. + + For more information, see [Trust and Federation with Identity Providers](https://help.sap.com/products/BTP/65de2977205c403bbc107264b8eccf4b/cb1bc8f1bd5c482e891063960d7acd78.html). + + +Once you enable Graph, you see both Graph role collections in your list. + + + +### Enable Graph Users + +- Graph Key User + + The creation and activation of business data graphs is managed by a user with a special role, the *Graph\_Key\_User* authorization role. You must assign this role to one or more users so that they can create and activate business data graphs for a landscape. + + To assign the *Graph.KeyUser* role collection to a user, do the following: + + 1. In the SAP BTP cockpit, go to *Security* \> *Users*. + + 2. Select the relevant user. Under *Role Collections*, choose *Assign Role Collection*. + + 3. Search for *Graph.KeyUser*, select the role collection, and choose *Assign Role Collection*. + + 4. To apply the role, go back to the Integration Suite home page. + + +- Graph Navigator Viewer + + Graph Navigator is a tool in SAP API business hub enterprise that developers use to inspect business data graphs. For more information, see [Graph Navigator in SAP API Business Hub Enterprise](https://help.sap.com/viewer/15e49174b4ed461e8d8b071ba13af3de/PROD/en-US/8e75d3178a684912a4b28d3b9593539c.html "The Graph Navigator is a tool that you use to inspect business data graphs.") :arrow_upper_right:. + + To assign the *GraphNavigator.Viewer* role collection to a user with the *Graph\_Navigator\_Viewer* role, do the following: + + 1. In the SAP BTP cockpit, go to *Security* \> *Users*. + + 2. Select the relevant user. Under *Role Collections*, choose *Assign Role Collection*. + + 3. Search for *GraphNavigator.Viewer*, select the role collection, and choose *Assign Role Collection*. + + 4. To apply the role, go back to the Integration Suite home page. + + + +> ### Note: +> Reselect your subaccount to access *Users* after assigning the role collection. + +For more information, see: + +- [Define a Role Collection](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/4b20383efab341f181becf0a947a5498.html) +- [Add Roles to a Role Collection](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/e3130fb95aa64970b07d4dc65b24df1a.html) +- [Assign Users to Role Collections](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/c5766765bda74ad59fe656977c8fa4d6.html) + diff --git a/docs/ISuite/initial-setup-64ac761.md b/docs/ISuite/initial-setup-64ac761.md index 8b224f87..bd3bb300 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/initiating-the-message-broker-61eb5dd.md b/docs/ISuite/initiating-the-message-broker-61eb5dd.md new file mode 100644 index 00000000..14d1f706 --- /dev/null +++ b/docs/ISuite/initiating-the-message-broker-61eb5dd.md @@ -0,0 +1,48 @@ + + +# Initiating the Message Broker + +Initiate the message broker before you get started with the Event Mesh capability. + + + + + +## Prerequisites + +- You must have activated the Event Mesh capability. See: [Activating and Managing Capabilities](activating-and-managing-capabilities-2ffb343.md). + +- You must have the *EventMeshAdmin* role collection assigned to you. + + + + +## Context + +This task is a one-time activity. Before getting started with the actions associated with the Event Mesh capability, you must initiate the Event Mesh's broker. While doing so, you get to know the specifications of the broker, such as the spool size, maximum message size, and more. + + + +## Procedure + +1. Choose *Configure* \> *Event Mesh*. + + The *Initiate Event Mesh* screen opens. You see the specifications of the broker. + +2. Choose *Activate*. + + The broker activation is in progress. Wait for a few seconds for this process to complete. + +3. Choose *OK* to complete the activation process. + + You remain in the *Configure* \> *Event Mesh* screen. You see the *Overview* tab where the broker specifications are displayed in a card with an *Active* status. + + + + + + +## Next Steps + +[Configure Event Mesh](50-Development/configure-event-mesh-77e213c.md) + diff --git a/docs/ISuite/known-limitations-7a552d4.md b/docs/ISuite/known-limitations-7a552d4.md index 76e12cca..fbd8adcd 100644 --- a/docs/ISuite/known-limitations-7a552d4.md +++ b/docs/ISuite/known-limitations-7a552d4.md @@ -28,11 +28,7 @@ Message Mapping -User-defined Functions \(UDFs\) with function libraries, imported archives, or parameters aren't supported when migrating a message mapping. - -Importing, viewing, and editing a local Java UDF is supported. - -For more information, see: [Importing Mapping Content from ES Repository](50-Development/IntegrationSettings/importing-mapping-content-from-es-repository-e18fc05.md). +Parameterized message mappings from ES Repository can be imported but the parameters defined in the message mapping object in SAP Process Integration is not available in SAP Integration Suite after the import. For more information, see [Designing and Configuring Parameterized Mapping Programs](https://help.sap.com/docs/SAP_NETWEAVER_750/bbd7c67c5eb14835843976b790024ec6/c47b8d9349e143a2b62e9b747eae4bce.html?version=latest). @@ -60,22 +56,13 @@ XML to CSV Converter -For the templates that use CSV to XML or XML to CSV converter, the following limitations apply: +For the patterns that support CSV to XML or XML to CSV converter, the following limitations apply: - XSD schema files from the source ICO aren't migrated. As an integration developer, you must manually download the schema files from the Enterprise Services Repository of SAP Process Orchestration and upload the same as resources in the integration flow. Then, configure the converter flow step before you deploy the integration flow. - Field Fixed-Length separator isn't supported. You can't directly migrate field fixed length file-based Integrated Configuration Objects \(ICOs\). -See: - -- [P2P\_ASYNC\_CSV\_0001](supported-templates-ad867ae.md#loio468e43826e1b42549baaf1e0771e3521) - -- [P2P\_ASYNC\_CSV\_0002](supported-templates-ad867ae.md#loiod03185fa66674bec8b258de8352325ce) - -- [P2P\_ASYNC\_CSV\_0003](supported-templates-ad867ae.md#loio2bb532d7b4b24bb2a34219f6e62e4ede) - - diff --git a/docs/ISuite/50-Development/manage-developer-access-9df3ece.md b/docs/ISuite/manage-developer-access-9df3ece.md similarity index 98% rename from docs/ISuite/50-Development/manage-developer-access-9df3ece.md rename to docs/ISuite/manage-developer-access-9df3ece.md index a39d22e1..97d5eedb 100644 --- a/docs/ISuite/50-Development/manage-developer-access-9df3ece.md +++ b/docs/ISuite/manage-developer-access-9df3ece.md @@ -14,7 +14,7 @@ You need the following role to configure the access control checks: - *AuthGroup.API.Admin* - To assign this role, see [Assigning Role Collections to Users](../assigning-role-collections-to-users-80bb02e.md) . + To assign this role, see [Assigning Role Collections to Users](assigning-role-collections-to-users-80bb02e.md) . > ### Note: diff --git a/docs/ISuite/50-Development/manage-domain-categories-new-design-bd9691d.md b/docs/ISuite/manage-domain-categories-bd9691d.md similarity index 85% rename from docs/ISuite/50-Development/manage-domain-categories-new-design-bd9691d.md rename to docs/ISuite/manage-domain-categories-bd9691d.md index 39f3974b..5ff68d53 100644 --- a/docs/ISuite/50-Development/manage-domain-categories-new-design-bd9691d.md +++ b/docs/ISuite/manage-domain-categories-bd9691d.md @@ -1,8 +1,8 @@ - + -# Manage Domain Categories \[New Design\] +# Manage Domain Categories Domain categories are displayed on the API business hub enterprise home page. @@ -20,7 +20,7 @@ You need the following roles to create and update categories: - *AuthGroup.API.Admin* - To assign the role, see [Tasks and Corresponding Role Collections](../tasks-and-corresponding-role-collections-911ca5a.md) . + To assign the role, see [User Roles in API Management \(New\)](user-roles-in-api-management-new-911ca5a.md) . @@ -34,8 +34,6 @@ Content administrators can use *Manage Content* to create domain categories and > ### Note: > If you've configured the API business hub enterprise to connect to multiple API portals then you can add products from different API portals under one category. Whereas in classic design, you can only add products from one API portal under a category. -This document describes the new design of the API business hub enterprise. To view the documentation for the classic design, see [Manage Navigation Categories \[Classic Design\]](manage-navigation-categories-classic-design-7f1a44b.md). - Use the following procedure to configure navigation categories. diff --git a/docs/ISuite/50-Development/manage-external-content-new-design-f5bd17d.md b/docs/ISuite/manage-external-content-f5bd17d.md similarity index 89% rename from docs/ISuite/50-Development/manage-external-content-new-design-f5bd17d.md rename to docs/ISuite/manage-external-content-f5bd17d.md index f961203d..0b4092c0 100644 --- a/docs/ISuite/50-Development/manage-external-content-new-design-f5bd17d.md +++ b/docs/ISuite/manage-external-content-f5bd17d.md @@ -1,6 +1,6 @@ -# Manage External Content \(New Design\) +# Manage External Content On this page, you have the option to adjust the visibility of the Graph navigator on the API business hub enterprise. @@ -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 [Tasks and Corresponding Role Collections](../tasks-and-corresponding-role-collections-911ca5a.md) . + To assign the role, see [User Roles in API Management \(New\)](user-roles-in-api-management-new-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/apim/API-Management/manage-notifications-new-design-df32457.md b/docs/ISuite/manage-notifications-df32457.md similarity index 95% rename from docs/apim/API-Management/manage-notifications-new-design-df32457.md rename to docs/ISuite/manage-notifications-df32457.md index e1c70c29..3769bfbd 100644 --- a/docs/apim/API-Management/manage-notifications-new-design-df32457.md +++ b/docs/ISuite/manage-notifications-df32457.md @@ -1,8 +1,8 @@ - + -# Manage Notifications \[New Design\] +# Manage Notifications As a site administrator you can configure notifications for providing information to the API business hub enterprise end users on any website updates, events or news items. diff --git a/docs/ISuite/50-Development/managing-the-access-request-of-the-users-new-design-8b79ee8.md b/docs/ISuite/managing-the-access-request-of-the-users-new-design-8b79ee8.md similarity index 94% rename from docs/ISuite/50-Development/managing-the-access-request-of-the-users-new-design-8b79ee8.md rename to docs/ISuite/managing-the-access-request-of-the-users-new-design-8b79ee8.md index c3adfb9f..944790eb 100644 --- a/docs/ISuite/50-Development/managing-the-access-request-of-the-users-new-design-8b79ee8.md +++ b/docs/ISuite/managing-the-access-request-of-the-users-new-design-8b79ee8.md @@ -13,7 +13,7 @@ As an API administrator, you can approve or reject the access request made by an You’re assigned the *AuthGroup.API.Admin* role. > ### Note: -> This document describes the new design of the API business hub enterprise. To view the documentation for the classic design, see [Managing the Access Request of the Users \[Classic Design\]](managing-the-access-request-of-the-users-classic-design-5b3e2f6.md). +> This document describes the new design of the API business hub enterprise. To view the documentation for the classic design, see [Managing the Access Request of the Users \[Classic Design\]](https://help.sap.com/viewer/de4066bb3f9240e3bfbcd5614e18c2f9/Cloud/en-US/5b3e2f607046447c867db43e9b7859c7.html "Procedure to provide or reject access to an Application developer for using the API business hub enterprise.") :arrow_upper_right:. @@ -36,9 +36,6 @@ 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/message-exchange-patterns-9bcbf3b.md b/docs/ISuite/message-exchange-patterns-9bcbf3b.md new file mode 100644 index 00000000..44af4eb7 --- /dev/null +++ b/docs/ISuite/message-exchange-patterns-9bcbf3b.md @@ -0,0 +1,41 @@ + + +# Message Exchange Patterns + +Know the different message exchange patterns. + +Most messaging applications use the following messaging exchange patterns: + +- Publish–subscribe + +- Point-to-point + +- Request reply + + +Most events use the publish-subscribe pattern. + + + + + +## Publish–Subscribe + +In a publish-subscribe exchange pattern, messages sent by the producer \(publisher\) can be processed multiple times by different consumers \(subscribers\). Each consumer receives its own copy of the message for processing. + + + + + +## Point-to-Point + +In a point-to-point exchange pattern, messages sent by the producer are processed by a single consumer. + + + + + +## Request Reply + +In a request reply exchange pattern, applications achieve two-way communication using separate point-to-point channels: one for requests, and another for replies. + diff --git a/docs/ISuite/migrate-integrated-configuration-objects-7e7909e.md b/docs/ISuite/migrate-integrated-configuration-objects-7e7909e.md index a0196568..4da94587 100644 --- a/docs/ISuite/migrate-integrated-configuration-objects-7e7909e.md +++ b/docs/ISuite/migrate-integrated-configuration-objects-7e7909e.md @@ -14,6 +14,8 @@ Migrate supported integration artifacts from your SAP Process Orchestration syst - You've connected your SAP Process Orchestration System with SAP Integration Suite using SAP BTP destinations. See: [Connecting an SAP Process Orchestration System](connecting-an-sap-process-orchestration-system-4120ecb.md). +- You've understood the [Supported Patterns](supported-patterns-ad867ae.md#loioad867aea1fc749a99abc2cf643c94038) in Migration Tooling. + - You've created an integration package in Integration Suite for the purpose of migration. See: [Creating an Integration Package](50-Development/creating-an-integration-package-9126d79.md). @@ -39,20 +41,33 @@ Migrate supported integration artifacts from your SAP Process Orchestration syst 5. Choose *Next Step*. -6. In the *Template* tab, a template that is associated to your ICO is automatically preselected. If there are multiple templates associated, select the template of your choice. +6. In the *Pattern* tab, a pattern that is associated to your ICO is automatically preselected. If there are multiple patterns associated, select the pattern of your choice. > ### Note: - > If there are no associated templates available and yet the ICO is ready for migration, the migration tooling falls back to the default template. The default template creates a point-to-point integration design; this template doesn't contain the integration scenario or the communication channels from the source ICO. + > If there are no associated patterns available and yet the ICO is ready for migration, the migration tooling falls back to the default pattern. The default pattern creates a point-to-point integration design; this pattern doesn't contain the integration scenario or the communication channels from the source ICO. > - > If a default template was applied, the sender and receiver channels are empty. But the resources from your ICO, like mappings and scripts, are migrated so that you can easily reuse them and create an integration design. + > If the default pattern was applied, the sender and receiver channels are empty. But the resources from your ICO, like mappings and scripts, are migrated so that you can easily reuse them and create an integration design. > - > The default template is also available for all ICOs that are ready for migration with one or more supported templates. + > The default pattern is also available for all ICOs that are ready for migration with one or more supported patterns. + + Based on the pattern that you select, you see a short description that explains what the pattern is. + + +If the preselected pattern is *Point-to-Point Asynchronous*, there are additional options available to better design your integration flow. + +7. Optional: Enable the following options based on your requirements: + + 1. Enable *Decouple with JMS Queue* if you want to decouple the sender and receiver adapter using a JMS queue. For more information, see [Decoupling via JMS Queue](50-Development/decoupling-via-jms-queue-ecbde19.md). + + 2. Enable *Idempotent Process at Receiver Side* if you want the receiver adapter to identify and ignore any duplicate processing of messages. For more information, see [Define Idempotent Process Call](50-Development/define-idempotent-process-call-84c85d7.md). + + +8. Choose *Next Step*. - Based on the template that you select, you see a short description that explains what the template contains. -7. Choose *Next Step*. +Handle the dependent message mapping objects and its resources in an efficient way. -8. In the *Message Mapping from ESR* tab, select the import method for the message mapping objects that are associated to the ICO. +9. In the *Message Mapping from ESR* tab, select the import method for the message mapping objects that are associated to the ICO. > ### Note: > By default, the option *Enable Reusable Message Mapping Artifacts* is enabled to so that you import the message mappings objects from ESR as message mapping artifacts to Integration Suite. This approach helps you to benefit from the advantages of reusable artifacts. See: [Creating Message Mapping as an Artifact](50-Development/creating-message-mapping-as-an-artifact-1d52a7b.md). @@ -76,9 +91,9 @@ Migrate supported integration artifacts from your SAP Process Orchestration syst > 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*. +10. Choose *Next Step*. -10. In the *Message Mapping Resources* tab, identify and appropriately import the dependent resources of the message mapping objects like function library, WSDL, and a few more. +11. In the *Message Mapping Resources* tab, identify and appropriately import the dependent resources of the message mapping objects like function library, WSDL, and a few more. This step is applicable only if you're creating at least one message mapping object in the previous step. If you're reusing all associated message mapping objects in the previous step, skip the substeps that follow and move to the [next step](migrate-integrated-configuration-objects-7e7909e.md#loio7e7909e6ebd44365867a6c611d94083a__iflow). @@ -90,21 +105,21 @@ Migrate supported integration artifacts from your SAP Process Orchestration syst 2. For the dependent function library objects associated to the message mapping object, select a Function Libraries artifact in Integration Suite. -11. Choose *Next Step*. +12. Choose *Next Step*. -12. In the *Integration Flow* tab, provide a *Name* and *ID* for the integration flow that is about to be created in Integration Suite. +13. In the *Integration Flow* tab, provide a *Name* and *ID* for the integration flow that is about to be created in Integration Suite. -13. Choose *Review*. +14. Choose *Review*. -14. In the *Review* tab, check all your entries. If needed, use the *Edit* option for the associated tab to make changes. +15. In the *Review* tab, check all your entries. If needed, use the *Edit* option for the associated tab to make changes. -15. Choose *Migrate*. +16. Choose *Migrate*. An integration flow equivalent to the ICO is created. The sender and receiver channels, other flow steps like mappings, and attributes from the ICO are migrated too. For the sender and receiver adapter, all their attributes from the ICO are externalized in the newly created integration flow. This design helps you configure the parameters for Integration Suite without having to edit the integration flow. -16. Look out for useful information in the *Migration Success* page. +17. Look out for useful information in the *Migration Success* page. In the *Channel Mappings* section, you see the mappings for the sender and receiver channels in this tab. For the sender and receiver adapter types used in the source ICO, you see the equivalent adapter types that the migration tooling creates in the integration flow. diff --git a/docs/ISuite/migration-templates-40c080f.md b/docs/ISuite/migration-patterns-40c080f.md similarity index 70% rename from docs/ISuite/migration-templates-40c080f.md rename to docs/ISuite/migration-patterns-40c080f.md index 4befa4c4..11f2d670 100644 --- a/docs/ISuite/migration-templates-40c080f.md +++ b/docs/ISuite/migration-patterns-40c080f.md @@ -1,6 +1,6 @@ -# Migration Templates +# Migration Patterns -The migration tooling maps the sender and receiver channels from the source Integrated Configuration Object \(ICO\) to the equivalent supported ones in the SAP Integration Suite. The equivalent sender and receiver channels are populated in the new integration flow. Same is the case with the flow steps and events. With the possible combinations of supported communication channels, events, and flow steps, there are templates available in the migration tooling. If your ICO can be mapped to one of these templates, then migration is achievable. +The migration tooling maps the sender and receiver channels from the source Integrated Configuration Object \(ICO\) to the equivalent supported ones in the SAP Integration Suite. The equivalent sender and receiver channels are populated in the new integration flow. Same is the case with the flow steps and events. With the possible combinations of supported communication channels, events, and flow steps, there are patterns available in the migration tooling. If your ICO can be mapped to one of these patterns, then migration is achievable. diff --git a/docs/ISuite/mirrored-entities-07fdc7a.md b/docs/ISuite/mirrored-entities-07fdc7a.md new file mode 100644 index 00000000..4ac9adfa --- /dev/null +++ b/docs/ISuite/mirrored-entities-07fdc7a.md @@ -0,0 +1,86 @@ + + +# Mirrored Entities + +Developers familiar with existing SAP product data models can continue to consume the resources of these models with Graph. Rather than accessing them separately via different system APIs, they’re accessed from the business data graph, using the Graph API. The mirrored entities of supported SAP data sources are added to the data graph under a reserved SAP namespace. Entities from unsupported data sources are mirrored under custom namespaces. + +The following SAP system-specific namespaces are supported: + + + + + + + + + + + + + + + + + + + +
+ +Namespace + + + +Description + +
+ +`sap.s4` + + + +Mirrored entities from the data model of SAP S/4HANA. + +
+ +`sap.c4c` + + + +Mirrored entities from the data model of SAP Sales Cloud, which is part of SAP CX's suite of products. + +
+ +`sap.hcm` + + + +Mirrored entities from the data model of SAP Human Capital Management \(HCM, also known as SAP SuccessFactors\). + +
+ +When referencing a mirrored entity, the namespace is simply prepended. For example: `sap.s4/A_SalesOrder` references sales order information from an SAP S/4HANA data source, and `sap.hcm/PerPerson` references person information from an SAP SuccessFactors data source. + +![](images/Mirrored_Entities_9bba72e.png) + +Developers can easily combine all these resources in one application, focusing on the data, without having to know where the specific data sources are located or how to connect to them. + + + + + +## Additional Connections + +In addition to consolidating the different system models, Graph introduces hundreds of additional connections between related entities in the business data graph, in the form of associations that are recognized by OData or GraphQL. A common example is the relation from an order item to an ordered product: + +![](images/Additional_Connections_4f17ccb.png) + +The additional connections are usually named by prefixing an underscore to the name of an attribute of type `String`, which represents the reference value. In the illustrated example, the original attribute `Material` is a string that represents a foreign key, and `_Material` is a relation. + +Such relationships improve the semantic intent of the business data graph and lead to simpler, more intuitive, and more efficient navigational queries. For example, a developer could follow the illustrated relationships to access `sap.s4/A_SalesOrder(15)/to_Item(10)/_Material/Brand` in a single OData query, answering the question: *show the brand of the product ordered in item 10 of the sales order with key 15*. + +Similarly, the business data graph represents hierarchical entities as compositions, which clearly expose the structural boundaries of the model, simplifying the interaction and reducing developer errors. An example of a composition is a book with chapters – you need to access the book to read the chapters. In the diagram, the relationship between `A_SalesOrder` and `A_SalesOrderItem` is modeled as a composition via `to_Item`, ensuring that developers always access a sales order item by going through the root of the composition \(the root entity\). + +To complete the consolidation of the system models, Graph introduces hundreds of additional connections between related root entities in the business data graph, in the form of associations that are recognized by OData or GraphQL. A common example is the relationship from an order item to an ordered product. + +Using a more traditional API, this small example would have required at least three different round-trip API calls, plus the necessary expertise to develop the business logic to extract the keys to match the requirements of the different entity instances. + 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 ebc76310..a8425628 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,6 +10,9 @@ 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: @@ -28,7 +31,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 *Modify*. +6. Choose *Update*. @@ -37,6 +40,5 @@ To modify the Edge Integration Cell deployment solution properties, proceed as f ## Results -- 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). +The solution is updated based on modified helm charts. diff --git a/docs/ISuite/modularizing-supported-templates-59515e5.md b/docs/ISuite/modularizing-supported-patterns-59515e5.md similarity index 75% rename from docs/ISuite/modularizing-supported-templates-59515e5.md rename to docs/ISuite/modularizing-supported-patterns-59515e5.md index 87d07228..e3cb088a 100644 --- a/docs/ISuite/modularizing-supported-templates-59515e5.md +++ b/docs/ISuite/modularizing-supported-patterns-59515e5.md @@ -1,14 +1,12 @@ -# Modularizing Supported Templates +# Modularizing Supported Patterns -Templates are modularized to ease the creation of additional flow steps. +Patterns are modularized to ease the creation of additional flow steps. -For certain templates, if depicted in the template's description, the following few additional features are available: - -- A template is modularized to ease the creation of additional flow steps to the integration flow: +- A pattern is modularized to ease the creation of additional flow steps to the integration flow: - A Local Integration Process pool is available to contain the mapping files from the source ICO. With such a design, readability of the mapping steps is better and becomes convenient to add more mapping steps or maintain the sequence of message mappings and XSLT mappings. diff --git a/docs/ISuite/50-Development/onboard-an-application-developer-786d107.md b/docs/ISuite/onboard-an-application-developer-786d107.md similarity index 64% rename from docs/ISuite/50-Development/onboard-an-application-developer-786d107.md rename to docs/ISuite/onboard-an-application-developer-786d107.md index 8fafd3e7..cdce142a 100644 --- a/docs/ISuite/50-Development/onboard-an-application-developer-786d107.md +++ b/docs/ISuite/onboard-an-application-developer-786d107.md @@ -18,8 +18,8 @@ To provide application developers with access to the API business hub enterprise 1. The application developers log on to the API business hub enterprise application with their IDP user credentials, and register to the API business hub enterprise. For more information, see [Register on API business hub enterprise](register-on-api-business-hub-enterprise-c85fafe.md). -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). +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\]](https://help.sap.com/viewer/de4066bb3f9240e3bfbcd5614e18c2f9/Cloud/en-US/5b3e2f607046447c867db43e9b7859c7.html "Procedure to provide or reject access to an Application developer for using the API business hub enterprise.") :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: + 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: 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 9c564df2..80960fec 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](patch-releases-for-api-management-6ddd927.md) +[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: diff --git a/docs/ISuite/patch-releases-for-api-management-6ddd927.md b/docs/ISuite/patch-releases-for-api-management-6ddd927.md deleted file mode 100644 index ef21b68d..00000000 --- a/docs/ISuite/patch-releases-for-api-management-6ddd927.md +++ /dev/null @@ -1,192 +0,0 @@ - - -# 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 bbbf94c6..e3bde9ce 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,150 +8,7 @@ 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. - - - - - -## 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. - -
+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:. diff --git a/docs/ISuite/queues-99b7501.md b/docs/ISuite/queues-99b7501.md new file mode 100644 index 00000000..971d7f3e --- /dev/null +++ b/docs/ISuite/queues-99b7501.md @@ -0,0 +1,26 @@ + + +# Queues + +Events are stored in queues on the broker. + +A queue is an endpoint configured with topic subscriptions that can publish messages to and consume messages from. Queues can subscribe to more than one topic and receive messages for all topics matching their subscriptions. + +There are two types of queues: + +- **EXCLUSIVE** – only one consumer exclusively can access the queue at any point in time. + +- **NON-EXCLUSIVE** – multiple consumers can access the queue at any point in time. + + +Queues work like queues in all message queuing systems: + +1. Producers send guaranteed messages to Event Mesh. + +2. The messages are saved in the queue and delivered to consuming clients if they are online, or held in the queue until the consumer connects. + +3. The consumer acknowledges the message once it has completed processing it. + +4. Event Mesh removes the message from the queue. + + 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 dfb9d43b..7f3b1571 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 @@ -839,7 +839,7 @@ 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.") -[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 \(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.") [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.") diff --git a/docs/ISuite/50-Development/register-on-api-business-hub-enterprise-c85fafe.md b/docs/ISuite/register-on-api-business-hub-enterprise-c85fafe.md similarity index 100% rename from docs/ISuite/50-Development/register-on-api-business-hub-enterprise-c85fafe.md rename to docs/ISuite/register-on-api-business-hub-enterprise-c85fafe.md diff --git a/docs/ISuite/50-Development/revoke-access-new-design-ce609bb.md b/docs/ISuite/revoke-access-new-design-ce609bb.md similarity index 83% rename from docs/ISuite/50-Development/revoke-access-new-design-ce609bb.md rename to docs/ISuite/revoke-access-new-design-ce609bb.md index 7b4878bf..d40731f4 100644 --- a/docs/ISuite/50-Development/revoke-access-new-design-ce609bb.md +++ b/docs/ISuite/revoke-access-new-design-ce609bb.md @@ -1,6 +1,6 @@ - + # Revoke Access \[New Design\] @@ -23,7 +23,7 @@ You are an API administrator and the role *AuthGroup.API.Admin* is assigned to y As an API administrator, you use this procedure to revoke an application developer's access for using the API business hub enterprise. > ### Note: -> This document describes the new design of the API business hub enterprise. To view the documentation for the classic design, see [Revoke Access \[Classic Design\]](revoke-access-classic-design-147fb9d.md). +> This document describes the new design of the API business hub enterprise. To view the documentation for the classic design, see [Revoke Access \[Classic Design\]](https://help.sap.com/viewer/de4066bb3f9240e3bfbcd5614e18c2f9/Cloud/en-US/147fb9dca1414f6a956dd05b4c86d74d.html "Revoke the access of an application developer.") :arrow_upper_right:. diff --git a/docs/ISuite/sap-s-4hana-a911638.md b/docs/ISuite/sap-s-4hana-a911638.md new file mode 100644 index 00000000..064c5fd6 --- /dev/null +++ b/docs/ISuite/sap-s-4hana-a911638.md @@ -0,0 +1,357 @@ + + +# SAP S/4HANA + +As an administrator for SAP S/4HANA, you need to configure the communication between Graph and SAP S/4HANA by installing a cloud connector and creating destinations. + + + + + +## Setup Connectivity + +As the Cloud Connector administrator, you must install a cloud connector on your business system. + + + +### Prerequisites + +Your SAP BTP Administrator has provided the following: + +- Region + +- Subaccount + +- Assigned a Cloud Connector administrator to a role or role collections . For more information, see [Initial Configuration](https://help.sap.com/viewer/cca91383641e40ffbe03bdc78f00f681/Cloud/en-US/db9170a7d97610148537d5a84bf79ba2.html). + + + + +### Procedure + +1. Install and configure the cloud connector. For more information, see [Cloud Connector](https://help.sap.com/viewer/cca91383641e40ffbe03bdc78f00f681/Cloud/en-US/e6c7616abb5710148cfcf3e75d96d596.html). + +2. Add the SAP BTP subaccount to the cloud connector. For more information, see [Manage Subaccounts](https://help.sap.com/viewer/cca91383641e40ffbe03bdc78f00f681/Cloud/en-US/f16df12fab9f4fe1b8a4122f0fd54b6e.html). + + + + +### Establish Trust + +1. Configure the single-sign on \(SSO\) Identity Authentication Service +2. Upload your key-pair keystore in SAP BTP cockpit. Otherwise, use the default key-pair keystore. + +3. Set up the SAP S/4HANA side. +4. Set up the SAP BTP side. + +For a detailed description of each of these steps, see [Authenticating Users against On-Premise Systems](https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/authenticating-users-against-on-premise-systems?version=Cloud). + + + + + +## Create Destinations + +As the SAP BTP administrator, you must create and configure an HTTP destination that either supports principal propagation or is based on a technical user. + + + +### Destination for Identity Propagation + +**Prerequisites** + +- Cloud Connector administrator has added the SAP BTP subaccount to the cloud connector. + +- To configure the HTTP destination, you need to know the following: + + - Host and port of the system exposed by the cloud connector + + - Authentication type + + - Location ID \(if configured in the cloud connector\) + + - SAP S/4HANA tenant ID + + + +**Procedure** + +Create a *PrincipalPropagation* HTTP destination and configure its settings as follows: + +1. Go to SAP BTP cockpit *Connectivity* \> *Destinations*, and choose *New Destination*. Enter the following: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + Parameter + + + + Value + +
+ + Name + + + + The destination name. + +
+ + Type + + + + `HTTP` + +
+ + Description + + + + Optional + +
+ + URL + + + + Virtual URL of the protected on-premise application. + +
+ + Proxy Type + + + + OnPremise + +
+ + Authentication + + + + PrincipalPropagation + +
+ +2. Click *Save*. + +To create a destination that uses the host exposed by the cloud connector, make sure that: + +- *Proxy Type* is set to *OnPremise*. + +- *Authentication Type* is supported by your cloud connector configuration. For more information, see [Configuring Principal Propagation](https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/configuring-principal-propagation?version=Cloud). + +- The SAP S/4HANA tenant ID is configured as an *Additional Property*: + + + + + + + + + + + +
+ + Parameter + + + + Value + +
+ + sap-client + + + + SAP S/4HANA tenant ID + +
+ + +For more information about how to create the destination, see [Create HTTP Destinations](https://help.sap.com/viewer/cca91383641e40ffbe03bdc78f00f681/Cloud/en-US/783fa1c418a244d0abb5f153e69ca4ce.html). + + + +### Destination with a Technical User + +**Prerequisites** + +The SAP S/4HANA administrator configured the communication between Graph and SAP S/4HANA. You know the following: + +- URL of your SAP S/4HANA account + +- Name of the communication \(technical\) user in the SAP S/4HANA tenant + +- Password for the communication user + + +**Procedure** + +Create a *BasicAuthentication* HTTP destination and configure its settings as follows: + +1. Go to SAP BTP cockpit*Connectivity* \> *Destinations* and choose *New Destination*. Enter the following: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + Parameter + + + + Value + +
+ + Name + + + + Enter the destination name. + +
+ + Type + + + + `HTTP` + +
+ + Description + + + + Optional + +
+ + URL + + + + The service URL from the communication arrangement. + + > ### Note: + > Make sure you use the HTTPS protocol. + + + +
+ + Proxy Type + + + + Internet + +
+ + Authentication + + + + `BasicAuthentication` + +
+ + User + + + + The name of the communication user in the SAP S/4HANA tenant. + +
+ + Password + + + + The password for the communication user. + +
+ +2. Click *Save*. + + +**Related Information** + + +[Configure Systems in Cloud Connector](https://developers.sap.com/tutorials/btp-app-ext-service-cloud-connector.html) + diff --git a/docs/ISuite/sap-s-4hana-cloud-c099a42.md b/docs/ISuite/sap-s-4hana-cloud-c099a42.md new file mode 100644 index 00000000..925ec1af --- /dev/null +++ b/docs/ISuite/sap-s-4hana-cloud-c099a42.md @@ -0,0 +1,561 @@ + + +# SAP S/4HANA Cloud + +As an administrator of an SAP S/4HANA Cloud configured IAS tenant you need to configure the communication between Graph and SAP S/4HANA Cloud. + +To do this, you need to set up the connectivity on the SAP S/4HANA Cloud tenant and on the SAP BTP tenant for SAP Cloud Identity Access Governance \(IAG\), and create destinations. + + + + + +## Set Up Connectivity + + + +### Prerequisites + +The SAP S/4HANA Cloud administrator must have the following business role assignments: + + + + + + + + + + + + + + + + + + + +
+ +Business Role ID + + + +Area + +
+ +SAP\_BCR\_CORE\_COM + + + +Communication Management + +
+ +SAP\_BCR\_CORE\_IAM + + + +Identity and Access Management + +
+ +SAP\_BCR\_CORE\_EXT + + + +Extensibility + +
+ + + +### Procedure + +1. Configure the single-sign on \(SSO\) Identity Authentication service. +2. Upload your key-pair keystore in SAP BTP cockpit. Otherwise, use the default key-pair keystore. + +3. Set up the SAP S/4HANA Cloud side. +4. Set up the SAP BTP side. + +For a detailed description of each of these steps, see [Using SAML Bearer Assertion Authentication](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/f9d5adca9e414d9b8c42513a8890d782.html). + + + +### Handover Information to the SAP BTP Administrator + +- URL of your SAP S/4HANA Cloud account +- Name of the communication user in the SAP S/4HANA Cloud tenant +- Password for the communication user +- Token Service URL from the OAuth 2.0 details in the communication arrangement +- Provider name for the communication system in SAP S/4HANA Cloud + + + + + +## Create Destinations + +Create a destination to enable the communication between your business system and Graph. + +You can define destinations to data sources using two authentication models: identity propagation \(preferred\) and based on a technical user. Both options are described here for each supported business system. + +> ### Note: +> Graph caches destination settings. If you want to change these settings after the business data graph is created, you need to edit the business data graph configuration and update it. For more information, see [Modify Your Business Data Graph](https://help.sap.com/viewer/15e49174b4ed461e8d8b071ba13af3de/PROD/en-US/0084c4dd85954fc7b3ea6c05ff37d550.html "When you edit your business data graph configuration, it overwrites the existing configuration.") :arrow_upper_right:. + +As the SAP BTP administrator, you must create and configure an HTTP destination that either supports principal propagation or is based on a technical user. + +> ### Note: +> An HTTP destination can be generated automatically by extending SAP S/4HANA Cloud in the Cloud Foundry and Kyma environments. For more information, follow the steps in: +> +> - [Extending SAP Solutions Using Automated Configurations](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/346864df64f24011b49abee07bbd79af.html) +> +> - [Extending SAP S/4HANA Cloud in the Cloud Foundry and Kyma Environment](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/40b9e6c3cc43498b92472da13e88c7bf.html). + + + +### Destination for Identity Propagation + +**Prerequisites** + +The SAP S/4HANA Cloud Administrator configured the communication between Graph and SAP S/4HANA Cloud. You know the following: + +- URL of your SAP S/4HANA Cloud account + +- Name of the communication user in the SAP S/4HANA Cloud tenant + +- Password for the communication user + +- Token Service URL from the OAuth 2.0 details in the communication arrangement + +- Provider name for the communication system in SAP S/4HANA Cloud + + +For more information, see [Principal Propogation Scenario: Cloud to Cloud](https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/scenario-cloud-to-cloud). + +**Procedure** + +Create an *OAuth2SAMLBearerAssertion* HTTP destination and configure its settings as follows: + +1. Go to SAP BTP cockpit *Connectivity* \> *Destinations* and choose *New Destination*. Enter the following: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + Parameter + + + + Value + +
+ + Name + + + + Enter the destination name. + +
+ + Type + + + + `HTTP` + +
+ + Description + + + + Optional + +
+ + URL + + + + The service URL from the communication arrangement. + + > ### Note: + > Make sure you use the HTTPS protocol. + + + +
+ + Proxy Type + + + + Internet + +
+ + Authentication + + + + OAuth2SAMLBearerAssertion + +
+ + Key Store Location + + + + In the dropdown list, select the key-pair keystore file you uploaded in [Upload Your Key-Pair Keystore in SAP BTP](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/f9d5adca9e414d9b8c42513a8890d782.html#loio1c58ebce86514260a3b5be9fb9587745). + +
+ + Key Store Password + + + + The password for the keystore. + + > ### Note: + > The password for the keystore must be the same as the one for the key-pair entry in the keystore file. + + + +
+ + Audience + + + + The URL of your SAP S/4HANA Cloud account. To get it, log on to your SAP S/4HANA Cloud account. Select the profile picture, choose *Settings*, and copy the value from the *Server* field. Add `https://` to the beginning of the URL. + +
+ + Client Key + + + + The name of the communication user you have in the SAP S/4HANA Cloud tenant. + +
+ + Token Service URL + + + + The token service URL from the OAuth 2.0 details in the communication arrangement. + +
+ + Token Service URL Type + + + + Dedicated + +
+ + Token Service User + + + + The name of the communication user in the SAP S/4HANA Cloud tenant. + +
+ + Token Service Password + + + + The password for the communication user. + +
+ + System User + + + + Leave the field empty. + +
+ +2. Configure the required additional properties. To do so, in the *Additional Properties* panel, choose *New Property*, and enter the following parameters: + + + + + + + + + + + + + + + + + + + + + + + +
+ + Parameter + + + + Value + +
+ + `authnContextClassRef` + + + + `urn:oasis:names:tc:SAML:2.0:ac:classes:X509` + +
+ + `nameIdFormat` + + + + `urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress` + +
+ + `scope` + + + + For example: `API_BUSINESS_PARTNER_0001` + +
+ + `userIdSource` + + + + email + +
+ +3. Select the *Use default JDK truststore* checkbox. + +4. Click *Save*. + + + + +### Destination with a Technical User + +**Prerequisites** + +The SAP S/4HANA Cloud administrator configured the communication between Graph and SAP S/4HANA Cloud. You know the following: + +- URL of your SAP S/4HANA Cloud account + +- Name of the communication \(technical\) user in the SAP S/4HANA Cloud tenant + +- Password for the communication user + + +**Procedure** + +Create a *BasicAuthentication* HTTP destination and configure its settings as follows: + +1. Go to SAP BTP cockpit *Connectivity* \> *Destinations* and choose *New Destination*. Enter the following: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + Parameter + + + + Value + +
+ + Name + + + + Enter a destination name. + +
+ + Type + + + + `HTTP` + +
+ + Description + + + + Optional + +
+ + URL + + + + The service URL from the communication arrangement. + + > ### Note: + > Make sure you use the HTTPS protocol. + + + +
+ + Proxy Type + + + + Internet + +
+ + Authentication + + + + `BasicAuthentication` + +
+ + User + + + + The name of the communication user in the SAP S/4HANA Cloud tenant. + +
+ + Password + + + + The password for the communication user. + +
+ +2. Click *Save*. + + diff --git a/docs/ISuite/sap-sales-cloud-5c50b2b.md b/docs/ISuite/sap-sales-cloud-5c50b2b.md new file mode 100644 index 00000000..6779f115 --- /dev/null +++ b/docs/ISuite/sap-sales-cloud-5c50b2b.md @@ -0,0 +1,489 @@ + + +# SAP Sales Cloud + +As an administrator for SAP Sales Cloud, you need to establish trust with the SAP BTP subaccount and create destinations.. + +You can use the SAML Bearer assertion flow for consuming OAuth-protected resources. Users are authenticated by using SAML against the configured trusted identity providers. The SAML assertion is then used to request an access token from an OAuth authorization server. + +This access token must be added as an Authorization header with the value `Bearer ` in all HTTP requests to the OAuth-protected resources. + + + + + +## Configure the OAuth Identity Provider in SAP Sales Cloud + +As the SAP Sales Cloud administrator, you must add the SAP BTP service provider as a trusted OAuth identity provider. + +For more information, see [Configure OAuth Identity Provider in SAP Sales Cloud](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/40d20a26f3dd445facff151b249fcf94.html). + + + +### Prerequisites from SAP BTP administrator + +- Trust certificate +- Region host +- Subaccount ID + + + +### Procedure + +Create an *OAuth2SAMLBearerAssertion* HTTP destination and configure its settings as follows: + +1. Go to SAP BTP cockpit*Connectivity* \> *Destinations* and choose *New Destination*. Enter the following: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + Parameter + + + + Value + +
+ + Name + + + + Enter the destination name + +
+ + Type + + + + HTTP + +
+ + Description + + + + Optional + +
+ + URL + + + + The service URL from the communication arrangement. + + > ### Note: + > Make sure you use the HTTPS protocol. + + + +
+ + Proxy Type + + + + Internet + +
+ + Authentication + + + + OAuth2SAMLBearerAssertion + +
+ + Key Store Location + + + + In the dropdown list, select the key-pair keystore file you uploaded in [Upload Your Key-Pair Keystore in SAP BTP](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/f9d5adca9e414d9b8c42513a8890d782.html#loio1c58ebce86514260a3b5be9fb9587745). + +
+ + Key Store Password + + + + The password for the keystore. + + > ### Note: + > The password for the keystore must be the same as the one for the key pair entry in the keystore file. + + + +
+ + Audience + + + + The URL of your SAP Sales Cloud account. To get the URL, log on to your SAP Sales Cloud account. Select the profile picture and then choose *Settings* and copy the value from the *Server* field. Add `https://` to the beginning of the URL. + +
+ + Client Key + + + + The name of your communication user in the SAP Sales Cloud tenant. + +
+ + Token Service URL + + + + This is the Token service URL from the OAuth 2.0 Details in the communication arrangement. + +
+ + Token Service URL Type + + + + Dedicated + +
+ + Token Service User + + + + The name of the communication user in the SAP Sales Cloud tenant. + +
+ + Token Service Password + + + + The password for the communication user. + +
+ + System User + + + + This parameter is not used, leave the field empty. + +
+ +2. Configure the required additional properties. To do so, in the *Additional Properties* panel, choose *New Property*, and enter the following: + + + + + + + + + + + + + + + + + + + + + + + +
+ + Parameter + + + + Value + +
+ + authnContextClassRef + + + + `urn:oasis:names:tc:SAML:2.0:ac:classes:X509` + +
+ + nameIdFormat + + + + `urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress` + +
+ + scope + + + + For example: `API_BUSINESS_PARTNER_0001` + +
+ + userIdSource + + + + `email` + +
+ +3. Select the *Use default JDK truststore* checkbox. + +4. Click *Save*. + + + + +## Configure the OAuth Client for OData Access + +As the SAP Sales Cloud administrator, you must configure the OAuth client for OData access to SAP Sales Cloud OData APIs. + +For more information, see [Configure the OAuth Client for OData Access](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/2c9c02d7d19748eea0d2482093f04278.html). + + + +### Prerequisites + +- You know the name of the identity provider created in [Configure OAuth Identity Provider in SAP Sales Cloud](https://help.sap.com/viewer/15e49174b4ed461e8d8b071ba13af3de/PROD/en-US/a22152f0f53a48bdbb4385cd438e0324.html "As an administrator for SAP Sales Cloud, you need to establish trust with the SAP BTP subaccount and create destinations..") :arrow_upper_right:. + + + +### Handover Information to the SAP BTP Administrator + +- Client ID +- Client secret +- Scope + + + + + +## Create Destinations + +As the SAP BTP administrator, you must create and configure an HTTP destination that either supports principal propagation or is based on a technical user. + + + +### Destination for Identity Propagation + +**Prerequisites** + +The SAP Sales Cloud administrator has configured the communication between Graph and SAP Sales Cloud. You know the following: + +- Client ID +- Client secret +- Scope + +**Procedure** + +As the SAP BTP administrator, you must create and configure an HTTP destination that supports principal propagation. For more information, see [Create and Configure the HTTP Destination](https://help.sap.com/products/BTP/65de2977205c403bbc107264b8eccf4b/21e50d89d0904038b98e604c8ed85de3.html?version=Cloud). + + + +### Destination with a Technical User + +**Procedure** + +Create a *BasicAuthentication* HTTP destination and configure its settings as follows: + +1. Go to SAP BTP cockpit*Connectivity* \> *Destinations* and choose *New Destination*. Enter the following: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + Parameter + + + + Value + +
+ + Name + + + + Enter the destination name. + +
+ + Type + + + + `HTTP` + +
+ + Description + + + + Optional + +
+ + URL + + + + The service URL from the communication arrangement. + + > ### Note: + > Make sure you use the HTTPS protocol. + + + +
+ + Proxy Type + + + + Internet + +
+ + Authentication + + + + `BasicAuthentication` + +
+ + User + + + + The name of the communication user in the SAP Sales Cloud tenant. + +
+ + Password + + + + The password for the communication user. + +
+ +2. Click *Save*. + + diff --git a/docs/ISuite/sap-successfactors-a6b5934.md b/docs/ISuite/sap-successfactors-a6b5934.md new file mode 100644 index 00000000..d7778c2c --- /dev/null +++ b/docs/ISuite/sap-successfactors-a6b5934.md @@ -0,0 +1,297 @@ + + +# SAP SuccessFactors + +As an SAP SuccessFactors and SAP BTP administrator, you need to set up the connectivity to Graph and create destinations.: + +1. Download the certificate from the *Destination* service of your SAP BTP account. +2. Create an OAuth client in SAP SuccessFactors. +3. Create the *Destination* on your SAP BTP Destination service. + + + + + +## Download the Trust Certificate from the Destination Service + +As the SAP BTP subaccount administrator, download the trust certificate from your account’s destination service. + + + +### Procedure + +1. In the SAP BTP cockpit, go to your subaccount in the SAP BTP, Cloud Foundry environment. +2. Choose *Connectivity* \> *Destinations*. +3. Choose *Download Trust* to get the certificate for this subaccount and save it to your local file system. + + + + + +## Create an OAuth Client on SAP SuccessFactors + +As the SAP SuccessFactors administrator, you need to create an OAuth client that will be used to configure the trust between SAP SuccessFactors and Graph. + + + +### Procedure + +1. In the SAP SuccessFactors system, go to the *Admin Center* and search for *OAuth*. Choose *Manage OAuth2 Client Applications* from the search results. +2. Choose *Register Client Application*. +3. In the *Application Name*, choose a descriptive name for the client of your choice. +4. In the *Application URL* field, enter the URL of yourGraph tenant. +5. In the *X.509 Certificate* field, open the certificate you downloaded before from the Destination service using any text editor, then copy the content between `-----BEGIN CERTIFICATE-----` and `-----END CERTIFICATE-----`, and paste it into the field. +6. Choose *Register* to save the OAuth client. + + + + + +## Create Destinations + +As the SAP BTP administrator, you need to create an HTTP destination to be able to make calls to the SAP SuccessFactors HCM Suite OData APIs using SAML 2.0 Bearer Assertion authentication. + + + +### Procedure + +1. In the SAP BTP cockpit, go to your subaccount in the SAP BTP, Cloud Foundry environment. +2. Choose *Connectivity* \> *Destinations*. +3. Choose *New Destination* and fill in the following parameters: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + Parameter + + + + Value + +
+ + Name + + + + Enter the destination name + +
+ + Type + + + + `HTTP` + +
+ + Description + + + + Optional + +
+ + URL + + + + Enter the URL of the SAP SuccessFactors OData API that you want to consume. For a list of the API Endpoint URLs for the SAP SuccessFactors environments, see [About HXM Suite OData APIs](https://help.sap.com/docs/SAP_SUCCESSFACTORS_PLATFORM/28bc3c8e3f214ab487ec51b1b8709adc/03e1fc3791684367a6a76a614a2916de.html) + +
+ + Proxy Type + + + + Internet + +
+ + Authentication + + + + `OAuth2SAMLBearerAssertion` + +
+ + Key Store Password + + + + The password for the keystore. + + > ### Note: + > The password for the keystore must be the same as the one for the key-pair entry in the keystore file. + + + +
+ + Audience + + + + `www.successfactors.com` + +
+ + AuthnContextClassRef + + + + `urn:oasis:names:tc:SAML:2.0:ac:classes:PreviousSession` + +
+ + Client Key + + + + Enter the API Key of the OAuth client that you created in SAP SuccessFactors. + +
+ + Token Service URL + + + + Enter the API Endpoint URL for the SAP SuccessFactors instance followed by`/oauth/token`. For example,`https://apisalesdemo2.successfactors.eu/oauth/token`. For a list of the API Endpoint URLs for the SAP SuccessFactors environments, see [About HXM Suite OData APIs](https://help.sap.com/viewer/d599f15995d348a1b45ba5603e2aba9b/). + +
+ + Token Service URL Type + + + + Dedicated + +
+ +4. Configure the required additional properties. To do so, in the *Additional Properties* panel, choose *New Property*, and enter the following parameters: + + + + + + + + + + + + + + + + + + + + + + + +
+ + Parameter + + + + Value + +
+ + apiKey + + + + Enter the API Key of the OAuth client that you created in SAP SuccessFactors. + +
+ + companyId + + + + The ID of your SAP SuccessFactors company. + +
+ + nameIdFormat + + + + `urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress` + +
+ + userIdSource + + + + `email` + +
+ +5. Select the *Use default JDK truststore* checkbox. + +6. Click *Save*. + + 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 index 3cff071e..64ba5e8d 100644 --- 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 @@ -17,7 +17,7 @@ The high-level view for SAP API Management and the SAP Cloud Identity is capture [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 \(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.") [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.") diff --git a/docs/apim/API-Management/subscribe-to-a-product-new-design-486d263.md b/docs/ISuite/subscribe-to-a-product-486d263.md similarity index 76% rename from docs/apim/API-Management/subscribe-to-a-product-new-design-486d263.md rename to docs/ISuite/subscribe-to-a-product-486d263.md index 141cded0..df918e21 100644 --- a/docs/apim/API-Management/subscribe-to-a-product-new-design-486d263.md +++ b/docs/ISuite/subscribe-to-a-product-486d263.md @@ -1,6 +1,6 @@ -# Subscribe to a Product \[New Design\] +# Subscribe to a Product You can subscribe to a product and add it to an existing application or create a new application. @@ -10,9 +10,6 @@ You can subscribe to a product and add it to an existing application or create a On the homepage, you can find the list of products under various categories. You can also view the various resources that each product has to offer. -> ### Note: -> This document describes the new design of the API business hub enterprise. To view the documentation for the classic design, see [Subscribe to a Product \[Classic Design\]](subscribe-to-a-product-classic-design-2e586e1.md). - diff --git a/docs/ISuite/supported-patterns-ad867ae.md b/docs/ISuite/supported-patterns-ad867ae.md new file mode 100644 index 00000000..df8fbf67 --- /dev/null +++ b/docs/ISuite/supported-patterns-ad867ae.md @@ -0,0 +1,48 @@ + + +# Supported Patterns + +Learn about the patterns that are available in the migration tooling. + + + + + +## Point-to-Point Asynchronous + +**Point-to-Point asynchronous interface between 1 sender and 1 receiver** is the basic version available within the Point-to-Point Asynchronous pattern.![](images/P2P_ASYNC_0002_8d4e555.png) + +Either by having more components in your source ICO or by choosing the options available in the Migration Tooling, you can have different versions of the Point-to-Point Asynchronous pattern. + +For example: + +- If your source ICO contains at least one message mapping object, the pattern becomes **Point-to-Point asynchronous interface between 1 sender and 1 receiver with 1 message mapping**. + +- If you enable the option to decouple the sender and receiver adapters, the pattern becomes **Point-to-Point asynchronous interface between 1 sender and 1 receiver decoupled using two integration processes**. + +- If your source ICO contains at least one message mapping object, you enable the option to decouple the sender and receiver adapters, and you also enable the option to let the receiver adapter ignore duplicate messages, the pattern becomes **Point-to-Point asynchronous interface between 1 sender and 1 receiver with 1 message mapping and and 1 idempotent process decoupled using two integration processes**. + + + + + + +## Point-to-Point Synchronous + +**Point-to-Point synchronous interface between 1 sender and 1 receiver** is the basic version available within the Point-to-Point Synchronous pattern.![](images/P2P_SYNC_0003_3c8e9ef.png) + +By having more components in your source ICO, you can have different versions of the Point-to-Point Synchronous pattern. + +For example: + +- If your source ICO contains message mapping objects for response and requests, the pattern becomes **Point-to-Point asynchronous interface between 1 sender and 1 receiver with message mappings for request and response**. + +- If your source ICO contains XSLT mapping objects for response and requests, the pattern becomes **Point-to-Point asynchronous interface between 1 sender and 1 receiver with XSLT mappings for request and response**. + + + + + + +## Recipient List Asynchronous + diff --git a/docs/ISuite/supported-templates-ad867ae.md b/docs/ISuite/supported-templates-ad867ae.md deleted file mode 100644 index 477b11cc..00000000 --- a/docs/ISuite/supported-templates-ad867ae.md +++ /dev/null @@ -1,326 +0,0 @@ - - -# Supported Templates - -Learn about the various templates that are available in the migration tooling. - -Following are the supported scenarios, their associated template identifier, and equivalent design in Integration Suite. - - - - - -## P2P\_ASYNC\_0001 - -Point-to-Point asynchronous interface between 1 sender and 1 receiver with 1 message mapping - -![](images/P2P_ASYNC_0001_466d25a.png) - - - - - -## P2P\_ASYNC\_0002 - -Point-to-Point asynchronous interface between 1 sender and 1 receiver - -![](images/P2P_ASYNC_0002_8d4e555.png) - - - - - -## P2P\_ASYNC\_0003 - -Point-to-Point asynchronous interface between 1 sender and 1 receiver with 1 XSLT mapping - -![](images/P2P_ASYNC_0003_acd1a5f.png) - - - - - -## P2P\_ASYNC\_0004 - -Point-to-Point asynchronous interface between 1 sender and 1 receiver with 2 message mappings and 1 XSLT mapping - -![](images/P2P_ASYNC_0004_164a6a3.png) - - - - - -## P2P\_ASYNC\_0005 - -Point-to-Point asynchronous interface between 1 sender and 1 receiver with 1 message mapping decoupled using two integration processes - -![](images/P2P_ASYNC_0005_f42d898.png) - - - - - -## P2P\_ASYNC\_0006 - -Point-to-Point asynchronous interface between 1 sender and 1 receiver with 1 message mapping and 1 idempotent process - -![](images/P2P_ASYNC_0006_82b624b.png) - -The integration process receives the messages, transforms the message using message mapping, and executes an Idempotent Process Call to check if an incoming message was already processed. In this case, the processing of this message is skipped. Else, the message is sent to the receiver using the Request Reply step. - - - - - -## P2P\_ASYNC\_0007 - -Point-to-Point asynchronous interface between 1 sender and 1 receiver with 1 message mapping and 1 idempotent process decoupled using two integration processes - -![](images/P2P_ASYNC_0007_630a053.png) - -The first integration process stores the incoming messages in the JMS queue, using the JMS receiver adapter. - -The second integration process reads the messages from this JMS queue \(using JMS sender adapter\), transforms the message using message mapping, and executes an Idempotent Process Call to check if an incoming message was already processed. In this case, the processing of this message is skipped. Else, the message is sent to the receiver using the Request Reply step. - - - - - -## P2P\_ASYNC\_ATTACH\_0001 - -Point-to-Point asynchronous interface between 1 sender and 1 receiver with 1 message mapping and exchanging the incoming attachment with the message body. - -![](images/P2P_ASYNC_ATTACH_0001_ad32168.png) - - - - - -## P2P\_ASYNC\_BRIDGE\_0001 - -Point-to-Point Async-Sync Bridge between 1 sender supporting asynchronous communication and 1 receiver supporting synchronous communication with message mappings for request and response. - -![](images/P2P_ASYNC_BRIDGE_0001_55747be.png) - - - - - -## P2P\_ASYNC\_CSV\_0001 - -Point-to-Point asynchronous interface between 1 sender and 1 receiver with 1 XSLT mapping, 1 message mapping and CSV conversion at inbound and outbound - -![](images/P2P_ASYNC_CSV_0001_7872efd.png) - -There are limitation while using the template. For more information, see: [Known Limitations](known-limitations-7a552d4.md). - - - - - -## P2P\_ASYNC\_CSV\_0002 - -Point-to-Point asynchronous interface between 1 sender and 1 receiver with 1 message mapping and XML to CSV conversion at outbound - -![](images/P2P_ASYNC_CSV_0002_4450364.png) - -There are limitation while using the template. For more information, see: [Known Limitations](known-limitations-7a552d4.md). - - - - - -## P2P\_ASYNC\_CSV\_0003 - -Point-to-Point asynchronous interface between 1 sender and 1 receiver with 1 message mapping and CSV to XML conversion at inbound - -![](images/P2P_ASYNC_CSV_0003_fd2ea7c.png) - -There are limitation while using the template. For more information, see: [Known Limitations](known-limitations-7a552d4.md). - - - - - -## P2P\_ASYNC\_JSON\_0001 - -Point-to-Point asynchronous interface between 1 sender and 1 receiver with 1 message mapping exchanging messages in JSON format - -![](images/P2P_ASYNC_JSON_0001_8af626e.png) - - - - - -## P2P\_ASYNC\_JSON\_REC\_0001 - -Point-to-Point asynchronous interface between 1 sender and 1 receiver with 1 message mapping and 1 XML to JSON converter - -![](images/P2P_ASYNC_JSON_REC_0001_143627c.png) - - - - - -## P2P\_ASYNC\_JSON\_SND\_0001 - -Point-to-Point asynchronous interface between 1 sender and 1 receiver with 1 message mapping and 1 JSON to XML converter. Additionally, two Groovy scripts are used – one for reading the URL path and the other for reading the GET variables. - -![](images/P2P_ASYNC_JSON_SND_0001_a9cd3b5.png) - - - - - -## P2P\_SYNC\_0001 - -Point-to-Point synchronous interface between 1 sender and 1 receiver with message mappings for request and response - -![](images/P2P_SYNC_0001_235445d.png) - - - - - -## P2P\_SYNC\_0002 - -Point-to-Point synchronous interface between 1 sender and 1 receiver with XSLT mappings for request and response - -![](images/P2P_SYNC_0002_9a2f00a.png) - - - - - -## P2P\_SYNC\_0003 - -Point-to-Point synchronous interface between 1 sender and 1 receiver without any mapping - -![](images/P2P_SYNC_0003_3c8e9ef.png) - - - - - -## P2P\_SYNC\_JSON\_REC\_0001 - -Point-to-Point synchronous interface between 1 sender and 1 receiver with message mappings for request and response exchanging JSON messages with the receiver - -![](images/P2P_SYNC_JSON_REC_0001_b23d382.png) - - - - - -## P2P\_SYNC\_JSON\_SND\_0001 - -Point-to-Point synchronous interface between 1 sender and 1 receiver with message mappings for request and response exchanging JSON messages with sender - -![](images/P2P_SYNC_JSON_SND_0001_231604c.png) - - - - - -## CBR\_ASYNC\_0001 - -Content Based Router with 1 router and a receiver for each router branch raising error in case of receiver not determined - -![](images/CBR_ASYNC_0001_c25af87.png) - - - - - -## CBR\_ASYNC\_0002 - -Content Based Router with 1 router and a receiver for each router branch ignoring message in case of receiver not determined - -![](images/CBR_ASYNC_0002_a5acb3b.png) - - - - - -## CBR\_ASYNC\_0003 - -Content Based Router with 1 router and a receiver for each router branch sending message to default receiver in case of receiver not determined - -![](images/CBR_ASYNC_0003_b742101.png) - - - - - -## CM\_ASYNC\_0001 - -Command Message pattern triggered via start timer event with 1 message mapping and 1 receiver for delta sync via timestamp - -![](images/CM_ASYNC_0001_7525f27.png) - - - - - -## CM\_ASYNC\_0002 - -Command Message pattern triggered via start timer event with 1 XSLT mapping and 1 receiver for delta sync by updating source - -![](images/CM_ASYNC_0002_3b517b4.png) - - - - - -## MF\_ASYNC\_0001 - -Message Filter asynchronous interface with 1 message mapping, 1 router, and 1 receiver - -![](images/MF_ASYNC_0001_15d8925.png) - - - - - -## RL\_ASYNC\_0001 - -Recipient List with option to raise an error if receiver cannot be determined - -![](images/RL_ASYNC_0001_0f9d278.png) - - - - - -## RL\_ASYNC\_0002 - -Recipient List with option to ignore the message if receiver cannot be determined - -![](images/RL_ASYNC_0002_14bc64f.png) - - - - - -## RL\_ASYNC\_0003 - -Recipient List with option to send message to default receiver in case of receiver not determined - -![](images/RL_ASYNC_0003_5163d0f.png) - - - - - -## RL\_ASYNC\_0004 - -Recipient List with NO Condition \(Multicast\)​.![](images/1d24205975ec4c41b7d7f5408f187f7d.image) - - - - - -## RL\_ASYNC\_0005 - -Recipient List with Order at Runtime \(Sequential Multicast\)​![](images/042dbe67e5cc489cbd5e82c245433a2e.image) - diff --git a/docs/ISuite/terminology-and-glossary-fd1491d.md b/docs/ISuite/terminology-and-glossary-fd1491d.md index f2e066bb..f216b401 100644 --- a/docs/ISuite/terminology-and-glossary-fd1491d.md +++ b/docs/ISuite/terminology-and-glossary-fd1491d.md @@ -5,9 +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 "") +[Terminology & Glossary for SAP Integration Advisor](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/9c221b48799a4ce59367b0e3367f5a8f.html "") :arrow_upper_right: diff --git a/docs/ISuite/50-Development/test-runtime-behavior-of-apis-new-design-15c7d52.md b/docs/ISuite/test-runtime-behavior-of-apis-15c7d52.md similarity index 84% rename from docs/ISuite/50-Development/test-runtime-behavior-of-apis-new-design-15c7d52.md rename to docs/ISuite/test-runtime-behavior-of-apis-15c7d52.md index f40ebf47..55b87409 100644 --- a/docs/ISuite/50-Development/test-runtime-behavior-of-apis-new-design-15c7d52.md +++ b/docs/ISuite/test-runtime-behavior-of-apis-15c7d52.md @@ -1,13 +1,13 @@ -# Test Runtime Behavior of APIs \[New Design\] +# Test Runtime Behavior of APIs 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/4425026877144cc2b15505ed30215167/IAT/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/66d066d903c2473f81ec33acfe2ccdb4/Cloud/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/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: +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: diff --git a/docs/ISuite/understanding-event-driven-architecture-2604955.md b/docs/ISuite/understanding-event-driven-architecture-2604955.md new file mode 100644 index 00000000..b436bee6 --- /dev/null +++ b/docs/ISuite/understanding-event-driven-architecture-2604955.md @@ -0,0 +1,6 @@ + + +# Understanding Event Driven Architecture + +Learn about the basics of event-driven architecture. + diff --git a/docs/ISuite/unified-entities-9bcd2ec.md b/docs/ISuite/unified-entities-9bcd2ec.md new file mode 100644 index 00000000..3fdffbdc --- /dev/null +++ b/docs/ISuite/unified-entities-9bcd2ec.md @@ -0,0 +1,29 @@ + + +# Unified Entities + +Certain business objects \(primarily master data, such as customer or product descriptions\) are commonly replicated in multiple SAP systems, sometimes under different names. What one system calls `Product`, another may refer to as `ProductCollection`, `Material`, or even `supplierPart`. They all represent the same product object instance, with common attributes like its name and description, but then each SAP system manages additional, system-specific aspects: SAP S/4HANA maintains details of the manufacture and inventory of products, SAP Sales Cloud is concerned with the conditions of selling or using the product \(for example, the skills required by a sales team\), and SAP Ariba manages elaborate buyer-supplier pricing. Enterprises must synchronize the different representations of the same object, which often have different keys in the different systems, leading to high complexity for application developers as well. + +Developers often only need the common attributes of such business objects and are mystified by the different system representations and key sequences of the same data. To address this, Graph introduces unified entities. Unified entities define the common and most widely used attributes of a business object, using a consistent and easier to understand structure and naming convention. Unified attributes are accessed under the `sap.graph` namespace. + +Developers of extension apps use these common attributes, regardless of where this data resides. Under the hood, Graph maps these attributes to one of the data sources in the landscape, but this doesn't concern the developer. Consequently, the use of unified entities results in SAP-extending apps that are portable and reusable across a wide range of customer landscapes. + +![](images/Unified_Entities_be6c8d3.png) + +Unified entities have association attributes that connect them to the system-specific representations of the same object \(`_s4` and `_c4c`\). These associations effectively provide developers with a consolidated and navigable 360° view of all the attributes of these objects in SAP. To access an attribute such as `Brand`, the app simply issues a `sap.graph/Product(123)/_s4/Brand` request. Of course, SAP S/4HANA system-specific attributes are only available if such a system is part of the underlying enterprise landscape. Graph handles key mapping complexities under the hood. For more information, see [Data Locating Policy](https://help.sap.com/viewer/15e49174b4ed461e8d8b071ba13af3de/PROD/en-US/28d2c2cd55454c968661b60c0a829abe.html "Data in the business data graph is connected via key-based references.") :arrow_upper_right:. + +Whether or not an entity is read-only depends on various parameters of your landscape. The metadata of your business data graph tells you which entities are writable. + +Citizen developers use low-code tools to access the unified entities. Advanced developers with more complex requirements can follow the edges of the graph to use detailed system-specific attributes. + +In summary, unified entities play two roles: + +1. They provide consistent and simplified access to the *common* attributes of a multi-sourced business object. This simplified and common information provides sufficient detail for many extension applications. It is written without worrying about the differences and more complex variations of the system-specific models, making these applications portable over a broad range of landscape configurations. + +2. They "connect" the system-specific entities via explicit associations. This provides developers of extension applications a comprehensive 360° perspective of how objects are managed in their enterprise and supports powerful cross-system queries of system-specific attributes. + + +SAP is gradually introducing new unified entities, along with the extended support of Graph for more SAP systems. The initial release of Graph supportsSAP S/4HANA, SAP Sales Cloud, and SAP SuccessFactors. + +To all Graph developers, the business data graph looks and behaves like a single, giant, consistent, navigable SAP system, accessible via a single API and access protocol, ignoring the physical landscape of data source system instances. + diff --git a/docs/ISuite/50-Development/updating-the-connection-request-credentials-for-a-pending-request-new-design-dd37a7b.md b/docs/ISuite/updating-the-connection-request-credentials-for-a-pending-request-dd37a7b.md similarity index 90% rename from docs/ISuite/50-Development/updating-the-connection-request-credentials-for-a-pending-request-new-design-dd37a7b.md rename to docs/ISuite/updating-the-connection-request-credentials-for-a-pending-request-dd37a7b.md index 8003a6ca..fc453dbf 100644 --- a/docs/ISuite/50-Development/updating-the-connection-request-credentials-for-a-pending-request-new-design-dd37a7b.md +++ b/docs/ISuite/updating-the-connection-request-credentials-for-a-pending-request-dd37a7b.md @@ -1,6 +1,6 @@ -# Updating the Connection Request Credentials for a Pending Request \[New Design\] +# Updating the Connection Request Credentials for a Pending Request Update the credentials you've used to establish a connection between the Integration Suite API Management tenant and the API business hub enterprise. @@ -42,9 +42,6 @@ If you encounter one of the following situations when your connection request is - You've deleted the service instance, or the service key, after the connection request was submitted. In this case, the credentials you used before deleting the service instance or the service key becomes invalid. -> ### Note: -> This document describes the new design of the API business hub enterprise. To view the documentation for the classic design, see [Updating the Connection Request Credentials for a Submitted Request \[Classic Design\]](updating-the-connection-request-credentials-for-a-submitted-request-classic-design-eb84854.md). - diff --git a/docs/ISuite/50-Development/updating-the-connection-request-credentials-for-an-approved-request-new-design-882e1d9.md b/docs/ISuite/updating-the-connection-request-credentials-for-an-approved-request-882e1d9.md similarity index 91% rename from docs/ISuite/50-Development/updating-the-connection-request-credentials-for-an-approved-request-new-design-882e1d9.md rename to docs/ISuite/updating-the-connection-request-credentials-for-an-approved-request-882e1d9.md index 415db69c..e527447f 100644 --- a/docs/ISuite/50-Development/updating-the-connection-request-credentials-for-an-approved-request-new-design-882e1d9.md +++ b/docs/ISuite/updating-the-connection-request-credentials-for-an-approved-request-882e1d9.md @@ -1,6 +1,6 @@ -# Updating the Connection Request Credentials for an Approved Request \[New Design\] +# Updating the Connection Request Credentials for an Approved Request There can be instances where you have to update the credentials once the connection request is approved by the API business hub enterprise admin. @@ -39,9 +39,6 @@ If you encounter one of the following situations after the connection request ha - Similarly, if the destination that fetches the API content from the Integration Suite API Management tenant workspace gets deleted, the credentials you were using before the destination got deleted becomes invalid. -> ### Note: -> This document describes the new design of the API business hub enterprise. To view the documentation for the classic design, see [Updating the Connection Request Credentials for an Approved Request \[Classic Design\]](updating-the-connection-request-credentials-for-an-approved-request-classic-design-b583b7a.md). - diff --git a/docs/ISuite/upgrade-edge-integration-cell-solution-e7b8089.md b/docs/ISuite/upgrade-edge-integration-cell-solution-e7b8089.md index c7e1117b..61a70cb6 100644 --- a/docs/ISuite/upgrade-edge-integration-cell-solution-e7b8089.md +++ b/docs/ISuite/upgrade-edge-integration-cell-solution-e7b8089.md @@ -40,13 +40,8 @@ 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. - - > ### 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). +The solution is upgraded based on helm charts of the new version. +> ### 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 ed3d6991..e4db638c 100644 --- a/docs/ISuite/user-roles-in-api-management-7010b58.md +++ b/docs/ISuite/user-roles-in-api-management-7010b58.md @@ -199,7 +199,7 @@ 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.") -[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 \(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.") [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/tasks-and-corresponding-role-collections-911ca5a.md b/docs/ISuite/user-roles-in-api-management-new-911ca5a.md similarity index 99% rename from docs/ISuite/tasks-and-corresponding-role-collections-911ca5a.md rename to docs/ISuite/user-roles-in-api-management-new-911ca5a.md index 4644fdd3..5192ece3 100644 --- a/docs/ISuite/tasks-and-corresponding-role-collections-911ca5a.md +++ b/docs/ISuite/user-roles-in-api-management-new-911ca5a.md @@ -1,6 +1,6 @@ -# Tasks and Corresponding Role Collections +# User Roles in API Management \(New\) 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/50-Development/view-applications-costs-and-analyze-reports-new-design-fca4d8c.md b/docs/ISuite/view-applications-costs-and-analyze-reports-fca4d8c.md similarity index 94% rename from docs/ISuite/50-Development/view-applications-costs-and-analyze-reports-new-design-fca4d8c.md rename to docs/ISuite/view-applications-costs-and-analyze-reports-fca4d8c.md index 6cacd760..9b802a9d 100644 --- a/docs/ISuite/50-Development/view-applications-costs-and-analyze-reports-new-design-fca4d8c.md +++ b/docs/ISuite/view-applications-costs-and-analyze-reports-fca4d8c.md @@ -1,6 +1,6 @@ -# View Applications, Costs, and Analyze Reports \[New Design\] +# View Applications, Costs, and Analyze Reports From the *My Workspace* page you can view your applications, costs, and analyze reports. diff --git a/docs/ISuite/what-are-event-brokers-f72428f.md b/docs/ISuite/what-are-event-brokers-f72428f.md new file mode 100644 index 00000000..b9364b69 --- /dev/null +++ b/docs/ISuite/what-are-event-brokers-f72428f.md @@ -0,0 +1,10 @@ + + +# What Are Event Brokers + +An event broker is middleware that mediates the communication of event messages between producers and consumers using the various message exchange patterns + +Event-driven architecture \(EDA\) uses event brokers to provide the messaging infrastructure. Applications that produce and consume events are clients of an event broker. When an application publishes an event message, the event is sent to an event broker, which then routes the event on to subscribing clients. + +An event broker can be a hardware appliance, software, or software-as-a-service \(SaaS\). SAP Integration Suite provides event broker services. + diff --git a/docs/ISuite/what-are-events-9a5bf90.md b/docs/ISuite/what-are-events-9a5bf90.md new file mode 100644 index 00000000..f1a1c1f7 --- /dev/null +++ b/docs/ISuite/what-are-events-9a5bf90.md @@ -0,0 +1,15 @@ + + +# What Are Events + +To understand event-driven architecture \(EDA\), you must first understand events. + +In the simplest terms, an event is something that happens. In IT terms, an event represents a change in the state of data, such as a sensor signaling a change in temperature, a field changing in a database, a ship changing course, a bank deposit being completed, or a checkout button being clicked in an e-commerce app. Often, the sooner an enterprise knows about an event and can react, the better. + +When an event happens, an application sends a message. A message is simply a communication of data. In an EDA, messages communicate data about events. + +For large enterprises who need to track and respond to constantly occurring events as vehicles and goods move, prices change, and customers click, EDA provides an infrastructure for making sure that streams of event messages get everywhere they need to go as quickly as possible, to enable enterprises to act on new data in near-real time. + +> ### Remember: +> Events and messages are so closely related in an EDA that people often think that an event and a message are the same. However, it's the events that generate messages to communicate the event data. + diff --git a/docs/ISuite/what-are-topics-and-topic-subscriptions-1712c0d.md b/docs/ISuite/what-are-topics-and-topic-subscriptions-1712c0d.md new file mode 100644 index 00000000..d0e565f5 --- /dev/null +++ b/docs/ISuite/what-are-topics-and-topic-subscriptions-1712c0d.md @@ -0,0 +1,48 @@ + + +# What Are Topics and Topic Subscriptions? + +To understand how messages flow from publishers to subscribers, you must understand the role played by topics. + + + + + +## Topics and Topic Subscriptions + + + +### Topics + +In an event-driven architecture \(EDA\), topics are a means of classifying the information contained in the event message. Events are published to a topic and queues can subscribe to one or more topics to attract events from publishers. In practice, topics are simply strings composed of one or more levels added to a message header. + +Topics have the format `a/b/c/.../n` + +where `a`, `b`, `c` and so on to `n` are identifiers in a hierarchical scheme you've devised that allows you to classify your information. + +For example, if you're publishing information on sports events, you might create topics like `sports/football/scores`, `sports/football/results`, `sports/basketball/scores`, and `sports/basketball/results` to organize the content you're sending out. + + + +### Topic Subscriptions + +A topic subscription is a string used to attract published events. Topic subscriptions can contain wildcards to match with multiple topics. The `*` character can be used as a wildcard in topic subscriptions. + +When `*` appears at a level within a topic subscription, it indicates a wildcard match at that level. For example, `sports/*/scores` matches the topics `sports/football/scores` and `sports/basketball/scores`. + + + + + +## How Event Mesh Uses Topics + +If we think of topics as destinations, then Event Mesh can be thought of as the post office that directs events from the publisher to the subscribers' post boxes. + +- **Endpoints** are objects created on the broker to persist messages. + + - **Queues** are both a destination that clients can publish messages to and an endpoint that clients can consume messages from. For more information, see [Queues](queues-99b7501.md). + + +- Consumers are consuming applications that connect to Event Mesh. Any of the consumers that have been configured with topic subscriptions receive messages with matching topics. + + diff --git a/docs/ISuite/what-is-graph-ad1c48d.md b/docs/ISuite/what-is-graph-ad1c48d.md new file mode 100644 index 00000000..180b2f29 --- /dev/null +++ b/docs/ISuite/what-is-graph-ad1c48d.md @@ -0,0 +1,35 @@ + + +# What Is Graph? + +Extending traditional API Management, Graph 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. + +Graph is a capability of API Management within SAP Integration Suite. With Graph, developers access your business data as a single semantically connected data graph, spanning the suite of SAP products and beyond. Targeting SAP's ecosystem of partner and customer developers, Graph's powerful API reduces the cost and complexity of creating and deploying reusable extensions and other client applications. + +Enterprise landscapes continue to expand in scale and complexity. Each additional system, SaaS, or microservice introduces new protocols, data models, connectivity, and security conventions. Real-world problems often span multiple lines of business, services, and APIs. Consequently, even the most experienced developers struggle to understand all of the technologies and interfaces involved. Developing new business-extending client applications requires an ever-growing range of expertise and skills. The phenomenal adoption of low-code tools by nonprofessional developers further increases the gap. + +Enterprises use API Management to partially address this gap: APIs can be renamed, authentication can be streamlined, APIs can be protected against unauthorized access or threats. But this doesn't address the deeper problem: separate, disconnected APIs from different data sources and systems. + +Graph is a solution to unify your business APIs in the form of a semantically connected data graph, accessed via a single powerful API. Out of the box, it provides developers a single connected and unified view of your SAP-managed business data. Graph consolidates thousands of data entities from SAP systems likeSAP S/4HANA, SAP Sales Cloud, and SAP SuccessFactors, into one curated, semantically connected, data model. We call this connected graph a *Business Data Graph*. + +The out-of-the-box data graph of SAP-managed data is the baseline, the starting point to your own data graph. You can expand it by adding your own data sources and your own data models, projections, and compositions, creating a unique data model of your business. + +The business data graph is ultimately an abstraction of the data in your landscape, for developers. It establishes a separation of concerns, by exposing the data graph through a single unified API, entirely hiding the complexities of the landscape itself. + +Developers use standard and powerful data graph query languages \(OData V4 or GraphQL\) to efficiently navigate the data, without being exposed to the complexity of data sources, URLs, connections, replications, VPNs, or underlying security concerns. All the data, through one API. Often a single powerful graph-navigating query replaces the complex programming logic that would have been required to issue repeated queries to separate systems or APIs. + +Graph technically acts as a scalable and stateless multitenant service, accepting navigation queries from applications, breaking up those queries, and accessing the APIs of the actual data sources on their behalf. Graph doesn’t maintain or cache data; all data requests are semantically routed to the data source systems. + +Because of the decoupling of the system landscape from applications, enterprises can deploy Graph-based applications more easily, across more landscapes, and at a lower cost. + +As part of SAP Integration Suite, Graph is compatible with SAP's Cloud Application Programming model \(CAP\) and with the range of SAP Build development solutions. + +**Related Information** + + +[Configure](https://help.sap.com/viewer/15e49174b4ed461e8d8b071ba13af3de/PROD/en-US/1b52dd10f37c45feabaa1949bc80f261.html "Before Graph can be used, the Tenant administrator, needs to configure Graph as a capability of API Management within SAP Integration Suite.") :arrow_upper_right: + +[Model](https://help.sap.com/viewer/15e49174b4ed461e8d8b071ba13af3de/PROD/en-US/31f8c54de9ca4e8799371e7d385cde08.html "It is common knowledge that data-driven software should be modeled on its underlying business processes.") :arrow_upper_right: + +[Develop](https://help.sap.com/viewer/15e49174b4ed461e8d8b071ba13af3de/PROD/en-US/68ce43a3c609468d95721031085007b1.html "As a developer you want to build applications that consume data from business data graphs. This section provides all the information you need to start developing.") :arrow_upper_right: + diff --git a/docs/ISuite/what-is-messaging-0ef235f.md b/docs/ISuite/what-is-messaging-0ef235f.md new file mode 100644 index 00000000..01723b83 --- /dev/null +++ b/docs/ISuite/what-is-messaging-0ef235f.md @@ -0,0 +1,21 @@ + + +# What Is Messaging + +Understand how a message about an event is communicated. + +Messaging lets computer systems share information without requiring direct connections or awareness of each other's location. Messaging is analogous to postal and shipping services. With messaging, your applications deliver information to a messaging system that routes it to whatever other applications it needs to get to. + +At its most basic, messaging involves the following participants: + +- Publisher – the entity that sends or publishes a message \(also called a producer\). + +- Message – the information the publisher wants to send. Messages often contain event data, but can also carry queries, commands, and other information. + +- Messaging system – the infrastructure that transmits the message. + +- Subscriber – the ultimate receiver of the message \(also called a consumer\). + + +In an event-driven architecture \(EDA\), a message typically has a destination that separates the publisher from the subscriber. In SAP Integration Suite, a destination is generally a queue that is managed by the event brokers. + diff --git a/docs/ISuite/what-is-migration-tooling-1a3bfbc.md b/docs/ISuite/what-is-migration-tooling-1a3bfbc.md index fd99c2ab..227cc6a5 100644 --- a/docs/ISuite/what-is-migration-tooling-1a3bfbc.md +++ b/docs/ISuite/what-is-migration-tooling-1a3bfbc.md @@ -4,7 +4,7 @@ Learn more about Migration Tooling. -Migration Tooling is a template-based feature in the Cloud Integration capability of the SAP Integration Suite that helps you migrate integration artifacts from SAP Process Orchestration to SAP Integration Suite. Before you migrate an integration artifact, evaluate the migration possibility using the Migration Assessment capability of SAP Integration Suite. For more information, see: [Migration Assessment](migration-assessment-5c5e50e.md). +Migration Tooling is a pattern-based feature in the Cloud Integration capability of the SAP Integration Suite that helps you migrate integration artifacts from SAP Process Orchestration to SAP Integration Suite. Before you migrate an integration artifact, evaluate the migration possibility using the Migration Assessment capability of SAP Integration Suite. For more information, see: [Migration Assessment](migration-assessment-5c5e50e.md). > ### 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). @@ -46,11 +46,11 @@ To get started with migration, you must: -## Usage of Templates +## Usage of Patterns -Every ICO that can be migrated has an associated template in the migration tooling. It's based on these templates, the migration tooling creates equivalent integration flows in the SAP Integration Suite. +The migration tooling analyses an migratable ICO and maps it with an integration pattern. It's based on these patterns, the migration tooling creates equivalent integration flows in the SAP Integration Suite. -To know more about templates and the complete list of supported templates, see: [Supported Templates](supported-templates-ad867ae.md#loioad867aea1fc749a99abc2cf643c94038). +To know more about patterns, see: [Supported Patterns](supported-patterns-ad867ae.md#loioad867aea1fc749a99abc2cf643c94038). diff --git a/docs/ISuite/what-is-sap-integration-suite-5cc6987.md b/docs/ISuite/what-is-sap-integration-suite-5cc6987.md index 1af491e5..f5cb93a9 100644 --- a/docs/ISuite/what-is-sap-integration-suite-5cc6987.md +++ b/docs/ISuite/what-is-sap-integration-suite-5cc6987.md @@ -63,6 +63,17 @@ Discover, protect, govern, and publish APIs to developers with API Management an +
+ +Manage Business Events + +
+
+ +Publish and consume business events to seamlessly connect applications through event-driven architecture. + + +
Extend Non-SAP Connectivity 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 deleted file mode 100644 index f007986a..00000000 --- a/docs/ISuite/what-s-new-for-integration-suite-general-features-2ad1b96.md +++ /dev/null @@ -1,765 +0,0 @@ - - - - -# What's New for Integration Suite General Features - - - - - -**2023** - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -Technical Component - - - -Environment - - - -Title - - - -Description - - - -Action - - - -Lifecycle - - - -Type - - - -Line of Business - - - -Modular Business Process - - - -Product - - - -Latest Revision - - - -Available as of - -
- -Integration Suite General Features - - - -- Cloud Foundry - - - - - -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 - - - - - -Built-In Support - - - -This new feature helps you find solutions to problems you may encounter when using SAP Integration Suite. - -From SAP Integration Suite, you can search knowledge base articles that can help you understand the application behavior and guide you towards a solution. - -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](20-Working_with_SAP_Integration_Suite_Home/working-with-integration-suite-home-a53dce3.md) - - - -Info only - - - -General Availability - - - -New - - - -Technology - - - -Not applicable - - - -SAP Business Technology Platform - - - -2024-05-10 - - - -2024-05-10 - -
- -Integration Suite General Features - - - -- Cloud Foundry - - - - - -Changes in the User Interface - - - -The following changes can be seen: - -- Edge Integration Cell is now generally available. -- The Integrations tab under the *Design*,*Monitoring*, and *Settings* sections in the left navigation pane has been renamed to *Integrations and APIs* to encompass the fact that APIs specific to Edge Integration Cell can now be added as artifacts when creating integration packages. -- An *Engage* section is now available in the left navigation panel and contains content pertaining to products and applications associated with API proxies. -- The API tab is no longer available under the *Design* section, the content of this section dealing with API Management has been moved under the *Configure* and*Engage* sections. -- If you’ve chosen to activate the Edge Integration Cell, then: - - - An*Operations* section is available in the left navigation panel. - - A *Runtime* tab is now available in the *Settings* section. - - See [What Is Edge Integration Cell](https://help.sap.com/docs/integration-suite/sap-integration-suite/what-is-sap-integration-suite-edge-integration-cell). - - - - - - -Info only - - - -General Availability - - - -New - - - -Technology - - - -Not applicable - - - -SAP Business Technology Platform - - - -2023-10-28 - - - -2023-10-28 - -
- -Integration Suite General Features - - - -- Cloud Foundry - - - - - -Contextual Help - - - -You can now access contextual help for the *Monitoring* and *Graph* screens. - - - -Info only - - - -General Availability - - - -New - - - -Technology - - - -Not applicable - - - -SAP Business Technology Platform - - - -2023-08-28 - - - -2023-08-28 - -
- -Integration Suite General Features - - - -- Cloud Foundry - - - - - -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) - - - -Info only - - - -General Availability - - - -New - - - -Technology - - - -Not applicable - - - -SAP Business Technology Platform - - - -2023-07-17 - - - -2023-07-17 - -
- -Integration Suite General Features - - - -- Cloud Foundry - - - - - -Contextual Help - - - -You can now access contextual help for the *Inspect* screens. - - - -Info only - - - -General Availability - - - -New - - - -Technology - - - -Not applicable - - - -SAP Business Technology Platform - - - -2023-07-17 - - - -2023-07-17 - -
- -Integration Suite General Features - - - -- Cloud Foundry - - - - - -Contextual Help - - - -You can access contextual help for the following screens: - -- *Home* -- *Discover* \> *Integrations* -- *Discover* \> *APIs* -- *Discover* \> *Type Systems* -- *Design* \> *Custom Type Systems* -- *Design* \> *MIGs* -- *Design* \> *MAGs* -- *Monitor* \> *Integrations* -- *Settings* \> *MIGs and MAGs* - -A guided tour is available for the home page. Take this tour to explore the various aspects of the home page. - -To activate this help, choose from the top tool bar. You will see green icons on the screen. Choose these icons to know about the UI element associated with them. - -To activate the guided tour, from the contextual help panel, choose *Guided Tours* \> *Take A Tour of the Home Screen*. Follow the instructions to take the tour. - -You can close the help by again choosing . - - - -Info only - - - -General Availability - - - -New - - - -Technology - - - -Not applicable - - - -SAP Business Technology Platform - - - -2023-03-13 - - - -2023-03-13 - -
- -Integration Suite General Features - - - -- Cloud Foundry - - - - - -Contextual Help - - - -You can access contextual help for the following screens: - -- *Home* -- *Discover* \> *Type Systems* -- *Design* \> *Custom Type Systems* -- *Design* \> *MIGs* -- *Design* \> *MAGs* -- *Settings* \> *MIGs and MAGs* - -To activate this help, choose from the top tool bar. You will see green icons on the screen. Choose these icons to know about the UI element associated with them. You can close the help by again choosing . - - - -Info only - - - -General Availability - - - -Announcement - - - -Technology - - - -Not applicable - - - -SAP Business Technology Platform - - - -2023-02-20 - - - -2023-02-20 - -
- -Integration Suite General Features - - - -- Cloud Foundry - - - - - -Feedback survey. - - - -A survey is available on the top toolbar, for you to share your feedback on the SAP Integration Suite . - - - -Info only - - - -General Availability - - - -New - - - -Technology - - - -Not applicable - - - -SAP Business Technology Platform - - - -2022-12-10 - - - -2022-12-10 - -
- -Integration Suite General Features - - - -- Cloud Foundry - - - - - -Provide feedback and contribute content on GitHub. - - - -You can now actively contribute to this guide by giving feedback via Github. The new Feedback functionality on the SAP Help Portal allows you to provide feedback to responsible authors and the development team and discuss documentation-related issues. You will need a GitHub account to use this feature. See, [What is SAP Integration Suite?](https://help.sap.com/docs/SAP_INTEGRATION_SUITE/51ab953548be4459bfe8539ecaeee98d/5cc6987511104c418b7cb4c25f3d9cb0.html?version=CLOUD) and [SAP BTP Documentation Goes GitHub: Learn About Our New Collaboration Process](https://www.youtube.com/watch?v=WJ0oarMlVW4). - - - -Info only - - - -General Availability - - - -Announcement - - - -Technology - - - -Not applicable - - - -SAP Business Technology Platform - - - -2022-11-07 - - - -2022-11-07 - -
- diff --git a/docs/ISuite/working-with-api-management-321fb4d.md b/docs/ISuite/working-with-api-management-321fb4d.md new file mode 100644 index 00000000..6bacb947 --- /dev/null +++ b/docs/ISuite/working-with-api-management-321fb4d.md @@ -0,0 +1,162 @@ + + +# Working with API Management + +Get an understanding of API Management within SAP Integration Suite and leverage its capabilities effectively. + +The table below enumerates the concepts, capabilities, functions and services of API Management: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +API Lifecycle + + + +The API lifecycle encompasses several stages, including API planning, creation, and implementation by company developers, API creators, and composers. It extends to the consumption of these APIs by other employees, partners, or users of the company's products and services. For more information, see [API Lifecycle](api-lifecycle-5e8ea7d.md). + +
+ +Enable API Management Capability + + + +Set up the API Management capability from Integration Suite. For more information, see [Activate and Configure API Management Capability](activate-and-configure-api-management-capability-f6eb433.md). + +
+ +Components of API Management + + + +The API Management components collaborate to offer a comprehensive solution, allowing organizations to securely expose, manage, and monetize their APIs. This empowers developers to effectively build applications that utilize these APIs. It comprises of five key components: API Management Runtime, API Management Design Time, API business hub enterprise, API Analytics and API Designer. For more information, see [Components of API Management](components-of-api-management-e02ae53.md). + +
+ +Important Concepts of API Management + + + +The structure of the API Management capability within Integration Suite revolves around APIs, products, applications, users, developers, and accounts. Understanding this structure is crucial for effectively managing and organizing APIs within API Management. For more information, see [Important Concepts of API Management](important-concepts-of-api-management-414808b.md). + +
+ +Managing API Endpoints + + + +The primary purpose of API Management is to manage your API endpoints. Managing API endpoints involves two categories: + +- Proxified API endpoints, which are the APIs that you explicitly want to "proxify" by routing API calls through an API proxy. + +- Unproxified API endpoints, also known as unmanaged or externally managed APIs, are endpoints that do not require an API proxy and are not part of the strictly managed APIs. + +For more information, see [Managing API Endpoints](managing-api-endpoints-ac794e4.md). + +
+ +Configure APIs + + + +Create, update API proxies and register APIs. For more information, see [Configure APIs](configure-apis-fdf5373.md). + +
+ +API Services + + + +A variety of APIs are offered as services in specific use cases and workflows. You can explore them and try it out in the SAP Business Accelerator Hub. For more information, see [API Services](api-services-007d50f.md). + +
+ +API Management Service Plans + + + +The functionality of the API Management capability is typically managed using the Integration Suite \(UI\) application. However, there are certain service plans that allows you to call API Management APIs, manage Cloud Foundry applications, and connect to an on-premise backend system. For more information, see [API Management Service Plans](api-management-service-plans-e064663.md). + +
+ +Additional Configurations for API Management + + + +In this section, you can find information about configuring additional virtual host, region-specific IP addresses for API Management, managing user roles in API Management, cancelling your API Management service subscription, and integrating API Management with SAP Cloud Identity Services. For more information, see [Additional Configurations for API Management](additional-configurations-for-api-management-5ac63ab.md). + +
+ +API Documentation + + + +Gather additional instructions on how to effectively use and integrate with an API. For more information, see [API Documentation](api-documentation-e26b332.md). + +
+ +Migration of API Management Content + + + +You can now migrate the API Management content from Neo to Cloud Foundry or between different Cloud Foundry environments. For more information, see [Migration of API Management Content](APIM-Migration/migration-of-api-management-content-d66b3e5.md). + +
+ +Limits in API Management + + + +There are certain boundary conditions to consider when building, managing, and reviewing APIs. API Management is designed to perform at its best when configured within these specified conditions. For more information, see [Limits in API Management](limits-in-api-management-f70f425.md). + +
+ diff --git a/docs/apim/API-Management/2021-archives-bdf0f0e.md b/docs/apim/API-Management/2021-archives-bdf0f0e.md index 5f45e8eb..ca5268e0 100644 --- a/docs/apim/API-Management/2021-archives-bdf0f0e.md +++ b/docs/apim/API-Management/2021-archives-bdf0f0e.md @@ -163,7 +163,7 @@ Applications table on My Workspace -The *My Workspace* section in API Business Hub Enterprise has been revamped to provide better performance. The Cost Incurred column has been removed from the Applications table. You can view the cost incurred details in the *Cost* section. For more information,see [Create an Application \[Classic Design\]](create-an-application-classic-design-7b4e71b.md). +The *My Workspace* section in API Business Hub Enterprise has been revamped to provide better performance. The Cost Incurred column has been removed from the Applications table. You can view the cost incurred details in the *Cost* section. For more information,see [Create an Application \[Classic Design\]](https://help.sap.com/viewer/de4066bb3f9240e3bfbcd5614e18c2f9/Cloud/en-US/7b4e71b3887f4396aa22ce3e2ed7e0c3.html "Create an Application to consume the required APIs.") :arrow_upper_right:. @@ -485,7 +485,7 @@ API Business Hub Enterprise Ypu can now update the credentials used to establish a connection between the API portal and the API Business Hub Enterprise for a submitted request and an approved request. -Action: To update the credentials, see [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) and [Updating the Connection Request Credentials for an Approved Request \[Classic Design\]](APIM-Initial-Setup/updating-the-connection-request-credentials-for-an-approved-request-classic-des-b583b7a.md). +Action: To update the credentials, see [Updating the Connection Request Credentials for a Submitted Request \[Classic Design\]](https://help.sap.com/viewer/de4066bb3f9240e3bfbcd5614e18c2f9/Cloud/en-US/eb84854e31d943b490af77cfb218ddbb.html "Update the credentials you've used to establish a connection between the API portal and the API business hub enterprise.") :arrow_upper_right: and [Updating the Connection Request Credentials for an Approved Request \[Classic Design\]](https://help.sap.com/viewer/de4066bb3f9240e3bfbcd5614e18c2f9/Cloud/en-US/b583b7a62f3c4cfdb50a499250c25c15.html "There can be instances where you have to update the credentials once the connection request is approved by the API business hub enterprise admin.") :arrow_upper_right:. @@ -667,7 +667,7 @@ Generate client ID and secret from API Portal UI You can now generate the credentials from the API Portal to establish the connection with centralized API Business Hub Enterprise. -Action: See the Next Steps section in [Set Up API Portal Application](APIM-Initial-Setup/set-up-api-portal-application-29c281b.md). See the Prerequisites section and the Note in the Results section in [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). +Action: See the Next Steps section in [Set Up API Portal Application](APIM-Initial-Setup/set-up-api-portal-application-29c281b.md). See the Prerequisites section and the Note in the Results section in [Create a Connection Request for the Centralized API business hub enterprise \[Classic Design\]](https://help.sap.com/viewer/de4066bb3f9240e3bfbcd5614e18c2f9/Cloud/en-US/02f7877360a64c6b8d853fed9b2d9cc6.html "To publish the API portal content on the API business hub enterprise, you must create a request to connect the API portal to the API business hub enterprise.") :arrow_upper_right:. @@ -843,7 +843,7 @@ Updating the Connection Request Credentials -There can be instances where you have to update the credentials that you've used to establish a connection between the API portal and the API Business Hub Enterprise. For more information, see [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). +There can be instances where you have to update the credentials that you've used to establish a connection between the API portal and the API Business Hub Enterprise. For more information, see [Updating the Connection Request Credentials for a Submitted Request \[Classic Design\]](https://help.sap.com/viewer/de4066bb3f9240e3bfbcd5614e18c2f9/Cloud/en-US/eb84854e31d943b490af77cfb218ddbb.html "Update the credentials you've used to establish a connection between the API portal and the API business hub enterprise.") :arrow_upper_right:. @@ -1143,7 +1143,7 @@ API Business Hub Enterprise You can now maintain a centralized API catalog in one API Business Hub Enterprise that accepts contents like API proxies, API products, and so on, from multiple API portals. -Action: You can select multiple products published from the same portal but you can't select products published from different portals. For more information, see [Centralized API business hub enterprise \[Classic Design\]](APIM-Initial-Setup/centralized-api-business-hub-enterprise-classic-design-33b706f.md) and [Create an Application \[Classic Design\]](create-an-application-classic-design-7b4e71b.md). +Action: You can select multiple products published from the same portal but you can't select products published from different portals. For more information, see [Centralized API business hub enterprise \[Classic Design\]](https://help.sap.com/viewer/de4066bb3f9240e3bfbcd5614e18c2f9/Cloud/en-US/33b706f4f2e148ffb1cb9289d5cda27d.html "The centralized API business hub enterprise is a central API catalog, allowing application developers to consume APIs and other assets, from a common platform.") :arrow_upper_right: and [Create an Application \[Classic Design\]](https://help.sap.com/viewer/de4066bb3f9240e3bfbcd5614e18c2f9/Cloud/en-US/7b4e71b3887f4396aa22ce3e2ed7e0c3.html "Create an Application to consume the required APIs.") :arrow_upper_right:. diff --git a/docs/apim/API-Management/2022-archives-7eaa63d.md b/docs/apim/API-Management/2022-archives-7eaa63d.md index a9dc45dc..82816640 100644 --- a/docs/apim/API-Management/2022-archives-7eaa63d.md +++ b/docs/apim/API-Management/2022-archives-7eaa63d.md @@ -90,7 +90,7 @@ API Business Hub Enterprise \[New Design\] -If you have added API Business Hub Enterprise as a capability with Integration suite, or if you’ve subscribed to API Business Hub Enterprise as part of standalone API Management subscription, we now have a new design of the user interface for you to experience. For more information, see [Consume API Proxies](consume-api-proxies-ea561e4.md) and [Configure the API business hub enterprise \[New Design\]](configure-the-api-business-hub-enterprise-new-design-54b4607.md). +If you have added API Business Hub Enterprise as a capability with Integration suite, or if you’ve subscribed to API Business Hub Enterprise as part of standalone API Management subscription, we now have a new design of the user interface for you to experience. For more information, see [Consume API Proxies](consume-api-proxies-ea561e4.md) and [Configure API business hub enterprise](configure-api-business-hub-enterprise-54b4607.md). 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 dd0242b8..079f1aa1 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 @@ -13,7 +13,7 @@ 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 . +> The API Management platform incorporates the circuit breaker pattern to enhance the resilience of the back-end. For more information, see [Circuit Breaker for On-Premise Provider](circuit-breaker-for-on-premise-provider-bd3c2d5.md). ![](images/On-prem_Connectivity_1067d7f.png) diff --git a/docs/apim/API-Management/APIM-Initial-Setup/approve-the-pending-connection-requests-classic-design-b4e6f56.md b/docs/apim/API-Management/APIM-Initial-Setup/approve-the-pending-connection-requests-classic-design-b4e6f56.md deleted file mode 100644 index d49c64fa..00000000 --- a/docs/apim/API-Management/APIM-Initial-Setup/approve-the-pending-connection-requests-classic-design-b4e6f56.md +++ /dev/null @@ -1,47 +0,0 @@ - - - - -# Approve the Pending Connection Requests \[Classic Design\] - -As an API business hub enterprise administrator, you must approve or reject the connection request after you receive them. - - - - - -## Prerequisites - -You’re assigned the *AuthGroup.API.Admin* role. - -> ### 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). - - - -## Procedure - -1. Log on to the *API Business Hub Enterprise*. - -2. Navigate to the *Manage* tab and choose *Manage API Portal Connections* tile. - - The connection requests that are pending for approval are listed on the *Manage API Portal Connections* page. - -3. Choose *View* to read the comments from the requester before approving or rejecting a connection request. - -4. Choose Manage Connections icon in the *Actions* column and choose *Approve*. - - - - - - -## Results - -The connection has been set up between the Integration Suite API portal and the API business hub enterprise. - -**Related Information** - - -[Create a Connection Request for the Centralized API business hub enterprise \[Classic Design\]](create-a-connection-request-for-the-centralized-api-business-hub-enterprise-cla-02f7877.md "Create a request to connect the Integration Suite API Management tenant to the API business hub enterprise. You need to establish this connection to publish the content of the Integration Suite API Management tenant on the API business hub enterprise.") - diff --git a/docs/apim/API-Management/APIM-Initial-Setup/approve-the-pending-connection-requests-new-design-e296f80.md b/docs/apim/API-Management/APIM-Initial-Setup/approve-the-pending-connection-requests-e296f80.md similarity index 75% rename from docs/apim/API-Management/APIM-Initial-Setup/approve-the-pending-connection-requests-new-design-e296f80.md rename to docs/apim/API-Management/APIM-Initial-Setup/approve-the-pending-connection-requests-e296f80.md index 6e6ec6e7..8c31b98c 100644 --- a/docs/apim/API-Management/APIM-Initial-Setup/approve-the-pending-connection-requests-new-design-e296f80.md +++ b/docs/apim/API-Management/APIM-Initial-Setup/approve-the-pending-connection-requests-e296f80.md @@ -2,7 +2,7 @@ -# Approve the Pending Connection Requests \[New Design\] +# Approve the Pending Connection Requests As an API business hub enterprise administrator, you must approve or reject the connection request after you receive them. @@ -16,9 +16,6 @@ You’re assigned the *AuthGroup.API.Admin* role. You’re assigned the *AuthGroup.APIPortalRegistration* role. -> ### Note: -> This document describes the new design of the API business hub enterprise. To view the documentation for the classic design, see [Approve the Pending Connection Requests \[Classic Design\]](approve-the-pending-connection-requests-classic-design-b4e6f56.md). - @@ -42,5 +39,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/centralized-api-business-hub-enterprise-classic-design-33b706f.md b/docs/apim/API-Management/APIM-Initial-Setup/centralized-api-business-hub-enterprise-38422de.md similarity index 62% rename from docs/ISuite/50-Development/centralized-api-business-hub-enterprise-classic-design-33b706f.md rename to docs/apim/API-Management/APIM-Initial-Setup/centralized-api-business-hub-enterprise-38422de.md index 613c60f4..1daf1e31 100644 --- a/docs/ISuite/50-Development/centralized-api-business-hub-enterprise-classic-design-33b706f.md +++ b/docs/apim/API-Management/APIM-Initial-Setup/centralized-api-business-hub-enterprise-38422de.md @@ -1,17 +1,14 @@ - + -# Centralized API business hub enterprise \[Classic Design\] +# Centralized API business hub enterprise -The centralized API business hub enterprise is a central API catalog, allowing application developers to consume APIs and other assets, from a common platform. - -> ### 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). +The API business hub enterprise is a central API catalog, allowing application developers to consume APIs and other assets, from a common platform. > ### 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). +> 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. > ### 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. 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. diff --git a/docs/apim/API-Management/APIM-Initial-Setup/centralized-api-business-hub-enterprise-classic-design-33b706f.md b/docs/apim/API-Management/APIM-Initial-Setup/centralized-api-business-hub-enterprise-classic-design-33b706f.md deleted file mode 100644 index 73dfdce9..00000000 --- a/docs/apim/API-Management/APIM-Initial-Setup/centralized-api-business-hub-enterprise-classic-design-33b706f.md +++ /dev/null @@ -1,24 +0,0 @@ - - -# Centralized API business hub enterprise \[Classic 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. - -> ### 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. - -> ### 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). - -> ### 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. - -> ### 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. - -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. - -The API business hub enterprise admin identifies which existing or new API Business Hub Enterprise application can accept content from multiple API portals. - diff --git a/docs/apim/API-Management/APIM-Initial-Setup/centralized-api-business-hub-enterprise-new-design-38422de.md b/docs/apim/API-Management/APIM-Initial-Setup/centralized-api-business-hub-enterprise-new-design-38422de.md deleted file mode 100644 index 0918fd8f..00000000 --- a/docs/apim/API-Management/APIM-Initial-Setup/centralized-api-business-hub-enterprise-new-design-38422de.md +++ /dev/null @@ -1,23 +0,0 @@ - - -# 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. - -> ### 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. -> -> 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. - -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. - -> ### 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. - -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. - -The API business hub enterprise admin identifies which existing or new API Business Hub Enterprise application can accept content from multiple API portals. - diff --git a/docs/ISuite/circuit-breaker-bd3c2d5.md b/docs/apim/API-Management/APIM-Initial-Setup/circuit-breaker-for-on-premise-provider-bd3c2d5.md similarity index 97% rename from docs/ISuite/circuit-breaker-bd3c2d5.md rename to docs/apim/API-Management/APIM-Initial-Setup/circuit-breaker-for-on-premise-provider-bd3c2d5.md index 2a2166ee..01839695 100644 --- a/docs/ISuite/circuit-breaker-bd3c2d5.md +++ b/docs/apim/API-Management/APIM-Initial-Setup/circuit-breaker-for-on-premise-provider-bd3c2d5.md @@ -1,6 +1,6 @@ -# Circuit Breaker +# Circuit Breaker for On-Premise Provider 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. diff --git a/docs/apim/API-Management/APIM-Initial-Setup/create-a-connection-request-for-the-centralized-api-business-hub-enterprise-new-c7bda8c.md b/docs/apim/API-Management/APIM-Initial-Setup/create-a-connection-request-for-the-centralized-api-business-hub-enterprise-c7bda8c.md similarity index 94% rename from docs/apim/API-Management/APIM-Initial-Setup/create-a-connection-request-for-the-centralized-api-business-hub-enterprise-new-c7bda8c.md rename to docs/apim/API-Management/APIM-Initial-Setup/create-a-connection-request-for-the-centralized-api-business-hub-enterprise-c7bda8c.md index 30104a9c..68279b38 100644 --- a/docs/apim/API-Management/APIM-Initial-Setup/create-a-connection-request-for-the-centralized-api-business-hub-enterprise-new-c7bda8c.md +++ b/docs/apim/API-Management/APIM-Initial-Setup/create-a-connection-request-for-the-centralized-api-business-hub-enterprise-c7bda8c.md @@ -1,6 +1,6 @@ -# Create a Connection Request for the Centralized API business hub enterprise \[New Design\] +# Create a Connection Request for the Centralized API business hub enterprise Create a request to connect the Integration Suite API Management tenant to the API business hub enterprise. You need to establish this connection to publish the content of the Integration Suite API Management tenant on the API business hub enterprise. @@ -65,9 +65,6 @@ For the newly set up Integration Suite API Management tenant, you can request fo To create a request to connect the Integration Suite API Management tenant to the centralized API business hub enterprise. -> ### Note: -> This document describes the new design of the API business hub enterprise. To view the documentation for the classic design, see [Create a Connection Request for the Centralized API business hub enterprise \[Classic Design\]](create-a-connection-request-for-the-centralized-api-business-hub-enterprise-cla-02f7877.md). - diff --git a/docs/apim/API-Management/APIM-Initial-Setup/create-a-connection-request-for-the-centralized-api-business-hub-enterprise-cla-02f7877.md b/docs/apim/API-Management/APIM-Initial-Setup/create-a-connection-request-for-the-centralized-api-business-hub-enterprise-cla-02f7877.md deleted file mode 100644 index f4507520..00000000 --- a/docs/apim/API-Management/APIM-Initial-Setup/create-a-connection-request-for-the-centralized-api-business-hub-enterprise-cla-02f7877.md +++ /dev/null @@ -1,177 +0,0 @@ - - - - -# Create a Connection Request for the Centralized API business hub enterprise \[Classic Design\] - -Create a request to connect the Integration Suite API Management tenant to the API business hub enterprise. You need to establish this connection to publish the content of the Integration Suite API Management tenant on the API business hub enterprise. - - - - - -## Prerequisites - -- 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 . - -- The following role collections should be assigned to you: - - *AuthGroup.API.Admin* - - - *APIPortal.Administrator* - - - *AuthGroup.APIPortalRegistration*: You can't create a connection request, without the *AuthGroup.APIPortalRegistration* role. - - - *APIPortal Service.CatalogIntegration* - - -- Generate the access credentials to establish the connection. To generate the credentials from the Integration Suite API Management tenant, you must have the *APIPortal. Administrator* role assigned to you. - - 1. Log in to the . - - 2. Choose the navigation icon on the left and choose *Settings* \> *APIs*. - - 3. Choose the *Connection* tab. - - 4. Follow the onscreen instructions under *Connect the API Portal to the centralized API Business Hub Enterprise* to generate the Integration Suite API Management tenant access credentials. - - ![](images/ABHE_Connection_a5eb276.png) - - - > ### Note: - > The client credentials get generated for the *APIPortal .Service.CatalogIntegration* role. - - - - -## Context - -The API business hub enterprise administrator identifies which existing or new API business hub enterprise application can accept content from multiple Integration Suite API Management tenants. - -> ### Note: -> Only new API Management subscriptions are allowed to set up a connection with the centralized API business hub enterprise. - -> ### Note: -> You can connect a maximum number of 3 Integration Suite API Management tenants to the centralized API business hub enterprise. - -Create a new subaccount in Cloud Foundry and set up only the Integration Suite API Management tenant. - -For the newly set up Integration Suite API Management tenant, you can request for the API business hub enterprise connection to be established. - -> ### Note: -> The option to disconnect an Integration Suite API Management tenant from an existing API business hub enterprise isn’t supported currently. - -> ### Note: -> Once this connection is set up, you can't place a request to severe this connection and establish a new connection with any other centralized API business hub enterprise. - -> ### Note: -> This document describes the classic design of the API business hub enterprise. To view the documentation for the new design, see [Create a Connection Request for the Centralized API business hub enterprise \[New Design\]](create-a-connection-request-for-the-centralized-api-business-hub-enterprise-new-c7bda8c.md). - - - -## Procedure - -1. Log on to the *API Business Hub Enterprise*. - -2. Navigate to the *Manage* tab and choose *Establish API Portal Connectivity with API Business Hub Enterprise* tile. - -3. Choose :heavy_plus_sign: icon to create a request to connect the Integration Suite API Management tenant to the centralized API business hub enterprise. - - > ### Note: - > Once this connection is set up, you can't place a request to severe this connection and establish a new connection with any other centralized API business hub enterprise. - - Choose *OK* on the *Confirmation* screen to proceed. - -4. Fill in the following details on the *Submit Connection Request* page. - - - - - - - - - - - - - - - - - - - -
- - Parameters - - - - Values - -
- - API Portal Alias Name - - - - Enter the Integration Suite API Management tenant name that gets displayed on the API Business Hub Enterprise. This name is used to distinguish products that are published from the API portal and likewise for applications created for the product. - -
- - API Portal Access Credentials - - - - Enter the Integration Suite API Management tenant access credentials that you generated earlier. These credentials are used by the API business hub enterprise to establish the connection. - - Sample credentials: - - ``` - { - "url": "https://.cfapps.sap.hana.ondemand.com", - "tokenurl": "https://.authentication.sap.hana.ondemand.com/oauth/token", - "certurl": "https://xxxxxx.authentication.cert.sap.hana.ondemand.com", - "certificate": "xxxxxxxxxxxxxxxxxxx", - "key": "xxxxxxxxxxxxxx" - } - ``` - - > ### Note: - > These credentials will remain valid for a period of 65 days. Please make sure to regenerate them and reestablish the connection within this timeframe. - - - -
- - Comment - - - - Provide the details to the approver about the need for the connection request. - -
- -5. Choose *Submit*. - - - - - - -## Results - -You've submitted the connection request to the API business hub enterprise administrator. Once the connection request is approved by the administrator, you can start publishing the Integration Suite API Management tenant content to the API business hub enterprise. - -> ### Note: -> You can log on to the Integration Suite API Management tenant and check the connection status. Navigate to :gear: and choose *Connection*. -> -> You can also choose *Test Connection* to get the details about the connectivity status once your connection request is approved. You will get a connection error, if the destination is deleted or configured incorrectly. In case of an error, retry after revalidating the destination configuration. - -**Related Information** - - -[Approve the Pending Connection Requests \[Classic Design\]](approve-the-pending-connection-requests-classic-design-b4e6f56.md "As an API business hub enterprise administrator, you must approve or reject the connection request after you receive them.") - diff --git a/docs/apim/API-Management/APIM-Initial-Setup/custom-domain-configuration-for-api-portal-or-api-business-hub-enterprise-subsc-c4e67a9.md b/docs/apim/API-Management/APIM-Initial-Setup/custom-domain-configuration-for-api-portal-or-api-business-hub-enterprise-subsc-c4e67a9.md index 71f7e232..813ad84c 100644 --- a/docs/apim/API-Management/APIM-Initial-Setup/custom-domain-configuration-for-api-portal-or-api-business-hub-enterprise-subsc-c4e67a9.md +++ b/docs/apim/API-Management/APIM-Initial-Setup/custom-domain-configuration-for-api-portal-or-api-business-hub-enterprise-subsc-c4e67a9.md @@ -7,9 +7,9 @@ To complete the process of configuring a custom domain for the API portal or the > ### Note: > Custom domain for subscription URLs is available for *API Management, API portal*, *API Management, API business hub enterprise*, and API Management as a capability within the Integration Suite product. -For information on the initial setup of the Custom Domain Service in the Cloud Foundry environment, see [Configuring Custom Domains](https://help.sap.com/viewer/74af813c7ee2457cb5eddca0cc70a0c1/Cloud/en-US/108177aea2a04d1b9006d96173bfa99a.html). +For information on the initial setup of the Custom Domain Service in the Cloud Foundry environment, see [What Is Custom Domain?](https://help.sap.com/docs/CUSTOM_DOMAINS/6f35a23466ee4df0b19085c9c52f9c29/4f4c3ff62fd2413089dce8a973620167.html?version=Cloud). -To map the custom domain to a SAAS application subscription, see [Map a SaaS Application to a Custom Domain](https://help.sap.com/viewer/74af813c7ee2457cb5eddca0cc70a0c1/Cloud/en-US/9f029c0ba0ab496fa2767b607eae924f.html). +To map the custom domain to a SAAS application subscription, see [Manage SaaS Routes](https://help.sap.com/docs/custom-domain/custom-domain-manager/manage-saas-routes?version=Cloud). After mapping a custom domain to a SAAS application subscription using the Custom Domain Service, you need to raise a ticket through the [SAP Support Portal](https://support.sap.com/en/index.html) to complete the SaaS route configuration. diff --git a/docs/ISuite/images/Circuit_Breaker_OPproxy_68cc29e.png b/docs/apim/API-Management/APIM-Initial-Setup/images/Circuit_Breaker_OPproxy_68cc29e.png similarity index 100% rename from docs/ISuite/images/Circuit_Breaker_OPproxy_68cc29e.png rename to docs/apim/API-Management/APIM-Initial-Setup/images/Circuit_Breaker_OPproxy_68cc29e.png 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 a66e5c11..401acda0 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 @@ -78,9 +78,9 @@ You’re registered as an application developer on the API business hub enterpri -[Configure the API business hub enterprise \[Classic Design\]](../configure-the-api-business-hub-enterprise-classic-design-7b71b16.md "You can configure the API business hub enterprise to personalize it for your organization.") +[Configure the API business hub enterprise \[Classic Design\]](https://help.sap.com/viewer/de4066bb3f9240e3bfbcd5614e18c2f9/Cloud/en-US/7b71b166d6984e8f81a212568af5ce94.html "You can configure the API business hub enterprise to personalize it for your organization.") :arrow_upper_right: -[Create an Application \[Classic Design\]](../create-an-application-classic-design-7b4e71b.md "Create an Application to consume the required APIs.") +[Create an Application \[Classic Design\]](https://help.sap.com/viewer/de4066bb3f9240e3bfbcd5614e18c2f9/Cloud/en-US/7b4e71b3887f4396aa22ce3e2ed7e0c3.html "Create an Application to consume the required APIs.") :arrow_upper_right: [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: 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 f089d6ca..2a85ee2c 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 @@ -112,7 +112,7 @@ The API portal is now configured. Log on to the API portal again. You can now cr ## Next Steps -To start publishing the API portal content, you must enable the API Business Hub Enterprise. To publish the API portal content on the API Business Hub Enterprise located in the same subaccount, 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). To publish the API portal content on the centralized API Business Hub Enterprise, follow the on-screen instructions and see [Centralized API business hub enterprise \[Classic Design\]](centralized-api-business-hub-enterprise-classic-design-33b706f.md). +To start publishing the API portal content, you must enable the API Business Hub Enterprise. To publish the API portal content on the API Business Hub Enterprise located in the same subaccount, 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). To publish the API portal content on the centralized API Business Hub Enterprise, follow the on-screen instructions and see [Centralized API business hub enterprise \[Classic Design\]](https://help.sap.com/viewer/de4066bb3f9240e3bfbcd5614e18c2f9/Cloud/en-US/33b706f4f2e148ffb1cb9289d5cda27d.html "The centralized API business hub enterprise is a central API catalog, allowing application developers to consume APIs and other assets, from a common platform.") :arrow_upper_right:. Once API Business Hub Enterprise is set up, navigate to :gear: and choose *Connection*. diff --git a/docs/apim/API-Management/APIM-Initial-Setup/updating-the-connection-request-credentials-for-a-pending-request-new-design-dd37a7b.md b/docs/apim/API-Management/APIM-Initial-Setup/updating-the-connection-request-credentials-for-a-pending-request-dd37a7b.md similarity index 90% rename from docs/apim/API-Management/APIM-Initial-Setup/updating-the-connection-request-credentials-for-a-pending-request-new-design-dd37a7b.md rename to docs/apim/API-Management/APIM-Initial-Setup/updating-the-connection-request-credentials-for-a-pending-request-dd37a7b.md index 98f017e4..7cd8568a 100644 --- a/docs/apim/API-Management/APIM-Initial-Setup/updating-the-connection-request-credentials-for-a-pending-request-new-design-dd37a7b.md +++ b/docs/apim/API-Management/APIM-Initial-Setup/updating-the-connection-request-credentials-for-a-pending-request-dd37a7b.md @@ -1,6 +1,6 @@ -# Updating the Connection Request Credentials for a Pending Request \[New Design\] +# Updating the Connection Request Credentials for a Pending Request Update the credentials you've used to establish a connection between the Integration Suite API Management tenant and the API business hub enterprise. @@ -42,9 +42,6 @@ If you encounter one of the following situations when your connection request is - You've deleted the service instance, or the service key, after the connection request was submitted. In this case, the credentials you used before deleting the service instance or the service key becomes invalid. -> ### Note: -> This document describes the new design of the API business hub enterprise. To view the documentation for the classic design, see [Updating the Connection Request Credentials for a Submitted Request \[Classic Design\]](updating-the-connection-request-credentials-for-a-submitted-request-classic-des-eb84854.md). - diff --git a/docs/apim/API-Management/APIM-Initial-Setup/updating-the-connection-request-credentials-for-a-submitted-request-classic-des-eb84854.md b/docs/apim/API-Management/APIM-Initial-Setup/updating-the-connection-request-credentials-for-a-submitted-request-classic-des-eb84854.md deleted file mode 100644 index b17f69fb..00000000 --- a/docs/apim/API-Management/APIM-Initial-Setup/updating-the-connection-request-credentials-for-a-submitted-request-classic-des-eb84854.md +++ /dev/null @@ -1,85 +0,0 @@ - - -# Updating the Connection Request Credentials for a Submitted Request \[Classic Design\] - -Update the credentials you've used to establish a connection between the Integration Suite API Management tenant and the API business hub enterprise. - - - - - -## Prerequisites - -- 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. - - 1. Log in to the . - - 2. Choose the navigation icon on the left and choose *Settings* \> *APIs*. - - 3. Choose the *Connection* tab. - - 4. Choose *Generate Credentials* under *Connect the API Portal to the centralized API Business Hub Enterprise* and *Copy* the Integration Suite API Management tenant access credentials. - - - > ### Note: - > The client credentials get generated for the *APIPortal .Service.CatalogIntegration* role. - - -You must also have the *AuthGroup.APIPortalRegistration* role assigned to you. - - - -## Context - -The credentials required to access the Integration Suite API Management tenant are shared during the connection request process. - -If you encounter one of the following situations when your connection request is in the submitted state, you have to update the credentials: - -- You have submitted incorrect credentials while raising a connection request, and your request is in pending approval or submitted state. - -- You've deleted the service instance, or the service key, after the connection request was submitted. In this case, the credentials you used before deleting the service instance or the service key becomes invalid. - - -> ### Note: -> This document describes the classic design of the API business hub enterprise. To view the documentation for the new design, see [Updating the Connection Request Credentials for a Pending Request \[New Design\]](updating-the-connection-request-credentials-for-a-pending-request-new-design-dd37a7b.md). - - - -## Procedure - -1. Log on to the *API Business Hub Enterprise*. - -2. Navigate to the *Manage* tab and choose *Establish API Portal Connectivity with API Business Hub Enterprise* tile. - -3. Go to the *Actions* column of the connection request that you want to edit and choose *Edit Credentials*. - -4. On the *Edit Credentials for <* Integration Suite API Management tenant*Alias Name \>* popup, enter the mandatory *API Portal Access Credentials* that you copied earlier from the Integration Suite API Management tenant. - - Sample credentials: - - ``` - { - "url": "https://.cfapps.sap.hana.ondemand.com", - "tokenurl": "https://.authentication.sap.hana.ondemand.com/oauth/token", - "certurl": "https://xxxxxx.authentication.cert.sap.hana.ondemand.com", - "certificate": "xxxxxxxxxxxxxxxxxxx", - "key": "xxxxxxxxxxxxxx" - } - ``` - - > ### Note: - > The credentials required to establish the connection will be valid for 365 days. Please remember to regenerate them 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. - -5. Choose *Save*. - - - - - - -## Results - -You’ve updated the Integration Suite API Management tenant access credentials successfully. - diff --git a/docs/apim/API-Management/APIM-Initial-Setup/updating-the-connection-request-credentials-for-an-approved-request-new-design-882e1d9.md b/docs/apim/API-Management/APIM-Initial-Setup/updating-the-connection-request-credentials-for-an-approved-request-882e1d9.md similarity index 91% rename from docs/apim/API-Management/APIM-Initial-Setup/updating-the-connection-request-credentials-for-an-approved-request-new-design-882e1d9.md rename to docs/apim/API-Management/APIM-Initial-Setup/updating-the-connection-request-credentials-for-an-approved-request-882e1d9.md index e1b2945f..630e661e 100644 --- a/docs/apim/API-Management/APIM-Initial-Setup/updating-the-connection-request-credentials-for-an-approved-request-new-design-882e1d9.md +++ b/docs/apim/API-Management/APIM-Initial-Setup/updating-the-connection-request-credentials-for-an-approved-request-882e1d9.md @@ -1,6 +1,6 @@ -# Updating the Connection Request Credentials for an Approved Request \[New Design\] +# Updating the Connection Request Credentials for an Approved Request There can be instances where you have to update the credentials once the connection request is approved by the API business hub enterprise admin. @@ -39,9 +39,6 @@ If you encounter one of the following situations after the connection request ha - Similarly, if the destination that fetches the API content from the Integration Suite API Management tenant workspace gets deleted, the credentials you were using before the destination got deleted becomes invalid. -> ### Note: -> This document describes the new design of the API business hub enterprise. To view the documentation for the classic design, see [Updating the Connection Request Credentials for an Approved Request \[Classic Design\]](updating-the-connection-request-credentials-for-an-approved-request-classic-des-b583b7a.md). - diff --git a/docs/apim/API-Management/APIM-Initial-Setup/updating-the-connection-request-credentials-for-an-approved-request-classic-des-b583b7a.md b/docs/apim/API-Management/APIM-Initial-Setup/updating-the-connection-request-credentials-for-an-approved-request-classic-des-b583b7a.md deleted file mode 100644 index 2e2adf72..00000000 --- a/docs/apim/API-Management/APIM-Initial-Setup/updating-the-connection-request-credentials-for-an-approved-request-classic-des-b583b7a.md +++ /dev/null @@ -1,84 +0,0 @@ - - -# Updating the Connection Request Credentials for an Approved Request \[Classic Design\] - -There can be instances where you have to update the credentials once the connection request is approved by the API business hub enterprise admin. - - - - - -## Prerequisites - -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 . - -2. Choose the navigation icon on the left and choose *Settings* \> *APIs*. - -3. Choose the *Connection* tab. - -4. Choose *Regenerate Credentials* and *Copy* the access credentials. - - -> ### Note: -> The client credentials get generated for *APIPortal .Service.CatalogIntegration* role. - - - - - -## Context - -To establish the connection between the API Management tenant and the API business hub enterprise, the Client ID and Client Secret created for the API Management tenant is shared during the connection request process. - -If you encounter one of the following situations after the connection request has already been approved by the API business hub enterprise admin, you have to update the credentials: - -- The service instance, or the service key gets deleted after the connection between the API Management tenant and the API business hub enterprise was established. In this case, the credentials you were using before the service instance or the service key got deleted becomes invalid. - -- Similarly, if the destination that fetches the API content from theAPI Management tenant workspace gets deleted, the credentials you were using before the destination got deleted becomes invalid. - - -> ### Note: -> This document describes the classic design of the API business hub enterprise. To view the documentation for the new design, see [Updating the Connection Request Credentials for an Approved Request \[New Design\]](updating-the-connection-request-credentials-for-an-approved-request-new-design-882e1d9.md). - - - - - -## Procedure - -1. Log on to the *API Business Hub Enterprise*. - -2. Navigate to the *Manage* tab and choose *Establish API Portal Connectivity with API Business Hub Enterprise* tile. - -3. Go to the *Actions* column and select the approved connection request that you want to edit and choose *Re-establish Connection*. - -4. On the *Submit Connection Request* page, enter the *Client ID* and *Client Secret* that you copied earlier from the API Portal. - - Sample credentials: - - ``` - { - "url": "https://.cfapps.sap.hana.ondemand.com", - "tokenurl": "https://.authentication.sap.hana.ondemand.com/oauth/token", - "certurl": "https://xxxxxx.authentication.cert.sap.hana.ondemand.com", - "certificate": "xxxxxxxxxxxxxxxxxxx", - "key": "xxxxxxxxxxxxxx" - } - ``` - - > ### Note: - > The credentials required to establish the connection will be valid for 365 days. Please remember to regenerate them 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. - -5. Choose *Save*. - - - - - - -## Results - -You’ve updated the Integration Suite API portal access credentials successfully. - diff --git a/docs/apim/API-Management/APIM-Migration/clone-api-management-content-7abd887.md b/docs/apim/API-Management/APIM-Migration/clone-api-management-content-7abd887.md index d5d050a6..44688ecf 100644 --- a/docs/apim/API-Management/APIM-Migration/clone-api-management-content-7abd887.md +++ b/docs/apim/API-Management/APIM-Migration/clone-api-management-content-7abd887.md @@ -4,7 +4,7 @@ Clone the API Management content using the Tenant Cloning tool. -Once you have your source and target system ready, you can clone your API Management content to the target system by running the Tenant Cloning Tool that you downloaded from [here](https://help.sap.com/docs/link-disclaimer?site=https%3A%2F%2Frepo1.maven.org%2Fmaven2%2Fcom%2Fsap%2Fapimgmt%2Fapim-tct-sdk%2F1.8.2%2Fapim-tct-sdk-1.8.2.zip). +Once you have your source and target system ready, you can clone your API Management content to the target system by running the Tenant Cloning Tool that you downloaded from [here](https://help.sap.com/docs/link-disclaimer?site=https%3A%2F%2Frepo1.maven.org%2Fmaven2%2Fcom%2Fsap%2Fapimgmt%2Fapim-tct-sdk%2F1.8.3%2Fapim-tct-sdk-1.8.3.zip). @@ -63,7 +63,38 @@ Once you have your source and target system ready, you can clone your API Manage - + + +## Context + +To migrate all API Management entities, you need to complete the apim-tct-input.json file in the tenant cloning tool by providing all the necessary details. + +In case you want to migrate selected API proxies from the source API Management tenant to the target API Management tenant, make the following configurations in the `apim-tct-input.json` file: + +- Set `selectiveEntityMigration` to `true` + +- Provide the names of the API proxies in `selectiveEntities`, separated by commas. + + +For more information, see [selectiveEntityMigration](clone-api-management-content-7abd887.md#loio7abd887d54604e699543ef57c618c8d7__selective_entity_migration) and [selectiveEntities](clone-api-management-content-7abd887.md#loio7abd887d54604e699543ef57c618c8d7__selective_entities). + +By enabling this feature, you can explicitly clone the API proxies mentioned in the configuration file from the source to the target tenant. The cloning process will occur in the following sequence: + +- Certificate stores + +- Key value maps entries + +- API providers + +- API proxies + + +> ### Note: +> If `selectiveEntityMigration` is set to `true`, only the certificate stores, key-value maps, API providers, and API proxies will be migrated. Other entities such as products and applications will not be migrated. If it is set to `false` or not available in the `apim-tct-input.json` file, all entities will be considered for migration. +> +> The `selectiveEntityMigration` parameter is optional. + + ## Procedure @@ -95,6 +126,11 @@ Once you have your source and target system ready, you can clone your API Manage + Supported Values + + + + Required/Optional @@ -132,6 +168,11 @@ Once you have your source and target system ready, you can clone your API Manage +   + + + + Required @@ -139,7 +180,7 @@ Once you have your source and target system ready, you can clone your API Manage URL of the source API management, API portal in the Neo environment - Example: `https://-.` + `https://-.` @@ -161,6 +202,11 @@ Once you have your source and target system ready, you can clone your API Manage +   + + + + Optional @@ -185,6 +231,11 @@ Once you have your source and target system ready, you can clone your API Manage +   + + + + Optional @@ -219,6 +270,11 @@ Once you have your source and target system ready, you can clone your API Manage +   + + + + Required @@ -248,6 +304,11 @@ Once you have your source and target system ready, you can clone your API Manage +   + + + + Optional @@ -272,6 +333,11 @@ Once you have your source and target system ready, you can clone your API Manage +   + + + + Optional @@ -291,7 +357,7 @@ Once you have your source and target system ready, you can clone your API Manage - Supported values: "guid" +   @@ -306,6 +372,11 @@ Once you have your source and target system ready, you can clone your API Manage + Supported values: "guid" + + + + Optional @@ -358,6 +429,11 @@ Once you have your source and target system ready, you can clone your API Manage +   + + + + Required @@ -385,6 +461,11 @@ Once you have your source and target system ready, you can clone your API Manage +   + + + + Required @@ -407,6 +488,11 @@ Once you have your source and target system ready, you can clone your API Manage +   + + + + Optional @@ -431,6 +517,11 @@ Once you have your source and target system ready, you can clone your API Manage +   + + + + Optional @@ -460,6 +551,11 @@ Once you have your source and target system ready, you can clone your API Manage +   + + + + Optional @@ -482,6 +578,11 @@ Once you have your source and target system ready, you can clone your API Manage +   + + + + Optional @@ -504,6 +605,11 @@ Once you have your source and target system ready, you can clone your API Manage +   + + + + Optional @@ -526,6 +632,11 @@ Once you have your source and target system ready, you can clone your API Manage +   + + + + Optional @@ -563,6 +674,11 @@ Once you have your source and target system ready, you can clone your API Manage +   + + + + Required @@ -585,6 +701,11 @@ Once you have your source and target system ready, you can clone your API Manage +   + + + + Required @@ -607,6 +728,11 @@ Once you have your source and target system ready, you can clone your API Manage +   + + + + Optional @@ -631,6 +757,11 @@ Once you have your source and target system ready, you can clone your API Manage +   + + + + Optional @@ -660,6 +791,11 @@ Once you have your source and target system ready, you can clone your API Manage +   + + + + Optional @@ -682,6 +818,11 @@ Once you have your source and target system ready, you can clone your API Manage +   + + + + Optional @@ -704,6 +845,11 @@ Once you have your source and target system ready, you can clone your API Manage +   + + + + Optional @@ -726,6 +872,11 @@ Once you have your source and target system ready, you can clone your API Manage +   + + + + Optional @@ -763,6 +914,11 @@ Once you have your source and target system ready, you can clone your API Manage +   + + + + Required @@ -785,6 +941,11 @@ Once you have your source and target system ready, you can clone your API Manage +   + + + + Required @@ -807,6 +968,11 @@ Once you have your source and target system ready, you can clone your API Manage +   + + + + Optional @@ -831,6 +997,11 @@ Once you have your source and target system ready, you can clone your API Manage +   + + + + Optional @@ -860,6 +1031,11 @@ Once you have your source and target system ready, you can clone your API Manage +   + + + + Optional @@ -882,6 +1058,11 @@ Once you have your source and target system ready, you can clone your API Manage +   + + + + Optional @@ -904,6 +1085,11 @@ Once you have your source and target system ready, you can clone your API Manage +   + + + + Optional @@ -926,6 +1112,11 @@ Once you have your source and target system ready, you can clone your API Manage +   + + + + Optional @@ -948,7 +1139,7 @@ Once you have your source and target system ready, you can clone your API Manage - Supported values: `true/false` +   @@ -963,6 +1154,11 @@ Once you have your source and target system ready, you can clone your API Manage + Supported values: `true/false` + + + + Optional @@ -991,7 +1187,7 @@ Once you have your source and target system ready, you can clone your API Manage - Supported values: `true/false` +   @@ -1006,6 +1202,11 @@ Once you have your source and target system ready, you can clone your API Manage + Supported values: `true/false` + + + + Optional @@ -1033,7 +1234,7 @@ Once you have your source and target system ready, you can clone your API Manage - Supported values: `true/false` +   @@ -1048,6 +1249,11 @@ Once you have your source and target system ready, you can clone your API Manage + Supported values: `true/false` + + + + Optional @@ -1068,7 +1274,7 @@ Once you have your source and target system ready, you can clone your API Manage - Supported values: `true/false` +   @@ -1083,6 +1289,11 @@ Once you have your source and target system ready, you can clone your API Manage + Supported values: `true/false` + + + + Optional @@ -1108,7 +1319,7 @@ Once you have your source and target system ready, you can clone your API Manage - Supported values: `"DEFAULT" | "SWITCHOVER` +   @@ -1123,6 +1334,11 @@ Once you have your source and target system ready, you can clone your API Manage + Supported values: `"DEFAULT" | "SWITCHOVER` + + + + Optional @@ -1130,6 +1346,107 @@ Once you have your source and target system ready, you can clone your API Manage The supported values for this parameter is either default or switchover. + + + + + + selectiveEntityMigration + + + + +   + + + + +   + + + + +   + + + + + Boolean + + + + + Supported values: true/false + + + + + Optional + + + + + If you want to migrate API proxies selectively, please set this flag to 'true'. + + > ### Note: + > Once this flag is set to 'true', please ensure that the *selectiveEntities* parameter is not left empty. + + + + + + + + + selectiveEntities + + + + + API proxies + + + + +   + + + + +   + + + + + Enter the list of API proxy names in a comma-separated manner as shown below. + + + + +   + + + + + Optional + + + + + Enter the API proxies that you want to migrate. + + > ### Sample Code: + > ``` + > "selectiveEntityMigration": true, + > "selectiveEntities": { + > "APIProxies": [ + > "SCpayload", "SetTLSPropertiesAsPayload", "newproxy" + > ] + > } + > ``` + + + @@ -1200,7 +1517,7 @@ Once you have your source and target system ready, you can clone your API Manage 2. Run the following commands from your Java command-line interface to verify the setup and check the version of the tool. This is an optional step. - To verify the setup: - `java -jar apim-tct-client-.jar verify` + `java -jar apim-tct-client-.jar verifyExample:` - To check the version of the tenant cloning tool you’re using: @@ -1215,7 +1532,7 @@ Once you have your source and target system ready, you can clone your API Manage Your API Management entities are now cloned to your target system. - An excel file named `apimtct-output.xlsx` and a log file named `apimtct-logs.log` are generated in the same folder where the .jar file is present. + Example:An excel file named `apimtct-output.xlsx` and a log file named `apimtct-logs.log` are generated in the same folder where the .jar file is present. The status of each cloned entity is stored in a separate worksheet within the output excel file. diff --git a/docs/apim/API-Management/APIM-Migration/clone-api-management-content-for-cloud-foundry-to-cloud-foundry-migration-2e5d127.md b/docs/apim/API-Management/APIM-Migration/clone-api-management-content-between-cloud-foundry-environments-2e5d127.md similarity index 84% rename from docs/apim/API-Management/APIM-Migration/clone-api-management-content-for-cloud-foundry-to-cloud-foundry-migration-2e5d127.md rename to docs/apim/API-Management/APIM-Migration/clone-api-management-content-between-cloud-foundry-environments-2e5d127.md index 0a241384..2deff964 100644 --- a/docs/apim/API-Management/APIM-Migration/clone-api-management-content-for-cloud-foundry-to-cloud-foundry-migration-2e5d127.md +++ b/docs/apim/API-Management/APIM-Migration/clone-api-management-content-between-cloud-foundry-environments-2e5d127.md @@ -1,10 +1,10 @@ -# 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. -Once you have your source and target system ready, you can clone your API Management content to the target system by running the Tenant Cloning Tool that you downloaded from [here](https://help.sap.com/docs/link-disclaimer?site=https%3A%2F%2Frepo1.maven.org%2Fmaven2%2Fcom%2Fsap%2Fapimgmt%2Fapim-tct-sdk%2F1.8.2%2Fapim-tct-sdk-1.8.2.zip). +Once you have your source and target system ready, you can clone your API Management content to the target system by running the Tenant Cloning Tool that you downloaded from [here](https://help.sap.com/docs/link-disclaimer?site=https%3A%2F%2Frepo1.maven.org%2Fmaven2%2Fcom%2Fsap%2Fapimgmt%2Fapim-tct-sdk%2F1.8.3%2Fapim-tct-sdk-1.8.3.zip). @@ -52,7 +52,7 @@ Once you have your source and target system ready, you can clone your API Manage - Open the default terminal from your system. - Go to the `apim-tct` folder in the terminal. -- Run the `chmod +x download_dependencies.sh` command to make the file executable. +- Run the `chmod +x download_dependencies.sh` - Run the `.\download_dependencies.sh` command. The required libraries are downloaded to the `lib` folder. @@ -63,7 +63,38 @@ Once you have your source and target system ready, you can clone your API Manage - + + +## Context + +To migrate all API Management entities, you need to complete the apim-tct-input.json file in the tenant cloning tool by providing all the necessary details. command to make the file executable. + +In case you want to migrate selected API proxies from the source API Management tenant to the target API Management tenant, make the following configurations in the `apim-tct-input.json` file: + +- Set `selectiveEntityMigration` to `true` + +- Provide the names of the API proxies in `selectiveEntities`, separated by commas. + + +For more informarmation, see [selectiveEntityMigration](clone-api-management-content-between-cloud-foundry-environments-2e5d127.md#loio2e5d127a13fc4a3cbba26bfd5ae44e69__selective_entity_migration) and [selectiveEntities](clone-api-management-content-between-cloud-foundry-environments-2e5d127.md#loio2e5d127a13fc4a3cbba26bfd5ae44e69__selective_entities). + +By enabling this feature, you can explicitly clone the API proxies mentioned in the configuration file from the source to the target. The cloning process will occur in the following sequence: + +- Certificate stores + +- Key value maps + +- API providers + +- API proxies + + +> ### Note: +> If `selectiveEntityMigration` is set to `true`, only the above entities will be migrated. Other entities such as products and applications will not be migrated. If it is set to `false` or not available in the `apim-tct-input.json` file, all entities will be considered for migration. +> +> The `selectiveEntityMigration` parameter is optional. + + ## Procedure @@ -95,6 +126,11 @@ Once you have your source and target system ready, you can clone your API Manage + Supported Values + + + + Required/Optional @@ -137,6 +173,11 @@ Once you have your source and target system ready, you can clone your API Manage +   + + + + Required @@ -164,6 +205,11 @@ Once you have your source and target system ready, you can clone your API Manage +   + + + + Optional @@ -186,6 +232,11 @@ Once you have your source and target system ready, you can clone your API Manage +   + + + + Optional @@ -212,6 +263,11 @@ Once you have your source and target system ready, you can clone your API Manage +   + + + + Optional @@ -241,6 +297,11 @@ Once you have your source and target system ready, you can clone your API Manage +   + + + + Required @@ -263,6 +324,11 @@ Once you have your source and target system ready, you can clone your API Manage +   + + + + Required @@ -285,6 +351,11 @@ Once you have your source and target system ready, you can clone your API Manage +   + + + + Required @@ -307,6 +378,11 @@ Once you have your source and target system ready, you can clone your API Manage +   + + + + Required @@ -344,6 +420,11 @@ Once you have your source and target system ready, you can clone your API Manage +   + + + + Required @@ -371,6 +452,11 @@ Once you have your source and target system ready, you can clone your API Manage +   + + + + Optional @@ -393,6 +479,11 @@ Once you have your source and target system ready, you can clone your API Manage +   + + + + Optional @@ -417,6 +508,11 @@ Once you have your source and target system ready, you can clone your API Manage +   + + + + Optional @@ -446,6 +542,11 @@ Once you have your source and target system ready, you can clone your API Manage +   + + + + Optional @@ -468,6 +569,11 @@ Once you have your source and target system ready, you can clone your API Manage +   + + + + Optional @@ -490,6 +596,11 @@ Once you have your source and target system ready, you can clone your API Manage +   + + + + Optional @@ -512,6 +623,11 @@ Once you have your source and target system ready, you can clone your API Manage +   + + + + Optional @@ -529,7 +645,7 @@ Once you have your source and target system ready, you can clone your API Manage - Supported values: "guid" +   @@ -544,6 +660,11 @@ Once you have your source and target system ready, you can clone your API Manage + Supported values: "guid" + + + + Not Applicable @@ -586,6 +707,11 @@ Once you have your source and target system ready, you can clone your API Manage +   + + + + Required @@ -613,6 +739,11 @@ Once you have your source and target system ready, you can clone your API Manage +   + + + + Required @@ -635,6 +766,11 @@ Once you have your source and target system ready, you can clone your API Manage +   + + + + Optional @@ -659,6 +795,11 @@ Once you have your source and target system ready, you can clone your API Manage +   + + + + Optional @@ -688,6 +829,11 @@ Once you have your source and target system ready, you can clone your API Manage +   + + + + Optional @@ -710,6 +856,11 @@ Once you have your source and target system ready, you can clone your API Manage +   + + + + Optional @@ -732,6 +883,11 @@ Once you have your source and target system ready, you can clone your API Manage +   + + + + Optional @@ -754,6 +910,11 @@ Once you have your source and target system ready, you can clone your API Manage +   + + + + Optional @@ -791,6 +952,11 @@ Once you have your source and target system ready, you can clone your API Manage +   + + + + Required @@ -818,6 +984,11 @@ Once you have your source and target system ready, you can clone your API Manage +   + + + + Required @@ -840,6 +1011,11 @@ Once you have your source and target system ready, you can clone your API Manage +   + + + + Optional @@ -864,6 +1040,11 @@ Once you have your source and target system ready, you can clone your API Manage +   + + + + Optional @@ -893,6 +1074,11 @@ Once you have your source and target system ready, you can clone your API Manage +   + + + + Optional @@ -915,6 +1101,11 @@ Once you have your source and target system ready, you can clone your API Manage +   + + + + Optional @@ -937,6 +1128,11 @@ Once you have your source and target system ready, you can clone your API Manage +   + + + + Optional @@ -959,6 +1155,11 @@ Once you have your source and target system ready, you can clone your API Manage +   + + + + Optional @@ -981,7 +1182,7 @@ Once you have your source and target system ready, you can clone your API Manage - Supported values: `true/false` +   @@ -996,6 +1197,11 @@ Once you have your source and target system ready, you can clone your API Manage + Supported values: `true/false` + + + + Optional @@ -1026,7 +1232,7 @@ Once you have your source and target system ready, you can clone your API Manage - Supported values: `true/false` +   @@ -1041,6 +1247,11 @@ Once you have your source and target system ready, you can clone your API Manage + Supported values: `true/false` + + + + Optional @@ -1061,7 +1272,7 @@ Once you have your source and target system ready, you can clone your API Manage - Supported values: `true/false` +   @@ -1076,6 +1287,11 @@ Once you have your source and target system ready, you can clone your API Manage + Supported values: `true/false` + + + + Optional @@ -1101,7 +1317,7 @@ Once you have your source and target system ready, you can clone your API Manage - Supported values: `"DEFAULT" | "SWITCHOVER` +   @@ -1116,6 +1332,11 @@ Once you have your source and target system ready, you can clone your API Manage + Supported values: `"DEFAULT" | "SWITCHOVER` + + + + Optional @@ -1123,6 +1344,107 @@ Once you have your source and target system ready, you can clone your API Manage The default values for this parameter is supported. Switchover is not applicable for this scenario. + + + + + + selectiveEntityMigration + + + + +   + + + + +   + + + + +   + + + + + Boolean + + + + + Supported values: true/false + + + + + Optional + + + + + If you want to migrate API proxies selectively, please set this flag to 'true'. + + > ### Note: + > Once this flag is set to 'true', please ensure that the *selectiveEntities* parameter is not left empty. + + + + + + + + + selectiveEntities + + + + + API proxies + + + + +   + + + + +   + + + + + Enter the list of API proxy names in a comma-separated manner as shown below. + + + + +   + + + + + Optional + + + + + Enter the API proxies that you want to migrate. + + > ### Sample Code: + > ``` + > "selectiveEntityMigration": true, + > "selectiveEntities": { + > "APIProxies": [ + > "SCpayload", "SetTLSPropertiesAsPayload", "newproxy" + > ] + > } + > ``` + + + @@ -1318,8 +1640,6 @@ Once you have your source and target system ready, you can clone your API Manage - - ## Next Steps After the cloning process completes, you must perform the tasks mentioned in the `User Actions` worksheet within the output excel file `apimtct-output.xlsx`. diff --git a/docs/apim/API-Management/APIM-Migration/post-cloning-tasks-49e9716.md b/docs/apim/API-Management/APIM-Migration/post-cloning-tasks-49e9716.md index afaa757b..4379acc0 100644 --- a/docs/apim/API-Management/APIM-Migration/post-cloning-tasks-49e9716.md +++ b/docs/apim/API-Management/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](../APIM-Initial-Setup/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](../APIM-Initial-Setup/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 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](../APIM-Initial-Setup/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](../APIM-Initial-Setup/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 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/apim/API-Management/APIM-Migration/prerequisites-for-the-source-and-the-target-system-1b181dd.md b/docs/apim/API-Management/APIM-Migration/prerequisites-for-the-source-and-the-target-system-1b181dd.md index f647fa78..91a237e6 100644 --- a/docs/apim/API-Management/APIM-Migration/prerequisites-for-the-source-and-the-target-system-1b181dd.md +++ b/docs/apim/API-Management/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/apim/API-Management/access-control-3f72aea.md b/docs/apim/API-Management/access-control-3f72aea.md index c76ed675..248b8070 100644 --- a/docs/apim/API-Management/access-control-3f72aea.md +++ b/docs/apim/API-Management/access-control-3f72aea.md @@ -177,6 +177,38 @@ The default value is `ALLOW`. + + + + + +ValidateBasedOn \(Optional\) + + + + +To determine which IP addresses should be evaluated, utilize the ValidateBasedOn element when the X-Forwarded-For HTTP header contains multiple IP addresses. + +Valid value: X\_FORWARDED\_FOR\_ALL\_IP, X\_FORWARDED\_FOR\_FIRST\_IP, X\_FORWARDED\_FOR\_LAST\_IP + +The default value is `X_FORWARDED_FOR_FIRST_IP`. + +> ### Sample Code: +> ``` +> +> +> 120.75.68.75 +> +> +> 120.75.68.75 +> +> +> X_FORWARDED_FOR_ALL_IP +> +> ``` + + + diff --git a/docs/apim/API-Management/archive-2023-a8dd11f.md b/docs/apim/API-Management/archive-2023-a8dd11f.md index 53cfb5f9..5c873b82 100644 --- a/docs/apim/API-Management/archive-2023-a8dd11f.md +++ b/docs/apim/API-Management/archive-2023-a8dd11f.md @@ -619,7 +619,7 @@ 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). +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\]](https://help.sap.com/viewer/de4066bb3f9240e3bfbcd5614e18c2f9/Cloud/en-US/02f7877360a64c6b8d853fed9b2d9cc6.html "To publish the API portal content on the API business hub enterprise, you must create a request to connect the API portal to the API business hub enterprise.") :arrow_upper_right: and [Create a Connection Request for the Centralized API business hub enterprise](APIM-Initial-Setup/create-a-connection-request-for-the-centralized-api-business-hub-enterprise-c7bda8c.md). @@ -941,7 +941,7 @@ 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). +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 between Cloud Foundry Environments](APIM-Migration/clone-api-management-content-between-cloud-foundry-environments-2e5d127.md). @@ -1005,7 +1005,7 @@ 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). +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 between Cloud Foundry Environments](APIM-Migration/clone-api-management-content-between-cloud-foundry-environments-2e5d127.md). @@ -1261,7 +1261,7 @@ 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). +\[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](manage-domain-categories-bd9691d.md). @@ -1325,7 +1325,7 @@ 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). +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](manage-notifications-df32457.md). @@ -1389,7 +1389,7 @@ 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). +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](APIM-Initial-Setup/updating-the-connection-request-credentials-for-a-pending-request-dd37a7b.md) and [Updating the Connection Request Credentials for a Submitted Request \[Classic Design\]](https://help.sap.com/viewer/de4066bb3f9240e3bfbcd5614e18c2f9/Cloud/en-US/eb84854e31d943b490af77cfb218ddbb.html "Update the credentials you've used to establish a connection between the API portal and the API business hub enterprise.") :arrow_upper_right:. diff --git a/docs/apim/API-Management/assign-permission-to-a-product-via-ui-09fb892.md b/docs/apim/API-Management/assign-permission-to-a-product-via-ui-09fb892.md index 7e734f74..540a2a3a 100644 --- a/docs/apim/API-Management/assign-permission-to-a-product-via-ui-09fb892.md +++ b/docs/apim/API-Management/assign-permission-to-a-product-via-ui-09fb892.md @@ -22,7 +22,7 @@ Whenever you create a product or edit a draft product, permissions can be added > ### Note: > Currently, we do not support assigning of permissions to the products defined in the remote API portals that are connected to a centralised API business hub enterprise. > -> \*Remote API portals are those that are not in the same subaccount as the centralised API business hub enterprise and are configured via the manage connections. For more information, [Centralized API business hub enterprise \[New Design\]](APIM-Initial-Setup/centralized-api-business-hub-enterprise-new-design-38422de.md) and [Centralized API business hub enterprise \[Classic Design\]](APIM-Initial-Setup/centralized-api-business-hub-enterprise-classic-design-33b706f.md). +> \*Remote API portals are those that are not in the same subaccount as the centralised API business hub enterprise and are configured via the manage connections. For more information, [Centralized API business hub enterprise](APIM-Initial-Setup/centralized-api-business-hub-enterprise-38422de.md) and [Centralized API business hub enterprise \[Classic Design\]](https://help.sap.com/viewer/de4066bb3f9240e3bfbcd5614e18c2f9/Cloud/en-US/33b706f4f2e148ffb1cb9289d5cda27d.html "The centralized API business hub enterprise is a central API catalog, allowing application developers to consume APIs and other assets, from a common platform.") :arrow_upper_right:. diff --git a/docs/apim/API-Management/auditing-and-logging-information-for-api-management-77024b3.md b/docs/apim/API-Management/auditing-and-logging-information-for-api-management-77024b3.md index 9a2038f5..1a64e416 100644 --- a/docs/apim/API-Management/auditing-and-logging-information-for-api-management-77024b3.md +++ b/docs/apim/API-Management/auditing-and-logging-information-for-api-management-77024b3.md @@ -320,7 +320,7 @@ Example: -[Create an Application \[Classic Design\]](create-an-application-classic-design-7b4e71b.md) +[Create an Application \[Classic Design\]](https://help.sap.com/viewer/de4066bb3f9240e3bfbcd5614e18c2f9/Cloud/en-US/7b4e71b3887f4396aa22ce3e2ed7e0c3.html "Create an Application to consume the required APIs.") :arrow_upper_right: diff --git a/docs/apim/API-Management/configure-api-business-hub-enterprise-54b4607.md b/docs/apim/API-Management/configure-api-business-hub-enterprise-54b4607.md new file mode 100644 index 00000000..620418d0 --- /dev/null +++ b/docs/apim/API-Management/configure-api-business-hub-enterprise-54b4607.md @@ -0,0 +1,243 @@ + + +# Configure API business hub enterprise + +You can configure and customize the API business hub enterprise to suit your organization's needs. + + + + + +## Key Actions for Admins in API business hub enterprise + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +As... + + + +You can use the… + + + +For more information, see… + +
+ +An *API Admin*, you already have the *AuthGroup.API.Admin* role assigned to you. + + + +*Home Page* to browse and search through the various categories, APIs, and products available. + + + +[Register on API business hub enterprise](register-on-api-business-hub-enterprise-c85fafe.md) + +
+ +*My Workspace* to perform the following actions on behalf of an application developer: + +- Create, update, and delete applications + +- Create custom attributes for applications + +- Provide app key and secret, while creating or updating an application + +- View and access all the applications created in API business hub enterprise +- Monitor costs + +- Analyze reports + + + + + + +[Creating an Application with API business hub enterprise Administrator Role](creating-an-application-with-api-business-hub-enterprise-administrator-role-df4f777.md) + +
+ +*Enterprise Manager* \> *Manage External Content* to adjust the visibility of the Graph navigator on the API business hub enterprise. + + + +[Manage External Content](https://help.sap.com/docs/integration-suite/sap-integration-suite/manage-external-content-new-design?version=CLOUD&q=Exyternal%20Content) + +
+ +*Enterprise Manager* \> *Manage Access* 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. + + + +[Manage Developer Access](manage-developer-access-9df3ece.md) + +
+ +*Enterprise Manager* \> *Manage Users* to add and revoke user access to the API business hub enterprise. + + + +[Managing the Access Request of the Users \[New Design\]](managing-the-access-request-of-the-users-new-design-8b79ee8.md) + +[Revoke Access \[New Design\]](revoke-access-new-design-ce609bb.md) + +
+ +*Enterprise Manager* \> *Manage API Management Connections* to approve and reject the pending connection requests and update the API portal access credentials. + +> ### Note: +> Additinally, the *AuthGroup.APIPortalRegistration* role must be assigned to you to perform the above actions. + + + + + +[Approve the Pending Connection Requests](APIM-Initial-Setup/approve-the-pending-connection-requests-e296f80.md) + +
+ +A *Site Admin* you already have the *AuthGroup.Site.Admin* role assigned to you. + + + +*Site Editor* to customize the visual layout of the API business hub enterprise. + + + +[Customize the Visual Format of the API business hub enterprise](customize-the-visual-format-of-the-api-business-hub-enterprise-2eacd52.md) + +
+ +*Enterprise Manager* \> *Manage Notifications* to configure notifications to keep the end users of the API business hub enterprise informed about website updates and news items. + + + +[Manage Notifications](manage-notifications-df32457.md) + +
+ +A *Content Admin* you already have the *AuthGroup.Content.Admin* role assigned to you. + + + +*Enterprise Manager* \> *Manage Domain Categories* to create domain categories and add the related products into relevant categories. + +> ### Note: +> Additinally, the *AuthGroup.API.Admin* role must be assigned to you to perform the above actions. + + + + + +[Manage Domain Categories](manage-domain-categories-bd9691d.md) + +
+ + + + + +## Key Actions for Application Developers inAPI business hub enterprise + + + + + + + + + + + + + + + + + +
+ +As... + + + +You can use… + + + +For more information, see… + +
+ +An *Application Developer* you already have the *AuthGroup.API.ApplicationDeveloper* role assigned to you. + +> ### Note: +> The *AuthGroup.API.ApplicationDeveloper* role is assigned by default to a user who onboards to the API business hub enterprise using the Self-registration process or via *Add User* flow. + + + + + +*My Workspace* to create applications, view your applications, monitor costs, and analyze reports. + + + +[Creating an Application with Application Developer Role](creating-an-application-with-application-developer-role-99515fc.md) + +
+ +*Test Environment* to test the runtime behaviour of APIs. + + + +[Test Runtime Behavior of APIs](test-runtime-behavior-of-apis-15c7d52.md) + +
+ diff --git a/docs/apim/API-Management/configure-the-api-business-hub-enterprise-classic-design-7b71b16.md b/docs/apim/API-Management/configure-the-api-business-hub-enterprise-classic-design-7b71b16.md deleted file mode 100644 index 3cd7a4fa..00000000 --- a/docs/apim/API-Management/configure-the-api-business-hub-enterprise-classic-design-7b71b16.md +++ /dev/null @@ -1,207 +0,0 @@ - - -# Configure the API business hub enterprise \[Classic Design\] - -You can configure the API business hub enterprise to personalize it for your organization. - -> ### 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 [Configure the API business hub enterprise \[New Design\]](configure-the-api-business-hub-enterprise-new-design-54b4607.md). - - - -Select *Manage* from the banner. Modify the following sections to personalize the API business hub enterprise. - -The prerequisite varies for each section. Sections are visible to the user based on the role assigned to the user. For example, *General* section is visible to only users assigned with site admin role. For more information on API business hub enterprise user roles, see [Assigning User Roles](https://help.sap.com/docs/SAP_CLOUD_PLATFORM_API_MANAGEMENT/66d066d903c2473f81ec33acfe2ccdb4/911ca5a620e94ab581fa159d76b3b108.html?q=Assign%20User%20Roles). - - - -### General - -Prerequisite: You are assigned the site admin role. - - - - - - - - - - - - - - - -
- -Section - - - -Description - -
- -Company Logo - - - -Upload an image file for your logo, and save the changes. - -
- -Color Scheme - - - -Information about the color scheme used. - -When you upload a logo, the dark color of the navigation area at the top of the screens is replaced with white, since many logos require a white background. - -Other colors on the Web site are changed to neutral tones to avoid visual conflicts with your company's logo colors. - -
- - - -### *Home Page* - -Prerequisite: - -- You are assigned the *AuthGroup.Site.Admin* role to view the following sections: *Name and Description* and *Updates*. - -- You are assigned the content admin role to view *Navigation Categories*. - - -From the homepage, you can view and search the categories, APIs, and products. - - - - - - - - - - - - - - - - - - - -
- -Section - - - -Description - -
- -Name and Description - - - -Edit the default name and description for your application. - -
- -Updates - - - -Configure updates to be displayed on the Home page. For more information on how to add, edit, or delete an update, see [Manage Updates \[Classic Design\]](manage-updates-classic-design-94e37b4.md). - -
- -Navigation Categories - - - -Configure navigation categories to be displayed on the Home page. For more information on how to add, edit, or delete a category, see [Manage Navigation Categories \[Classic Design\]](manage-navigation-categories-classic-design-7f1a44b.md). - -
- - - -### *Manage Users* - -Prerequisite: You are assigned the admin role. - - - - - - - - - - - - - - - - - - - -
- -Section - - - -Description - -
- -E-mail Configuration - - - -Provide the administrators e-mail id. - -
- -Pending Requests - - - -Information about pending user requests. You can either accept or reject the requests. For more information, see [Managing the Access Request of the Users \[Classic Design\]](managing-the-access-request-of-the-users-classic-design-5b3e2f6.md). - -
- -Registered Users - - - -Information about users registered. You can either edit the roles for an existing user or register a new user. For more information, see [Managing the Access Request of the Users \[Classic Design\]](managing-the-access-request-of-the-users-classic-design-5b3e2f6.md). - -
- - - -### *Manage API Portal Connection* - -Prerequisite: You’re assigned the *AuthGroup.API.Admin* role. - -As an API business hub enterprise administrator, you can approve or reject the connection requests from this page. You can also view the requests that you have previously approved or rejected. - - - -### *Reference Links* - -Prerequisite: You are assigned the site admin role. - -You can add, edit, and customize the links that appear at the bottom of the page here. Links are grouped into sets of three. Click *\+* to add and edit Web site updates and news. In the *Add Link* dialog window, enter the link title and URL, and choose *Save*. - diff --git a/docs/apim/API-Management/configure-the-api-business-hub-enterprise-new-design-54b4607.md b/docs/apim/API-Management/configure-the-api-business-hub-enterprise-new-design-54b4607.md deleted file mode 100644 index 22b4112c..00000000 --- a/docs/apim/API-Management/configure-the-api-business-hub-enterprise-new-design-54b4607.md +++ /dev/null @@ -1,256 +0,0 @@ - - -# Configure the API business hub enterprise \[New Design\] - -You can configure the API business hub enterprise to personalize it for your organization. - -> ### Note: -> This document describes the new design of the API business hub enterprise. To view the documentation for the classic design, see [Configure the API business hub enterprise \[Classic Design\]](configure-the-api-business-hub-enterprise-classic-design-7b71b16.md). - -Modify the following to personalize the API business hub enterprise: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- -You can use the… - - - -To… - - - -Role that you must be assigned to… - - - -For more information, see… - -
- -*Home Page* - - - -View and search the categories, APIs, and products - - - -AuthGroup.API.Admin - -AuthGroup.API.ApplicationDeveloper - -> ### Note: -> The *AuthGroup.API.ApplicationDeveloper* role is assigned by default to a user who onboards to the API business hub enterprise using the Self-registration process or via *Add User* flow. - - - - - -[Register on API business hub enterprise](register-on-api-business-hub-enterprise-c85fafe.md) - -
- -*Site Editor* - - - -Customize the visual layout of the API business hub enterprise - - - -- AuthGroup.Site.Admin - -- AuthGroup.API.Admin - - - - - - -[Customize the Visual Format of the API business hub enterprise](customize-the-visual-format-of-the-api-business-hub-enterprise-2eacd52.md) - -
- -*Enterprise Manager* \> *Manage API Management Connections* - - - -Approve and reject the pending connection requests and update the API portal access credentials - - - -- AuthGroup.APIPortalRegistration - - - - - - -[Approve the Pending Connection Requests \[New Design\]](APIM-Initial-Setup/approve-the-pending-connection-requests-new-design-e296f80.md) - -
- -*Enterprise Manager* \> *Manage Users* - - - -Add and Revoke user access to the API Business Hub Enterprise - - - -AuthGroup.API.Admin - - - -[Managing the Access Request of the Users \[New Design\]](managing-the-access-request-of-the-users-new-design-8b79ee8.md) - -[Revoke Access \[New Design\]](revoke-access-new-design-ce609bb.md) - -
- -*Enterprise Manager* \> *Manage Domain Categories* - - - -Create and edit domain specific categories. - - - -- AuthGroup.Content.Admin - -- AuthGroup.API.Admin - - - - - - -[Manage Domain Categories \[New Design\]](manage-domain-categories-new-design-bd9691d.md) - -Also, to add the *AuthGroup.Content.Admin* role, see the table in [Manage Domain Categories \[New Design\]](manage-domain-categories-new-design-bd9691d.md). - -
- -*Enterprise Manager* \> *Manage Notifications* - - - -Configure notifications for providing information to the API business hub enterprise end users on any website updates or news items. - - - -- AuthGroup.Site.Admin - - - - - - -[Manage Notifications \[New Design\]](manage-notifications-new-design-df32457.md) - -
- -*My Workspace* - - - -Create applications and view your applications, costs and analyze reports. - - - -AuthGroup.API.Admin - -> ### Note: -> Administrators can create applications on behalf of a developer and can see all the applications across developers. - -> ### Note: -> AuthGroup.API.ApplicationDeveloper -> -> > ### Note: -> > Application developers can create applications and see only the applications created by him. - - - - - -[Create an Application \[New Design\]](create-an-application-new-design-a501a6d.md) - -
- -*Test Environment* - - - -Test the runtime behaviour of APIs - - - -AuthGroup.API.ApplicationDeveloper - -> ### Note: -> Application developers can test the runtime behaviour of APIs. - - - - - -[Test Runtime Behavior of APIs \[New Design\]](test-runtime-behavior-of-apis-new-design-15c7d52.md) - -
- diff --git a/docs/apim/API-Management/consume-api-proxies-ea561e4.md b/docs/apim/API-Management/consume-api-proxies-ea561e4.md index 87213352..21f93584 100644 --- a/docs/apim/API-Management/consume-api-proxies-ea561e4.md +++ b/docs/apim/API-Management/consume-api-proxies-ea561e4.md @@ -5,7 +5,7 @@ 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. > ### 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). +> 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 API business hub enterprise](configure-api-business-hub-enterprise-54b4607.md). If you've added API business hub enterprise as a capability with Integration suite, or if you’ve subscribed to the API business hub enterprise as part of the standalone API Management subscription, you have the option to experience the new design of the API business hub enterprise user interface along with the classic design. @@ -36,7 +36,7 @@ The API business hub enterprise supports the following features: **Related Information** -[Configure the API business hub enterprise \[Classic Design\]](configure-the-api-business-hub-enterprise-classic-design-7b71b16.md "You can configure the API business hub enterprise to personalize it for your organization.") +[Configure the API business hub enterprise \[Classic Design\]](https://help.sap.com/viewer/de4066bb3f9240e3bfbcd5614e18c2f9/Cloud/en-US/7b71b166d6984e8f81a212568af5ce94.html "You can configure the API business hub enterprise to personalize it for your organization.") :arrow_upper_right: -[Configure the API business hub enterprise \[New Design\]](configure-the-api-business-hub-enterprise-new-design-54b4607.md "You can configure the API business hub enterprise to personalize it for your organization.") +[Configure API business hub enterprise](configure-api-business-hub-enterprise-54b4607.md "You can configure and customize the API business hub enterprise to suit your organization's needs.") diff --git a/docs/apim/API-Management/create-a-product-d769622.md b/docs/apim/API-Management/create-a-product-d769622.md index b3ae9b9d..4eff41d6 100644 --- a/docs/apim/API-Management/create-a-product-d769622.md +++ b/docs/apim/API-Management/create-a-product-d769622.md @@ -101,7 +101,7 @@ You create a product when you want to expose one or more API proxies to the Appl The OAuth 2.0 policy provides a way to limit the amount of access that is granted to an access token. For example, an access token issued to a client app may be granted READ and WRITE access to protected resources, or just READ access. You can implement your APIs to enforce any scope or combination of scopes you wish. So, if a client receives a token that has READ scope, and it tries to call an API endpoint that requires WRITE access, the call will fail. - Each product can have zero to many scopes assigned. These scopes can be assigned when the product is created or later. Scopes exist as a list of names and are included in the metadata associated with each product. + The maximum character limit for specifying scopes is 4K characters. Each product can have zero or multiple scopes assigned, as long as the total length of all the scopes does not exceed 4K characters. These scopes can be assigned when the product is created or later. Scopes exist as a list of names and are included in the metadata associated with each product. 8. In the *APIs* section, choose *Add*. 9. In the *Add APIs* window, select the required APIs and the corresponding resources. diff --git a/docs/apim/API-Management/create-an-application-new-design-a501a6d.md b/docs/apim/API-Management/create-an-application-a501a6d.md similarity index 85% rename from docs/apim/API-Management/create-an-application-new-design-a501a6d.md rename to docs/apim/API-Management/create-an-application-a501a6d.md index feff4690..b0688eb2 100644 --- a/docs/apim/API-Management/create-an-application-new-design-a501a6d.md +++ b/docs/apim/API-Management/create-an-application-a501a6d.md @@ -1,12 +1,9 @@ -# Create an Application \[New Design\] +# Create an Application Create an Application to consume the required APIs. -> ### Note: -> This document describes the new design of the API business hub enterprise. To view the documentation for the classic design, see [Create an Application \[Classic Design\]](create-an-application-classic-design-7b4e71b.md). - An application is a discrete representation of the actual developer’s application. It provides the developer with an API key to pass-in with every request to the API. In API Management, similar APIs are bundled together to form products, which are published in the catalog. An application developer enters necessary details to register to the API business hub enterprise. After successful registration, the application developer can explore the required products and APIs to create an application. Once the application has been created successfully, the system generates an appIication key and application secret. If APIs in the application you created are protected via **Verify API Key** policy, then to access those APIs, you must pass the generated application key. Whereas, if APIs are protected via **OAuth** policy, then to access those APIs, you must pass an OAuth token that can be obtained by using the combination of generated appIication key and application secret. diff --git a/docs/apim/API-Management/create-an-application-classic-design-7b4e71b.md b/docs/apim/API-Management/create-an-application-classic-design-7b4e71b.md deleted file mode 100644 index b876e191..00000000 --- a/docs/apim/API-Management/create-an-application-classic-design-7b4e71b.md +++ /dev/null @@ -1,141 +0,0 @@ - - -# Create an Application \[Classic Design\] - -Create an Application to consume the required APIs. - -> ### 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 [Create an Application \[New Design\]](create-an-application-new-design-a501a6d.md). - -**Prerequisites** - -- You either have the `AuthGroup.API.ApplicationDeveloper` role or `AuthGroup.API.Admin` role assigned to you. For more information on roles, see [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:. - - > ### 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. - > - > This role is assigned by default to a user who onboards to the API business hub enterprise using the Self-registration process or via Add User flow. - > - > A user must be onboarded to API business hub enterprise only via Self-registration or Add User flow. For more information on registering in API business hub enterprise, see [Register on API business hub enterprise](register-on-api-business-hub-enterprise-c85fafe.md). In the Add User flow, the API business hub enterprise admin adds a user who wants to be onboarded to API business hub enterprise. However, the user who is requesting to be onboarded must ensure that the user details provided to the admin matches the user details obtained from the response of /api/1.0/users. - - -An application is a discrete representation of the actual developer’s application. It provides the developer with an API key to pass-in with every request to the API. - -In API Management, similar APIs are bundled together to form products, which are published in the Catalog. An application developer enters necessary details to register to the API business hub enterprise. After successful registration, the Application Developer can explore the required products and APIs to create an application. Once the application has been created successfully, the system generates an AppIication Key and Application Secret. If APIs in the application you created are protected via Verify API Key policy, then to access those APIs, you must pass the generated Application Key. Whereas, if APIs are protected via OAuth policy, then to access those APIs, you must pass an OAuth token that can be obtained by using the combination of generated Application Key and Application Secret. - - - -## Creating an Application with Application Developer Role - -1. Log on to the API business hub enterprise. -2. Navigate to the *My Workspace* page. - - If you have created applications earlier, they’re displayed under the *Applications* section. For a created application, you can view the total number of calls made in the current month. - - > ### Note: - > By default, the *Cost* section displays the cost incurred in the last 6 months and the cost incurred in the current month. However, you can choose a month to view the cost incurred for that month. - - You can choose ![](images/Refresh_icon_ba1b5ab.png) to obtain the latest metering data. - - > ### Note: - > You might experience some delay before you see the latest metering data. - - Notation used to display the data is as per metric specifications, for example: - - - 999 shows as 999 and 1000 shows as 1k - - 999000 shows as 999K and 1000000 shows as 1M - - 1500000 shows as 1.5M and 1000000000 shows as 1G - -3. To create an application, choose ![](images/Add_icon_587bccc.png) in the *Applications* section. -4. In the *Create an Application* dialog, enter a `Title`, a `Description` \(optional\), and a `Callback URL` \(optional\) for the application. -5. Choose ![](images/Add_icon_587bccc.png) to add products to this application. -6. In the *Add Products* dialog, select the products that you want to associate with the application. - - > ### Note: - > You can select multiple products published from the same portal but you can't select products published from different portals. For example, you can select products P1 and P2 from API portal A1. But you can't choose products, P3 and P4 from API portal A2 if you've already selected P1 and P2 from A1. - -7. Choose *OK*. -8. Choose *Save*. - - > ### Note: - > While creating an application, if you’ve selected the *Take me to this new application now* checkbox, you’re directly navigated to the newly created application. - - The application you have created appears under the *Applications* section, and also under the *Applications* tab in API portal. - - > ### Note: - > If you open any created application, you notice that the system has generated an *API Key* automatically. Use this value to access the API. At any point in time, you can regenerate the API Key using *Regenerate Key* option. When you regenerate the key, both Application key and Secret key are changed. When you trigger API using the old key, then the response is negative. The old API key becomes invalid on regeneration. - - - - - - -## Creating an Application with API business hub enterprise Administrator Role - -A API business hub enterprise administrator can perform the following tasks: - -- Create an application on behalf of a user \(Application Developer\) and handover the application key and secret to that user. -- Create new applications in different landscapes\(example: production, nonproduction\) by maintaining the same application key and secret. -- Create custom attributes at application level and regulate the API call logic - -1. Log on to the API business hub enterprise. -2. Navigate to the *My Workspace* page. - - ![](images/My_Workspace_315b2dc.png) If you or other application developers have created applications earlier, they’re displayed under the *Applications* section. For a created application, you can view the total number of calls made in the current month. - - > ### Note: - > By default, the *Cost* section displays the cost incurred in the last 6 months and the cost incurred in the current month. However, you can choose a month to view the cost incurred for that month. - - > ### Note: - > For API business hub enterprise administrators, analytics data is unavailable for those applications that they created on behalf of other users or application developers. - - You can choose ![](images/Refresh_icon_ba1b5ab.png) to obtain the latest metering data. - - > ### Note: - > You might experience some delay before you see the latest metering data. - - Notion used to display the data is as per metric specifications, for example: - - - 999 shows as 999 and 1000 shows as 1k - - 999000 shows as 999K and 1000000 shows as 1M - - 1500000 shows as 1.5M and 1000000000 shows as 1G - -3. To create an application, under *Applications* section, choose ![](images/Add_icon_587bccc.png). -4. In the *Create an Application* dialog, enter a `Title`, a `Description` \(optional\), and a `Callback URL` \(optional\) for the application. -5. As an administrator, you have the option to create an application on behalf of a user \(Application Developer\). To achieve this task, select the *Create this application on behalf of someone else* checkbox and enter the `User ID` of the user on behalf of whom you are creating the application. If you already possess an application key and secret, then select the *Already have Application Key and Secret* checkbox and enter the `Application Key` and `Application Secret` . - - > ### Note: - > Application key and secret of an existing org can't be used in a new application in a new org. This implies that you'll not be able to use the same application key and secret in multiple orgs within the same data center and region. - -6. Choose ![](images/Add_icon_587bccc.png) to add products to this application. -7. In the *Add Products* dialog, select the products that you want to associate with the application. - - > ### Note: - > You can select multiple products. - -8. Choose *OK*. -9. Choose *Save*. - - > ### Note: - > While creating an application, if you’ve selected the *Take me to this new application now* checkbox, you’re directly navigated to the newly created application. - - The application you created appears under the *Applications* section, and also under the *Applications* tab in API portal. - - > ### Note: - > If you open any created application, you notice that the system has generated an *API Key* automatically. Use this value to access the API. At any point in time, you can regenerate the API Key using *Regenerate Key* option. When you regenerate the key, both Application key and Secret key are changed. When you trigger API using the old key, then the response is negative. The old API key becomes invalid on regeneration. - -10. Specify custom attributes. - 1. Under *My Workspace*, choose an application for which you want to add custom attributes. - 2. In the *Application Info* screen, under *Custom Attributes* section, choose ![](images/Add_icon_587bccc.png) to add a custom attribute. - 3. In the *Add Custom Attribute* dialog, enter a name and a value for your custom attribute and choose *Add*. - - > ### Note: - > You can create a maximum of 18 custom attributes per application. You cannot modify the name of a created custom attribute. However, you can modify its value whenever required. You can delete a custom attribute if it is no longer needed. - - For more information on the usage of custom attributes in an application, see [Example: Accessing the Custom Attributes of an Application](example-accessing-the-custom-attributes-of-an-application-1cbd94c.md). - - - diff --git a/docs/apim/API-Management/creating-an-application-with-api-business-hub-enterprise-administrator-role-new-design-df4f777.md b/docs/apim/API-Management/creating-an-application-with-api-business-hub-enterprise-administrator-role-df4f777.md similarity index 96% rename from docs/apim/API-Management/creating-an-application-with-api-business-hub-enterprise-administrator-role-new-design-df4f777.md rename to docs/apim/API-Management/creating-an-application-with-api-business-hub-enterprise-administrator-role-df4f777.md index 98b1cc38..77cf8a7f 100644 --- a/docs/apim/API-Management/creating-an-application-with-api-business-hub-enterprise-administrator-role-new-design-df4f777.md +++ b/docs/apim/API-Management/creating-an-application-with-api-business-hub-enterprise-administrator-role-df4f777.md @@ -1,6 +1,6 @@ -# Creating an Application with API business hub enterprise Administrator Role \[New Design\] +# Creating an Application with API business hub enterprise Administrator Role With the API business hub enterprise administrator role you can create an application on behalf of a user \(application developer\), and view the existing application details, and its associated products, custom attributes, and analytics data. @@ -65,6 +65,6 @@ An API business hub enterprise administrator can perform the following tasks: > ### Note: > You can create a maximum of 18 custom attributes per application. You cannot modify the name of a created custom attribute. However, you can modify its value whenever required. You can delete a custom attribute if it is no longer needed. - For more information on the usage of custom attributes in an application, see [Example: Accessing the Custom Attributes of an Application](example-accessing-the-custom-attributes-of-an-application-1cbd94c.md). + For more information on the usage of custom attributes in an application, see [Example: Accessing the Custom Attributes of an Application](https://help.sap.com/viewer/de4066bb3f9240e3bfbcd5614e18c2f9/Cloud/en-US/1cbd94c86c054d66b3826f6cd91e0df8.html "") :arrow_upper_right:. diff --git a/docs/apim/API-Management/creating-an-application-with-application-developer-role-new-design-99515fc.md b/docs/apim/API-Management/creating-an-application-with-application-developer-role-99515fc.md similarity index 95% rename from docs/apim/API-Management/creating-an-application-with-application-developer-role-new-design-99515fc.md rename to docs/apim/API-Management/creating-an-application-with-application-developer-role-99515fc.md index 57bfb253..718700ba 100644 --- a/docs/apim/API-Management/creating-an-application-with-application-developer-role-new-design-99515fc.md +++ b/docs/apim/API-Management/creating-an-application-with-application-developer-role-99515fc.md @@ -1,6 +1,6 @@ -# Creating an Application with Application Developer Role \[New Design\] +# Creating an Application with Application Developer Role As an application developer you can create an application, and view the existing application details, and its associated products, custom attributes and analytics data. @@ -64,6 +64,6 @@ You are about to create an application and add products to your application. You > ### Note: > You can create a maximum of 18 custom attributes per application. You cannot modify the name of a created custom attribute. However, you can modify its value whenever required. You can delete a custom attribute if it is no longer needed. - For more information on the usage of custom attributes in an application, see [Example: Accessing the Custom Attributes of an Application](example-accessing-the-custom-attributes-of-an-application-1cbd94c.md). + For more information on the usage of custom attributes in an application, see [Example: Accessing the Custom Attributes of an Application](https://help.sap.com/viewer/de4066bb3f9240e3bfbcd5614e18c2f9/Cloud/en-US/1cbd94c86c054d66b3826f6cd91e0df8.html "") :arrow_upper_right:. diff --git a/docs/apim/API-Management/data-protection-and-privacy-for-api-management-d50613e.md b/docs/apim/API-Management/data-protection-and-privacy-for-api-management-d50613e.md index 216ed6cd..89cac704 100644 --- a/docs/apim/API-Management/data-protection-and-privacy-for-api-management-d50613e.md +++ b/docs/apim/API-Management/data-protection-and-privacy-for-api-management-d50613e.md @@ -204,7 +204,7 @@ API Management stores the API portal administrator’s user ID. Storing the user API Management stores personal information such as first name, last name, user ID, and e-mail ID of users who have logged on to the Developer Portal. All the personal information stored in the application is deleted when the access for the corresponding user is revoked. -In API Management, application developers can contact their developer portal administrators to have their personal data erased and access revoked. For more information, see [Revoke Access \[Classic Design\]](revoke-access-classic-design-147fb9d.md) and [Delete Data of Unregistered Users](delete-data-of-unregistered-users-d548233.md). +In API Management, application developers can contact their developer portal administrators to have their personal data erased and access revoked. For more information, see [Revoke Access \[Classic Design\]](https://help.sap.com/viewer/de4066bb3f9240e3bfbcd5614e18c2f9/Cloud/en-US/147fb9dca1414f6a956dd05b4c86d74d.html "Revoke the access of an application developer.") :arrow_upper_right: and [Delete Data of Unregistered Users](delete-data-of-unregistered-users-d548233.md). diff --git a/docs/apim/API-Management/example-accessing-the-custom-attributes-of-an-application-1cbd94c.md b/docs/apim/API-Management/example-accessing-the-custom-attributes-of-an-application-1cbd94c.md deleted file mode 100644 index e45aa164..00000000 --- a/docs/apim/API-Management/example-accessing-the-custom-attributes-of-an-application-1cbd94c.md +++ /dev/null @@ -1,80 +0,0 @@ - - -# Example: Accessing the Custom Attributes of an Application - -Let’s say as a Developer Portal Administrator, you would want to restrict the number of calls to an application based on Application Key. To achieve this result, you create two applications `Application_1` and `Application_2`. - -`Application_1` contains two products namely `Prod_1` and `Prod_2`. - -`Application_2` contains two products namely `Prod_3` and `Prod_4`. - -`Prod_1` and `Prod_2`contain two common APIs namely `API_1` and `API_2`. - -For `Application_1`, add the following custom attributes and its corresponding values: - -- app\_time\_unit = minute -- app\_quota\_interval = 1 -- app\_quota\_count = 9 - -For `Application_2`, add the following custom attributes and its corresponding values: - -- app\_time\_unit = minute -- app\_quota\_interval = 1 -- app\_quota\_count = 5 - -To leverage these custom attributes in your API proxy execution, you must: - -- add a verify API Key policy to the APIs that are part of your application. -- add a Quota policy to APIs that are part of your application. - -For `API_1` and `API_2`, add the following sample policy payloads: - -Sample payload for Verify API Key policy: - -> ### Sample Code: -> ``` -> -> xmlns='http://www.sap.com/apimgmt'> -> -> -> ``` - -Sample payload for Quota policy: - -> ### Sample Code: -> ``` -> -> -> -> -> -> -> -> -> -> true -> -> 2015-2-11 12:00:00 -> -> true -> -> -> -> -> -> ``` - -> ### Note: -> The attribute names `app_quota_interval`, `app_quota_count`, and `app_time_unit` must be the same attributes that you have added while creating the application. - -To verify if the custom attributes are used in runtime, make an API call with `` passed as a query parameter. For example, `https://?apikey=`. - -Call the same URL repeatedly and after 9 successive calls, your API proxy must return a Quota violation message. - -Similarly, make an API call with `` passed as a query parameter. For example,`https://?apikey=`. - -Call the same URL repeatedly and after 6 successive calls, your API proxy must return a Quota violation message. - diff --git a/docs/apim/API-Management/images/Add_icon_587bccc.png b/docs/apim/API-Management/images/Add_icon_587bccc.png deleted file mode 100644 index ca9c9347..00000000 Binary files a/docs/apim/API-Management/images/Add_icon_587bccc.png and /dev/null differ diff --git a/docs/apim/API-Management/images/My_Workspace_315b2dc.png b/docs/apim/API-Management/images/My_Workspace_315b2dc.png deleted file mode 100644 index 63adb654..00000000 Binary files a/docs/apim/API-Management/images/My_Workspace_315b2dc.png and /dev/null differ diff --git a/docs/apim/API-Management/images/Refresh_icon_ba1b5ab.png b/docs/apim/API-Management/images/Refresh_icon_ba1b5ab.png deleted file mode 100644 index 44a100aa..00000000 Binary files a/docs/apim/API-Management/images/Refresh_icon_ba1b5ab.png and /dev/null differ diff --git a/docs/apim/API-Management/manage-access-9df3ece.md b/docs/apim/API-Management/manage-developer-access-9df3ece.md similarity index 99% rename from docs/apim/API-Management/manage-access-9df3ece.md rename to docs/apim/API-Management/manage-developer-access-9df3ece.md index 5977b11f..3e01e5ad 100644 --- a/docs/apim/API-Management/manage-access-9df3ece.md +++ b/docs/apim/API-Management/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/apim/API-Management/manage-domain-categories-new-design-bd9691d.md b/docs/apim/API-Management/manage-domain-categories-bd9691d.md similarity index 92% rename from docs/apim/API-Management/manage-domain-categories-new-design-bd9691d.md rename to docs/apim/API-Management/manage-domain-categories-bd9691d.md index 94611397..caecba48 100644 --- a/docs/apim/API-Management/manage-domain-categories-new-design-bd9691d.md +++ b/docs/apim/API-Management/manage-domain-categories-bd9691d.md @@ -2,7 +2,7 @@ -# Manage Domain Categories \[New Design\] +# Manage Domain Categories Domain categories are displayed on the API business hub enterprise home page. @@ -34,8 +34,6 @@ Content administrators can use *Manage Content* to create domain categories and > ### Note: > If you've configured the API business hub enterprise to connect to multiple API portals then you can add products from different API portals under one category. Whereas in classic design, you can only add products from one API portal under a category. -This document describes the new design of the API business hub enterprise. To view the documentation for the classic design, see [Manage Navigation Categories \[Classic Design\]](manage-navigation-categories-classic-design-7f1a44b.md). - Use the following procedure to configure navigation categories. diff --git a/docs/apim/API-Management/manage-external-content-new-design-f5bd17d.md b/docs/apim/API-Management/manage-external-content-f5bd17d.md similarity index 97% rename from docs/apim/API-Management/manage-external-content-new-design-f5bd17d.md rename to docs/apim/API-Management/manage-external-content-f5bd17d.md index 4414ac13..100b5d28 100644 --- a/docs/apim/API-Management/manage-external-content-new-design-f5bd17d.md +++ b/docs/apim/API-Management/manage-external-content-f5bd17d.md @@ -1,6 +1,6 @@ -# Manage External Content \(New Design\) +# Manage External Content On this page, you have the option to adjust the visibility of the Graph navigator on the API business hub enterprise. diff --git a/docs/apim/API-Management/manage-navigation-categories-classic-design-7f1a44b.md b/docs/apim/API-Management/manage-navigation-categories-classic-design-7f1a44b.md deleted file mode 100644 index a60b7b09..00000000 --- a/docs/apim/API-Management/manage-navigation-categories-classic-design-7f1a44b.md +++ /dev/null @@ -1,98 +0,0 @@ - - -# Manage Navigation Categories \[Classic Design\] - -Navigation categories are displayed on the home page. - - - - - -## Prerequisites - -You have the content admin role assigned to you. - - - - - -## Context - -> ### 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). - -Use the following procedure to configure navigation categories. - - - - - -## Procedure - -1. Log on to the API business hub enterprise, and navigate to *Manage* \> *Home Page* \> *Navigation Categories*. - -2. To add a category, choose *Add Category* icon. In the *Add Category* screen that opens, enter the following details: - - - - - - - - - - - - - - - - - - - -
- - Name - - - - Description - -
- - **Category Name** - - - - Provide a name for the category. - -
- - **Category Title** - - - - Provide a title for the category. Categories are identified by their title on the home screen. - -
- - **Description** - - - - Provide a description for the category. - -
- -3. To add products, choose *Add Products*button. In the *Add Products* window that opens, select the products that you want to add to this category. - -4. Save the changes. - - Newly configured category is visible in the *Navigation Categories* section. In this section, you can perform the following: - - - Reorder the updates by using the *Move Up* and *Move Down* action icons. - - Edit a category by choosing the edit action icon. - - Delete a category by choosing the delete action icon. - - diff --git a/docs/ISuite/50-Development/manage-notifications-new-design-df32457.md b/docs/apim/API-Management/manage-notifications-df32457.md similarity index 98% rename from docs/ISuite/50-Development/manage-notifications-new-design-df32457.md rename to docs/apim/API-Management/manage-notifications-df32457.md index e1c70c29..5a48425f 100644 --- a/docs/ISuite/50-Development/manage-notifications-new-design-df32457.md +++ b/docs/apim/API-Management/manage-notifications-df32457.md @@ -2,7 +2,7 @@ -# Manage Notifications \[New Design\] +# Manage Notifications As a site administrator you can configure notifications for providing information to the API business hub enterprise end users on any website updates, events or news items. diff --git a/docs/apim/API-Management/manage-updates-classic-design-94e37b4.md b/docs/apim/API-Management/manage-updates-classic-design-94e37b4.md deleted file mode 100644 index 66a5a805..00000000 --- a/docs/apim/API-Management/manage-updates-classic-design-94e37b4.md +++ /dev/null @@ -1,89 +0,0 @@ - - -# Manage Updates \[Classic Design\] - -Configure the updates to be displayed in the *Updates* section on the home page. - - - - - -## Prerequisites - -You have the site admin role assigned to you. - - - -## Context - -Use the following procedure to configure updates. - - - -## Procedure - -1. Log on to the API business hub enterprise, and navigate to *Manage* \> *Home Page* \> *Updates* \> *Configure Updates*. - -2. To add an update, click *Add Update* icon. In the *Add Update* screen that opens, enter the following details: - - - - - - - - - - - - - - - - - - - -
- - Name - - - - Description - -
- - **Title** - - - - Provide a title for the update. - -
- - **Description** - - - - Provide a description for the update. - -
- - **Link** - - - - Provide the details of a reference link. Link is an optional field to provide more information on the update. - -
- -3. Save the changes. - - Newly configured update is visible in the *Configured Updates* section. In this section, you can perform the following: - - - Reorder the updates by using the *Move Up* and *Move Down* action icons. - - Edit an update by choosing the edit action icon. - - Delete an update by choosing the delete action icon. - - diff --git a/docs/apim/API-Management/managing-the-access-request-of-the-users-classic-design-5b3e2f6.md b/docs/apim/API-Management/managing-the-access-request-of-the-users-classic-design-5b3e2f6.md deleted file mode 100644 index 7869ec10..00000000 --- a/docs/apim/API-Management/managing-the-access-request-of-the-users-classic-design-5b3e2f6.md +++ /dev/null @@ -1,128 +0,0 @@ - - - - -# Managing the Access Request of the Users \[Classic Design\] - -Procedure to provide or reject access to an Application developer for using the API business hub enterprise. - - - - - -## Prerequisites - -You’re assigned the *AuthGroup.API.Admin* role. - -> ### 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). - - - - - -## Procedure - -1. Log on to the API business hub enterprise. - -2. Choose *Manage* \> *Manage Users*. - - Use the *Manage Users* page to onboard the application developers. For assigning roles to other users, use the SAP BTP Cockpit. - -3. Add the email id in the textbox. - - This email id is used to receive email notification of the pending requests and send approvals. - -4. To view the pending requests, navigate to *Pending* section . - -5. In the pending section, **Approve** or **Reject** the request by choosing the corresponding action item in the *Actions* column. - - On accepting the request, an approval email is sent to the requester. On rejecting a request, you need to provide a reason and an email notification is sent to the requester with the mentioned reason. - - To view registered users, navigate to *Registered Users* section. - - In the *Registered Users*section, you can perform the following: - - - Edit an existing user to add or remove user roles. - - Register a new user by selecting the :heavy_plus_sign: icon. - - In the *Add User* dialog: - - 1. Enter the *User ID* and the user details like *First Name*, *Last Name* and *Email ID*. - - 2. Under *Assigned Roles*, identify the needed scope and select the roles accordingly: - - - - - - - - - - - - - - - - - - - - - - - -
- - Roles - - - - Descrition - -
- - Administrator - - - - Manages user registration. Create and delete applications on behalf of application developers. In addition, create custom attributes and import the app key. - -
- - Developer - - - - Create applications and check billing and metering data. Test APIs and view analytics data. - -
- - Site Administrator - - - - Configure updates, and perform portal changes like uploading the logo, changing the name and the description, and changing the footer links for the site. - -
- - Content Administrator - - - - Manages content categories. - -
- - - - - -**Related Information** - - -[Configure the API business hub enterprise \[Classic Design\]](configure-the-api-business-hub-enterprise-classic-design-7b71b16.md "You can configure the API business hub enterprise to personalize it for your organization.") - -[Revoke Access \[Classic Design\]](revoke-access-classic-design-147fb9d.md "Revoke the access of an application developer.") - diff --git a/docs/apim/API-Management/managing-the-access-request-of-the-users-new-design-8b79ee8.md b/docs/apim/API-Management/managing-the-access-request-of-the-users-new-design-8b79ee8.md index 79745d93..944790eb 100644 --- a/docs/apim/API-Management/managing-the-access-request-of-the-users-new-design-8b79ee8.md +++ b/docs/apim/API-Management/managing-the-access-request-of-the-users-new-design-8b79ee8.md @@ -13,7 +13,7 @@ As an API administrator, you can approve or reject the access request made by an You’re assigned the *AuthGroup.API.Admin* role. > ### Note: -> This document describes the new design of the API business hub enterprise. To view the documentation for the classic design, see [Managing the Access Request of the Users \[Classic Design\]](managing-the-access-request-of-the-users-classic-design-5b3e2f6.md). +> This document describes the new design of the API business hub enterprise. To view the documentation for the classic design, see [Managing the Access Request of the Users \[Classic Design\]](https://help.sap.com/viewer/de4066bb3f9240e3bfbcd5614e18c2f9/Cloud/en-US/5b3e2f607046447c867db43e9b7859c7.html "Procedure to provide or reject access to an Application developer for using the API business hub enterprise.") :arrow_upper_right:. diff --git a/docs/apim/API-Management/onboard-an-application-developer-786d107.md b/docs/apim/API-Management/onboard-an-application-developer-786d107.md index 05620c20..8359ad8f 100644 --- a/docs/apim/API-Management/onboard-an-application-developer-786d107.md +++ b/docs/apim/API-Management/onboard-an-application-developer-786d107.md @@ -18,7 +18,7 @@ To provide application developers with access to the API business hub enterprise 1. The application developers log on to the API business hub enterprise application with their IDP user credentials, and register to the API business hub enterprise. For more information, see [Register on API business hub enterprise](register-on-api-business-hub-enterprise-c85fafe.md). -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). +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\]](https://help.sap.com/viewer/de4066bb3f9240e3bfbcd5614e18c2f9/Cloud/en-US/5b3e2f607046447c867db43e9b7859c7.html "Procedure to provide or reject access to an Application developer for using the API business hub enterprise.") :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](APIM-Initial-Setup/shadow-users-a0f5fe5.md) diff --git a/docs/apim/API-Management/patch-releases-for-api-management-6ddd927.md b/docs/apim/API-Management/patch-releases-for-api-management-6ddd927.md index ebdc786e..b063d3de 100644 --- a/docs/apim/API-Management/patch-releases-for-api-management-6ddd927.md +++ b/docs/apim/API-Management/patch-releases-for-api-management-6ddd927.md @@ -6,6 +6,86 @@ This topic provides information on patch releases for API Management that are pr + + +## May 2024 + +**Software Increment: 2403** + + + + + + + + + + + + + + + + + + + + + + + +
+ +Technical Component + + + +Software Version + + + +Description + +
+ +API Management + + + +1.168.4 + + + +The transport of the apiprovider was failing due to a missing KVM. However, this issue has been resolved by creating the necessary KVMs during the provider creation process. + +
+ +API Management + + + +1.168.4 + + + +The issue with the key credentials of the Devportal node service broker has been resolved. The correct key credentials are now available to access the application APIs. + +
+ +API Management + + + +1.168.3 + + + +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 diff --git a/docs/apim/API-Management/revoke-access-classic-design-147fb9d.md b/docs/apim/API-Management/revoke-access-classic-design-147fb9d.md deleted file mode 100644 index 34804847..00000000 --- a/docs/apim/API-Management/revoke-access-classic-design-147fb9d.md +++ /dev/null @@ -1,47 +0,0 @@ - - -# Revoke Access \[Classic Design\] - -Revoke the access of an application developer. - - - - - -## Prerequisites - -You are an API administrator and the role *AuthGroup.API.Admin* is assigned to your user. - - - -## Context - -As an API administrator, you use this procedure to revoke an application developer's access for using the API business hub enterprise. - -> ### Note: -> This document describes the classic design of the API business hub enterprise. To view the documentation for the new design, see [Revoke Access \[New Design\]](revoke-access-new-design-ce609bb.md). - - - -## Procedure - -1. Log on to the API business hub enterprise. - -2. Choose *Manage* \> *Manage Users*. - -3. Go to the *Registered* section. From the list of application developers, select the application developer whose access you want to revoke and choose the revoke user action item under the *Actions* column. - -4. In the *Revoke* window, provide a reason for revoking the access. - - > ### Note: - > By revoking roles, user will lose all the roles assigned. However, user account will be retained. - - - - - - -## Results - -You have revoked the access of the user from using API business hub enterprise successfully. - diff --git a/docs/apim/API-Management/revoke-access-new-design-ce609bb.md b/docs/apim/API-Management/revoke-access-new-design-ce609bb.md index 7b4878bf..6ee719b0 100644 --- a/docs/apim/API-Management/revoke-access-new-design-ce609bb.md +++ b/docs/apim/API-Management/revoke-access-new-design-ce609bb.md @@ -23,7 +23,7 @@ You are an API administrator and the role *AuthGroup.API.Admin* is assigned to y As an API administrator, you use this procedure to revoke an application developer's access for using the API business hub enterprise. > ### Note: -> This document describes the new design of the API business hub enterprise. To view the documentation for the classic design, see [Revoke Access \[Classic Design\]](revoke-access-classic-design-147fb9d.md). +> This document describes the new design of the API business hub enterprise. To view the documentation for the classic design, see [Revoke Access \[Classic Design\]](https://help.sap.com/viewer/de4066bb3f9240e3bfbcd5614e18c2f9/Cloud/en-US/147fb9dca1414f6a956dd05b4c86d74d.html "Revoke the access of an application developer.") :arrow_upper_right:. diff --git a/docs/ISuite/50-Development/subscribe-to-a-product-new-design-486d263.md b/docs/apim/API-Management/subscribe-to-a-product-486d263.md similarity index 76% rename from docs/ISuite/50-Development/subscribe-to-a-product-new-design-486d263.md rename to docs/apim/API-Management/subscribe-to-a-product-486d263.md index 141cded0..df918e21 100644 --- a/docs/ISuite/50-Development/subscribe-to-a-product-new-design-486d263.md +++ b/docs/apim/API-Management/subscribe-to-a-product-486d263.md @@ -1,6 +1,6 @@ -# Subscribe to a Product \[New Design\] +# Subscribe to a Product You can subscribe to a product and add it to an existing application or create a new application. @@ -10,9 +10,6 @@ You can subscribe to a product and add it to an existing application or create a On the homepage, you can find the list of products under various categories. You can also view the various resources that each product has to offer. -> ### Note: -> This document describes the new design of the API business hub enterprise. To view the documentation for the classic design, see [Subscribe to a Product \[Classic Design\]](subscribe-to-a-product-classic-design-2e586e1.md). - diff --git a/docs/apim/API-Management/subscribe-to-a-product-classic-design-2e586e1.md b/docs/apim/API-Management/subscribe-to-a-product-classic-design-2e586e1.md deleted file mode 100644 index 1362459e..00000000 --- a/docs/apim/API-Management/subscribe-to-a-product-classic-design-2e586e1.md +++ /dev/null @@ -1,38 +0,0 @@ - - -# Subscribe to a Product \[Classic Design\] - -You can subscribe to a product and add it to an existing application or create a new application. - - - -## Context - -On the homepage, you can find the list of products. You can also view the various resources that each product has to offer. - -> ### 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 [Subscribe to a Product \[New Design\]](subscribe-to-a-product-new-design-486d263.md). - - - -## Procedure - -1. Log on to the API business hub enterprise. - -2. You can either look for the product on the homepage, or use the search bar to search for the product. - -3. In the product details screen, choose *Subscribe*. - - You can subscribe to: - - - *Add to Existing Application*: The list of applications appears. Choose the required application. - - - *Create New Application*: Create an application by entering the name and title. The selected Product is added to the application by default. - - -4. Choose *Save* . - - diff --git a/docs/apim/API-Management/test-runtime-behavior-of-apis-new-design-15c7d52.md b/docs/apim/API-Management/test-runtime-behavior-of-apis-15c7d52.md similarity index 98% rename from docs/apim/API-Management/test-runtime-behavior-of-apis-new-design-15c7d52.md rename to docs/apim/API-Management/test-runtime-behavior-of-apis-15c7d52.md index 92d2da45..357af986 100644 --- a/docs/apim/API-Management/test-runtime-behavior-of-apis-new-design-15c7d52.md +++ b/docs/apim/API-Management/test-runtime-behavior-of-apis-15c7d52.md @@ -1,6 +1,6 @@ -# Test Runtime Behavior of APIs \[New Design\] +# Test Runtime Behavior of APIs Use the API Test Environment to test the runtime behavior of APIs. diff --git a/docs/apim/API-Management/view-applications-costs-and-analyze-reports-new-design-fca4d8c.md b/docs/apim/API-Management/view-applications-costs-and-analyze-reports-fca4d8c.md similarity index 94% rename from docs/apim/API-Management/view-applications-costs-and-analyze-reports-new-design-fca4d8c.md rename to docs/apim/API-Management/view-applications-costs-and-analyze-reports-fca4d8c.md index 6cacd760..9b802a9d 100644 --- a/docs/apim/API-Management/view-applications-costs-and-analyze-reports-new-design-fca4d8c.md +++ b/docs/apim/API-Management/view-applications-costs-and-analyze-reports-fca4d8c.md @@ -1,6 +1,6 @@ -# View Applications, Costs, and Analyze Reports \[New Design\] +# View Applications, Costs, and Analyze Reports From the *My Workspace* page you can view your applications, costs, and analyze reports. diff --git a/docs/apim/API-Management/view-applications-feac368.md b/docs/apim/API-Management/view-applications-feac368.md index 419e5c28..87d6bb1d 100644 --- a/docs/apim/API-Management/view-applications-feac368.md +++ b/docs/apim/API-Management/view-applications-feac368.md @@ -41,5 +41,5 @@ As an admin, you can view the list of applications that the developers have crea **Related Information** -[Create an Application \[Classic Design\]](create-an-application-classic-design-7b4e71b.md "Create an Application to consume the required APIs.") +[Create an Application \[Classic Design\]](https://help.sap.com/viewer/de4066bb3f9240e3bfbcd5614e18c2f9/Cloud/en-US/7b4e71b3887f4396aa22ce3e2ed7e0c3.html "Create an Application to consume the required APIs.") :arrow_upper_right: 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 deef0da1..3e3293bf 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 @@ -84,6 +84,220 @@ API Management + + + +Tenant Cloning Tool + + + + +In this release, we have introduced selective entity migration, which allows you to migrate only the desired API proxies by setting the *selectiveEntityMigration* flag to true. These enhancements provide you with greater control and flexibility during the migration process, enabling you to migrate only the necessary API proxies or all API Management entities effortlessly. + +See: + +- [Clone API Management Content](https://help.sap.com/docs/integration-suite/sap-integration-suite/clone-api-management-artifacts?version=CLOUD) + +- [Clone API Management Content between Cloud Foundry Environments](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 Content](https://help.sap.com/docs/sap-api-management/sap-api-management/clone-api-management-artifacts?version=Cloud) + +- [Clone API Management Content for 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) + + + + + + + +Info only + + + + +General Availability + + + + + + + + + +Technology + + + + +Not applicable + + + + +  + + + + +2024-05-31 + + + + +2024-05-31 + + + + + + +API Management + + + + +- Cloud Foundry + + + + + + +API business hub enterprise Classic Design UI Removed + + + + +The classic design of the API business hub enterprise has been removed and is no longer accessible. + +To configure the new design, see [Configure the API business hub enterprise](https://help.sap.com/docs/integration-suite/sap-integration-suite/configure-api-business-hub-enterprise-new-design?version=CLOUD&q=Exyternal%20Content) + +SAP API Management customers choose: [Configure the API business hub enterprise](https://help.sap.com/docs/sap-api-management/sap-api-management/configure-api-business-hub-enterprise-new-design?version=Cloud) + + + + +Info only + + + + +Deleted + + + + +Announcement + + + + +Technology + + + + +Not applicable + + + + +  + + + + +2024-06-10 + + + + +2024-06-10 + + + + + + +API Management + + + + +- Cloud Foundry + + + + + + +Anomaly Detection + + + + +Anomaly detection is an AI-based feature of API Management within SAP Integration Suite. It involves the identification of patterns or data points that deviate significantly from normal behaviour or expected patterns. This feature allows you to proactively identify and respond to unusual patterns or deviations in API proxy calls, thereby ensuring the security, reliability, and optimal performance of APIs. + +See: [Anomaly Detection](https://help.sap.com/docs/integration-suite/sap-integration-suite/anomaly-detection?version=CLOUD) + + + + +Info only + + + + +General Availability + + + + +New + + + + +Technology + + + + +Not applicable + + + + +  + + + + +2024-06-10 + + + + +2024-06-10 + + + + + + +API Management + + + + +- Cloud Foundry + + + diff --git a/docs/apim/css/SAP-icons-TNT-V3.woff b/docs/apim/css/SAP-icons-TNT-V3.woff index a1c9f187..cf3cb169 100644 Binary files a/docs/apim/css/SAP-icons-TNT-V3.woff and b/docs/apim/css/SAP-icons-TNT-V3.woff differ diff --git a/docs/apim/css/SAP-icons-V5.woff b/docs/apim/css/SAP-icons-V5.woff index 40ce00c5..b84e8940 100644 Binary files a/docs/apim/css/SAP-icons-V5.woff and b/docs/apim/css/SAP-icons-V5.woff differ diff --git a/docs/apim/index.md b/docs/apim/index.md index 6e76d715..a72d714b 100644 --- a/docs/apim/index.md +++ b/docs/apim/index.md @@ -28,6 +28,7 @@ How to use SAP API Management - [Accessing API business hub enterprise APIs Programmatically](API-Management/APIM-Initial-Setup/accessing-api-business-hub-enterprise-apis-programmatically-dabee6e.md) - [Managing Cloud Foundry Microservices through API Management](API-Management/APIM-Initial-Setup/managing-cloud-foundry-microservices-through-api-management-e609a3e.md) - [Accessing On-Premise Systems through API Management](API-Management/APIM-Initial-Setup/accessing-on-premise-systems-through-api-management-2fc7a5b.md) + - [Circuit Breaker for On-Premise Provider](API-Management/APIM-Initial-Setup/circuit-breaker-for-on-premise-provider-bd3c2d5.md) - [Consume API Management Service Instance from Kyma](API-Management/APIM-Initial-Setup/consume-api-management-service-instance-from-kyma-3b53c26.md) - [Account Members](API-Management/APIM-Initial-Setup/account-members-66a7bc8.md) - [User Roles in API Management](API-Management/APIM-Initial-Setup/user-roles-in-api-management-7010b58.md) @@ -41,16 +42,11 @@ How to use SAP API Management - [Configuring Mutual TLs for Virtual Host](API-Management/APIM-Initial-Setup/configuring-mutual-tls-for-virtual-host-9faf7ce.md) - [Shadow Users](API-Management/APIM-Initial-Setup/shadow-users-a0f5fe5.md) - [Cancel API Management Service Subscription](API-Management/APIM-Initial-Setup/cancel-api-management-service-subscription-df6df2b.md) - - [Centralized API business hub enterprise \[Classic Design\]](API-Management/APIM-Initial-Setup/centralized-api-business-hub-enterprise-classic-design-33b706f.md) - - [Create a Connection Request for the Centralized API business hub enterprise \[Classic Design\]](API-Management/APIM-Initial-Setup/create-a-connection-request-for-the-centralized-api-business-hub-enterprise-cla-02f7877.md) - - [Updating the Connection Request Credentials for a Submitted Request \[Classic Design\]](API-Management/APIM-Initial-Setup/updating-the-connection-request-credentials-for-a-submitted-request-classic-des-eb84854.md) - - [Approve the Pending Connection Requests \[Classic Design\]](API-Management/APIM-Initial-Setup/approve-the-pending-connection-requests-classic-design-b4e6f56.md) - - [Updating the Connection Request Credentials for an Approved Request \[Classic Design\]](API-Management/APIM-Initial-Setup/updating-the-connection-request-credentials-for-an-approved-request-classic-des-b583b7a.md) - - [Centralized API business hub enterprise \[New Design\]](API-Management/APIM-Initial-Setup/centralized-api-business-hub-enterprise-new-design-38422de.md) - - [Create a Connection Request for the Centralized API business hub enterprise \[New Design\]](API-Management/APIM-Initial-Setup/create-a-connection-request-for-the-centralized-api-business-hub-enterprise-new-c7bda8c.md) - - [Updating the Connection Request Credentials for a Pending Request \[New Design\]](API-Management/APIM-Initial-Setup/updating-the-connection-request-credentials-for-a-pending-request-new-design-dd37a7b.md) - - [Approve the Pending Connection Requests \[New Design\]](API-Management/APIM-Initial-Setup/approve-the-pending-connection-requests-new-design-e296f80.md) - - [Updating the Connection Request Credentials for an Approved Request \[New Design\]](API-Management/APIM-Initial-Setup/updating-the-connection-request-credentials-for-an-approved-request-new-design-882e1d9.md) + - [Centralized API business hub enterprise](API-Management/APIM-Initial-Setup/centralized-api-business-hub-enterprise-38422de.md) + - [Create a Connection Request for the Centralized API business hub enterprise](API-Management/APIM-Initial-Setup/create-a-connection-request-for-the-centralized-api-business-hub-enterprise-c7bda8c.md) + - [Updating the Connection Request Credentials for a Pending Request](API-Management/APIM-Initial-Setup/updating-the-connection-request-credentials-for-a-pending-request-dd37a7b.md) + - [Approve the Pending Connection Requests](API-Management/APIM-Initial-Setup/approve-the-pending-connection-requests-e296f80.md) + - [Updating the Connection Request Credentials for an Approved Request](API-Management/APIM-Initial-Setup/updating-the-connection-request-credentials-for-an-approved-request-882e1d9.md) - [Build API Proxies](API-Management/build-api-proxies-74c042b.md) - [Key Components of an API](API-Management/key-components-of-an-api-19c0654.md) - [API Proxy](API-Management/api-proxy-8962643.md) @@ -224,32 +220,24 @@ How to use SAP API Management - [Consume API Proxies](API-Management/consume-api-proxies-ea561e4.md) - [Onboard an Application Developer](API-Management/onboard-an-application-developer-786d107.md) - [Register on API business hub enterprise](API-Management/register-on-api-business-hub-enterprise-c85fafe.md) - - [Managing the Access Request of the Users \[Classic Design\]](API-Management/managing-the-access-request-of-the-users-classic-design-5b3e2f6.md) - [Managing the Access Request of the Users \[New Design\]](API-Management/managing-the-access-request-of-the-users-new-design-8b79ee8.md) - - [Revoke Access \[Classic Design\]](API-Management/revoke-access-classic-design-147fb9d.md) - [Revoke Access \[New Design\]](API-Management/revoke-access-new-design-ce609bb.md) - [Delete Data of Unregistered Users](API-Management/delete-data-of-unregistered-users-d548233.md) - - [Configure the API business hub enterprise \[Classic Design\]](API-Management/configure-the-api-business-hub-enterprise-classic-design-7b71b16.md) - - [Manage Updates \[Classic Design\]](API-Management/manage-updates-classic-design-94e37b4.md) - - [Manage Navigation Categories \[Classic Design\]](API-Management/manage-navigation-categories-classic-design-7f1a44b.md) - - [Configure the API business hub enterprise \[New Design\]](API-Management/configure-the-api-business-hub-enterprise-new-design-54b4607.md) + - [Configure API business hub enterprise](API-Management/configure-api-business-hub-enterprise-54b4607.md) - [Customize the Visual Format of the API business hub enterprise](API-Management/customize-the-visual-format-of-the-api-business-hub-enterprise-2eacd52.md) - - [Manage Domain Categories \[New Design\]](API-Management/manage-domain-categories-new-design-bd9691d.md) - - [Manage Notifications \[New Design\]](API-Management/manage-notifications-new-design-df32457.md) - - [Manage External Content \(New Design\)](API-Management/manage-external-content-new-design-f5bd17d.md) - - [Manage Access](API-Management/manage-access-9df3ece.md) - - [Subscribe to a Product \[Classic Design\]](API-Management/subscribe-to-a-product-classic-design-2e586e1.md) - - [Subscribe to a Product \[New Design\]](API-Management/subscribe-to-a-product-new-design-486d263.md) - - [Create an Application \[Classic Design\]](API-Management/create-an-application-classic-design-7b4e71b.md) - - [Example: Accessing the Custom Attributes of an Application](API-Management/example-accessing-the-custom-attributes-of-an-application-1cbd94c.md) - - [View Applications, Costs, and Analyze Reports \[New Design\]](API-Management/view-applications-costs-and-analyze-reports-new-design-fca4d8c.md) - - [Create an Application \[New Design\]](API-Management/create-an-application-new-design-a501a6d.md) - - [Creating an Application with Application Developer Role \[New Design\]](API-Management/creating-an-application-with-application-developer-role-new-design-99515fc.md) - - [Creating an Application with API business hub enterprise Administrator Role \[New Design\]](API-Management/creating-an-application-with-api-business-hub-enterprise-administrator-role-new-design-df4f777.md) + - [Manage Domain Categories](API-Management/manage-domain-categories-bd9691d.md) + - [Manage Notifications](API-Management/manage-notifications-df32457.md) + - [Manage External Content](API-Management/manage-external-content-f5bd17d.md) + - [Manage Developer Access](API-Management/manage-developer-access-9df3ece.md) + - [Subscribe to a Product](API-Management/subscribe-to-a-product-486d263.md) + - [View Applications, Costs, and Analyze Reports](API-Management/view-applications-costs-and-analyze-reports-fca4d8c.md) + - [Create an Application](API-Management/create-an-application-a501a6d.md) + - [Creating an Application with Application Developer Role](API-Management/creating-an-application-with-application-developer-role-99515fc.md) + - [Creating an Application with API business hub enterprise Administrator Role](API-Management/creating-an-application-with-api-business-hub-enterprise-administrator-role-df4f777.md) - [Consume Applications](API-Management/consume-applications-d4f6fda.md) - [Analyze Applications](API-Management/analyze-applications-deb57dd.md) - [Consume API Proxies Using SAP Business Application Studio](API-Management/consume-api-proxies-using-sap-business-application-studio-15732eb.md) - - [Test Runtime Behavior of APIs \[New Design\]](API-Management/test-runtime-behavior-of-apis-new-design-15c7d52.md) + - [Test Runtime Behavior of APIs](API-Management/test-runtime-behavior-of-apis-15c7d52.md) - [Analyze APIs](API-Management/analyze-apis-7712c61.md) - [API Analytics](API-Management/api-analytics-6766dc3.md) - [Analytics Dashboard](API-Management/analytics-dashboard-ee416ac.md) @@ -296,7 +284,7 @@ How to use SAP API Management - [Migrating API Management Subscription Created Using the Starter Plan Service Instance to Different Subaccounts](API-Management/APIM-Migration/migrating-api-management-subscription-created-using-the-starter-plan-service-instan-1f4ed86.md) - [Migration of API Management Content between Cloud Foundry Environments](API-Management/APIM-Migration/migration-of-api-management-content-between-cloud-foundry-environments-17f09f3.md) - [Prerequisites for the Source and the Target System](API-Management/APIM-Migration/prerequisites-for-the-source-and-the-target-system-1b181dd.md) - - [Clone API Management Content for Cloud Foundry to Cloud Foundry Migration](API-Management/APIM-Migration/clone-api-management-content-for-cloud-foundry-to-cloud-foundry-migration-2e5d127.md) + - [Clone API Management Content between Cloud Foundry Environments](API-Management/APIM-Migration/clone-api-management-content-between-cloud-foundry-environments-2e5d127.md) - [Cloned and Uncloned Entities](API-Management/APIM-Migration/cloned-and-uncloned-entities-b2b393d.md) - [Tenant Cloning Tool Behavior](API-Management/APIM-Migration/tenant-cloning-tool-behavior-b23c603.md) - [Post Cloning Tasks](API-Management/APIM-Migration/post-cloning-tasks-49e9716.md)