diff --git a/docs/ISuite/10-InitialSetup/get-an-sap-business-technology-platform-account-1eda403.md b/docs/ISuite/10-InitialSetup/get-an-sap-business-technology-platform-account-1eda403.md index 3806c42b..a4ae8389 100644 --- a/docs/ISuite/10-InitialSetup/get-an-sap-business-technology-platform-account-1eda403.md +++ b/docs/ISuite/10-InitialSetup/get-an-sap-business-technology-platform-account-1eda403.md @@ -10,7 +10,7 @@ To enable SAP Integration Suite functionality, you must purchase an SAP Business ## Purchase a Customer Account -A customer account is an entitlement that allows you to host the capabilities of SAP Business Technology Platform on your landscape, with round the clock [Support](../70-Support/support-6abc874.md). To purchase an account, contact an SAP sales representative or visit us on [SAP Business Technology Platform](https://www.sap.com/sea/products/business-technology-platform.html) . +A customer account is an entitlement that allows you to host the capabilities of SAP Business Technology Platform on your landscape, with round the clock . To purchase an account, contact an SAP sales representative or visit us on [SAP Business Technology Platform](https://www.sap.com/sea/products/business-technology-platform.html) . General information about SAP Integration Suite is available [here](https://www.sap.com/sea/products/integration-suite.html). Before making the purchase, you can use the estimator [tool](https://www.sap.com/products/business-technology-platform/price-list/estimator-tool.html) to derive the Pricing information for your business use case. 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 3c48f145..9a42186a 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 @@ -14,6 +14,16 @@ Subscribe to the SAP Integration Suitein SAP BTP cockpit and assign the Integrat - You’ve created a subaccount in your assigned global account using the SAP BTP cockpit and added the desired service plans for Integration Suite to the subaccount. For more information on service plans, see [SAP Discovery Center - Integration Suite](https://discovery-center.cloud.sap/serviceCatalog/integration-suite?region=all). +- If you want to use Integration Suite with the **Starter** service plan, additionally assign the entitlement *integration\_flows* to your subaccount. This entitlement along with the appropriate quota assignment is a prerequiste to create custom integration flows. For more information about the service plans, see SAP Note [2903776](https://me.sap.com/notes/2903776). + + > ### Note: + > If you are unable to assign the *integration\_flows* entitlement, contact the administrator of your subaccount or global account. + + +> ### Tip: +> We recommend you clear your browser cookies and cache after subscribing to the application and assigning roles. If you still can't access the application with the correct roles, log out and log back in to resolve the issue. + +You can watch a short video to learn about subscribing and configuring initial access here: diff --git a/docs/ISuite/20-Working_with_SAP_Integration_Suite_Home/working-with-integration-suite-home-a53dce3.md b/docs/ISuite/20-Working_with_SAP_Integration_Suite_Home/working-with-integration-suite-home-a53dce3.md index 9a3d6b95..1aa96da5 100644 --- a/docs/ISuite/20-Working_with_SAP_Integration_Suite_Home/working-with-integration-suite-home-a53dce3.md +++ b/docs/ISuite/20-Working_with_SAP_Integration_Suite_Home/working-with-integration-suite-home-a53dce3.md @@ -87,12 +87,17 @@ Tab +Cloud Integration + + + + API Management -Cloud Integration +Event Mesh @@ -114,12 +119,17 @@ Discover + *Discover* \> *Integrations* + + + + *Discover* \> *APIs* - *Discover* \> *Integrations* + @@ -141,12 +151,17 @@ Design :pencil2: + *Design* \> *Integrations and APIs* + + + + *Design* \> *Graph* - *Design* \> *Integrations and APIs* + @@ -168,6 +183,11 @@ Test + + + + + *Test* \> *APIs* @@ -195,12 +215,17 @@ Configure + + + + + *Configure* \> *APIs* - + *Configure* \> *Event Mesh* @@ -222,6 +247,11 @@ Engage + + + + + @@ -249,12 +279,17 @@ Monitor + *Monitor* \> *Integrations and APIs* + + + + *Monitor* \> *Analyze APIs* - *Monitor* \> *Integrations and APIs* + *Monitor* \> *Event Mesh* @@ -276,12 +311,17 @@ Inspect Resource Consumption + + + + + - + @@ -303,6 +343,11 @@ Monetize + + + + + *Monitor* \> *APIs* @@ -349,6 +394,11 @@ NA NA + + + +NA + @@ -361,7 +411,7 @@ Settings :gear: -*Settings* \> *APIs* +*Settings* \> *Integrations* *Settings* \> *Runtime* @@ -370,13 +420,18 @@ Settings :gear: -*Settings* \> *Integrations* +*Settings* \> *APIs* *Settings* \> *Runtime* + + + + + NA @@ -471,7 +526,7 @@ Built-in support. You can activate built-in support by choosing ### Note: -> The procedure to set up HTTP connections depends on whether you use Cloud Integration in the Cloud Foundry or in the Neo environment. - **Related Information** [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).") [Tutorial: Set Up Inbound OAuth Client Credentials Grant Authentication for API Clients with SAP-Generated Certificate](https://developers.sap.com/tutorials/btp-integration-suite-oauth-client-certificate.html) diff --git a/docs/ISuite/40-RemoteSystems/images/grant-type-01_20fac43.png b/docs/ISuite/40-RemoteSystems/images/grant-type-01_20fac43.png new file mode 100644 index 00000000..f8104905 Binary files /dev/null and b/docs/ISuite/40-RemoteSystems/images/grant-type-01_20fac43.png differ diff --git a/docs/ISuite/40-RemoteSystems/images/grant-type-02_0e87127.png b/docs/ISuite/40-RemoteSystems/images/grant-type-02_0e87127.png new file mode 100644 index 00000000..cc5c522d Binary files /dev/null and b/docs/ISuite/40-RemoteSystems/images/grant-type-02_0e87127.png differ diff --git a/docs/ISuite/40-RemoteSystems/images/grant-type-04_b17141e.png b/docs/ISuite/40-RemoteSystems/images/grant-type-04_b17141e.png new file mode 100644 index 00000000..5121d283 Binary files /dev/null and b/docs/ISuite/40-RemoteSystems/images/grant-type-04_b17141e.png differ diff --git a/docs/ISuite/40-RemoteSystems/introduction-10dc4a3.md b/docs/ISuite/40-RemoteSystems/introduction-10dc4a3.md index 1c110d6c..ce25304a 100644 --- a/docs/ISuite/40-RemoteSystems/introduction-10dc4a3.md +++ b/docs/ISuite/40-RemoteSystems/introduction-10dc4a3.md @@ -1139,6 +1139,22 @@ See: [JDBC for SAP HANA Platform \(On-Premise\)](../50-Development/jdbc-for-sap- +*Jira* + +Receiver adapter + + + + +Enables SAP Integration Suite to connect to Jira. + +See: [Jira Receiver Adapter](../50-Development/jira-receiver-adapter-d15b560.md) + + + + + + *JMS* Sender adapter diff --git a/docs/ISuite/40-RemoteSystems/oauth-with-client-credentials-grant-for-integration-flow-processing-6c052ce.md b/docs/ISuite/40-RemoteSystems/oauth-with-client-credentials-grant-for-integration-flow-processing-6c052ce.md index a2ac4ae1..144097de 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,12 +27,17 @@ 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) + > [Set Up Inbound OAuth Client Credentials Grant Authentication for Senders Calling Integration Flows with SAP-Generated Certificate](https://developers.sap.com/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/specific-use-cases-8fdb213.md b/docs/ISuite/40-RemoteSystems/specific-use-cases-8fdb213.md index 971fb7f5..0b43b3ea 100644 --- a/docs/ISuite/40-RemoteSystems/specific-use-cases-8fdb213.md +++ b/docs/ISuite/40-RemoteSystems/specific-use-cases-8fdb213.md @@ -11,5 +11,3 @@ [Using Custom IDP with SAP Cloud Integration](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/c59610d483974fcda631af4a2aae586b.html "") :arrow_upper_right: -[Setting Up OAuth Configurations in Customer Account, Neo Environment](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/b5e75eaf95534baaa7c9bc2ac020391c.html "With a REST API you can manage roles and their assignments to users.") :arrow_upper_right: - diff --git a/docs/ISuite/40-RemoteSystems/update-service-instance-that-contains-deprecated-client-x509-grant-type-0a38373.md b/docs/ISuite/40-RemoteSystems/update-service-instance-that-contains-deprecated-client-x509-grant-type-0a38373.md new file mode 100644 index 00000000..b9463a2e --- /dev/null +++ b/docs/ISuite/40-RemoteSystems/update-service-instance-that-contains-deprecated-client-x509-grant-type-0a38373.md @@ -0,0 +1,80 @@ + + +# Update Service Instance that Contains Deprecated client\_x509 Grant Type + +This information is relevant for you when you operate scenarios using Cloud Integration inbound authentication with client certificates and service instances with client\_x509 grant type. This affects all users who have set up such a scenario before March 2022. + +For SAP Cloud Integration, the client\_x509 grant type has already been removed from the SAP BTP cockpit user interface in March 2022. + +By the end of 2024, grant-type *client\_x509* is deprecated. Grant type *client\_x509* was required to call Cloud Integration endpoints with an *External Certificate* \(see [Creating Service Instance and Service Key for Inbound Authentication](creating-service-instance-and-service-key-for-inbound-authentication-19af5e2.md)\). It is substituted by the *client\_credentials* grant type. While service instances with *client\_x509* grant type continue to work, its recommended to replace existing *client\_x509* service instances. To do this, replace the *client\_x509* grant type by *client\_credential* grant type. + + + + + +## Updating Affected Service Instances + +To find out if a service instance is affected, perform the following steps: + +1. SAP BTP cockpit and select *Services* \> *Instances and Subscriptions* \> *.* + +2. Select a service instance. + + > ### Note: + > Only service instances with service *Process Integration Runtime* are relevant. + +3. Select *View Parameters*. + + ![](images/grant-type-01_20fac43.png) + +4. In the popup, choose the *JSON* tab. + +5. If under *Grant-types* there is the entry *client\_x509*, this service instance is affected. + + ![](images/grant-type-02_0e87127.png) + +6. Copy the JSON representation to a text editor and replace entry `client_x509` by `client_credentials`. + +7. Save the text for later reference. + +8. Create a new service instance and provide the JSON configuration from the text editor. + +9. For each service key in the old service instance, create a new service key in the new service instance. + + - Open each old service key and copy the value of *certificate* and *certificate-pinning*. You can open a service key by clicking the service key name. This will show the service key details. + + Example: + + ``` + { + "oauth": { + ..., + ..., + "certificate": "...", + "certificate-pinning": "...", + ..., + ..., + ... + } + } + ``` + + - During the creation of the service keys in the new instance, reuse the existing values from the old service instance. The key type must always have the key type *External Certificate*. + + Example: + + ![](images/grant-type-04_b17141e.png) + + - As long as the old service key is not deleted, the creation of the new service key fails with the following error message: + + `Certificate already exists for Follower within Leader with appid […].` + + Resolve this error by deleting the old service key before creating the new service key. + + > ### Note: + > Deleting a service key means that the client that is using this specific certificate for inbound authentication is no longer able to call integration flow or API endpoints. It is crucial to make sure that a service key with the certificate is recreated in the new service instance. + + + +See also: [Cloud Integration on CF - How to Setup Secure HTTP Inbound Connection with Client Certificates](https://community.sap.com/t5/technology-blogs-by-sap/cloud-integration-on-cf-how-to-setup-secure-http-inbound-connection-with/ba-p/13393777) \(SAP Community blog\) + diff --git a/docs/ISuite/50-Development/IntegrationSettings/runtime-profiles-8007daa.md b/docs/ISuite/50-Development/IntegrationSettings/runtime-profiles-8007daa.md index 22d1c2cf..acc535b7 100644 --- a/docs/ISuite/50-Development/IntegrationSettings/runtime-profiles-8007daa.md +++ b/docs/ISuite/50-Development/IntegrationSettings/runtime-profiles-8007daa.md @@ -54,6 +54,39 @@ See [Integration Artifact Types](../integration-artifact-types-bf932e0.md) + + + + + +**Cloud Integration – Starter** + + + + +Cloud-based integration runtime of Cloud Integration for the **Starter** service plan. + + + + +- Integration Flow + +- Message Mapping + +- Script Collection + +- Value Mapping + +- Integration Adapter \(only for prepackaged standard content\) + + + + + + + +See SAP Note [2903776](https://me.sap.com/notes/2903776) for more information on the scope of the runtime profile. + diff --git a/docs/ISuite/50-Development/add-custom-attributes-to-an-application-39c3cbd.md b/docs/ISuite/50-Development/add-custom-attributes-to-an-application-39c3cbd.md index 57633b8e..ab7efd93 100644 --- a/docs/ISuite/50-Development/add-custom-attributes-to-an-application-39c3cbd.md +++ b/docs/ISuite/50-Development/add-custom-attributes-to-an-application-39c3cbd.md @@ -6,7 +6,7 @@ You can create applications on behalf of other application developers, add custo The custom attributes at application level have values assigned to them. These values help in configuring and accessing them on runtime easily. Here, when admin creates an application on behalf of developer at application level, custom attributes can be assigned by the admin. Therefore, this helps you in enhancing the functionality and performing attribute specific runtime enforcements for your API. -**Role of a API business hub enterprise Administrator**: +**Role of a Developer Hub Administrator**: - Create an application on behalf of a user and handover the application key and secret to that user. - Create new applications in different landscapes\(example: production, non-production\) by maintaining the same application key and secret. @@ -14,7 +14,7 @@ The custom attributes at application level have values assigned to them. These v **Visibility of List of Applications** -When a user has permission, "ManageAllAPISubscriptions" or is a API business hub enterprise admin, they can view *My Workspace* tab on the home page of the API business hub enterprise. After choosing *My Workspace* tab, they can view the following changes: +When a user has permission, "ManageAllAPISubscriptions" or is a Developer Hub admin, they can view *My Workspace* tab on the home page of the Developer Hub. After choosing *My Workspace* tab, they can view the following changes: - A list of all the applications created for the tenant by all the developers. - Navigate to the application details screen by selecting one of the applications. Hence, *My Workspace* tab also helps in managing all the applications. diff --git a/docs/ISuite/50-Development/add-partner-414b97d.md b/docs/ISuite/50-Development/add-partner-414b97d.md new file mode 100644 index 00000000..b0d289c8 --- /dev/null +++ b/docs/ISuite/50-Development/add-partner-414b97d.md @@ -0,0 +1,123 @@ + + +# Add Partner + +Add a new partner to the Partner Directory. + + + +When you create a partner, you must specify a partner ID \(PID\) first that identifies the partner in the Partner Directory. For each partner \(with a given PID\), you can then create multiple entries for different entities \(such like string parameter, binary parameter, alternative partner, and authorized user\). + + + +1. Go to *Monitor* \> *Integrations and APIs*. + +2. Choose *Partner Directory*. +3. Select *\+* \(*Add*\). + +4. On the *Create Partner Entry* dialog, specify the *PID*. + + This ID identifies the partner within the Partner Directory. + + Make sure that the entered value is unique within the Partner Directory. + +5. Specify the *Entity Type*. + +6. Specify the remaining parameters. Which parameters are available, depends on the chosen entity type \(see also: [Partner Directory Entity Types](partner-directory-entity-types-950f4b2.md)\). + + **** + + + + + + + + + + + + + + + + + + + + + + + +
+ + Entity Type + + + + Specify the Following Attributes + +
+ + *String Parameters* + + + + - *ID* + + - *Value* + + + + +
+ + *Binary Parameters* + + + + - *ID* + + - *Value* + + - *Content Type* + + - *Encoding* + + Only available if for *Content Type* one of the following options has been selected: *xml*, *xsl*, *xsd*, *json*, *text*. + + + + +
+ + *Alternative Partners* + + + + - *Agency* + + - *Scheme* + + - *ID* + + + + +
+ + *Authorized Users* + + + + *User* + +
+ +7. Select *Create*. + + With the new partner, you have also created the first partner entity. + +8. If you like to add more entities for the partner, click and repeat the previous steps. + + diff --git a/docs/ISuite/50-Development/adding-activity-parameters-655a594.md b/docs/ISuite/50-Development/adding-activity-parameters-655a594.md new file mode 100644 index 00000000..3cd8ae07 --- /dev/null +++ b/docs/ISuite/50-Development/adding-activity-parameters-655a594.md @@ -0,0 +1,38 @@ + + +# Adding Activity Parameters + +Add activity parameters to your agreement. + + + +## Context + +Activity Parameters are specific settings and rules that govern the electronic data interchange \(EDI\) or business-to-business \(B2B\) transactions between trading partners. These parameters define how transactions are processed, transmitted, and validated, ensuring seamless data exchange and compliance with industry standards and regulations. Activity Parameters are typically outlined in the Trading Partner Agreement \(TPA\) and are agreed upon by both parties. + +The *Activity Parameters* allows you to either use dynamic parameters that are maintained in the trading partner/company profile or create a new parameter. + +To add any activity parameters to your transaction, peform the steps below: + + + +## Procedure + +1. Select anywhere outside the transaction flow to view the generic tabs and select the *Activity Parameters* tab. + +2. Choose *Add Parameters*. This will display the following options: + + 1. *Extend from Company*: This option allows you to use the dynamic parameters from the company profile used in the agreement template. You can choose either *Inbound* or *Outbound* and this will display the list of parameters respectively. Select a parameter from the list and choose *Save*. + + If you want to know how to add dynamic parameters to a company profile, see [Parameters](parameters-ec72fcf.md). + + 2. *Extend from TP*: This option allows you to use the dynamic parameters from the trading partner profile used in the agreement template. You can choose either *Inbound* or *Outbound* and this will display the list of parameters respectively. Select a parameter from the list and choose *Save*. + + If you want to know how to add dynamic parameters to a trading partner profile, see [Parameters](parameters-d13b835.md). + + 3. *Create Activity Parameters*: You can also create your own activity paramaters using this option. Select this option and choose *Inbound* or *Outbound*. Maintain the values of the fields *Parameter Key* and *Value* and choose *Save*. + + +3. To define custom attributes, see [Adding Custom Search Attributes](adding-custom-search-attributes-934bbcd.md). + + diff --git a/docs/ISuite/50-Development/adding-custom-search-attributes-934bbcd.md b/docs/ISuite/50-Development/adding-custom-search-attributes-934bbcd.md new file mode 100644 index 00000000..8be63bbf --- /dev/null +++ b/docs/ISuite/50-Development/adding-custom-search-attributes-934bbcd.md @@ -0,0 +1,131 @@ + + + + +# Adding Custom Search Attributes + +Add Custom Search Attributes to your agreement. + + + + + +## Prerequisites + +You have defined custom search attributes in the *Configuration Manager* tab. See [Configuration Manager](configuration-manager-7daf06c.md). + + + +## Context + +Custom search attributes allow you to search for interchanges based on the user-defined filters in the **Monitor** section. To add custom search attributes to the transaction, perform the steps below: + + + +## Procedure + +1. Navigate to the *Custom Search Attributes* tab and choose *Add*. + + > ### Note: + > To know how to create a custom search attribute, see [Configuration Manager](configuration-manager-7daf06c.md). + +2. In the resulting dialog, maintain the following fields: + + **Custom Search Attribute** + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + Field + + + + Description + +
+ + Name + + + + Select a value from the list of attributes that you have created. + +
+ + Source Type + + + + Select whether your source is of type *Parameter* or *XPath*. + +
+ + Source Value + + + + Enter the source value for the name. If you chose *Source Type* as *Parameter*, you need to enter the parameter here. If you chose *XPath*, then you need to enter the xpath of the source value. + +
+ + Data Source + + + + Select whether you want the data source in *Sender Interchange* or *Receiver Interchange*. + +
+ + Business Transaction Activity + + + + Select the direction of the business transaction activity from the drop-down list. + +
+ +3. Choose *Save*. + + > ### Note: + > You can view these custom search attributes in B2B Monitor tab once the agreement is activated. To know more, see [Update Agreements](update-agreements-b5e1fc9.md). + + + + + + +## Results + +With this, you have now successfully created a trading partner agreement and you can view the agreement details under the *Agreements* tab. You can also view the administrative information under the tab. To enable those fields, choose *Settings* :gear: icon and select the following fields and choose *OK*: + +- Created By + +- Created Date +- Last Modified By +- Modified Date + diff --git a/docs/ISuite/50-Development/adding-externally-managed-apis-523ff94.md b/docs/ISuite/50-Development/adding-externally-managed-apis-523ff94.md index 8dd4da43..c4fb2ced 100644 --- a/docs/ISuite/50-Development/adding-externally-managed-apis-523ff94.md +++ b/docs/ISuite/50-Development/adding-externally-managed-apis-523ff94.md @@ -37,7 +37,7 @@ To add an externally managed API, you must import the API definition of an exter This API will only be listed in SAP Integration Suite, and it's lifecycle will not be managed. - In order to access externally managed APIs in the API business hub enterprise, you need to add these APIs to a product and then publish the product. For more information on how to create a product, see [Create a Product](https://help.sap.com/docs/integration-suite/sap-integration-suite/create-product?q=import%20an%20APi&version=CLOUD). + In order to access externally managed APIs in the Developer Hub, you need to add these APIs to a product and then publish the product. For more information on how to create a product, see [Create a Product](https://help.sap.com/docs/integration-suite/sap-integration-suite/create-product?q=import%20an%20APi&version=CLOUD). > ### Note: > While you can add externally managed APIs to a product, you will not be able to include rate plans or add custom attributes for them. diff --git a/docs/ISuite/50-Development/api-details-014d6ad.md b/docs/ISuite/50-Development/api-details-014d6ad.md index c894d68d..b1f344bf 100644 --- a/docs/ISuite/50-Development/api-details-014d6ad.md +++ b/docs/ISuite/50-Development/api-details-014d6ad.md @@ -9,8 +9,6 @@ The API details correspond to the details shown in the SAP Business Accelerator [Integration Content](integration-content-d1679a8.md "Manage integration artifacts for your tenant.") -[Log Files, Neo Environment](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/93bc3722533741c7a48eec6a8352f060.html "Access technical system logs written during message processing on the worker/runtime node.") :arrow_upper_right: - [Message Processing Logs](message-processing-logs-827a2d7.md "Get an overview of the messages processed on a tenant and get the details for individual messages. The message processing log (MPL) stores data about the messages processed on a tenant. Furthermore, it stores information about the individual processing steps for each processed message.") [Message Stores](message-stores-1aab5e9.md "Get data from Message Stores for processed messages and resources of the used JMS queues.") diff --git a/docs/ISuite/50-Development/api-proxy-states-091cda4.md b/docs/ISuite/50-Development/api-proxy-states-091cda4.md index 088a3a5f..217304b2 100644 --- a/docs/ISuite/50-Development/api-proxy-states-091cda4.md +++ b/docs/ISuite/50-Development/api-proxy-states-091cda4.md @@ -91,5 +91,5 @@ When you deprecate or decommission an API proxy, you must provide a deprecation The API state is to be used only for demarcation, and doesn’t play a role in the governance or lifecycle of the API. > ### Note: -> An application developer can view the states of the deprecated and decommissioned API proxies \(if published in the Integration Suite\) in the API details screen of the API business hub enterprise. +> An application developer can view the states of the deprecated and decommissioned API proxies \(if published in the Integration Suite\) in the API details screen of the Developer Hub. 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 74ef9b49..91e20dcb 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 @@ -17,12 +17,12 @@ Assign permission to a product in the SAP Integration Suite . ## Context -Whenever you create a product or edit a draft product, permissions can be added to product. Use this procedure to grant permission to user roles for discovering and subscribing to the product in the API business hub enterprise. Only users who are assigned the required role can discover and subscribe to the product. +Whenever you create a product or edit a draft product, permissions can be added to product. Use this procedure to grant permission to user roles for discovering and subscribing to the product in the Developer Hub. Only users who are assigned the required role can discover and subscribe to the product. > ### 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. +> Currently, we do not support assigning of permissions to the products defined in the remote API portals that are connected to a centralised Developer Hub. > -> \*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). +> \*Remote API portals are those that are not in the same subaccount as the centralised Developer Hub and are configured via the manage connections. For more information, [Centralized Developer Hub](../centralized-developer-hub-38422de.md). @@ -36,9 +36,9 @@ Whenever you create a product or edit a draft product, permissions can be added Here, whenever a product is created or a draft product is edited, permissions can be added to product. -4. Select a role from the *Discovery* dropdown list. Only users who are assigned the selected role can discover this product in the API business hub enterprise. +4. Select a role from the *Discovery* dropdown list. Only users who are assigned the selected role can discover this product in the Developer Hub. -5. Select a role from the *Subscription* dropdown list. Only users who are assigned the selected role can subscribe to this product in the API business hub enterprise. +5. Select a role from the *Subscription* dropdown list. Only users who are assigned the selected role can subscribe to this product in the Developer Hub. - You can change the roles selected for *Discovery* and *Subscription* by choosing *Edit*. diff --git a/docs/ISuite/50-Development/b2b-scenarios-c55eb4d.md b/docs/ISuite/50-Development/b2b-scenarios-c55eb4d.md index 97632591..2c1f9bd2 100644 --- a/docs/ISuite/50-Development/b2b-scenarios-c55eb4d.md +++ b/docs/ISuite/50-Development/b2b-scenarios-c55eb4d.md @@ -11,7 +11,7 @@ The *B2B Scenarios* tab allows you to manage all your B2B related transactions a 2. [Creating a Trading Partner Profile](creating-a-trading-partner-profile-542fb11.md) 3. [Creating a Communication Partner Profile](creating-a-communication-partner-profile-49a6b02.md) 4. [Creating an Agreement Template](creating-an-agreement-template-9692cb1.md) -5. [Creating a Trading Partner Agreement](creating-a-trading-partner-agreement-9bd43c9.md) +5. [Trading Partner Agreement](trading-partner-agreement-9bd43c9.md) **Related Information** diff --git a/docs/ISuite/50-Development/billing-service-a4e2fb8.md b/docs/ISuite/50-Development/billing-service-a4e2fb8.md index de2a691a..9756d7ca 100644 --- a/docs/ISuite/50-Development/billing-service-a4e2fb8.md +++ b/docs/ISuite/50-Development/billing-service-a4e2fb8.md @@ -2,7 +2,7 @@ # Billing Service -Billing service is available in both SAP Integration Suite and API business hub enterprise. +Billing service is available in both SAP Integration Suite and Developer Hub. Using billing service, you can view the bill details and download bill details for a specific developer and for a specific month. @@ -29,7 +29,7 @@ Service to view bills : - Required in API business hub enterprise + Required in Developer Hub @@ -153,9 +153,9 @@ 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, +- You can also view the bill details in the SAP Integration Suite and Developer Hub. 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: + - [View Bill Details in the Developer Hub](https://help.sap.com/viewer/66d066d903c2473f81ec33acfe2ccdb4/Cloud/en-US/4ddac6740f344f8d8260bbf2db97d950.html "View the bill details in the Developer Hub 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 60092b43..a7798da5 100644 --- a/docs/ISuite/50-Development/build-api-proxies-74c042b.md +++ b/docs/ISuite/50-Development/build-api-proxies-74c042b.md @@ -33,6 +33,6 @@ To build an API, you need to perform the following tasks: 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**. + > In order to achieve an effortless navigation to the Developer Hub, choose *Navigation Links*\(![](../images/Finalgrid_1a621ca.png)\) from the SAP Integration Suite and select **Developer Hub**. diff --git a/docs/ISuite/50-Development/configuration-manager-7daf06c.md b/docs/ISuite/50-Development/configuration-manager-7daf06c.md index fd0fe07c..e76ed15d 100644 --- a/docs/ISuite/50-Development/configuration-manager-7daf06c.md +++ b/docs/ISuite/50-Development/configuration-manager-7daf06c.md @@ -20,7 +20,7 @@ The *B2B Scenarios* tab under the *Monitor* section allows you to monitor the in 3. Enter a meaningful name in the *Name* field and provide a description in the *Description* field. 4. Choose *Save*. The custom search attribute has been created successfully. -After creating your custom attribute, you need to assign these attributes to a transaction for it to reflect in the B2B monitor. To know more, see [Creating a Trading Partner Agreement](creating-a-trading-partner-agreement-9bd43c9.md). +After creating your custom attribute, you need to assign these attributes to a transaction for it to reflect in the B2B monitor. To know more, see [Trading Partner Agreement](trading-partner-agreement-9bd43c9.md). *How are the custom search attributes consumed* diff --git a/docs/ISuite/50-Development/configure-a-message-client-867c517.md b/docs/ISuite/50-Development/configure-a-message-client-867c517.md index 221f03a3..3bdf12d3 100644 --- a/docs/ISuite/50-Development/configure-a-message-client-867c517.md +++ b/docs/ISuite/50-Development/configure-a-message-client-867c517.md @@ -41,4 +41,6 @@ Create a service binding: A binding of the service instance is created to the Event Mesh capability. + You can also view the message client in the Integration Suite UI. Navigate to *Configure* \> *Event Mesh* to view all the associated message clients. + diff --git a/docs/ISuite/50-Development/configure-adapter-in-communication-channels-1f06633.md b/docs/ISuite/50-Development/configure-adapter-in-communication-channels-1f06633.md index ed24f652..2238d288 100644 --- a/docs/ISuite/50-Development/configure-adapter-in-communication-channels-1f06633.md +++ b/docs/ISuite/50-Development/configure-adapter-in-communication-channels-1f06633.md @@ -954,6 +954,22 @@ See: [JDBC for SAP HANA Platform \(On-Premise\)](jdbc-for-sap-hana-platform-on-p +*Jira* + +Receiver adapter + + + + +Enables SAP Integration Suite to connect to Jira. + +See: [Jira Receiver Adapter](jira-receiver-adapter-d15b560.md) + + + + + + *JMS* Sender adapter diff --git a/docs/ISuite/50-Development/configure-csv-to-xml-converter-fe33888.md b/docs/ISuite/50-Development/configure-csv-to-xml-converter-fe33888.md index afa51d03..7a9005c8 100644 --- a/docs/ISuite/50-Development/configure-csv-to-xml-converter-fe33888.md +++ b/docs/ISuite/50-Development/configure-csv-to-xml-converter-fe33888.md @@ -117,6 +117,11 @@ You’re editing the integration flow in the editor. + > ### Note: + > The CSV to XML flow step, version 1.4 and above, supports dynamic configurations for fields such as XML Schema, Path to Target Element in XSD, and Record Marker in CSV. For a header or property, the accepted format is "$\{header.\}" or "$\{property.\}". For the partner directory, the accepted format is "pd::". + > + > In addition to the above, for XML Schema, you now have the ability to consume an XSD file from the partner directory in binary form. For this, the accepted format for the partner directory is "pd:::binary". + 4. Save or deploy the configuration. diff --git a/docs/ISuite/50-Development/configure-the-odata-v4-receiver-adapter-cd66a12.md b/docs/ISuite/50-Development/configure-the-odata-v4-receiver-adapter-cd66a12.md index 67cf01d9..c0d6c68c 100644 --- a/docs/ISuite/50-Development/configure-the-odata-v4-receiver-adapter-cd66a12.md +++ b/docs/ISuite/50-Development/configure-the-odata-v4-receiver-adapter-cd66a12.md @@ -521,24 +521,23 @@ Description Select the operation that you want to perform. -The adapter supports *Function Import* for the following return types: - -- Entity +- Batch Processing \($batch\) -- Collection of entities + > ### Remember: + > For the Batch Processing operation, the maximum XML payload size supported is 2 MB. If your payload is more than 2 MB, message processing fails. -- Complex types +- Create\(POST\) -- Collection of complex types +- Query\(GET\) -- Simple types +- Update\(PUT\) -- Collection of simple types +- Delete\(DELETE\) -- Void +- Patch\(PATCH\) -*The function Import*can also be consumed in the *$batch* mode. +To leverage all operations, always use the latest version of the adapter. diff --git a/docs/ISuite/50-Development/configure-the-processdirect-receiver-adapter-5b7327d.md b/docs/ISuite/50-Development/configure-the-processdirect-receiver-adapter-5b7327d.md index 6049ae22..d54f7732 100644 --- a/docs/ISuite/50-Development/configure-the-processdirect-receiver-adapter-5b7327d.md +++ b/docs/ISuite/50-Development/configure-the-processdirect-receiver-adapter-5b7327d.md @@ -4,6 +4,10 @@ You use the ProcessDirect receiver adapter to establish fast and direct communication between integration flows by reducing latency and network overhead provided both of them are available within a same tenant. +Two integration flows, a producer integration flow, and a consumer integration flow, can be directly connected using the ProcessDirect adapter. As shown in the figure, the producer integration flow utilizes a ProcessDirect receiver adapter to send a message to the consumer integration flow, which, in turn, uses a ProcessDirect sender adapter to receive the message. + +![](images/ProcessDirect_47d56c7.png) + Once you have created a receiver channel and selected the ProcessDirect receiver adapter, you can configure the following attributes. See [Overview of Integration Flow Editor](overview-of-integration-flow-editor-db10beb.md). Select the *General* tab and provide values in the fields as follows. @@ -64,7 +68,11 @@ Address -URL of the target system that you are connecting to. For example, /localiprequiresnew. +Address of the ProcessDirect sender adapter in the consumer integration flow you like to connect to. + +Example: + +`/myConsumerIntegrationFlow` > ### Note: > It may or may not start with "/". It can contain alphanumeric characters and special characters such as underscore "\_" or hyphen "-". You can also use simple expressions, for example, $\{header.address\}. diff --git a/docs/ISuite/50-Development/configure-the-processdirect-sender-adapter-e340d4c.md b/docs/ISuite/50-Development/configure-the-processdirect-sender-adapter-e340d4c.md index 02ba2080..66cd68c8 100644 --- a/docs/ISuite/50-Development/configure-the-processdirect-sender-adapter-e340d4c.md +++ b/docs/ISuite/50-Development/configure-the-processdirect-sender-adapter-e340d4c.md @@ -4,6 +4,10 @@ You use the ProcessDirect sender adapter to establish fast and direct communication between integration flows by reducing latency and network overhead provided both of them are available within a same tenant. +Two integration flows, a producer integration flow, and a consumer integration flow, can be directly connected using the ProcessDirect adapter. As shown in the figure, the producer integration flow utilizes a ProcessDirect receiver adapter to send a message to the consumer integration flow, which, in turn, uses a ProcessDirect sender adapter to receive the message. + +![](images/ProcessDirect_47d56c7.png) + Once you have created a sender channel and selected the ProcessDirect sender adapter, you can configure the following attributes. See [Overview of Integration Flow Editor](overview-of-integration-flow-editor-db10beb.md). Select the *General* tab and provide values in the fields as follows. @@ -64,7 +68,11 @@ Address -URL of the target system that you are connecting to. For example, /localiprequiresnew. +Address of the ProcessDirect sender adapter in the consumer integration flow. The producer integration flow uses this address to reach the sender adapter in the consumer integration flow. + +Example: + +`/myConsumerIntegrationFlow` > ### Note: > It may or may not start with "/". It can contain alphanumeric characters and special characters such as underscore "\_" or hyphen "-". You can also use simple expressions, for example, $\{header.address\}. 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 d0f18615..0c721c0d 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 @@ -113,21 +113,17 @@ Relative path to read the file from a directory. Example: `parentdirectory/child -Name of the file to be read. - -If you do not enter a file name and the parameter remains blank, all the files in the specified directory are read. +Name of the file to be read. If you do not enter a file name and the parameter remains blank, all the files in the specified directory are read. When you use an expression to include files from subdirectories, the relative path from the root directory of the user and the actual file name are evaluated. For more information, see [3529367](https://me.sap.com/notes/3529367) > ### Note: -> **Usage of expressions and file name patterns:** -> -> Expressions, such as `ab*`, `a.*`, `*a*`, `*a`, `?b`, and so on, are supported. +> For simple expressions: > -> - The expression `*` replaces no character or an arbitrary number of characters. +> - Expressions, such as `ab*`, `a.*`, `*a*`, `*a`, `?b`, and so on, are supported. > -> - The expression `?` replaces exactly one arbitrary character. +> - The expression \* replaces no character or an arbitrary number of characters. > +> - The expression ? replaces exactly one arbitrary character. > -> When you use an expression to include files from subdirectories, the relative path from the root directory of the user and the actual file name are evaluated. > > Examples: > @@ -433,7 +429,14 @@ When this option is selected, the polling process is performed on a single worke -*Sorting* +*Sorting* + +This field is enabled only if *Poll on One Worker Only* is checked. + +> ### Note: +> From adpater version 1.16 onwards, the *Sorting* field is accessible only when *Poll on One Worker Only* is enabled. + + diff --git a/docs/ISuite/50-Development/configure-the-sftp-sender-adapter-used-with-the-poll-enrich-step-1f15fe2.md b/docs/ISuite/50-Development/configure-the-sftp-sender-adapter-used-with-the-poll-enrich-step-1f15fe2.md index 0b9d2970..97b17458 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 @@ -120,20 +120,18 @@ You can configure this parameter by entering a dynamic expression such like `${p -Name of the file to be read. +Name of the file to be read. If you do not enter a file name and the parameter remains blank, all the files in the specified directory are read. When you use an expression to include files from subdirectories, the relative path from the root directory of the user and the actual file name are evaluated. For more information, see [3529367](https://me.sap.com/notes/3529367) > ### Note: -> **Usage of expressions and file name patterns:** +> For simple expressions: > -> Expressions, such as `ab*`, `a.*`, `*a*`, `*a`, `?b`, and so on, are supported. +> - Expressions, such as `ab*`, `a.*`, `*a*`, `*a`, `?b`, and so on, are supported. > -> - The expression `*` replaces no character or an arbitrary number of characters. +> - The expression \* replaces no character or an arbitrary number of characters. > -> - The expression `?` replaces exactly one arbitrary character. +> - The expression ? replaces exactly one arbitrary character. > > -> When you use an expression to include files from subdirectories, the relative path from the root directory of the user and the actual file name are evaluated. -> > Examples: > > - If you want to include files from subdirectories \(see *Property Include Subdirectories* in the *Processing Tab*\), you need to consider the relative path in your pattern, for example, by using `*file.txt`. diff --git a/docs/ISuite/50-Development/copy-partner-entity-d110a04.md b/docs/ISuite/50-Development/copy-partner-entity-d110a04.md new file mode 100644 index 00000000..a61ce3ab --- /dev/null +++ b/docs/ISuite/50-Development/copy-partner-entity-d110a04.md @@ -0,0 +1,146 @@ + + +# Copy Partner Entity + +Copy a Partner Directory entity. + + + +The main use case of copying a Partner Directory entity is to use it in the context of another partner \(PID\). + +1. Go to *Monitor* \> *Integrations and APIs*. + +2. Choose *Partner Directory*. +3. In the master table, select a partner. + +4. In the detailed table at right, select first a tab for the entity type \(for example, String Parameters\) and then entry. + +5. Choose *Actions* \> *Copy*. + +6. On the *Copy * screen, edit the attributes of the entity. The editable attributes depend on the entity type, as shown in table below \(see also: [Partner Directory Entity Types](partner-directory-entity-types-950f4b2.md)\). + + **** + + + + + + + + + + + + + + + + + + + + + + + +
+ + Entity Type + + + + Edit the Following Attributes + +
+ + *String Parameters* + + + + - *PID* + + Specify the new partner for which the authorized user should apply. + + - *ID* + + Is predefined but can be changed. + + - *Value* + + Is predefined but can be changed. + + + + +
+ + *Binary Parameters* + + + + - *PID* + + Specify the new partner for which the authorized user should apply. + + - *ID* + + Is predefined but can be changed. + + - *Value* + + Is predefined but can be changed. + + - *Content Type* + + Is predefined but can be changed. + + - *Encoding* + + Is predefined but can be changed. + + Only available if for *Content Type* one of the following options has been selected: *xml*, *xsl*, *xsd*, *json*, *text*. + + + + +
+ + *Alternative Partners* + + + + - *PID* + + - *Agency* + + Is already prefilled but can be changed. + + - *Scheme* + + Is already prefilled but can be changed. + + - *ID* + + + + +
+ + *Authorized Users* + + + + - *PID* + + - *User* + + Is already prefilled but can be changed. + + + + +
+ +7. Choose *Copy*. + + diff --git a/docs/ISuite/50-Development/create-a-product-d769622.md b/docs/ISuite/50-Development/create-a-product-d769622.md index 1eb6d085..4afd5a74 100644 --- a/docs/ISuite/50-Development/create-a-product-d769622.md +++ b/docs/ISuite/50-Development/create-a-product-d769622.md @@ -46,7 +46,7 @@ You create a product when you want to expose one or more API proxies to the Appl 5. For the product, enter a *Name* and *Title*, provide an introductory text in the *Short Text* field, and a brief description in the *Description* field. > ### Note: - > If you publish a product with a short introductory text, the short text appears on the corresponding API business hub enterprise pages. It appears on the product tiles on the API business hub enterprise landing page, and on the product details page. It also appears on the search result page for the searched products. + > If you publish a product with a short introductory text, the short text appears on the corresponding Developer Hub pages. It appears on the product tiles on the Developer Hub landing page, and on the product details page. It also appears on the search result page for the searched products. > > If you leave the short text field empty, the product description is displayed instead of the short text in the product tile. diff --git a/docs/ISuite/50-Development/create-a-webhook-subscription-e120b8b.md b/docs/ISuite/50-Development/create-a-webhook-subscription-e120b8b.md new file mode 100644 index 00000000..7b2e7efa --- /dev/null +++ b/docs/ISuite/50-Development/create-a-webhook-subscription-e120b8b.md @@ -0,0 +1,169 @@ + + +# Create a Webhook Subscription + +Understand how to create webhook subscriptions. + + + + + +## Prerequisites + +- You've created a message client. See: [Configure A Message Client](configure-a-message-client-867c517.md). + +- You've created a queue. See: [Create A Queue](create-a-queue-95357fa.md). + +- You've the URL of your online webhook. + + + + +## Procedure + +1. Choose *Configure* \> *Event Mesh*. Choose a message client. + + A webhook subscription is configured within a message client. + +2. Choose *Create*. + + The *Create Webhook Subscription* wizard comes up. + +3. Provide a name for the subscription. + +4. Select a queue from the list. + + Your webhook must always associate with a queue. The messages that the queue receives are relayed to your webhook. + + > ### Note: + > Event Mesh can send up to 18 messages in parallel from a queue to your webhook. + +5. Select an option for *Quality of Service*. + + The supported values are: + + - *0* – When you choose Quality of Service *0*, Event Mesh attempts only once to deliver the messages to your webhook. Event Mesh doesn't wait for acknowledgement from your webhook and deletes the messages from the queue after attempting to deliver. + + - *1* – When you choose QoS 1, Event Mesh attempts to deliver the messages to your to your webhook at least once, that is, waits for an acknowledgement from your webhook. If your webhook responds with a 2XX HTTP response code, the messages are deleted from the queue. If your webhook responds with other codes, Event Mesh keeps trying to redeliver the message until your webhook responds with a 2XX response code. + + The retry mechanism works in such a way that with every new unackowledged retry, the wait time between the retries get exponentially longer. The retry starts with redelivering after 15 minutes and gets longer until it eventually becomes once per day. + + > ### Remember: + > - If there are 18 unacknowledged messages \(that is, there is no 2XX response code\), Event Mesh won't attempt to consume more messages from the queue until the first 18 messages are acknowledged by your webhook. If any unacknowledged message is successfully redelivered, next message in the queue is consumed. + > + > - If Event Mesh stops delivering messages to the webhook, the messages are persisted for a maximum time-to-live as per the configuration of the queue. After maximum time-to-live, the messages are purged. For more information, see [Create A Queue](create-a-queue-95357fa.md). + + +6. Enable *Exempt Handshake* only if you don't want Event Mesh to make a handshake request with your webhook before relaying messages. + + For more information about handshake, see [Handshake and Its Status](handshake-and-its-status-a65d213.md). + +7. Turn on the toggle *On Premise* if you want to connect your webhook that is hosted on an on-premises landscape. + + 1. Enter the *Location ID* that you used in Cloud Connector to configure connectivity to your on-premise system. + + +8. Enter the URL of your webhook. + +9. Enter a *Contet Type* you want to assign to the messages that are relayed from a queue to your webhook. + + By default, if an event and its message contain the content type header, Event Mesh passes on the same to your webhook. Only in cases of messages without a defined content type, Event Mesh consideres the value you provide here. + + If the message contains neither its own content type nor a default content type defined in Event Mesh, then ** is applied as the content type. + + Event Mesh supports all standard HTTP content types. + +10. Select an *Authentication* method using which Event Mesh must securely access your webhook. + + Supported authentication methods are: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + Authentication Methods + + + + Explanation + +
+ + *None* + + + +   + +
+ + *Basic* + + + + Provide a username and password. + +
+ + *OAuth 2.0* + + + + Supports the following: + + - OAuth2 Client Credentials – if you want Event Mesh to authenticate with a combination of client ID, client secret, and token URL. + + - OAuth2 with X.509 – if you want Event Mesh to authenticate with a combination of client ID, token URL, certificate, and key. + + + + +
+ + *API Key* + + + + Provide the API key name and API key value. + +
+ + *X.509 Certificate* + + + + Upload a certificate and key. + +
+ +11. Choose *Create*. + + +[Webhook Subscriptions](../webhook-subscriptions-58e3729.md "A webhook subscription is a configuration on the message client that facilitates message delivery from a queue to REST-based consumers.") + +[Consuming the Connectivity Service](https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf/consuming-connectivity-service?version=Cloud) + diff --git a/docs/ISuite/50-Development/create-partner-directory-entity-f41418f.md b/docs/ISuite/50-Development/create-partner-directory-entity-f41418f.md new file mode 100644 index 00000000..6fd5c1c1 --- /dev/null +++ b/docs/ISuite/50-Development/create-partner-directory-entity-f41418f.md @@ -0,0 +1,130 @@ + + +# Create Partner Directory Entity + +Create an entity for an existing partner. + + + +1. Go to *Monitor* \> *Integrations and APIs*. + +2. Choose *Partner Directory*. +3. In the master table, select a partner. + +4. In the detailed table at right, choose the tab with the type of the entity that you like to create \(for example *String Parameters*\). + +5. Select *Create*. + +6. On the *Create * screen, enter the attributes of the entity. Which attributes to specify depends on the entity type, as shown in table below \(see also: [Partner Directory Entity Types](partner-directory-entity-types-950f4b2.md)\). + + **** + + + + + + + + + + + + + + + + + + + + + + + +
+ + Entity Type + + + + Specify the Following Attributes + +
+ + *String Parameters* + + + + - *PID* + + Is already prefilled but can be changed. + + - *ID* + + - *Value* + + + + +
+ + *Binary Parameters* + + + + - *PID* + + Is already prefilled but can be changed. + + - *ID* + + - *Value* + + - *Content Type* + + - *Encoding* + + Only available if for *Content Type* one of the following options has been selected: *xml*, *xsl*, *xsd*, *json*, *text*. + + + + +
+ + *Alternative Partners* + + + + - *PID* + + Is already prefilled but can be changed. + + - *Agency* + + - *Scheme* + + - *ID* + + + + +
+ + *Authorized Users* + + + + - *PID* + + Is already prefilled but can be changed. + + - *User* + + + + +
+ +7. Select *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 deleted file mode 100644 index 0ea69eba..00000000 --- a/docs/ISuite/50-Development/creating-a-trading-partner-agreement-9bd43c9.md +++ /dev/null @@ -1,1077 +0,0 @@ - - - - -# Creating a Trading Partner Agreement - -A trading partner agreement is an agreement of a contract defined by two trading parties that have decided to exchange certain business data or items using a B2B scenario for fullfilling the agreed trading/business process in a given business context. - -Creating an agreement is the last step in the design of a B2B transaction and consists of two trading partners representing one type of transaction between those two partners. Follow the following procedure to create a trading partner agreement. - -The trading partner agreement is created out of a predefined template. There has been an update on the template format and, both the old and updated templates are available for creating an agreement. The procedure varies for both the templates and the corresponding steps are provided in the respective sections. - -> ### Note: -> The sections *Activity Parameters* and *Custom Search Attributes* in this chapter are common to both the template formats. - -*Agreement Creation Mode* - -The new agreement template comprises of alias based configurations that help with maintaining information such as trading partner details and B2B transaction details directly in the agreement template. With this template, there could be situations where multiple trading partners have the same B2B scenarios defined. In such cases, if a change has to be done for a B2B scenario, you need to make individual changes in each of the agreement consisting of that scenario. To help avoid this, while creating an agreement, you can now choose to copy or reference the B2B scenarios from the template. With *Copy* mode, the agreement that you create will have its own set of B2B scenarios\(replicated from the agreement template\) and you can edit and make changes to them. With *Reference* mode, your agreement will only refer to the B2B scenarios that exist in the template. In this mode, the B2B scenarios are not editable in the agreement and they can be updated only by editing them in the actual agreement template. If you have multiple trading partners using the same B2B scenarios, then with *Reference* mode, you can make the changes only once in the referenced template and the changes will get updated in the agreements directly. - -You can choose between these two modes at the time of agreement creation. The options provided are: - -- *Copy from Template*: This will copy the B2B scenarios from the template into your agreement and you can make changes to them directly in your agreement. The changes made to the B2B scenarios will be applicable only for that agreement. - -- *Bind with Template*: This will bind your agreement with the template by referencing the B2B scenarios available in the agreement template. So the newly created agreement will have B2B scenarios that are read-only. If you want to update the transactions, you can do so by editing them in their referencing template and the changes will be applied automatically to the referencing agreements. - -> ### Note: -> The *Bind with Template* mode does not apply for the templates with *Outdated Format*. - -The creation modes apply only for the agreements you newly create. The agreements that were created in the past do not have the *Creation Mode* field displayed and can no longer be edited or copied. They have to be migrated to the latest format to continue editing. Follow the steps mentioned in [Migrating an Agreement](migrating-an-agreement-bdcf534.md) to migrate your old agreements to this new format. - - - - - -## Create Agreement - Outdated Format - -1. Log on to your application. -2. Choose *Design* \> *B2B Scenarios*. -3. Navigate to *Agreements* tab and choose *Create*. - -4. This will display a list of agreement templates available in the system. The templates with outdated format will have the label *Outdated Format* right after the name. Select the template that you want to use for your agreement and choose *Next*. - - > ### Note: - > SAP does not provide any pre-defined templates. Ensure you have the required template created before creating an agreement. To know more, see [Creating an Agreement Template](creating-an-agreement-template-9692cb1.md) - -5. The next screen displays the creation mode with *Copy from Template* selected by default. This is because the referencing option is not applicable for the templates with outdated format. The *Transactions* table provides a list of transactions available under the template. Select one or more transactions from the list for your agreement. -6. Select the trading partner from the drop-down list under *Select Trading Partner* section and choose *Open Draft*. -7. In the *Overview* tab, maintain the following fields under the *Details* section - - **Details** - - - - - - - - - - - - - - - - - - - -
- - Field - - - - Description - -
- - Name - - - - Name of the agreement - -
- - Description - - - - Provide a description of your agreement - -
- - Version - - - - Enter a version for your agreement - -
- -8. Maintain the following fields under *My Company Details* section. - - **My Company Details** - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - Field - - - - Description - -
- - System - - - - Select a system from the drop-down list - -
- - Type System - - - - Select a type system from the drop-down list - -
- - Contact Person - - This field appears only when you choose *GS1 XML* as the type system. - - - - Select a contact person from the drop-down list. - - > ### Note: - > You need to have the Business Expert to assign a contact person. To know more on assigning roles, see [Configuring User Access to SAP Integration Suite](../configuring-user-access-to-sap-integration-suite-2c6214a.md). - - - -
- - Type System Version - - - - Select a type system version from the drop-down list - -
- - Identifier in Company Type System - - - - Select an identifier using the value help provided. You can also create an identifier using the :heavy_plus_sign: button. - -
- - Identifier as Trading Partner Type System - - - - Select an identifier from your company that will be the trading partner. This field can be set only after defining the *Type System* field of the trading partner. You can also create an identifier using the :heavy_plus_sign: button. - -
- -9. Maintain the following fields under *Trading Partner Details* section. The *Name* of the trading partner is autofilled based on the value you chose in step 6. - - **Trading Partner Details** - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - Field - - - - Description - -
- - Name - - - - Name of the trading partner - -
- - System - - - - Select a system from the drop-down list - -
- - Type System - - - - Select a type system from the drop-down list - -
- - Contact Person - - This field appears only when you choose *GS1 XML* as the type system. - - - - Select a contact person from the drop-down list. - - > ### Note: - > You need to have the Business Expert to assign a contact person. To know more on assigning roles, see [Configuring User Access to SAP Integration Suite](../configuring-user-access-to-sap-integration-suite-2c6214a.md). - - - -
- - Type System Version - - - - Select a type system version from the drop-down list - -
- - Identifier in Trading Partner Type System - - - - Select an identifier using the value help provided. You can also create an identifier using the :heavy_plus_sign: button. - -
- - Identifier in Company Type System - - - - Select an identifier from the trading partner for the company. You can also create an identifier using the :heavy_plus_sign: button. - -
- -10. Choose *Save*. Once you save the agreement, the *Overview* tab also displays the *Purpose* of the type system you chose. -11. Navigate to the *B2B Scenarios* tab. This tab displays the transactions that you chose from the agreement template. Choose *Edit* to start working with the transactions. -12. 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 for Sender Functional Acknowledgement*. - - > ### 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 [Update Agreements](update-agreements-b5e1fc9.md) - -15. Select the *Interchange* step on the sender side. -16. Set the target decimal value of the incoming payload in the *Target Decimal Character* field. - - > ### Note: - > This field appears only for **UN/EDIFACT** type system. - -17. 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. Once you choose a MIG, the message type used within that MIG is displayed under the *Message Type* field. - - > ### Note: - > - Ensure you have the required MIG created in the Integration Advisor. - > - > - Trading Partner Management only supports the following type systems: - > - Edifact - > - > - X12 - > - SAP IDoc - > - SAP SOAP On-Premise - > - SAP SOAP Cloud - > - GS1 XML - > - Tradacoms - > - > Tradacoms is supported only in the 2.0 version of the integration package *Cloud Integration - Trading Partner Management V2* - > - > - > - For Type Systems *ASC X12* and *UN/EDIFACT*, you can edit their version numbers in the *Type System Version* field. - -18. Select a value from the drop-down list for the field *Create Acknowledgement*. - - > ### Note: - > This field appears only for the following type systems: - > - > - UN/EDIFACT - > - > - ASC X12 - > - > You can view the status of the Functional Acknowledgement through the *Monitor* tab. To know more, see [Update Agreements](update-agreements-b5e1fc9.md) - -19. If you are planning to use custom integration flows for Pre-Processing of your interchange step, then enable the checkbox for the field *Customized Pre-Processing*. -20. Provide the address of your custom integration flow in the *Process Direct Address* field. - - > ### 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) - -21. 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. - - If enabled, the generic integration flow will perform a validation check for the sender interchange. And regardless of the outcome, the interchange processing will continue to run. If you want to stop processing the interchange when payload validation fails, enable the checkbox for the field *Stop Processing if Payload Validation Fails*. - -22. 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 - > - > If the identifier used in the agreement has **Custom Scheme Code**, then this option will be skipped irrespective of the field selection. - -23. To archive the sender payload, select the checkbox for the field *Archive Sender Payload*. To know more about archiving data, see [Archiving Payload Data](archiving-payload-data-b927e01.md). -24. Choose the *Mapping* step. -25. Select a mapping guideline using the value help provided for the field *Mapping Guideline\(MAG\)*. - - If you want to view the details of the MAG that you chose, you can use the link provided under the *Version* field. - -26. If you want to use custom integration flow for the Mapping process, enable the checkbox for *Customized Mapping Processing* and provide the address of the integration flow under the field *Process Direct Address* field. - - > ### Note: - > Enabling custom message processing will disable the *Mapping Guideline \(MAG\)* field. - > - > The application now provides you with the *ProcessDirect* adapter that allows you to use your customised integration flow within the generic integration flow. To know more about how it works, see [Interchange Processing Flow](interchange-processing-flow-7d3bce9.md) - -27. Choose the *Communication Channel* on the receiver side and select a value from the drop-down list for the field *Communication*. -28. Select the value for the field *Receiver Functional Acknowledgement Channel*. - - > ### 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 [Update Agreements](update-agreements-b5e1fc9.md) - -29. Select the *Interchange* shape on the receiver side. -30. Choose the value help provided for the *Message Implementation Guideline \(MIG\)* field and select a MIG from the list and select *Choose*. - - > ### Note: - > If you want to view the details of the MIG that you chose, you can use the link provided under the *Version* field. - -31. Select a value from the drop-down list for the field *Number Range*. - - > ### Note: - > A number range is used to insert unique sequence numbers. - > - > You need to configure this number range in the Cloud Integration tenant. To do so, see [Number Ranges](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/b6e17fa17a70491da4a54216db298f84.html). - -32. Similar to the Sender, if you want to use custom integration flows for your Pre/Post-Processing of the interchange step, enable the checkbox under *Custom Integration Flow*. - - > ### Note: - > The application now provides you with the *ProcessDirect* adapter that allows you to use your customised integration flow within the generic integration flow. To know more about how it works, see [Interchange Processing Flow](interchange-processing-flow-7d3bce9.md) - -33. Provide the address path of your custom integration flow in the *Process Direct Address* field. - - > ### Note: - > To know more about how it works, see [Interchange Processing Flow](interchange-processing-flow-7d3bce9.md) - -34. The *Enable Payload Validation* checkbox allows the system to validate the outgoing payload. It is selected by default. Uncheck the option if you want to disable the payload validation. - - If enabled, the generic integration flow will perform a validation check for the receiver interchange. And regardless of the outcome, the interchange processing will continue to run. If you want to stop processing the interchange when payload validation fails, enable the checkbox for the field *Stop Processing if Payload Validation Fails*. - -35. 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). -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. -37. If you want to use custom seperators for your payload, enable the *Use Custom Seperators* checkbox and maintain the values for the following fields: - - > ### Note: - > This option is available only for UN/EDIFACT and ASC X12 type systems. - - - Segment Terminator - - - Composite Seperator - - Data Element Seperator - - Escape Character - -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: - > - > - UN/EDIFACT - > - ASC X12 - > - > - > You also need to maintain the Functional Acknowledgement in the Receiver side. - -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 - -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* - - - *Composite Separator* - - *Data Element Separator* - - *Escape Character* - - > ### 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. - -41. Choose *Save*. - - - - - -## Create Agreement - Latest Format - -1. Log on to your application. -2. Choose *Design* \> *B2B Scenarios*. -3. Navigate to *Agreements* tab and choose *Create*. - -4. This will display a list of agreement templates available in the system. The templates with outdated format will have the label *Outdated Format* right after the name. Select a template without the label if you want to use the latest format for your agreement and choose *Next*. - - > ### Note: - > SAP does not provide any pre-defined templates. Ensure you have the required template created before creating an agreement. To know more, see [Creating an Agreement Template](creating-an-agreement-template-9692cb1.md) - -5. The next screen displays the *Agreement Creation Mode* with the following options: - - - *Copy from Template*: This will copy the B2B scenarios into your agreement from the template. You can edit the transactions in the agreement. - - - *Bind with Template*: This will bind you agreement with the template by creating a reference of the *B2B Scenarios* in the agreement. Here you cannot edit the transactions in the agreement. They can be edited only in the referenced agreement template and updated in the agreement. - - Select an option depending on your requirement. - -6. Under the *Transactions* table, select the transactions for your agreement. - -7. Select the trading partner from the drop-down list under *Select Trading Partner* section and choose *Open Draft*. -8. If you have created this agreement from a template that has communication partner in it, you can see the relevant detail in the *Communication Partner* field in the *Trading Partner Details* section. -9. The newly created agreement will have a field by name *Creation Mode*. This will display the mode that you chose for your agreement. If you chose to copy them into your agreement, it will display *Copied from Template*. If you chose to only reference the B2B scenarios, it will display *Bound with Template* and you can select *Refresh* button if you want to see any latest update on the B2B scenarios. A timestamp near this button displays the last update that was applied on the agreement. -10. If you have maintained the necessary alias information in the template, the corresponding trading partner details will get filled in automatically in the agreement. Steps number 10 to 13 are optional. - - > ### Note: - > As the new agreement template is alias-based, ensure you maintain the right alias across the system. Only then, the right trading partner configuration can be picked up using the alias when creating the agreement. - -11. In the *Overview* tab, maintain the following fields under the *Details* section - - **Details** - - - - - - - - - - - - - - - - - - - -
- - Field - - - - Description - -
- - Name - - - - Name of the agreement - -
- - Description - - - - Provide a description of your agreement - -
- - Version - - - - Enter a version for your agreement - -
- -12. Maintain the following fields under *My Company Details* section. - - **My Company Details** - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - Field - - - - Description - -
- - System - - - - Select a system from the drop-down list - -
- - Type System - - - - Select a type system from the drop-down list - -
- - Contact Person - - This field appears only when you choose *GS1 XML* as the type system. - - - - Select a contact person from the drop-down list. - - > ### Note: - > You need to have the Business Expert to assign a contact person. To know more on assigning roles, see [Configuring User Access to SAP Integration Suite](../configuring-user-access-to-sap-integration-suite-2c6214a.md). - - - -
- - Type System Version - - - - Select a type system version from the drop-down list - -
- - Identifier in Company Type System - - - - Select an identifier using the value help provided. You can also create an identifier using the :heavy_plus_sign: button. - -
- - Identifier as Trading Partner Type System - - - - Select an identifier from your company that will be the trading partner. This field can be set only after defining the *Type System* field of the trading partner. You can also create an identifier using the :heavy_plus_sign: button. - -
- -13. Maintain the following fields under *Trading Partner Details* section. The *Name* of the trading partner is autofilled based on the value you chose in step 6. - - **Trading Partner Details** - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - Field - - - - Description - -
- - Name - - - - Name of the trading partner - -
- - System - - - - Select a system from the drop-down list - -
- - Type System - - - - Select a type system from the drop-down list - -
- - Contact Person - - This field appears only when you choose *GS1 XML* as the type system. - - - - Select a contact person from the drop-down list. - - > ### Note: - > You need to have the Business Expert to assign a contact person. To know more on assigning roles, see [Configuring User Access to SAP Integration Suite](../configuring-user-access-to-sap-integration-suite-2c6214a.md). - - - -
- - Type System Version - - - - Select a type system version from the drop-down list - -
- - Identifier in Trading Partner Type System - - - - Select an identifier using the value help provided. You can also create an identifier using the :heavy_plus_sign: button. - -
- - Identifier in Company Type System - - - - Select an identifier from the trading partner for the company. You can also create an identifier using the :heavy_plus_sign: button. - -
- -14. Choose *Save*. -15. Once you save the agreement, the field *Creation Mode*is displayed showing the creation mode that you chose for your agreement. It will display *Copied from Template* if you had chosen to copy the template into your agreement. - - If you chose to only reference the B2B scenarios, it will display *Bound with Template* and you can select *Refresh* button if you want to see any latest update on the B2B scenarios. A timestamp near this button displays the last update that was applied on the agreement. - - The *Trading Partner Details* section also displays the *Purpose* of the type system you chose. - -16. Navigate to the *B2B Scenarios* tab. This tab displays the transactions that you chose from the agreement template. Choose *Edit* to start working with the transactions. - - > ### Remember: - > The *Edit* option is available only if you chose *Copy from Template* at the time of agreement creation. For referenced B2B scenarios, you can only view them in this tab. - > - > Steps 12 to 35 are optional if you have the template filled with the necessary alias information. With the new template, you can configure all the steps of the transaction including the *Mapping* step. - -17. Choose the *Communication Channel* step on the sender side. -18. Select a value from the drop-down list for the field *Communication*. -19. Select a value from the drop-down list for the field *Communication for Sender Functional Acknowledgement*. - - > ### 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 [Update Agreements](update-agreements-b5e1fc9.md) - -20. Select the *Interchange* step on the sender side. -21. Set the target decimal value of the incoming payload in the *Target Decimal Character* field. - - > ### Note: - > This field appears only for **UN/EDIFACT** type system. - -22. 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. Once you choose a MIG, the message type used within that MIG is displayed under the *Message Type* field. - - > ### Note: - > - Ensure you have the required MIG created in the Integration Advisor. - > - > - Trading Partner Management only supports the following type systems: - > - Edifact - > - > - X12 - > - SAP IDoc - > - SAP SOAP On-Premise - > - SAP SOAP Cloud - > - GS1 XML - > - Tradacoms - > - > Tradacoms is supported only in the 2.0 version of the integration package *Cloud Integration - Trading Partner Management V2* - > - > - > - For Type Systems *ASC X12* and *UN/EDIFACT*, you can edit their version numbers in the *Type System Version* field. - -23. Select a value from the drop-down list for the field *Create Acknowledgement*. - - > ### Note: - > This field appears only for the following type systems: - > - > - UN/EDIFACT - > - > - ASC X12 - > - > You can view the status of the Functional Acknowledgement through the *Monitor* tab. To know more, see [Update Agreements](update-agreements-b5e1fc9.md) - -24. If you are planning to use custom integration flows for Pre-Processing of your interchange step, then enable the checkbox for the field *Customized Pre-Processing*. -25. Provide the address of your custom integration flow in the *Process Direct Address* field. - - > ### 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) - -26. 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. - - If enabled, the generic integration flow will perform a validation check for the sender interchange. And regardless of the outcome, the interchange processing will continue to run. If you want to stop processing the interchange when payload validation fails, enable the checkbox for the field *Stop Processing if Payload Validation Fails*. - -27. 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 - > - > If the identifier used in the agreement has **Custom Scheme Code**, then this option will be skipped irrespective of the field selection. - > - > This option is not editable if you have created the agreement with reference mode \(created using *Bind with Template* option\). - -28. 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) -29. Choose the *Mapping* step. -30. 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. - -31. 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) - -32. Choose the *Communication Channel* on the receiver side and select a value from the drop-down list for the field *Communication*. -33. 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 [Update Agreements](update-agreements-b5e1fc9.md) - -34. Select the *Interchange* shape on the receiver side. -35. 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. - -36. 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). - -37. 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) - -38. 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) - -39. 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. - - If enabled, the generic integration flow will perform a validation check for the receiver interchange. And regardless of the outcome, the interchange processing will continue to run. If you want to stop processing the interchange when payload validation fails, enable the checkbox for the field *Stop Processing if Payload Validation Fails*. - -40. 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) -41. If you want to use custom seperators for your payload, enable the *Use Custom Seperators* checkbox and maintain the values for the following fields: - - > ### Note: - > This option is available only for UN/EDIFACT and ASC X12 type systems. - - - Segment Terminator - - - Composite Seperator - - Data Element Seperator - - Escape Character - -42. 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: - > - > - UN/EDIFACT - > - ASC X12 - > - > - > You also need to maintain the Functional Acknowledgement in the Receiver side. - -43. 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 - -44. 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* - - - *Composite Separator* - - *Data Element Separator* - - *Escape Character* - - > ### 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. - -45. Choose *Save*. - - - - - -## Activity Parameters - -If you want to add any activity parameters to your transaction, select anywhere outside the transaction flow to view the generic tabs and select the *Activity Parameters* tab - -1. 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. You can choose either *Inbound* or *Outbound* and this will display the list of parameters respectively. Select a parameter from the list and choose *Save*. - - If you want to know how to add dynamic parameters to a company profile, see [Creating a Company Profile and a Subsidiary](creating-a-company-profile-and-a-subsidiary-909d928.md) - - - *Extend from TP*: This option allows you to use the dynamic parameters from the trading partner profile used in the agreement template. You can choose either *Inbound* or *Outbound* and this will display the list of parameters respectively. Select a parameter from the list and choose *Save*. - - If you want to know how to add dynamic parameters to a trading partner profile, see [Creating a Trading Partner Profile](creating-a-trading-partner-profile-542fb11.md) - - - *Create Activity Parameters*: You can also create your own activity paramaters using this option. Select this option and choose *Inbound* or *Outbound*. Maintain the values of the fields *Parameter Key* and *Value* and choose *Save*. - - - - - - -## Custom Search Attributes - -If you want to add custom search attributes to the transaction, - -1. Navigate to the *Custom Search Attributes* tab and choose *Add*. - - > ### Note: - > To know how to create a custom search attribute, see [Configuration Manager](configuration-manager-7daf06c.md). - -2. In the resulting dialog, maintain the following fields: - - **Custom Search Attribute** - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - Field - - - - Description - -
- - Name - - - - Select a value from the list of attributes that you have created. - -
- - Source Type - - - - Select whether your source is of type *Parameter* or *XPath*. - -
- - Source Value - - - - Enter the source value for the name. If you chose *Source Type* as *Parameter*, you need to enter the parameter here. If you chose *XPath*, then you need to enter the xpath of the source value. - -
- - Data Source - - - - Select whether you want the data source in *Sender Interchange* or *Receiver Interchange*. - -
- - Business Transaction Activity - - - - Select the direction of the business transaction activity from the drop-down list. - -
- -3. Choose *Save*. - - > ### Note: - > You can view these custom search attributes in B2B Monitor tab once the agreement is activated. To know more, see [Update Agreements](update-agreements-b5e1fc9.md) - - - - -You have now successfully created a trading partner agreement and you can view the agreement details under the *Agreements* tab. You can also view the administrative information under the tab. To enable those fields, choose *Settings* :gear: icon and select the following fields and choose *OK*: - -- Created By - -- Created Date -- Last Modified By -- Modified Date - -**Related Information** - - -[Activating a Trading Partner Agreement](activating-a-trading-partner-agreement-baed0e3.md "Activate your trading partner agreement to push the agreement details into the SAP Cloud Integration partner directory.") - diff --git a/docs/ISuite/50-Development/creating-agreement-latest-format-72679dd.md b/docs/ISuite/50-Development/creating-agreement-latest-format-72679dd.md new file mode 100644 index 00000000..565d6b8b --- /dev/null +++ b/docs/ISuite/50-Development/creating-agreement-latest-format-72679dd.md @@ -0,0 +1,537 @@ + + + + +# Creating Agreement - Latest Format + +Create agreements using the latest template format. + + + +## Context + +The new agreement template comprises of alias based configurations that help with maintaining information such as trading partner details and B2B transaction details directly in the agreement template. With this template, there could be situations where multiple trading partners have the same B2B scenarios defined. In such cases, if a change has to be done for a B2B scenario, you need to make individual changes in each of the agreement consisting of that scenario. To help avoid this, while creating an agreement, you can now choose to copy or reference the B2B scenarios from the template. + +- With Copy mode, the agreement that you create will have its own set of B2B scenarios\(replicated from the agreement template\) and you can edit and make changes to them. + +- With Reference mode, your agreement will only refer to the B2B scenarios that exist in the template. In this mode, the B2B scenarios are not editable in the agreement and they can be updated only by editing them in the actual agreement template. If you have multiple trading partners using the same B2B scenarios, then with Reference mode, you can make the changes only once in the referenced template and the changes will get updated in the agreements directly. + +You can choose between these two modes at the time of agreement creation. The options provided are: + +- *Copy from Template*: This will copy the B2B scenarios from the template into your agreement and you can make changes to them directly in your agreement. The changes made to the B2B scenarios will be applicable only for that agreement. + +- *Bind with Template*: This will bind your agreement with the template by referencing the B2B scenarios available in the agreement template. So the newly created agreement will have B2B scenarios that are read-only. If you want to update the transactions, you can do so by editing them in their referencing template and the changes will be applied automatically to the referencing agreements. + +> ### Note: +> The *Bind with Template* mode does not apply for the templates with *Outdated Format*. + +The creation modes apply only for the agreements you newly create. The agreements that were created in the past do not have the *Creation Mode* field displayed and can no longer be edited or copied. They have to be migrated to the latest format to continue editing. Follow the steps mentioned in [Migrating an Agreement](migrating-an-agreement-bdcf534.md) to migrate your old agreements to this new format. + + + +## Procedure + +1. Log on to your application. + +2. Choose *Design* \> *B2B Scenarios*. + +3. Navigate to *Agreements* tab and choose *Create*. + +4. This will display a list of agreement templates available in the system. The templates with outdated format will have the label *Outdated Format* right after the name. Select a template without the label if you want to use the latest format for your agreement and choose *Next*. + + > ### Note: + > SAP does not provide any pre-defined templates. Ensure you have the required template created before creating an agreement. To know more, see [Creating an Agreement Template](creating-an-agreement-template-9692cb1.md). + +5. The next screen displays the *Agreement Creation Mode* with the following options: + + 1. *Copy from Template*: This will copy the B2B scenarios into your agreement from the template. You can edit the transactions in the agreement. + + 2. *Bind with Template*: This will bind you agreement with the template by creating a reference of the *B2B Scenarios* in the agreement. Here you cannot edit the transactions in the agreement. They can be edited only in the referenced agreement template and updated in the agreement. + + Select an option depending on your requirement. + + +6. Under the *Transactions* table, select the transactions for your agreement. + +7. Select the trading partner from the drop-down list under *Select Trading Partner* section and choose *Open Draft*. + +8. If you have created this agreement from a template that has communication partner in it, you can see the relevant detail in the *Communication Partner* field in the *Trading Partner Details* section. + +9. The newly created agreement will have a field by name *Creation Mode*. This will display the mode that you chose for your agreement. If you chose to copy them into your agreement, it will display *Copied from Template*. If you chose to only reference the B2B scenarios, it will display *Bound with Template* and you can select *Refresh* button if you want to see any latest update on the B2B scenarios. A timestamp near this button displays the last update that was applied on the agreement. + +10. If you have maintained the necessary alias information in the template, the corresponding trading partner details will get filled in automatically in the agreement. Steps number 10 to 13 are optional. + + > ### Note: + > As the new agreement template is alias-based, ensure you maintain the right alias across the system. Only then, the right trading partner configuration can be picked up using the alias when creating the agreement. + +11. In the *Overview* tab, maintain the following fields under the *Details* section: + + **Details** + + + + + + + + + + + + + + + + + + + +
+ + Field + + + + Description + +
+ + Name + + + + Name of the agreement + +
+ + Description + + + + Provide a description of your agreement + +
+ + Version + + + + Enter a version for your agreement + +
+ +12. Maintain the following fields under *My Company Details* section: + + **My Company Details** + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + Field + + + + Description + +
+ + System + + + + Select a system from the drop-down list + +
+ + Type System + + + + Select a type system from the drop-down list + +
+ + Contact Person + + This field appears only when you choose *GS1 XML* as the type system. + + + + Select a contact person from the drop-down list. + + > ### Note: + > You need to have the Business Expert to assign a contact person. To know more on assigning roles, see [Configuring User Access to SAP Integration Suite](../configuring-user-access-to-sap-integration-suite-2c6214a.md). + + + +
+ + Type System Version + + + + Select a type system version from the drop-down list + +
+ + Identifier in Company Type System + + + + Select an identifier using the value help provided. You can also create an identifier using the :heavy_plus_sign: button. + +
+ + Identifier as Trading Partner Type System + + + + Select an identifier from your company that will be the trading partner. This field can be set only after defining the *Type System* field of the trading partner. You can also create an identifier using the :heavy_plus_sign: button. + +
+ +13. Maintain the following fields under *Trading Partner Details* section. The *Name* of the trading partner is autofilled based on the value you chose in Step 6. + + **Trading Partner Details** + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + Field + + + + Description + +
+ + Name + + + + Name of the trading partner + +
+ + System + + + + Select a system from the drop-down list + +
+ + Type System + + + + Select a type system from the drop-down list + +
+ + Contact Person + + This field appears only when you choose *GS1 XML* as the type system. + + + + Select a contact person from the drop-down list. + + > ### Note: + > You need to have the Business Expert to assign a contact person. To know more on assigning roles, see [Configuring User Access to SAP Integration Suite](../configuring-user-access-to-sap-integration-suite-2c6214a.md). + + + +
+ + Type System Version + + + + Select a type system version from the drop-down list + +
+ + Identifier in Trading Partner Type System + + + + Select an identifier using the value help provided. You can also create an identifier using the :heavy_plus_sign: button. + +
+ + Identifier in Company Type System + + + + Select an identifier from the trading partner for the company. You can also create an identifier using the :heavy_plus_sign: button. + +
+ +14. Choose *Save*. + +15. Once you save the agreement, the field *Creation Mode*is displayed showing the creation mode that you chose for your agreement. It will display *Copied from Template* if you had chosen to copy the template into your agreement. + + If you chose to only reference the B2B scenarios, it will display *Bound with Template* and you can select *Refresh* button if you want to see any latest update on the B2B scenarios. A timestamp near this button displays the last update that was applied on the agreement. + + The *Trading Partner Details* section also displays the *Purpose* of the type system you chose. + +16. Navigate to the *B2B Scenarios* tab. This tab displays the transactions that you chose from the agreement template. Choose *Edit* to start working with the transactions. + + > ### Remember: + > The *Edit* option is available only if you chose *Copy from Template* at the time of agreement creation. For referenced B2B scenarios, you can only view them in this tab. + > + > Steps 12 to 35 are optional if you have the template filled with the necessary alias information. With the new template, you can configure all the steps of the transaction including the *Mapping* step. + +17. Choose the *Communication Channel* step on the sender side. + +18. Select a value from the drop-down list for the field *Communication*. + +19. Select a value from the drop-down list for the field *Communication for Sender Functional Acknowledgement*. + + > ### 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 [Update Agreements](update-agreements-b5e1fc9.md). + +20. Select the *Interchange* step on the sender side. + +21. Set the target decimal value of the incoming payload in the *Target Decimal Character* field. + + > ### Note: + > This field appears only for **UN/EDIFACT** type system. + +22. 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. Once you choose a MIG, the message type used within that MIG is displayed under the *Message Type* field. + + > ### Note: + > - Ensure you have the required MIG created in the Integration Advisor. + > + > - Trading Partner Management only supports the following type systems: + > - Edifact + > + > - X12 + > - SAP IDoc + > - SAP SOAP On-Premise + > - SAP SOAP Cloud + > - GS1 XML + > - Tradacoms + > + > Tradacoms is supported only in the 2.0 version of the integration package *Cloud Integration - Trading Partner Management V2* + > + > + > - For Type Systems *ASC X12* and *UN/EDIFACT*, you can edit their version numbers in the *Type System Version* field. + +23. Select a value from the drop-down list for the field *Create Acknowledgement*. + + > ### Note: + > This field appears only for the following type systems: + > + > - UN/EDIFACT + > + > - ASC X12 + > + > You can view the status of the Functional Acknowledgement through the *Monitor* tab. To know more, see [Update Agreements](update-agreements-b5e1fc9.md). + +24. If you are planning to use custom integration flows for Pre-Processing of your interchange step, then enable the checkbox for the field *Customized Pre-Processing*. + +25. Provide the address of your custom integration flow in the *Process Direct Address* field. + + > ### 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). + +26. 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. + + If enabled, the generic integration flow will perform a validation check for the sender interchange. And regardless of the outcome, the interchange processing will continue to run. If you want to stop processing the interchange when payload validation fails, enable the checkbox for the field *Stop Processing if Payload Validation Fails*. + +27. 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 + > + > If the identifier used in the agreement has **Custom Scheme Code**, then this option will be skipped irrespective of the field selection. + > + > This option is not editable if you have created the agreement with reference mode \(created using *Bind with Template* option\). + +28. 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). + +29. Choose the *Mapping* step. + +30. 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. + +31. 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) + +32. Choose the *Communication Channel* on the receiver side and select a value from the drop-down list for the field *Communication*. + +33. 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 [Update Agreements](update-agreements-b5e1fc9.md). + +34. Select the *Interchange* shape on the receiver side. + +35. 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. + +36. 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). + +37. 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). + +38. 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). + +39. 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. + + If enabled, the generic integration flow will perform a validation check for the receiver interchange. And regardless of the outcome, the interchange processing will continue to run. If you want to stop processing the interchange when payload validation fails, enable the checkbox for the field *Stop Processing if Payload Validation Fails*. + +40. 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). + +41. If you want to use custom seperators for your payload, enable the *Use Custom Seperators* checkbox and maintain the values for the following fields: + + > ### Note: + > This option is available only for UN/EDIFACT and ASC X12 type systems. + + - Segment Terminator + + - Composite Seperator + - Data Element Seperator + - Escape Character + +42. 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: + > + > - UN/EDIFACT + > - ASC X12 + > + > + > You also need to maintain the Functional Acknowledgement in the Receiver side. + +43. If you have enabled *Receiver Functional Acknowledgement*, choose *Communication* on the receiver side and set the following values: + + 1. *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). + + 2. *Receiver Functional Acknowledgement Channel*: Select a value from the drop-down list. + + +44. 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* + + - *Composite Separator* + - *Data Element Separator* + - *Escape Character* + + > ### 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. + +45. Choose *Save*. + +46. For further configuration, see: + + 1. [Adding Activity Parameters](adding-activity-parameters-655a594.md) + + 2. [Adding Custom Search Attributes](adding-custom-search-attributes-934bbcd.md) + + +47. 48. You have now successfully created a trading partner agreement and you can view the agreement details under the *Agreements* tab. You can also view the administrative information under the tab. To enable those fields, choose *Settings* :gear: icon and select the following fields and choose *OK*: + + 1. Created By + + 2. Created Date + + 3. Last Modified By + + 4. Modified Date + + + diff --git a/docs/ISuite/50-Development/creating-agreement-outdated-format-5701ddc.md b/docs/ISuite/50-Development/creating-agreement-outdated-format-5701ddc.md new file mode 100644 index 00000000..fe5d244c --- /dev/null +++ b/docs/ISuite/50-Development/creating-agreement-outdated-format-5701ddc.md @@ -0,0 +1,493 @@ + + + + +# Creating Agreement - Outdated Format + +Create a Trading Partner Agreement using the outdated format. + + + +## Context + +You are creating an agreement using the outdated template format. This template does not contain the latest features such as alias-based configuration, creation modes etc. To utilize these features, it is recommended to use the latest format. Agreement templates that are outdated will have the *Outdated Format* label next to their name. + + + +## Procedure + +1. Log on to your application. + +2. Choose *Design* \> *B2B Scenarios*. + +3. Navigate to *Agreements* tab and choose *Create*. + +4. This will display a list of agreement templates available in the system. The templates with outdated format will have the label *Outdated Format* right after the name. Select the template that you want to use for your agreement and choose *Next*. + + > ### Note: + > SAP does not provide any pre-defined templates. Ensure you have the required template created before creating an agreement. To know more, see [Creating an Agreement Template](creating-an-agreement-template-9692cb1.md). + +5. The next screen displays the creation mode with *Copy from Template* selected by default. This is because the referencing option is not applicable for the templates with outdated format. The *Transactions* table provides a list of transactions available under the template. Select one or more transactions from the list for your agreement. + +6. Select the trading partner from the drop-down list under *Select Trading Partner* section and choose *Open Draft*. + +7. In the *Overview* tab, maintain the following fields under the *Details* section: + + + + + + + + + + + + + + + + + + + +
+ + Field + + + + Description + +
+ + Name + + + + Name of the agreement + +
+ + Description + + + + Provide a description of your agreement + +
+ + Version + + + + Enter a version for your agreement + +
+ +8. Maintain the following fields under *My Company Details* section: + + **My Company Details** + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + Field + + + + Description + +
+ + System + + + + Select a system from the drop-down list + +
+ + Type System + + + + Select a type system from the drop-down list + +
+ + Contact Person + + This field appears only when you choose *GS1 XML* as the type system. + + + + Select a contact person from the drop-down list. + + > ### Note: + > You need to have the Business Expert to assign a contact person. To know more on assigning roles, see [Configuring User Access to SAP Integration Suite](../configuring-user-access-to-sap-integration-suite-2c6214a.md). + + + +
+ + Type System Version + + + + Select a type system version from the drop-down list + +
+ + Identifier in Company Type System + + + + Select an identifier using the value help provided. You can also create an identifier using the :heavy_plus_sign: button. + +
+ + Identifier as Trading Partner Type System + + + + Select an identifier from your company that will be the trading partner. This field can be set only after defining the *Type System* field of the trading partner. You can also create an identifier using the :heavy_plus_sign: button. + +
+ +9. Maintain the following fields under *Trading Partner Details* section. The *Name* of the trading partner is autofilled based on the value you chose in Step 6: + + **Trading Partner Details** + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + Field + + + + Description + +
+ + Name + + + + Name of the trading partner + +
+ + System + + + + Select a system from the drop-down list + +
+ + Type System + + + + Select a type system from the drop-down list + +
+ + Contact Person + + This field appears only when you choose *GS1 XML* as the type system. + + + + Select a contact person from the drop-down list. + + > ### Note: + > You need to have the Business Expert to assign a contact person. To know more on assigning roles, see [Configuring User Access to SAP Integration Suite](../configuring-user-access-to-sap-integration-suite-2c6214a.md). + + + +
+ + Type System Version + + + + Select a type system version from the drop-down list + +
+ + Identifier in Trading Partner Type System + + + + Select an identifier using the value help provided. You can also create an identifier using the :heavy_plus_sign: button. + +
+ + Identifier in Company Type System + + + + Select an identifier from the trading partner for the company. You can also create an identifier using the :heavy_plus_sign: button. + +
+ +10. Choose *Save*. Once you save the agreement, the *Overview* tab also displays the *Purpose* of the type system you chose. + +11. Navigate to the *B2B Scenarios* tab. This tab displays the transactions that you chose from the agreement template. Choose *Edit* to start working with the transactions. + +12. 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 for Sender Functional Acknowledgement*. + + > ### 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 [Update Agreements](update-agreements-b5e1fc9.md). + +15. Select the *Interchange* step on the sender side. + +16. Set the target decimal value of the incoming payload in the *Target Decimal Character* field. + + > ### Note: + > This field appears only for **UN/EDIFACT** type system. + +17. 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. Once you choose a MIG, the message type used within that MIG is displayed under the *Message Type* field. + + > ### Note: + > - Ensure you have the required MIG created in the Integration Advisor. + > + > - Trading Partner Management only supports the following type systems: + > - Edifact + > + > - X12 + > - SAP IDoc + > - SAP SOAP On-Premise + > - SAP SOAP Cloud + > - GS1 XML + > - Tradacoms + > + > Tradacoms is supported only in the 2.0 version of the integration package *Cloud Integration - Trading Partner Management V2* + > + > + > - For Type Systems *ASC X12* and *UN/EDIFACT*, you can edit their version numbers in the *Type System Version* field. + +18. Select a value from the drop-down list for the field *Create Acknowledgement*. + + > ### Note: + > This field appears only for the following type systems: + > + > - UN/EDIFACT + > + > - ASC X12 + > + > You can view the status of the Functional Acknowledgement through the *Monitor* tab. To know more, see [Update Agreements](update-agreements-b5e1fc9.md). + +19. If you are planning to use custom integration flows for Pre-Processing of your interchange step, then enable the checkbox for the field *Customized Pre-Processing*. + +20. Provide the address of your custom integration flow in the *Process Direct Address* field. + + > ### 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). + +21. 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. + + If enabled, the generic integration flow will perform a validation check for the sender interchange. And regardless of the outcome, the interchange processing will continue to run. If you want to stop processing the interchange when payload validation fails, enable the checkbox for the field *Stop Processing if Payload Validation Fails*. + +22. 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 + > + > If the identifier used in the agreement has **Custom Scheme Code**, then this option will be skipped irrespective of the field selection. + +23. To archive the sender payload, select the checkbox for the field *Archive Sender Payload*. To know more about archiving data, see [Archiving Payload Data](archiving-payload-data-b927e01.md). + +24. Choose the *Mapping* step. + +25. Select a mapping guideline using the value help provided for the field *Mapping Guideline\(MAG\)*. + + If you want to view the details of the MAG that you chose, you can use the link provided under the *Version* field. + +26. If you want to use custom integration flow for the Mapping process, enable the checkbox for *Customized Mapping Processing* and provide the address of the integration flow under the field *Process Direct Address* field. + + > ### Note: + > Enabling custom message processing will disable the *Mapping Guideline \(MAG\)* field. + > + > The application now provides you with the *ProcessDirect* adapter that allows you to use your customised integration flow within the generic integration flow. To know more about how it works, see [Interchange Processing Flow](interchange-processing-flow-7d3bce9.md). + +27. Choose the *Communication Channel* on the receiver side and select a value from the drop-down list for the field *Communication*. + +28. Select the value for the field *Receiver Functional Acknowledgement Channel*. + + > ### 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 [Update Agreements](update-agreements-b5e1fc9.md). + +29. Select the *Interchange* shape on the receiver side. + +30. Choose the value help provided for the *Message Implementation Guideline \(MIG\)* field and select a MIG from the list and select *Choose*. + + > ### Note: + > If you want to view the details of the MIG that you chose, you can use the link provided under the *Version* field. + +31. Select a value from the drop-down list for the field *Number Range*. + + > ### Note: + > A number range is used to insert unique sequence numbers. + > + > You need to configure this number range in the Cloud Integration tenant. To do so, see [Number Ranges](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/b6e17fa17a70491da4a54216db298f84.html). + +32. Similar to the Sender, if you want to use custom integration flows for your Pre/Post-Processing of the interchange step, enable the checkbox under *Custom Integration Flow*. + + > ### Note: + > The application now provides you with the *ProcessDirect* adapter that allows you to use your customised integration flow within the generic integration flow. To know more about how it works, see [Interchange Processing Flow](interchange-processing-flow-7d3bce9.md). + +33. Provide the address path of your custom integration flow in the *Process Direct Address* field. + + > ### Note: + > To know more about how it works, see [Interchange Processing Flow](interchange-processing-flow-7d3bce9.md). + +34. The *Enable Payload Validation* checkbox allows the system to validate the outgoing payload. It is selected by default. Uncheck the option if you want to disable the payload validation. + + If enabled, the generic integration flow will perform a validation check for the receiver interchange. And regardless of the outcome, the interchange processing will continue to run. If you want to stop processing the interchange when payload validation fails, enable the checkbox for the field *Stop Processing if Payload Validation Fails*. + +35. 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). + +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. + +37. If you want to use custom seperators for your payload, enable the *Use Custom Seperators* checkbox and maintain the values for the following fields: + + > ### Note: + > This option is available only for UN/EDIFACT and ASC X12 type systems. + + - Segment Terminator + + - Composite Seperator + - Data Element Seperator + - Escape Character + +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: + > + > - UN/EDIFACT + > - ASC X12 + > + > + > You also need to maintain the Functional Acknowledgement in the Receiver side. + +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. + +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* + + - *Composite Separator* + - *Data Element Separator* + - *Escape Character* + + > ### 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. + +41. Choose *Save*. + + > ### Note: + > Once saved, the agreement will be rendered read-only. To make further changes, migrate to the latest format. To know more, see [Migrating an Agreement](migrating-an-agreement-bdcf534.md). + +42. For further configuration, see: + + 1. [Adding Activity Parameters](adding-activity-parameters-655a594.md) + + 2. [Adding Custom Search Attributes](adding-custom-search-attributes-934bbcd.md) + + +43. You have now successfully created a trading partner agreement and you can view the agreement details under the *Agreements* tab. You can also view the administrative information under the tab. To enable those fields, choose *Settings* :gear: icon and select the following fields and choose *OK*: + + 1. Created By + + 2. Created Date + + 3. Last Modified By + + 4. Modified Date + + + 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 390364cc..a8eea492 100644 --- a/docs/ISuite/50-Development/creating-an-agreement-template-9692cb1.md +++ b/docs/ISuite/50-Development/creating-an-agreement-template-9692cb1.md @@ -614,5 +614,5 @@ You have now successfully created an agreement template and you can view the tem **Related Information** -[Creating a Trading Partner Agreement](creating-a-trading-partner-agreement-9bd43c9.md "A trading partner agreement is an agreement of a contract defined by two trading parties that have decided to exchange certain business data or items using a B2B scenario for fullfilling the agreed trading/business process in a given business context.") +[Trading Partner Agreement](trading-partner-agreement-9bd43c9.md "Explore and create trading partner agreements.") diff --git a/docs/ISuite/50-Development/custom-attributes-90a5a6d.md b/docs/ISuite/50-Development/custom-attributes-90a5a6d.md index b49aa9d7..7a9da08e 100644 --- a/docs/ISuite/50-Development/custom-attributes-90a5a6d.md +++ b/docs/ISuite/50-Development/custom-attributes-90a5a6d.md @@ -43,7 +43,7 @@ AuthGroup.API.Admin -API business hub enterprise +Developer Hub @@ -362,7 +362,7 @@ Sample payload to create a custom attribute \(application\) - Request Header: Authorization:Bearer - Response: bearer-token value - To know how to retrieve this token, see [Accessing API business hub enterprise APIs Programmatically](../accessing-api-business-hub-enterprise-apis-programmatically-dabee6e.md). + To know how to retrieve this token, see [Accessing Developer Hub APIs Programmatically](../accessing-developer-hub-apis-programmatically-dabee6e.md). @@ -429,7 +429,7 @@ Sample payload to create a custom attribute via navigation \(application\) - Request Header: Authorization:Bearer - Response: bearer-token value - To know how to retrieve this token, see [Accessing API business hub enterprise APIs Programmatically](../accessing-api-business-hub-enterprise-apis-programmatically-dabee6e.md). + To know how to retrieve this token, see [Accessing Developer Hub APIs Programmatically](../accessing-developer-hub-apis-programmatically-dabee6e.md). > ### Sample Code: diff --git a/docs/ISuite/50-Development/decouple-sender-and-flows-without-persistence-31d4dec.md b/docs/ISuite/50-Development/decouple-sender-and-flows-without-persistence-31d4dec.md index 7adacaf3..1add1321 100644 --- a/docs/ISuite/50-Development/decouple-sender-and-flows-without-persistence-31d4dec.md +++ b/docs/ISuite/50-Development/decouple-sender-and-flows-without-persistence-31d4dec.md @@ -45,7 +45,15 @@ The integration flow consists of 2 integration processes: > ### Note: -> For connecting the two integration processes, it is recommended using the ProcessDirect adapter. In our case however, the One-Way message exchange pattern is required which is supported by the SOAP adapter only. Hence, in this case the SOAP adapter is used. +> For connecting the two integration processes, it is recommended using the ProcessDirect adapter. +> +> In our case however, the One-Way message exchange pattern is required which is supported by the SOAP adapter only. Therefore, in this case the SOAP adapter is used. +> +> When using the SOAP adapter, the *Integration Process - Sender* integration process \(short: Sender\) calls the *Integration Process - Receiver* integration process \(short: Receiver\) using the HTTP protocol. Although Sender and Receiver are running on the same tenant in this case, the load balancer is interposed in this call. The Sender calls the load balancer *from the outside*, which forwards the request to the Receiver \(on the same tenant\). +> +> In scenarios where integration flows communicate using the ProcessDirect adapter, the call isn't bypassed through the load balancer. +> +> See: [Decouple Sender and Flows Without Persistence](decouple-sender-and-flows-without-persistence-31d4dec.md) **Receiver integration process** diff --git a/docs/ISuite/50-Development/define-edi-splitter-584a3be.md b/docs/ISuite/50-Development/define-edi-splitter-584a3be.md index 13894430..0d13508d 100644 --- a/docs/ISuite/50-Development/define-edi-splitter-584a3be.md +++ b/docs/ISuite/50-Development/define-edi-splitter-584a3be.md @@ -123,7 +123,7 @@ You use the EDI splitter to split inbound bulk EDI messages, and configure the s - Source Encoding + *Source Encoding* @@ -146,7 +146,7 @@ You use the EDI splitter to split inbound bulk EDI messages, and configure the s - Validate Message + *Validate Message* @@ -165,7 +165,7 @@ You use the EDI splitter to split inbound bulk EDI messages, and configure the s - Validate + *Validate* @@ -184,7 +184,7 @@ You use the EDI splitter to split inbound bulk EDI messages, and configure the s - Decimal Character + *Decimal Character* @@ -202,7 +202,7 @@ You use the EDI splitter to split inbound bulk EDI messages, and configure the s - Transaction Mode + *Transaction Mode* \(Only if *Validate* is selected as *Envelope and Message* @@ -230,7 +230,7 @@ You use the EDI splitter to split inbound bulk EDI messages, and configure the s - EDI Schema Definition + *EDI Schema Definition* @@ -272,7 +272,7 @@ You use the EDI splitter to split inbound bulk EDI messages, and configure the s - Process Invalid Messages + *Process Invalid Messages* \(Only if *Transaction Mode* is selected as *Mesaage*\) @@ -295,7 +295,7 @@ You use the EDI splitter to split inbound bulk EDI messages, and configure the s - Header Name + *Header Name* @@ -316,7 +316,7 @@ You use the EDI splitter to split inbound bulk EDI messages, and configure the s - Create Acknowledgement + *Create Acknowledgement* @@ -353,7 +353,7 @@ You use the EDI splitter to split inbound bulk EDI messages, and configure the s - Customize Envelope + *Customize Envelope* \(Only if *Create Acknowledgment* is selected anything except *Not Required*\) @@ -378,26 +378,28 @@ You use the EDI splitter to split inbound bulk EDI messages, and configure the s - Interchange Number + *Interchange Number* - The splitter uses the interchange number of an EDI message in the functional acknowledgment. It allows the splitter to read the interchange number either from the EDI message or from an assigned set of number ranges. + The splitter added the interchange number in the fucntional acknowledgmenet of an EDImessage. It can be set in either of these ways: - You can also set this field using the header `SAP_EDISPLITTER_EDIFACT_INTERCHANGE_NUMBER`. The values for the headers can be one of the following: - - - `useFromEDIMessage` - - `numberRange` + - *Dynamic*: You can also set this field using the header `SAP_EDISPLITTER_EDIFACT_INTERCHANGE_NUMBER`. The values for the headers can be one of the following: + - `useFromEDIMessage` + - `numberRange` + - *Number Range*: Redas the interchange number from an assigned set of number ranges. + - *Use from EDI Message*: Reads the interchange number either from the EDI message + . - Unique Interchange Number + *Unique Interchange Number* \(Only if you select *Interchange Number* as *Number Range*\) @@ -420,21 +422,28 @@ You use the EDI splitter to split inbound bulk EDI messages, and configure the s - Number Range + *Number Range* Define the number range assigned to an interchange number in the functional acknowledgement. - You can also set this field using the header `SAP_EDISPLITTER_EDIFACT_NUMBER_RANGE`. A unique interchange number is generated for every unique incoming message. A duplicate incoming message is assigned with same interchange number for 30 days. + If *Unique Interchange Number* is set as: + + - *Required*: A new interchange number is generated for every incoming message. + + - *Not Required*: A new interchange number is generated only for unique incoming message. A duplicate incoming message is assigned with same interchange number for 30 days. + + + You can also set this field using the header `SAP_EDISPLITTER_EDIFACT_NUMBER_RANGE`. - CONTRL Message Version + *CONTRL Message Version* @@ -453,7 +462,7 @@ You use the EDI splitter to split inbound bulk EDI messages, and configure the s - Include UNA Segment + *Include UNA Segment* @@ -496,7 +505,7 @@ You use the EDI splitter to split inbound bulk EDI messages, and configure the s - Source Encoding + *Source Encoding* @@ -520,7 +529,7 @@ You use the EDI splitter to split inbound bulk EDI messages, and configure the s - Validate Message + *Validate Message* @@ -544,7 +553,7 @@ You use the EDI splitter to split inbound bulk EDI messages, and configure the s - Transaction Mode + *Transaction Mode* @@ -568,7 +577,7 @@ You use the EDI splitter to split inbound bulk EDI messages, and configure the s - EDI Schema Definition + *EDI Schema Definition* @@ -599,7 +608,7 @@ You use the EDI splitter to split inbound bulk EDI messages, and configure the s - Header Name + *Header Name* @@ -620,7 +629,7 @@ You use the EDI splitter to split inbound bulk EDI messages, and configure the s - Create Acknowledgement + *Create Acknowledgement* @@ -649,9 +658,28 @@ You use the EDI splitter to split inbound bulk EDI messages, and configure the s - Customize Envelope + *Exclude AK3 and AK4* + + + + + Notifies the splitter to exclude the AK3 and AK4 segments from the functional acknowledgement message. However, it retains the details of the AK1, AK2, AK5, and AK9 segments in the functional acknowledgement. - Only if *Create Acknowledgment* is selected anything except *Not Required*, + You can also set this field using the header `SAP_EDISPLITTER_X12_EXCLUDE_AK3_AK4`. The values for the headers can be one of the following: + + - `true` + - `false` + + + + + + + + + *Customize Envelope* + + Only if *Create Acknowledgment* is selected anything except *Not Required* @@ -672,17 +700,19 @@ You use the EDI splitter to split inbound bulk EDI messages, and configure the s - Interchange Number + *Interchange Number* - The splitter uses the interchange number of an EDI message in the functional acknowledgment. It allows the splitter to read the interchange number either from the EDI message or from an assigned set of number ranges. + The splitter adds the interchange number in the functional acknowledgment of an EDI message. The interchange number can be read in either of these ways: - You can also set this field using the header `SAP_EDISPLITTER_X12_INTERCHANGE_NUMBER`. The values for the headers can be one of the following: + - *Use from EDI Message*: Reads the interchange number from the incoming payload + - *Number Range*: Reads the interchange number from an assigned set of number ranges. + - *Dynamic*: You can also set this field using the header `SAP_EDISPLITTER_X12_INTERCHANGE_NUMBER`. The value of the header can be one of the following: + - `useFromEDIMessage` + - `numberRange` - - `useFromEDIMessage` - - `numberRange` @@ -691,16 +721,18 @@ You use the EDI splitter to split inbound bulk EDI messages, and configure the s - Unique Interchange Number + *Unique Interchange Number* + + Only if *Interchange Number* is selected as anything except *Use from EDI Message*. - Following are the options to generate a unique interchange number while generating a acknowledgment message: + Following are the options to generate a unique interchange number while generating an 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. + - *Required*: EDI Splitter can generate a unique interchange number, which is the incremented value from the defined *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_X12_UNIQUE_INTERCHANGE_NUMBER`. The values for the headers can be one of the following: + - *Dynamic*: You can also set this field using the header `SAP_EDISPLITTER_X12_UNIQUE_INTERCHANGE_NUMBER`. The value of the headers can be one of the following: - `required` - `notRequired` @@ -712,33 +744,155 @@ You use the EDI splitter to split inbound bulk EDI messages, and configure the s - Number Range + *Number Range* - Define the number range assigned to an interchange number in the functional acknowledgement. A unique interchange number is generated for every unique incoming message. A duplicate incoming message is assigned with same interchange number for 30 days. + Define the number range assigned to an interchange number in the functional acknowledgement. + + If *Unique Interchange Number* is set as: + + - *Required*: A new interchange number is generated for every incoming message. + + - *Not Required* A new interchange number is generated only for unique incoming message. A duplicate incoming message is assigned with same interchange number for 30 days. + You can also set this field using the header `SAP_EDISPLITTER_X12_NUMBER_RANGE`. The value for the header should be the number range artifact name. + + You can also set this field using the header or property. The syntax is `${header.}` and `${property.`. - Exclude AK3 and AK4 + *Group Number* - Notifies the splitter to exclude the AK3 and AK4 segments from the functional acknowledgement message. However, it retains the details of the AK1, AK2, AK5, and AK9 segments in the functional acknowledgement. + The splitter adds the group segment number in the functional acknowledgment of an EDI message. This number can be set in either of these ways: - You can also set this field using the header `SAP_EDISPLITTER_X12_EXCLUDE_AK3_AK4`. The values for the headers can be one of the following: + - *Dynamic*: You can set this field using the header `SAP_EDISPLITTER_997_GROUP_CONTROL_NUMBER`. The values for the headers can be: + - numberRange + - useFromEDIMessage + - predefined - - `true` - - `false` + - *Predefined \(1\)*: Sets the group segment number to 1 irrespective of the number in incoming payload. + - *Number Range*: Reads from the assigned set of number ranges. + - *Use from EDI Message*: Uses the same group segment number from the incoming payload. + + + + + + + + + *Unique Group Number* + + Only if *Group Number* is selected as *Dynamic* or *Number Range*. + + + + + Following are the options to generate a unique group segment number while generating a acknowledgment message: + + - *Required*: EDI Splitter can generate a unique group segment number, which is the incremented value from the number range object and does not depend on the number of the incoming payload. + - *Not Required*: Does not generate a unique group segment number. + - *Dynamic*: You can also set this field using the header `SAP_EDISPLITTER_997_UNIQUE_GROUP_CONTROL_NUMBER`. The values for the headers can be one of the following: + - `required` + - `notRequired` + + + + + + + + + + *Group Number Range* + + + + + Define the number range assigned to an group segment number in the functional acknowledgement. + + If *Unique Group Number* is set as: + + - *Required*: A new group number is generated for every incoming message. + + - *Not Required* A new group number is generated only for unique incoming message. A duplicate incoming message is assigned with same group number for 30 days. + + + You can also set this field using the header or property. The syntax is `${header.}` and `${property.`. + + + + + + + *Transaction Set Number* + + + + + The splitter adds the transaction segment number in the functional acknowledgment of an EDI message. This number can be set in either of these ways: + + - *Dynamic*: You can set this field using the header`SAP_EDISPLITTER_997_TRANSACTION_SET_NUMBER`. The values for the headers can be:: + - numberRange + - predefined + + - *Predefined \(0001\)*: Sets the transaction set number to 0001 irrespective of the number in incoming payload. + - *Number Range*: Reads from the assigned set of number ranges. + + + + + + + + + *Unique Transaction Set Number* + + Only if *Transaction Set Number* is selected as *Dynamic* or *Number Range*. + + + + + Following are the options to generate a unique transaction set number while generating an acknowledgment message: + + - *Required*: EDI Splitter can generate a unique transaction set number, which is the incremented value from the *Number Range* object and does not depend on the number of the incoming payload. + - *Not Required*: Does not generate a unique transaction set number. + - *Dynamic*: You can also set this field using the header `SAP_EDISPLITTER_EDIFACT_UNIQUE_TRANSACTION_SET_NUMBER`. The values for the headers can be one of the following: + - `required` + - `notRequired` + + + + + + + + + + *Transaction Set Number Range* + + + + + Define the number range assigned to an transaction set number in the functional acknowledgement. + + If *Unique Transaction Set Number* is set as: + + - *Required*: A new transaction set number is generated for every incoming message. + + - *Not Required* A new transaction set number is generated only for unique incoming message. A duplicate incoming message is assigned with same transaction set number for 30 days. + You can also set this field using the header or property. The syntax is `${header.}` and `${property.`. @@ -768,7 +922,7 @@ You use the EDI splitter to split inbound bulk EDI messages, and configure the s - Source Encoding + *Source Encoding* @@ -793,7 +947,7 @@ You use the EDI splitter to split inbound bulk EDI messages, and configure the s - Split Preference + *Split Preference* @@ -818,7 +972,7 @@ You use the EDI splitter to split inbound bulk EDI messages, and configure the s - EDI Schema Definition + *EDI Schema Definition* @@ -847,7 +1001,7 @@ You use the EDI splitter to split inbound bulk EDI messages, and configure the s - Header Name + *Header Name* \(only available if for *EDI Schema Definition* the option *Header* is selected\) @@ -870,7 +1024,7 @@ You use the EDI splitter to split inbound bulk EDI messages, and configure the s - Schemas + *Schemas* \(only available if for *EDI Schema Definition* the option *Integration Flow* is selected\) diff --git a/docs/ISuite/50-Development/delete-partner-83a9bfd.md b/docs/ISuite/50-Development/delete-partner-83a9bfd.md new file mode 100644 index 00000000..8bc0acf2 --- /dev/null +++ b/docs/ISuite/50-Development/delete-partner-83a9bfd.md @@ -0,0 +1,22 @@ + + +# Delete Partner + +Delete a partner from the Partner Directory. + +With this step, you delete a partner and all its entities. + + + +1. Go to *Monitor* \> *Integrations and APIs*. + +2. Choose *Partner Directory*. +3. Ffrom the master table, select the partner you like to delete. + +4. Select the recycle bin icon \(*Delete*\). + +5. On a subsequent screen, confirm this step by entering `DELETE`. + +6. Select *Delete*. + + diff --git a/docs/ISuite/50-Development/delete-partner-entity-25aed52.md b/docs/ISuite/50-Development/delete-partner-entity-25aed52.md new file mode 100644 index 00000000..9e313bb1 --- /dev/null +++ b/docs/ISuite/50-Development/delete-partner-entity-25aed52.md @@ -0,0 +1,22 @@ + + +# Delete Partner Entity + +Delete an entity of a partner from the Partner Directory. + + + +1. Go to *Monitor* \> *Integrations and APIs*. + +2. Choose *Partner Directory*. +3. In the master table, select a partner. + +4. In the detailed table at right, select first a tab for the entity type \(for example, String Parameters\) and then entry. + +5. Choose *Actions* \> *Delete*. + +6. On a subsequent screen, confirm this step by entering `DELETE`. + +7. Select *Delete*. + + diff --git a/docs/ISuite/50-Development/deploying-an-oauth2-client-credentials-artifact-801b106.md b/docs/ISuite/50-Development/deploying-an-oauth2-client-credentials-artifact-801b106.md index ddeabd47..05de5d98 100644 --- a/docs/ISuite/50-Development/deploying-an-oauth2-client-credentials-artifact-801b106.md +++ b/docs/ISuite/50-Development/deploying-an-oauth2-client-credentials-artifact-801b106.md @@ -15,6 +15,9 @@ You can edit and deploy an OAuth2 Client Credentials artifact. > > - Every time you edit an OAuth2 Client Credentials artifact, you must re-enter the Client Secret. +> ### Note: +> Read [SAP Cloud Integration – Principal Propagation with SuccessFactors OData V2](https://blogs.sap.com/2018/07/30/sap-cloud-platform-integration-principal-propagation-with-successfactors-odata-v2/), to design and deploy an integration flow that talks to SuccessFactors OData V2 endpoint with OAuth2 authentication. + More information on OAuth: [https://tools.ietf.org/html/rfc6749](https://tools.ietf.org/html/rfc6749) @@ -61,23 +64,6 @@ More information on OAuth: [https://tools.ietf.org/html/rfc6749](https://tools.i Name for the credentials. This name is also called as "alias" when using in an adapter. - - - - - - Grant Type - - - - - The relevant type of grant for authorizing the client to interact with the server. By default, the value is *Client Credentials* which you can't change. - - > ### Note: - > Read [SAP Cloud Integration – Principal Propagation with SuccessFactors OData V2](https://blogs.sap.com/2018/07/30/sap-cloud-platform-integration-principal-propagation-with-successfactors-odata-v2/), to design and deploy an integration flow that talks to SuccessFactors OData V2 endpoint with OAuth2 authentication. - - - @@ -196,6 +182,23 @@ More information on OAuth: [https://tools.ietf.org/html/rfc6749](https://tools.i + **Custom Parameter** + + Add or delete additional parameters in the custom parameter table, which includes three columns: *Key*, *Value*, and *Send as Part of*. + + Each custom parameter can be sent in the request body, request header, or request URL, depending on specific requirements. + + > ### Note: + > - Duplicate combinations of *Key*, *Value*, and *Send as Part of* fields are not allowed. + > + > - The *Key* cannot be "client\_id," "client\_secret," or "grant\_type". + > + > - Fields cannot be empty or consist only of whitespace. + > + > - The maximum length of the fields can be 1024 characters. + > + > - You can add a maximum of 20 key-value pairs. + 7. Choose *Deploy*. diff --git a/docs/ISuite/50-Development/develop-68ce43a.md b/docs/ISuite/50-Development/develop-68ce43a.md index 038cc717..09bd94bf 100644 --- a/docs/ISuite/50-Development/develop-68ce43a.md +++ b/docs/ISuite/50-Development/develop-68ce43a.md @@ -14,7 +14,7 @@ This guide gets you started and provides all of the conceptual information you n ## Developer Reference -This reference provides information about how to connect to the *Graph Navigator* in SAP Business Accelerator Hub Enterprise and on the public SAP Business Accelerator Hub. +This reference provides information about how to connect to the *Graph Navigator* in Developer Hub and on the public SAP Business Accelerator Hub. This reference also contains the *Graph Syntax* diagrams that give you a graphical representation of the APIs. diff --git a/docs/ISuite/50-Development/developer-reference-74668b7.md b/docs/ISuite/50-Development/developer-reference-74668b7.md index 0b343a8d..d98e5e7b 100644 --- a/docs/ISuite/50-Development/developer-reference-74668b7.md +++ b/docs/ISuite/50-Development/developer-reference-74668b7.md @@ -10,7 +10,7 @@ You can consume Graph APIs using one of the following: A public listing of all supported entities from SAP business systems in a business data graph. You can try out theGraph APIs using the provided sandbox system. -- Graph Navigator on API business hub enterprise. +- Graph Navigator on Developer Hub. This tool is available in Graph on the SAP Integration Suite home page. You can inspect your configured business data graphs and try them out on your own system, including custom services, model extensions, and more. diff --git a/docs/ISuite/50-Development/development-de1ae81.md b/docs/ISuite/50-Development/development-de1ae81.md index f4d17c4e..1b9f85d0 100644 --- a/docs/ISuite/50-Development/development-de1ae81.md +++ b/docs/ISuite/50-Development/development-de1ae81.md @@ -259,7 +259,7 @@ Generate revenue from APIs. -Set up API Management and test API business hub enterprise connections. +Set up API Management and test Developer Hub connections. diff --git a/docs/ISuite/50-Development/download-bill-details-from-api-business-hub-enterprise-ceea2da.md b/docs/ISuite/50-Development/download-bill-details-from-developer-hub-ceea2da.md similarity index 85% rename from docs/ISuite/50-Development/download-bill-details-from-api-business-hub-enterprise-ceea2da.md rename to docs/ISuite/50-Development/download-bill-details-from-developer-hub-ceea2da.md index 8bb88970..16d297e3 100644 --- a/docs/ISuite/50-Development/download-bill-details-from-api-business-hub-enterprise-ceea2da.md +++ b/docs/ISuite/50-Development/download-bill-details-from-developer-hub-ceea2da.md @@ -1,8 +1,8 @@ -# Download Bill Details from API business hub enterprise +# Download Bill Details from Developer Hub -Download bill details using the API business hub enterprise. +Download bill details using the Developer Hub. @@ -26,7 +26,7 @@ To download the bill details, proceed as follows: ## Procedure -1. Log on to the API business hub enterprise. +1. Log on to the Developer Hub. 2. Navigate to, *My Workspace*. diff --git a/docs/ISuite/50-Development/edit-an-api-proxy-a64b952.md b/docs/ISuite/50-Development/edit-an-api-proxy-a64b952.md index 8261bd9d..c65c3162 100644 --- a/docs/ISuite/50-Development/edit-an-api-proxy-a64b952.md +++ b/docs/ISuite/50-Development/edit-an-api-proxy-a64b952.md @@ -8,7 +8,7 @@ Once you’ve created an API proxy you can further change the proxy, either on t ## Context -When you edit an API proxy either on the Integration Suite or using the API designer, ensure that you save and deploy the API proxy once the changes are made. Saving the API proxy is a design time activity, the changes you've made get pushed to the runtime only when you deploy the changes. Therefore, when you choose *Save* after making the changes, the changes are saved locally and don’t get published on the API business hub enterprise. Choose *Deploy* to perform an explicit deployment to bring in the new changes in the runtime during the API proxy execution. +When you edit an API proxy either on the Integration Suite or using the API designer, ensure that you save and deploy the API proxy once the changes are made. Saving the API proxy is a design time activity, the changes you've made get pushed to the runtime only when you deploy the changes. Therefore, when you choose *Save* after making the changes, the changes are saved locally and don’t get published on the Developer Hub. Choose *Deploy* to perform an explicit deployment to bring in the new changes in the runtime during the API proxy execution. Consider the following examples: @@ -181,7 +181,7 @@ Consider the following examples: > ### Note: > When you’re editing the swagger structure in the API designer, editing the same from the tabs is disabled. - If the API proxy is already in the deployed state, then saving the changes after editing the API doesn’t deploy the latest changes. Similarly, if the API proxy is already published on the API business hub enterprise, the save action doesn’t publish the latest changes. In both cases, a message appears on the *View API* page that the changes you've made aren't deployed. For the changes to reflect during API proxy runtime flow, choose *Click to Deploy* and provide your confirmation on the popup window. + If the API proxy is already in the deployed state, then saving the changes after editing the API doesn’t deploy the latest changes. Similarly, if the API proxy is already published on the Developer Hub, the save action doesn’t publish the latest changes. In both cases, a message appears on the *View API* page that the changes you've made aren't deployed. For the changes to reflect during API proxy runtime flow, choose *Click to Deploy* and provide your confirmation on the popup window. diff --git a/docs/ISuite/50-Development/edit-partner-entity-858af76.md b/docs/ISuite/50-Development/edit-partner-entity-858af76.md new file mode 100644 index 00000000..d7f1cdce --- /dev/null +++ b/docs/ISuite/50-Development/edit-partner-entity-858af76.md @@ -0,0 +1,101 @@ + + +# Edit Partner Entity + +Edit an existing partner entity. + + + +1. Go to *Monitor* \> *Integrations and APIs*. + +2. Choose *Partner Directory*. +3. In the master table, select a partner. + +4. In the detailed table at right, select first a tab for the entity type \(for example, *String Parameters*\) and then entry. + +5. Choose *Actions* \> *Edit*. + +6. On the *Edit * screen, edit the attributes of the entity. The editable attributes depend on the entity type, as shown in table below \(see also: [Partner Directory Entity Types](partner-directory-entity-types-950f4b2.md)\). + + **** + + + + + + + + + + + + + + + + + + + + + + + +
+ + Entity Type + + + + Edit the Following Attributes + +
+ + *String Parameters* + + + + *Value* + +
+ + *Binary Parameters* + + + + - *Value* + + - *Content Type* + + - *Encoding* + + Only available if for *Content Type* one of the following options has been selected: *xml*, *xsl*, *xsd*, *json*, *text*. + + + + +
+ + *Alternative Partners* + + + + *PID* + + Specify the new partner for which the alternative partner should apply. + +
+ + *Authorized Users* + + + + *PID* + + Specify the new partner for which the authorized user should apply. + +
+ +7. Choose *Edit*. + + diff --git a/docs/ISuite/50-Development/editing-data-type-7136a31.md b/docs/ISuite/50-Development/editing-data-type-7136a31.md index 512d42f7..e4373caf 100644 --- a/docs/ISuite/50-Development/editing-data-type-7136a31.md +++ b/docs/ISuite/50-Development/editing-data-type-7136a31.md @@ -522,7 +522,7 @@ To add elements and attributes while editing the data type, follow these steps: You can also delete nodes from the data type. To do so follow these steps: -1. Use the checkboxes to select the rows that you want to delete. +1. Use the checkboxes to select the nodes that you want to delete. > ### Note: > - You can't delete a root node. diff --git a/docs/ISuite/50-Development/engage-1036845.md b/docs/ISuite/50-Development/engage-1036845.md index c8c603c4..577f5b1f 100644 --- a/docs/ISuite/50-Development/engage-1036845.md +++ b/docs/ISuite/50-Development/engage-1036845.md @@ -34,7 +34,7 @@ Applicable to: API Administrator -*Developer Services*: Use the API business hub enterprise to consume the exposed APIs. +*Developer Services*: Use the Developer Hub to consume the exposed APIs. Applicable to: Application Developer and Application Consumer diff --git a/docs/ISuite/50-Development/exporting-runtime-artifacts-5ab4cfe.md b/docs/ISuite/50-Development/exporting-runtime-artifacts-5ab4cfe.md index 9aa2deae..86aa5361 100644 --- a/docs/ISuite/50-Development/exporting-runtime-artifacts-5ab4cfe.md +++ b/docs/ISuite/50-Development/exporting-runtime-artifacts-5ab4cfe.md @@ -4,7 +4,12 @@ # Exporting Runtime Artifacts -Once you have created the Message Implementation Guidelines \(MIG\) and Mapping Guidelines \(MAG\), the next step is to use these artifacts in the integration solution to enable integrations with your business partner/s. Currently, SAP Integration Suite supports exporting runtime artifacts for and SAP Process Orchestration. +Exporting Runtime Artifacts for Integration Solutions. + +> ### Note: +> Currently, SAP Integration Suite supports exporting runtime artifacts for and SAP Process Orchestration. +> +> To know more about these runtime artifacts, refer to the blog [The Mapping Artifacts and their Purpose](https://community.sap.com/t5/technology-blogs-by-sap/integration-advisor-the-mapping-runtime-artifacts-and-their-purpose/ba-p/13426356). By exporting the runtime artifacts, the application automatically generates a number of schemes, scripts, and examples from a mapping guideline, including: diff --git a/docs/ISuite/50-Development/externally-managed-apis-848015d.md b/docs/ISuite/50-Development/externally-managed-apis-848015d.md index e94c403e..103a099e 100644 --- a/docs/ISuite/50-Development/externally-managed-apis-848015d.md +++ b/docs/ISuite/50-Development/externally-managed-apis-848015d.md @@ -4,7 +4,7 @@ You can add and view APIs that are not managed by SAP Integration Suite but by some other API Management solution. -You can import an API definition \(Open API Specification 2.0 or 3.0\) of externally managed APIs in Integration Suite, without adding management capability \(proxy creation and policies\) of SAP Integration Suite and publish them to API business hub enterprise. +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 Developer Hub. @@ -17,7 +17,7 @@ You can import an API definition \(Open API Specification 2.0 or 3.0\) of extern - These APIs are only listed in SAP Integration Suite. No aspect of their life cycle is managed by SAP Integration Suite. - Status \(Deployed/Not Deployed\) is not displayed for these APIs. - These APIs are represented by the symbol: ![](images/External_API_94e5ac7.png) -- If you create a product using only externally managed APIs , your consumers can't view the rate plan for these APIs, nor can they subscribe to the product or use custom attributes for the product in the API business hub enterprise. For more information, see [Create a Product](create-a-product-d769622.md). +- If you create a product using only externally managed APIs , your consumers can't view the rate plan for these APIs, nor can they subscribe to the product or use custom attributes for the product in the Developer Hub. For more information, see [Create a Product](create-a-product-d769622.md). - 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). diff --git a/docs/ISuite/50-Development/first-steps-create-entities-in-the-partner-directory-d32359a.md b/docs/ISuite/50-Development/first-steps-create-entities-in-the-partner-directory-d32359a.md index 20d8e06a..e31f2f05 100644 --- a/docs/ISuite/50-Development/first-steps-create-entities-in-the-partner-directory-d32359a.md +++ b/docs/ISuite/50-Development/first-steps-create-entities-in-the-partner-directory-d32359a.md @@ -5,7 +5,7 @@ > ### Note: > As prerequisite to create entities in the Partner Directory, you need to configure secure inbound authentication for the API client to call the OData API. > -> The detailed procedure depends on the cloud environment \(Cloud Foundry or Neo\) and on the desired authentication option. +> The detailed procedure depends on the cloud environment \(Cloud Foundry \) and on the desired authentication option. > > For more information, check out the links under *Related Information*. @@ -212,9 +212,9 @@ Perform the following initial steps with Postman. 2. Start the Postman Runner and select collection *CPI Partner Directory Example Flows*. -3. Depending on the Cloud environment, select folder *Update PD \(CF\)* or *Update PD \(Neo\)*. This folder contains a request that automatically creates the sample partner `PartnerA` with the entities listed in table above. +3. Select folder *Update PD \(CF\)*. This folder contains a request that automatically creates the sample partner `PartnerA` with the entities listed in table above. -4. Start the Postman runner for folder *Update PD \(CF\)* or *Update PD \(Neo\)*. +4. Start the Postman runner for folder *Update PD \(CF\)*. **Related Information** diff --git a/docs/ISuite/50-Development/first-steps-import-the-postman-collections-0f4cf38.md b/docs/ISuite/50-Development/first-steps-import-the-postman-collections-0f4cf38.md index e50b1d68..a072fe4c 100644 --- a/docs/ISuite/50-Development/first-steps-import-the-postman-collections-0f4cf38.md +++ b/docs/ISuite/50-Development/first-steps-import-the-postman-collections-0f4cf38.md @@ -23,20 +23,6 @@ Description -*SAP Cloud Integration Tenant Parameters Postman Environment \(*Neo*\)* - -\(Not relevant when using SAP Integration Suite; only relevant when using SAP Cloud Integration as standalone service in the Neo environment\) - - - - -You can use this Postman collection as template to set up a Postman environment to test the example integration flows \(in the Neo environment\). - - - - - - *SAP Cloud Integration Tenant Parameters Postman Environment \(CF\)* diff --git a/docs/ISuite/50-Development/global-code-value-mapping-fd1d3ff.md b/docs/ISuite/50-Development/global-code-value-mapping-fd1d3ff.md new file mode 100644 index 00000000..6e92c0ff --- /dev/null +++ b/docs/ISuite/50-Development/global-code-value-mapping-fd1d3ff.md @@ -0,0 +1,61 @@ + + + + +# Global Code Value Mapping + +Know more about the *Code Value Mapping* tab in the Mapping Guidelines page. + +The *Code Value Mapping* tab displays the list of global code value mappings that can be used in your mapping guideline. You can open a code value mapping to view its source and target code values.You can also create a global code value mapping with both 1:1 and N:1 cardinality. To know more, follow the procedure below: + +1. Login to your application and select the *MAGs* section. + +2. In the *Mapping Guidelines* screen, navigate to the *Code Value Mapping* tab and choose *Create* to create a Global Code Value Mapping. This will open the *Create Code Value Mapping* dialog. + +3. Maintain the following fields for *Source Codelist* : + - *Type System*: Select the value help icon for this field. This will display the *Standard* type systems available in the tenant. If you want to use a custom code list, select the *Custom* button and select the custom type system from the list. + + - *Codelist*: Select the codelist using the button. The button will display the list of codelists available in the type system that you chose in the previous field. + - *Version*: Select a version of the codelist + +4. Choose :heavy_plus_sign: to add after maintaining the fields. +5. If you want to add more source codelists, you can do so by changing the corresponding values of the fields using the value help button and then selecting the add :heavy_plus_sign: button. +6. Select *Next* and maintain the following fields for *Target Codelist*. + - Type System + + - Codelist + - Version + +7. Choose *Next* and in the *Mapping Creation* step, you are provided with a summary of your selection. +8. You can modify the name of this new global code value mapping and if you want to modify your selection, you can do so using the *Edit* button provided under the *Source Codelist* and *Target Codelist*. +9. Choose *Create*. For 1:1 code value mapping, the *Code Value Mapping* tab displays the all the source and target code values of the selected source and target codelist. +10. > ### Note: + > The following applies only if you have created a N:1 code value mapping. + + If you have created a N:1 code value mapping, then no values appear in the *Code Value Mapping* tab. You need to select a value for the *Default Value* field and then choose :heavy_plus_sign: to add an entry in the code values table. You can then select the value help and set the values for each column in the table. + + After maintaining the entries, you can choose sort to sort the values. This will reorder the existing code value mappings to ensure more accurate mappings are applied first. + + You can also choose reorder to reorder the source code values. Selecting this button opens up a *Reorder Source Codelists* dialog that allows you to move the order of the source codelists using the up and down arrows. Choose *OK* to see your changes reflecting in the code values table. + +11. Choose *Save* after making the necessary changes. +12. The *Overview* tab of the code value mapping provides an overview of the source and target codelists. The *References* section displays the list of MAGs wherever the codelist is used. +13. You can also edit the *Name* of the code value mapping. +14. After making the necessary changes, select *Activate* to activate the code value mapping. In the *Confirm* dialog, choose *Confirm*. + + > ### Note: + > Activating a global code value mapping will render it read-only. To make further edits, you need to create a new draft version of the mapping. + + + + + + +## Copying a Global Code Value Mapping + +If you want to create a code value mapping from an existing code value mapping: + +- You can open the existing code value mapping and choose *Copy*. + +- In the main *Code Value Mapping* tab, you can select the more options button and choose *Copy*. + diff --git a/docs/ISuite/50-Development/graph-navigator-in-api-business-hub-enterprise-8e75d31.md b/docs/ISuite/50-Development/graph-navigator-in-developer-hub-8e75d31.md similarity index 81% rename from docs/ISuite/50-Development/graph-navigator-in-api-business-hub-enterprise-8e75d31.md rename to docs/ISuite/50-Development/graph-navigator-in-developer-hub-8e75d31.md index 34fb6d1c..44384ac2 100644 --- a/docs/ISuite/50-Development/graph-navigator-in-api-business-hub-enterprise-8e75d31.md +++ b/docs/ISuite/50-Development/graph-navigator-in-developer-hub-8e75d31.md @@ -1,6 +1,6 @@ -# Graph Navigator in API business hub enterprise +# Graph Navigator in Developer Hub The Graph Navigator is a tool that you use to inspect business data graphs. @@ -27,7 +27,7 @@ The Graph Navigator is a tool that you use to inspect business data graphs. ## Using the Graph Navigator > ### Note: -> To access the Graph Navigator in API business hub enterprise, the Graph capability of API Management within SAP Integration Suite must be activated. For more information, see [Configure Graph](initial-setup-12ad448.md#loio12ad448225ac47049982d9faab7978a3__section_AddGraph_APIM). +> To access the Graph Navigator in Developer Hub, the Graph capability of API Management within SAP Integration Suite must be activated. For more information, see [Configure Graph](initial-setup-12ad448.md#loio12ad448225ac47049982d9faab7978a3__section_AddGraph_APIM). diff --git a/docs/ISuite/50-Development/guidelines-and-best-practices-for-message-monitoring-6f598b4.md b/docs/ISuite/50-Development/guidelines-and-best-practices-for-message-monitoring-6f598b4.md index 0c9062b9..926fa99e 100644 --- a/docs/ISuite/50-Development/guidelines-and-best-practices-for-message-monitoring-6f598b4.md +++ b/docs/ISuite/50-Development/guidelines-and-best-practices-for-message-monitoring-6f598b4.md @@ -13,8 +13,6 @@ To efficiently monitor message processing and analyze runtime errors, you can fo [Tracing the Execution of an Integration Flow](tracing-the-execution-of-an-integration-flow-4ec27d3.md "If you like to find out in detail how a message is processed and transformed at runtime, you can run the related integration flow with the Trace log level.") -[Checking the Default Trace (in the Neo Environment)](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/69a8b9b430dc48209125ce17431635e6.html "To analyze runtime errors, you can check the default trace.") :arrow_upper_right: - [Blog: Monitoring Tools for Cloud Integration capability of SAP Integration Suite](https://blogs.sap.com/2021/10/28/monitoring-tools-for-cloud-integration-capability-of-sap-integration-suite/) [Blog: Alerting for Cloud Integration, Capability of SAP Integration Suite](https://blogs.sap.com/2021/12/12/alerting-for-cloud-integration-capability-of-sap-integration-suite/) diff --git a/docs/ISuite/50-Development/handshake-and-its-status-a65d213.md b/docs/ISuite/50-Development/handshake-and-its-status-a65d213.md new file mode 100644 index 00000000..8b3bd8df --- /dev/null +++ b/docs/ISuite/50-Development/handshake-and-its-status-a65d213.md @@ -0,0 +1,110 @@ + + +# Handshake and Its Status + +Learn about handshake between Event Mesh and your webhook. + +When you create a subscription to a queue with a webhook, Event Mesh makes a handshake request before pushing the messages to the webhook. The handshake request is an OPTIONS call to the webhook with the HTTP header `WebHook-Request-Origin`. The webhook must respond to this handshake request with the HTTP header `WebHook-Allowed-Origin` and the value of this header has to match the value of the request header `WebHook-Request-Origin`. The webhook can also respond with the value `‘*’` which means that the webhook supports event notifications from all origins. After the handshake for the subscription is completed successfully, Event Mesh publishes messages to the webhook. + +> ### Example: +> Handshake call where the webhook URL is protected with basic authentication: +> +> ``` +> OPTIONS +> +> Headers: +> Authorization: Basic +> WebHook-Request-Origin: +> +> ``` + +> ### Example: +> Handshake call where the webhook URL is protected with OAuth 2.0 authentication: +> +> ``` +> OPTIONS +> +> Headers: +> Authorization: Bearer +> WebHook-Request-Origin: +> +> ``` + +After creating a subscription, *Handshake Status* is one of the following: + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +Handshake Status + + + +Explanation + +
+ +*Not Initiated* + + + +Event Mesh hasn't triggered the handshake yet + +
+ +*Requested* + + + +Event Mesh has requested a handshake and awaiting response from your webhook. + +
+ +*Completed* + + + +Event Mesh has completed the handshake. + +
+ +*Failed* + + + +Event Mesh requested a handshake and your webhook responsed with different value under `WebHook-Allowed-Origin` that differs from the value that was originally requested with. + +
+ +*Exempted* + + + +You've enabled the *Exempt Handshake* option. + +
+ diff --git a/docs/ISuite/50-Development/https-sender-adapter-0ae4a78.md b/docs/ISuite/50-Development/https-sender-adapter-0ae4a78.md index a015e68d..40a3da7f 100644 --- a/docs/ISuite/50-Development/https-sender-adapter-0ae4a78.md +++ b/docs/ISuite/50-Development/https-sender-adapter-0ae4a78.md @@ -93,19 +93,30 @@ Description -Enter the URL of the HTTP system to connect to. +Enter a relative path to address the integration flow. + +When deploying the integration flow, the path is appended to the address of the service instance, completed with `/http`. This results in the endpoint address through which a sending system can reach the integration flow. + +When as *Address* you enter `/myIntegrationFlow`, the endpoint address of the integration flow will finally be: + +`/http/myIntegrationFlow` + +Example: + +`https://abcd-1234-efg-5678.it-xyz001-rt.cfapps.eu12.hana.ondemand.com/http/myIntegrationFlow` + +The service instance URL is also displayed in the *url* field of the service key created for the corresponding service instance \([Creating Service Instance and Service Key for Inbound Authentication](../40-RemoteSystems/creating-service-instance-and-service-key-for-inbound-authentication-19af5e2.md)\). > ### Note: -> - Use the following pattern: `http://:/http` . This should be appended by the unique address specified in the channel. > - The field value supports these characters **~, -, . , $** and **\*** . > - The *Address* field should start with '/ ' and can contain alphanumeric values, '\_' and '/ '. For example a valid address is */test/123*. > - In the example mentioned above, you can use **~** only for the address part which succeeds */test/* > - You can use **$** only at the beginning of the address after **/**. > - You cannot begin address with**.**, **\-** or **~**. Alphanumeric value or**\_** must succeed these characters. > - You can use **\*** only at the extreme end of the address and no characters are allowed after **\***. A **\*** can only be preceded with**/**. -> - If you are using **/\***, it implies that URI containing the prefix preceding the **/\*** is supported. For example. if the address is */Customer/\** then URIs supported are *http://:/http/Customer/*. +> - If you are using **/\***, it implies that URI containing the prefix preceding the **/\*** is supported. For example. if the address is */Customer/\** then URIs supported are `/http/Customer/`. > - If you are using **/path /\***, then no other integration flows with the addresses `/path/any-URL` or `/path/any-URL/text` can be deployed across the tenant. -> - URIs are case insensitive. So, *http://:/http/test* and *http://:/http/Test* is treated as same. +> - URIs are case insensitive. So, `/http/test` and `/http/Test` are treated as same. diff --git a/docs/ISuite/50-Development/images/Database_Connection_Usage_cddfbbd.png b/docs/ISuite/50-Development/images/Database_Connection_Usage_cddfbbd.png new file mode 100644 index 00000000..897fca4e Binary files /dev/null and b/docs/ISuite/50-Development/images/Database_Connection_Usage_cddfbbd.png differ diff --git a/docs/ISuite/50-Development/images/Database_Transaction_Usage_ac04ede.png b/docs/ISuite/50-Development/images/Database_Transaction_Usage_ac04ede.png new file mode 100644 index 00000000..64aafe67 Binary files /dev/null and b/docs/ISuite/50-Development/images/Database_Transaction_Usage_ac04ede.png differ diff --git a/docs/ISuite/50-Development/images/Inspect_Content_Size_f9e2357.png b/docs/ISuite/50-Development/images/Inspect_Content_Size_f9e2357.png new file mode 100644 index 00000000..69f43ec9 Binary files /dev/null and b/docs/ISuite/50-Development/images/Inspect_Content_Size_f9e2357.png differ diff --git a/docs/ISuite/50-Development/images/Inspect_Memory_Usage_21a01f3.png b/docs/ISuite/50-Development/images/Inspect_Memory_Usage_21a01f3.png new file mode 100644 index 00000000..e2a76035 Binary files /dev/null and b/docs/ISuite/50-Development/images/Inspect_Memory_Usage_21a01f3.png differ diff --git a/docs/ISuite/50-Development/images/Inspect_Temporary_Storage_f48af1c.png b/docs/ISuite/50-Development/images/Inspect_Temporary_Storage_f48af1c.png new file mode 100644 index 00000000..7cff325b Binary files /dev/null and b/docs/ISuite/50-Development/images/Inspect_Temporary_Storage_f48af1c.png differ diff --git a/docs/ISuite/50-Development/images/Inspect_Top_Consuming_Iflows_63461d0.png b/docs/ISuite/50-Development/images/Inspect_Top_Consuming_Iflows_63461d0.png new file mode 100644 index 00000000..72170299 Binary files /dev/null and b/docs/ISuite/50-Development/images/Inspect_Top_Consuming_Iflows_63461d0.png differ diff --git a/docs/ISuite/50-Development/images/Monitoring_Storage_Usage_6f18dcf.png b/docs/ISuite/50-Development/images/Monitoring_Storage_Usage_6f18dcf.png new file mode 100644 index 00000000..44521305 Binary files /dev/null and b/docs/ISuite/50-Development/images/Monitoring_Storage_Usage_6f18dcf.png differ diff --git a/docs/ISuite/50-Development/images/Partner_Directory_UI_ece21e6.png b/docs/ISuite/50-Development/images/Partner_Directory_UI_ece21e6.png new file mode 100644 index 00000000..0c4e5c14 Binary files /dev/null and b/docs/ISuite/50-Development/images/Partner_Directory_UI_ece21e6.png differ diff --git a/docs/ISuite/50-Development/images/ProcessDirect_47d56c7.png b/docs/ISuite/50-Development/images/ProcessDirect_47d56c7.png new file mode 100644 index 00000000..af05a421 Binary files /dev/null and b/docs/ISuite/50-Development/images/ProcessDirect_47d56c7.png differ diff --git a/docs/ISuite/50-Development/initial-setup-12ad448.md b/docs/ISuite/50-Development/initial-setup-12ad448.md index aa09cc40..95009e83 100644 --- a/docs/ISuite/50-Development/initial-setup-12ad448.md +++ b/docs/ISuite/50-Development/initial-setup-12ad448.md @@ -68,13 +68,13 @@ Your global account administrator is responsible for configuring the Graph entit 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 API business hub enterprise** + 1. **Enable Developer Hub** 2. *Graph* > ### Note: - > If you have already set up API Management, choose *Edit*, and select *Graph*. You must select **Enable API business hub enterprise** to activate *Graph*. + > If you have already set up API Management, choose *Edit*, and select *Graph*. You must select **Enable Developer Hub** to activate *Graph*. 4. Choose *Activate* and once the status on the *Summary* changes from *In Progress* to *Active*, choose *OK*. @@ -118,7 +118,7 @@ Once you enable Graph, you see all of the Graph role collections in your list. - Graph Navigator Viewer - Graph Navigator is a tool in API business hub enterprise that developers use to inspect business data graphs. For more information, see [Graph Navigator in API business hub enterprise](graph-navigator-in-api-business-hub-enterprise-8e75d31.md). + Graph Navigator is a tool in Developer Hub that developers use to inspect business data graphs. For more information, see [Graph Navigator in Developer Hub](graph-navigator-in-developer-hub-8e75d31.md). To assign the *GraphNavigator.Viewer* role collection to a user with the *Graph\_Navigator\_Viewer* role, do the following: 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 c090e9a4..5a5190ec 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 @@ -12,6 +12,11 @@ You can inject mapping artifacts from Integration Advisor to your SAP Cloud Inte You need to maintain the SAP Cloud Integration tenant details into which you need to inject the resources under the *Destinations* tab of your subaccount in SAP BTP cockpit. +> ### Note: +> Users leveraging Integration Advisor within Integration Suite do not need to manually maintain destination details, as the capability automatically discovers the target Cloud Integration tenant. +> +> However, if you plan to inject resources into a Cloud Integration tenant outside your Integration Suite subscription, you must manually configure the destination details. For such cases, follow the procedure below. + 1. Login to SAP BTP cockpit and navigate to your subaccount. 2. Choose *Destinations* \> *New Destination*. @@ -127,8 +132,6 @@ You need to maintain the SAP Cloud Integration tenant details into which you nee > > You need to register the client application as the OAuth client in the consumer account using the SAP BTP cockpit with the TMN node details. In the *Security* \> *OAuth* section, go to the *Clients* tab. Under *Subscription*, enter the VM name of the TMN node\(it ends with the node type `.tmn`\). > - > For information on creating OAuuth client credentials for Neo environment, see: [Creating OAuth Client Credentials for Neo Environment](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/040d8110293d44b1bfaa75674530d395.html "The API is protected by basic authentication and OAuth.") :arrow_upper_right: - > > For information on creating OAuth client credentials for Cloud Foundry, see: [Creating OAuth Client Credentials for Cloud Foundry Environment](creating-oauth-client-credentials-for-cloud-foundry-environment-50b63c6.md). @@ -151,6 +154,12 @@ You need to maintain the SAP Cloud Integration tenant details into which you nee 4. Choose an SAP Cloud Integration tenant from the *Destinations* list. + The *Destinations* table displays two sections: + + 1. *Built-In*: Displays the Cloud Integration tenant associated with your Integration Suite subscription. + + 2. *User-Defined*: Displays manually created destinations by the user, typically used for external Cloud Integration tenants or custom integrations. + 5. The next step *2 Integration Package* lists down the integration packages available under the tenant that you chose in the previous step. Choose the desired integration package from the list. Configure-only packages will not be listed in this step. diff --git a/docs/ISuite/50-Development/inspect-content-size-f72b7ff.md b/docs/ISuite/50-Development/inspect-content-size-f72b7ff.md index 01357d02..acdb6ddd 100644 --- a/docs/ISuite/50-Development/inspect-content-size-f72b7ff.md +++ b/docs/ISuite/50-Development/inspect-content-size-f72b7ff.md @@ -17,7 +17,7 @@ The default value of the entitlement is 500 MB, as documented at [What Is SAP Cl ## Screen Components -The bar chart shows the artifacts that put the highest load on the file system for a given time period, each represented by a different color. +The bar chart shows the artifacts that put the highest load on the file system for a given time period, each represented by a different color as shown below:![](images/Inspect_Content_Size_f9e2357.png) You can change the displayed time period by selecting a different option in the dropdown box under *Time*. You can select *Past Day*, *Past Week*, *Past Month*, or *Custom* for a custom time interval. @@ -39,9 +39,13 @@ The legend lists the top consuming integration artifacts and associates a color Choose a bar to get more context information and access the following functions: -- *Inspect Artifact*. Navigate to the more detailed *Inspect Artifact* screen to inspect the selected artifact further. For more information, see [Inspect Resource Consumption for Individual Integration Flow](inspect-resource-consumption-for-individual-integration-flow-3380bd6.md). +- *Inspect Artifact* -- *Show Integration Content*. Navigate to *Manage Integration Content* to monitor the specific artifact you've selected. For more information, see [Manage Integration Content](manage-integration-content-09a7223.md). + Navigate to the more detailed *Inspect Artifact* screen to inspect the selected artifact further. For more information, see [Inspect Resource Consumption for Individual Integration Flow](inspect-resource-consumption-for-individual-integration-flow-3380bd6.md). + +- *Show Integration Content* + + Navigate to *Manage Integration Content* to monitor the specific artifact you've selected. For more information, see [Manage Integration Content](manage-integration-content-09a7223.md). > ### Note: > You can use this function to inspect an artifact and its uncompressed references. In the *Manage Integration Content* screen, go to *Artifact Details* \> *View Deployed Artifact* \>*Integration Flow* \> *References*. You can find all the uncompressed archives, schemas, and scripts of your selected artifact there. diff --git a/docs/ISuite/50-Development/inspect-data-store-usage-fcc08f6.md b/docs/ISuite/50-Development/inspect-data-store-usage-fcc08f6.md index cbcd82dd..247da5a4 100644 --- a/docs/ISuite/50-Development/inspect-data-store-usage-fcc08f6.md +++ b/docs/ISuite/50-Development/inspect-data-store-usage-fcc08f6.md @@ -25,7 +25,7 @@ The default value of the entitlement is 35 GB, as documented at [What Is SAP Clo ## Screen Components -The bar chart shows the data store usage of the tenant database for a defined time period. +The bar chart indicates the data store usage of the tenant database for a defined time period, as shown in the image below: You can change the displayed time period by selecting a different option in the dropdown box under *Time*. You can select *Past Day*, *Past Week*, *Past Month*, or *Custom* for a custom time interval. diff --git a/docs/ISuite/50-Development/inspect-database-connection-usage-567eb42.md b/docs/ISuite/50-Development/inspect-database-connection-usage-567eb42.md index 3e008088..efb025a9 100644 --- a/docs/ISuite/50-Development/inspect-database-connection-usage-567eb42.md +++ b/docs/ISuite/50-Development/inspect-database-connection-usage-567eb42.md @@ -16,16 +16,14 @@ Database connection usage depends on the integration flow design and on the volu ## Screen Components -The bar chart shows the data store usage of the tenant database for a defined time period. +The bar chart shows the data store usage of the tenant database for a defined time period, as shown in the image below.![](images/Database_Connection_Usage_cddfbbd.png) You can change the displayed time period by selecting a different option in the dropdown box under *Time*. You can select *Past Day*, *Past Week*,*Past Month*, or *Custom* for a custom time interval. > ### Note: > When you select the option *Custom* for the *Time* filter, you can adjust the date and time intervals with the calendar and watch elements. You can select dates up to 30 days in the past. However, selection of dates in the future is disabled. -The database connection usage is plotted in a bar graph against time. The horizontal axis shows the time window, and the vertical axis shows the percentage of database connection usage in relation to the maximum usage. - -Maximum usage corresponds to the situation where all database connections are used. +The database connection usage is plotted in a bar graph against time. The horizontal axis shows the time window, and the vertical axis shows the percentage of database connection usage in relation to the maximum usage. The maximum usage corresponds to the situation where all database connections are used. The usage level is represented by the following elements: diff --git a/docs/ISuite/50-Development/inspect-database-transaction-usage-6736a37.md b/docs/ISuite/50-Development/inspect-database-transaction-usage-6736a37.md index 65018f7a..58df6e44 100644 --- a/docs/ISuite/50-Development/inspect-database-transaction-usage-6736a37.md +++ b/docs/ISuite/50-Development/inspect-database-transaction-usage-6736a37.md @@ -12,7 +12,7 @@ There are no hard limits for the number and duration of database transactions. H ## Screen Components -The bar chart shows the maximum transaction duration of the tenant database for a defined time period. +The bar chart shows the maximum transaction duration of the tenant database for a defined time period, as shown in the image below.![](images/Database_Transaction_Usage_ac04ede.png) You can change the displayed time period by selecting a different option in the dropdown box under **Time**. You can select **Past Day**, **Past Week**,**Past Month**, or **Custom** for a custom time interval. diff --git a/docs/ISuite/50-Development/inspect-monitoring-storage-usage-216dc43.md b/docs/ISuite/50-Development/inspect-monitoring-storage-usage-216dc43.md index 89086161..37dc973c 100644 --- a/docs/ISuite/50-Development/inspect-monitoring-storage-usage-216dc43.md +++ b/docs/ISuite/50-Development/inspect-monitoring-storage-usage-216dc43.md @@ -16,7 +16,7 @@ When the assigned database capacity for monitoring storage is exceeded, you're a ## Screen Components -The bar chart shows the consumption of the database storage for monitoring data for a defined time period. +The bar chart shows the consumption of the database storage for monitoring data for a defined time period, as shown in the image below:![](images/Monitoring_Storage_Usage_6f18dcf.png) You can change the displayed time period by selecting a different option in the dropdown box under *Time*. You can select *Past Day*, *Past Week*, *Past Month*, or *Custom* for a custom time interval. diff --git a/docs/ISuite/50-Development/inspect-system-memory-usage-e9617dd.md b/docs/ISuite/50-Development/inspect-system-memory-usage-e9617dd.md index 9ecdc886..03de159d 100644 --- a/docs/ISuite/50-Development/inspect-system-memory-usage-e9617dd.md +++ b/docs/ISuite/50-Development/inspect-system-memory-usage-e9617dd.md @@ -21,14 +21,14 @@ Messages processed by integration flows at runtime consume system memory. Memory ## Screen Components -The bar chart shows the message load of the system memory for a defined time period. +The bar chart shows the message load of the system memory for a defined time period, as shown in the image below.![](images/Inspect_Memory_Usage_21a01f3.png) You can change the displayed time period by selecting a different option in the dropdown box under *Time*. You can select *Past Day*, *Past Week*, *Past Month*, or *Custom* for a custom time interval. > ### Note: > When you select the option *Custom* for the *Time* filter, you can adjust the date and time intervals with the calendar and watch elements. You can select dates up to 30 days in the past. However, selection of dates in the future is disabled. -The message load is plotted in two charts against time. +The message load is plotted in two charts against time: - The total count of message processing logs \(MPLs\) for a given time period \(as selected with the *Time* parameter\) is plotted in a bar chart. diff --git a/docs/ISuite/50-Development/inspect-temporary-storage-7cdfaa7.md b/docs/ISuite/50-Development/inspect-temporary-storage-7cdfaa7.md index bdd092ba..1c78a6b6 100644 --- a/docs/ISuite/50-Development/inspect-temporary-storage-7cdfaa7.md +++ b/docs/ISuite/50-Development/inspect-temporary-storage-7cdfaa7.md @@ -17,7 +17,7 @@ Temporary files become especially relevant when integration flows process large ## Screen Components -The bar chart shows the total storage used by temporary files for a defined time period. +The bar chart shows the total storage used by temporary files for a defined time period, as shown in the image below:![](images/Inspect_Temporary_Storage_f48af1c.png) You can change the displayed time period by selecting a different option in the dropdown box under *Time*. You can select *Past Day*, *Past Week*, *Past Month*, or *Custom* for a custom time interval. diff --git a/docs/ISuite/50-Development/inspect-top-consuming-integration-flows-c8fd522.md b/docs/ISuite/50-Development/inspect-top-consuming-integration-flows-c8fd522.md index e86df80e..9c5a6c14 100644 --- a/docs/ISuite/50-Development/inspect-top-consuming-integration-flows-c8fd522.md +++ b/docs/ISuite/50-Development/inspect-top-consuming-integration-flows-c8fd522.md @@ -14,6 +14,8 @@ The *Integration Flows* feature allows you to analyze and compare the integratio The bar chart shows the five integration flows with the highest resource consumption for the defined time period. +Each flow displays different colored bars representing the levels of consumption of the different resources within the individual integration flows, as shown in the image below.![](images/Inspect_Top_Consuming_Iflows_63461d0.png) + You can change the displayed time period by selecting a different option in the dropdown box under *Time*. You can select *Past Day*, *Past Week*, *Past Month*, or *Custom* for a custom time interval. > ### Note: @@ -21,8 +23,6 @@ You can change the displayed time period by selecting a different option in the The total resource consumption is presented in a bar graph. The horizontal axis displays the names of the integration flows, while the vertical axis shows the percentage of total resource consumption over the selected time period. -Each flow displays different colored bars representing the levels of consumption of the different resources within the individual integration flows. - > ### Note: > The system reads the resource consumption every hour. This means that there can be a maximum lag of one hour between processing an integration flow with a certain transaction setting and displaying the latest integration flow usage in the *Inspect* feature. diff --git a/docs/ISuite/50-Development/jira-receiver-adapter-d15b560.md b/docs/ISuite/50-Development/jira-receiver-adapter-d15b560.md new file mode 100644 index 00000000..f1c95a98 --- /dev/null +++ b/docs/ISuite/50-Development/jira-receiver-adapter-d15b560.md @@ -0,0 +1,303 @@ + + +# Jira Receiver Adapter + +The Jira receiver adapter connects SAP Integration Suite to Jira. The Jira adapter helps you exchange data between the two systems. Jira is a versatile software with multiple offerings like issue tracking, bug management, and agile project management. + +> ### 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 Jira Receiver Adapter Works + +If you have configured a Jira receiver adapter, the data exchange is performed as follows at runtime: SAP Integration Suite tenant sends the operation request to Jira \(this is a receiver system\), Jira works on the request and sends the data back to the SAP Integration Suite tenant. + + + + + +## Configure the Jira Receiver Adapter + +Once you have created a receiver channel and selected the Jira adapter, you can configure its parameters by referring the following description: + +**Connection** + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +Parameter + + + +Description + +
+ +*Address* + + + +Specify the login endpoint to your Jira endpoint url. + +Example: `https://your-domain.atlassian.net` + +
+ +*Authentication* + + + +Select *Basic* to use simple authentication to connect to the Jira endpoint with a username and password. + +
+ +*Basic Credentials Alias* + + + +Specify the user credential to be stored as a security artifact in *Security Material*. + +
+ +*Reuse Connection* + + + +Enable to reuse the connection. This option enables the reuse of connection objects from the internal connection pool which in turn improves the network turnaround time for multiple communications to a same end point. + +
+ +*Connection Timeout \(in ms\)* + + + +Specify the maximum waiting time \(in milliseconds\) for the connection to be established. + +Example: 6000 + +
+ +*Response Timeout \(in ms\)* + + + +Specify the maximum waiting time \(in milliseconds\) for a response message. + +Example: 6000 + +
+ +The Processing tab contains all operation related configurations for the Jira Receiver adapter. + +**Processing** + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +Parameter + + + +Description + +
+ +*API Version* + + + +Select the API version of the Jira Adapter. + +
+ +*Entity* + + + +Select the type of entity in Jira. + +
+ +*Operation* + + + +Select the operation to be performed. + +
+ +*Resource Parameters* + + + +Specify the parameter name and value in case resource path includes parameters. + +Example: Set *Name* to `propertyKey` and *Value* to `23434`. + +
+ +*Query Parameter* + + + +Specify the expression containing the query parameter and value. + +Example: `fields=summary,comment&properties=*all` + +
+ +*Attachment* + + + +Specify the filename containing the attachment. + +
+ +*Start At* + + + +Specify the index of the first item returned in the page. + +> ### Note: +> A value of `0` indicates a start from the first page. + +Example: `5` + +
+ +*Max Results* + + + +Specify the maximum number of items that a page can return. Each operation can have a different limit for the number of items returned and these limits may change without notice. + +Example: `45` + +
+ +*JQL Query* + + + +Specify the value of the Jira Query Language parameters. + +Example: `created >= -30d AND project = STP ORDER BY created DESC` + +
+ +*Request Headers* + + + +Specify a list of custom headers, separated by a pipe \(|\), to be sent to the target system. Use an asterisk \(\*\) to send all custom headers to the target system. + +> ### Note: +> All Camel-specific headers and HTTP protocol headers except "date" are excluded by default even if you specify them. + + + +
+ +*Response Headers* + + + +Specify a list of headers, separated by a pipe \(|\), coming from the target system's response to be received in the message. Use an asterisk \(\*\) to receive all the headers from the target system, which is also the default value. + +> ### Note: +> All Camel-specific headers and HTTP protocol headers except "date" are excluded by default even if you specify them. + + + +
+ diff --git a/docs/ISuite/50-Development/manage-stores-59f8e3a.md b/docs/ISuite/50-Development/manage-stores-59f8e3a.md index c5bab11f..572c1f62 100644 --- a/docs/ISuite/50-Development/manage-stores-59f8e3a.md +++ b/docs/ISuite/50-Development/manage-stores-59f8e3a.md @@ -15,3 +15,5 @@ The Manage Stores section allows you to manage various temporary data storages o [Managing Number Ranges](managing-number-ranges-b6e17fa.md "The topic provides an overview of number ranges related artifacts.") +[Managing Partner Directory Entries](managing-partner-directory-entries-3d6eee7.md "Manage Partner Directory entries that can be used to parameterize integration flows.") + 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 e409739f..7e48e178 100644 --- a/docs/ISuite/50-Development/managing-jdbc-data-sources-4c873fa.md +++ b/docs/ISuite/50-Development/managing-jdbc-data-sources-4c873fa.md @@ -164,8 +164,6 @@ After you complete the above configuration, now create a JDBC data source for yo *Database ID* - - \(only available for SAP ASE Service \(Neo\), SAP HANA Service \(Neo\) databases that are managed by SAP Managed\) @@ -178,8 +176,6 @@ After you complete the above configuration, now create a JDBC data source for yo *Access Token* - - \(only available for SAP ASE Service \(Neo\), SAP HANA Service \(Neo\) databases that are managed by SAP Managed\) diff --git a/docs/ISuite/50-Development/managing-partner-directory-entries-3d6eee7.md b/docs/ISuite/50-Development/managing-partner-directory-entries-3d6eee7.md new file mode 100644 index 00000000..53b3e4bf --- /dev/null +++ b/docs/ISuite/50-Development/managing-partner-directory-entries-3d6eee7.md @@ -0,0 +1,153 @@ + + +# Managing Partner Directory Entries + +Manage Partner Directory entries that can be used to parameterize integration flows. + +The Partner Directory facilitates the management of integration scenarios encompassing communication networks with numerous partners. In these scenarios, integration flows are parameterized with partner-specific parameters that are centrally stored in the Partner Directory. At runtime, integration flows can read information from the Partner Directory, based on the partner-specific values contained in the incoming request or the payload of the inbound message. This *dynamic* usage of integration flow parameters provides the advantage of adding new partners to the network without the need to edit and redeploy any integration flow, allowing for the extension of the business partner network without any downtime of the scenario. + +> ### Tip: +> Integration flows can access data from the Partner Directory through actions like the Script step. +> +> For more comprehensive details on the concept and entities stored in the Partner Directory, see [Parameterizing Integration Flows Using the Partner Directory](parameterizing-integration-flows-using-the-partner-directory-b7812a5.md) +> +> To view examples of integration flows using the Partner Directory, consult the integration flow design guidelines at [Use the Partner Directory Appropriately](use-the-partner-directory-appropriately-6e00412.md). +> +> You can also use the Cloud Integration OData API to create, edit, and display the content of the Partner Directory \(see: [Partner Directory](partner-directory-0fe80dc.md)\). + +With this feature, you can manage the contents of the Partner Directory by creating new entries, as well as editing and deleting existing ones. + +To access the Partner Directory: + +1. Navigate to *Monitor* \> *Integrations and APIs*. + +2. Choose *Partner Directory*. + + If partners are defined, the screen displays a master table featuring the list of partners. + +3. Clicking on a partner in the list reveals the entities defined for the partner in another table on the right. + + + + + + +## Screen Components + +Each partner is identified by a partner ID \(*PID*\). When a partner is selected, different entity types are accessible through different tabs in the second table. For each entry, administrative information is displayed, including the user who created and modified the entry, and the timestamp of the entry's creation or last modification. Depending on the entity type, additional attributes are displayed for an entry \(see: [Partner Directory Entity Types](partner-directory-entity-types-950f4b2.md)\). + +![](images/Partner_Directory_UI_ece21e6.png) + + + + + +## Functions + +The following operations can be performed on partners and partner entities: + +**** + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +Object + + + +Operation + + + +More Information + +
+ +Partner + + + +Add + + + +[Add Partner](add-partner-414b97d.md) + +
+ +Delete + + + +[Delete Partner](delete-partner-83a9bfd.md) + +
+ +Partner entity \(such like string parameter, binary parameter, alternative partner, or authorized user\) + + + +Create + + + +[Create Partner Directory Entity](create-partner-directory-entity-f41418f.md) + +
+ +Edit + + + +[Edit Partner Entity](edit-partner-entity-858af76.md) + +
+ +Copy + + + +[Copy Partner Entity](copy-partner-entity-d110a04.md) + +
+ +Delete + + + +[Delete Partner Entity](delete-partner-entity-25aed52.md) + +
+ diff --git a/docs/ISuite/50-Development/mapping-guidelines-mags-42124f4.md b/docs/ISuite/50-Development/mapping-guidelines-mags-42124f4.md index c006298c..6c2ee82a 100644 --- a/docs/ISuite/50-Development/mapping-guidelines-mags-42124f4.md +++ b/docs/ISuite/50-Development/mapping-guidelines-mags-42124f4.md @@ -268,7 +268,7 @@ You can also view the version history of a specific mapping guideline. Choose *H - *Imported*: This column lets you know if the MAG is imported or not. - \(Action\) allows you to copy, migrate or compare your MAG. -The *Code Value Mapping* tab displays the list of global code value mappings that can be used in your mapping guideline. To know more, see [Global Code Value Mapping](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/fd1d3ff10e0f406f95924d5f77c7f6b1.html "Know more about the Code Value Mapping tab in the Mapping Guidelines page.") :arrow_upper_right:. +The *Code Value Mapping* tab displays the list of global code value mappings that can be used in your mapping guideline. To know more, see [Global Code Value Mapping](global-code-value-mapping-fd1d3ff.md). diff --git a/docs/ISuite/50-Development/monetize-apis-f6ab151.md b/docs/ISuite/50-Development/monetize-apis-f6ab151.md index 380689a6..0b3fd1f3 100644 --- a/docs/ISuite/50-Development/monetize-apis-f6ab151.md +++ b/docs/ISuite/50-Development/monetize-apis-f6ab151.md @@ -4,14 +4,14 @@ SAP Integration Suite provides monetization feature to all API providers to generate revenue for using the APIs. -As an API Admin, you can create a rate plan, attach it to a product in the SAP Integration Suite, and publish the product in the API business hub enterprise. You can also view bill details of each developer in the SAP Integration Suite. +As an API Admin, you can create a rate plan, attach it to a product in the SAP Integration Suite, and publish the product in the Developer Hub. You can also view bill details of each developer in the SAP Integration Suite. -As an application developer, in the API business hub enterprise you can create an application and add products to the application. Based on the product usage, you can view the corresponding bill details. +As an application developer, in the Developer Hub you can create an application and add products to the application. Based on the product usage, you can view the corresponding bill details. 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: +- [Billing Service](https://help.sap.com/viewer/66d066d903c2473f81ec33acfe2ccdb4/Cloud/en-US/1e20fb575ad644399a7af8e1c4f423d0.html "Billing service is available in both API portal and Developer Hub.") :arrow_upper_right: If you were creating, updating, or reading an application using the APIs and not through the user interface, then you need to switch to Subscription entity from Application entity to use the Monetize feature. For more information, see [Create or Update or Read an Application using Subscription key](https://help.sap.com/viewer/66d066d903c2473f81ec33acfe2ccdb4/Cloud/en-US/e2645b5658e64fdfae97aa952756dd01.html "Creating, updating, and reading an application using the Subscription key.") :arrow_upper_right: diff --git a/docs/ISuite/50-Development/monitor-integrations-05446d0.md b/docs/ISuite/50-Development/monitor-integrations-05446d0.md index d3aa39e4..0b67318c 100644 --- a/docs/ISuite/50-Development/monitor-integrations-05446d0.md +++ b/docs/ISuite/50-Development/monitor-integrations-05446d0.md @@ -198,10 +198,6 @@ When you add or edit a tile, you can specify the following filter categories: [Managing PGP Keys](managing-pgp-keys-cd478a7.md "The PGP Keys monitor allows a tenant administrator to manage the public and private PGP keys.") -[Managing Certificate-to-User Mappings, Neo Environment](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/88ea2e5336d445f783c194c8d2780d35.html "The Manage Security area provides an overview of security-related artifacts. It also provides access to all certificate-to-user mappings defined for the tenant.") :arrow_upper_right: - -[Creating Custom Roles for Access Policies, Neo Environment](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/18f06d4c8c5244d8927c0e2c5dc1c706.html "Create custom roles to define access policies in the Neo environment.") :arrow_upper_right: - [Creating Custom Roles for Access Policies](creating-custom-roles-for-access-policies-7db3c87.md "Define a custom role to be associated with an access policy.") [Managing User Roles](managing-user-roles-4e86f0d.md "The user role monitor allows a tenant administrator to manage user roles which then can be used during inbound authorization of an integration flow execution.") @@ -218,10 +214,6 @@ When you add or edit a tile, you can specify the following filter categories: [Managing Number Ranges](managing-number-ranges-b6e17fa.md "The topic provides an overview of number ranges related artifacts.") -[Access Logs, Neo Environment](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/d5a4113e6da14a18838898d769261512.html "The Access Logs section allows you to monitor audit logs (resulting from system changes) and to analyze errors that occurred during inbound HTTP processing (and documented in system log files).") :arrow_upper_right: - -[Monitoring Audit Log, Neo Environment](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/2d6031ffc1aa4af08a03f0444b979667.html "The audit log contains information on system changes. These events can be for example the deployment of an integration flow as well as a configuration change.") :arrow_upper_right: - [Access Logs](access-logs-c1649cd.md "The Access Logs section allows you to monitor and to analyze errors that occurred during inbound HTTP processing (and documented in system log files)") [Manage Locks](manage-locks-e3fb788.md "The Manage Locks section lets you manage various locked entities on your tenant.") diff --git a/docs/ISuite/50-Development/optimize-memory-footprint-dc24074.md b/docs/ISuite/50-Development/optimize-memory-footprint-dc24074.md index 5da6c395..04327549 100644 --- a/docs/ISuite/50-Development/optimize-memory-footprint-dc24074.md +++ b/docs/ISuite/50-Development/optimize-memory-footprint-dc24074.md @@ -41,7 +41,12 @@ In the following, we provide guidelines about how to optimize the memory footpri *Why*: If you define variables in a script, the variables are kept in memory even if the processing of the script ended. The memory is kept until the entire integration process ends. -*How*: Either remove particular variables from the script or purge all variables at the end of the script. +*How*: Remove particular variables from the script. + +> ### Tip: +> To remove a variable, you can use the following method: +> +> `binding.variables.remove 'varname'` diff --git a/docs/ISuite/50-Development/overview-of-b2b-standards-c339707.md b/docs/ISuite/50-Development/overview-of-b2b-standards-c339707.md index a09e226b..3c795666 100644 --- a/docs/ISuite/50-Development/overview-of-b2b-standards-c339707.md +++ b/docs/ISuite/50-Development/overview-of-b2b-standards-c339707.md @@ -502,7 +502,7 @@ Last Version \(if discontinued\) -111 - Individual Insurance Policy and Client Information +  @@ -553,7 +553,7 @@ Last Version \(if discontinued\) -114 - Air Shipment Status Message +114 - Air Shipment Status Message111 - Individual Insurance Policy and Client Information @@ -723,7 +723,7 @@ Last Version \(if discontinued\) -131 - Student Educational Record \(Transcript\) Acknowledgment +111 - Individual Insurance Policy and Client131 - Student Educational Record \(Transcript\) Acknowledgment @@ -5852,6 +5852,28 @@ Last Version \(if discontinued\)   + + + + + +Envelope – Envelope with Functional Groups of Messages + +> ### Note: +> This message is applicable for all automotive EDIFACTS \(JAIF/VDA/Odette\). + + + + + + +002001 + + + + +  + @@ -7603,6 +7625,66 @@ ENTREC - Accounting entries message D.98A S3 + + + +  + + + + + + +EnvelopeForMessagesS3 – Envelope for Messages \(Syntax Versions 1/2/3\) + +> ### Note: +> This message is specifically designed to capture and define the envelope structure. +> +> This message is applicable for all automotive EDIFACTS \(JAIF/VDA/Odette\). + + + + + + +- UN/EDIFACT: 92.1 S3 +- JAIF: D.03A S3 + +- VDA: D.96A S3 +- Odette: D.96A + + + + + + +  + + + + + + +EnvelopeWithFunctionalGroupsS3 – Envelope with Functional Groups of Messages \(Syntax Versions 1/2/3\) + +> ### Note: +> This message is specifically designed to capture and define the envelope structure. +> +> This message is applicable for all automotive EDIFACTS \(JAIF/VDA/Odette\). + + + + + + +- UN/EDIFACT: 92.1 S3 +- JAIF: D.03A S3 + +- VDA: D.96A S3 +- Odette: D.96A + + + @@ -9735,6 +9817,13 @@ Message Type +AVIEXP:3 - Despatch Advice \(Version 3\) + + + + + + AVIEXP:4 - Despatch Advice @@ -9807,6 +9896,18 @@ ENGDAT:1 - Engineering Data Message ENQIRY:2 - Enquiry + + + + + +EnvelopeForMessagesS3 - Envelope for Messages \(Syntax Versions 1/2/3\) + +> ### Note: +> This message is specifically designed to capture and define the envelope structure. + + + @@ -9932,6 +10033,9 @@ SYNPAC:2 - Sequenced Packaged Delivery The Odette delivery contains 26 different message types. For most of the message types only the newest version is provided. For example, INVOIC:3 represents Version 3 of the Invoice message. For the message types CONTRL and ORDERR both versions 1 and 2 are available. +> ### Note: +> Despatch Advice message structure remains unchanged between AVIEXP Versions 3 and 4. However, several nodes' requirements were updated from mandatory to conditional. Despite these changes, Odette did not revise segment version numbers. Consequently, segments display AVIEXP:4 configurations for AVIEXP:3. You can optionally update these fields to mandatory in your Message Implementation Guideline \(MIG\), if necessary. + @@ -10117,6 +10221,20 @@ Version 1.2.060 + + + + + +1.2.061 + + + + + + +1.2.062 + @@ -11749,6 +11867,50 @@ DIRDEB - Direct debit message +EnvelopeForMessagesS3 - Envelope for Messages \(Syntax Versions 1/2/3\) + +> ### Note: +> This message is specifically designed to capture and define the envelope structure. + + + + + + +1995 S3 + + + + +  + + + + + + +EnvelopeWithFunctionalGroupsS3 – Envelope with Functional Groups of Messages \(Syntax Versions 1/2/3\) + +> ### Note: +> This message is specifically designed to capture and define the envelope structure. + + + + + + +1995 S3 + + + + +  + + + + + + FINCAN - Financial cancellation message diff --git a/docs/ISuite/50-Development/parameterizing-integration-flows-using-the-partner-directory-b7812a5.md b/docs/ISuite/50-Development/parameterizing-integration-flows-using-the-partner-directory-b7812a5.md index f898d4f2..be38a8d9 100644 --- a/docs/ISuite/50-Development/parameterizing-integration-flows-using-the-partner-directory-b7812a5.md +++ b/docs/ISuite/50-Development/parameterizing-integration-flows-using-the-partner-directory-b7812a5.md @@ -4,14 +4,62 @@ The Partner Directory is a tenant-specific storage option that allows you to store information on business partners that are connected to the tenant in the context of a larger business network. -You can use the information stored in the Partner Directory to parameterize integration flows. Parameterizing works in such a way that partner-specific information can be read from the Partner Directory by certain integration flow steps and processed during runtime. Partner-specific information is read from the Partner Directory at runtime based on partner-specific values contained in the incoming request or the payload of the inbound message. We also refer to this behavior as *dynamic* usage of integration flow parameters. +The Partner Directory facilitates the management of integration scenarios encompassing communication networks with numerous partners. In these scenarios, integration flows are parameterized with partner-specific parameters that are centrally stored in the Partner Directory. At runtime, integration flows can read information from the Partner Directory, based on the partner-specific values contained in the incoming request or the payload of the inbound message. This *dynamic* usage of integration flow parameters provides the advantage of adding new partners to the network without the need to edit and redeploy any integration flow, allowing for the extension of the business partner network without any downtime of the scenario. > ### Note: > Partner-specific information comprises information such as endpoints, XSLT mappings, XSD definitions, or certificates \(to mention some examples\). The Partner Directory doesn’t come with a dedicated user interface. You can access \(read/write\) its content through the OData API as well as during message processing through certain \(parameterized\) integration flow steps. -Storing partner-specific information in the Partner Directory has the advantage that you can add new partners to the network without the need to edit and redeploy any integration flow. Therefore, it provides a convenient option to extend your business partner network without any downtime of your scenario. + + +To display and maintain Partner Directory entries, there are the following options: + +**** + + + + + + + + + + + + + + + +
+ +Option + + + +Description + +
+ +User interface access + + + +In the *Monitor* section, you can access the Partner Directory, display existing entries and create new ones. + +See: [Managing Partner Directory Entries](managing-partner-directory-entries-3d6eee7.md) + +
+ +API access + + + +You can access \(read/write\) its content through the OData API as well as during message processing through certain \(parameterized\) integration flow steps. + +See: [Partner Directory](partner-directory-0fe80dc.md) + +
diff --git a/docs/ISuite/50-Development/partner-directory-entity-types-950f4b2.md b/docs/ISuite/50-Development/partner-directory-entity-types-950f4b2.md new file mode 100644 index 00000000..c4bb1d47 --- /dev/null +++ b/docs/ISuite/50-Development/partner-directory-entity-types-950f4b2.md @@ -0,0 +1,190 @@ + + +# Partner Directory Entity Types + +Learn more about tha Partner Directory entity types. + +Each entry in the Partner Directory is identified by a partner ID *PID* which is unique within the Partner Directory. + +The *PID* may consist of alphanumeric characters \(A-Z, a-z, 0-9\), as well as the following special characters: '-', '.', '\_', '~', '<', '\>', and '@'. + +The Partner Directory has different entity types. In addition to the *PID*, each entry comes with additional attributes. The set of additional attributes and their meaning depend on the entity type: + +**** + + + + + + + + + + + + + + + + + + + + + + + +
+ +Entity Type + + + +Specific Attributes + +
+ +*String Parameters* + +Use this entity type to define a user string parameter associated with a partner. + +Use this content type if you like to represent the partner by textual data, such as words, sentences, or any other kind of character sequence. + +> ### Note: +> A Partner Directory parameter has a value and a type. The currently supported predefined types are Binary and String. + + + + + +- *ID* + + An identifier for the string parameter. + + The ID of this entity may consist of alphanumeric characters \(A-Z, a-z, 0-9\), as well as the following special characters: '-', '.', '\_', '~', '<', '\>', and '@'. + +- *Value* + + The value associated with the string parameter. + + A string parameter has a maximum length of 4000 characters. + + + + +
+ +*Binary Parameters* + +Use this entity type to define a binary parameter associated with a partner. + +Use this content type if you like to represent the partner by binary data, such as files, or any other non-textual data. + +A binary parameter has a maximum size of 1,5 MB. + +> ### Note: +> A Partner Directory parameter has a value and a type. The currently supported predefined types are Binary and String. + + + + + +- *ID* + + An identifier for the binary parameter. + + The ID of this entity may consist of alphanumeric characters \(A-Z, a-z, 0-9\), as well as the following special characters: '-', '.', '\_', '~', '<', '\>', and '@'. + +- *Value* + + The value \(file\) associated with the binary parameter. + + For this entity type, you can upload a file from your computer. + + The parameter `Value` of this entity can have a maximum length of 262144 bytes. + +- *Content Type* + + Specifies the type of content, for example, xml or json. + + The following content types are supported \(defined by the `ContentType` parameter\): xml, xsl, xsd, json, text, zip, gz \(for GZIP files\), zlib, crt \(for DER encoded X.509 certificates\). + +- *Encoding* + + There are the following options: + + - *US-ASCII* + + - *ISO-8859-1* + + - *UTF-8* + + - *UTF-16BE* + + - *UTF-16LE* + + - *UTF-16* + + + + + +
+ +*Alternative Partners* + +Use this entity type to define an alternative identifier of a partner. + +> ### Note: +> Examples for use cases where an entity can be defined by different identifiers: +> +> - A bank can be identified by the German bank code number \(Bankleitzahl or: BLZ\) or the international Bank Identifier Code \(BIC\). +> +> - A person can be identified in many different ways, for example, by their customer number at a mail order company, or their name or employee number at their place of work. To able to identify a person uniquely, it isn't sufficient to just know the customer number, for example, you must know that **this** number is a customer number. Only once the frame of reference \(the identification scheme `Customer Number` \) is also known can a person be identified uniquely \(by using the number\). In the example, the agency `Mail Order Company` manages the identification scheme `Customer Number` . Different customers are issued unique names \(customer numbers\) within this scheme. + + + + + +- *Agency* + + Abbreviation for the organization that defines the identification scheme and that issues names for the partner to be identified \(maximum length of 120 characters\). + +- *Scheme* + + Reference framework within which partners are uniquely identified by names \(maximum length of 120 characters\). + +- *ID* + + Identifier for the partner \(issued by the agency\) \(maximum length of 225 characters\). + + This is an ID or name that identifies the partner within the given scheme. + + +> ### Note: +> Restriction: +> +> - The triple `Agency`, `Scheme`, `Id` must be unique. +> +> - The triple `Agency`, `Scheme`, `Pid` must be unique \(only then you can look up the alternative partner Id from such a triple\). + + + +
+ +*Authorized Users* + +Use this entity type to define a user with which a partner sender system can log in into Cloud Integration. + +This entity is required for the authorization of the partner sender system when calling Cloud Integration. + +An *Authorized Users* entry provides information on the authorized message sender and the unique Partner ID \(PID\) linked to the partner in the Partner Directory. + + + +*User* + +The user authorized to send messages. + +
+ diff --git a/docs/ISuite/50-Development/receiver-communication-flow-v2-3897ded.md b/docs/ISuite/50-Development/receiver-communication-flow-v2-3897ded.md index d1805bad..4d8424cf 100644 --- a/docs/ISuite/50-Development/receiver-communication-flow-v2-3897ded.md +++ b/docs/ISuite/50-Development/receiver-communication-flow-v2-3897ded.md @@ -92,7 +92,7 @@ Follow the procedure below to configure the integration flow. 3. Choose the *Receiver* tab and maintain the following: > ### Note: - > You only need to maintain this tab if you have enabled dead letter queue in your agreement for the receiver interchange. To know more, see [Creating a Trading Partner Agreement](creating-a-trading-partner-agreement-9bd43c9.md). + > You only need to maintain this tab if you have enabled dead letter queue in your agreement for the receiver interchange. To know more, see [Trading Partner Agreement](trading-partner-agreement-9bd43c9.md). : diff --git a/docs/ISuite/50-Development/runtime-artifacts-d016138.md b/docs/ISuite/50-Development/runtime-artifacts-d016138.md new file mode 100644 index 00000000..b684b85a --- /dev/null +++ b/docs/ISuite/50-Development/runtime-artifacts-d016138.md @@ -0,0 +1,25 @@ + + +# Runtime Artifacts + +Explore the functionality of runtime artifacts. + +Runtime Artifacts are reusable, configurable objects that store dynamic values, mapping rules, and configuration settings essential for the execution and management of integrations in SAP Integration Advisor. These artifacts serve as the bridge between integration design and runtime, enabling flexibility, adaptability, and efficiency in integration processes. + +These artifacts encompass more than just source-to-target schema mapping. They comprise a set of automatically generated, processable schemes \(XSD\) and transformation scripts \(XSLT\) that facilitate: + +- **Syntax Conversion**: Seamless data format transformations, such as EDI to XML or vice versa. + +- **Validation**: Verification of declared nodes and supported codes within a payload. +- **Pre-/Post-Processing**: Addition or removal of information before or after mapping. +- **Mapping**: Value mapping from source nodes to corresponding target nodes, enabling accurate data transformation. + +Once these runtime artifacts are generated, they can be leveraged within your integration solution, enabling seamless integrations with your business partners. + +To know more, see: + +1. [Consuming Artifacts in Integration Flows](consuming-artifacts-in-integration-flows-a33a6c6.md) + +2. [Exporting Runtime Artifacts](exporting-runtime-artifacts-5ab4cfe.md) +3. [Inject Mapping Artifacts to SAP Cloud Integration](inject-mapping-artifacts-to-sap-cloud-integration-47ad97e.md) + diff --git a/docs/ISuite/50-Development/setting-up-api-management-capability-f34e86c.md b/docs/ISuite/50-Development/setting-up-api-management-capability-f34e86c.md index fa4e19b2..c463d507 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 @@ -18,7 +18,7 @@ The following role collections must be assigned to you: - To access the *Settings* page, the *APIManagement.Selfservice.Administrator* role collection must be assigned to you -- You need the following role collections to establish and test the connection between API business hub enterprise and Integration Suite API Management tenant. +- You need the following role collections to establish and test the connection between Developer Hub and Integration Suite API Management tenant. - APIPortal.Administrator @@ -90,13 +90,13 @@ API Management Service is now configured. You can now create APIs, build API pro After completing the setup, logout of the Integration Suite application and login again. The *Connections* tab appears on the *Settings* page. -To publish the Integration Suite API portal content on the **API business hub enterprise**, Integration Suite should be connected to API business hub enterprise. Choose *Test Connection* and see the *Connection Status* change to *Success*. +To publish the Integration Suite API portal content on the **Developer Hub**, Integration Suite should be connected to Developer Hub. Choose *Test Connection* and see the *Connection Status* change to *Success*. > ### 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've activated Developer Hub while enabling API Management capability, the connection to Developer Hub 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\]](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). +> If you want to connect Integration Suite to a centralized Developer Hub, you must create a connection request. For more information, see [Create a Connection Request for the Centralized Developer Hub](../create-a-connection-request-for-the-centralized-developer-hub-c7bda8c.md). > ### Note: -> You can navigate to the **API business hub enterprise** by choosing the Explore our Ecosystem icon on the header bar. +> You can navigate to the **Developer Hub** by choosing the Explore our Ecosystem icon on the header bar. diff --git a/docs/ISuite/50-Development/spike-arrest-bf441dc.md b/docs/ISuite/50-Development/spike-arrest-bf441dc.md index d1e8fba9..98c142ca 100644 --- a/docs/ISuite/50-Development/spike-arrest-bf441dc.md +++ b/docs/ISuite/50-Development/spike-arrest-bf441dc.md @@ -4,81 +4,366 @@ The Spike Arrest policy limits the number of requests forwarded from the point in the processing flow where the policy is attached as a processing step. -You can attach a Spike Arrest policy at the proxy endpoint or the target endpoint. At the proxy endpoint, this policy limits inbound requests. When you attach this policy at the TargetEndpoint, it limits request forwarded to the backend service. +You can attach a Spike Arrest policy at the proxy endpoint or at the target endpoint. At the Proxy Endpoint, this policy limits the inbound requests. When you attach this policy at the Target Endpoint, it limits the requests forwarded to the backend service. -Unlike Quotas, spike arrests are not implemented as counts. Rather, they are implemented as a rate limit which is based on the time the last matching message was processed. If you specify 6 messages per minute, it means that requests can only be submitted at the rate of one per 10 second interval. A second request within 10 seconds on the same API Management server will be rejected. Even with a larger number \(200 per second\), if two requests come in nearly simultaneously to the same API Management server, one will be rejected. Each successful request will update the spike arrest's last processed count. +Unlike Quotas, spike arrests are not implemented as counts. Rather, they are implemented as a rate limit which is based on the time the last matching message was processed. For example, if you specify 6 messages per minute, it means that the requests can only be submitted at the rate of one per 10 second interval. The second request within the 10 seconds on the same API Management server will be rejected. Even with a larger number of requests \(200 per second\), if two requests come in nearly simultaneously to the same API Management server, one will be rejected. Each successful request will update the spike arrest's last processed count. -No counter is maintained for spike arrests, only a time that the last message was successfully passed through the Spike Arrest policy. On a given API Management server, if a request is received now, all subsequent requests will fail until 10 seconds has elapsed. Since Spike Arrest is not distributed, you might see some discrepancy between the actual behavior of the system and your expected results. In general, you should use Spike Arrest to set a limit that throttles traffic to what your backend services can handle. Do not use Spike Arrest to limit traffic from individual clients. +No counter is maintained for spike arrests, only the time that the last message was successfully passed through the Spike Arrest policy is maintained. On a given API Management server, if a request is received now, all subsequent requests will fail until the duration of 10 seconds has elapsed. Since Spike Arrest policy is not distributed, you might see some discrepancy between the actual behavior of the system and your expected results. In general, you should use Spike Arrest policy to set a limit that throttles traffic to what your backend services can handle. Do not use Spike Arrest policy to limit traffic from individual clients. You can attach the policy in the following locations: ![](images/flow_policy_1_1aa837c.png) An example payload for the policy is as follows: > ### Code Syntax: +> > ### Sample Code: +> > ``` +> >  +> > +> > +> > +> > +> > +> > 30pm +> > +> > ``` + +**`` element** + + + + + + + + + + + + + + + +
+ +Element + + + +Default + + + +Type + + + +Description + +
+ +`Identifier` \(Optional\) + + + +N/A + + + +String + + + +Flow variable used for identifying the application or client. + +> ### Sample Code: > ``` -> -> -> -> > > -> -> 30pm > -> > ``` + +
+ +**`ref` attribute of the `` element** + + + + + + + +
-**Elements and Attributes** +Attribute + + + +Default + + + +Type -**Description** +Description
-Identifier ref +`ref` \(Required\) + + + +N/A -Variable used for uniquely identifying the application or client. +N/A + +Identifies the flow variable by which Spike Arrest groups incoming requests. + +
+ +**`` element** + + + + + + + + + + +
+ +Element + + + +Default + + + +Type + + + +Description + +
-MessageWeight ref +`MessageWeight` \(Optional\) + + + +N/A + + + +Integer Specifies the weight defined for each message. -Message weight is used to modify the impact of a single request on the calculation of the SpikeArrest limit. Message weight can be set by variables based on HTTP headers, query parameters, or message body content. For example, if the SpikeArrest Rate is 10 per minute, and an application submits requests with weight 5, then only 2 messages are permitted per minute from that application. +Message weight modifies the impact of a single request on the calculation of the SpikeArrest limit. Message weight can be set by variables based on HTTP headers, query parameters, or message body content. + +For example, if the SpikeArrest Rate is 10 per minute, and an application submits requests with weight 5, then only 2 messages are permitted per minute from that application. + +> ### Sample Code: +> ``` +> +> +> +> ``` + +
+ +**`ref` attribute of the `` element** + + + + + + + + + + + + + + +
+ +Attribute + + + +Default + + + +Type + + + +Description + +
+ +`ref` \(Required\) + + + +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 + + -Rate +Interger Specifies the rate at which to limit the traffic spike \(or burst\). -Valid value: integer per or or . +Valid value: integer per or or + +> ### Sample Code: +> ``` +> +> 30pm +> +> ``` + + + +
+ +**`` element** + + + + + + + + + + + + + + @@ -208,11 +493,28 @@ FailedToResolveSpikeArrestRate The referenced variable used to specify the rate can't be resolved. + + + + + +
+ +Element + + + +Default + + + +Type + + + +Description + +
+ +`UseEffectiveCount` \(Optional\) + + + +N/A + + + +Boolean + + + +Distributes your Spike Arrest count across Message Processors \(MPs\) when using auto-scalin groups. + +> ### Sample Code: +> ``` +> +> true +> +> ``` + +
+ +InvalidAllowedRate + + + +500 + + + +If the spike arrest rate specified in the `` element of the Spike Arrest Policy is not an integer or if the rate does not have ps or pm as a suffix, then the deployment of the API proxy fails. +
-Following fault variables are set when the policy triggers an error at runtime: +The folFlowing fault variables are set when the policy triggers an error at runtime: **Fault Variables** @@ -243,7 +545,7 @@ Example -The fault variable \[prefix\] is ratelimit. +The fault variable \[prefix\] is rate limit. The \[policy\_name\] is the name of the policy that threw the error. diff --git a/docs/ISuite/50-Development/trading-partner-agreement-9bd43c9.md b/docs/ISuite/50-Development/trading-partner-agreement-9bd43c9.md new file mode 100644 index 00000000..7883a8d2 --- /dev/null +++ b/docs/ISuite/50-Development/trading-partner-agreement-9bd43c9.md @@ -0,0 +1,42 @@ + + +# Trading Partner Agreement + +Explore and create trading partner agreements. + +A Trading Partner Agreement \(TPA\) is a legally binding contract between two or more organizations that engage in business-to-business \(B2B\) transactions, outlining the terms, conditions, and guidelines for electronic data interchange \(EDI\), data synchronization, and other business transactions. The agreement establishes the rules, responsibilities, and expectations for the exchange of electronic documents, data, and other business information between trading partners. + +The primary purpose of a Trading Partner Agreement is to: + +- Define the scope and terms of the business relationship + +- Ensure seamless communication and data exchange +- Facilitate compliance with industry standards, regulations, and laws +- Ensure confidentiality, integrity, and security of exchanged data + +A typical agreement includes the following components: + +- **Partner Identification**: Names, addresses, and contact information of the trading partners. + +- **Transaction Types**: Definition of the types of transactions to be exchanged. +- **Data Formats**: Specification of the data formats and standards to be used . +- **Transmission Protocols**: Definition of the communication protocols and methods for data exchange. +- **Security Requirements**: Specification of security measures to ensure data confidentiality, integrity, and authenticity. +- **Business Processes**: Description of the business processes and workflows to be followed. + +Creating a Trading Partner Agreement is the last step in the design of a B2B transaction and is usually created out of a predefined template. There has been an update on the template format and, both the old and updated templates are available for creating an agreement. The procedure varies for both the templates and the corresponding steps are provided in the respective chapters. + +> ### Note: +> The chapters *Activity Parameters* and *Custom Search Attributes* are common to both the template formats. + +1. To create an agreement using the old template, see [Creating Agreement - Outdated Format](creating-agreement-outdated-format-5701ddc.md). + +2. To create an agreement using the latest format, see [Creating Agreement - Latest Format](creating-agreement-latest-format-72679dd.md) +3. [Adding Activity Parameters](adding-activity-parameters-655a594.md) +4. [Adding Custom Search Attributes](adding-custom-search-attributes-934bbcd.md) + +**Related Information** + + +[Activating a Trading Partner Agreement](activating-a-trading-partner-agreement-baed0e3.md "Activate your trading partner agreement to push the agreement details into the SAP Cloud Integration partner directory.") + diff --git a/docs/ISuite/50-Development/view-applications-feac368.md b/docs/ISuite/50-Development/view-applications-feac368.md index 43155da0..467a1aa5 100644 --- a/docs/ISuite/50-Development/view-applications-feac368.md +++ b/docs/ISuite/50-Development/view-applications-feac368.md @@ -8,9 +8,9 @@ In the context of API Management, an application is the unit of API consumption. ## Context -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. +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 Developer Hub. -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 application developers have created in the Developer Hub, along with the developer details, associated products and AppKey and secret. diff --git a/docs/ISuite/50-Development/view-bill-details-in-the-api-business-hub-enterprise-8f77615.md b/docs/ISuite/50-Development/view-bill-details-in-the-developer-hub-8f77615.md similarity index 79% rename from docs/ISuite/50-Development/view-bill-details-in-the-api-business-hub-enterprise-8f77615.md rename to docs/ISuite/50-Development/view-bill-details-in-the-developer-hub-8f77615.md index a48922f2..96a9c984 100644 --- a/docs/ISuite/50-Development/view-bill-details-in-the-api-business-hub-enterprise-8f77615.md +++ b/docs/ISuite/50-Development/view-bill-details-in-the-developer-hub-8f77615.md @@ -1,8 +1,8 @@ -# View Bill Details in the API business hub enterprise +# View Bill Details in the Developer Hub -View the bill details in the API business hub enterprise for all the applications subscribed by a developer. +View the bill details in the Developer Hub for all the applications subscribed by a developer. @@ -16,7 +16,7 @@ You are assigned the application developer role. ## Procedure -1. Log on to the API business hub enterprise. +1. Log on to the Developer Hub. 2. Navigate to, *My Workspace*. diff --git a/docs/ISuite/60-Security/auditing-and-logging-information-for-data-space-integration-5e2d650.md b/docs/ISuite/60-Security/auditing-and-logging-information-for-data-space-integration-5e2d650.md new file mode 100644 index 00000000..d250ca74 --- /dev/null +++ b/docs/ISuite/60-Security/auditing-and-logging-information-for-data-space-integration-5e2d650.md @@ -0,0 +1,76 @@ + + +# Auditing and Logging Information for Data Space Integration + +Here you can find a list of the security events that are logged by TECHNICAL COMPONENT. + +**Security events written in audit logs** + + + + + + + + + + + + + + + +
+ +Event grouping + + + +What events are logged + + + +How to identify related log events + + + +Additional information + +
+ + + + + + + + + + + + + + + +
+ + + +The following information is described in the table columns: + +- *Event grouping* - Events that are logged with a similar format or are related to the same entities. + +- *What events are logged* - Description of the security or data protection and privacy related event that is logged. + +- *How to identify related log events* - Search criteria or key words, that are specific for a log event that is created along with the logged event. + +- *Additional information* - Any related information that can be helpful. + + +**Related Information** + + +[Audit Logging in the Cloud Foundry Environment](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/f92c86ab11f6474ea5579d839051c334.html) + +[Audit Logging in the Neo Environment](https://help.sap.com/viewer/ea72206b834e4ace9cd834feed6c0e09/Cloud/en-US/02c39712c1064c96b37c1ea5bc9420dc.html) + diff --git a/docs/ISuite/60-Security/auditing-and-logging-information-for-integration-advisor-3dbe557.md b/docs/ISuite/60-Security/auditing-and-logging-information-for-integration-advisor-3dbe557.md index e20e7dad..7da6ef5d 100644 --- a/docs/ISuite/60-Security/auditing-and-logging-information-for-integration-advisor-3dbe557.md +++ b/docs/ISuite/60-Security/auditing-and-logging-information-for-integration-advisor-3dbe557.md @@ -211,9 +211,5 @@ Delete license -You can refer the following links to see the audit logging in Neo and Cloud Foundry environment : - -- [Audit Logging in the Neo Environment](https://help.sap.com/viewer/ea72206b834e4ace9cd834feed6c0e09/Cloud/en-US/02c39712c1064c96b37c1ea5bc9420dc.html) - -- [Audit Logging in the Cloud Foundry Environment](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/f92c86ab11f6474ea5579d839051c334.html) +To view the audit logging in Cloud Foundry environment, see [Audit Logging in the Cloud Foundry Environment](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/f92c86ab11f6474ea5579d839051c334.html) 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 1275b856..b1f1efdd 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 @@ -186,9 +186,9 @@ API Management does not store any sensitive personal data. The only personal data of data subjects stored in API Management is the user ID. This user ID is stored whenever a user creates an API artifact, for example an API proxy or API product, and this user ID can be obtained \(read\) only from that artifact. -To enable data subjects to obtain information about their personal data in the API business hub enterprise, we provide the following service to retrieve their personal information: +To enable data subjects to obtain information about their personal data in the Developer Hub, we provide the following service to retrieve their personal information: -- [Service to View User Details on API business hub enterprise](service-to-view-user-details-on-api-business-hub-enterprise-a49c05f.md) +- [Service to View User Details on Developer Hub](service-to-view-user-details-on-developer-hub-a49c05f.md) @@ -202,9 +202,9 @@ Personal data can also include referenced data. The challenge for deletion and b API Management stores the API portal administrator’s user ID. Storing the user ID is a business requirement and the user ID is deleted when the resources created by the API portal administrator are removed. -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 API business hub enterprise. All the personal information stored in the application is deleted when the access for the corresponding user is revoked. +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 Hub. 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 API business hub enterprise administrators to have their personal data erased and access revoked. For more information, see [Revoke Access](../revoke-access-ce609bb.md) and [Delete Data of Unregistered Users](../delete-data-of-unregistered-users-d548233.md). +In API Management, application developers can contact their Developer Hub administrators to have their personal data erased and access revoked. For more information, see [Revoke Access](../revoke-access-ce609bb.md) and [Delete Data of Unregistered Users](../delete-data-of-unregistered-users-d548233.md). diff --git a/docs/ISuite/60-Security/service-to-view-user-details-on-api-business-hub-enterprise-a49c05f.md b/docs/ISuite/60-Security/service-to-view-user-details-on-developer-hub-a49c05f.md similarity index 63% rename from docs/ISuite/60-Security/service-to-view-user-details-on-api-business-hub-enterprise-a49c05f.md rename to docs/ISuite/60-Security/service-to-view-user-details-on-developer-hub-a49c05f.md index df4c0049..8678f82e 100644 --- a/docs/ISuite/60-Security/service-to-view-user-details-on-api-business-hub-enterprise-a49c05f.md +++ b/docs/ISuite/60-Security/service-to-view-user-details-on-developer-hub-a49c05f.md @@ -1,15 +1,15 @@ -# Service to View User Details on API business hub enterprise +# Service to View User Details on Developer Hub -API Management allows user to view their personal data stored in the API business hub enterprise. +API Management allows user to view their personal data stored in the Developer Hub. -**Service to view personal data on API business hub enterprise:** +**Service to view personal data on Developer Hub:** - URL: https:///api/1.0/user - Method: GET -- Response: Fetches your personal details stored in API business hub enterprise. +- Response: Fetches your personal details stored in Developer Hub. > ### Sample Code: > Sample response 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 ec1c470e..480a54f5 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 @@ -825,6 +825,8 @@ UserRolesEdit +Integration Developer + Tenant Administrator diff --git a/docs/ISuite/70-Support/support-6abc874.md b/docs/ISuite/70-Support/support-6abc874.md deleted file mode 100644 index ec100191..00000000 --- a/docs/ISuite/70-Support/support-6abc874.md +++ /dev/null @@ -1,17 +0,0 @@ - - -# Support - -Check out our 24/7 active support resources for tips, troubleshooting, and assistance. - -Depending on your global account, you can use the following support media: - -- [SAP Integration Suite Community.](https://community.sap.com/topics/cloud-platform-integration-suite) -- [SAP Integration Suite Guided Answers](https://gad5158842f.us2.hana.ondemand.com/dtp/viewer/#/tree/3154/actions/48501/?version=current) -- [Guided Answers for SAP Business Technology Platform](https://ga.support.sap.com/dtp/viewer/#/tree/2065/actions/26547) -- [SAP Support Portal](https://support.sap.com/en/index.html) \(only S-user can log in and report an incident.\) - - -> ### Note: -> Planned downtimes and outage communication are sent through e-mail to the initial administrator of your global account. - 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 09219a43..821e8f84 100644 --- a/docs/ISuite/APIM-Migration/clone-api-management-content-7abd887.md +++ b/docs/ISuite/APIM-Migration/clone-api-management-content-7abd887.md @@ -107,7 +107,7 @@ By enabling this feature, you can explicitly clone the API proxies mentioned in Ensure that you don’t modify the name of the `apim-tct-input.json` file. - For more information on how to create the service key, refer the [Accessing API Management APIs Programmatically](../accessing-api-management-apis-programmatically-24a2c37.md) and [Accessing API business hub enterprise APIs Programmatically](../accessing-api-business-hub-enterprise-apis-programmatically-dabee6e.md). + For more information on how to create the service key, refer the [Accessing API Management APIs Programmatically](../accessing-api-management-apis-programmatically-24a2c37.md) and [Accessing Developer Hub APIs Programmatically](../accessing-developer-hub-apis-programmatically-dabee6e.md). **Structure of the apim-tct-input.json file:** @@ -956,7 +956,7 @@ By enabling this feature, you can explicitly clone the API proxies mentioned in - Token url received during creation of the service key for API business hub enterprise API access for the `AuthGroup.API.Admin` role. + Token url received during creation of the service key for Developer Hub API access for the `AuthGroup.API.Admin` role. 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 3b1eb334..e6da8e3f 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 @@ -107,7 +107,7 @@ By enabling this feature, you can explicitly clone the API proxies mentioned in Ensure that you don’t modify the name of the `apim-tct-input.json` file. - For more information on how to create the service key, refer the [Accessing API Management APIs Programmatically](../accessing-api-management-apis-programmatically-24a2c37.md) and [Accessing API business hub enterprise APIs Programmatically](../accessing-api-business-hub-enterprise-apis-programmatically-dabee6e.md). + For more information on how to create the service key, refer the [Accessing API Management APIs Programmatically](../accessing-api-management-apis-programmatically-24a2c37.md) and [Accessing Developer Hub APIs Programmatically](../accessing-developer-hub-apis-programmatically-dabee6e.md). **Structure of the apim-tct-input.json file:** @@ -967,7 +967,7 @@ By enabling this feature, you can explicitly clone the API proxies mentioned in - URL received during creation of the service key for API business hub enterprise API access for the `AuthGroup.API.Admin` role. + URL received during creation of the service key for Developer Hub API access for the `AuthGroup.API.Admin` role. @@ -999,7 +999,7 @@ By enabling this feature, you can explicitly clone the API proxies mentioned in - Token url received during creation of the service key for API business hub enterprise API access for the `AuthGroup.API.Admin` role. + Token url received during creation of the service key for Developer Hub API access for the `AuthGroup.API.Admin` role. @@ -1026,7 +1026,7 @@ By enabling this feature, you can explicitly clone the API proxies mentioned in - The client ID received during creation of the service key for API business hub enterprise API access for the `AuthGroup.API.Admin` role. + The client ID received during creation of the service key for Developer Hub API access for the `AuthGroup.API.Admin` role. You’re prompted to enter these values while running the command in Step 3 if you haven’t already provided these details in the `apim-tct-input.json` file. @@ -1055,7 +1055,7 @@ By enabling this feature, you can explicitly clone the API proxies mentioned in - The client secret received during creation of the service key for API business hub enterprise API access for the `AuthGroup.API.Admin` role. + The client secret received during creation of the service key for Developer Hub API access for the `AuthGroup.API.Admin` role. You’re prompted to enter these values while running the command in Step 3 if you haven’t already provided these details in the `apim-tct-input.json` file. @@ -1302,8 +1302,8 @@ By enabling this feature, you can explicitly clone the API proxies mentioned in - - The default value for skip-devportal is false, and API business hub enterprise entities are cloned. - - If you set the value for skip-devportal to true, no cloning of the API business hub enterprise entities takes place. + - The default value for skip-devportal is false, and Developer Hub entities are cloned. + - If you set the value for skip-devportal to true, no cloning of the Developer Hub entities takes place. @@ -1459,10 +1459,10 @@ By enabling this feature, you can explicitly clone the API proxies mentioned in > ### Remember: > For the clone input attribute: > - > - Both skip-apiportal and skip-devportal are set to false by default, so, API portal entities are cloned first, followed by API business hub enterprise entities. + > - Both skip-apiportal and skip-devportal are set to false by default, so, API portal entities are cloned first, followed by Developer Hub entities. > - If both skip-apiportal and skip-devportal are set to true, no cloning takes place. > - If skip-apiportal is set to false, but skip-devportal is set to true, then only the API portal entities are cloned. - > - If skip-apiportal is set to true, but skip-devportal to false, then only API business hub enterprise entities are cloned and cloning for entities \(like applications\) may fail, pertaining to nonavailability of dependent entity \(like API Product\) in API business hub enterprise. + > - If skip-apiportal is set to true, but skip-devportal to false, then only Developer Hub entities are cloned and cloning for entities \(like applications\) may fail, pertaining to nonavailability of dependent entity \(like API Product\) in Developer Hub. Sample configuration: @@ -1476,10 +1476,10 @@ By enabling this feature, you can explicitly clone the API proxies mentioned in "clientSecret": "" }, "devportal": { - "url": "", - "tokenUrl": ".authentication.sap.hana.ondemand.com/oauth/token>", - "clientId": "", - "clientSecret": "" + "url": "", + "tokenUrl": ".authentication.sap.hana.ondemand.com/oauth/token>", + "clientId": "", + "clientSecret": "" } }, @@ -1493,10 +1493,10 @@ By enabling this feature, you can explicitly clone the API proxies mentioned in }, "devportal": { - "url": "", - "tokenUrl": "", - "clientId": "", - "clientSecret": "" + "url": "", + "tokenUrl": "", + "clientId": "", + "clientSecret": "" } }, diff --git a/docs/ISuite/APIM-Migration/migrating-api-management-from-neo-to-the-multi-cloud-foundation-92f2da1.md b/docs/ISuite/APIM-Migration/migrating-api-management-from-neo-to-the-multi-cloud-foundation-92f2da1.md index 62e0fae5..1b2f3b7c 100644 --- a/docs/ISuite/APIM-Migration/migrating-api-management-from-neo-to-the-multi-cloud-foundation-92f2da1.md +++ b/docs/ISuite/APIM-Migration/migrating-api-management-from-neo-to-the-multi-cloud-foundation-92f2da1.md @@ -22,7 +22,7 @@ For the migration assistance, you must have an Integration Suite subscription wi After completing the prerequisites mentioned in the steps below, you can clone your API Management artifacts nondisruptively from the source to the target system. Post cloning, you must complete some user actions and validate your target system. > ### Note: -> The developer portal is renamed to API business hub enterprise within the multi-cloud foundation. In this document API business hub enterprise is referred to as developer portal even within the multi-cloud foundation. +> The developer portal is renamed to Developer Hub within the multi-cloud foundation. In this document Developer Hub is referred to as developer portal even within the multi-cloud foundation. The steps assisting the migration of your API Management from your source system to a target system are: diff --git a/docs/ISuite/APIM-Migration/migrating-api-management-subscription-created-using-the-starter-plan-service-instance-9778a36.md b/docs/ISuite/APIM-Migration/migrating-api-management-subscription-created-using-the-starter-plan-service-instance-9778a36.md index 1a74235a..baa24d78 100644 --- a/docs/ISuite/APIM-Migration/migrating-api-management-subscription-created-using-the-starter-plan-service-instance-9778a36.md +++ b/docs/ISuite/APIM-Migration/migrating-api-management-subscription-created-using-the-starter-plan-service-instance-9778a36.md @@ -13,7 +13,7 @@ You can choose to migrate the design-time components that you have in the Neo en You can also enable the new API Management design time subscription on the same multi-cloud foundation subaccount, where you have created the starter plan service instance. > ### Note: -> You must subscribe to the API portal and the API business hub enterprise in the same multi-cloud foundation subaccount where the starter plan instance is created. +> You must subscribe to the API portal and the Developer Hub in the same multi-cloud foundation subaccount where the starter plan instance is created. > > Tenant type \(for example, production and test\) of the newly onboarded API Management on the multi-cloud foundation must be same as that of the source API Management on the Neo environment. @@ -92,7 +92,7 @@ You can also enable the new API Management design time subscription on the same 5. Run the Tenant Cloning Tool in the SWITCHOVER stage. For more information, see [Clone API Management Content](clone-api-management-content-7abd887.md). > ### Note: - > If applicable, API business hub enterprise entities are cloned in this step. + > If applicable, Developer Hub entities are cloned in this step. 6. After the SWITCHOVER, if you have any API Provider of the type onpremise, provide the Basic Auth password in the target system. For more information, see "API Provider Credentials" under *User Actions* in [Post Cloning Tasks](post-cloning-tasks-116d82c.md). diff --git a/docs/ISuite/APIM-Migration/migrating-api-management-subscription-created-using-the-starter-plan-service-instance-to-1f4ed86.md b/docs/ISuite/APIM-Migration/migrating-api-management-subscription-created-using-the-starter-plan-service-instance-to-1f4ed86.md index e8763fb9..e93d355a 100644 --- a/docs/ISuite/APIM-Migration/migrating-api-management-subscription-created-using-the-starter-plan-service-instance-to-1f4ed86.md +++ b/docs/ISuite/APIM-Migration/migrating-api-management-subscription-created-using-the-starter-plan-service-instance-to-1f4ed86.md @@ -17,7 +17,7 @@ With the Integration Suite premium edition license available in a different suba > > - Analytics data can't be retained, as Advanced Analytics gets newly configured in the different subaccount. However, if you come across any analytics data from the previous subaccount, you must ignore the data and consider the analytics data after the migration task is completed. > -> - Subscribe to the API portal and the API business hub enterprise in the other multi-cloud foundation subaccount. This is the subaccount with the Integration Suite premium edition license. +> - Subscribe to the API portal and the Developer Hub in the other multi-cloud foundation subaccount. This is the subaccount with the Integration Suite premium edition license. > > - Tenant type \(for example, production and test\) of the newly onboarded API Management on the multi-cloud foundation must be same as that of the source API Management on the Neo environment. > @@ -100,7 +100,7 @@ With the Integration Suite premium edition license available in a different suba 5. Run the Tenant Cloning Tool in the SWITCHOVER stage. For more information, see [Clone API Management Content](clone-api-management-content-7abd887.md). > ### Note: - > If applicable, API business hub enterprise entities are cloned in this step. + > If applicable, Developer Hub entities are cloned in this step. 6. After the SWITCHOVER, if you have any API Provider of the type onpremise, provide the Basic Auth password in the target system. For more information, see "API Provider Credentials" under *User Actions* in [Post Cloning Tasks](post-cloning-tasks-116d82c.md). diff --git a/docs/ISuite/APIM-Migration/migration-of-api-management-content-between-cloud-foundry-environments-17f09f3.md b/docs/ISuite/APIM-Migration/migration-of-api-management-content-between-cloud-foundry-environments-17f09f3.md index dbdda74f..98073a1d 100644 --- a/docs/ISuite/APIM-Migration/migration-of-api-management-content-between-cloud-foundry-environments-17f09f3.md +++ b/docs/ISuite/APIM-Migration/migration-of-api-management-content-between-cloud-foundry-environments-17f09f3.md @@ -115,7 +115,7 @@ Source and target subscriptions must be in same environment. Both the source and You can clone your API Management content non-disruptively from the source to the target system only after completing the steps in the prerequisites section. Post cloning, you must complete some user actions and validate your target system. > ### Note: -> The developer portal is renamed to API business hub enterprise in Cloud Foundry environment. In this document API business hub enterprise is referred to as developer portal even in Cloud Foundry environment. +> The developer portal is renamed to Developer Hub in Cloud Foundry environment. In this document Developer Hub is referred to as developer portal even in Cloud Foundry environment. The steps assisting the migration of your API Management from your source system to a target system are: diff --git a/docs/ISuite/APIM-Migration/post-cloning-tasks-49e9716.md b/docs/ISuite/APIM-Migration/post-cloning-tasks-49e9716.md index 311f8ab9..e3f94c97 100644 --- a/docs/ISuite/APIM-Migration/post-cloning-tasks-49e9716.md +++ b/docs/ISuite/APIM-Migration/post-cloning-tasks-49e9716.md @@ -309,7 +309,7 @@ If you have multiple virtual hosts configured on your source system subscription -### Switching Over Design time URLs of API portal and API business hub enterprise portals +### Switching Over Design time URLs of API portal and Developer Hub portals - Domains managed by SAP can't be switched over. - To switch over a custom domain, create an incident on the component OPU-API-OD-OPS through the [SAP Support Portal](https://support.sap.com/en/index.html). diff --git a/docs/ISuite/APIM-Migration/prerequisites-c1904bc.md b/docs/ISuite/APIM-Migration/prerequisites-c1904bc.md index 8bd8dbc8..de5be005 100644 --- a/docs/ISuite/APIM-Migration/prerequisites-c1904bc.md +++ b/docs/ISuite/APIM-Migration/prerequisites-c1904bc.md @@ -17,9 +17,9 @@ Checks to be completed before you start migrating your API Management content no ### Prerequisites for the source system -- You must have a valid API Management system \(API portal and API business hub enterprise\) running in the Neo environment. -- The source system must support basic authentication for API access on Integration Suite and API business hub enterprise\(which is the developer portal\). -- Make a note of the Integration Suite and API business hub enterprise\(developer portal\) URLs of the source system and keep it handy. +- You must have a valid API Management system \(API portal and Developer Hub\) running in the Neo environment. +- The source system must support basic authentication for API access on Integration Suite and Developer Hub\(which is the developer portal\). +- Make a note of the Integration Suite and Developer Hub\(developer portal\) URLs of the source system and keep it handy. - You must have identified a user with the following roles assigned in your source systems: - APIPortal.Administrator @@ -90,14 +90,14 @@ Checks to be completed before you start migrating your API Management content no > > Consider the following example: During cloning, the email address `john.smith@abc.com` in the source becomes `John.Smith@abc.com` in target due to the change in configurations in Custom IDP. This mismatch might lead to data discrepancy during application creation and metering in the target after cloning. -- Ensure that API access is enabled for the Integration Suite and the API business hub enterprise\(developer portal\) for the following roles: +- Ensure that API access is enabled for the Integration Suite and the Developer Hub\(developer portal\) for the following roles: - APIPortal.Administrator - AuthGroup.API.Admin For Integration Suite, see [Accessing API Management APIs Programmatically](https://help.sap.com/docs/integration-suite/sap-integration-suite/api-access-plan-for-api-portal?version=CLOUD) - For API business hub enterprise, execute the following mandatory steps: + For Developer Hub, execute the following mandatory steps: - Make a note of the service keys \(`url`, `tokenurl`, `clientId`, and `clientSecret`\) for the given roles, and keep handy. @@ -105,9 +105,9 @@ Checks to be completed before you start migrating your API Management content no - Create a destination of type *OAuth2Credentials* to the XSUAA APIs by using the credentials you derived from creating the service key. - - Create a service instance with the *AuthGroup.API.Admin* role to access theAPI business hub enterprise APIs. + - Create a service instance with the *AuthGroup.API.Admin* role to access theDeveloper Hub APIs. - To perform the above steps, see [Accessing API business hub enterprise APIs Programmatically](../accessing-api-business-hub-enterprise-apis-programmatically-dabee6e.md). + To perform the above steps, see [Accessing Developer Hub APIs Programmatically](../accessing-developer-hub-apis-programmatically-dabee6e.md). - When you have API products protected by the custom roles permission in the source Neo system, ensure that custom roles creation and assignments are done in the target system within the multi-cloud foundation before starting the migration. diff --git a/docs/ISuite/APIM-Migration/prerequisites-for-the-source-and-the-target-system-1b181dd.md b/docs/ISuite/APIM-Migration/prerequisites-for-the-source-and-the-target-system-1b181dd.md index 3583a815..81a702f2 100644 --- a/docs/ISuite/APIM-Migration/prerequisites-for-the-source-and-the-target-system-1b181dd.md +++ b/docs/ISuite/APIM-Migration/prerequisites-for-the-source-and-the-target-system-1b181dd.md @@ -14,10 +14,10 @@ Both the source and the target system are the system that has your API Managemen ### Prerequisites for the source system -- You must have a valid API Management system \(Integration Suite and API business hub enterprise\) running in the Cloud Foundry environment. -- The source system must support Oauth client credentials for Cloud Foundry. You need the auth token url and key secret to access the Integration Suite and API business hub enterprise. For more information, refer [Accessing API Management APIs Programmatically](https://help.sap.com/docs/integration-suite/sap-integration-suite/api-access-plan-for-api-portal?version=CLOUD)[Accessing API business hub enterprise APIs Programmatically](https://help.sap.com/docs/integration-suite/sap-integration-suite/api-access-plan-for-api-business-hub-enterprise?version=CLOUD). -- Make a note of the API portal and API business hub enterprise URLs of the source system and keep handy. -- Ensure that API access is enabled for the Integration Suite and API business hub enterprise systems for the following roles: +- You must have a valid API Management system \(Integration Suite and Developer Hub\) running in the Cloud Foundry environment. +- The source system must support Oauth client credentials for Cloud Foundry. You need the auth token url and key secret to access the Integration Suite and Developer Hub. For more information, refer [Accessing API Management APIs Programmatically](https://help.sap.com/docs/integration-suite/sap-integration-suite/api-access-plan-for-api-portal?version=CLOUD)[Accessing Developer Hub APIs Programmatically](https://help.sap.com/docs/integration-suite/sap-integration-suite/api-access-plan-for-api-business-hub-enterprise?version=CLOUD). +- Make a note of the API portal and Developer Hub URLs of the source system and keep handy. +- Ensure that API access is enabled for the Integration Suite and Developer Hub systems for the following roles: - APIPortal.Administrator - AuthGroup.API.Admin @@ -95,14 +95,14 @@ Both the source and the target system are the system that has your API Managemen > > Consider the following example: During cloning, the email address `john.smith@abc.com` in the source becomes `John.Smith@abc.com` in target due to the change in configurations in Custom IDP. This mismatch might lead to data discrepancy during application creation and metering in the target after cloning. -- Ensure that API access is enabled for the Integration Suite and the API business hub enterprise for the following roles: +- Ensure that API access is enabled for the Integration Suite and the Developer Hub for the following roles: - APIPortal.Administrator - AuthGroup.API.Admin For Integration Suite, see [Accessing API Management APIs Programmatically](https://help.sap.com/docs/integration-suite/sap-integration-suite/api-access-plan-for-api-portal?version=CLOUD) - For API business hub enterprise, execute the following mandatory steps: + For Developer Hub, execute the following mandatory steps: - Make a note of the service keys \(`url`, `tokenurl`, `clientId`, and `clientSecret`\) for the given roles, and keep handy. @@ -110,9 +110,9 @@ Both the source and the target system are the system that has your API Managemen - Create a destination of type *OAuth2Credentials* to the XSUAA APIs by using the credentials you derived from creating the service key. - - Create a service instance with the *AuthGroup.API.Admin* role to access theAPI business hub enterprise APIs. + - Create a service instance with the *AuthGroup.API.Admin* role to access theDeveloper Hub APIs. - To perform the above steps, see [Accessing API business hub enterprise APIs Programmatically](https://help.sap.com/docs/integration-suite/sap-integration-suite/api-access-plan-for-api-business-hub-enterprise?version=CLOUD) + To perform the above steps, see [Accessing Developer Hub APIs Programmatically](https://help.sap.com/docs/integration-suite/sap-integration-suite/api-access-plan-for-api-business-hub-enterprise?version=CLOUD) - 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. diff --git a/docs/ISuite/APIM-Migration/security-features-of-the-tenant-cloning-tool-41702e8.md b/docs/ISuite/APIM-Migration/security-features-of-the-tenant-cloning-tool-41702e8.md index 96194784..cb5c6c9d 100644 --- a/docs/ISuite/APIM-Migration/security-features-of-the-tenant-cloning-tool-41702e8.md +++ b/docs/ISuite/APIM-Migration/security-features-of-the-tenant-cloning-tool-41702e8.md @@ -10,7 +10,7 @@ The security features of the Tenant Cloning Tool is described in this section. ## Auditing and Logging -- The Tenant Cloning tool calls the APIs provided by Integration Suite and API business hub enterprise\(developer portal\). Hence, there are no security-related events available in the tool. +- The Tenant Cloning tool calls the APIs provided by Integration Suite and Developer Hub\(developer portal\). Hence, there are no security-related events available in the tool. - All application logs generated from the cloning tool are stored in "APIM-Tenant-Cloning-Tool.log", an autogenerated log file. @@ -45,5 +45,5 @@ The security features of the Tenant Cloning Tool is described in this section. ## Network and Communication Security -The tool uses standard HTTPS communication to make API calls, as provided by the Integration Suite and API business hub enterprise\(developer portal\). +The tool uses standard HTTPS communication to make API calls, as provided by the Integration Suite and Developer Hub\(developer portal\). diff --git a/docs/ISuite/APIM-Migration/security-features-of-the-tenant-cloning-tool-a6969cc.md b/docs/ISuite/APIM-Migration/security-features-of-the-tenant-cloning-tool-a6969cc.md index 1e301e05..2d3a78d9 100644 --- a/docs/ISuite/APIM-Migration/security-features-of-the-tenant-cloning-tool-a6969cc.md +++ b/docs/ISuite/APIM-Migration/security-features-of-the-tenant-cloning-tool-a6969cc.md @@ -10,7 +10,7 @@ The security features of the Tenant Cloning Tool is described in this section. ## Auditing and Logging -- The Tenant Cloning tool calls the APIs provided by Integration Suite and API business hub enterprise\(developer portal\). Hence, there are no security-related events available in the tool. +- The Tenant Cloning tool calls the APIs provided by Integration Suite and Developer Hub\(developer portal\). Hence, there are no security-related events available in the tool. - All application logs generated from the cloning tool are stored in "APIM-Tenant-Cloning-Tool.log", an autogenerated log file. @@ -45,5 +45,5 @@ The security features of the Tenant Cloning Tool is described in this section. ## Network and Communication Security -The tool uses standard HTTPS communication to make API calls, as provided by the Integration Suite and API business hub enterprise\(developer portal\). +The tool uses standard HTTPS communication to make API calls, as provided by the Integration Suite and Developer Hub\(developer portal\). 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 809f81b2..c7552742 100644 --- a/docs/ISuite/APIM-Migration/tenant-cloning-tool-behavior-6d15ffd.md +++ b/docs/ISuite/APIM-Migration/tenant-cloning-tool-behavior-6d15ffd.md @@ -20,7 +20,7 @@ This topic describes the behavior of the Tenant Cloning Tool with respect to clo To know more about API proxy states, see [API Proxy States](../50-Development/api-proxy-states-091cda4.md). > ### Note: - > If the Tenant Cloning Tool is used to clone an API proxy or a product with more than 100 resources attached to it, you might notice data inconsistency in the target system \(API business hub enterprise or Integration Suite\). It is recommended that you do not add more than 100 resources per proxy or product. For more information, see [Limits in API Management](../limits-in-api-management-f70f425.md). + > If the Tenant Cloning Tool is used to clone an API proxy or a product with more than 100 resources attached to it, you might notice data inconsistency in the target system \(Developer Hub or Integration Suite\). It is recommended that you do not add more than 100 resources per proxy or product. For more information, see [Limits in API Management](../limits-in-api-management-f70f425.md). > > . 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 0a2e1139..35ee9f35 100644 --- a/docs/ISuite/APIM-Migration/tenant-cloning-tool-behavior-b23c603.md +++ b/docs/ISuite/APIM-Migration/tenant-cloning-tool-behavior-b23c603.md @@ -20,7 +20,7 @@ This topic describes the behavior of the Tenant Cloning Tool with respect to clo To know more about API proxy states, see [API Proxy States](../50-Development/api-proxy-states-091cda4.md). > ### Note: - > If the Tenant Cloning Tool is used to clone an API proxy or a product with more than 100 resources attached to it, you might notice data inconsistency in the target system \(API business hub enterprise or Integration Suite\). It is recommended that you do not add more than 100 resources per proxy or product. For more information, see [Limits in API Management](../limits-in-api-management-f70f425.md). + > If the Tenant Cloning Tool is used to clone an API proxy or a product with more than 100 resources attached to it, you might notice data inconsistency in the target system \(Developer Hub or Integration Suite\). It is recommended that you do not add more than 100 resources per proxy or product. For more information, see [Limits in API Management](../limits-in-api-management-f70f425.md). > > . diff --git a/docs/ISuite/accessing-api-business-hub-enterprise-apis-programmatically-dabee6e.md b/docs/ISuite/accessing-developer-hub-apis-programmatically-dabee6e.md similarity index 78% rename from docs/ISuite/accessing-api-business-hub-enterprise-apis-programmatically-dabee6e.md rename to docs/ISuite/accessing-developer-hub-apis-programmatically-dabee6e.md index 468d6ffc..0031d56f 100644 --- a/docs/ISuite/accessing-api-business-hub-enterprise-apis-programmatically-dabee6e.md +++ b/docs/ISuite/accessing-developer-hub-apis-programmatically-dabee6e.md @@ -1,8 +1,8 @@ -# Accessing API business hub enterprise APIs Programmatically +# Accessing Developer Hub APIs Programmatically -The *devportal-apiaccess* plan allows you to access the API business hub enterprise APIs to programmatically onboard developers, create applications, and more. +The *devportal-apiaccess* plan allows you to access the Developer Hub APIs to programmatically onboard developers, create applications, and more. @@ -12,7 +12,7 @@ The *devportal-apiaccess* plan allows you to access the API business hub enterpr The service key, consisting of url \(application url\), clientId, clientSecret, and tokenUrl is used to generate a bearer token with the help of a REST client. This bearer token, along with the application url and API endpoint, is used to trigger the APIs. -This topic explains how to enable API access for API business hub enterprise. +This topic explains how to enable API access for Developer Hub. @@ -20,10 +20,10 @@ This topic explains how to enable API access for API business hub enterprise. ## Prerequisites -- If you've enabled API Management capability using Integration suite, ensure that you've also enabled API business hub enterprise in Integration suite. For more information, refer [Subscribing to Integration Suite](https://help.sap.com/docs/SAP_INTEGRATION_SUITE/51ab953548be4459bfe8539ecaeee98d/8a3c8b7a6b1c4f249bb81d11644ef806.html?version=CLOUD) and [Activating Capabilities](https://help.sap.com/docs/SAP_INTEGRATION_SUITE/51ab953548be4459bfe8539ecaeee98d/2ffb343c163c48a4b3a90f9f3c487328.html?version=CLOUD). To access API business hub enterprise from Integration Suite, select API business hub enterprise from the *Navigation Links* on the header. +- If you've enabled API Management capability using Integration suite, ensure that you've also enabled Developer Hub in Integration suite. For more information, refer [Subscribing to Integration Suite](https://help.sap.com/docs/SAP_INTEGRATION_SUITE/51ab953548be4459bfe8539ecaeee98d/8a3c8b7a6b1c4f249bb81d11644ef806.html?version=CLOUD) and [Activating Capabilities](https://help.sap.com/docs/SAP_INTEGRATION_SUITE/51ab953548be4459bfe8539ecaeee98d/2ffb343c163c48a4b3a90f9f3c487328.html?version=CLOUD). To access Developer Hub from Integration Suite, select Developer Hub from the *Navigation Links* on the header. > ### Note: - > Please ensure that you can access API business hub enterprise before creating an instance. + > Please ensure that you can access Developer Hub before creating an instance. - You have the `space developer` role assigned to you. - You have created a service instance under the *Authorization and Trust Management* tile. @@ -78,20 +78,20 @@ This topic explains how to enable API access for API business hub enterprise. -## Creating a Service Instance in the API Management, API business hub enterprise +## Creating a Service Instance in the API Management, Developer Hub Create a service instance using *devportal-apiaccess* plan. 1. In your web browser, open the *SAP BTP Cockpit* - [https://account.hana.ondemand.com/cockpit](https://account.hana.ondemand.com/cockpit). 2. From your *Subaccount*, navigate to *Spaces* in your Cloud Foundry environment and choose *Services* \> *Service Marketplace.* -3. Choose **API Management, API business hub enterprise**, *Instances* \> *New Instance*. +3. Choose **API Management, Developer Hub**, *Instances* \> *New Instance*. 4. In the *Create Instance* dialog that opens, choose *devportal-apiaccess*. 5. Click *Next*. 6. In the section *Specify parameters*, provide the details as mentioned below, based on the role you require. - The roles that support API access in the API business hub enterprise are `AuthGroup.API.Admin`, `AuthGroup.Content.Admin`, and `AuthGroup.API.ApplicationDeveloper`. + The roles that support API access in the Developer Hub are `AuthGroup.API.Admin`, `AuthGroup.Content.Admin`, and `AuthGroup.API.ApplicationDeveloper`. - Create a service instance with the `AuthGroup.API.Admin` role to access the API business hub enterprise APIs \(applications and attributes, API packages, API proxies and products, app developer and metering\), and perform operations like create, update, and delete on various API business hub enterprise entities as specified in the [Business Accelerator Hub](https://api.sap.com/package/APIMgmt?section=Artifacts). + Create a service instance with the `AuthGroup.API.Admin` role to access the Developer Hub APIs \(applications and attributes, API packages, API proxies and products, app developer and metering\), and perform operations like create, update, and delete on various Developer Hub entities as specified in the [Business Accelerator Hub](https://api.sap.com/package/APIMgmt?section=Artifacts). ``` @@ -101,7 +101,7 @@ Create a service instance using *devportal-apiaccess* plan. ``` - Create a service instance with the `AuthGroup.Content.Admin` role to manage the domain categories in API business hub enterprise and add the related products into relevant categories. + Create a service instance with the `AuthGroup.Content.Admin` role to manage the domain categories in Developer Hub and add the related products into relevant categories. ``` { @@ -110,7 +110,7 @@ Create a service instance using *devportal-apiaccess* plan. ``` - Create a service instance with the `AuthGroup.API.ApplicationDeveloper` role to access the API business hub enterprise APIs \(applications, API packages, and API proxies and products\), and perform operations like create, update, and delete on variousAPI business hub enterprise entities as specified in the [Business Accelerator Hub](https://api.sap.com/package/APIMgmt?section=Artifacts). + Create a service instance with the `AuthGroup.API.ApplicationDeveloper` role to access the Developer Hub APIs \(applications, API packages, and API proxies and products\), and perform operations like create, update, and delete on variousDeveloper Hub entities as specified in the [Business Accelerator Hub](https://api.sap.com/package/APIMgmt?section=Artifacts). ``` @@ -125,18 +125,18 @@ Create a service instance using *devportal-apiaccess* plan. > > Providing an invalid or an empty `developerId` throws an error in the service instance creation process. > - > To successfully create an application via the API business hub enterprise, you must provide a valid `developerId`. This means that you must have already registered as an application developer to the API Management, API business hub enterprise service or you must have been onboarded by your adminstrator. + > To successfully create an application via the Developer Hub, you must provide a valid `developerId`. This means that you must have already registered as an application developer to the API Management, Developer Hub service or you must have been onboarded by your adminstrator. > - > - If you have registered to the API Management, API business hub enterprise application, provide your `developerId`. + > - If you have registered to the API Management, Developer Hub application, provide your `developerId`. > > 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](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). + > - If you have not registered to the API Management, Developer Hub application, follow the steps in [Register on Developer Hub](register-on-developer-hub-c85fafe.md) and try again. + > - If you are not registered to the API Management, Developer Hub 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`**: > - > - If you are a registered developer in the API business hub enterprise, access the following URL in your browser to obtain your `developerId`: + > - If you are a registered developer in the Developer Hub, access the following URL in your browser to obtain your `developerId`: > > ``` > https://devportal-url/api/1.0/user @@ -168,7 +168,7 @@ Create a service instance using *devportal-apiaccess* plan. > ``` > > - > **Limitation**: Self-service onboarding request is not supported for a developer. So, the POST operation under the **API business hub enterprise- Registering Users** tile in the [API Business Hub](https://api.sap.com/api/DevPortal_RegisteringUsers/resource) cannot be made by the application developer service key. As an alternative, you can invoke this API using the admin service key. + > **Limitation**: Self-service onboarding request is not supported for a developer. So, the POST operation under the **Developer Hub- Registering Users** tile in the [API Business Hub](https://api.sap.com/api/DevPortal_RegisteringUsers/resource) cannot be made by the application developer service key. As an alternative, you can invoke this API using the admin service key. 7. In the section *Confirm*, enter a unique *Instance Name*, and choose *Finish*. @@ -405,7 +405,7 @@ The credentials like url, tokenUrl, developerId \(for developer role\), clientId - The clientId and clientSecret are necessary credentials required to fetch the Bearer Token. - The tokenUrl is used to fetch the Bearer Token. -Make a note of these credentials as you will need them in the next steps to obtain a bearer token, in order to access the API business hub enterprise APIs. +Make a note of these credentials as you will need them in the next steps to obtain a bearer token, in order to access the Developer Hub APIs. > ### Note: > Once your client is setup you can use it to authenticate against the x509 endpoint by providing the client certificate and key. @@ -446,7 +446,7 @@ Make a note of these credentials as you will need them in the next steps to obta -## Updating a Service Instance in the API Management, API business hub enterprise +## Updating a Service Instance in the API Management, Developer Hub You can update an already provisioned service instance of an API access plan by performing the following steps: @@ -479,7 +479,7 @@ In the REST client: 3. Similarly, paste the *clientId* and *clientSecret* in the place of `Username` and `Password`. 4. Make a POST Call. 5. Obtain the Bearer Token from the output and copy it in a notepad. - - Now, to trigger an API, in the same REST client, append the API endpoint \(obtained from the API business hub enterprise APIs that are located in the SAP API Management package of SAP Business Hub Acclerator\) to the *url*. + - Now, to trigger an API, in the same REST client, append the API endpoint \(obtained from the Developer Hub APIs that are located in the SAP API Management package of SAP Business Hub Acclerator\) to the *url*. - Choose `Bearer Token` as the `Authorization` type and paste the copied Bearer Token in the specified space. - Include payloads, if needed. diff --git a/docs/ISuite/activating-and-managing-capabilities-2ffb343.md b/docs/ISuite/activating-and-managing-capabilities-2ffb343.md index bb7c2280..e77885e3 100644 --- a/docs/ISuite/activating-and-managing-capabilities-2ffb343.md +++ b/docs/ISuite/activating-and-managing-capabilities-2ffb343.md @@ -37,6 +37,8 @@ This topic describes how to add and activate relevant capabilities in Integratio - Trading Partner Management +- Data Space Integration + - Integration Assessment - Migration Assessment @@ -96,15 +98,15 @@ This topic describes how to add and activate relevant capabilities in Integratio API Management - - API business hub enterprise + - Developer Hub > ### Note: - > You can activate API business hub enterprise by selecting the checkbox. + > You can activate Developer Hub by selecting the checkbox. - Graph > ### Note: - > You must select API business hub enterprise to activate Graph. + > You must select Developer Hub to activate Graph. @@ -180,6 +182,18 @@ This topic describes how to add and activate relevant capabilities in Integratio + Data Space Integration + + + + + *Exchange Data Within Data Spaces* + + + + + + Integration Assessment @@ -225,9 +239,10 @@ This topic describes how to add and activate relevant capabilities in Integratio - 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). +- After activating Data Space Integration, continue with the additional preparatory steps. See [Preparatory Steps](preparatory-steps-95366b2.md). **Related Information** -[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.") +[Centralized Developer Hub](centralized-developer-hub-38422de.md "The Developer Hub 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 deleted file mode 100644 index 68d31c49..00000000 --- a/docs/ISuite/activating-api-business-hub-enterprise-a0fb69b.md +++ /dev/null @@ -1,82 +0,0 @@ - - - - -# 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 **not** selected by default if you've subscribed to the premium/standard service plan and have activated API Management. - - - -
- -Access API business hub enterprise - - - -Click on the product switcher icon and select API business hub enterprise. - -> ### Note: -> If you have an SAP Build subscription, the API business hub enterprise tile appears on the home page under*Quick Links* section. Select the tile to navigate to the API business hub enterprise web page. Alternatively, you can click on the product switcher icon on the page header and select API business hub enterprise. - -> ### Note: -> To onboard API business hub enterprise web page, the *AuthGroup.SelfService.Admin* role must me assigned to you. This is an one time activity. -> -> Please be aware that the *Authgroup.API.Admin* role is required for onboarding into the API business hub enterprise. This role will be automatically assigned to your scope once you have been assigned the *AuthGroup.SelfService.Admin* role. After the onboarding process is completed, it is necessary for an admin to assign the *Content Administrator* role to a user in order to access and discover the APIs from different business systems in theAPI business hub enterprise. - - - -
- diff --git a/docs/ISuite/activating-developer-hub-a0fb69b.md b/docs/ISuite/activating-developer-hub-a0fb69b.md new file mode 100644 index 00000000..73bca536 --- /dev/null +++ b/docs/ISuite/activating-developer-hub-a0fb69b.md @@ -0,0 +1,82 @@ + + + + +# Activating Developer Hub + +Steps to activate Developer Hub in SAP Integration Suite. Developer Hub 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 Developer Hub + + + +Add and activate Developer Hub in Integration Suite. For more information, see [Activating and Managing Capabilities](activating-and-managing-capabilities-2ffb343.md). + +> ### Note: +> The Developer Hub checkbox is **not** selected by default if you've subscribed to the premium/standard service plan and have activated API Management. + + + +
+ +Access Developer Hub + + + +Click on the product switcher icon and select Developer Hub. + +> ### Note: +> If you have an SAP Build subscription, the Developer Hub tile appears on the home page under*Quick Links* section. Select the tile to navigate to the Developer Hub web page. Alternatively, you can click on the product switcher icon on the page header and select Developer Hub. + +> ### Note: +> To onboard Developer Hub web page, the *AuthGroup.SelfService.Admin* role must me assigned to you. This is an one time activity. +> +> Please be aware that the *Authgroup.API.Admin* role is required for onboarding into the Developer Hub. This role will be automatically assigned to your scope once you have been assigned the *AuthGroup.SelfService.Admin* role. After the onboarding process is completed, it is necessary for an admin to assign the *Content Administrator* role to a user in order to access and discover the APIs from different business systems in theDeveloper Hub. + + + +
+ diff --git a/docs/ISuite/activating-the-capability-b49ad35.md b/docs/ISuite/activating-the-capability-b49ad35.md index 45ca7ac8..95353f03 100644 --- a/docs/ISuite/activating-the-capability-b49ad35.md +++ b/docs/ISuite/activating-the-capability-b49ad35.md @@ -26,7 +26,7 @@ Learn how to activate the Data Space Integration capability within SAP Integrati 3. In the *Capabilities* section, choose *Manage Capabilities* or *Add Capabilities*. -4. In the *Select Capabilities* step, select *Connect within Data Spaces \(Beta\)*. Choose *Next*. +4. In the *Select Capabilities* step, select *Connect within Data Spaces*. Choose *Next*. A list of the capabilities that can be activated is displayed. diff --git a/docs/ISuite/add-an-sap-process-orchestration-system-5f76723.md b/docs/ISuite/add-an-sap-process-orchestration-system-5f76723.md index 80cf2c21..d34f0ed3 100644 --- a/docs/ISuite/add-an-sap-process-orchestration-system-5f76723.md +++ b/docs/ISuite/add-an-sap-process-orchestration-system-5f76723.md @@ -64,7 +64,7 @@ Establish a connection between your SAP Process Orchestration system and Migrati ## Context -To connect your SAP Process Orchestration system with the Migration Assessment application, execute the following steps. +To connect your SAP Process Orchestration system with the Migration Assessment application, perform the following steps. @@ -119,7 +119,11 @@ To connect your SAP Process Orchestration system with the Migration Assessment a 7. Choose *Create*. The new system is now listed under *SAP Process Orchestration Systems*. - If you want to check that the connection is working correctly, select your system and choose *Test Connection*. +8. To check if the connection is working properly, select your system and choose*Test Connection*. + + This test verifies that the main resources needed for the SAP Process Orchestration implementation are reachable. Perform this test even if previous Cloud Connector and destination connection tests were successful, as those don't check for resource accessibility. + + If you get an error during this step, please check the . diff --git a/docs/ISuite/additional-configurations-for-api-management-5ac63ab.md b/docs/ISuite/additional-configurations-for-api-management-5ac63ab.md index 54d7eac6..bb8fa0d8 100644 --- a/docs/ISuite/additional-configurations-for-api-management-5ac63ab.md +++ b/docs/ISuite/additional-configurations-for-api-management-5ac63ab.md @@ -2,7 +2,7 @@ # Additional Configurations for API Management -In this section, you'll find information about different plans for managing API Management, API portal and API business hub enterprise. +In this section, you'll find information about different plans for managing API Management, API portal and Developer Hub. You'll also find information on how to request for additional virtual host, custom domain for a virtual host, and two-way SSL certificate. diff --git a/docs/ISuite/alerting-fe8c67d.md b/docs/ISuite/alerting-fe8c67d.md index f4ea3d0d..c6dd6ed7 100644 --- a/docs/ISuite/alerting-fe8c67d.md +++ b/docs/ISuite/alerting-fe8c67d.md @@ -343,6 +343,20 @@ A very high number of HTTP threads are currently processing requests. +Java Memory usage of the Worker Pod exceeds 95% + + + + +The Java Memory usage of the Worker Pod is significantly high. + +The Java Memory limit is determined by the Worker's Runtime Parameter. + + + + + + Worker has stuck artifacts diff --git a/docs/ISuite/api-business-hub-enterprise-41f7c45.md b/docs/ISuite/api-business-hub-enterprise-41f7c45.md deleted file mode 100644 index f069aa17..00000000 --- a/docs/ISuite/api-business-hub-enterprise-41f7c45.md +++ /dev/null @@ -1,12 +0,0 @@ - - -# 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. - diff --git a/docs/ISuite/api-lifecycle-5e8ea7d.md b/docs/ISuite/api-lifecycle-5e8ea7d.md index 0ec901ed..348b8350 100644 --- a/docs/ISuite/api-lifecycle-5e8ea7d.md +++ b/docs/ISuite/api-lifecycle-5e8ea7d.md @@ -19,7 +19,7 @@ API Management in SAP Integration Suite is used to discover, shape, compose, int [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](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 Developer Hub. In the Developer Hub, 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.") diff --git a/docs/ISuite/api-management-1b17d18.md b/docs/ISuite/api-management-1b17d18.md index c76bd028..46c80f15 100644 --- a/docs/ISuite/api-management-1b17d18.md +++ b/docs/ISuite/api-management-1b17d18.md @@ -18,7 +18,7 @@ With API Management you can perform the following tasks: - **Transform your APIs**: Apply advance header and payload modifications. -- **Developer Engagements**: API business hub enterprise is a feature-rich, themed, and customizable portal designed specifically for application developers. It provides comprehensive API documentation, code snippets, and more. With API business hub enterprise, developers can easily engage with the platform, enabling them to discover, subscribe to, and consume APIs directly. +- **Developer Engagements**: Developer Hub is a feature-rich, themed, and customizable portal designed specifically for application developers. It provides comprehensive API documentation, code snippets, and more. With Developer Hub, developers can easily engage with the platform, enabling them to discover, subscribe to, and consume APIs directly. ![](images/WhatsAPIMBlock_e136868.png) diff --git a/docs/ISuite/api-management-faqs-2d16070.md b/docs/ISuite/api-management-faqs-2d16070.md index f266271d..0f33548a 100644 --- a/docs/ISuite/api-management-faqs-2d16070.md +++ b/docs/ISuite/api-management-faqs-2d16070.md @@ -119,14 +119,14 @@ Answers -What is the difference between SAP API business hub enterprise and SAP API Management? +What is the difference between SAP Developer Hub and SAP API Management? SAP API Management is a solution that helps customers to secure, manage, transform and publish APIs from both SAP and non-SAP systems. The published APIs can be consumed within mobile or web applications on any platform. Application developers who want to use a published API need to subscribe to the respective API. Usage of the published APIs can be monitored and analyzed from SAP API Management. -SAP API business hub enterprise provides a central catalog of SAP and selected partner APIs allowing developers to search, discover, experience and consume the services they need to build new applications, app extensions or process integrations. +SAP Developer Hub provides a central catalog of SAP and selected partner APIs allowing developers to search, discover, experience and consume the services they need to build new applications, app extensions or process integrations. @@ -285,7 +285,7 @@ For detailed information regarding policy types, see [Policy Types](https://help -How to onboard an application developer on the API business hub enterprise? +How to onboard an application developer on the Developer Hub? diff --git a/docs/ISuite/api-services-007d50f.md b/docs/ISuite/api-services-007d50f.md index 0d6b72e3..fb39ff3e 100644 --- a/docs/ISuite/api-services-007d50f.md +++ b/docs/ISuite/api-services-007d50f.md @@ -33,7 +33,7 @@ You can browse through this API package for API admin services with the required -API business hub enterprise +Developer Hub diff --git a/docs/ISuite/approve-the-pending-connection-requests-e296f80.md b/docs/ISuite/approve-the-pending-connection-requests-e296f80.md index ca1579c3..18f8e8f9 100644 --- a/docs/ISuite/approve-the-pending-connection-requests-e296f80.md +++ b/docs/ISuite/approve-the-pending-connection-requests-e296f80.md @@ -4,7 +4,7 @@ # Approve the Pending Connection Requests -As an API business hub enterprise administrator, you must approve or reject the connection request after you receive them. +As an Developer Hub administrator, you must approve or reject the connection request after you receive them. @@ -25,9 +25,9 @@ The following roles must be assigned to you: ## Procedure -1. Log on to the **API business hub enterprise**. +1. Log on to the **Developer Hub**. -2. Navigate to the *Enterprise Manager* \> *API Management Connections* and choose *Pending Requests*. +2. Navigate to the *Admin Center* \> *API Management Connections* and choose *Pending Requests*. The connection requests that are pending for approval are listed on the *Pending Requests* page. @@ -42,5 +42,5 @@ The following roles must be assigned to you: ## Results -The connection has been set up between the Integration Suite API Management tenant and the API business hub enterprise. +The connection has been set up between the Integration Suite API Management tenant and the Developer Hub. diff --git a/docs/ISuite/assigning-role-collections-to-users-80bb02e.md b/docs/ISuite/assigning-role-collections-to-users-80bb02e.md index 15a1521f..4a8eb732 100644 --- a/docs/ISuite/assigning-role-collections-to-users-80bb02e.md +++ b/docs/ISuite/assigning-role-collections-to-users-80bb02e.md @@ -30,7 +30,7 @@ Role collections enable you to group together the roles you create. The role col [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/66d066d903c2473f81ec33acfe2ccdb4/Cloud/en-US/80c0519ebf1449d9bed37fccf7ba127a.html "To discover, consume and monitor API from a centralized API catalog, set up the API business hub enterprise application.") :arrow_upper_right: +[Set Up Developer Hub 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 Developer Hub application.") :arrow_upper_right: [Shadow Users](https://help.sap.com/viewer/38c3df3f8da44a809f937220b3579607/Cloud/en-US/a0f5fe580ed846ca95f8601678509add.html "Whenever a user authenticates at an application in your subaccount using any identity provider, it’s essential that user-related data provided by the identity provider is stored in the form of shadow users.") :arrow_upper_right: diff --git a/docs/ISuite/cancel-api-management-service-subscription-df6df2b.md b/docs/ISuite/cancel-api-management-service-subscription-df6df2b.md index a85896ab..75d8b8a3 100644 --- a/docs/ISuite/cancel-api-management-service-subscription-df6df2b.md +++ b/docs/ISuite/cancel-api-management-service-subscription-df6df2b.md @@ -14,7 +14,7 @@ You can deactivate your API Management capability from Integration Suite to disa **Prequisite**: The *Integration\_Provisioner* role must be assigned to you. -If you've enabled the API Management capability via Integration Suite, perform the following steps to cancel the API portal and the API business hub enterprise subscriptions: +If you've enabled the API Management capability via Integration Suite, perform the following steps to cancel the API portal and the Developer Hub subscriptions: 1. Log on to SAP BTP Cockpit and navigate to your subaccount. @@ -32,7 +32,7 @@ If you've enabled the API Management capability via Integration Suite, perform t The *Deactivate API Management* confirmation dialog appears. -6. Once you choose *Deactivate*, the *API Management, API Portal* and **API Management, API business hub enterprise** applications are deactivated. +6. Once you choose *Deactivate*, the *API Management, API Portal* and **API Management, Developer Hub** applications are deactivated. **Related Information** @@ -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-683a97c.md "API Management protects your backend services. However, API Management needs to establish connectivity to your backend services during an API call execution.") -[User Roles in API Management](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.") +[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 Developer Hub users.") [Setting Up API Management with SAP Cloud Identity Services](setting-up-api-management-with-sap-cloud-identity-services-1e88d9c.md "SAP Cloud Platform allows customers to connect their SAP Cloud Identity Services with the BTP offerings.") diff --git a/docs/ISuite/centralized-api-business-hub-enterprise-38422de.md b/docs/ISuite/centralized-api-business-hub-enterprise-38422de.md deleted file mode 100644 index 3b1dfaef..00000000 --- a/docs/ISuite/centralized-api-business-hub-enterprise-38422de.md +++ /dev/null @@ -1,20 +0,0 @@ - - -# 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. - -If you have enabled API business hub enterprise and API Management tenant in the same Integration Suite sub-account, they will automatically connect to each other. - -> ### Note: -> Once this connection is established, you will not be able to connect the API Management tenant to any other API business hub enterprise enabled in a different sub-account. However, if you have not enabled API business hub enterprise in the same Integration Suite sub-account where you have enabled API Management tenant, you can connect this API Management tenant to an API business hub enterprise enabled in another sub-account and designate it as a centralized API business hub enterprise. -> -> This centralized API business hub enterprise can be used to establish connections with multiple API Management tenants and can receive API proxies, API products, and other assets from each connected API Management tenants. It is important to ensure that all assets published to the centralized API business hub enterprise are unique. - -> ### Remember: -> You can configure multipleIntegration Suite API Management tenants to cater to different stages of the API lifecycle. For example, you can have separate instances for development, testing, and production. However, connecting these API Management tenants having such a relationship to the same API business hub enterprise will violate the uniquness of the assets. - -Once the application developers register with the centralized API business hub enterprise, they can easily search, explore, and test APIs. They can also create and subscribe to specific types of applications available from the API business hub enterprise. - -The API business hub enterprise admin identifies which existing or new API business hub enterprise application can accept content from multiple Integration Suite API Management tenants. - diff --git a/docs/ISuite/centralized-developer-hub-38422de.md b/docs/ISuite/centralized-developer-hub-38422de.md new file mode 100644 index 00000000..64a75b0a --- /dev/null +++ b/docs/ISuite/centralized-developer-hub-38422de.md @@ -0,0 +1,20 @@ + + +# Centralized Developer Hub + +The Developer Hub is a central API catalog, allowing application developers to consume APIs and other assets, from a common platform. + +If you have enabled Developer Hub and API Management tenant in the same Integration Suite sub-account, they will automatically connect to each other. + +> ### Note: +> Once this connection is established, you will not be able to connect the API Management tenant to any other Developer Hub enabled in a different sub-account. However, if you have not enabled Developer Hub in the same Integration Suite sub-account where you have enabled API Management tenant, you can connect this API Management tenant to an Developer Hub enabled in another sub-account and designate it as a centralized Developer Hub. +> +> This centralized Developer Hub can be used to establish connections with multiple API Management tenants and can receive API proxies, API products, and other assets from each connected API Management tenants. It is important to ensure that all assets published to the centralized Developer Hub are unique. + +> ### Remember: +> You can configure multipleIntegration Suite API Management tenants to cater to different stages of the API lifecycle. For example, you can have separate instances for development, testing, and production. However, connecting these API Management tenants having such a relationship to the same Developer Hub will violate the uniquness of the assets. + +Once the application developers register with the centralized Developer Hub, they can easily search, explore, and test APIs. They can also create and subscribe to specific types of applications available from the Developer Hub. + +The Developer Hub admin identifies which existing or new Developer Hub application can accept content from multiple Integration Suite API Management tenants. + diff --git a/docs/ISuite/component-monitor-49f487e.md b/docs/ISuite/component-monitor-49f487e.md index 62e80020..63214725 100644 --- a/docs/ISuite/component-monitor-49f487e.md +++ b/docs/ISuite/component-monitor-49f487e.md @@ -4,11 +4,11 @@ # Component Monitor -Get information on the components. +Get information on your components. -The *Component Monitor* tile shows you the most important information regarding your components at a glance. Out of all components for Edge Integration Cell, the tile always shows either those components in status *Error* or the status of the top three components, *Policy Engine*, *Worker*, and *Solace* \(Message Service\) in status *OK*. +The *Component Monitor* card in the **Operations Cockpit** shows you the most important information regarding your components at a glance. Out of all components for Edge Integration Cell, the card always shows either those components in status *Error* or the status of the top three components, *Policy Engine*, *Worker*, and *Solace* \(Message Service\) in status *OK*. -Choose the tile to view the full list of your deployed components and learn more about them. On the *Component Monitor* overview page, you can see a table with the following information: +Choose the card to view the full list of your deployed components and learn more about them. On the *Component Monitor* overview page, you can see a table with the following information: @@ -48,6 +48,11 @@ The status of the component's resources: *OK*, *Error* or *Warning* This column shows the combined state of all pods and is calculated based on the **Ready** and **Pod Status** information. For the Status to be **OK** all pods'**Pod Status** must be **Running**, and their current value must equal the expected value in the **Ready** column. +> ### Note: +> If the pod status indicates an error for one of the components, you can view the specific details of the pod events by selecting **View Pod Events** from the *Actions* menu. + + + @@ -120,18 +125,39 @@ The number of times a pod has restarted after it was initialized. -
+ + + +*Actions* + + + -If the pod status indicates an error for one of the components, you can view the specific details of the pod events. To do so, select the component in the table and the option **View Pod Events** \( View Pod Events\) becomes available. There's no exhaustive list of all pod events, but the Kubernetes documentation provides some examples. For more information, see [https://kubernetes.io/docs/reference/kubernetes-api/cluster-resources/event-v1/\#Event.](https://kubernetes.io/docs/reference/kubernetes-api/cluster-resources/event-v1/#Event.) +You can perform the following actions on the selected component. Depending on the component only some actions are available: -When you select an individual component, the grayed-out option **View Runtime Parameters** also becomes available. This leads you to the screen **Runtime Parameters** \(also accessible through the **Quick Links** card in the **Operations Cockpit**\), which provides more detailed information on the runtime parameters of the selected component. For more information, see: [Runtime Parameters](runtime-parameters-63c5276.md). +- **View Pod Events** . Examine the pod events associated with the selected component. + + There's no exhaustive list of all pod events, but the Kubernetes documentation provides some examples. For more information, see [https://kubernetes.io/docs/reference/kubernetes-api/cluster-resources/event-v1/\#Event.](https://kubernetes.io/docs/reference/kubernetes-api/cluster-resources/event-v1/#Event.) + +- **View Runtime Parameters **. Navigate to the screen **Runtime Parameters** \(also accessible through the **Quick Links** card in the **Operations Cockpit**\), which provides more detailed information on the runtime parameters of the selected component. For more information, see: [Runtime Parameters](runtime-parameters-63c5276.md). +- *Create Heap Dump Diagnostic Task*. Diagnose issues related to memory consumption for the selected pod. For more information, see [Diagnostics](diagnostics-80f3050.md). +- *Create Thread Dump Diagnostic Task*. Diagnose unequal resource usage that may cause system slowness for the selected pod. For more information, see [Diagnostics](diagnostics-80f3050.md). + +> ### Note: +> The **Create Heap** and *Thread Dump Diagnostic Tasks* actions become available for components that support *Diagnostics* \(*Edge API App*, *Monitoring Data Consumer*, and *Edge Security Artifact Controller*\). The menu is enabled when the pod is in the *Running* status and when the number of target containers matches the number in the *Ready* column. + + + + + + **Related Information** [Operations Cockpit](operations-cockpit-ec0fc95.md "The Operations Cockpit is the central control point for operating edge integration cells and allows the Edge Integration Cell administrator to monitor and adjust system configurations and resources.") -[Job Management](job-management-4146fa5.md "Organize and schedule your existing system jobs, such as data store entries cleanup or trace entries cleanup, or add jobs manually.") +[Job Management](job-management-4146fa5.md "Organize and schedule your existing system jobs, and add new jobs manually.") [Runtime Parameters](runtime-parameters-63c5276.md "Get information about the runtime parameters of the components of your Edge Integration Cell.") diff --git a/docs/ISuite/components-of-api-management-e02ae53.md b/docs/ISuite/components-of-api-management-e02ae53.md index 64db3596..acf18081 100644 --- a/docs/ISuite/components-of-api-management-e02ae53.md +++ b/docs/ISuite/components-of-api-management-e02ae53.md @@ -10,7 +10,7 @@ The API Management infrastructure comprises of five key components: - **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 API Proxies](50-Development/analyze-api-proxies-7712c61.md). -- **API business hub enterprise**: It is a self-service portal for application developers. You can discover, browse, and explore APIs. Subscribe to a rate plan and build application. For more information, see [Consume API Proxies](consume-api-proxies-ea561e4.md). +- **Developer Hub**: 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). diff --git a/docs/ISuite/manage-external-content-f5bd17d.md b/docs/ISuite/configure-the-visibility-of-graph-navigator-f5bd17d.md similarity index 88% rename from docs/ISuite/manage-external-content-f5bd17d.md rename to docs/ISuite/configure-the-visibility-of-graph-navigator-f5bd17d.md index 100b5d28..ad7ce589 100644 --- a/docs/ISuite/manage-external-content-f5bd17d.md +++ b/docs/ISuite/configure-the-visibility-of-graph-navigator-f5bd17d.md @@ -1,8 +1,8 @@ -# Manage External Content +# Configure the Visibility of Graph Navigator -On this page, you have the option to adjust the visibility of the Graph navigator on the API business hub enterprise. +On this page, you have the option to adjust the visibility of the Graph navigator on the Developer Hub. @@ -33,9 +33,9 @@ If the graph feature is deactivated in the Integration Suite, the *Configure Gra ## Procedure -1. Log on to the API business hub enterprise. +1. Log on to the Developer Hub. -2. Choose *Enterprise Manager* \> *Manage External Content* from the top navigation bar. +2. Choose *Admin Center* \> *Manage External Content* from the top navigation bar. 3. Use the slider button to enable/disable the graph feature. 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 3efdd9cd..87cdc039 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-683a97c.md "API Management protects your backend services. However, API Management needs to establish connectivity to your backend services during an API call execution.") -[User Roles in API Management](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.") +[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 Developer Hub users.") [Cancel API Management Service Subscription](cancel-api-management-service-subscription-df6df2b.md "You can deactivate your API Management capability from Integration Suite to disable your account from the API Management service.") diff --git a/docs/ISuite/configuring-connector-setup-using-the-api-alternative-approach-bfa408c.md b/docs/ISuite/configuring-connector-setup-using-the-api-alternative-approach-bfa408c.md index 986c6ab7..d57a0c99 100644 --- a/docs/ISuite/configuring-connector-setup-using-the-api-alternative-approach-bfa408c.md +++ b/docs/ISuite/configuring-connector-setup-using-the-api-alternative-approach-bfa408c.md @@ -38,13 +38,10 @@ Onboard with Catena-X and get started in Data Space Integration by entering your 1. First, create credentials to access Data Space Integration. The service instance and key your create in this step help you retrieve the connector URL for Data Space Integration. - 1. Go to the SAP BTP cockpitand navigate to your subaccount that has SAP Integration Suite enabled. From there, go to *Cloud Foundry* \> *Spaces* \> *Your space* \> *Services* \> *Instances*. + 1. Go to the SAP BTP cockpit and navigate to your subaccount that has SAP Integration Suite enabled. From there, go to *Cloud Foundry* \> *Spaces* \> *Your space* \> *Services* \> *Instances*. 2. Select *Create* to create a new service instance and select `Data Space Integration API Access`. In the *Plan* field, enter `api`, and add an instance name. Then, choose *Next*. - > ### Remember: - > If `Data Space Integration API Access` isn't available to you, check whether you've enabled beta features for your SAP BTP subaccount. See [Initial Setup](https://help.sap.com/viewer/fd99f220bba84308b411ea62c86ff31e/CLOUD/en-US/e8539cf283184169a71fe45be6719bff.html "Learn how to set up the Data Space Integration capability within SAP Integration Suite.") :arrow_upper_right:. - 3. Next, select the applicable roles to enforce user authorization. For this specific process, any role works, even `AuthGroup_DataspaceReadOnly`. For an overview of all roles, see [Personas and Roles](https://help.sap.com/viewer/fd99f220bba84308b411ea62c86ff31e/CLOUD/en-US/bb8cd79bd90e4b70ae424d7ff3f8c1e8.html "Get an overview of the personas and roles in Data Space Integration and the tasks they can accomplish.") :arrow_upper_right:. Once the roles are selected, select `client_credentials` as the grant type and choose *Next*. 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 fcf57b31..4e9143d0 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 @@ -148,13 +148,13 @@ 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 Developer Hub: *AuthGroup.SelfService.Admin* - - Onboard to API business hub enterprise. - - Gain access to API business hub enterprise. See [Setting Up API Management Capability](50-Development/setting-up-api-management-capability-f34e86c.md) + - Onboard to Developer Hub. + - Gain access to Developer Hub. See [Setting Up API Management Capability](50-Development/setting-up-api-management-capability-f34e86c.md) @@ -183,7 +183,7 @@ For more information on role collections, see [Roles and Role Collections](https - 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). + Use the Graph Navigator in SAP Developer Hub to inspect business data graphs. See [Define Users](https://help.sap.com/docs/graph/initial-setup#2.-define-users-for-graph). @@ -404,6 +404,100 @@ For more information on role collections, see [Roles and Role Collections](https + + + + + + Data Space Integration + + + + + DataspaceReadOnly + + + + + - See the assets, policies, and contract definitions that were created. + + - See the negotiated agreements. + + + + + + + + + + DataspaceConsumer + + + + + - Initiate contract negotiations. + + - Initiate transfer of assets. + + - Use the Data Management API to request data via Data Space Integration. + + - Use the EDR Management API to request data via Data Space Integration. + + - Read the negotiated agreements. + + + + + + + + + + DataspaceProvider + + + + + - Create assets, policies, and contract definitions. + + - See the negotiated agreements. + + + + + + + + + + DataspaceTechnicalAdmin + + + + + - Onboard Data Space Integration to a data space. + + - Assign company policies to use cases. + + + + + + + + + + DataspaceBusinessAdmin + + + + + - Create and edit company policies. + + + + diff --git a/docs/ISuite/connectivity-options-93d82e8.md b/docs/ISuite/connectivity-options-93d82e8.md index 49a45a5c..7e0fb69d 100644 --- a/docs/ISuite/connectivity-options-93d82e8.md +++ b/docs/ISuite/connectivity-options-93d82e8.md @@ -985,6 +985,22 @@ See: [JDBC for SAP HANA Platform \(On-Premise\)](50-Development/jdbc-for-sap-han +*Jira* + +Receiver adapter + + + + +Enables SAP Integration Suite to connect to Jira. + +See: [Jira Receiver Adapter](50-Development/jira-receiver-adapter-d15b560.md) + + + + + + *JMS* Sender adapter diff --git a/docs/ISuite/consume-api-proxies-ea561e4.md b/docs/ISuite/consume-api-proxies-ea561e4.md index a859dc88..953fed16 100644 --- a/docs/ISuite/consume-api-proxies-ea561e4.md +++ b/docs/ISuite/consume-api-proxies-ea561e4.md @@ -2,30 +2,30 @@ # Consume API Proxies -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 via the Developer Hub. In the Developer Hub, 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 [User Roles and Responsibilities in API business hub enterprise](user-roles-and-responsibilities-in-api-business-hub-enterprise-54b4607.md). +> Effective June 2024, the classic design of the Developer Hub will be deprecated and will no longer be accessible. The new design of the Developer Hub will be set as your default design from March 2024. For more information, see [User Roles and Responsibilities in Developer Hub](user-roles-and-responsibilities-in-developer-hub-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. +If you've added Developer Hub as a capability with Integration suite, or if you’ve subscribed to the Developer Hub as part of the standalone API Management subscription, you have the option to experience the new design of the Developer Hub user interface along with the classic design. > ### 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. For more information, see [Customize the Visual Format of the API business hub enterprise](customize-the-visual-format-of-the-api-business-hub-enterprise-2eacd52.md). +> 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. For more information, see [Customize the Visual Format of the Developer Hub](customize-the-visual-format-of-the-developer-hub-2eacd52.md). ![](images/ABHE_Block_509b298.png) -API business hub enterprise is an application that provides a common platform for Application developers to consume API proxies. Every API Management customer is provided with their own API business hub enterprise application on cloud. The API business hub enterprise offers capabilities to onboard application developers, explore and test API proxies, create and subscribe to Applications. +Developer Hub is an application that provides a common platform for Application developers to consume API proxies. Every API Management customer is provided with their own Developer Hub application on cloud. The Developer Hub offers capabilities to onboard application developers, explore and test API proxies, create and subscribe to Applications. -The API business hub enterprise supports the following features: +The Developer Hub supports the following features: -- **Onboard an Application developer**- To explore the API proxies and subscribe to an Application, an Application developer must be registered to the API business hub enterprise. On registering, the Application developer is provided access to the API business hub enterprise. +- **Onboard an Application developer**- To explore the API proxies and subscribe to an Application, an Application developer must be registered to the Developer Hub. On registering, the Application developer is provided access to the Developer Hub. - **Browse Catalog**- Explore the Products \(assembled APIs\) available in the Catalog store, navigate to individual API proxies, read the API Documentation, and view the resources attached to the API proxies. > ### Note: - > A limitation within the open-source Swagger library, on which the API business hub enterprise relies, causes slow, improper, or no rendering of API schemas that contain circular references on deeply nested models on the platform. + > A limitation within the open-source Swagger library, on which the Developer Hub relies, causes slow, improper, or no rendering of API schemas that contain circular references on deeply nested models on the platform. - **Create Applications** – An Application developer can create on or more applications to consume API proxies. To consume the API proxies, an Application developer must subscribe to an Application \(assembled Products\). It is by subscribing to an Application that you return to the developer the key required to access the API proxies. -- **Download JSON**- You can download the open API specification for the APIs that are part of the API business hub enterprise in JSON format. This enables the developer to use the metadata of the APIs for various aspects such as code/SDK generation for developing applications. +- **Download JSON**- You can download the open API specification for the APIs that are part of the Developer Hub in JSON format. This enables the developer to use the metadata of the APIs for various aspects such as code/SDK generation for developing applications. - **Download SDK**- You can also download the client software development kit \(SDK\) for developers through a non-commercial license on open source sites. You can use this SDK for developing applications. @@ -34,5 +34,5 @@ The API business hub enterprise supports the following features: **Related Information** -[User Roles and Responsibilities in API business hub enterprise](user-roles-and-responsibilities-in-api-business-hub-enterprise-54b4607.md "After activating the API business hub enterprise in the Integration Suite, you need to assign users the necessary roles and role collections to access the various features and functionalities of API business hub enterprise.") +[User Roles and Responsibilities in Developer Hub](user-roles-and-responsibilities-in-developer-hub-54b4607.md "After activating the Developer Hub in the Integration Suite, you need to assign users the necessary roles and role collections to access the various features and functionalities of Developer Hub.") diff --git a/docs/ISuite/consume-api-proxies-using-sap-business-application-studio-15732eb.md b/docs/ISuite/consume-api-proxies-using-sap-business-application-studio-15732eb.md index 72de1b95..25b1836c 100644 --- a/docs/ISuite/consume-api-proxies-using-sap-business-application-studio-15732eb.md +++ b/docs/ISuite/consume-api-proxies-using-sap-business-application-studio-15732eb.md @@ -2,7 +2,12 @@ # Consume API Proxies Using SAP Business Application Studio -The service center in SAP Business Application Studio provides a central entry point to explore products and services from the API business hub enterprise. +The service center in SAP Business Application Studio provides a central entry point to explore products and services from the Developer Hub. -You can use this service center to develop your applications based on the OData Services available as a part of products published in API business hub enterprise. For more information, see [API Business Hub Enterprise Service Provider](https://help.sap.com/docs/SAP%20Business%20Application%20Studio/9d1db9835307451daa8c930fbd9ab264/328519b3b7c04871b63a41350190d4d5.html?version=Cloud). +You are an application developer, you can use this service center to develop your applications based on the OData Services available as a part of products published in Developer Hub. For more information, see [Developer Hub Service Provider](https://help.sap.com/docs/SAP%20Business%20Application%20Studio/9d1db9835307451daa8c930fbd9ab264/328519b3b7c04871b63a41350190d4d5.html?version=Cloud). + +**Related Information** + + +[Creating Destinations and Adding System and Consumption Bundle Properties](https://help.sap.com/viewer/54e467e3bd2148deb837d34d1ec66a78/IAT/en-US/c80ff2875e08440c8429fda79461c161.html "You are a content administrator, you want to ensure that the SAP Build developers have access to products published in Developer Hub.") :arrow_upper_right: diff --git a/docs/ISuite/content-life-cycle-06581f4.md b/docs/ISuite/content-life-cycle-06581f4.md deleted file mode 100644 index 6ddb74e1..00000000 --- a/docs/ISuite/content-life-cycle-06581f4.md +++ /dev/null @@ -1,130 +0,0 @@ - - -# Content Life Cycle - -Incorporate new versions of standard content into your dataset. - -At the time of onboarding, the latest available SAP standard content will be available for usage. As and when new version of SAP standard content is released, you have the flexibility to update to the latest version depending on your business needs. - -> ### Example: -> Recommendation Degree 'Not Supported / Not Relevant' is assigned to to Key Characteristic Patterns relevant for the Data Integration Style. After assigning the recommendation degree, a new version of SAP standard content is released. If the standard content is updated to the latest version, it will affect the assessment result. Since the update will impact the existing scenario, you can choose to retain the old version. - -Every time a new version of SAP standard content is released, you can choose which changesets to update by selecting or deselecting it. Selecting a changeset will include it and not selecting a changeset will remove it and trigger potential cleanup actions. - -> ### Example: -> Not selecting a "remove action" will trigger the referred content to be not SAP managed any longer. - -> ### Note: -> If you are an old customer and new version of standard content has been updated after your onboarding, you will be able to see *Content Life Cycle* in the left navigation based on a rule. Only the personas *Integration Architect* and *Administrator* will have the rights for "Update". - -**** - - - - - - - - - - - - - - - - - - - -
- -Header - - - -Meaning - -
- -Type - - - -The type of Update. Possible values are: - -- New - New Content - -- Update - Update of existing content - -- Delete - Deletion of old content - - - - -
- -Mandatory For Update - - - -Signifies if the changeset is mandatory if you plan to update it. Possible values are Yes/No. - -
- -Available For Update - - - -Signifies if the changeset is available for update. Possible values are Yes/No. - -
- - - - - -## Notification for outdated ISA-M version - -To get notified about the content updates delivered by SAP, as an Administrator directly in the tool. - -1. Click on the *Notification* button \(bell icon\) in the shell bar. The badge shows the number of notifications available. -2. If there is newer content available, the title is displayed as *New Content Available*. The description is displayed as *A newer version of the content maintained by SAP is available for update.* -3. To view the content updates, click on *View Updates*. The *Content Life Cycle* page with new content is displayed. - - - - - -## Versioning - -When there is more than one version of the standard content released, you cannot directly upgrade to the latest version. You will only be able to upgrade to the next version. - -> ### Example: -> If the current version is 1.1, update version is 1.2 and the latest version is 1.3, you will only be able to update first to 1.2 and then to 1.3. You cannot update directly to the latest version. - - - - - -## Hierarchial Data - -The dataset is hierarchical and has a parent-child relationship. Parent nodes are known as *Changesets*, Child nodes are *Change Execution Sets*. Whenever you are trying to update a parent node, the child node should also be considered. Under one parent node, there can be multiple child nodes. There are two types of child nodes: - -1. *Mandatory child node* - - For a mandatory child node, if the parent node is deslected, the child nodes are deselected by default. - -2. *Non-mandatory child node* - - For a non-mandatory child node, if the parent node is deselected, you have the control to select or deselect the child nodes. Sufficient details about what all content is going to be updated as part of this selection/deselection is shown. - - - - - - -## Error Scenario - -At the time of update, if there is an error, the update fails. It is all going to be in a single transaction. Its either successfully updated or it is not updated. A red icon is visible which shows the details of the failure and reason for the failure. Accordingly, sufficient action can be taken. - diff --git a/docs/ISuite/create-a-connection-request-for-the-centralized-api-business-hub-enterprise-c7bda8c.md b/docs/ISuite/create-a-connection-request-for-the-centralized-developer-hub-c7bda8c.md similarity index 68% rename from docs/ISuite/create-a-connection-request-for-the-centralized-api-business-hub-enterprise-c7bda8c.md rename to docs/ISuite/create-a-connection-request-for-the-centralized-developer-hub-c7bda8c.md index b670501e..2bb6ed64 100644 --- a/docs/ISuite/create-a-connection-request-for-the-centralized-api-business-hub-enterprise-c7bda8c.md +++ b/docs/ISuite/create-a-connection-request-for-the-centralized-developer-hub-c7bda8c.md @@ -1,8 +1,8 @@ -# Create a Connection Request for the Centralized API business hub enterprise +# Create a Connection Request for the Centralized Developer Hub -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. +Create a request to connect the Integration Suite API Management tenant to the Developer Hub. You need to establish this connection to publish the content of the Integration Suite API Management tenant on the Developer Hub. @@ -10,9 +10,9 @@ Create a request to connect the Integration Suite API Management tenant to the A ## 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 connections between the Developer Hub and Integration Suite API Management tenants, a Cloud Foundry space should be created in the sub-account from where the Developer Hub 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 API portal. +- To establish a connection between an Integration Suite API Management tenant and the centralised Developer Hub which is available in a different sub-account, you must ensure that the Developer Hub capability is not enabled in the same sub-account as that of the API portal. - The following role collections should be assigned to you: - AuthGroup.API.Admin @@ -32,7 +32,7 @@ Create a request to connect the Integration Suite API Management tenant to the A 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. + 4. Follow the onscreen instructions under **Connect the API Portal to the centralized Developer Hub** to generate the Integration Suite API Management tenant access credentials. > ### Note: @@ -45,25 +45,25 @@ Create a request to connect the Integration Suite API Management tenant to the A ## 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. +The Developer Hub administrator identifies which existing or new Developer Hub application can accept content from multiple Integration Suite API Management tenants. > ### Note: -> Only new Integration Suite subscriptions with API Management capability enabled with the Integration Suite are allowed to set up a connection with the centralized API business hub enterprise. +> Only new Integration Suite subscriptions with API Management capability enabled with the Integration Suite are allowed to set up a connection with the centralized Developer Hub. > ### Note: -> You can connect a maximum number of three Integration Suite API portals to the centralized API business hub enterprise. +> You can connect a maximum number of three Integration Suite API portals to the centralized Developer Hub. 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. +For the newly set up Integration Suite API Management tenant, you can request for the Developer Hub 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. +> The option to disconnect an Integration Suite API Management tenant from an existing Developer Hub 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. +> 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 Developer Hub. -To create a request to connect the Integration Suite API Management tenant to the centralized API business hub enterprise. +To create a request to connect the Integration Suite API Management tenant to the centralized Developer Hub. @@ -71,7 +71,7 @@ To create a request to connect the Integration Suite API Management tenant to th ## Procedure -1. Log on to the **API business hub enterprise**. +1. Log on to the **Developer Hub**. 2. Navigate to the *Admin Center* \> *Manage Connections* and choose *Approved Requests*. @@ -101,7 +101,7 @@ To create a request to connect the Integration Suite API Management tenant to th - 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. + Enter the Integration Suite API Management tenant name that gets displayed on the Developer Hub. This name is used to distinguish products that are published from the API portal and likewise for applications created for the product. @@ -113,7 +113,7 @@ To create a request to connect the Integration Suite API Management tenant to th - 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. + Enter the Integration Suite API Management tenant access credentials that you generated earlier. These credentials are used by the Developer Hub to establish the connection. Sample credentials: @@ -149,7 +149,7 @@ To create a request to connect the Integration Suite API Management tenant to th - 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. + 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 Developer Hub. @@ -169,7 +169,7 @@ To create a request to connect the Integration Suite API Management tenant to th ## 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. +You've submitted the connection request to the Developer Hub administrator. Once the connection request is approved by the administrator, you can start publishing the Integration Suite API Management tenant content to the Developer Hub. > ### Note: > You can log on to the Integration Suite API Management tenant and check the connection status. Navigate to *Settings* \> *APIs* and choose *Connection*. diff --git a/docs/ISuite/create-an-application-a501a6d.md b/docs/ISuite/create-an-application-a501a6d.md index b0688eb2..06933613 100644 --- a/docs/ISuite/create-an-application-a501a6d.md +++ b/docs/ISuite/create-an-application-a501a6d.md @@ -6,7 +6,7 @@ Create an Application to consume the required APIs. 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. +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 Developer Hub. 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. -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. +A user must be onboarded to Developer Hub only via Self-registration or *Add User* flow. For more information on registering in Developer Hub, see [Register on Developer Hub](register-on-developer-hub-c85fafe.md). In the *Add User* flow, the Developer Hub admin adds a user who wants to be onboarded to Developer Hub. 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. diff --git a/docs/ISuite/create-heap-and-thread-dumps-fb10394.md b/docs/ISuite/create-heap-and-thread-dumps-fb10394.md index aa4ab1ad..aaa2d1cc 100644 --- a/docs/ISuite/create-heap-and-thread-dumps-fb10394.md +++ b/docs/ISuite/create-heap-and-thread-dumps-fb10394.md @@ -8,7 +8,14 @@ Learn how to create heap and thread dumps. ## Context -You can create heap and thread dumps using the `jcmd` tool. +You can create heap and thread dumps either by: + +- Creating a diagnostic task. Open *Diagnostics* through the *Quick Links* card in the Operations Cockpit and create a *Heap* or *Thread Dump* task. + + For more information, see [Diagnostics](diagnostics-80f3050.md). + +- Using the `jcmd` tool. To do so, perform the following procedure: + diff --git a/docs/ISuite/create-products-by-importing-api-specifications-961d39e.md b/docs/ISuite/create-products-by-importing-api-specifications-961d39e.md index 16f08811..2bef87f8 100644 --- a/docs/ISuite/create-products-by-importing-api-specifications-961d39e.md +++ b/docs/ISuite/create-products-by-importing-api-specifications-961d39e.md @@ -2,7 +2,7 @@ # Create Products by Importing API Specifications -As a content administrator, you can discover APIs from various business systems and publish them as products in the API business hub enterprise catalog. However, if you have an API specification from an external gateway, you can still create a product and make it available in the catalog. +As a content administrator, you can discover APIs from various business systems and publish them as products in the Developer Hub catalog. However, if you have an API specification from an external gateway, you can still create a product and make it available in the catalog. @@ -22,9 +22,9 @@ To import an API specification, you must first create a product. Then, use the * ## Procedure -1. Log on to the **API business hub enterprise**. +1. Log on to the **Developer Hub**. -2. Navigate to the *Enterprise Manager* \> *Manage* \> *Content*. +2. Navigate to the *Admin Center* \> *Manage* \> *Content*. 3. Choose the *Products**Create* diff --git a/docs/ISuite/create-products-from-business-systems-08aff91.md b/docs/ISuite/create-products-from-business-systems-08aff91.md index 8dbe0aee..eb663a99 100644 --- a/docs/ISuite/create-products-from-business-systems-08aff91.md +++ b/docs/ISuite/create-products-from-business-systems-08aff91.md @@ -16,9 +16,9 @@ The *AuthGroup.Content.Admin* role collection should be assigned to you. ## Procedure -1. Log on to the API business hub enterprise. +1. Log on to the Developer Hub. -2. Navigate to the *Enterprise Manager* \> *Manage* \> *Content*. +2. Navigate to the *Admin Center* \> *Manage* \> *Content*. A list of all business systems is displayed. @@ -60,7 +60,7 @@ The *AuthGroup.Content.Admin* role collection should be assigned to you. **Related Information** -[Make APIs Available in the Catalog](make-apis-available-in-the-catalog-f148690.md "As a content administrator, make your APIs available to developers in your organization by publishing them on API business hub enterprise.") +[Make APIs Available in the Catalog](make-apis-available-in-the-catalog-f148690.md "As a content administrator, make your APIs available to developers in your organization by publishing them on Developer Hub.") [Manage Products](manage-products-4dd3d90.md "As a content administrator, you have the ability to manage a product once it has been created.") diff --git a/docs/ISuite/creating-a-custom-role-9d827cd.md b/docs/ISuite/creating-a-custom-role-9d827cd.md index d3fbf044..eb3b94c2 100644 --- a/docs/ISuite/creating-a-custom-role-9d827cd.md +++ b/docs/ISuite/creating-a-custom-role-9d827cd.md @@ -27,7 +27,7 @@ You can restrict access to an API product in API Management using a custom role. 2. Choose *Service Marketplace* in the left-hand pane. -3. In order to create a custom role, choose **API Management, API business hub enterprise** tile. +3. In order to create a custom role, choose **API Management, Developer Hub** tile. 4. Under *Application Plans* for API BusinessHub Enterprise, choose the Action icon and select *Manage Roles*. @@ -79,7 +79,7 @@ You can restrict access to an API product in API Management using a custom role. > ### Remember: - > Application Developers who are already onboarded in the API business hub enterprise should have the custom role. If any user has been assigned a custom role but hasn’t been onboarded as an application developer in the API business hub enterprise, the application creation fails. In this case, Authgroup.API.Admin can onboard the user as an Application Developer in the portal. + > Application Developers who are already onboarded in the Developer Hub should have the custom role. If any user has been assigned a custom role but hasn’t been onboarded as an application developer in the Developer Hub, the application creation fails. In this case, Authgroup.API.Admin can onboard the user as an Application Developer in the portal. **Next Steps** diff --git a/docs/ISuite/creating-an-application-with-application-developer-role-99515fc.md b/docs/ISuite/creating-an-application-with-application-developer-role-99515fc.md index 41840b72..3ecec72b 100644 --- a/docs/ISuite/creating-an-application-with-application-developer-role-99515fc.md +++ b/docs/ISuite/creating-an-application-with-application-developer-role-99515fc.md @@ -15,9 +15,9 @@ As an application developer you can create an application, and view the existing > ### 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. > - > 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. 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). + > The *AuthGroup.API.ApplicationDeveloper* role is assigned by default to a user who onboards to the Developer Hub using the self-registration process or via*Add User* flow. For more information on registering in Developer Hub, see [Register on Developer Hub](register-on-developer-hub-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. + > In the Add User flow, the Developer Hub admin adds a user who wants to be onboarded to Developer Hub. 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. @@ -30,7 +30,7 @@ You are about to create an application and add products to your application. You ## Procedure -1. Log on to the API business hub enterprise and navigate to *My Workspace*. +1. Log on to the Developer Hub and navigate to *My Workspace*. The applications you created earlier, are displayed under the *Applications* tab. For an existing application, you can view the total number of calls made in the current month on the *Applications* page. diff --git a/docs/apim/API-Management/creating-an-application-with-api-business-hub-enterprise-administrator-role-df4f777.md b/docs/ISuite/creating-an-application-with-developer-hub-administrator-role-df4f777.md similarity index 79% rename from docs/apim/API-Management/creating-an-application-with-api-business-hub-enterprise-administrator-role-df4f777.md rename to docs/ISuite/creating-an-application-with-developer-hub-administrator-role-df4f777.md index df5fb653..0c33ded7 100644 --- a/docs/apim/API-Management/creating-an-application-with-api-business-hub-enterprise-administrator-role-df4f777.md +++ b/docs/ISuite/creating-an-application-with-developer-hub-administrator-role-df4f777.md @@ -1,8 +1,8 @@ -# Creating an Application with API business hub enterprise Administrator Role +# Creating an Application with Developer Hub 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. +With the Developer Hub 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. @@ -11,7 +11,7 @@ With the API business hub enterprise administrator role you can create an applic ## Prerequisites > ### Note: -> The availability of this feature is dependent on your SAP Integration Suite service plan. For more information about different service plans and their supported feature set, see [User Roles and Responsibilities in API business hub enterprise](user-roles-and-responsibilities-in-api-business-hub-enterprise-54b4607.md). You can also refer to the SAP Notes [2903776](https://help.sap.com/docs/link-disclaimer?site=https%3A%2F%2Fme.sap.com%2Fnotes%2F2903776) and [3463620](https://help.sap.com/docs/link-disclaimer?site=https%3A%2F%2Fme.sap.com%2Fnotes%2F3463620). +> The availability of this feature is dependent on your SAP Integration Suite service plan. For more information about different service plans and their supported feature set, see [User Roles and Responsibilities in Developer Hub](user-roles-and-responsibilities-in-developer-hub-54b4607.md). You can also refer to the SAP Notes [2903776](https://help.sap.com/docs/link-disclaimer?site=https%3A%2F%2Fme.sap.com%2Fnotes%2F2903776) and [3463620](https://help.sap.com/docs/link-disclaimer?site=https%3A%2F%2Fme.sap.com%2Fnotes%2F3463620). You should have the *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:. @@ -19,7 +19,7 @@ You should have the *AuthGroup.API.Admin* role assigned to you. For more informa ## Context -An API business hub enterprise administrator can perform the following tasks: +An Developer Hub 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. @@ -31,12 +31,12 @@ An API business hub enterprise administrator can perform the following tasks: ## Procedure -1. Log on to the **API business hub enterprise** and navigate to *My Workspace*. +1. Log on to the **Developer Hub** and navigate to *My Workspace*. 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: - > For API business hub enterprise administrators, analytics data is unavailable for those applications that they created on behalf of other users or application developers. + > For Developer Hub administrators, analytics data is unavailable for those applications that they created on behalf of other users or application developers. 2. To create an application, choose *Create New Application* in the *Applications* section. diff --git a/docs/ISuite/customize-the-visual-format-of-the-api-business-hub-enterprise-2eacd52.md b/docs/ISuite/customize-the-visual-format-of-the-developer-hub-2eacd52.md similarity index 90% rename from docs/ISuite/customize-the-visual-format-of-the-api-business-hub-enterprise-2eacd52.md rename to docs/ISuite/customize-the-visual-format-of-the-developer-hub-2eacd52.md index e6696d9f..204c6998 100644 --- a/docs/ISuite/customize-the-visual-format-of-the-api-business-hub-enterprise-2eacd52.md +++ b/docs/ISuite/customize-the-visual-format-of-the-developer-hub-2eacd52.md @@ -1,8 +1,8 @@ -# Customize the Visual Format of the API business hub enterprise +# Customize the Visual Format of the Developer Hub -As a Site Administrator, you can customize the visual layout of the API business hub enterprise using the Site Editor. The customizations you make using the Site Editor appear to the other users in the system. +As a Site Administrator, you can customize the visual layout of the Developer Hub using the Site Editor. The customizations you make using the Site Editor appear to the other users in the system. @@ -119,5 +119,5 @@ To modify the banner settings, ## Publish Changes -The customizations you've made to the API business hub enterprise layout will be available to the users once you publish the changes. +The customizations you've made to the Developer Hub layout will be available to the users once you publish the changes. diff --git a/docs/ISuite/deploy-the-edge-integration-cell-solution-ab81b84.md b/docs/ISuite/deploy-the-edge-integration-cell-solution-ab81b84.md index 8538f6e7..cd463ca0 100644 --- a/docs/ISuite/deploy-the-edge-integration-cell-solution-ab81b84.md +++ b/docs/ISuite/deploy-the-edge-integration-cell-solution-ab81b84.md @@ -127,18 +127,6 @@ Get to know the steps needed to create the Edge Node as a *Runtime Location* in - - - - - - **Enable Worker based on JDK8** - - - - - By default, the *Worker* component is now based on JDK 17. In cases of compatibility issues, you can also enable the *Worker* component based on JDK 8 as a fallback. - diff --git a/docs/ISuite/developer-hub-41f7c45.md b/docs/ISuite/developer-hub-41f7c45.md new file mode 100644 index 00000000..9e9c8454 --- /dev/null +++ b/docs/ISuite/developer-hub-41f7c45.md @@ -0,0 +1,12 @@ + + +# Developer Hub + +The Developer Hub 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 Developer Hub. This allows you to expose one or more API proxies to application developers. Furthermore, content administrators on theDeveloper Hub 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 Developer Hub 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. + diff --git a/docs/ISuite/diagnostics-80f3050.md b/docs/ISuite/diagnostics-80f3050.md index 47f294a7..d994012c 100644 --- a/docs/ISuite/diagnostics-80f3050.md +++ b/docs/ISuite/diagnostics-80f3050.md @@ -16,7 +16,7 @@ A file system is required in order to use *Diagnostics*. This is because the inf -## Diagnostic Tasks +## Context You can access *Diagnostics* through the *Quick Links* card on the Operations Cockpit. @@ -67,11 +67,22 @@ The type of diagnostic task. It can be any of the following: - *Custom Logging*. Temporarily increase the log level for a list of log locations and collect the required debug information for diagnosing your issue. + To learn more about custom loggers, see [Custom Loggers](custom-loggers-7e52a49.md). + - *Thread Dump*. Use thread dumps to diagnose unequal resource usage that may cause system slowness. You can configure the number of thread dumps to create for a component and specify the intervals between them. -- *Heap Dump* +- *Heap Dump*. Use heap dumps to diagnose issues related to memory consumption. + + > ### Note: + > You can only create a heap dump for one pod per component at a time, as this operation is resource-intensive. + +- *Message Processing Log \(MPL\)*. Diagnose problems related to storage and access to message processing logs. Select one of the following scopes according to your issue: + + - *Create and collect Message Processing Log*. Select if you experience issues with collecting MPL data from workers, aggregation, and storing in the database. + - *Access Message Processing Log*. Select if you experience issues with retrieving MPL from the database. + - *Database Logging*. Select if you require extra information on database operations. > ### Note: - > You can only create a heap dump for one pod per component at a time, as this operation is resource-intensive.. Use heap dumps to diagnose issues related to memory consumption. + > If you're unsure about the correct scope of your issue, you can choose all of them. @@ -128,6 +139,13 @@ Depending on the status of the diagnostic task, you can either *Download* the di +> ### Note: +> In some *Heap Dump* tasks, the *Name* and *Started By* columns indicate that they are automatically generated. This is because the Worker component is configured to automatically create a heap dump when an `OutOfMemory` situation occurs and the Java VM crashes. These heap dumps are then automatically written into the shared file system. + + + +## Procedure + To create a new diagnostic task, perform the following steps: 1. Choose *Create Diagnostic Task* and select the required diagnostic type from the dropdown list. @@ -137,7 +155,7 @@ To create a new diagnostic task, perform the following steps: If you don't stop the session manually, it stops automatically after 10 minutes. -5. . Use heap dumps to diagnose issues related to memoryYou can now download the results of your diagnostic task. The results save as a zip file on your computer. +5. You can now download the results of your diagnostic task. The results save as a zip file on your computer. > ### Note: > In the case of heap dumps, you can't download the results directly from the UI due to the large file size. When you choose *Download*, a popup appears with the path to the file's location on the file share. You can download the results file using your preferred Kubernetes tooling. The corresponding command is the following: `kubectl -n edge-icell cp : ` diff --git a/docs/ISuite/discover-apis-within-integration-suite-from-various-business-systems-0cea56f.md b/docs/ISuite/discover-apis-within-integration-suite-from-various-business-systems-0cea56f.md index 0b59c701..b03fcf4a 100644 --- a/docs/ISuite/discover-apis-within-integration-suite-from-various-business-systems-0cea56f.md +++ b/docs/ISuite/discover-apis-within-integration-suite-from-various-business-systems-0cea56f.md @@ -2,15 +2,15 @@ # Discover APIs within Integration Suite from Various Business Systems -As a content administrator, you can make your APIs available on the API business hub enterprise catalog by discovering and publishing them from various business systems. +As a content administrator, you can make your APIs available on the Developer Hub catalog by discovering and publishing them from various business systems. -## How to discover business systems in API business hub enterprise? +## How to discover business systems in Developer Hub? -To discover the APIs from various business systems in the API business hub enterprise, you first need to ask the *Global Account Administrator* to register these systems in the SAP BTP Cockpit. +To discover the APIs from various business systems in the Developer Hub, you first need to ask the *Global Account Administrator* to register these systems in the SAP BTP Cockpit. The Global Account Administrator organizes SAP systems into groups so that they can be extended in a business scenario at one go. To accomplish this, the administrator creates a formation containing one or more different systems assigned to a common subaccount. For the Integration Suite to recognize these systems, they need to be part of the group. See [Enabling System Landscape for SAP Integration Suite](https://help.sap.com/docs/btp/sap-business-technology-platform/enabling-system-landscape-for-sap-integration-suite) topic for step-by-step instructions on how to register and connect the SAP Integration Suite business system with your global account. diff --git a/docs/ISuite/enable-garbage-collection-logging-52dba20.md b/docs/ISuite/enable-garbage-collection-logging-52dba20.md deleted file mode 100644 index 56d549f1..00000000 --- a/docs/ISuite/enable-garbage-collection-logging-52dba20.md +++ /dev/null @@ -1,30 +0,0 @@ - - - - -# Enable Garbage Collection Logging - -Learn how to enable Garbage Collection \(GC\) logging for worker pods. - - - -## Context - -You can enable GC logging by extending the runtime parameter JAVA\_OPTS. - - - - - -## Procedure - -1. Go to *Runtime Parameters* and select the *Worker* component. - -2. Choose :pencil2: to set a custom value for the JAVA\_OPTS parameter. - -3. Enter the custom value `-Xlog:gc*:file=log/gc.log:time` and choose *Apply*. - - > ### Note: - > Applying changes restarts all worker pods. - - diff --git a/docs/ISuite/establishing-trust-between-sap-cloud-identity-account-and-btp-offerings-7208200.md b/docs/ISuite/establishing-trust-between-sap-cloud-identity-account-and-btp-offerings-7208200.md index a2de6022..b8e2a0f4 100644 --- a/docs/ISuite/establishing-trust-between-sap-cloud-identity-account-and-btp-offerings-7208200.md +++ b/docs/ISuite/establishing-trust-between-sap-cloud-identity-account-and-btp-offerings-7208200.md @@ -37,7 +37,7 @@ To configure and establish trust between SAP Cloud Identity and BTP offerings, f 7. In the *Define from Metadata* tab, click *Browse* and upload the SAML metadata downloaded from Step 2, and then choose *Save*. -8. Navigate to *Assertion Attributes* of the SAML 2.0 configurations, and then provide the mapping between the SAML Assertion values. The developer needs these configurations for onboarding on the API business hub enterprise. +8. Navigate to *Assertion Attributes* of the SAML 2.0 configurations, and then provide the mapping between the SAML Assertion values. The developer needs these configurations for onboarding on the Developer Hub. The following table contains the mapping between the user attribute and the assertion attribute fields: diff --git a/docs/ISuite/establishing-trust-between-sap-hana-cloud-platform-account-and-sap-cloud-identity-c597708.md b/docs/ISuite/establishing-trust-between-sap-hana-cloud-platform-account-and-sap-cloud-identity-c597708.md index a29f3141..1caa9b1a 100644 --- a/docs/ISuite/establishing-trust-between-sap-hana-cloud-platform-account-and-sap-cloud-identity-c597708.md +++ b/docs/ISuite/establishing-trust-between-sap-hana-cloud-platform-account-and-sap-cloud-identity-c597708.md @@ -80,7 +80,7 @@ To configure and establish trust between SAP HANA Cloud Platform and SAP Cloud I -7. Now, you can navigate to the API portal or API business hub enterprise, and login using your SAP Cloud IDP users. +7. Now, you can navigate to the API portal or Developer Hub, and login using your SAP Cloud IDP users. **Related Information** diff --git a/docs/ISuite/images/ABHE_Block_509b298.png b/docs/ISuite/images/ABHE_Block_509b298.png index b95a44a1..b921918f 100644 Binary files a/docs/ISuite/images/ABHE_Block_509b298.png and b/docs/ISuite/images/ABHE_Block_509b298.png differ diff --git a/docs/ISuite/images/ABHE_DEV_Edition_3b25f9f.png b/docs/ISuite/images/ABHE_DEV_Edition_3b25f9f.png index 4d04148e..b7bd2f0f 100644 Binary files a/docs/ISuite/images/ABHE_DEV_Edition_3b25f9f.png and b/docs/ISuite/images/ABHE_DEV_Edition_3b25f9f.png differ diff --git a/docs/ISuite/images/API_Lifecycle_b3ecd4a.png b/docs/ISuite/images/API_Lifecycle_b3ecd4a.png index 7270e3e9..8d226de7 100644 Binary files a/docs/ISuite/images/API_Lifecycle_b3ecd4a.png and b/docs/ISuite/images/API_Lifecycle_b3ecd4a.png 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/EIC-Landscape1_bd52867.png b/docs/ISuite/images/EIC-Landscape1_bd52867.png index 847de2b4..b1e77114 100644 Binary files a/docs/ISuite/images/EIC-Landscape1_bd52867.png and b/docs/ISuite/images/EIC-Landscape1_bd52867.png 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/SAP_Companion_GIF_8122beb.gif b/docs/ISuite/images/SAP_Companion_GIF_8122beb.gif new file mode 100644 index 00000000..3b733699 Binary files /dev/null and b/docs/ISuite/images/SAP_Companion_GIF_8122beb.gif differ diff --git a/docs/ISuite/index.md b/docs/ISuite/index.md index 58bea208..725c52d7 100644 --- a/docs/ISuite/index.md +++ b/docs/ISuite/index.md @@ -8,10 +8,11 @@ - [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) -- [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) - - [Understanding Software Version Numbers](understanding-software-version-numbers-caad468.md) - - [Patch Releases for API Management](patch-releases-for-api-management-6ddd927.md) +- [What's New for SAP Integration Suite](what-s-new-for-sap-integration-suite-79cd682.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) + - [Understanding Software Version Numbers](understanding-software-version-numbers-caad468.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) @@ -72,38 +73,38 @@ - [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) - - [API Business Hub Enterprise](api-business-hub-enterprise-41f7c45.md) - - [Activating API business hub enterprise](activating-api-business-hub-enterprise-a0fb69b.md) - - [User Roles and Responsibilities in API business hub enterprise](user-roles-and-responsibilities-in-api-business-hub-enterprise-54b4607.md) - - [Accessing API business hub enterprise APIs Programmatically](accessing-api-business-hub-enterprise-apis-programmatically-dabee6e.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) + - [Developer Hub](developer-hub-41f7c45.md) + - [Activating Developer Hub](activating-developer-hub-a0fb69b.md) + - [User Roles and Responsibilities in Developer Hub](user-roles-and-responsibilities-in-developer-hub-54b4607.md) + - [Accessing Developer Hub APIs Programmatically](accessing-developer-hub-apis-programmatically-dabee6e.md) + - [Centralized Developer Hub](centralized-developer-hub-38422de.md) + - [Create a Connection Request for the Centralized Developer Hub](create-a-connection-request-for-the-centralized-developer-hub-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) + - [Register on Developer Hub](register-on-developer-hub-c85fafe.md) - [Managing the Access Request of the Users](managing-the-access-request-of-the-users-8b79ee8.md) - [Revoke Access](revoke-access-ce609bb.md) - [Delete Data of Unregistered Users](delete-data-of-unregistered-users-d548233.md) - - [User Roles and Responsibilities in API business hub enterprise](user-roles-and-responsibilities-in-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) + - [User Roles and Responsibilities in Developer Hub](user-roles-and-responsibilities-in-developer-hub-54b4607.md) + - [Customize the Visual Format of the Developer Hub](customize-the-visual-format-of-the-developer-hub-2eacd52.md) - [Manage Domain Categories](manage-domain-categories-bd9691d.md) - [Manage Notifications](manage-notifications-df32457.md) - - [Manage External Content](manage-external-content-f5bd17d.md) + - [Configure the Visibility of Graph Navigator](configure-the-visibility-of-graph-navigator-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) + - [Creating an Application with Developer Hub Administrator Role](creating-an-application-with-developer-hub-administrator-role-df4f777.md) - [Example: Accessing the Custom Attributes of an Application](example-accessing-the-custom-attributes-of-an-application-1cbd94c.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) - - [Manage Content](manage-content-cdf0fab.md) + - [Manage Content](manage-content-4b89a8b.md) - [Discover APIs within Integration Suite from Various Business Systems](discover-apis-within-integration-suite-from-various-business-systems-0cea56f.md) - [Make APIs Available in the Catalog](make-apis-available-in-the-catalog-f148690.md) - [Create Products from Business Systems](create-products-from-business-systems-08aff91.md) @@ -132,9 +133,12 @@ - [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) + - [Webhook Subscriptions](webhook-subscriptions-58e3729.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) + - [Integration Advisor](integration-advisor-3309fe0.md) + - [Overview of SAP Integration Advisor](overview-of-sap-integration-advisor-f99fdaf.md) - [Trading Partner Management](trading-partner-management-28fe3dc.md) - [Understanding the Basic Concepts](understanding-the-basic-concepts-74c068d.md) - [Data Space Integration](data-space-integration-8bb6972.md) @@ -167,7 +171,7 @@ - [Review and Adjust ISA-M Settings](review-and-adjust-isa-m-settings-957de13.md) - [Questionnaires](questionnaires-da3f7d8.md) - [Create a Questionnaire](create-a-questionnaire-4dc1b9c.md) - - [Content Life Cycle](content-life-cycle-06581f4.md) + - [Update Content Maintained by SAP](update-content-maintained-by-sap-06581f4.md) - [Review Integration Technology](review-integration-technology-47439ac.md) - [Define a Business Application](define-a-business-application-0da1b1e.md) - [Define Integration Policies](define-integration-policies-da857e1.md) @@ -192,9 +196,8 @@ - [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) + - [Content-Based Routing](supported-patterns-ad867ae.md#loio3d95082f12ad4020b2157bf8e1e88254) - [Known Limitations](known-limitations-7a552d4.md) - - [Integration Advisor](integration-advisor-3309fe0.md) - - [Overview of SAP Integration Advisor](overview-of-sap-integration-advisor-f99fdaf.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) @@ -250,7 +253,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) - - [Enable Garbage Collection Logging](enable-garbage-collection-logging-52dba20.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) @@ -261,6 +263,7 @@ - [Specifying Service Instance and Service Key Parameters in JSON Format](40-RemoteSystems/specifying-service-instance-and-service-key-parameters-in-json-format-ae419b6.md) - [Service Key Types](40-RemoteSystems/service-key-types-0fc1446.md) - [Managing Service Instances and Service Keys Using an API](40-RemoteSystems/managing-service-instances-and-service-keys-using-an-api-6e5db60.md) + - [Update Service Instance that Contains Deprecated client\_x509 Grant Type](40-RemoteSystems/update-service-instance-that-contains-deprecated-client-x509-grant-type-0a38373.md) - [Setting Up Inbound HTTP Connections \(Integration Flow Processing\)](40-RemoteSystems/setting-up-inbound-http-connections-integration-flow-processing-0f92842.md) - [Client Certificate Authentication for Integration Flow Processing](40-RemoteSystems/client-certificate-authentication-for-integration-flow-processing-7f84d16.md) - [OAuth with Client Credentials Grant for Integration Flow Processing](40-RemoteSystems/oauth-with-client-credentials-grant-for-integration-flow-processing-6c052ce.md) @@ -528,6 +531,7 @@ - [JDBC for SAP HANA Platform \(On-Premise\)](50-Development/jdbc-for-sap-hana-platform-on-premise-ff29388.md) - [JDBC for MariaDB \(On-Premise\)](50-Development/jdbc-for-mariadb-on-premise-1cfb512.md) - [JDBC for MariaDB \(Cloud\)](50-Development/jdbc-for-mariadb-cloud-1d320d6.md) + - [Jira Receiver Adapter](50-Development/jira-receiver-adapter-d15b560.md) - [JMS Adapter](50-Development/jms-adapter-0993f2a.md) - [Configure the JMS Sender Adapter](50-Development/configure-the-jms-sender-adapter-161791b.md) - [Configure the JMS Receiver Adapter](50-Development/configure-the-jms-receiver-adapter-79edc04.md) @@ -1226,7 +1230,7 @@ - [Mutations](50-Development/mutations-499950b.md) - [Developer Reference](50-Development/developer-reference-74668b7.md) - [Graph Syntax Diagrams](50-Development/graph-syntax-diagrams-86101be.md) - - [Graph Navigator in API business hub enterprise](50-Development/graph-navigator-in-api-business-hub-enterprise-8e75d31.md) + - [Graph Navigator in Developer Hub](50-Development/graph-navigator-in-developer-hub-8e75d31.md) - [Security](50-Development/security-7a9198c.md) - [Data Protection and Privacy for Graph](50-Development/data-protection-and-privacy-for-graph-9b09c0e.md) - [B2B Scenarios](50-Development/b2b-scenarios-c55eb4d.md) @@ -1255,7 +1259,11 @@ - [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) + - [Trading Partner Agreement](50-Development/trading-partner-agreement-9bd43c9.md) + - [Creating Agreement - Outdated Format](50-Development/creating-agreement-outdated-format-5701ddc.md) + - [Creating Agreement - Latest Format](50-Development/creating-agreement-latest-format-72679dd.md) + - [Adding Activity Parameters](50-Development/adding-activity-parameters-655a594.md) + - [Adding Custom Search Attributes](50-Development/adding-custom-search-attributes-934bbcd.md) - [Understanding Identifiers in Agreement](50-Development/understanding-identifiers-in-agreement-783e935.md) - [Define Mapping between Group Identifiers](50-Development/define-mapping-between-group-identifiers-047f4eb.md) - [Migrating an Agreement](50-Development/migrating-an-agreement-bdcf534.md) @@ -1310,6 +1318,7 @@ - [Deleting a Message Implementation Guideline](50-Development/deleting-a-message-implementation-guideline-6949c3f.md) - [Mapping Guidelines \(MAGs\)](50-Development/mapping-guidelines-mags-42124f4.md) - [Creating a New Mapping Guideline](50-Development/creating-a-new-mapping-guideline-a42920e.md) + - [Global Code Value Mapping](50-Development/global-code-value-mapping-fd1d3ff.md) - [Working with a Mapping Guideline \(MAG\)](50-Development/working-with-a-mapping-guideline-mag-0803ca6.md) - [Pretransformation of a Message Implementation Guideline](50-Development/pretransformation-of-a-message-implementation-guideline-b287e5e.md) - [Mapping the Source and Target Nodes](50-Development/mapping-the-source-and-target-nodes-9ea58d6.md) @@ -1330,10 +1339,11 @@ - [Importing MIG/MAG](50-Development/importing-mig-mag-7139aad.md) - [Exporting MIG/MAG](50-Development/exporting-mig-mag-c8bba26.md) - [Exporting Documentation](50-Development/exporting-documentation-f7dbd2d.md) + - [Runtime Artifacts](50-Development/runtime-artifacts-d016138.md) + - [Consuming Artifacts in Integration Flows](50-Development/consuming-artifacts-in-integration-flows-a33a6c6.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) + - [Inject Mapping Artifacts to SAP Cloud Integration](50-Development/inject-mapping-artifacts-to-sap-cloud-integration-47ad97e.md) + - [Creating OAuth Client Credentials for Cloud Foundry Environment](50-Development/creating-oauth-client-credentials-for-cloud-foundry-environment-50b63c6.md) - [Data Spaces - Providing Assets, Policies, and Contract Definitions](50-Development/data-spaces-providing-assets-policies-and-contract-definitions-079b342.md) - [Working with Assets](50-Development/working-with-assets-fa84319.md) - [Creating Assets](50-Development/creating-assets-5e051be.md) @@ -1517,6 +1527,8 @@ - [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) + - [Create a Webhook Subscription](50-Development/create-a-webhook-subscription-e120b8b.md) + - [Handshake and Its Status](50-Development/handshake-and-its-status-a65d213.md) - [Publish and Consume Events](50-Development/publish-and-consume-events-8e296d9.md) - [Configure in Data Spaces](50-Development/configure-in-data-spaces-7b65115.md) - [Create and Edit Company Policies](50-Development/create-and-edit-company-policies-51fa547.md) @@ -1607,6 +1619,14 @@ - [JMS Resource Limits and Optimizing their Usage](50-Development/jms-resource-limits-and-optimizing-their-usage-4857054.md) - [JMS Resource Limits for Edge Integration Cell](50-Development/jms-resource-limits-for-edge-integration-cell-17366b3.md) - [Managing Number Ranges](50-Development/managing-number-ranges-b6e17fa.md) + - [Managing Partner Directory Entries](50-Development/managing-partner-directory-entries-3d6eee7.md) + - [Partner Directory Entity Types](50-Development/partner-directory-entity-types-950f4b2.md) + - [Add Partner](50-Development/add-partner-414b97d.md) + - [Delete Partner](50-Development/delete-partner-83a9bfd.md) + - [Create Partner Directory Entity](50-Development/create-partner-directory-entity-f41418f.md) + - [Edit Partner Entity](50-Development/edit-partner-entity-858af76.md) + - [Copy Partner Entity](50-Development/copy-partner-entity-d110a04.md) + - [Delete Partner Entity](50-Development/delete-partner-entity-25aed52.md) - [Access Logs](50-Development/access-logs-c1649cd.md) - [Monitoring System Log Files](50-Development/monitoring-system-log-files-4002376.md) - [External Logging](50-Development/external-logging-ad719c1.md) @@ -1679,9 +1699,9 @@ - [Delete a Rate Plan](50-Development/delete-a-rate-plan-af1a2a6.md) - [Billing Service](50-Development/billing-service-a4e2fb8.md) - [View Bill Details in the SAP Integration Suite](50-Development/view-bill-details-in-the-sap-integration-suite-dafe588.md) - - [View Bill Details in the API business hub enterprise](50-Development/view-bill-details-in-the-api-business-hub-enterprise-8f77615.md) + - [View Bill Details in the Developer Hub](50-Development/view-bill-details-in-the-developer-hub-8f77615.md) - [Download Bill Details from SAP Integration Suite](50-Development/download-bill-details-from-sap-integration-suite-77f512c.md) - - [Download Bill Details from API business hub enterprise](50-Development/download-bill-details-from-api-business-hub-enterprise-ceea2da.md) + - [Download Bill Details from Developer Hub](50-Development/download-bill-details-from-developer-hub-ceea2da.md) - [Create or Update or Read an Application using Subscription key](50-Development/create-or-update-or-read-an-application-using-subscription-key-4409614.md) - [Settings](50-Development/settings-9e64d05.md) - [Configuring Integration Settings](50-Development/IntegrationSettings/configuring-integration-settings-98091f7.md) @@ -1735,7 +1755,7 @@ - [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) + - [Service to View User Details on Developer Hub](60-Security/service-to-view-user-details-on-developer-hub-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) @@ -1753,6 +1773,7 @@ - [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) + - [Auditing and Logging Information for Data Space Integration](60-Security/auditing-and-logging-information-for-data-space-integration-5e2d650.md) - [Adapters Authentication Methods](60-Security/adapters-authentication-methods-9f7cf82.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) @@ -1780,7 +1801,6 @@ - [Fix Edge Local Authentication and Authorization Issues](fix-edge-local-authentication-and-authorization-issues-4cddfbe.md) - [Fix Keystore Synchronization Issues](fix-keystore-synchronization-issues-1e7489f.md) - [Troubleshooting for Data Space Integration](troubleshooting-for-data-space-integration-166fa88.md) -- [Support](70-Support/support-6abc874.md) - [Accessibility Features in SAP Integration Suite](accessibility-features-in-sap-integration-suite-e3e04a8.md) - [Accessibility Features in SAP Trading Partner Management](accessibility-features-in-sap-trading-partner-management-c17213a.md) - [Accessibility Features in Integration Assessment](accessibility-features-in-integration-assessment-ad9ad4b.md) diff --git a/docs/ISuite/initial-setup-17ab4a2.md b/docs/ISuite/initial-setup-17ab4a2.md index 1f6bcc2d..ab41f141 100644 --- a/docs/ISuite/initial-setup-17ab4a2.md +++ b/docs/ISuite/initial-setup-17ab4a2.md @@ -68,13 +68,13 @@ Your global account administrator is responsible for configuring the Graph entit 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 API business hub enterprise** + 1. **Enable Developer Hub** 2. *Graph* > ### Note: - > If you have already set up API Management, choose *Edit*, and select *Graph*. You must select **Enable API business hub enterprise** to activate *Graph*. + > If you have already set up API Management, choose *Edit*, and select *Graph*. You must select **Enable Developer Hub** to activate *Graph*. 4. Choose *Activate* and once the status on the *Summary* changes from *In Progress* to *Active*, choose *OK*. @@ -118,7 +118,7 @@ Once you enable Graph, you see all of the Graph role collections in your list. - Graph Navigator Viewer - Graph Navigator is a tool in API business hub enterprise that developers use to inspect business data graphs. For more information, see [Graph Navigator in API business hub enterprise](50-Development/graph-navigator-in-api-business-hub-enterprise-8e75d31.md). + Graph Navigator is a tool in Developer Hub that developers use to inspect business data graphs. For more information, see [Graph Navigator in Developer Hub](50-Development/graph-navigator-in-developer-hub-8e75d31.md). To assign the *GraphNavigator.Viewer* role collection to a user with the *Graph\_Navigator\_Viewer* role, do the following: diff --git a/docs/ISuite/job-management-4146fa5.md b/docs/ISuite/job-management-4146fa5.md index cd336d32..ba42b005 100644 --- a/docs/ISuite/job-management-4146fa5.md +++ b/docs/ISuite/job-management-4146fa5.md @@ -4,18 +4,27 @@ # Job Management -Organize and schedule your existing system jobs, such as data store entries cleanup or trace entries cleanup, or add jobs manually. +Organize and schedule your existing system jobs, and add new jobs manually. -Per default, this screen shows three scheduled jobs related to the system. These are defined as *Actions*: -- *Cleanup Data Store Entries* -- *Cleanup Monitoring Data* + -- *Cleanup Trace Entries* +## Context +You can perform the following types of jobs, also refereed to as *Actions*: -For each of the jobs, the following information is available: +- *Cleanup Data Store Entries*. Delete data store entries that have reached the retention time. + +- *Cleanup Monitoring Data*. Clean up monitoring data by deleting message processing log \(MPL\) data for messages in their final state. You can also delete the aggregated data of tenants if the creation date is within the specified number of days from the command's execution date. + +- *Cleanup Trace Entries*. Delete trace messages that have reached the retention time. + +- *Cleanup Diagnostic Data*. Delete manually created diagnostic tasks and automatically generated heap dumps. This job also deletes empty working directories that were created by the Worker component on the shared file system but are no longer in use. + +Per default, *Cleanup Data Store Entries*, *Cleanup Monitoring Data*, and *Cleanup Trace Entries* are scheduled during the installation time. However, you must schedule *Cleanup Diagnostic Data* manually. + +The overview screen shows a list of all your existing jobs. For each of the jobs, the following information is available: **Table Overview** @@ -29,7 +38,7 @@ Parameter -Information +Description @@ -41,7 +50,7 @@ Information -Name of the system job. +The name of the system job. @@ -55,7 +64,10 @@ Name of the system job. Information on which user last edited the job. -Per default, `SYSTEM_USER` is set. +> ### Note: +> `SYSTEM_USER` is the default user for the jobs scheduled at installation. + + @@ -67,7 +79,7 @@ Per default, `SYSTEM_USER` is set. -Information on when this job was last edited. The format specifies date and time down to minutes. +Information on when this job was last edited. The format specifies the date and time down to minutes. @@ -104,7 +116,7 @@ Information on whether or not this job has run successfully. -Information on when this job was last executed. The format specifies date and time down to minutes. +Information on when this job was last executed. The format specifies the date and time down to minutes. @@ -116,130 +128,152 @@ Information on when this job was last executed. The format specifies date and ti -Information on when this job is to be executed next. The format specifies date and time down to minutes. The date is calculated based on defined schedule settings. +Information on when this job is to be executed next. The format specifies the date and time down to minutes. The date is calculated based on defined schedule settings. -For more information, for instance on the schedule pattern for each job, select one of the jobs from the list by clicking on it. A details view opens. Select *Delete* to delete an existing job. Select *Edit* to make changes to an existing job. Depending on the job, *Parameters* and / or *Schedule* can be edited. The general information, such as *Name* and *Actions*, that is, the type of job, can't be edited. +For more information on the parameters and schedule pattern for each job, select one job from the list and the details view opens. You can choose **Delete** to delete an existing job and **Edit** to make changes to an existing job. -Enter the following information for *Parameters*: +> ### Note: +> Depending on the job, you can edit **Parameters** and/or **Schedule**. The general information, such as **Name** and **Actions**, can't be changed. + + + + -**Parameters** +## Procedure + +To add a new job, select :heavy_plus_sign: \(Add\). Depending on the **Action** you select, you need to define different parameters: - + - -
+ -Only available for *Cleanup Monitoring Data* +*Action* - - + + -- *Delete COMPLETED Message Processing Log Data Older Than \(Days\)*: Enter a number representing days. -- *Delete Monitoring Data Older Than \(Days\)*\(mandatory\): Enter a number representing days. The default is set to `30`. +*Parameters* + +*Description* - +
-Only available for *Cleanup Trace Entries* +*Cleanup Monitoring Data* -*Delete Data Trace From Trace Table Older than \(Minutes\)*: Enter a number representing minutes. The default is set to `60`. +- *Delete Processing Log Data for Completed Messages Older Than \(Days\)* +- *Delete Monitoring Data Older Than \(Days\)* -
-Enter the following information for *Schedule*: -**Schedule** + + +Enter the number of days. - + + + + + + + + + - -
-*Select Schedule* +*Cleanup Trace Entries* -The following options are available: +*Delete Trace Data Older Than \(Minutes\)* -- Daily + -- Monthly on Day +Enter the number of days. The default is set to `60`. -- Weekly +
-- On Date +*Cleanup Data Store Entries* + +No parameters. + + + 
-*Schedule Type* +*Cleanup Diagnostic Data* -The following options are available: - -- Fixed Time - -- Recurrence - +*Delete Data Older Than \(Days\)* : + +Enter the number of days. The default is set to `30`.
+
-*Every* +Enter the following information for *Schedule*: -\(only available if for *Schedule Time* *Recurrence* is set\) +**Schedule** - - -The following options are available: + + + + + + + + -
-- 1 min +Parameter -- 5 min + -- 10 min +Description -- 15 min +
-- 20 min +*Select Schedule* -- 30 min + -- 1 h +The following options are available: -- 2 h +- Daily -- 4 h +- Monthly on Day -- 6 h +- Weekly -- 12 h +- On Date @@ -249,70 +283,61 @@ The following options are available:
-*Between* - -\(only available if for *Schedule Time* *Recurrence* is set\) +*Schedule Type* -Specify the hours in which this job is to run between `00:00` and `24:00`. +The following options are available: + +- Fixed Time. The job executes at the specific time you select. + +- Recurrence. The job executes regularly at the time interval you select. + + +
-*Schedule Time* +*Every* -\(only available if for *Schedule Time* *Once* is set\) +\(only available if *Schedule Type* *Recurrence* is set\) -Define the time when the job is supposed to run. +Select a time period.
- -Depending on your use cases, you can add or delete jobs. To add an additional job, select :heavy_plus_sign: \(Add\). In *Create Job*, enter the following details. - - - @@ -323,5 +348,5 @@ Choose between: [Operations Cockpit](operations-cockpit-ec0fc95.md "The Operations Cockpit is the central control point for operating edge integration cells and allows the Edge Integration Cell administrator to monitor and adjust system configurations and resources.") -[Component Monitor](component-monitor-49f487e.md "Get information on the components.") +[Component Monitor](component-monitor-49f487e.md "Get information on your components.") diff --git a/docs/ISuite/known-limitations-7a552d4.md b/docs/ISuite/known-limitations-7a552d4.md index 1f4eeab5..ef7482b1 100644 --- a/docs/ISuite/known-limitations-7a552d4.md +++ b/docs/ISuite/known-limitations-7a552d4.md @@ -28,7 +28,7 @@ Message Mapping diff --git a/docs/ISuite/limits-in-api-management-f70f425.md b/docs/ISuite/limits-in-api-management-f70f425.md index 4d3765bd..1780c29a 100644 --- a/docs/ISuite/limits-in-api-management-f70f425.md +++ b/docs/ISuite/limits-in-api-management-f70f425.md @@ -89,7 +89,7 @@ Maximum number of resources that can be attached to an API proxy > ### Note: > By selectively choosing resources, we mean avoiding the attempt to select specific resources from the *Add API* dialog while adding an API proxy to a product on the *Create Product* page. -- If you are using API business hub enterprise OData APIs to retrieve resources from an API proxy, please note that the retrieved result may not include all the resources available in the API proxy. +- If you are using Developer Hub OData APIs to retrieve resources from an API proxy, please note that the retrieved result may not include all the resources available in the API proxy. diff --git a/docs/ISuite/make-apis-available-in-the-catalog-f148690.md b/docs/ISuite/make-apis-available-in-the-catalog-f148690.md index 145db4e9..f9159b5d 100644 --- a/docs/ISuite/make-apis-available-in-the-catalog-f148690.md +++ b/docs/ISuite/make-apis-available-in-the-catalog-f148690.md @@ -2,9 +2,9 @@ # Make APIs Available in the Catalog -As a content administrator, make your APIs available to developers in your organization by publishing them on API business hub enterprise. +As a content administrator, make your APIs available to developers in your organization by publishing them on Developer Hub. -The API business hub enterprise catalog acts as a centralized repository where content administrators can showcase their APIs, and provide corresponding API documentation. +The Developer Hub catalog acts as a centralized repository where content administrators can showcase their APIs, and provide corresponding API documentation. To effectively publish an API, it is crucial to understand how to bundle them together and present them as a cohesive product. A product is essentially a collection of APIs, which includes metadata specific to your business for monitoring or analytics. For instance, you can bundle all CRM-related APIs into a CRM product. Once the required API are included in a product, it can be published to the catalog, allowing application developers to browse through and access it. diff --git a/docs/ISuite/manage-content-4b89a8b.md b/docs/ISuite/manage-content-4b89a8b.md new file mode 100644 index 00000000..865e72d7 --- /dev/null +++ b/docs/ISuite/manage-content-4b89a8b.md @@ -0,0 +1,17 @@ + + +# Manage Content + +As a content administrator, you can create products that includes APIs from different business systems and manage the content that application developers can view on the catalog. + +To illustrate the benefits of this feature, let's consider an example. Imagine you work for XYZ company and you are tasked with building an application. To accomplish this, you need to utilize APIs such as the sales order or CRM APIs from S4HANA, payroll APIs from SuccessFactors, and marketing solution APIs from SAP Marketing Cloud. Using this feature you can enhance the extensibility of these APIs and leverage them to build your application and address any challenges you encounter. + +![](images/ABHE_DEV_Edition_3b25f9f.png) + +The block diagram illustrates the process of adding and registering business systems in the System Landscape within Business Technology Platform \(BTP\). Once a business system is added and registered, it can be found in the Developer Hub. To discover the APIs within these systems, the content admin creates products and publishes them, making the products visible in the catalog. They can incorporate pertinent API documentation and ensure that this catalog is readily available to developers. Once they appear in the catalog, developers can explore and utilize these APIs to develop applications. + +To achieve these objectives, your *Global Account Administrator* needs to register these systems in your system landscape. This action establishes a connection between the SAP system and SAP BTP. Following system registration, these systems appear on the *Manage Content* page in Developer Hub. For more information, see [Discover APIs within Integration Suite from Various Business Systems](discover-apis-within-integration-suite-from-various-business-systems-0cea56f.md). + +> ### Note: +> At present, you can only register and add S/4 HANA Cloud business systems. + diff --git a/docs/ISuite/manage-content-cdf0fab.md b/docs/ISuite/manage-content-cdf0fab.md deleted file mode 100644 index f9ae6e84..00000000 --- a/docs/ISuite/manage-content-cdf0fab.md +++ /dev/null @@ -1,28 +0,0 @@ - - -# Manage Content - -As a content administrator, you can create products that includes APIs from different business systems and manage the content that application developers can view on the catalog. - -To illustrate the benefits of this feature, let's consider an example. Imagine you work for XYZ company and you are tasked with building an application. To accomplish this, you need to utilize APIs such as the sales order or CRM APIs from S4HANA, payroll APIs from SuccessFactors, and marketing solution APIs from SAP Marketing Cloud. Using this feature you can enhance the extensibility of these APIs and leverage them to build your application and address any challenges you encounter. - -![](images/ABHE_DEV_Edition_3b25f9f.png) - -The block diagram illustrates the process of adding and registering business systems in the System Landscape within Business Technology Platform \(BTP\). Once a business system is added and registered, it can be found in the API business hub enterprise. To discover the APIs within these systems, the content admin creates products and publishes them, making the products visible in the catalog. They can incorporate pertinent API documentation and ensure that this catalog is readily available to developers. Once they appear in the catalog, developers can explore and utilize these APIs to develop applications. - -To achieve these objectives, your *Global Account Administrator* needs to register these systems in your system landscape. This action establishes a connection between the SAP system and SAP BTP. Following system registration, these systems appear on the *Manage Content* page in API business hub enterprise. For more information, see [Discover APIs within Integration Suite from Various Business Systems](discover-apis-within-integration-suite-from-various-business-systems-0cea56f.md). - -> ### Note: -> At present, you can only register and add S/4 HANA Cloud business systems. - -**Related Information** - - -[Discover APIs within Integration Suite from Various Business Systems](discover-apis-within-integration-suite-from-various-business-systems-0cea56f.md "As a content administrator, you can make your APIs available on the API business hub enterprise catalog by discovering and publishing them from various business systems.") - -[Make APIs Available in the Catalog](make-apis-available-in-the-catalog-f148690.md "As a content administrator, make your APIs available to developers in your organization by publishing them on API business hub enterprise.") - -[Manage Products](manage-products-4dd3d90.md "As a content administrator, you have the ability to manage a product once it has been created.") - -[Manage Scheduled Requests](manage-scheduled-requests-7236981.md "Monitor and manage all requests for product creation and updates.") - diff --git a/docs/ISuite/manage-developer-access-9df3ece.md b/docs/ISuite/manage-developer-access-9df3ece.md index 432286a2..5b68ba83 100644 --- a/docs/ISuite/manage-developer-access-9df3ece.md +++ b/docs/ISuite/manage-developer-access-9df3ece.md @@ -2,7 +2,7 @@ # 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. +As an Developer Hub 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 Developer Hub. @@ -18,7 +18,7 @@ You need the following role to configure the access control checks: > ### Note: -> The **Manage Access** feature is available only in the new design of the API business hub enterprise on the Cloud Foundry environment. +> The **Manage Access** feature is available only in the new design of the Developer Hub on the Cloud Foundry environment. @@ -26,19 +26,19 @@ You need the following role to configure the access control checks: ## Context -In API business hub enterprise, managing access for different users is important for several reasons like improving user productivity, resource optimization, privacy, and security. +In Developer Hub, managing access for different users is important for several reasons like improving user productivity, resource optimization, privacy, and security. User productivity is enhanced by granting users the appropriate access to carry out their tasks efficiently, without being overwhelmed by unnecessary information or resources. In this context, the **All Visitors** option allows anyone, whether logged in or not, to utilize the APIs without requiring authentication. However, the ability to consume the APIs still depends on obtaining the necessary developer role. -Moreover, by managing access, you can provide access to **Authenticated Users** who do not have a designated role, allowing them to access different pages of the API business hub enterprise based on their specific needs. This facilitates broader exploration and enables users to familiarize themselves with the available resources. Nevertheless, the ability to consume the APIs still relies on obtaining the necessary developer role. +Moreover, by managing access, you can provide access to **Authenticated Users** who do not have a designated role, allowing them to access different pages of the Developer Hub based on their specific needs. This facilitates broader exploration and enables users to familiarize themselves with the available resources. Nevertheless, the ability to consume the APIs still relies on obtaining the necessary developer role. To maintain privacy and security, you can grant access to**Authorized Users** who are logged in and possess the required developer role. This ensures that only authorized individuals can seamlessly access and consume the APIs while upholding privacy and security measures. > ### Note: -> Access to the API business hub enterprise content using the API access plan is not affected by these permissions. +> Access to the Developer Hub content using the API access plan is not affected by these permissions. > ### Note: -> As an administrator of API business hub enterprise, please note that when you update these permissions, it may take up to 5 minutes for the changes to be applied for other users of the API business hub enterprise. +> As an administrator of Developer Hub, please note that when you update these permissions, it may take up to 5 minutes for the changes to be applied for other users of the Developer Hub. @@ -46,9 +46,9 @@ To maintain privacy and security, you can grant access to**Authorized Users** wh ## Procedure -1. Log on to the **API business hub enterprise**. +1. Log on to the **Developer Hub**. -2. Choose *Enterprise Manager* \> *Manage Access* from the top navigation bar. +2. Choose *Admin Center* \> *Manage Access* from the top navigation bar. ![](images/Manage_Access_SUI_492ece2.png) @@ -56,13 +56,13 @@ To maintain privacy and security, you can grant access to**Authorized Users** wh Select the appropriate permission from the following list: - - *Authorised Users*: These are the users who are registered as application developers or have the privilege of the application developer assigned through the SAP BTP cockpit. They can search, discover, and consume the contents of this API business hub enterprise application. + - *Authorised Users*: These are the users who are registered as application developers or have the privilege of the application developer assigned through the SAP BTP cockpit. They can search, discover, and consume the contents of this Developer Hub application. > ### Note: > By default, the option for *Authorised Users* is selected. However, you have the flexibility to change it to either *All Visitors* or *Authenticated Users*, depending on your specific requirements. - - *Authenticated Users*: These users are not registered as application developers but are successfully authenticated by the API business hub enterprise application and can access the following pages: + - *Authenticated Users*: These users are not registered as application developers but are successfully authenticated by the Developer Hub application and can access the following pages: - Home @@ -73,7 +73,7 @@ To maintain privacy and security, you can grant access to**Authorized Users** wh Optionally, you can select the *API Details* checkbox to provide access to the *API Details* page as well. - - *All Visitors*: These are the users who can visit the following pages even before they are authenticated by the API business hub enterprise application, that is without logging in to the API business hub enterprise application: + - *All Visitors*: These are the users who can visit the following pages even before they are authenticated by the Developer Hub application, that is without logging in to the Developer Hub application: - Home diff --git a/docs/ISuite/manage-domain-categories-bd9691d.md b/docs/ISuite/manage-domain-categories-bd9691d.md index 1ef3152e..720b9ff7 100644 --- a/docs/ISuite/manage-domain-categories-bd9691d.md +++ b/docs/ISuite/manage-domain-categories-bd9691d.md @@ -4,7 +4,7 @@ # Manage Domain Categories -Domain categories are displayed on the API business hub enterprise home page. +Domain categories are displayed on the Developer Hub home page. @@ -32,7 +32,7 @@ You need the following roles to create and update categories: Content administrators can use *Manage Content* to create domain categories and add the related products into relevant categories. They can also configure the order in which these categories and the contained products get displayed in the home page. > ### 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. +> If you've configured the Developer Hub 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. Use the following procedure to configure navigation categories. @@ -42,9 +42,9 @@ Use the following procedure to configure navigation categories. ## Procedure -1. Log on to the **API business hub enterprise**. +1. Log on to the **Developer Hub**. -2. Choose *Enterprise Manager* \> *Manage Domain Categories* from the top navigation bar. +2. Choose *Admin Center* \> *Manage Domain Categories* from the top navigation bar. 3. To add a category, choose *Add New Domain Category*. diff --git a/docs/ISuite/manage-notifications-df32457.md b/docs/ISuite/manage-notifications-df32457.md index 2909fd14..f834f322 100644 --- a/docs/ISuite/manage-notifications-df32457.md +++ b/docs/ISuite/manage-notifications-df32457.md @@ -4,7 +4,7 @@ # 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. +As a site administrator you can configure notifications for providing information to the Developer Hub end users on any website updates, events or news items. @@ -20,9 +20,9 @@ You’re assigned the *AuthGroup.Site.Admin* role. To assign the role, see [Mana ## Procedure -1. Log on to the API business hub enterprise. +1. Log on to the Developer Hub. -2. Choose *Enterprise Manager* \> *Notifications* from the top navigation bar. +2. Choose *Admin Center* \> *Notifications* from the top navigation bar. 3. Choose *Add Notification*. @@ -40,7 +40,7 @@ You’re assigned the *AuthGroup.Site.Admin* role. To assign the role, see [Mana Enter a name for the notification entity. - **Example**: Experience the new design of the API business hub enterprise! + **Example**: Experience the new design of the Developer Hub! @@ -54,7 +54,7 @@ You’re assigned the *AuthGroup.Site.Admin* role. To assign the role, see [Mana Enter a description for the notification entity. - **Example**: If you’ve subscribed to API business hub enterprise as part of Integration Suite subscription , we now have a new design of the user interface for you to experience. + **Example**: If you’ve subscribed to Developer Hub as part of Integration Suite subscription , we now have a new design of the user interface for you to experience. diff --git a/docs/ISuite/managing-the-access-request-of-the-users-8b79ee8.md b/docs/ISuite/managing-the-access-request-of-the-users-8b79ee8.md index ab0926a5..0e9cbbcb 100644 --- a/docs/ISuite/managing-the-access-request-of-the-users-8b79ee8.md +++ b/docs/ISuite/managing-the-access-request-of-the-users-8b79ee8.md @@ -2,7 +2,7 @@ # Managing the Access Request of the Users -As an API administrator, you can approve or reject the access request made by an application developer to use the API business hub enterprise. +As an API administrator, you can approve or reject the access request made by an application developer to use the Developer Hub. @@ -18,11 +18,11 @@ You’re assigned the *AuthGroup.API.Admin* role. ## Procedure -1. Log on to the **API business hub enterprise**. +1. Log on to the **Developer Hub**. Use the *Manage Users* page to approve or reject the developer's registration requests and manage the roles of the registered users. For assigning roles to the users, use the SAP BTP Cockpit. -2. Choose *Enterprise Manager* \> *Manage Users* \> *E-mail Configuration* and add the administrator’s email in the *E-mail Configuration* textbox. +2. Choose *Admin Center* \> *Manage Users* \> *E-mail Configuration* and add the administrator’s email in the *E-mail Configuration* textbox. The administrator receives email notification of the pending developer registration requests on this email id. Also, the e-mail notifications to the developers or users are sent from this e-mail id. @@ -31,7 +31,7 @@ You’re assigned the *AuthGroup.API.Admin* role. 3. To view the pending requests, navigate to *Manage Users* \> *New Requests*. -4. Look for the request and choose *Accept Request* from the *Actions* coulmn. The application developer can now access the API business hub enterprise. +4. Look for the request and choose *Accept Request* from the *Actions* coulmn. The application developer can now access the Developer Hub. > ### Note: > The user will be added to all the IDPs configured in the sub-account, along with the *ApplicationDeveloper* role. @@ -47,7 +47,7 @@ You’re assigned the *AuthGroup.API.Admin* role. - Register a new user by choosing *Add User*. > ### Note: - > A user must be onboarded to API business hub enterprise only via Self-registration or **Add User** flow. + > A user must be onboarded to Developer Hub only via Self-registration or **Add User** flow. In the *Add User* dialog: @@ -77,7 +77,7 @@ You’re assigned the *AuthGroup.API.Admin* role. @@ -89,7 +89,7 @@ You’re assigned the *AuthGroup.API.Admin* role. @@ -101,7 +101,7 @@ You’re assigned the *AuthGroup.API.Admin* role. @@ -113,7 +113,7 @@ You’re assigned the *AuthGroup.API.Admin* role. diff --git a/docs/ISuite/onboard-an-application-developer-786d107.md b/docs/ISuite/onboard-an-application-developer-786d107.md index 0bae3248..c0bed631 100644 --- a/docs/ISuite/onboard-an-application-developer-786d107.md +++ b/docs/ISuite/onboard-an-application-developer-786d107.md @@ -2,23 +2,23 @@ # Onboard an Application Developer -Explains how API administrators can onboard application developers so they can access the API business hub enterprise. +Explains how API administrators can onboard application developers so they can access the Developer Hub. ## Context -A user must be onboarded to API business hub enterprise only via Self-registration or **Add User** flow. +A user must be onboarded to Developer Hub only via Self-registration or **Add User** flow. -To provide application developers with access to the API business hub enterprise, the API Administrator first has to onboard them. The steps to onboard an application developer are as follows: +To provide application developers with access to the Developer Hub, the API Administrator first has to onboard them. The steps to onboard an application developer are as follows: ## Procedure -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). +1. The application developers log on to the Developer Hub application with their IDP user credentials, and register to the Developer Hub. For more information, see [Register on Developer Hub](register-on-developer-hub-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](managing-the-access-request-of-the-users-8b79ee8.md). +2. The API administrator approves or rejects the request to access the Developer Hub. For more information, see [Managing the Access Request of the Users](managing-the-access-request-of-the-users-8b79ee8.md). If you haven’t enabled the automatic creation of shadow users, and you've not explicitly created shadow users for your developers, then they’re unable to log on to the application, and they’re asked to contact the administrator. For more information, see [Shadow Users](https://help.sap.com/viewer/38c3df3f8da44a809f937220b3579607/Cloud/en-US/a0f5fe580ed846ca95f8601678509add.html "Whenever a user authenticates at an application in your subaccount using any identity provider, it’s essential that user-related data provided by the identity provider is stored in the form of shadow users.") :arrow_upper_right: diff --git a/docs/ISuite/operating-edge-integration-cell-2af17b8.md b/docs/ISuite/operating-edge-integration-cell-2af17b8.md index 9f67584a..9896a9a0 100644 --- a/docs/ISuite/operating-edge-integration-cell-2af17b8.md +++ b/docs/ISuite/operating-edge-integration-cell-2af17b8.md @@ -24,5 +24,5 @@ You can operate Edge Integration Cells from the Operations Cockpit, where you ca [Execute Integration Flows with Proxies](execute-integration-flows-with-proxies-e9515b5.md "Execute integration flows that include manual proxy configuration.") -[Enable Garbage Collection Logging](enable-garbage-collection-logging-52dba20.md "Learn how to enable Garbage Collection (GC) logging for worker pods.") + diff --git a/docs/ISuite/other-issues-e6755e1.md b/docs/ISuite/other-issues-e6755e1.md index 70cf910c..28a57a69 100644 --- a/docs/ISuite/other-issues-e6755e1.md +++ b/docs/ISuite/other-issues-e6755e1.md @@ -38,11 +38,7 @@ If yes, please make sure that you have: - Subscribed to Content Agent \(plan: free\). See [Subscribe to Content Agent User Interface](https://help.sap.com/docs/content-agent-service/user-guide/subscribe-to-content-agent-service?version=Cloud). 2. Destination Subaccount \(Example: TMS\_Destination\) - - Subscribed to API Management \(plan: default\). See: - - Integration Suite: [Activate and Configure API Management Capability](https://help.sap.com/docs/integration-suite/sap-integration-suite/enabling-api-management-capability-from-integration-suite?version=CLOUD). - - Standalone: [Setting Up API Portal Application Using API Management Standalone Tile](https://help.sap.com/docs/sap-api-management/sap-api-management/setting-up-api-portal-application-using-api-management-standalone-tile?version=Cloud). + - Standalone: [Setting Up API Portal Application Using API Management Standalone Tile](https://help.sap.com/docs/sap-api-management/sap-api-management/setting-up-api-portal-application-using-api-management-standalone-tile?version=Cloud). - Subscribed to Content Agent \(plan: free\). See [Subscribe to Content Agent User Interface](https://help.sap.com/docs/content-agent-service/user-guide/subscribe-to-content-agent-service?version=Cloud). 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..031e1325 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 @@ -106,6 +106,8 @@ Migration Assessment Edge Integration Cell +Data Space Integration + + + + + + + + + @@ -70,7 +70,7 @@ Use this role to access the API portal in read-only mode. You can view all APIs,
-*Name* +*Between* + +\(only available if *Schedule Type* *Recurrence* is set\) -Enter a unique name. +Specify the hours in which this job is to run between `00:00` and `24:00`.
-*Actions* +*Schedule Time* + +\(only available if *Schedule Type Fixed Time* is set\) -Choose between: - -- *Cleanup Data Store Entries* - -- *Cleanup Monitoring Data* - -- *Cleanup Trace Entries* - - -> ### Note: -> Depending on the type you choose, you have different options for *Parameters* and *Schedule*. - - +Define the time when the job is to run.
-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). +Parameterized message mappings from ES Repository can be imported with certain limitations. Only msessage mapping objects with *Simple Type* parameter category of the type *Import* are supported during migration. For more information, see [Designing and Configuring Parameterized Mapping Programs](https://help.sap.com/docs/SAP_NETWEAVER_750/bbd7c67c5eb14835843976b790024ec6/c47b8d9349e143a2b62e9b747eae4bce.html?version=latest).
- Manages user registration. Create and delete applications on behalf of application developers. In addition, create custom attributes and import the app key. + Manages user registration. Creates and deletes applications on behalf of application developers. In addition, creates custom attributes and imports the app key.
- Create applications and check billing and metering data. Test APIs and view analytics data. + Creates applications and checks billing and metering data, tests APIs, and views analytics data.
- Configure updates, and perform portal changes like uploading the logo, changing the name and the description, and changing the footer links for the site. + Configures, updates, and performs portal changes such as uploading the logo, changing the name and description, and modifying the footer links for the site.
- Manages content categories. + Creates products that include APIs from different business systems and manages the content that application developers can view in the catalog.
diff --git a/docs/ISuite/patch-releases-for-api-management-6ddd927.md b/docs/ISuite/patch-releases-for-api-management-6ddd927.md index e9eddc5e..793a1550 100644 --- a/docs/ISuite/patch-releases-for-api-management-6ddd927.md +++ b/docs/ISuite/patch-releases-for-api-management-6ddd927.md @@ -431,11 +431,11 @@ 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: +- 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 Developer Hub 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 APIProduct uses the name as the primary key in Developer Hub, 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. 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 ca2c3464..cb888922 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 @@ -12,6 +12,52 @@ The following patch release information covers the most recent changes made to t + + +## October 2024 + +**Software Increment: 2409** + + + + + + + + + + + + + +
+ +Technical Component + + + +Software Version + + + +Description + +
+ +Cloud Integration + + + +6.58.24 + + + +The JDBC Adapter version 1.5 was unavailable in Camel 3x tenants due to the command version difference between the Camel 2x and 3x branches. This patch fixes the issue. + +
+ + + ## September 2024 diff --git a/docs/ISuite/preparatory-steps-95366b2.md b/docs/ISuite/preparatory-steps-95366b2.md index 1b948d12..aaeab1f3 100644 --- a/docs/ISuite/preparatory-steps-95366b2.md +++ b/docs/ISuite/preparatory-steps-95366b2.md @@ -35,7 +35,7 @@ Before you can continue with the onboarding steps that are specific to Data Spac ## Results -You've enabled Beta features and are onboarded to SAP Integration Suite with Cloud Integration enabled. +You're onboarded to SAP Integration Suite with Cloud Integration enabled. diff --git a/docs/ISuite/prepare-for-deployment-on-red-hat-openshift-ocp-21ae0fd.md b/docs/ISuite/prepare-for-deployment-on-red-hat-openshift-ocp-21ae0fd.md index 74e27978..1b5f42f0 100644 --- a/docs/ISuite/prepare-for-deployment-on-red-hat-openshift-ocp-21ae0fd.md +++ b/docs/ISuite/prepare-for-deployment-on-red-hat-openshift-ocp-21ae0fd.md @@ -2,7 +2,10 @@ # Prepare for Deployment on Red Hat OpenShift \(OCP\) -OCP storage configuration depends on the underlying storage infrastructure. For information about supported storage, see [3247839](https://me.sap.com/notes/3247839), and for storage infrastructure, see [https://docs.openshift.com/container-platform/4.14/storage/index.html](https://docs.openshift.com/container-platform/4.14/storage/index.html). +OCP storage configuration depends on the underlying storage infrastructure. For information about supported storage, see [3247839](https://me.sap.com/notes/3247839), and for storage infrastructure, see [OpenShift Container Platform storage overview](https://docs.openshift.com/container-platform/4.14/storage/index.html). + +> ### Note: +> For information about how to prepare your infrastructure for the installation of Edge Integration Cell on OpenShift, see [Installation Guidance: SAP Edge Integration Cell on OpenShift](https://access.redhat.com/articles/7085063). diff --git a/docs/ISuite/prepare-your-kubernetes-cluster-46720c5.md b/docs/ISuite/prepare-your-kubernetes-cluster-46720c5.md index 6e292781..c44fa89b 100644 --- a/docs/ISuite/prepare-your-kubernetes-cluster-46720c5.md +++ b/docs/ISuite/prepare-your-kubernetes-cluster-46720c5.md @@ -64,7 +64,19 @@ Your PostgreSQL database must meet certain requirements before you can set up Ed - Server must provide a single endpoint \(host and port pair\). -- Using a connection proxy for failover such as `pgBouncer`, `HAProxy`, `Pgpool-II`. + - Using a connection proxy for failover such as `pgBouncer`, `HAProxy`, `Pgpool-II`. + + > ### Note: + > If you use `pgBouncer` as a connection proxy for PostgreSQL, the following parameters must be set: + > + > - pgbouncer.pool\_mode = transaction + > + > - pgbouncer.max\_prepared\_statements \> 0 + > + > - pgbouncer.ignore\_startup\_parameters = extra\_float\_digits + + + - Alternatively, in case PostgreSQL HA is deployed in K8s, the PostgreSQL K8s service should always point to the PostgreSQL read-write pod. The requirements are fulfilled when using cloud platform offerings like Azure Database for PostgreSQL, or Amazon RDS for PostgreSQL. diff --git a/docs/ISuite/region-specific-ip-addresses-available-for-api-management-cloud-foundry-environment-683a97c.md b/docs/ISuite/region-specific-ip-addresses-available-for-api-management-cloud-foundry-environment-683a97c.md index 8cc63a32..c0ae7076 100644 --- a/docs/ISuite/region-specific-ip-addresses-available-for-api-management-cloud-foundry-environment-683a97c.md +++ b/docs/ISuite/region-specific-ip-addresses-available-for-api-management-cloud-foundry-environment-683a97c.md @@ -1001,14 +1001,14 @@ us-east-1
> ### Note: -> If customers are implementing allow or deny listing based on IPs from their clients to API Management design time applications - API Portal, API business hub enterprise, or other platform services in Cloud Foundry, such as SAP Authorization and Trust Management Service \(XSUAA\) for fetching tokens, they will need to refer to the documentation for SAP Business Technology Platform Cloud Foundry IP addresses, which can be found at the following link: [Regions and API Endpoints Available for the Cloud Foundry Environment | SAP Help Portal](https://help.sap.com/docs/btp/sap-business-technology-platform/regions-and-api-endpoints-available-for-cloud-foundry-environment?version=Cloud). +> If customers are implementing allow or deny listing based on IPs from their clients to API Management design time applications - API Portal, Developer Hub, or other platform services in Cloud Foundry, such as SAP Authorization and Trust Management Service \(XSUAA\) for fetching tokens, they will need to refer to the documentation for SAP Business Technology Platform Cloud Foundry IP addresses, which can be found at the following link: [Regions and API Endpoints Available for the Cloud Foundry Environment | SAP Help Portal](https://help.sap.com/docs/btp/sap-business-technology-platform/regions-and-api-endpoints-available-for-cloud-foundry-environment?version=Cloud). **Related Information** [Configuring Additional Virtual Host in Cloud Foundry Environment](configuring-additional-virtual-host-in-cloud-foundry-environment-a7b91e5.md "A virtual host allows you to host multiple domain names on the API Management capability within Integration Suite.") -[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.") +[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 Developer Hub users.") [Cancel API Management Service Subscription](cancel-api-management-service-subscription-df6df2b.md "You can deactivate your API Management capability from Integration Suite to disable your account from the API Management service.") diff --git a/docs/ISuite/register-on-api-business-hub-enterprise-c85fafe.md b/docs/ISuite/register-on-developer-hub-c85fafe.md similarity index 68% rename from docs/ISuite/register-on-api-business-hub-enterprise-c85fafe.md rename to docs/ISuite/register-on-developer-hub-c85fafe.md index 01d4bb63..0ea9975a 100644 --- a/docs/ISuite/register-on-api-business-hub-enterprise-c85fafe.md +++ b/docs/ISuite/register-on-developer-hub-c85fafe.md @@ -1,8 +1,8 @@ -# Register on API business hub enterprise +# Register on Developer Hub -Procedure to register as an application developer on the API business hub enterprise to view the products available in the catalog store. The API business hub enterprise also enables you to explore the APIs, read the associated API documentation, and view resources. +Procedure to register as an application developer on the Developer Hub to view the products available in the catalog store. The Developer Hub also enables you to explore the APIs, read the associated API documentation, and view resources. @@ -16,11 +16,11 @@ Procedure to register as an application developer on the API business hub enterp > ### Note: - > If the *AuthGroup.API.ApplicationDeveloper* role is already assigned to you by the SAP BTP admin or via the IDP Role Collection mapping, you will get automatically registered as an application developer in API business hub enterprise when you logon for the first time. + > If the *AuthGroup.API.ApplicationDeveloper* role is already assigned to you by the SAP BTP admin or via the IDP Role Collection mapping, you will get automatically registered as an application developer in Developer Hub when you logon for the first time. > - > If you don't have the *AuthGroup.API.ApplicationDeveloper* role assigned to you in SAP BTP cockpit, complete the self-registration process to access all the funtionalities and features of API business hub enterprise. + > If you don't have the *AuthGroup.API.ApplicationDeveloper* role assigned to you in SAP BTP cockpit, complete the self-registration process to access all the funtionalities and features of Developer Hub. > - > Please note that the *AuthGroup.API.ApplicationDeveloper* role that has been assigned to you will only take effect if you login to API business hub enterprise. Only relevant for New Design of the API business hub enterprise. + > Please note that the *AuthGroup.API.ApplicationDeveloper* role that has been assigned to you will only take effect if you login to Developer Hub. Only relevant for New Design of the Developer Hub. - As an Admin you're trying to onboard multiple users: @@ -39,11 +39,11 @@ Procedure to register as an application developer on the API business hub enterp > > - **Use Case 1: User is no longer in the organization:** > - > If the *AuthGroup.API.ApplicationDeveloper* role is removed from either the SAP BTP cockpit or the IDP Role Collection mapping, as an admin, you should also ensure that the *AuthGroup.API.ApplicationDeveloper* role is removed from the API business hub enterprise, or vice versa. Failing to do so may lead to confusion and discrepancies. + > If the *AuthGroup.API.ApplicationDeveloper* role is removed from either the SAP BTP cockpit or the IDP Role Collection mapping, as an admin, you should also ensure that the *AuthGroup.API.ApplicationDeveloper* role is removed from the Developer Hub, or vice versa. Failing to do so may lead to confusion and discrepancies. > > - **Use Case 2: User is still in the organization:** > - > If a user is still part of the organization, the role removal in BTP will take effect in the API business hub enterprise once the user logs in. If this user wishes to access the API business hub enterprise, they must either follow the self-registration process or have this role assigned to them from the SAP BTP Cockpit. + > If a user is still part of the organization, the role removal in BTP will take effect in the Developer Hub once the user logs in. If this user wishes to access the Developer Hub, they must either follow the self-registration process or have this role assigned to them from the SAP BTP Cockpit. @@ -58,24 +58,24 @@ The procedure below describes the sequence of steps when as a developer you're t ## Procedure -1. Log on to the API business hub enterprise application with your IDP user credentials. +1. Log on to the Developer Hub application with your IDP user credentials. -2. To register to the API business hub enterprise as an Application developer, choose *Register*. +2. To register to the Developer Hub as an Application developer, choose *Register*. A dialog box with the prepopulated data such as, your first name, last name, and e-mail address appears. -3. Enter the country/region and reason for requesting access to the API business hub enterprise. +3. Enter the country/region and reason for requesting access to the Developer Hub. 4. Choose *OK*. The request is sent to the administrator with the AuthGroup.API.Admin role. - - If the administrator approves your request, you’ll receive an e-mail notification. You can log in to the API business hub enterprise via the link provided in the e-mail. + - If the administrator approves your request, you’ll receive an e-mail notification. You can log in to the Developer Hub via the link provided in the e-mail. - If the administrator rejects the request, you’ll receive an e-mail notification with the reason for the rejection. When you log on to the application, you’ll see the reason for request rejection on the display page. > ### Note: - > Application Developers can now email to the administrator by replying to the email notification they receive for any queries regarding their access request to the API business hub enterprise application. + > Application Developers can now email to the administrator by replying to the email notification they receive for any queries regarding their access request to the Developer Hub application. diff --git a/docs/ISuite/review-and-adjust-isa-m-settings-957de13.md b/docs/ISuite/review-and-adjust-isa-m-settings-957de13.md index f0521fa9..f771e06b 100644 --- a/docs/ISuite/review-and-adjust-isa-m-settings-957de13.md +++ b/docs/ISuite/review-and-adjust-isa-m-settings-957de13.md @@ -434,7 +434,7 @@ Use this kind of questionnaire to guide the user through the creation of a busin The Content Life Cycle update gives you the ability to incorporate relevant changes to the latest standard content, delivered by SAP, into your existing SAP standard content. You can select/deselect the listed updates based on your requirements and apply them as the latest version of your dataset. -See: [Content Life Cycle](content-life-cycle-06581f4.md) +See: [Update Content Maintained by SAP](update-content-maintained-by-sap-06581f4.md) **Related Information** diff --git a/docs/ISuite/revoke-access-ce609bb.md b/docs/ISuite/revoke-access-ce609bb.md index 723cf79e..902384d6 100644 --- a/docs/ISuite/revoke-access-ce609bb.md +++ b/docs/ISuite/revoke-access-ce609bb.md @@ -20,7 +20,7 @@ You are an API administrator and the role *AuthGroup.API.Admin* is assigned to y ## Context -As an API administrator, you use this procedure to revoke an application developer's access for using the API business hub enterprise. +As an API administrator, you use this procedure to revoke an application developer's access for using the Developer Hub. @@ -28,9 +28,9 @@ As an API administrator, you use this procedure to revoke an application develop ## Procedure -1. Log on to the **API business hub enterprise**. +1. Log on to the **Developer Hub**. -2. Choose *Enterprise Manager* \> *Manage Users* \> *Registered Users*. +2. Choose *Admin Center* \> *Manage Users* \> *Registered Users*. 3. From the list of application developers, select the application developer whose access you want to revoke and choose the Revoke Usericon under the *Actions* column. @@ -46,5 +46,5 @@ As an API administrator, you use this procedure to revoke an application develop ## Results -You have revoked the access of the user from using API business hub enterprise successfully. +You have revoked the access of the user from using Developer Hub successfully. diff --git a/docs/ISuite/set-log-levels-8e58ec4.md b/docs/ISuite/set-log-levels-8e58ec4.md index d6ef868f..40d04549 100644 --- a/docs/ISuite/set-log-levels-8e58ec4.md +++ b/docs/ISuite/set-log-levels-8e58ec4.md @@ -10,14 +10,14 @@ Learn how to set log levels for Java-based solution components. There are different methods to set log levels depending on your requirements: -- If you need to change log levels only temporarily, you can create a diagnostic task. Open *Diagnostics* through the *Quick Links* tile and create a *Custom Logging* task. You can edit the log levels of existing custom loggers or create new ones. +- If you need to change log levels only temporarily, you can create a diagnostic task. Open *Diagnostics* through the *Quick Links* card in the Operations Cockpit and create a *Custom Logging* task. You can edit the log levels of existing custom loggers or create new ones. > ### Remember: > Make sure that *Diagnostics* fulfills your requirements. For more information, see [Diagnostics](diagnostics-80f3050.md). -- You can use the *Edge Nodes* tab in Edge Lifecycle Management. Perform the following procedure to set log levels in Edge Lifecycle Management: +- If you want to change log levels permanently of for a longer time period, you can use the *Edge Nodes* tab in Edge Lifecycle Management. Perform the following procedure to set log levels in Edge Lifecycle Management: 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 a56e0d13..dfc99c91 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-683a97c.md "API Management protects your backend services. However, API Management needs to establish connectivity to your backend services during an API call execution.") -[User Roles in API Management](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.") +[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 Developer Hub users.") [Cancel API Management Service Subscription](cancel-api-management-service-subscription-df6df2b.md "You can deactivate your API Management capability from Integration Suite to disable your account from the API Management service.") diff --git a/docs/ISuite/subscribe-to-a-product-486d263.md b/docs/ISuite/subscribe-to-a-product-486d263.md index df918e21..603f4cac 100644 --- a/docs/ISuite/subscribe-to-a-product-486d263.md +++ b/docs/ISuite/subscribe-to-a-product-486d263.md @@ -16,7 +16,7 @@ On the homepage, you can find the list of products under various categories. You ## Procedure -1. Log on to the API business hub enterprise. +1. Log on to the Developer Hub. 2. You can either look for the product under various categories, or use the search bar to search for the product. diff --git a/docs/ISuite/supported-patterns-ad867ae.md b/docs/ISuite/supported-patterns-ad867ae.md index 1d9afbd9..b94fb6eb 100644 --- a/docs/ISuite/supported-patterns-ad867ae.md +++ b/docs/ISuite/supported-patterns-ad867ae.md @@ -51,11 +51,17 @@ For example: ## Recipient List Asynchronous -Recipient list-based integration scenarios and content-based routing integration scenarios can be migrated using the pattern Recipient List Asynchronous. +Recipient List Asynchronous pattern is used to migrate multi-casted integration pattern between a sender and multiple receiver systems via multiple routes. Based on the scenario, the migration tooling applies the Recipient List Asynchronous pattern and dynamically adds the flow steps. The pattern implements JMS queues to store the message after it is received from the sender and decouple the sender and the multiple receivers. -For example, if your ICO is designed with a recipient list where the message is sent to the default receiver in case the receiver is not determined, the following pattern applies.![](images/RL_ASYNC_0003_5163d0f.png) +SAP recommends using this pattern for conditions based scenarios where you know that more than one condition can be true at runtime. That is, multiple receivers receives the message or payload based on the conditions. -If your ICO is designed with 1 router and a receiver for each router branch sending message to default receiver in case of receiver not determined, the following pattern applies. ![](images/CBR_ASYNC_0003_b742101.png) + -Similarly, based on other receipient list integration scenarios and content-based routing integration scenarios, the migration tooling applies the Recipient List Asynchronous pattern and dynamically adds the flow steps. + + +## Content-Based Routing + +Content-Based Routing pattern is used to migrate condition-based integration scenarios where messages are routed to a single receiver. Based on the scenario, the migration tooling applies the Content-Based Routing pattern and dynamically adds the flow steps. + +SAP recommends using this pattern for conditions based scenarios where you know that only one of the conditions can be true at runtime. That is, only one receiver receives the message or payload. diff --git a/docs/ISuite/test-runtime-behavior-of-apis-15c7d52.md b/docs/ISuite/test-runtime-behavior-of-apis-15c7d52.md index 55b87409..2fd983fe 100644 --- a/docs/ISuite/test-runtime-behavior-of-apis-15c7d52.md +++ b/docs/ISuite/test-runtime-behavior-of-apis-15c7d52.md @@ -7,7 +7,7 @@ Use the API Test Environment to test the runtime behavior of APIs. The *Test Environment* enables you to test your APIs. Testing an API is essential to understand the runtime behavior of the APIs. It allows you to explore the resources associated with an API and execute the operations. It also allows you to test OData and REST-based services. > ### Note: -> This document describes the new design of the API business hub enterprise. To view the documentation for the classic design, see [Test API Proxies](https://help.sap.com/viewer/66d066d903c2473f81ec33acfe2ccdb4/Cloud/en-US/3ba6151391bc474b9f1fa69455f65e3b.html "Use the API Test Console to test the runtime behavior of the API proxies.") :arrow_upper_right:. +> This document describes the new design of the Developer Hub. 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:. @@ -23,7 +23,7 @@ The *Test Environment* tab will be visible to you only if you have the *AuthGrou ## Procedure -1. Log on to the API business hub enterprise. +1. Log on to the Developer Hub. 2. Navigate to the *Test Environment*. diff --git a/docs/ISuite/trading-partner-management-28fe3dc.md b/docs/ISuite/trading-partner-management-28fe3dc.md index ee5ad9e1..4e42f1ac 100644 --- a/docs/ISuite/trading-partner-management-28fe3dc.md +++ b/docs/ISuite/trading-partner-management-28fe3dc.md @@ -2,9 +2,18 @@ # Trading Partner Management -SAP Trading Partner Management \(TPM\) is a microservice that meets the needs of your B2B data exchange such as individual definition and configuration of specific electronic exchange of business data between you and your trading partners. B2B users have different levels of requirements for data exchange starting from the different kind of communication protocols such as AS2, SFTP, etc. to the usage of different types of B2B standards or APIs. TPM helps you manage B2B relationships with multiple trading partners. The easy-to-use user interface helps you cope with the complexity of B2B communication between trading partners. +SAP Trading Partner Management \(TPM\) is a powerful capability within Integration Suite that streamlines the management and governance of business-to-business \(B2B\) relationships, agreements, and interactions with external trading partners. TPM empowers organizations to tailor their B2B data exchange to meet specific needs, defining and configuring electronic data interchange protocols, standards, and APIs for each trading partner. -TPM, just like Cloud Integration and Integration Advisor, is a capability of SAP Integration Suite. This application achieves the goal by using the entities and artifacts provided by the other capabilities of SAP Integration Suite such as: +With TPM, organizations can accommodate diverse B2B requirements, including: + +- Multiple communication protocols \(AS2, SFTP, FTP, etc.\) + +- Various B2B standards \(EDI, XML, JSON, etc.\) +- APIs for seamless integration + +The intuitive user interface simplifies the complexity of B2B communication, enabling efficient management of trading partner relationships, agreements, and data exchange configurations. + +This application achieves the goal by using the entities and artifacts provided by the other capabilities of SAP Integration Suite such as: - SAP Integration Advisor @@ -26,5 +35,5 @@ The application helps you to: - Push the auto-generated runtime artefacts of the B2B scenarios as defined in the agreements into the Partner Directory of SAP Cloud Integration. This will ensure that the B2B messages get processed individually by a single integration flow at runtime. - Deploy and run integration flows to conduct end-to-end business transactions. -To get started, see [Update Properties](50-Development/update-properties-ba066bb.md). +To get started, see [B2B Scenarios](https://help.sap.com/docs/integration-suite/sap-integration-suite/b2b-scenarios). diff --git a/docs/ISuite/troubleshooting-for-edge-integration-cell-816d9e4.md b/docs/ISuite/troubleshooting-for-edge-integration-cell-816d9e4.md index 7b9653ba..ca8e5cbe 100644 --- a/docs/ISuite/troubleshooting-for-edge-integration-cell-816d9e4.md +++ b/docs/ISuite/troubleshooting-for-edge-integration-cell-816d9e4.md @@ -74,7 +74,7 @@ BC-CP-IS-EDG-BCS
-Provisioning of Edge Integration Cell. +Issues with the Provisioning of the Edge Integration Cell. @@ -86,6 +86,30 @@ LOD-HCI-PI-PRV
+Issues with the Operations Cockpit. + + + +BC-CP-IS-EDG-OPI + +
+ +Issues with Edge Local Authentication and Authorization. + + + +BC-CP-IS-EDG-ELA + +
+ - Issues with worker nodes. - Issues with content deployment \(integration flow deployment\). diff --git a/docs/ISuite/troubleshooting-for-sap-integration-suite-8e77039.md b/docs/ISuite/troubleshooting-for-sap-integration-suite-8e77039.md index 777d34b6..0f3f22b6 100644 --- a/docs/ISuite/troubleshooting-for-sap-integration-suite-8e77039.md +++ b/docs/ISuite/troubleshooting-for-sap-integration-suite-8e77039.md @@ -8,5 +8,6 @@ In this section you will find: - [Troubleshooting for API Management](troubleshooting-for-api-management-e765066.md) - [Troubleshooting for Graph](troubleshooting-for-graph-2cfb06c.md) +- [Troubleshooting for Data Space Integration](troubleshooting-for-data-space-integration-166fa88.md) - [Troubleshooting for Edge Integration Cell](troubleshooting-for-edge-integration-cell-816d9e4.md) diff --git a/docs/ISuite/update-content-maintained-by-sap-06581f4.md b/docs/ISuite/update-content-maintained-by-sap-06581f4.md new file mode 100644 index 00000000..6eb62206 --- /dev/null +++ b/docs/ISuite/update-content-maintained-by-sap-06581f4.md @@ -0,0 +1,138 @@ + + + + +# Update Content Maintained by SAP + +Incorporate new versions of standard content into your dataset. + +At the time of onboarding, the latest SAP standard content will be available for usage. When a new version of SAP standard content is released, you get a notification. If you have the required privileges, you can choose to update to the latest version depending on your business needs. + + + + + +## Required Privileges + +The *Content Life Cycle* page is only visible to users who have the right to update the content. This privilege is granted to the following personas: + +- Integration Architect +- Administrator + +For more information on personas, see: [Personas for Migration Assessment](60-Security/personas-for-integration-assessment-5df5af1.md). + + + + + +## Notification for new content + +Once there are content updates delivered by SAP, you get a notification directly in the tool via the notification icon :bell: in the shell bar. If you have the required privileges to update content as described in the previous section, the notification will have the *View Updates* button. Selecting the button takes you to the *Content Life Cycle* page where new content is visible for update. + +> ### Note: +> Alternatively, you can navigate to *Settings* \> *Content Life Cycle* to view the updates available. + + + + + +## Content Life Cycle Page + +The dataset is hierarchical and has a parent-child relationship. Parent nodes are known as *Changesets*, Child nodes are *Change Execution Sets*. Every time a new version of SAP standard content is released, you can choose which data to update. + +> ### Note: +> When there's more than one version of the standard content released, you cannot directly upgrade to the latest version. You will only be able to upgrade to the next version. +> +> > ### Example: +> > If the current version is 1.1, update version is 1.2 and the latest version is 1.3, you can only update first to 1.2 and then to 1.3. You can't update directly to the latest version. + +The possible types of updates are the following: + + + + + + + + + + + +
+ +New + + + +New Content + +
+ +Update + + + +Update of existing content + +
+ +Selecting a changeset includes it in the update. When you don't select it, the changeset is removed and potential cleanup actions are initiated. + +The changesets can be either *Mandatory for Update* or *Available for Update* as described in the following table. + + + + + + + + + + + + + + + +
+ +Changeset type + + + +Meaning + +
+ +Mandatory For Update + + + +Signifies whether the changeset is mandatory for the planned update. + +
+ +Available For Update + + + +Signifies whether the changeset is available for update. + +
+ +Whenever you're trying to update a parent node, the child node should also be considered. Under one parent node, there can be multiple child nodes. The two types of child nodes are as follows: + +- Mandatory child node: + + For a mandatory child node, if the parent node is deselected, the child nodes are deselected by default. + +- Non-mandatory child node + + For a non-mandatory child node, if the parent node is deselected, you have the control to select or deselect the child nodes. Sufficient details about what all content is going to be updated as part of this selection/deselection is shown. + + +Select *Update* once you are done. + +> ### Note: +> If there's any error during the update, the entire content update fails. An error marker is placed at the respective position. By selecting it, error details including the reason are shown. + diff --git a/docs/ISuite/updating-a-published-product-5cc1b23.md b/docs/ISuite/updating-a-published-product-5cc1b23.md index 9d3ebda4..1b7a5366 100644 --- a/docs/ISuite/updating-a-published-product-5cc1b23.md +++ b/docs/ISuite/updating-a-published-product-5cc1b23.md @@ -26,9 +26,9 @@ Additionally, you can remove and add APIs to the product. Once done you can publ ## Procedure -1. Log on to the API business hub enterprise. +1. Log on to the Developer Hub. -2. Navigate to the *Enterprise Manager* \> *Manage* \> *Content*. +2. Navigate to the *Admin Center* \> *Manage* \> *Content*. 3. Choose the *Products* tab. diff --git a/docs/ISuite/updating-the-connection-request-credentials-for-a-pending-request-dd37a7b.md b/docs/ISuite/updating-the-connection-request-credentials-for-a-pending-request-dd37a7b.md index 93f2c367..b0562c88 100644 --- a/docs/ISuite/updating-the-connection-request-credentials-for-a-pending-request-dd37a7b.md +++ b/docs/ISuite/updating-the-connection-request-credentials-for-a-pending-request-dd37a7b.md @@ -2,7 +2,7 @@ # 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. +Update the credentials you've used to establish a connection between the Integration Suite API Management tenant and the Developer Hub. @@ -20,7 +20,7 @@ Update the credentials you've used to establish a connection between the Integra 3. Choose the *Connection* tab. - 4. Choose *Generate Credentials* under **Connect the API Portal to the centralized API business hub enterprise** and *Copy* the access credentials. + 4. Choose *Generate Credentials* under **Connect the API Portal to the centralized Developer Hub** and *Copy* the access credentials. > ### Note: @@ -48,9 +48,9 @@ If you encounter one of the following situations when your connection request is ## Procedure -1. Log on to the **API business hub enterprise**. +1. Log on to the **Developer Hub**. -2. Navigate to the *Enterprise Manager* \> *Manage Connections* and choose *Pending Requests*. +2. Navigate to the *Admin Center* \> *Manage Connections* and choose *Pending Requests*. 3. Go to the *Actions* column of the connection request that you want to edit and choose *Edit Credentials*. diff --git a/docs/ISuite/updating-the-connection-request-credentials-for-an-approved-request-882e1d9.md b/docs/ISuite/updating-the-connection-request-credentials-for-an-approved-request-882e1d9.md index f4728fbd..b6edfd07 100644 --- a/docs/ISuite/updating-the-connection-request-credentials-for-an-approved-request-882e1d9.md +++ b/docs/ISuite/updating-the-connection-request-credentials-for-an-approved-request-882e1d9.md @@ -2,7 +2,7 @@ # 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. +There can be instances where you have to update the credentials once the connection request is approved by the Developer Hub admin. @@ -30,11 +30,11 @@ To update the API portal access credentials, you must first generate it. To gene ## Context -To establish the connection between the Integration Suite API Management tenant and the API business hub enterprise, the client Id and client secret created for the Integration Suite API Management tenant is shared during the connection request process. +To establish the connection between the Integration Suite API Management tenant and the Developer Hub, the client Id and client secret created for the Integration Suite 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: +If you encounter one of the following situations after the connection request has already been approved by the Developer Hub admin, you have to update the credentials: -- The service instance, or the service key gets deleted after the connection between the Integration Suite 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. +- The service instance, or the service key gets deleted after the connection between the Integration Suite API Management tenant and the Developer Hub 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 the Integration Suite API Management tenant workspace gets deleted, the credentials you were using before the destination got deleted becomes invalid. @@ -45,9 +45,9 @@ If you encounter one of the following situations after the connection request ha ## Procedure -1. Log on to the **API business hub enterprise**. +1. Log on to the **Developer Hub**. -2. Navigate to the *Enterprise Manager* \> *API Management Connections* and choose *Approved Requests*. +2. Navigate to the *Admin Center* \> *API Management Connections* and choose *Approved Requests*. The connection requests that are pending for approval are listed on the *Approved Requests* page. diff --git a/docs/ISuite/user-roles-and-responsibilities-in-api-business-hub-enterprise-54b4607.md b/docs/ISuite/user-roles-and-responsibilities-in-api-business-hub-enterprise-54b4607.md deleted file mode 100644 index ee16ed48..00000000 --- a/docs/ISuite/user-roles-and-responsibilities-in-api-business-hub-enterprise-54b4607.md +++ /dev/null @@ -1,642 +0,0 @@ - - -# User Roles and Responsibilities in API business hub enterprise - -After activating the API business hub enterprise in the Integration Suite, you need to assign users the necessary roles and role collections to access the various features and functionalities of API business hub enterprise. - -Once the appropriate roles have been assigned, you can configure and customize the API business hub enterprise to align with your organization's needs. - -Your access to various features on the API business hub enterprise will depend on the service plan you have subscribed to. - - - -The roles and features offered in the Standard and Premium service plans include: - -- Key Actions for Admins in API business hub enterprise - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - As... - - - - You can use… - - - - Important Notes - - - - For more information, see… - -
- - An *API Admin*, you already have the *AuthGroup.API.Admin* role collection assigned to you. - - - - *Home Page* to browse and search through the various categories, APIs, and products available on the . - - - -   - - - - [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 - - - - - - - The availability of this feature is dependent on your SAP Integration Suite service plan. For more information about different service plans and their supported feature set, see SAP Note [2903776](https://me.sap.com/notes/2903776). - - - - [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. - - - - The availability of this feature is dependent on your SAP Integration Suite service plan. For more information about different service plans and their supported feature set, see SAP Note [2903776](https://me.sap.com/notes/2903776). - - - - [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](managing-the-access-request-of-the-users-8b79ee8.md) - - [Revoke Access](revoke-access-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 collection 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 collection 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) - -
- -   - - - - *Enterprise Manager* \> *Manage Content* to create products that includes APIs from different business systems and manage the content that application developers can view on the catalog. - - - -   - - - - [Manage Content](manage-content-cdf0fab.md) - -
- -   - - - - *Enterprise Manager* \> *Manage Content* to monitor and manage all requests for product creation and updates. - - - -   - - - - [Manage Scheduled Requests](manage-scheduled-requests-7236981.md) - -
- -- Key Actions for Application Developers in API business hub enterprise - - - - - - - - - - - - - - - - - - - - - - - - - -
- - As... - - - - You can use… - - - - Important Notes - - - - For more information, see… - -
- - An *Application Developer* you already have the *AuthGroup.API.ApplicationDeveloper* role collection assigned to you. - - > ### Note: - > The *AuthGroup.API.ApplicationDeveloper* role collection 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. - - - - - - The *Home page* to explore the product created on API business hub enterprise and view the APIs within the products, but you can't subscribe to them. - - - - - - - - - -
- - *My Workspace* to create applications, view your applications, monitor costs, and analyze reports. - - - - The availability of this feature is dependent on your SAP Integration Suite service plan. For more information about different service plans and their supported feature set, see SAP Note [2903776](https://me.sap.com/notes/2903776). - - - - [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. - - - - The availability of this feature is dependent on your SAP Integration Suite service plan. For more information about different service plans and their supported feature set, see SAP Note [2903776](https://me.sap.com/notes/2903776). - - - - [Test Runtime Behavior of APIs](test-runtime-behavior-of-apis-15c7d52.md) - -
- - - - - - -## Supported Features in Standard and Premium Edition - -The roles and features offered in the Standard and Premium service plans include: - -- Key Actions for Admins in API business hub enterprise - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - As... - - - - You can use… - - - - For more information, see… - -
- - An *API Admin*, you already have the *AuthGroup.API.Admin* role collection 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](managing-the-access-request-of-the-users-8b79ee8.md) - - [Revoke Access](revoke-access-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 collection 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 collection 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) - -
- -   - - - - *Enterprise Manager* \> *Manage Content* to create products that includes APIs from different business systems and manage the content that application developers can view on the catalog. - - - - [Manage Content](manage-content-cdf0fab.md) - -
- -   - - - - *Enterprise Manager* \> *Manage Content* to monitor and manage all requests for product creation and updates. - - - - [Manage Scheduled Requests](manage-scheduled-requests-7236981.md) - -
- -- Key Actions for Application Developers in API business hub enterprise - - - - - - - - - - - - - - - - - -
- - As... - - - - You can use… - - - - For more information, see… - -
- - An *Application Developer* you already have the *AuthGroup.API.ApplicationDeveloper* role collection assigned to you. - - > ### Note: - > The *AuthGroup.API.ApplicationDeveloper* role collection 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/user-roles-and-responsibilities-in-developer-hub-54b4607.md b/docs/ISuite/user-roles-and-responsibilities-in-developer-hub-54b4607.md new file mode 100644 index 00000000..1d8857eb --- /dev/null +++ b/docs/ISuite/user-roles-and-responsibilities-in-developer-hub-54b4607.md @@ -0,0 +1,370 @@ + + +# User Roles and Responsibilities in Developer Hub + +After activating the Developer Hub in the Integration Suite, you need to assign users the necessary roles and role collections to access the various features and functionalities of Developer Hub. + +Once the appropriate roles have been assigned, you can configure and customize the Developer Hub to align with your organization's needs. + +Your access to various features on the Developer Hub will depend on the service plan you have subscribed to. + + + +The roles and features offered in the Standard and Premium service plans include: + +- Key Actions for Admins in Developer Hub + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + As... + + + + You can use… + + + + Important Notes + + + + For more information, see… + +
+ + An *API Admin*, you already have the *AuthGroup.API.Admin* role collection assigned to you. + + + + *Home Page* to browse and search through the various categories, APIs, and products available on the . + + + +   + + + + [Register on Developer Hub](register-on-developer-hub-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 Developer Hub + - Monitor costs + + - Analyze reports + + + + + + + The availability of this feature is dependent on your SAP Integration Suite service plan. For more information about different service plans and their supported feature set, see SAP Note [2903776](https://me.sap.com/notes/2903776). + + + + [Creating an Application with Developer Hub Administrator Role](creating-an-application-with-developer-hub-administrator-role-df4f777.md) + +
+ + *Admin Center* \> *Manage External Content* to adjust the visibility of the Graph navigator on the Developer Hub. + + + + The availability of this feature is dependent on your SAP Integration Suite service plan. For more information about different service plans and their supported feature set, see SAP Note [2903776](https://me.sap.com/notes/2903776). + + + + [Manage External Content](https://help.sap.com/docs/integration-suite/sap-integration-suite/manage-external-content-new-design?version=CLOUD&q=Exyternal%20Content) + +
+ + *Admin Center* \> *Manage Access* to control the level of access for your users, allowing them to search, discover, and access the content available on the Developer Hub. + + + +   + + + + [Manage Developer Access](manage-developer-access-9df3ece.md) + +
+ + *Admin Center* \> *Manage Users* to add and revoke user access to the Developer Hub. + + + +   + + + + [Managing the Access Request of the Users](managing-the-access-request-of-the-users-8b79ee8.md) + + [Revoke Access](revoke-access-ce609bb.md) + +
+ + *Admin Center* \> *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 collection assigned to you. + + + + *Site Editor* to customize the visual layout of the Developer Hub. + + + +   + + + + [Customize the Visual Format of the Developer Hub](customize-the-visual-format-of-the-developer-hub-2eacd52.md) + +
+ + *Admin Center* \> *Manage Notifications* to configure notifications to keep the end users of the Developer Hub informed about website updates and news items. + + + +   + + + + [Manage Notifications](manage-notifications-df32457.md) + +
+ + A *Content Admin* you already have the *AuthGroup.Content.Admin* role collection assigned to you. + + + + *Admin Center* \> *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) + +
+ +   + + + + *Admin Center* \> *Manage Content* to create products that includes APIs from different business systems and manage the content that application developers can view on the catalog. + + + +   + + + + + +
+ +   + + + + *Admin Center* \> *Manage Content* to monitor and manage all requests for product creation and updates. + + + +   + + + + [Manage Scheduled Requests](manage-scheduled-requests-7236981.md) + +
+ +- Key Actions for Application Developers in Developer Hub + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + As... + + + + You can use… + + + + Important Notes + + + + For more information, see… + +
+ + An *Application Developer* you already have the *AuthGroup.API.ApplicationDeveloper* role collection assigned to you. + + > ### Note: + > The *AuthGroup.API.ApplicationDeveloper* role collection is assigned by default to a user who onboards to the Developer Hub using the Self-registration process or via *Add User* flow. + + + + + + The *Home page* to explore the product created on Developer Hub and view the APIs within the products, but you can't subscribe to them. + + + + + + + + + +
+ + *My Workspace* to create applications, view your applications, monitor costs, and analyze reports. + + + + The availability of this feature is dependent on your SAP Integration Suite service plan. For more information about different service plans and their supported feature set, see SAP Note [2903776](https://me.sap.com/notes/2903776). + + + + [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. + + + + The availability of this feature is dependent on your SAP Integration Suite service plan. For more information about different service plans and their supported feature set, see SAP Note [2903776](https://me.sap.com/notes/2903776). + + + + [Test Runtime Behavior of APIs](test-runtime-behavior-of-apis-15c7d52.md) + +
+ + diff --git a/docs/ISuite/user-roles-in-api-management-7010b58.md b/docs/ISuite/user-roles-in-api-management-7010b58.md index 242dfdba..8f8d0aeb 100644 --- a/docs/ISuite/user-roles-in-api-management-7010b58.md +++ b/docs/ISuite/user-roles-in-api-management-7010b58.md @@ -2,7 +2,7 @@ # User Roles in API Management -Use role collections to group together different roles that can be assigned to API Portal and API business hub enterprise users. +Use role collections to group together different roles that can be assigned to API Portal and Developer Hub users. **API Portal Roles** @@ -40,7 +40,7 @@ Use this role to access the API portal user interface \(UI\) and services, manag 		-You need this role assigned to you because the client credentials, which are necessary for establishing a connection between the Integration Suite API Management tenant and API business hub enterprise, are generated for this role. +You need this role assigned to you because the client credentials, which are necessary for establishing a connection between the Integration Suite API Management tenant and Developer Hub, are generated for this role.
-**API business hub enterprise Roles** +**Developer Hub Roles** @@ -94,7 +94,7 @@ Description @@ -131,8 +131,8 @@ Use this role to: Use this role to: -- Publish content to the API business hub enterprise. -- Establish a connection from the API portal to the API business hub enterprise. +- Publish content to the Developer Hub. +- Establish a connection from the API portal to the Developer Hub. @@ -148,7 +148,7 @@ Use this role to: Use this role to: -- Access the API business hub enterprise. +- Access the Developer Hub. - Create, update, and delete applications. - View analytics information on application usage, performance, and error count. - View and download bills for subscribed applications. @@ -198,7 +198,7 @@ Use this role to: diff --git a/docs/ISuite/using-apis-to-work-with-data-space-integration-411fd1e.md b/docs/ISuite/using-apis-to-work-with-data-space-integration-411fd1e.md index 959f27c2..6479741f 100644 --- a/docs/ISuite/using-apis-to-work-with-data-space-integration-411fd1e.md +++ b/docs/ISuite/using-apis-to-work-with-data-space-integration-411fd1e.md @@ -49,7 +49,7 @@ To get access to Data Space Integration using APIs, you must first create a serv ### Procedure 1. Go to the SAP BTP cockpit and navigate to your subaccount that has SAP Integration Suite enabled. From there, go to *Cloud Foundry* \> *Spaces* \> *Your space* \> *Services* \> *Instances*. -2. Select **Create** to create a new service instance and select `Data Space Integration API Access (BETA)`. In the **Plan** field, enter `api`, and add an instance name. Then, choose **Next**. +2. Select **Create** to create a new service instance and select `Data Space Integration API Access`. In the **Plan** field, enter `api`, and add an instance name. Then, choose **Next**. 3. Next, select the applicable role to enforce authorization, `DataspaceConsumer` or `DataspaceProvider`, or both, depending on the needs of the business application that wants to exchange data within the data space. For an overview of the available roles and their authorizations, see [Personas and Roles](60-Security/identity-and-access-management-for-data-space-integration-211c66a.md#loio211c66a2f65e4bf0ad0e93e68cfff984__section_cxz_vsk_pcc). Once you've selected the role, select `client_credentials` as the grant type and choose **Next**. diff --git a/docs/ISuite/webhook-subscriptions-58e3729.md b/docs/ISuite/webhook-subscriptions-58e3729.md new file mode 100644 index 00000000..61fdc7df --- /dev/null +++ b/docs/ISuite/webhook-subscriptions-58e3729.md @@ -0,0 +1,17 @@ + + +# Webhook Subscriptions + +A webhook subscription is a configuration on the message client that facilitates message delivery from a queue to REST-based consumers. + +A webhook is a method used by web applications to communicate with each other automatically and in real-time. When an event happens on a web application, like a button click, a webhook sends a message which prompts an action on a different web app. In this case, the application sending the message is known as the webhook provider and the responding app is known as the webhook receiver. + +You use webhooks whenever you want an event on one application to automatically trigger an event in other application. As there is no polling, webhooks consume lesser resources. As soon as a message reaches the queue, a webhook triggers a near real time delivery of the message. On contrary, in an API paradigm, a receiver application must manually ask the provider application for information, which in turn, consumes more resources. + +A **webhook subscription** in the Event Mesh capability of Integration Suite creates a connection to your webhook and associates the same to a queue. When messages reach a queue, a webhook subscription lets you automatically send those messages to your webhook in near real time. + +**Related Information** + + +[Create a Webhook Subscription](50-Development/create-a-webhook-subscription-e120b8b.md "Understand how to create webhook subscriptions.") + diff --git a/docs/ISuite/what-is-data-space-integration-4edeee5.md b/docs/ISuite/what-is-data-space-integration-4edeee5.md index 048be9d1..29a0cf0f 100644 --- a/docs/ISuite/what-is-data-space-integration-4edeee5.md +++ b/docs/ISuite/what-is-data-space-integration-4edeee5.md @@ -31,6 +31,8 @@ The International Data Spaces \(IDS\) initiative aims to establish a uniform sta > Currently, Data Space Integration supports connections to the following data spaces: > > - [Catena-X](https://catena-x.net) +> +> See also the [Release Notes](https://catenax-ev.github.io/release-notes) of Catena-X. diff --git a/docs/ISuite/what-is-migration-assessment-164b835.md b/docs/ISuite/what-is-migration-assessment-164b835.md index 9793ac5d..93a11a62 100644 --- a/docs/ISuite/what-is-migration-assessment-164b835.md +++ b/docs/ISuite/what-is-migration-assessment-164b835.md @@ -15,24 +15,30 @@ Learn more about Migration Assessment. - Extract data from your existing SAP Process Orchestration system - Migration is currently supported for the following versions of SAP Process Orchestration: + - Supported integration scenarios: - - 7.31 SP28 and above + - Integrated configurations + - Dual-stack scenarios - - 7.40 SP23 and above + - Supported SAP Process Orchestration system versions: + + - 7.31 SP28 and above + + - 7.40 SP23 and above + + - 7.50 SP06 and above - - 7.50 SP06 and above - Evaluate the extracted data -- Estimate the potential effort of migrating your integrated configuration objects from your SAP Process Orchestration system to SAP Integration Suite +- Estimate the potential effort of migrating your integration scenarios objects from your SAP Process Orchestration system to SAP Integration Suite > ### Note: > Migration Assessment focuses on the extraction and assessment of your data. > -> The actual migration tooling, which migrates your integrated configuration objects from SAP Process Orchestration to integration flows in SAP Integration Suite, is part of the Cloud Integration capability. See [Migration Tooling](migration-tooling-6061016.md). +> The actual migration tooling, which migrates your integration scenarios objects from SAP Process Orchestration to integration flows in SAP Integration Suite, is part of the Cloud Integration capability. See [Migration Tooling](migration-tooling-6061016.md). diff --git a/docs/ISuite/what-is-sap-integration-suite-5cc6987.md b/docs/ISuite/what-is-sap-integration-suite-5cc6987.md index 6a9bdf8e..49da2a4b 100644 --- a/docs/ISuite/what-is-sap-integration-suite-5cc6987.md +++ b/docs/ISuite/what-is-sap-integration-suite-5cc6987.md @@ -28,6 +28,8 @@ SAP Integration Suite is an industry-leading and enterprise-grade integration pl > ### Tip: > Contextual help is available for some screens of the SAP Integration Suite. To activate this help, from the top toolbar, choose Help. A panel with help topics opens alongside your current screen to your right. You will also find green Help icons on the screen. Choose these icons to know more about the associated element. +> +> The following GIF shows how you can interact with the contextual help:![](images/SAP_Companion_GIF_8122beb.gif) @@ -151,6 +153,17 @@ Offer, consume, and maintain data space assets with Data Space Integration. +
+ +Access Data In SAP Business Suite + +
+
+ +Access business data in the SAP Business Suite with OData Provisioning. + + +
diff --git a/docs/ISuite/what-s-new-for-sap-integration-suite-79cd682.md b/docs/ISuite/what-s-new-for-sap-integration-suite-79cd682.md new file mode 100644 index 00000000..720234c3 --- /dev/null +++ b/docs/ISuite/what-s-new-for-sap-integration-suite-79cd682.md @@ -0,0 +1,27 @@ + + + + +# What's New for SAP Integration Suite + +Learn about new and updated features in SAP Integration Suite. + + + + + +## New and Updated Features in SAP Integration Suite + +If you want to learn about the new and updated features that have been released for SAP Integration Suite and its capabilities, see [What's New for SAP Integration Suite](https://help.sap.com/whats-new/5793247a5d5741beb0decc5b7dee1160). + +> ### Tip: +> Want to stay up to date? Go to [What's New for SAP Integration Suite](https://help.sap.com/whats-new/5793247a5d5741beb0decc5b7dee1160) and choose :bell: to receive emails about new updates for SAP Integration Suite. You can also set a **filter** so you only receive emails about the capabilities that interest you. + + + + + +## Patch Release Notes + +SAP Integration Suite releases patches in irregular intervals, updating the latest version of the software. For details about the patch releases, see [Patch Release Notes for SAP Integration Suite](patch-release-notes-for-sap-integration-suite-58595b5.md). + diff --git a/docs/ISuite/working-with-api-management-321fb4d.md b/docs/ISuite/working-with-api-management-321fb4d.md index 6bacb947..2453f449 100644 --- a/docs/ISuite/working-with-api-management-321fb4d.md +++ b/docs/ISuite/working-with-api-management-321fb4d.md @@ -40,7 +40,7 @@ Components of API Management diff --git a/docs/apim/API-Management/APIM-Initial-Setup/accessing-api-management-apis-programmatically-24a2c37.md b/docs/apim/API-Management/APIM-Initial-Setup/accessing-api-management-apis-programmatically-24a2c37.md index e23bc25c..09b3da21 100644 --- a/docs/apim/API-Management/APIM-Initial-Setup/accessing-api-management-apis-programmatically-24a2c37.md +++ b/docs/apim/API-Management/APIM-Initial-Setup/accessing-api-management-apis-programmatically-24a2c37.md @@ -379,8 +379,6 @@ In the REST Console: **Related Information** -[Accessing API business hub enterprise APIs Programmatically](accessing-api-business-hub-enterprise-apis-programmatically-dabee6e.md "The devportal-apiaccess plan allows you to access the API business hub enterprise APIs to programmatically onboard developers, create applications, and more.") - [Managing Cloud Foundry Microservices through API Management](managing-cloud-foundry-microservices-through-api-management-e609a3e.md "The apim-as-route-service plan helps you in managing Cloud Foundry applications by including policies such as rate limit, quota. The service instance you create through this plan allows you to bind to the route service and creates an API Proxy. This API Proxy serves in establishing a secure connection with your Cloud Foundry application and all the calls made to the Cloud Foundry application are routed via API Management, API portal.") [Accessing On-Premise Systems through API Management](accessing-on-premise-systems-through-api-management-2fc7a5b.md "The on-premise-connectivity plan helps in achieving principal propagation while connecting to an on-premise backend system.") diff --git a/docs/apim/API-Management/APIM-Initial-Setup/accessing-api-business-hub-enterprise-apis-programmatically-dabee6e.md b/docs/apim/API-Management/APIM-Initial-Setup/accessing-developer-hub-apis-programmatically-dabee6e.md similarity index 73% rename from docs/apim/API-Management/APIM-Initial-Setup/accessing-api-business-hub-enterprise-apis-programmatically-dabee6e.md rename to docs/apim/API-Management/APIM-Initial-Setup/accessing-developer-hub-apis-programmatically-dabee6e.md index 1e1f5dcd..72dd3085 100644 --- a/docs/apim/API-Management/APIM-Initial-Setup/accessing-api-business-hub-enterprise-apis-programmatically-dabee6e.md +++ b/docs/apim/API-Management/APIM-Initial-Setup/accessing-developer-hub-apis-programmatically-dabee6e.md @@ -1,8 +1,8 @@ -# Accessing API business hub enterprise APIs Programmatically +# Accessing Developer Hub APIs Programmatically -The *devportal-apiaccess* plan allows you to access the API business hub enterprise APIs to programmatically onboard developers, create applications, and more. +The *devportal-apiaccess* plan allows you to access the Developer Hub APIs to programmatically onboard developers, create applications, and more. @@ -12,7 +12,7 @@ The *devportal-apiaccess* plan allows you to access the API business hub enterpr The service key, consisting of url \(application url\), clientId, clientSecret, and tokenUrl is used to generate a bearer token with the help of a REST client. This bearer token, along with the application url and API endpoint, is used to trigger the APIs. -This topic explains how to enable API access for API business hub enterprise. +This topic explains how to enable API access for Developer Hub. @@ -20,10 +20,10 @@ This topic explains how to enable API access for API business hub enterprise. ## Prerequisites -- If you've enabled API Management capability using Integration suite, ensure that you've also enabled API business hub enterprise in Integration suite. For more information, refer [Subscribing to Integration Suite](https://help.sap.com/docs/SAP_INTEGRATION_SUITE/51ab953548be4459bfe8539ecaeee98d/8a3c8b7a6b1c4f249bb81d11644ef806.html?version=CLOUD) and [Activating Capabilities](https://help.sap.com/docs/SAP_INTEGRATION_SUITE/51ab953548be4459bfe8539ecaeee98d/2ffb343c163c48a4b3a90f9f3c487328.html?version=CLOUD). To access API business hub enterprise from Integration Suite, select API business hub enterprise from the *Navigation Links* on the header. +- If you've enabled API Management capability using Integration suite, ensure that you've also enabled Developer Hub in Integration suite. For more information, refer [Subscribing to Integration Suite](https://help.sap.com/docs/SAP_INTEGRATION_SUITE/51ab953548be4459bfe8539ecaeee98d/8a3c8b7a6b1c4f249bb81d11644ef806.html?version=CLOUD) and [Activating Capabilities](https://help.sap.com/docs/SAP_INTEGRATION_SUITE/51ab953548be4459bfe8539ecaeee98d/2ffb343c163c48a4b3a90f9f3c487328.html?version=CLOUD). To access Developer Hub from Integration Suite, select Developer Hub from the *Navigation Links* on the header. > ### Note: - > Please ensure that you can access API business hub enterprise before creating an instance. + > Please ensure that you can access Developer Hub before creating an instance. - You have the `space developer` role assigned to you. - You have created a service instance under the *Authorization and Trust Management* tile. @@ -78,20 +78,20 @@ This topic explains how to enable API access for API business hub enterprise. -## Creating a Service Instance in the API Management, API business hub enterprise +## Creating a Service Instance in the API Management, Developer Hub Create a service instance using *devportal-apiaccess* plan. 1. In your web browser, open the *SAP BTP Cockpit* - [https://account.hana.ondemand.com/cockpit](https://account.hana.ondemand.com/cockpit). 2. From your *Subaccount*, navigate to *Spaces* in your Cloud Foundry environment and choose *Services* \> *Service Marketplace.* -3. Choose **API Management, API business hub enterprise**, *Instances* \> *New Instance*. +3. Choose **API Management, Developer Hub**, *Instances* \> *New Instance*. 4. In the *Create Instance* dialog that opens, choose *devportal-apiaccess*. 5. Click *Next*. 6. In the section *Specify parameters*, provide the details as mentioned below, based on the role you require. - The roles that support API access in the API business hub enterprise are `AuthGroup.API.Admin`, `AuthGroup.Content.Admin`, and `AuthGroup.API.ApplicationDeveloper`. + The roles that support API access in the Developer Hub are `AuthGroup.API.Admin`, `AuthGroup.Content.Admin`, and `AuthGroup.API.ApplicationDeveloper`. - Create a service instance with the `AuthGroup.API.Admin` role to access the API business hub enterprise APIs \(applications and attributes, API packages, API proxies and products, app developer and metering\), and perform operations like create, update, and delete on various API business hub enterprise entities as specified in the [Business Accelerator Hub](https://api.sap.com/package/APIMgmt?section=Artifacts). + Create a service instance with the `AuthGroup.API.Admin` role to access the Developer Hub APIs \(applications and attributes, API packages, API proxies and products, app developer and metering\), and perform operations like create, update, and delete on various Developer Hub entities as specified in the [Business Accelerator Hub](https://api.sap.com/package/APIMgmt?section=Artifacts). ``` @@ -101,7 +101,7 @@ Create a service instance using *devportal-apiaccess* plan. ``` - Create a service instance with the `AuthGroup.Content.Admin` role to manage the domain categories in API business hub enterprise and add the related products into relevant categories. + Create a service instance with the `AuthGroup.Content.Admin` role to manage the domain categories in Developer Hub and add the related products into relevant categories. ``` { @@ -110,7 +110,7 @@ Create a service instance using *devportal-apiaccess* plan. ``` - Create a service instance with the `AuthGroup.API.ApplicationDeveloper` role to access the API business hub enterprise APIs \(applications, API packages, and API proxies and products\), and perform operations like create, update, and delete on variousAPI business hub enterprise entities as specified in the [Business Accelerator Hub](https://api.sap.com/package/APIMgmt?section=Artifacts). + Create a service instance with the `AuthGroup.API.ApplicationDeveloper` role to access the Developer Hub APIs \(applications, API packages, and API proxies and products\), and perform operations like create, update, and delete on variousDeveloper Hub entities as specified in the [Business Accelerator Hub](https://api.sap.com/package/APIMgmt?section=Artifacts). ``` @@ -125,18 +125,18 @@ Create a service instance using *devportal-apiaccess* plan. > > Providing an invalid or an empty `developerId` throws an error in the service instance creation process. > - > To successfully create an application via the API business hub enterprise, you must provide a valid `developerId`. This means that you must have already registered as an application developer to the API Management, API business hub enterprise service or you must have been onboarded by your adminstrator. + > To successfully create an application via the Developer Hub, you must provide a valid `developerId`. This means that you must have already registered as an application developer to the API Management, Developer Hub service or you must have been onboarded by your adminstrator. > - > - If you have registered to the API Management, API business hub enterprise application, provide your `developerId`. + > - If you have registered to the API Management, Developer Hub application, provide your `developerId`. > > 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](../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). + > - If you have not registered to the API Management, Developer Hub application, follow the steps in [Register on Developer Hub](../register-on-developer-hub-c85fafe.md) and try again. + > - If you are not registered to the API Management, Developer Hub 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`**: > - > - If you are a registered developer in the API business hub enterprise, access the following URL in your browser to obtain your `developerId`: + > - If you are a registered developer in the Developer Hub, access the following URL in your browser to obtain your `developerId`: > > ``` > https://devportal-url/api/1.0/user @@ -168,7 +168,7 @@ Create a service instance using *devportal-apiaccess* plan. > ``` > > - > **Limitation**: Self-service onboarding request is not supported for a developer. So, the POST operation under the **API business hub enterprise- Registering Users** tile in the [API Business Hub](https://api.sap.com/api/DevPortal_RegisteringUsers/resource) cannot be made by the application developer service key. As an alternative, you can invoke this API using the admin service key. + > **Limitation**: Self-service onboarding request is not supported for a developer. So, the POST operation under the **Developer Hub- Registering Users** tile in the [API Business Hub](https://api.sap.com/api/DevPortal_RegisteringUsers/resource) cannot be made by the application developer service key. As an alternative, you can invoke this API using the admin service key. 7. In the section *Confirm*, enter a unique *Instance Name*, and choose *Finish*. @@ -405,7 +405,7 @@ The credentials like url, tokenUrl, developerId \(for developer role\), clientId - The clientId and clientSecret are necessary credentials required to fetch the Bearer Token. - The tokenUrl is used to fetch the Bearer Token. -Make a note of these credentials as you will need them in the next steps to obtain a bearer token, in order to access the API business hub enterprise APIs. +Make a note of these credentials as you will need them in the next steps to obtain a bearer token, in order to access the Developer Hub APIs. > ### Note: > Once your client is setup you can use it to authenticate against the x509 endpoint by providing the client certificate and key. @@ -446,7 +446,7 @@ Make a note of these credentials as you will need them in the next steps to obta -## Updating a Service Instance in the API Management, API business hub enterprise +## Updating a Service Instance in the API Management, Developer Hub You can update an already provisioned service instance of an API access plan by performing the following steps: @@ -479,19 +479,10 @@ In the REST client: 3. Similarly, paste the *clientId* and *clientSecret* in the place of `Username` and `Password`. 4. Make a POST Call. 5. Obtain the Bearer Token from the output and copy it in a notepad. - - Now, to trigger an API, in the same REST client, append the API endpoint \(obtained from the API business hub enterprise APIs that are located in the SAP API Management package of SAP Business Hub Acclerator\) to the *url*. + - Now, to trigger an API, in the same REST client, append the API endpoint \(obtained from the Developer Hub APIs that are located in the SAP API Management package of SAP Business Hub Acclerator\) to the *url*. - Choose `Bearer Token` as the `Authorization` type and paste the copied Bearer Token in the specified space. - Include payloads, if needed. - Make an API call. -**Related Information** - - -[Accessing API Management APIs Programmatically](accessing-api-management-apis-programmatically-24a2c37.md "The apiportal-apiaccess plan offers external applications the ability to access the public APIs of the Integration Suite API Management capability. These APIs are used by the external applications to perform CRUD operations on API Management features like API proxies or products. These APIs are built on REST and OData principles and are extensively documented on the SAP Business Accelerator Hub.") - -[Managing Cloud Foundry Microservices through API Management](managing-cloud-foundry-microservices-through-api-management-e609a3e.md "The apim-as-route-service plan helps you in managing Cloud Foundry applications by including policies such as rate limit, quota. The service instance you create through this plan allows you to bind to the route service and creates an API Proxy. This API Proxy serves in establishing a secure connection with your Cloud Foundry application and all the calls made to the Cloud Foundry application are routed via API Management, API portal.") - -[Accessing On-Premise Systems through API Management](accessing-on-premise-systems-through-api-management-2fc7a5b.md "The on-premise-connectivity plan helps in achieving principal propagation while connecting to an on-premise backend system.") - 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 9e16344c..945975a3 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 @@ -315,7 +315,5 @@ You can use the credentials to establish: [Accessing API Management APIs Programmatically](accessing-api-management-apis-programmatically-24a2c37.md "The apiportal-apiaccess plan offers external applications the ability to access the public APIs of the Integration Suite API Management capability. These APIs are used by the external applications to perform CRUD operations on API Management features like API proxies or products. These APIs are built on REST and OData principles and are extensively documented on the SAP Business Accelerator Hub.") -[Accessing API business hub enterprise APIs Programmatically](accessing-api-business-hub-enterprise-apis-programmatically-dabee6e.md "The devportal-apiaccess plan allows you to access the API business hub enterprise APIs to programmatically onboard developers, create applications, and more.") - [Managing Cloud Foundry Microservices through API Management](managing-cloud-foundry-microservices-through-api-management-e609a3e.md "The apim-as-route-service plan helps you in managing Cloud Foundry applications by including policies such as rate limit, quota. The service instance you create through this plan allows you to bind to the route service and creates an API Proxy. This API Proxy serves in establishing a secure connection with your Cloud Foundry application and all the calls made to the Cloud Foundry application are routed via API Management, API portal.") diff --git a/docs/apim/API-Management/APIM-Initial-Setup/approve-the-pending-connection-requests-e296f80.md b/docs/apim/API-Management/APIM-Initial-Setup/approve-the-pending-connection-requests-e296f80.md index 5a3779ab..ea08c028 100644 --- a/docs/apim/API-Management/APIM-Initial-Setup/approve-the-pending-connection-requests-e296f80.md +++ b/docs/apim/API-Management/APIM-Initial-Setup/approve-the-pending-connection-requests-e296f80.md @@ -4,7 +4,7 @@ # Approve the Pending Connection Requests -As an API business hub enterprise administrator, you must approve or reject the connection request after you receive them. +As an Developer Hub administrator, you must approve or reject the connection request after you receive them. @@ -25,9 +25,9 @@ The following roles must be assigned to you: ## Procedure -1. Log on to the **API business hub enterprise**. +1. Log on to the **Developer Hub**. -2. Navigate to the *Enterprise Manager* \> *API Management Connections* and choose *Pending Requests*. +2. Navigate to the *Admin Center* \> *API Management Connections* and choose *Pending Requests*. The connection requests that are pending for approval are listed on the *Pending Requests* page. @@ -42,5 +42,5 @@ The following roles must be assigned to you: ## Results -The connection has been set up between the Integration Suite API Management tenant and the API business hub enterprise. +The connection has been set up between the Integration Suite API Management tenant and the Developer Hub. diff --git a/docs/apim/API-Management/APIM-Initial-Setup/assigning-role-collections-to-users-80bb02e.md b/docs/apim/API-Management/APIM-Initial-Setup/assigning-role-collections-to-users-80bb02e.md index 480d75b5..baf6f10c 100644 --- a/docs/apim/API-Management/APIM-Initial-Setup/assigning-role-collections-to-users-80bb02e.md +++ b/docs/apim/API-Management/APIM-Initial-Setup/assigning-role-collections-to-users-80bb02e.md @@ -30,7 +30,7 @@ Role collections enable you to group together the roles you create. The role col [Set Up API Portal Application](set-up-api-portal-application-29c281b.md "To create APIs, products, import policy templates, and view applications, set up the API portal application.") -[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 discover, consume and monitor API from a centralized API catalog, set up the API business hub enterprise application.") +[Set Up Developer Hub Application Using the Standalone Tile](set-up-developer-hub-application-using-the-standalone-tile-80c0519.md "To discover, consume and monitor API from a centralized API catalog, set up the Developer Hub application.") [Shadow Users](shadow-users-a0f5fe5.md "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.") diff --git a/docs/apim/API-Management/APIM-Initial-Setup/cancel-api-management-service-subscription-df6df2b.md b/docs/apim/API-Management/APIM-Initial-Setup/cancel-api-management-service-subscription-df6df2b.md index 7880ca58..e7a0f95b 100644 --- a/docs/apim/API-Management/APIM-Initial-Setup/cancel-api-management-service-subscription-df6df2b.md +++ b/docs/apim/API-Management/APIM-Initial-Setup/cancel-api-management-service-subscription-df6df2b.md @@ -14,7 +14,7 @@ You can deactivate your API Management capability from Integration Suite to disa **Prequisite**: The *Integration\_Provisioner* role must be assigned to you. -If you've enabled the API Management capability via Integration Suite, perform the following steps to cancel the API portal and the API business hub enterprise subscriptions: +If you've enabled the API Management capability via Integration Suite, perform the following steps to cancel the API portal and the Developer Hub subscriptions: 1. Log on to SAP BTP Cockpit and navigate to your subaccount. @@ -32,6 +32,6 @@ If you've enabled the API Management capability via Integration Suite, perform t The *Deactivate API Management* confirmation dialog appears. -6. Once you choose *Deactivate*, the *API Management, API Portal* and **API Management, API business hub enterprise** applications are deactivated. +6. Once you choose *Deactivate*, the *API Management, API Portal* and **API Management, Developer Hub** applications are deactivated. diff --git a/docs/apim/API-Management/APIM-Initial-Setup/centralized-api-business-hub-enterprise-38422de.md b/docs/apim/API-Management/APIM-Initial-Setup/centralized-api-business-hub-enterprise-38422de.md deleted file mode 100644 index 3b1dfaef..00000000 --- a/docs/apim/API-Management/APIM-Initial-Setup/centralized-api-business-hub-enterprise-38422de.md +++ /dev/null @@ -1,20 +0,0 @@ - - -# 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. - -If you have enabled API business hub enterprise and API Management tenant in the same Integration Suite sub-account, they will automatically connect to each other. - -> ### Note: -> Once this connection is established, you will not be able to connect the API Management tenant to any other API business hub enterprise enabled in a different sub-account. However, if you have not enabled API business hub enterprise in the same Integration Suite sub-account where you have enabled API Management tenant, you can connect this API Management tenant to an API business hub enterprise enabled in another sub-account and designate it as a centralized API business hub enterprise. -> -> This centralized API business hub enterprise can be used to establish connections with multiple API Management tenants and can receive API proxies, API products, and other assets from each connected API Management tenants. It is important to ensure that all assets published to the centralized API business hub enterprise are unique. - -> ### Remember: -> You can configure multipleIntegration Suite API Management tenants to cater to different stages of the API lifecycle. For example, you can have separate instances for development, testing, and production. However, connecting these API Management tenants having such a relationship to the same API business hub enterprise will violate the uniquness of the assets. - -Once the application developers register with the centralized API business hub enterprise, they can easily search, explore, and test APIs. They can also create and subscribe to specific types of applications available from the API business hub enterprise. - -The API business hub enterprise admin identifies which existing or new API business hub enterprise application can accept content from multiple Integration Suite API Management tenants. - diff --git a/docs/apim/API-Management/APIM-Initial-Setup/centralized-developer-hub-38422de.md b/docs/apim/API-Management/APIM-Initial-Setup/centralized-developer-hub-38422de.md new file mode 100644 index 00000000..64a75b0a --- /dev/null +++ b/docs/apim/API-Management/APIM-Initial-Setup/centralized-developer-hub-38422de.md @@ -0,0 +1,20 @@ + + +# Centralized Developer Hub + +The Developer Hub is a central API catalog, allowing application developers to consume APIs and other assets, from a common platform. + +If you have enabled Developer Hub and API Management tenant in the same Integration Suite sub-account, they will automatically connect to each other. + +> ### Note: +> Once this connection is established, you will not be able to connect the API Management tenant to any other Developer Hub enabled in a different sub-account. However, if you have not enabled Developer Hub in the same Integration Suite sub-account where you have enabled API Management tenant, you can connect this API Management tenant to an Developer Hub enabled in another sub-account and designate it as a centralized Developer Hub. +> +> This centralized Developer Hub can be used to establish connections with multiple API Management tenants and can receive API proxies, API products, and other assets from each connected API Management tenants. It is important to ensure that all assets published to the centralized Developer Hub are unique. + +> ### Remember: +> You can configure multipleIntegration Suite API Management tenants to cater to different stages of the API lifecycle. For example, you can have separate instances for development, testing, and production. However, connecting these API Management tenants having such a relationship to the same Developer Hub will violate the uniquness of the assets. + +Once the application developers register with the centralized Developer Hub, they can easily search, explore, and test APIs. They can also create and subscribe to specific types of applications available from the Developer Hub. + +The Developer Hub admin identifies which existing or new Developer Hub application can accept content from multiple Integration Suite API Management tenants. + diff --git a/docs/apim/API-Management/APIM-Initial-Setup/create-a-connection-request-for-the-centralized-api-business-hub-enterprise-c7bda8c.md b/docs/apim/API-Management/APIM-Initial-Setup/create-a-connection-request-for-the-centralized-developer-hub-c7bda8c.md similarity index 68% rename from docs/apim/API-Management/APIM-Initial-Setup/create-a-connection-request-for-the-centralized-api-business-hub-enterprise-c7bda8c.md rename to docs/apim/API-Management/APIM-Initial-Setup/create-a-connection-request-for-the-centralized-developer-hub-c7bda8c.md index 12711ced..8c642268 100644 --- a/docs/apim/API-Management/APIM-Initial-Setup/create-a-connection-request-for-the-centralized-api-business-hub-enterprise-c7bda8c.md +++ b/docs/apim/API-Management/APIM-Initial-Setup/create-a-connection-request-for-the-centralized-developer-hub-c7bda8c.md @@ -1,8 +1,8 @@ -# Create a Connection Request for the Centralized API business hub enterprise +# Create a Connection Request for the Centralized Developer Hub -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. +Create a request to connect the Integration Suite API Management tenant to the Developer Hub. You need to establish this connection to publish the content of the Integration Suite API Management tenant on the Developer Hub. @@ -10,9 +10,9 @@ Create a request to connect the Integration Suite API Management tenant to the A ## 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 connections between the Developer Hub and Integration Suite API Management tenants, a Cloud Foundry space should be created in the sub-account from where the Developer Hub 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 API portal. +- To establish a connection between an Integration Suite API Management tenant and the centralised Developer Hub which is available in a different sub-account, you must ensure that the Developer Hub capability is not enabled in the same sub-account as that of the API portal. - The following role collections should be assigned to you: - AuthGroup.API.Admin @@ -32,7 +32,7 @@ Create a request to connect the Integration Suite API Management tenant to the A 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. + 4. Follow the onscreen instructions under **Connect the API Portal to the centralized Developer Hub** to generate the Integration Suite API Management tenant access credentials. > ### Note: @@ -45,25 +45,25 @@ Create a request to connect the Integration Suite API Management tenant to the A ## 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. +The Developer Hub administrator identifies which existing or new Developer Hub application can accept content from multiple Integration Suite API Management tenants. > ### Note: -> Only new Integration Suite subscriptions with API Management capability enabled with the Integration Suite are allowed to set up a connection with the centralized API business hub enterprise. +> Only new Integration Suite subscriptions with API Management capability enabled with the Integration Suite are allowed to set up a connection with the centralized Developer Hub. > ### Note: -> You can connect a maximum number of three Integration Suite API portals to the centralized API business hub enterprise. +> You can connect a maximum number of three Integration Suite API portals to the centralized Developer Hub. 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. +For the newly set up Integration Suite API Management tenant, you can request for the Developer Hub 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. +> The option to disconnect an Integration Suite API Management tenant from an existing Developer Hub 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. +> 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 Developer Hub. -To create a request to connect the Integration Suite API Management tenant to the centralized API business hub enterprise. +To create a request to connect the Integration Suite API Management tenant to the centralized Developer Hub. @@ -71,7 +71,7 @@ To create a request to connect the Integration Suite API Management tenant to th ## Procedure -1. Log on to the **API business hub enterprise**. +1. Log on to the **Developer Hub**. 2. Navigate to the *Admin Center* \> *Manage Connections* and choose *Approved Requests*. @@ -101,7 +101,7 @@ To create a request to connect the Integration Suite API Management tenant to th @@ -113,7 +113,7 @@ To create a request to connect the Integration Suite API Management tenant to th
-Use this role during the onboarding of API business hub enterprise and to get access to it. +Use this role during the onboarding of Developer Hub and to get access to it.
-This role is necessary for creating a connection request between the Integration Suite API Management tenant and the API business hub enterprise. It's also used to update the connection request credentials. +This role is necessary for creating a connection request between the Integration Suite API Management tenant and the Developer Hub. It's also used to update the connection request credentials.
-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). +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, Developer Hub, API Analytics and API Designer. For more information, see [Components of API Management](components-of-api-management-e02ae53.md).
- 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. + Enter the Integration Suite API Management tenant name that gets displayed on the Developer Hub. This name is used to distinguish products that are published from the API portal and likewise for applications created for the product.
- 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. + Enter the Integration Suite API Management tenant access credentials that you generated earlier. These credentials are used by the Developer Hub to establish the connection. Sample credentials: @@ -149,7 +149,7 @@ To create a request to connect the Integration Suite API Management tenant to th
- 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. + 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 Developer Hub. @@ -169,7 +169,7 @@ To create a request to connect the Integration Suite API Management tenant to th ## 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. +You've submitted the connection request to the Developer Hub administrator. Once the connection request is approved by the administrator, you can start publishing the Integration Suite API Management tenant content to the Developer Hub. > ### Note: > You can log on to the Integration Suite API Management tenant and check the connection status. Navigate to *Settings* \> *APIs* and choose *Connection*. diff --git a/docs/apim/API-Management/APIM-Initial-Setup/creating-a-custom-role-9d827cd.md b/docs/apim/API-Management/APIM-Initial-Setup/creating-a-custom-role-9d827cd.md index 314f633c..cecf441a 100644 --- a/docs/apim/API-Management/APIM-Initial-Setup/creating-a-custom-role-9d827cd.md +++ b/docs/apim/API-Management/APIM-Initial-Setup/creating-a-custom-role-9d827cd.md @@ -27,7 +27,7 @@ You can restrict access to an API product in API Management using a custom role. 2. Choose *Service Marketplace* in the left-hand pane. -3. In order to create a custom role, choose **API Management, API business hub enterprise** tile. +3. In order to create a custom role, choose **API Management, Developer Hub** tile. 4. Under *Application Plans* for API BusinessHub Enterprise, choose the Action icon and select *Manage Roles*. @@ -79,7 +79,7 @@ You can restrict access to an API product in API Management using a custom role. > ### Remember: - > Application Developers who are already onboarded in the API business hub enterprise should have the custom role. If any user has been assigned a custom role but hasn’t been onboarded as an application developer in the API business hub enterprise, the application creation fails. In this case, Authgroup.API.Admin can onboard the user as an Application Developer in the portal. + > Application Developers who are already onboarded in the Developer Hub should have the custom role. If any user has been assigned a custom role but hasn’t been onboarded as an application developer in the Developer Hub, the application creation fails. In this case, Authgroup.API.Admin can onboard the user as an Application Developer in the portal. **Next Steps** 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-developer-hub-subscription-c4e67a9.md similarity index 79% rename from docs/apim/API-Management/APIM-Initial-Setup/custom-domain-configuration-for-api-portal-or-api-business-hub-enterprise-subsc-c4e67a9.md rename to docs/apim/API-Management/APIM-Initial-Setup/custom-domain-configuration-for-api-portal-or-developer-hub-subscription-c4e67a9.md index 813ad84c..a8c09559 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-developer-hub-subscription-c4e67a9.md @@ -1,8 +1,8 @@ -# Custom Domain Configuration for API Portal or API business hub enterprise Subscription +# Custom Domain Configuration for API Portal or Developer Hub Subscription -To complete the process of configuring a custom domain for the API portal or the API business hub enterprise application using the Custom Domain Service in the SAP BTP Cloud Foundry environment, you need to contact the SAP API Management operations team. +To complete the process of configuring a custom domain for the API portal or the Developer Hub application using the Custom Domain Service in the SAP BTP Cloud Foundry environment, you need to contact the SAP API Management operations team. > ### 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. @@ -47,10 +47,10 @@ When submitting the incident, include the following information: - Subdomain of the current account -- Application: API Portal/ API business hub enterprise +- Application: API Portal/ Developer Hub - Custom domain URL \(the host name for the URL\) -- API Portal/API business hub enterprise URL +- API Portal/Developer Hub URL diff --git a/docs/apim/API-Management/APIM-Initial-Setup/developer-hub-3500bc5.md b/docs/apim/API-Management/APIM-Initial-Setup/developer-hub-3500bc5.md new file mode 100644 index 00000000..69af24d6 --- /dev/null +++ b/docs/apim/API-Management/APIM-Initial-Setup/developer-hub-3500bc5.md @@ -0,0 +1,12 @@ + + +# Developer Hub + +The Developer Hub 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 and then publishing it on the Developer Hub. This allows you to expose one or more API proxies to application developers. Furthermore, content administrators on theDeveloper Hub 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 Developer Hub 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. + diff --git a/docs/apim/API-Management/APIM-Initial-Setup/initial-setup-65c5110.md b/docs/apim/API-Management/APIM-Initial-Setup/initial-setup-65c5110.md index dfee5863..25add8f4 100644 --- a/docs/apim/API-Management/APIM-Initial-Setup/initial-setup-65c5110.md +++ b/docs/apim/API-Management/APIM-Initial-Setup/initial-setup-65c5110.md @@ -2,7 +2,7 @@ # Initial Setup -The two applications that are provisioned are the API portal and API business hub enterprise. +The two applications that are provisioned are the API portal and Developer Hub. > ### Note: > - All activities in this section are performed by the tenant \(customer\) administrator. @@ -14,7 +14,7 @@ The two applications that are provisioned are the API portal and API business hu This section covers the following activities: - [Set Up API Portal Application](set-up-api-portal-application-29c281b.md) -- [Set Up API business hub enterprise Application Using the Standalone Tile](set-up-api-business-hub-enterprise-application-using-the-standalone-tile-80c0519.md) +- [Set Up Developer Hub Application Using the Standalone Tile](set-up-developer-hub-application-using-the-standalone-tile-80c0519.md) - [Account Members](account-members-66a7bc8.md) - [User Roles in API Management](https://help.sap.com/docs/sap-api-management/sap-api-management/roles-collections-in-api-management-draft?version=Cloud) diff --git a/docs/apim/API-Management/APIM-Initial-Setup/managing-cloud-foundry-microservices-through-api-management-e609a3e.md b/docs/apim/API-Management/APIM-Initial-Setup/managing-cloud-foundry-microservices-through-api-management-e609a3e.md index b92d817c..398cdc65 100644 --- a/docs/apim/API-Management/APIM-Initial-Setup/managing-cloud-foundry-microservices-through-api-management-e609a3e.md +++ b/docs/apim/API-Management/APIM-Initial-Setup/managing-cloud-foundry-microservices-through-api-management-e609a3e.md @@ -95,7 +95,5 @@ Open the command-line interface for Cloud Foundry and enter the following comman [Accessing API Management APIs Programmatically](accessing-api-management-apis-programmatically-24a2c37.md "The apiportal-apiaccess plan offers external applications the ability to access the public APIs of the Integration Suite API Management capability. These APIs are used by the external applications to perform CRUD operations on API Management features like API proxies or products. These APIs are built on REST and OData principles and are extensively documented on the SAP Business Accelerator Hub.") -[Accessing API business hub enterprise APIs Programmatically](accessing-api-business-hub-enterprise-apis-programmatically-dabee6e.md "The devportal-apiaccess plan allows you to access the API business hub enterprise APIs to programmatically onboard developers, create applications, and more.") - [Accessing On-Premise Systems through API Management](accessing-on-premise-systems-through-api-management-2fc7a5b.md "The on-premise-connectivity plan helps in achieving principal propagation while connecting to an on-premise backend system.") diff --git a/docs/apim/API-Management/APIM-Initial-Setup/region-specific-ip-addresses-available-for-api-management-cloud-foundry-environ-683a97c.md b/docs/apim/API-Management/APIM-Initial-Setup/region-specific-ip-addresses-available-for-api-management-cloud-foundry-environ-683a97c.md index 23eb8f99..70ec560c 100644 --- a/docs/apim/API-Management/APIM-Initial-Setup/region-specific-ip-addresses-available-for-api-management-cloud-foundry-environ-683a97c.md +++ b/docs/apim/API-Management/APIM-Initial-Setup/region-specific-ip-addresses-available-for-api-management-cloud-foundry-environ-683a97c.md @@ -1001,5 +1001,5 @@ us-east-1
> ### Note: -> If customers are implementing allow or deny listing based on IPs from their clients to API Management design time applications - API Portal, API business hub enterprise, or other platform services in Cloud Foundry, such as SAP Authorization and Trust Management Service \(XSUAA\) for fetching tokens, they will need to refer to the documentation for SAP Business Technology Platform Cloud Foundry IP addresses, which can be found at the following link: [Regions and API Endpoints Available for the Cloud Foundry Environment | SAP Help Portal](https://help.sap.com/docs/btp/sap-business-technology-platform/regions-and-api-endpoints-available-for-cloud-foundry-environment?version=Cloud). +> If customers are implementing allow or deny listing based on IPs from their clients to API Management design time applications - API Portal, Developer Hub, or other platform services in Cloud Foundry, such as SAP Authorization and Trust Management Service \(XSUAA\) for fetching tokens, they will need to refer to the documentation for SAP Business Technology Platform Cloud Foundry IP addresses, which can be found at the following link: [Regions and API Endpoints Available for the Cloud Foundry Environment | SAP Help Portal](https://help.sap.com/docs/btp/sap-business-technology-platform/regions-and-api-endpoints-available-for-cloud-foundry-environment?version=Cloud). diff --git a/docs/apim/API-Management/APIM-Initial-Setup/set-up-api-portal-application-29c281b.md b/docs/apim/API-Management/APIM-Initial-Setup/set-up-api-portal-application-29c281b.md index 731b03a2..95b6c79c 100644 --- a/docs/apim/API-Management/APIM-Initial-Setup/set-up-api-portal-application-29c281b.md +++ b/docs/apim/API-Management/APIM-Initial-Setup/set-up-api-portal-application-29c281b.md @@ -10,7 +10,7 @@ To create APIs, products, import policy templates, and view applications, set up ## Context -Depending upon the license you hold, you can set up the *API Management, API Portal* capability from the **Integration Suite** launchpad. For more information, see [Enable API Management Capability](https://help.sap.com/docs/integration-suite/sap-integration-suite/enabling-api-management-capability-from-integration-suite?version=CLOUD). You can also use the standalone tile for **API Management, API Portal** to subscribe to the API Portal application. See, [Set Up API business hub enterprise Application Using the Standalone Tile](set-up-api-business-hub-enterprise-application-using-the-standalone-tile-80c0519.md). +Depending upon the license you hold, you can set up the *API Management, API Portal* capability from the **Integration Suite** launchpad. For more information, see [Enable API Management Capability](https://help.sap.com/docs/integration-suite/sap-integration-suite/enabling-api-management-capability-from-integration-suite?version=CLOUD). You can also use the standalone tile for **API Management, API Portal** to subscribe to the API Portal application. See, [Set Up Developer Hub Application Using the Standalone Tile](set-up-developer-hub-application-using-the-standalone-tile-80c0519.md). > ### Note: > - You should either have **Integration Suite** subscription or **API Management, API Portal** tile visibility to set up the API Portal application. diff --git a/docs/apim/API-Management/APIM-Initial-Setup/set-up-api-business-hub-enterprise-application-using-the-standalone-tile-80c0519.md b/docs/apim/API-Management/APIM-Initial-Setup/set-up-developer-hub-application-using-the-standalone-tile-80c0519.md similarity index 71% rename from docs/apim/API-Management/APIM-Initial-Setup/set-up-api-business-hub-enterprise-application-using-the-standalone-tile-80c0519.md rename to docs/apim/API-Management/APIM-Initial-Setup/set-up-developer-hub-application-using-the-standalone-tile-80c0519.md index cc90cc00..01cb4fcb 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-developer-hub-application-using-the-standalone-tile-80c0519.md @@ -2,9 +2,9 @@ -# Set Up API business hub enterprise Application Using the Standalone Tile +# Set Up Developer Hub Application Using the Standalone Tile -To discover, consume and monitor API from a centralized API catalog, set up the API business hub enterprise application. +To discover, consume and monitor API from a centralized API catalog, set up the Developer Hub application. @@ -28,7 +28,7 @@ To discover, consume and monitor API from a centralized API catalog, set up the Depending upon the license you hold, you can use the *API Management, API Business Hub Enterprise* stand-alone tile to subscribe to the application. > ### Note: -> Ensure that you don’t have an instance of a starter plan created in the same subaccount where you plan to create an API business hub enterprise subscription. Also, note that the API Management capabilities from Integration Suite and API Management subscriptions using the stand-alone tile can’t coexist in the same subaccount. +> Ensure that you don’t have an instance of a starter plan created in the same subaccount where you plan to create an Developer Hub subscription. Also, note that the API Management capabilities from Integration Suite and API Management subscriptions using the stand-alone tile can’t coexist in the same subaccount. @@ -44,7 +44,7 @@ Depending upon the license you hold, you can use the *API Management, API Busine Wait for the subscription to complete successfully. -4. To access the API business hub enterprise, you must first assign the *AuthGroup.SelfService.Admin* role to yourself. +4. To access the Developer Hub, you must first assign the *AuthGroup.SelfService.Admin* role to yourself. > ### Note: > If you choose *Go to Application* without assigning the *AuthGroup.SelfService.Admin* role, an application authentication error appears. If the error persists after assigning the role, clear your web browser cache, and log out of the application and log on again. @@ -62,7 +62,7 @@ Depending upon the license you hold, you can use the *API Management, API Busine You’re navigated to the *API Business Hub Enterprise*. -6. Log on to the API business hub enterprise application with your IDP user credentials. To register to the API business hub enterprise as an Application developer, see [Register on API business hub enterprise](../register-on-api-business-hub-enterprise-c85fafe.md). +6. Log on to the Developer Hub application with your IDP user credentials. To register to the Developer Hub as an Application developer, see [Register on Developer Hub](../register-on-developer-hub-c85fafe.md). @@ -71,12 +71,12 @@ Depending upon the license you hold, you can use the *API Management, API Busine ## Results -You’re registered as an application developer on the API business hub enterprise. You can now view the products available in the catalog store. +You’re registered as an application developer on the Developer Hub. You can now view the products available in the catalog store. **Related Information** [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: -[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.") +[Consume API Proxies](../consume-api-proxies-ea561e4.md "Consume API proxies via the Developer Hub. In the Developer Hub, an application developer registers, explores the API exposed by customers, creates applications, and tests API proxies.") 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 a90e3cb3..5a554149 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 @@ -113,7 +113,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 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 Developer Hub Application Using the Standalone Tile](set-up-developer-hub-application-using-the-standalone-tile-80c0519.md). **Related Information** diff --git a/docs/apim/API-Management/APIM-Initial-Setup/updating-the-connection-request-credentials-for-a-pending-request-dd37a7b.md b/docs/apim/API-Management/APIM-Initial-Setup/updating-the-connection-request-credentials-for-a-pending-request-dd37a7b.md index 34cfc896..e4d7003a 100644 --- a/docs/apim/API-Management/APIM-Initial-Setup/updating-the-connection-request-credentials-for-a-pending-request-dd37a7b.md +++ b/docs/apim/API-Management/APIM-Initial-Setup/updating-the-connection-request-credentials-for-a-pending-request-dd37a7b.md @@ -2,7 +2,7 @@ # 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. +Update the credentials you've used to establish a connection between the Integration Suite API Management tenant and the Developer Hub. @@ -20,7 +20,7 @@ Update the credentials you've used to establish a connection between the Integra 3. Choose the *Connection* tab. - 4. Choose *Generate Credentials* under **Connect the API Portal to the centralized API business hub enterprise** and *Copy* the access credentials. + 4. Choose *Generate Credentials* under **Connect the API Portal to the centralized Developer Hub** and *Copy* the access credentials. > ### Note: @@ -48,9 +48,9 @@ If you encounter one of the following situations when your connection request is ## Procedure -1. Log on to the **API business hub enterprise**. +1. Log on to the **Developer Hub**. -2. Navigate to the *Enterprise Manager* \> *Manage Connections* and choose *Pending Requests*. +2. Navigate to the *Admin Center* \> *Manage Connections* and choose *Pending Requests*. 3. Go to the *Actions* column of the connection request that you want to edit and choose *Edit Credentials*. diff --git a/docs/apim/API-Management/APIM-Initial-Setup/updating-the-connection-request-credentials-for-an-approved-request-882e1d9.md b/docs/apim/API-Management/APIM-Initial-Setup/updating-the-connection-request-credentials-for-an-approved-request-882e1d9.md index bf136a8b..98a8717b 100644 --- a/docs/apim/API-Management/APIM-Initial-Setup/updating-the-connection-request-credentials-for-an-approved-request-882e1d9.md +++ b/docs/apim/API-Management/APIM-Initial-Setup/updating-the-connection-request-credentials-for-an-approved-request-882e1d9.md @@ -2,7 +2,7 @@ # 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. +There can be instances where you have to update the credentials once the connection request is approved by the Developer Hub admin. @@ -30,11 +30,11 @@ To update the API portal access credentials, you must first generate it. To gene ## Context -To establish the connection between the Integration Suite API Management tenant and the API business hub enterprise, the client Id and client secret created for the Integration Suite API Management tenant is shared during the connection request process. +To establish the connection between the Integration Suite API Management tenant and the Developer Hub, the client Id and client secret created for the Integration Suite 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: +If you encounter one of the following situations after the connection request has already been approved by the Developer Hub admin, you have to update the credentials: -- The service instance, or the service key gets deleted after the connection between the Integration Suite 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. +- The service instance, or the service key gets deleted after the connection between the Integration Suite API Management tenant and the Developer Hub 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 the Integration Suite API Management tenant workspace gets deleted, the credentials you were using before the destination got deleted becomes invalid. @@ -45,9 +45,9 @@ If you encounter one of the following situations after the connection request ha ## Procedure -1. Log on to the **API business hub enterprise**. +1. Log on to the **Developer Hub**. -2. Navigate to the *Enterprise Manager* \> *API Management Connections* and choose *Approved Requests*. +2. Navigate to the *Admin Center* \> *API Management Connections* and choose *Approved Requests*. The connection requests that are pending for approval are listed on the *Approved Requests* page. diff --git a/docs/apim/API-Management/APIM-Initial-Setup/user-roles-and-responsibilities-in-developer-hub-54b4607.md b/docs/apim/API-Management/APIM-Initial-Setup/user-roles-and-responsibilities-in-developer-hub-54b4607.md new file mode 100644 index 00000000..9470e160 --- /dev/null +++ b/docs/apim/API-Management/APIM-Initial-Setup/user-roles-and-responsibilities-in-developer-hub-54b4607.md @@ -0,0 +1,370 @@ + + +# User Roles and Responsibilities in Developer Hub + +After activating the Developer Hub in the Integration Suite, you need to assign users the necessary roles and role collections to access the various features and functionalities of Developer Hub. + +Once the appropriate roles have been assigned, you can configure and customize the Developer Hub to align with your organization's needs. + +Your access to various features on the Developer Hub will depend on the service plan you have subscribed to. + + + +The roles and features offered in the Standard and Premium service plans include: + +- Key Actions for Admins in Developer Hub + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + As... + + + + You can use… + + + + Important Notes + + + + For more information, see… + +
+ + An *API Admin*, you already have the *AuthGroup.API.Admin* role collection assigned to you. + + + + *Home Page* to browse and search through the various categories, APIs, and products available on the . + + + +   + + + + [Register on Developer Hub](../register-on-developer-hub-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 Developer Hub + - Monitor costs + + - Analyze reports + + + + + + + The availability of this feature is dependent on your service plan. For more information about different service plans and their supported feature set, see SAP Note [2903776](https://me.sap.com/notes/2903776). + + + + [Creating an Application with Developer Hub Administrator Role](../creating-an-application-with-developer-hub-administrator-role-df4f777.md) + +
+ + *Admin Center* \> *Manage External Content* to adjust the visibility of the Graph navigator on the Developer Hub. + + + + The availability of this feature is dependent on your service plan. For more information about different service plans and their supported feature set, see SAP Note [2903776](https://me.sap.com/notes/2903776). + + + + [Manage External Content](https://help.sap.com/docs/integration-suite/sap-integration-suite/manage-external-content-new-design?version=CLOUD&q=Exyternal%20Content) + +
+ + *Admin Center* \> *Manage Access* to control the level of access for your users, allowing them to search, discover, and access the content available on the Developer Hub. + + + +   + + + + [Manage Developer Access](../manage-developer-access-9df3ece.md) + +
+ + *Admin Center* \> *Manage Users* to add and revoke user access to the Developer Hub. + + + +   + + + + [Managing the Access Request of the Users](../managing-the-access-request-of-the-users-8b79ee8.md) + + [Revoke Access](../revoke-access-ce609bb.md) + +
+ + *Admin Center* \> *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 collection assigned to you. + + + + *Site Editor* to customize the visual layout of the Developer Hub. + + + +   + + + + [Customize the Visual Format of the Developer Hub](../customize-the-visual-format-of-the-developer-hub-2eacd52.md) + +
+ + *Admin Center* \> *Manage Notifications* to configure notifications to keep the end users of the Developer Hub informed about website updates and news items. + + + +   + + + + [Manage Notifications](../manage-notifications-df32457.md) + +
+ + A *Content Admin* you already have the *AuthGroup.Content.Admin* role collection assigned to you. + + + + *Admin Center* \> *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) + +
+ +   + + + + *Admin Center* \> *Manage Content* to create products that includes APIs from different business systems and manage the content that application developers can view on the catalog. + + + +   + + + + + +
+ +   + + + + *Admin Center* \> *Manage Content* to monitor and manage all requests for product creation and updates. + + + +   + + + + + +
+ +- Key Actions for Application Developers in Developer Hub + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + As... + + + + You can use… + + + + Important Notes + + + + For more information, see… + +
+ + An *Application Developer* you already have the *AuthGroup.API.ApplicationDeveloper* role collection assigned to you. + + > ### Note: + > The *AuthGroup.API.ApplicationDeveloper* role collection is assigned by default to a user who onboards to the Developer Hub using the Self-registration process or via *Add User* flow. + + + + + + The *Home page* to explore the product created on Developer Hub and view the APIs within the products, but you can't subscribe to them. + + + + + + + + + +
+ + *My Workspace* to create applications, view your applications, monitor costs, and analyze reports. + + + + The availability of this feature is dependent on your service plan. For more information about different service plans and their supported feature set, see SAP Note [2903776](https://me.sap.com/notes/2903776). + + + + [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. + + + + The availability of this feature is dependent on your service plan. For more information about different service plans and their supported feature set, see SAP Note [2903776](https://me.sap.com/notes/2903776). + + + + [Test Runtime Behavior of APIs](../test-runtime-behavior-of-apis-15c7d52.md) + +
+ + diff --git a/docs/apim/API-Management/APIM-Initial-Setup/user-roles-in-api-management-7010b58.md b/docs/apim/API-Management/APIM-Initial-Setup/user-roles-in-api-management-7010b58.md index f37e837c..f9c99fbd 100644 --- a/docs/apim/API-Management/APIM-Initial-Setup/user-roles-in-api-management-7010b58.md +++ b/docs/apim/API-Management/APIM-Initial-Setup/user-roles-in-api-management-7010b58.md @@ -2,7 +2,7 @@ # User Roles in API Management -Use role collections to group together different roles that can be assigned to API Portal and API business hub enterprise users. +Use role collections to group together different roles that can be assigned to API Portal and Developer Hub users. **API Portal Roles** @@ -40,7 +40,7 @@ Use this role to access the API portal user interface \(UI\) and services, manag -You need this role assigned to you because the client credentials, which are necessary for establishing a connection between the Integration Suite API Management tenant and API business hub enterprise, are generated for this role. +You need this role assigned to you because the client credentials, which are necessary for establishing a connection between the Integration Suite API Management tenant and Developer Hub, are generated for this role. @@ -70,7 +70,7 @@ Use this role to access the API portal in read-only mode. You can view all APIs, -**API business hub enterprise Roles** +**Developer Hub Roles** @@ -94,7 +94,7 @@ Description @@ -131,8 +131,8 @@ Use this role to: Use this role to: -- Publish content to the API business hub enterprise. -- Establish a connection from the API portal to the API business hub enterprise. +- Publish content to the Developer Hub. +- Establish a connection from the API portal to the Developer Hub. @@ -148,7 +148,7 @@ Use this role to: Use this role to: -- Access the API business hub enterprise. +- Access the Developer Hub. - Create, update, and delete applications. - View analytics information on application usage, performance, and error count. - View and download bills for subscribed applications. @@ -198,7 +198,7 @@ Use this role to: 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 14dc7d43..233e55dc 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 @@ -107,7 +107,7 @@ By enabling this feature, you can explicitly clone the API proxies mentioned in Ensure that you don’t modify the name of the `apim-tct-input.json` file. - For more information on how to create the service key, refer the [Accessing API Management APIs Programmatically](../APIM-Initial-Setup/accessing-api-management-apis-programmatically-24a2c37.md) and [Accessing API business hub enterprise APIs Programmatically](../APIM-Initial-Setup/accessing-api-business-hub-enterprise-apis-programmatically-dabee6e.md). + For more information on how to create the service key, refer the [Accessing API Management APIs Programmatically](../APIM-Initial-Setup/accessing-api-management-apis-programmatically-24a2c37.md) and [Accessing Developer Hub APIs Programmatically](../APIM-Initial-Setup/accessing-developer-hub-apis-programmatically-dabee6e.md). **Structure of the apim-tct-input.json file:** @@ -956,7 +956,7 @@ By enabling this feature, you can explicitly clone the API proxies mentioned in diff --git a/docs/apim/API-Management/APIM-Migration/clone-api-management-content-between-cloud-foundry-environments-2e5d127.md b/docs/apim/API-Management/APIM-Migration/clone-api-management-content-between-cloud-foundry-environments-2e5d127.md index 59f88613..d1427d7f 100644 --- a/docs/apim/API-Management/APIM-Migration/clone-api-management-content-between-cloud-foundry-environments-2e5d127.md +++ b/docs/apim/API-Management/APIM-Migration/clone-api-management-content-between-cloud-foundry-environments-2e5d127.md @@ -107,7 +107,7 @@ By enabling this feature, you can explicitly clone the API proxies mentioned in Ensure that you don’t modify the name of the `apim-tct-input.json` file. - For more information on how to create the service key, refer the [Accessing API Management APIs Programmatically](../APIM-Initial-Setup/accessing-api-management-apis-programmatically-24a2c37.md) and [Accessing API business hub enterprise APIs Programmatically](../APIM-Initial-Setup/accessing-api-business-hub-enterprise-apis-programmatically-dabee6e.md). + For more information on how to create the service key, refer the [Accessing API Management APIs Programmatically](../APIM-Initial-Setup/accessing-api-management-apis-programmatically-24a2c37.md) and [Accessing Developer Hub APIs Programmatically](../APIM-Initial-Setup/accessing-developer-hub-apis-programmatically-dabee6e.md). **Structure of the apim-tct-input.json file:** @@ -967,7 +967,7 @@ By enabling this feature, you can explicitly clone the API proxies mentioned in @@ -999,7 +999,7 @@ By enabling this feature, you can explicitly clone the API proxies mentioned in @@ -1026,7 +1026,7 @@ By enabling this feature, you can explicitly clone the API proxies mentioned in @@ -285,7 +285,7 @@ For detailed information regarding policy types, see [Policy Types](https://help
-Use this role during the onboarding of API business hub enterprise and to get access to it. +Use this role during the onboarding of Developer Hub and to get access to it.
-This role is necessary for creating a connection request between the Integration Suite API Management tenant and the API business hub enterprise. It's also used to update the connection request credentials. +This role is necessary for creating a connection request between the Integration Suite API Management tenant and the Developer Hub. It's also used to update the connection request credentials.
- Token url received during creation of the service key for API business hub enterprise API access for the `AuthGroup.API.Admin` role. + Token url received during creation of the service key for Developer Hub API access for the `AuthGroup.API.Admin` role.
- URL received during creation of the service key for API business hub enterprise API access for the `AuthGroup.API.Admin` role. + URL received during creation of the service key for Developer Hub API access for the `AuthGroup.API.Admin` role.
- Token url received during creation of the service key for API business hub enterprise API access for the `AuthGroup.API.Admin` role. + Token url received during creation of the service key for Developer Hub API access for the `AuthGroup.API.Admin` role.
- The client ID received during creation of the service key for API business hub enterprise API access for the `AuthGroup.API.Admin` role. + The client ID received during creation of the service key for Developer Hub API access for the `AuthGroup.API.Admin` role. You’re prompted to enter these values while running the command in Step 3 if you haven’t already provided these details in the `apim-tct-input.json` file. @@ -1055,7 +1055,7 @@ By enabling this feature, you can explicitly clone the API proxies mentioned in - The client secret received during creation of the service key for API business hub enterprise API access for the `AuthGroup.API.Admin` role. + The client secret received during creation of the service key for Developer Hub API access for the `AuthGroup.API.Admin` role. You’re prompted to enter these values while running the command in Step 3 if you haven’t already provided these details in the `apim-tct-input.json` file. @@ -1302,8 +1302,8 @@ By enabling this feature, you can explicitly clone the API proxies mentioned in - - The default value for skip-devportal is false, and API business hub enterprise entities are cloned. - - If you set the value for skip-devportal to true, no cloning of the API business hub enterprise entities takes place. + - The default value for skip-devportal is false, and Developer Hub entities are cloned. + - If you set the value for skip-devportal to true, no cloning of the Developer Hub entities takes place. @@ -1459,10 +1459,10 @@ By enabling this feature, you can explicitly clone the API proxies mentioned in > ### Remember: > For the clone input attribute: > - > - Both skip-apiportal and skip-devportal are set to false by default, so, API portal entities are cloned first, followed by API business hub enterprise entities. + > - Both skip-apiportal and skip-devportal are set to false by default, so, API portal entities are cloned first, followed by Developer Hub entities. > - If both skip-apiportal and skip-devportal are set to true, no cloning takes place. > - If skip-apiportal is set to false, but skip-devportal is set to true, then only the API portal entities are cloned. - > - If skip-apiportal is set to true, but skip-devportal to false, then only API business hub enterprise entities are cloned and cloning for entities \(like applications\) may fail, pertaining to nonavailability of dependent entity \(like API Product\) in API business hub enterprise. + > - If skip-apiportal is set to true, but skip-devportal to false, then only Developer Hub entities are cloned and cloning for entities \(like applications\) may fail, pertaining to nonavailability of dependent entity \(like API Product\) in Developer Hub. Sample configuration: @@ -1476,10 +1476,10 @@ By enabling this feature, you can explicitly clone the API proxies mentioned in "clientSecret": "" }, "devportal": { - "url": "", - "tokenUrl": ".authentication.sap.hana.ondemand.com/oauth/token>", - "clientId": "", - "clientSecret": "" + "url": "", + "tokenUrl": ".authentication.sap.hana.ondemand.com/oauth/token>", + "clientId": "", + "clientSecret": "" } }, @@ -1493,10 +1493,10 @@ By enabling this feature, you can explicitly clone the API proxies mentioned in }, "devportal": { - "url": "", - "tokenUrl": "", - "clientId": "", - "clientSecret": "" + "url": "", + "tokenUrl": "", + "clientId": "", + "clientSecret": "" } }, diff --git a/docs/apim/API-Management/APIM-Migration/migrating-api-management-from-neo-to-the-multi-cloud-foundation-92f2da1.md b/docs/apim/API-Management/APIM-Migration/migrating-api-management-from-neo-to-the-multi-cloud-foundation-92f2da1.md index 62e0fae5..1b2f3b7c 100644 --- a/docs/apim/API-Management/APIM-Migration/migrating-api-management-from-neo-to-the-multi-cloud-foundation-92f2da1.md +++ b/docs/apim/API-Management/APIM-Migration/migrating-api-management-from-neo-to-the-multi-cloud-foundation-92f2da1.md @@ -22,7 +22,7 @@ For the migration assistance, you must have an Integration Suite subscription wi After completing the prerequisites mentioned in the steps below, you can clone your API Management artifacts nondisruptively from the source to the target system. Post cloning, you must complete some user actions and validate your target system. > ### Note: -> The developer portal is renamed to API business hub enterprise within the multi-cloud foundation. In this document API business hub enterprise is referred to as developer portal even within the multi-cloud foundation. +> The developer portal is renamed to Developer Hub within the multi-cloud foundation. In this document Developer Hub is referred to as developer portal even within the multi-cloud foundation. The steps assisting the migration of your API Management from your source system to a target system are: diff --git a/docs/apim/API-Management/APIM-Migration/migrating-api-management-subscription-created-using-the-starter-plan-service-instan-1f4ed86.md b/docs/apim/API-Management/APIM-Migration/migrating-api-management-subscription-created-using-the-starter-plan-service-instan-1f4ed86.md index e8763fb9..e93d355a 100644 --- a/docs/apim/API-Management/APIM-Migration/migrating-api-management-subscription-created-using-the-starter-plan-service-instan-1f4ed86.md +++ b/docs/apim/API-Management/APIM-Migration/migrating-api-management-subscription-created-using-the-starter-plan-service-instan-1f4ed86.md @@ -17,7 +17,7 @@ With the Integration Suite premium edition license available in a different suba > > - Analytics data can't be retained, as Advanced Analytics gets newly configured in the different subaccount. However, if you come across any analytics data from the previous subaccount, you must ignore the data and consider the analytics data after the migration task is completed. > -> - Subscribe to the API portal and the API business hub enterprise in the other multi-cloud foundation subaccount. This is the subaccount with the Integration Suite premium edition license. +> - Subscribe to the API portal and the Developer Hub in the other multi-cloud foundation subaccount. This is the subaccount with the Integration Suite premium edition license. > > - Tenant type \(for example, production and test\) of the newly onboarded API Management on the multi-cloud foundation must be same as that of the source API Management on the Neo environment. > @@ -100,7 +100,7 @@ With the Integration Suite premium edition license available in a different suba 5. Run the Tenant Cloning Tool in the SWITCHOVER stage. For more information, see [Clone API Management Content](clone-api-management-content-7abd887.md). > ### Note: - > If applicable, API business hub enterprise entities are cloned in this step. + > If applicable, Developer Hub entities are cloned in this step. 6. After the SWITCHOVER, if you have any API Provider of the type onpremise, provide the Basic Auth password in the target system. For more information, see "API Provider Credentials" under *User Actions* in [Post Cloning Tasks](post-cloning-tasks-116d82c.md). diff --git a/docs/apim/API-Management/APIM-Migration/migrating-api-management-subscription-created-using-the-starter-plan-service-instan-9778a36.md b/docs/apim/API-Management/APIM-Migration/migrating-api-management-subscription-created-using-the-starter-plan-service-instan-9778a36.md index 1a74235a..baa24d78 100644 --- a/docs/apim/API-Management/APIM-Migration/migrating-api-management-subscription-created-using-the-starter-plan-service-instan-9778a36.md +++ b/docs/apim/API-Management/APIM-Migration/migrating-api-management-subscription-created-using-the-starter-plan-service-instan-9778a36.md @@ -13,7 +13,7 @@ You can choose to migrate the design-time components that you have in the Neo en You can also enable the new API Management design time subscription on the same multi-cloud foundation subaccount, where you have created the starter plan service instance. > ### Note: -> You must subscribe to the API portal and the API business hub enterprise in the same multi-cloud foundation subaccount where the starter plan instance is created. +> You must subscribe to the API portal and the Developer Hub in the same multi-cloud foundation subaccount where the starter plan instance is created. > > Tenant type \(for example, production and test\) of the newly onboarded API Management on the multi-cloud foundation must be same as that of the source API Management on the Neo environment. @@ -92,7 +92,7 @@ You can also enable the new API Management design time subscription on the same 5. Run the Tenant Cloning Tool in the SWITCHOVER stage. For more information, see [Clone API Management Content](clone-api-management-content-7abd887.md). > ### Note: - > If applicable, API business hub enterprise entities are cloned in this step. + > If applicable, Developer Hub entities are cloned in this step. 6. After the SWITCHOVER, if you have any API Provider of the type onpremise, provide the Basic Auth password in the target system. For more information, see "API Provider Credentials" under *User Actions* in [Post Cloning Tasks](post-cloning-tasks-116d82c.md). diff --git a/docs/apim/API-Management/APIM-Migration/migration-of-api-management-content-between-cloud-foundry-environments-17f09f3.md b/docs/apim/API-Management/APIM-Migration/migration-of-api-management-content-between-cloud-foundry-environments-17f09f3.md index dbdda74f..98073a1d 100644 --- a/docs/apim/API-Management/APIM-Migration/migration-of-api-management-content-between-cloud-foundry-environments-17f09f3.md +++ b/docs/apim/API-Management/APIM-Migration/migration-of-api-management-content-between-cloud-foundry-environments-17f09f3.md @@ -115,7 +115,7 @@ Source and target subscriptions must be in same environment. Both the source and You can clone your API Management content non-disruptively from the source to the target system only after completing the steps in the prerequisites section. Post cloning, you must complete some user actions and validate your target system. > ### Note: -> The developer portal is renamed to API business hub enterprise in Cloud Foundry environment. In this document API business hub enterprise is referred to as developer portal even in Cloud Foundry environment. +> The developer portal is renamed to Developer Hub in Cloud Foundry environment. In this document Developer Hub is referred to as developer portal even in Cloud Foundry environment. The steps assisting the migration of your API Management from your source system to a target system are: 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 293da3ba..ec821402 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 @@ -309,7 +309,7 @@ If you have multiple virtual hosts configured on your source system subscription -### Switching Over Design time URLs of API portal and API business hub enterprise portals +### Switching Over Design time URLs of API portal and Developer Hub portals - Domains managed by SAP can't be switched over. - To switch over a custom domain, create an incident on the component OPU-API-OD-OPS through the [SAP Support Portal](https://support.sap.com/en/index.html). diff --git a/docs/apim/API-Management/APIM-Migration/prerequisites-c1904bc.md b/docs/apim/API-Management/APIM-Migration/prerequisites-c1904bc.md index 7bbd8c36..39ade0c3 100644 --- a/docs/apim/API-Management/APIM-Migration/prerequisites-c1904bc.md +++ b/docs/apim/API-Management/APIM-Migration/prerequisites-c1904bc.md @@ -17,9 +17,9 @@ Checks to be completed before you start migrating your API Management content no ### Prerequisites for the source system -- You must have a valid API Management system \(API portal and API business hub enterprise\) running in the Neo environment. -- The source system must support basic authentication for API access on and API business hub enterprise\(which is the developer portal\). -- Make a note of the and API business hub enterprise\(developer portal\) URLs of the source system and keep it handy. +- You must have a valid API Management system \(API portal and Developer Hub\) running in the Neo environment. +- The source system must support basic authentication for API access on and Developer Hub\(which is the developer portal\). +- Make a note of the and Developer Hub\(developer portal\) URLs of the source system and keep it handy. - You must have identified a user with the following roles assigned in your source systems: - APIPortal.Administrator @@ -90,14 +90,14 @@ Checks to be completed before you start migrating your API Management content no > > Consider the following example: During cloning, the email address `john.smith@abc.com` in the source becomes `John.Smith@abc.com` in target due to the change in configurations in Custom IDP. This mismatch might lead to data discrepancy during application creation and metering in the target after cloning. -- Ensure that API access is enabled for the and the API business hub enterprise\(developer portal\) for the following roles: +- Ensure that API access is enabled for the and the Developer Hub\(developer portal\) for the following roles: - APIPortal.Administrator - AuthGroup.API.Admin For , see [Accessing API Management APIs Programmatically](https://help.sap.com/docs/integration-suite/sap-integration-suite/api-access-plan-for-api-portal?version=CLOUD) - For API business hub enterprise, execute the following mandatory steps: + For Developer Hub, execute the following mandatory steps: - Make a note of the service keys \(`url`, `tokenurl`, `clientId`, and `clientSecret`\) for the given roles, and keep handy. @@ -105,9 +105,9 @@ Checks to be completed before you start migrating your API Management content no - Create a destination of type *OAuth2Credentials* to the XSUAA APIs by using the credentials you derived from creating the service key. - - Create a service instance with the *AuthGroup.API.Admin* role to access theAPI business hub enterprise APIs. + - Create a service instance with the *AuthGroup.API.Admin* role to access theDeveloper Hub APIs. - To perform the above steps, see [Accessing API business hub enterprise APIs Programmatically](../APIM-Initial-Setup/accessing-api-business-hub-enterprise-apis-programmatically-dabee6e.md). + To perform the above steps, see [Accessing Developer Hub APIs Programmatically](../APIM-Initial-Setup/accessing-developer-hub-apis-programmatically-dabee6e.md). - When you have API products protected by the custom roles permission in the source Neo system, ensure that custom roles creation and assignments are done in the target system within the multi-cloud foundation before starting the migration. 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 4a255838..6b7a6f66 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 @@ -14,10 +14,10 @@ Both the source and the target system are the system that has your API Managemen ### Prerequisites for the source system -- You must have a valid API Management system \( and API business hub enterprise\) running in the Cloud Foundry environment. -- The source system must support Oauth client credentials for Cloud Foundry. You need the auth token url and key secret to access the and API business hub enterprise. For more information, refer [Accessing API Management APIs Programmatically](https://help.sap.com/docs/integration-suite/sap-integration-suite/api-access-plan-for-api-portal?version=CLOUD)[Accessing API business hub enterprise APIs Programmatically](https://help.sap.com/docs/integration-suite/sap-integration-suite/api-access-plan-for-api-business-hub-enterprise?version=CLOUD). -- Make a note of the API portal and API business hub enterprise URLs of the source system and keep handy. -- Ensure that API access is enabled for the and API business hub enterprise systems for the following roles: +- You must have a valid API Management system \( and Developer Hub\) running in the Cloud Foundry environment. +- The source system must support Oauth client credentials for Cloud Foundry. You need the auth token url and key secret to access the and Developer Hub. For more information, refer [Accessing API Management APIs Programmatically](https://help.sap.com/docs/integration-suite/sap-integration-suite/api-access-plan-for-api-portal?version=CLOUD)[Accessing Developer Hub APIs Programmatically](https://help.sap.com/docs/integration-suite/sap-integration-suite/api-access-plan-for-api-business-hub-enterprise?version=CLOUD). +- Make a note of the API portal and Developer Hub URLs of the source system and keep handy. +- Ensure that API access is enabled for the and Developer Hub systems for the following roles: - APIPortal.Administrator - AuthGroup.API.Admin @@ -95,14 +95,14 @@ Both the source and the target system are the system that has your API Managemen > > Consider the following example: During cloning, the email address `john.smith@abc.com` in the source becomes `John.Smith@abc.com` in target due to the change in configurations in Custom IDP. This mismatch might lead to data discrepancy during application creation and metering in the target after cloning. -- Ensure that API access is enabled for the and the API business hub enterprise for the following roles: +- Ensure that API access is enabled for the and the Developer Hub for the following roles: - APIPortal.Administrator - AuthGroup.API.Admin For , see [Accessing API Management APIs Programmatically](https://help.sap.com/docs/integration-suite/sap-integration-suite/api-access-plan-for-api-portal?version=CLOUD) - For API business hub enterprise, execute the following mandatory steps: + For Developer Hub, execute the following mandatory steps: - Make a note of the service keys \(`url`, `tokenurl`, `clientId`, and `clientSecret`\) for the given roles, and keep handy. @@ -110,9 +110,9 @@ Both the source and the target system are the system that has your API Managemen - Create a destination of type *OAuth2Credentials* to the XSUAA APIs by using the credentials you derived from creating the service key. - - Create a service instance with the *AuthGroup.API.Admin* role to access theAPI business hub enterprise APIs. + - Create a service instance with the *AuthGroup.API.Admin* role to access theDeveloper Hub APIs. - To perform the above steps, see [Accessing API business hub enterprise APIs Programmatically](https://help.sap.com/docs/integration-suite/sap-integration-suite/api-access-plan-for-api-business-hub-enterprise?version=CLOUD) + To perform the above steps, see [Accessing Developer Hub APIs Programmatically](https://help.sap.com/docs/integration-suite/sap-integration-suite/api-access-plan-for-api-business-hub-enterprise?version=CLOUD) - 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. diff --git a/docs/apim/API-Management/APIM-Migration/security-features-of-the-tenant-cloning-tool-41702e8.md b/docs/apim/API-Management/APIM-Migration/security-features-of-the-tenant-cloning-tool-41702e8.md index 5302c3c0..3b66500b 100644 --- a/docs/apim/API-Management/APIM-Migration/security-features-of-the-tenant-cloning-tool-41702e8.md +++ b/docs/apim/API-Management/APIM-Migration/security-features-of-the-tenant-cloning-tool-41702e8.md @@ -10,7 +10,7 @@ The security features of the Tenant Cloning Tool is described in this section. ## Auditing and Logging -- The Tenant Cloning tool calls the APIs provided by and API business hub enterprise\(developer portal\). Hence, there are no security-related events available in the tool. +- The Tenant Cloning tool calls the APIs provided by and Developer Hub\(developer portal\). Hence, there are no security-related events available in the tool. - All application logs generated from the cloning tool are stored in "APIM-Tenant-Cloning-Tool.log", an autogenerated log file. @@ -45,5 +45,5 @@ The security features of the Tenant Cloning Tool is described in this section. ## Network and Communication Security -The tool uses standard HTTPS communication to make API calls, as provided by the and API business hub enterprise\(developer portal\). +The tool uses standard HTTPS communication to make API calls, as provided by the and Developer Hub\(developer portal\). diff --git a/docs/apim/API-Management/APIM-Migration/security-features-of-the-tenant-cloning-tool-a6969cc.md b/docs/apim/API-Management/APIM-Migration/security-features-of-the-tenant-cloning-tool-a6969cc.md index 3604d057..870efc7c 100644 --- a/docs/apim/API-Management/APIM-Migration/security-features-of-the-tenant-cloning-tool-a6969cc.md +++ b/docs/apim/API-Management/APIM-Migration/security-features-of-the-tenant-cloning-tool-a6969cc.md @@ -10,7 +10,7 @@ The security features of the Tenant Cloning Tool is described in this section. ## Auditing and Logging -- The Tenant Cloning tool calls the APIs provided by and API business hub enterprise\(developer portal\). Hence, there are no security-related events available in the tool. +- The Tenant Cloning tool calls the APIs provided by and Developer Hub\(developer portal\). Hence, there are no security-related events available in the tool. - All application logs generated from the cloning tool are stored in "APIM-Tenant-Cloning-Tool.log", an autogenerated log file. @@ -45,5 +45,5 @@ The security features of the Tenant Cloning Tool is described in this section. ## Network and Communication Security -The tool uses standard HTTPS communication to make API calls, as provided by the and API business hub enterprise\(developer portal\). +The tool uses standard HTTPS communication to make API calls, as provided by the and Developer Hub\(developer portal\). diff --git a/docs/apim/API-Management/APIM-Migration/tenant-cloning-tool-behavior-6d15ffd.md b/docs/apim/API-Management/APIM-Migration/tenant-cloning-tool-behavior-6d15ffd.md index ad0dc3da..603ba0f2 100644 --- a/docs/apim/API-Management/APIM-Migration/tenant-cloning-tool-behavior-6d15ffd.md +++ b/docs/apim/API-Management/APIM-Migration/tenant-cloning-tool-behavior-6d15ffd.md @@ -20,7 +20,7 @@ This topic describes the behavior of the Tenant Cloning Tool with respect to clo To know more about API proxy states, see [API Proxy States](../api-proxy-states-091cda4.md). > ### Note: - > If the Tenant Cloning Tool is used to clone an API proxy or a product with more than 100 resources attached to it, you might notice data inconsistency in the target system \(API business hub enterprise or \). It is recommended that you do not add more than 100 resources per proxy or product. For more information, see [Limits in API Management](../limits-in-api-management-f70f425.md). + > If the Tenant Cloning Tool is used to clone an API proxy or a product with more than 100 resources attached to it, you might notice data inconsistency in the target system \(Developer Hub or \). It is recommended that you do not add more than 100 resources per proxy or product. For more information, see [Limits in API Management](../limits-in-api-management-f70f425.md). > > . diff --git a/docs/apim/API-Management/APIM-Migration/tenant-cloning-tool-behavior-b23c603.md b/docs/apim/API-Management/APIM-Migration/tenant-cloning-tool-behavior-b23c603.md index 27c25b31..e077bb1b 100644 --- a/docs/apim/API-Management/APIM-Migration/tenant-cloning-tool-behavior-b23c603.md +++ b/docs/apim/API-Management/APIM-Migration/tenant-cloning-tool-behavior-b23c603.md @@ -20,7 +20,7 @@ This topic describes the behavior of the Tenant Cloning Tool with respect to clo To know more about API proxy states, see [API Proxy States](../api-proxy-states-091cda4.md). > ### Note: - > If the Tenant Cloning Tool is used to clone an API proxy or a product with more than 100 resources attached to it, you might notice data inconsistency in the target system \(API business hub enterprise or \). It is recommended that you do not add more than 100 resources per proxy or product. For more information, see [Limits in API Management](../limits-in-api-management-f70f425.md). + > If the Tenant Cloning Tool is used to clone an API proxy or a product with more than 100 resources attached to it, you might notice data inconsistency in the target system \(Developer Hub or \). It is recommended that you do not add more than 100 resources per proxy or product. For more information, see [Limits in API Management](../limits-in-api-management-f70f425.md). > > . diff --git a/docs/apim/API-Management/add-custom-attributes-to-an-application-39c3cbd.md b/docs/apim/API-Management/add-custom-attributes-to-an-application-39c3cbd.md index 57633b8e..ab7efd93 100644 --- a/docs/apim/API-Management/add-custom-attributes-to-an-application-39c3cbd.md +++ b/docs/apim/API-Management/add-custom-attributes-to-an-application-39c3cbd.md @@ -6,7 +6,7 @@ You can create applications on behalf of other application developers, add custo The custom attributes at application level have values assigned to them. These values help in configuring and accessing them on runtime easily. Here, when admin creates an application on behalf of developer at application level, custom attributes can be assigned by the admin. Therefore, this helps you in enhancing the functionality and performing attribute specific runtime enforcements for your API. -**Role of a API business hub enterprise Administrator**: +**Role of a Developer Hub Administrator**: - Create an application on behalf of a user and handover the application key and secret to that user. - Create new applications in different landscapes\(example: production, non-production\) by maintaining the same application key and secret. @@ -14,7 +14,7 @@ The custom attributes at application level have values assigned to them. These v **Visibility of List of Applications** -When a user has permission, "ManageAllAPISubscriptions" or is a API business hub enterprise admin, they can view *My Workspace* tab on the home page of the API business hub enterprise. After choosing *My Workspace* tab, they can view the following changes: +When a user has permission, "ManageAllAPISubscriptions" or is a Developer Hub admin, they can view *My Workspace* tab on the home page of the Developer Hub. After choosing *My Workspace* tab, they can view the following changes: - A list of all the applications created for the tenant by all the developers. - Navigate to the application details screen by selecting one of the applications. Hence, *My Workspace* tab also helps in managing all the applications. diff --git a/docs/apim/API-Management/adding-externally-managed-apis-523ff94.md b/docs/apim/API-Management/adding-externally-managed-apis-523ff94.md index 9f45a033..85852150 100644 --- a/docs/apim/API-Management/adding-externally-managed-apis-523ff94.md +++ b/docs/apim/API-Management/adding-externally-managed-apis-523ff94.md @@ -37,7 +37,7 @@ To add an externally managed API, you must import the API definition of an exter This API will only be listed in , and it's lifecycle will not be managed. - In order to access externally managed APIs in the API business hub enterprise, you need to add these APIs to a product and then publish the product. For more information on how to create a product, see [Create a Product](https://help.sap.com/docs/integration-suite/sap-integration-suite/create-product?q=import%20an%20APi&version=CLOUD). + In order to access externally managed APIs in the Developer Hub, you need to add these APIs to a product and then publish the product. For more information on how to create a product, see [Create a Product](https://help.sap.com/docs/integration-suite/sap-integration-suite/create-product?q=import%20an%20APi&version=CLOUD). > ### Note: > While you can add externally managed APIs to a product, you will not be able to include rate plans or add custom attributes for them. diff --git a/docs/apim/API-Management/api-management-faqs-2d16070.md b/docs/apim/API-Management/api-management-faqs-2d16070.md index 9bef29b6..0e51be8a 100644 --- a/docs/apim/API-Management/api-management-faqs-2d16070.md +++ b/docs/apim/API-Management/api-management-faqs-2d16070.md @@ -119,14 +119,14 @@ Answers
-What is the difference between SAP API business hub enterprise and SAP API Management? +What is the difference between SAP Developer Hub and SAP API Management? SAP API Management is a solution that helps customers to secure, manage, transform and publish APIs from both SAP and non-SAP systems. The published APIs can be consumed within mobile or web applications on any platform. Application developers who want to use a published API need to subscribe to the respective API. Usage of the published APIs can be monitored and analyzed from SAP API Management. -SAP API business hub enterprise provides a central catalog of SAP and selected partner APIs allowing developers to search, discover, experience and consume the services they need to build new applications, app extensions or process integrations. +SAP Developer Hub provides a central catalog of SAP and selected partner APIs allowing developers to search, discover, experience and consume the services they need to build new applications, app extensions or process integrations.
-How to onboard an application developer on the API business hub enterprise? +How to onboard an application developer on the Developer Hub? diff --git a/docs/apim/API-Management/api-proxy-states-091cda4.md b/docs/apim/API-Management/api-proxy-states-091cda4.md index 431b5363..90fe9174 100644 --- a/docs/apim/API-Management/api-proxy-states-091cda4.md +++ b/docs/apim/API-Management/api-proxy-states-091cda4.md @@ -91,5 +91,5 @@ When you deprecate or decommission an API proxy, you must provide a deprecation The API state is to be used only for demarcation, and doesn’t play a role in the governance or lifecycle of the API. > ### Note: -> An application developer can view the states of the deprecated and decommissioned API proxies \(if published in the \) in the API details screen of the API business hub enterprise. +> An application developer can view the states of the deprecated and decommissioned API proxies \(if published in the \) in the API details screen of the Developer Hub. diff --git a/docs/apim/API-Management/api-services-007d50f.md b/docs/apim/API-Management/api-services-007d50f.md index a8936d79..253d81d1 100644 --- a/docs/apim/API-Management/api-services-007d50f.md +++ b/docs/apim/API-Management/api-services-007d50f.md @@ -33,7 +33,7 @@ You can browse through this API package for API admin services with the required
-API business hub enterprise +Developer Hub diff --git a/docs/apim/API-Management/archive-2023-a8dd11f.md b/docs/apim/API-Management/archive-2023-a8dd11f.md index 67e2da74..6253b2f7 100644 --- a/docs/apim/API-Management/archive-2023-a8dd11f.md +++ b/docs/apim/API-Management/archive-2023-a8dd11f.md @@ -217,12 +217,12 @@ API Management -Manage external content in API business hub enterprise +Manage external content in Developer Hub -The new *Manage External Content* option in *Enterprise Manager* enables you to configure additional content, such as Business Data Graphs \(BDGs\), for display on the API business hub enterprise. +The new *Manage External Content* option in *Enterprise Manager* enables you to configure additional content, such as Business Data Graphs \(BDGs\), for display on the Developer Hub. @@ -281,12 +281,12 @@ API Management -Deprecation of Classic Design of API business hub enterprise +Deprecation of Classic Design of Developer Hub -The classic design of the API business hub enterprise will be deprecated soon. Starting from March 2024, the new design of the API business hub enterprise will become the default design. However, you’ll still be able to toggle between the new and old design until June 2024 using the *Set Default Design* feature in *Site Editor*. For more information, see +The classic design of the Developer Hub will be deprecated soon. Starting from March 2024, the new design of the Developer Hub will become the default design. However, you’ll still be able to toggle between the new and old design until June 2024 using the *Set Default Design* feature in *Site Editor*. For more information, see See: [Customize the Visual Format of the API business hub enterprise](https://help.sap.com/docs/integration-suite/sap-integration-suite/customize-visual-format-of-api-business-hub-enterprise)\(SAP API Management customers choose: [Customize the Visual Format of the API business hub enterprise](https://help.sap.com/docs/sap-api-management/sap-api-management/customize-visual-format-of-api-business-hub-enterprise)\) @@ -347,14 +347,14 @@ API Management -Auto-Registration of developers in API business hub enterprise +Auto-Registration of developers in Developer Hub If the AuthGroup.API.ApplicationDeveloper role is already assigned to you by the SAP BTP admin or via the IDP Role Collection mapping, you will get automatically registered as an application developer in API business hub enterprise when you logon for the first time. -See: [Register on API business hub enterprise](register-on-api-business-hub-enterprise-c85fafe.md) \(SAP API Management customers choose: [Register on API business hub enterprise](https://help.sap.com/docs/sap-api-management/sap-api-management/register-on-api-business-hub-enterprise)\) +See: [Register on API business hub enterprise](register-on-developer-hub-c85fafe.md) \(SAP API Management customers choose: [Register on API business hub enterprise](https://help.sap.com/docs/sap-api-management/sap-api-management/register-on-api-business-hub-enterprise)\) @@ -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](APIM-Initial-Setup/create-a-connection-request-for-the-centralized-api-business-hub-enterprise-c7bda8c.md). +The connection between the centralised Developer Hub and the API portal has been secured with certificate-based authentication. For more information, see [Create a Connection Request for the Centralized Developer Hub](APIM-Initial-Setup/create-a-connection-request-for-the-centralized-developer-hub-c7bda8c.md). @@ -872,12 +872,12 @@ API Management -API business hub enterprise: Add Links and Email Addresses Using Markdown +Developer Hub: Add Links and Email Addresses Using Markdown -You can use markdown to add links and email addresses to the title and subtitle fields as part of the banner description in *Site Editor*. For more information, see [Customize the Visual Format of the API business hub enterprise](customize-the-visual-format-of-the-api-business-hub-enterprise-2eacd52.md). +You can use markdown to add links and email addresses to the title and subtitle fields as part of the banner description in *Site Editor*. For more information, see [Customize the Visual Format of the Developer Hub](customize-the-visual-format-of-the-developer-hub-2eacd52.md). @@ -1069,7 +1069,7 @@ Secure options to consume APIs -We have introduced secure options to consume APIs using the API Access Plan for API portal, API business hub enterprise and on-premise connectivity. You can now create service keys with credential types "binding- secret", "instance- secret" and "x509". For more information, see [Accessing API Management APIs Programmatically](APIM-Initial-Setup/accessing-api-management-apis-programmatically-24a2c37.md), [Accessing API business hub enterprise APIs Programmatically](APIM-Initial-Setup/accessing-api-business-hub-enterprise-apis-programmatically-dabee6e.md) and [Accessing On-Premise Systems through API Management](APIM-Initial-Setup/accessing-on-premise-systems-through-api-management-2fc7a5b.md). +We have introduced secure options to consume APIs using the API Access Plan for API portal, API business hub enterprise and on-premise connectivity. You can now create service keys with credential types "binding- secret", "instance- secret" and "x509". For more information, see [Accessing API Management APIs Programmatically](APIM-Initial-Setup/accessing-api-management-apis-programmatically-24a2c37.md), [Accessing Developer Hub APIs Programmatically](APIM-Initial-Setup/accessing-developer-hub-apis-programmatically-dabee6e.md) and [Accessing On-Premise Systems through API Management](APIM-Initial-Setup/accessing-on-premise-systems-through-api-management-2fc7a5b.md). @@ -1133,7 +1133,7 @@ Short text field in API products. -In the API portal, a new *Short Text* field is now available for products. You can use this field to add an introductory text to your products. When you add the introductory text in this field and publish the product, this short text appears in the product tile on the corresponding API business hub enterprise page and is also available on the API proxy details page. For more information, see [Create a Product](create-a-product-d769622.md). +In the API portal, a new *Short Text* field is now available for products. You can use this field to add an introductory text to your products. When you add the introductory text in this field and publish the product, this short text appears in the product tile on the corresponding Developer Hub page and is also available on the API proxy details page. For more information, see [Create a Product](create-a-product-d769622.md). @@ -1192,7 +1192,7 @@ API Management -API business hub enterprise \[New Design\] and \[Classic Design\] +Developer Hub \[New Design\] and \[Classic Design\] @@ -1256,12 +1256,12 @@ API Management -API business hub enterprise +Developer Hub -\[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). +\[New DesignThe Manage options \(for example Manage Users, Manage Domain\] Categories, and so on\) on the Developer Hub \[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). @@ -1320,12 +1320,12 @@ API Management -API business hub enterprise \[New Design\] +Developer Hub \[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](manage-notifications-df32457.md). +You can now configure notifications for providing information to the Developer Hub end users on any website updates, events or news items from the Developer Hub new user interface. For more information, see [Manage Notifications](manage-notifications-df32457.md). @@ -1384,7 +1384,7 @@ API Management -API business hub enterprise +Developer Hub 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 b3e08bc4..f5cb2dbd 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 @@ -17,12 +17,12 @@ Assign permission to a product in the . ## Context -Whenever you create a product or edit a draft product, permissions can be added to product. Use this procedure to grant permission to user roles for discovering and subscribing to the product in the API business hub enterprise. Only users who are assigned the required role can discover and subscribe to the product. +Whenever you create a product or edit a draft product, permissions can be added to product. Use this procedure to grant permission to user roles for discovering and subscribing to the product in the Developer Hub. Only users who are assigned the required role can discover and subscribe to the product. > ### 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. +> Currently, we do not support assigning of permissions to the products defined in the remote API portals that are connected to a centralised Developer Hub. > -> \*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). +> \*Remote API portals are those that are not in the same subaccount as the centralised Developer Hub and are configured via the manage connections. For more information, [Centralized Developer Hub](APIM-Initial-Setup/centralized-developer-hub-38422de.md). @@ -36,9 +36,9 @@ Whenever you create a product or edit a draft product, permissions can be added Here, whenever a product is created or a draft product is edited, permissions can be added to product. -4. Select a role from the *Discovery* dropdown list. Only users who are assigned the selected role can discover this product in the API business hub enterprise. +4. Select a role from the *Discovery* dropdown list. Only users who are assigned the selected role can discover this product in the Developer Hub. -5. Select a role from the *Subscription* dropdown list. Only users who are assigned the selected role can subscribe to this product in the API business hub enterprise. +5. Select a role from the *Subscription* dropdown list. Only users who are assigned the selected role can subscribe to this product in the Developer Hub. - You can change the roles selected for *Discovery* and *Subscription* by choosing *Edit*. diff --git a/docs/apim/API-Management/billing-service-1e20fb5.md b/docs/apim/API-Management/billing-service-1e20fb5.md index 4391a049..b114ab99 100644 --- a/docs/apim/API-Management/billing-service-1e20fb5.md +++ b/docs/apim/API-Management/billing-service-1e20fb5.md @@ -2,7 +2,7 @@ # Billing Service -Billing service is available in both and API business hub enterprise. +Billing service is available in both and Developer Hub. Using billing service, you can view the bill details and download bill details for a specific developer and for a specific month. @@ -29,7 +29,7 @@ Service to view bills : - Required in API business hub enterprise + Required in Developer Hub @@ -153,9 +153,9 @@ Service to view bills :
-- You can also view the bill details in the and API business hub enterprise. For more information see, +- You can also view the bill details in the and Developer Hub. For more information see, - [View Bill Details in the](view-bill-details-in-the-2378110.md) - - [View Bill Details in the API business hub enterprise](view-bill-details-in-the-api-business-hub-enterprise-4ddac67.md) + - [View Bill Details in the Developer Hub](view-bill-details-in-the-developer-hub-4ddac67.md) diff --git a/docs/apim/API-Management/build-api-proxies-74c042b.md b/docs/apim/API-Management/build-api-proxies-74c042b.md index 2a51c28e..c42bf371 100644 --- a/docs/apim/API-Management/build-api-proxies-74c042b.md +++ b/docs/apim/API-Management/build-api-proxies-74c042b.md @@ -33,6 +33,6 @@ To build an API, you need to perform the following tasks: 4. [Test APIs using the API Test Console](test-api-proxies-3ba6151.md). > ### Note: - > In order to achieve an effortless navigation to the API business hub enterprise, choose *Navigation Links*\(![](images/Finalgrid_1a621ca.png)\) from the and select **API business hub enterprise**. + > In order to achieve an effortless navigation to the Developer Hub, choose *Navigation Links*\(![](images/Finalgrid_1a621ca.png)\) from the and select **Developer Hub**. diff --git a/docs/apim/API-Management/components-of-api-management-24f1af0.md b/docs/apim/API-Management/components-of-api-management-24f1af0.md index 31446fc1..14bb5694 100644 --- a/docs/apim/API-Management/components-of-api-management-24f1af0.md +++ b/docs/apim/API-Management/components-of-api-management-24f1af0.md @@ -6,7 +6,7 @@ API Management component overview -The API Management infrastructure consists of five components: API Runtime, API Portal, API business hub enterprise, API Analytics, and API Designer. +The API Management infrastructure consists of five components: API Runtime, API Portal, Developer Hub, API Analytics, and API Designer. ![](images/components_api_management_127274b.png) @@ -26,7 +26,7 @@ The one-stop-shop to create, secure, and publish API Proxies. This is the place ### API Business Hub Enterprise -Self-service for application developers to discover, browse, and explore APIs, subscribe to rate plans, and build apps. To know more about using the API business hub enterprise, see [Consume API Proxies](consume-api-proxies-ea561e4.md). +Self-service for application developers to discover, browse, and explore APIs, subscribe to rate plans, and build apps. To know more about using the Developer Hub, see [Consume API Proxies](consume-api-proxies-ea561e4.md). diff --git a/docs/apim/API-Management/manage-external-content-f5bd17d.md b/docs/apim/API-Management/configure-the-visibility-of-graph-navigator-f5bd17d.md similarity index 88% rename from docs/apim/API-Management/manage-external-content-f5bd17d.md rename to docs/apim/API-Management/configure-the-visibility-of-graph-navigator-f5bd17d.md index 100b5d28..ad7ce589 100644 --- a/docs/apim/API-Management/manage-external-content-f5bd17d.md +++ b/docs/apim/API-Management/configure-the-visibility-of-graph-navigator-f5bd17d.md @@ -1,8 +1,8 @@ -# Manage External Content +# Configure the Visibility of Graph Navigator -On this page, you have the option to adjust the visibility of the Graph navigator on the API business hub enterprise. +On this page, you have the option to adjust the visibility of the Graph navigator on the Developer Hub. @@ -33,9 +33,9 @@ If the graph feature is deactivated in the Integration Suite, the *Configure Gra ## Procedure -1. Log on to the API business hub enterprise. +1. Log on to the Developer Hub. -2. Choose *Enterprise Manager* \> *Manage External Content* from the top navigation bar. +2. Choose *Admin Center* \> *Manage External Content* from the top navigation bar. 3. Use the slider button to enable/disable the graph feature. diff --git a/docs/apim/API-Management/consume-api-proxies-ea561e4.md b/docs/apim/API-Management/consume-api-proxies-ea561e4.md index a859dc88..a22acba6 100644 --- a/docs/apim/API-Management/consume-api-proxies-ea561e4.md +++ b/docs/apim/API-Management/consume-api-proxies-ea561e4.md @@ -2,30 +2,30 @@ # Consume API Proxies -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 via the Developer Hub. In the Developer Hub, 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 [User Roles and Responsibilities in API business hub enterprise](user-roles-and-responsibilities-in-api-business-hub-enterprise-54b4607.md). +> Effective June 2024, the classic design of the Developer Hub will be deprecated and will no longer be accessible. The new design of the Developer Hub will be set as your default design from March 2024. For more information, see [User Roles and Responsibilities in Developer Hub](APIM-Initial-Setup/user-roles-and-responsibilities-in-developer-hub-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. +If you've added Developer Hub as a capability with Integration suite, or if you’ve subscribed to the Developer Hub as part of the standalone API Management subscription, you have the option to experience the new design of the Developer Hub user interface along with the classic design. > ### 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. For more information, see [Customize the Visual Format of the API business hub enterprise](customize-the-visual-format-of-the-api-business-hub-enterprise-2eacd52.md). +> 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. For more information, see [Customize the Visual Format of the Developer Hub](customize-the-visual-format-of-the-developer-hub-2eacd52.md). ![](images/ABHE_Block_509b298.png) -API business hub enterprise is an application that provides a common platform for Application developers to consume API proxies. Every API Management customer is provided with their own API business hub enterprise application on cloud. The API business hub enterprise offers capabilities to onboard application developers, explore and test API proxies, create and subscribe to Applications. +Developer Hub is an application that provides a common platform for Application developers to consume API proxies. Every API Management customer is provided with their own Developer Hub application on cloud. The Developer Hub offers capabilities to onboard application developers, explore and test API proxies, create and subscribe to Applications. -The API business hub enterprise supports the following features: +The Developer Hub supports the following features: -- **Onboard an Application developer**- To explore the API proxies and subscribe to an Application, an Application developer must be registered to the API business hub enterprise. On registering, the Application developer is provided access to the API business hub enterprise. +- **Onboard an Application developer**- To explore the API proxies and subscribe to an Application, an Application developer must be registered to the Developer Hub. On registering, the Application developer is provided access to the Developer Hub. - **Browse Catalog**- Explore the Products \(assembled APIs\) available in the Catalog store, navigate to individual API proxies, read the API Documentation, and view the resources attached to the API proxies. > ### Note: - > A limitation within the open-source Swagger library, on which the API business hub enterprise relies, causes slow, improper, or no rendering of API schemas that contain circular references on deeply nested models on the platform. + > A limitation within the open-source Swagger library, on which the Developer Hub relies, causes slow, improper, or no rendering of API schemas that contain circular references on deeply nested models on the platform. - **Create Applications** – An Application developer can create on or more applications to consume API proxies. To consume the API proxies, an Application developer must subscribe to an Application \(assembled Products\). It is by subscribing to an Application that you return to the developer the key required to access the API proxies. -- **Download JSON**- You can download the open API specification for the APIs that are part of the API business hub enterprise in JSON format. This enables the developer to use the metadata of the APIs for various aspects such as code/SDK generation for developing applications. +- **Download JSON**- You can download the open API specification for the APIs that are part of the Developer Hub in JSON format. This enables the developer to use the metadata of the APIs for various aspects such as code/SDK generation for developing applications. - **Download SDK**- You can also download the client software development kit \(SDK\) for developers through a non-commercial license on open source sites. You can use this SDK for developing applications. @@ -34,5 +34,5 @@ The API business hub enterprise supports the following features: **Related Information** -[User Roles and Responsibilities in API business hub enterprise](user-roles-and-responsibilities-in-api-business-hub-enterprise-54b4607.md "After activating the API business hub enterprise in the Integration Suite, you need to assign users the necessary roles and role collections to access the various features and functionalities of API business hub enterprise.") +[User Roles and Responsibilities in Developer Hub](APIM-Initial-Setup/user-roles-and-responsibilities-in-developer-hub-54b4607.md "After activating the Developer Hub in the Integration Suite, you need to assign users the necessary roles and role collections to access the various features and functionalities of Developer Hub.") diff --git a/docs/apim/API-Management/consume-api-proxies-using-sap-business-application-studio-15732eb.md b/docs/apim/API-Management/consume-api-proxies-using-sap-business-application-studio-15732eb.md index 72de1b95..6bcfbb46 100644 --- a/docs/apim/API-Management/consume-api-proxies-using-sap-business-application-studio-15732eb.md +++ b/docs/apim/API-Management/consume-api-proxies-using-sap-business-application-studio-15732eb.md @@ -2,7 +2,12 @@ # Consume API Proxies Using SAP Business Application Studio -The service center in SAP Business Application Studio provides a central entry point to explore products and services from the API business hub enterprise. +The service center in SAP Business Application Studio provides a central entry point to explore products and services from the Developer Hub. -You can use this service center to develop your applications based on the OData Services available as a part of products published in API business hub enterprise. For more information, see [API Business Hub Enterprise Service Provider](https://help.sap.com/docs/SAP%20Business%20Application%20Studio/9d1db9835307451daa8c930fbd9ab264/328519b3b7c04871b63a41350190d4d5.html?version=Cloud). +You are an application developer, you can use this service center to develop your applications based on the OData Services available as a part of products published in Developer Hub. For more information, see [Developer Hub Service Provider](https://help.sap.com/docs/SAP%20Business%20Application%20Studio/9d1db9835307451daa8c930fbd9ab264/328519b3b7c04871b63a41350190d4d5.html?version=Cloud). + +**Related Information** + + + diff --git a/docs/apim/API-Management/create-a-product-d769622.md b/docs/apim/API-Management/create-a-product-d769622.md index 1cd70c2b..f5dde867 100644 --- a/docs/apim/API-Management/create-a-product-d769622.md +++ b/docs/apim/API-Management/create-a-product-d769622.md @@ -46,7 +46,7 @@ You create a product when you want to expose one or more API proxies to the Appl 5. For the product, enter a *Name* and *Title*, provide an introductory text in the *Short Text* field, and a brief description in the *Description* field. > ### Note: - > If you publish a product with a short introductory text, the short text appears on the corresponding API business hub enterprise pages. It appears on the product tiles on the API business hub enterprise landing page, and on the product details page. It also appears on the search result page for the searched products. + > If you publish a product with a short introductory text, the short text appears on the corresponding Developer Hub pages. It appears on the product tiles on the Developer Hub landing page, and on the product details page. It also appears on the search result page for the searched products. > > If you leave the short text field empty, the product description is displayed instead of the short text in the product tile. diff --git a/docs/apim/API-Management/create-an-application-a501a6d.md b/docs/apim/API-Management/create-an-application-a501a6d.md index b0688eb2..06933613 100644 --- a/docs/apim/API-Management/create-an-application-a501a6d.md +++ b/docs/apim/API-Management/create-an-application-a501a6d.md @@ -6,7 +6,7 @@ Create an Application to consume the required APIs. 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. +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 Developer Hub. 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. -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. +A user must be onboarded to Developer Hub only via Self-registration or *Add User* flow. For more information on registering in Developer Hub, see [Register on Developer Hub](register-on-developer-hub-c85fafe.md). In the *Add User* flow, the Developer Hub admin adds a user who wants to be onboarded to Developer Hub. 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. diff --git a/docs/apim/API-Management/creating-an-application-with-application-developer-role-99515fc.md b/docs/apim/API-Management/creating-an-application-with-application-developer-role-99515fc.md index 59516217..0f52beb8 100644 --- a/docs/apim/API-Management/creating-an-application-with-application-developer-role-99515fc.md +++ b/docs/apim/API-Management/creating-an-application-with-application-developer-role-99515fc.md @@ -15,9 +15,9 @@ As an application developer you can create an application, and view the existing > ### 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. > - > 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. 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). + > The *AuthGroup.API.ApplicationDeveloper* role is assigned by default to a user who onboards to the Developer Hub using the self-registration process or via*Add User* flow. For more information on registering in Developer Hub, see [Register on Developer Hub](register-on-developer-hub-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. + > In the Add User flow, the Developer Hub admin adds a user who wants to be onboarded to Developer Hub. 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. @@ -30,7 +30,7 @@ You are about to create an application and add products to your application. You ## Procedure -1. Log on to the API business hub enterprise and navigate to *My Workspace*. +1. Log on to the Developer Hub and navigate to *My Workspace*. The applications you created earlier, are displayed under the *Applications* tab. For an existing application, you can view the total number of calls made in the current month on the *Applications* page. diff --git a/docs/ISuite/creating-an-application-with-api-business-hub-enterprise-administrator-role-df4f777.md b/docs/apim/API-Management/creating-an-application-with-developer-hub-administrator-role-df4f777.md similarity index 79% rename from docs/ISuite/creating-an-application-with-api-business-hub-enterprise-administrator-role-df4f777.md rename to docs/apim/API-Management/creating-an-application-with-developer-hub-administrator-role-df4f777.md index df5fb653..a8a42493 100644 --- a/docs/ISuite/creating-an-application-with-api-business-hub-enterprise-administrator-role-df4f777.md +++ b/docs/apim/API-Management/creating-an-application-with-developer-hub-administrator-role-df4f777.md @@ -1,8 +1,8 @@ -# Creating an Application with API business hub enterprise Administrator Role +# Creating an Application with Developer Hub 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. +With the Developer Hub 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. @@ -11,7 +11,7 @@ With the API business hub enterprise administrator role you can create an applic ## Prerequisites > ### Note: -> The availability of this feature is dependent on your SAP Integration Suite service plan. For more information about different service plans and their supported feature set, see [User Roles and Responsibilities in API business hub enterprise](user-roles-and-responsibilities-in-api-business-hub-enterprise-54b4607.md). You can also refer to the SAP Notes [2903776](https://help.sap.com/docs/link-disclaimer?site=https%3A%2F%2Fme.sap.com%2Fnotes%2F2903776) and [3463620](https://help.sap.com/docs/link-disclaimer?site=https%3A%2F%2Fme.sap.com%2Fnotes%2F3463620). +> The availability of this feature is dependent on your SAP Integration Suite service plan. For more information about different service plans and their supported feature set, see [User Roles and Responsibilities in Developer Hub](APIM-Initial-Setup/user-roles-and-responsibilities-in-developer-hub-54b4607.md). You can also refer to the SAP Notes [2903776](https://help.sap.com/docs/link-disclaimer?site=https%3A%2F%2Fme.sap.com%2Fnotes%2F2903776) and [3463620](https://help.sap.com/docs/link-disclaimer?site=https%3A%2F%2Fme.sap.com%2Fnotes%2F3463620). You should have the *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:. @@ -19,7 +19,7 @@ You should have the *AuthGroup.API.Admin* role assigned to you. For more informa ## Context -An API business hub enterprise administrator can perform the following tasks: +An Developer Hub 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. @@ -31,12 +31,12 @@ An API business hub enterprise administrator can perform the following tasks: ## Procedure -1. Log on to the **API business hub enterprise** and navigate to *My Workspace*. +1. Log on to the **Developer Hub** and navigate to *My Workspace*. 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: - > For API business hub enterprise administrators, analytics data is unavailable for those applications that they created on behalf of other users or application developers. + > For Developer Hub administrators, analytics data is unavailable for those applications that they created on behalf of other users or application developers. 2. To create an application, choose *Create New Application* in the *Applications* section. diff --git a/docs/apim/API-Management/custom-attributes-90a5a6d.md b/docs/apim/API-Management/custom-attributes-90a5a6d.md index 7a1eb536..32444db1 100644 --- a/docs/apim/API-Management/custom-attributes-90a5a6d.md +++ b/docs/apim/API-Management/custom-attributes-90a5a6d.md @@ -43,7 +43,7 @@ AuthGroup.API.Admin -API business hub enterprise +Developer Hub @@ -362,7 +362,7 @@ Sample payload to create a custom attribute \(application\) - Request Header: Authorization:Bearer - Response: bearer-token value - To know how to retrieve this token, see [Accessing API business hub enterprise APIs Programmatically](APIM-Initial-Setup/accessing-api-business-hub-enterprise-apis-programmatically-dabee6e.md). + To know how to retrieve this token, see [Accessing Developer Hub APIs Programmatically](APIM-Initial-Setup/accessing-developer-hub-apis-programmatically-dabee6e.md). @@ -429,7 +429,7 @@ Sample payload to create a custom attribute via navigation \(application\) - Request Header: Authorization:Bearer - Response: bearer-token value - To know how to retrieve this token, see [Accessing API business hub enterprise APIs Programmatically](APIM-Initial-Setup/accessing-api-business-hub-enterprise-apis-programmatically-dabee6e.md). + To know how to retrieve this token, see [Accessing Developer Hub APIs Programmatically](APIM-Initial-Setup/accessing-developer-hub-apis-programmatically-dabee6e.md). > ### Sample Code: diff --git a/docs/apim/API-Management/customize-the-visual-format-of-the-api-business-hub-enterprise-2eacd52.md b/docs/apim/API-Management/customize-the-visual-format-of-the-developer-hub-2eacd52.md similarity index 90% rename from docs/apim/API-Management/customize-the-visual-format-of-the-api-business-hub-enterprise-2eacd52.md rename to docs/apim/API-Management/customize-the-visual-format-of-the-developer-hub-2eacd52.md index e6696d9f..204c6998 100644 --- a/docs/apim/API-Management/customize-the-visual-format-of-the-api-business-hub-enterprise-2eacd52.md +++ b/docs/apim/API-Management/customize-the-visual-format-of-the-developer-hub-2eacd52.md @@ -1,8 +1,8 @@ -# Customize the Visual Format of the API business hub enterprise +# Customize the Visual Format of the Developer Hub -As a Site Administrator, you can customize the visual layout of the API business hub enterprise using the Site Editor. The customizations you make using the Site Editor appear to the other users in the system. +As a Site Administrator, you can customize the visual layout of the Developer Hub using the Site Editor. The customizations you make using the Site Editor appear to the other users in the system. @@ -119,5 +119,5 @@ To modify the banner settings, ## Publish Changes -The customizations you've made to the API business hub enterprise layout will be available to the users once you publish the changes. +The customizations you've made to the Developer Hub layout will be available to the users once you publish the changes. 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 3d91d762..a1a702f4 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 @@ -186,9 +186,9 @@ API Management does not store any sensitive personal data. The only personal data of data subjects stored in API Management is the user ID. This user ID is stored whenever a user creates an API artifact, for example an API proxy or API product, and this user ID can be obtained \(read\) only from that artifact. -To enable data subjects to obtain information about their personal data in the API business hub enterprise, we provide the following service to retrieve their personal information: +To enable data subjects to obtain information about their personal data in the Developer Hub, we provide the following service to retrieve their personal information: -- [Service to View User Details on API business hub enterprise](service-to-view-user-details-on-api-business-hub-enterprise-a49c05f.md) +- [Service to View User Details on Developer Hub](service-to-view-user-details-on-developer-hub-a49c05f.md) @@ -202,9 +202,9 @@ Personal data can also include referenced data. The challenge for deletion and b API Management stores the API portal administrator’s user ID. Storing the user ID is a business requirement and the user ID is deleted when the resources created by the API portal administrator are removed. -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 API business hub enterprise. All the personal information stored in the application is deleted when the access for the corresponding user is revoked. +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 Hub. 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 API business hub enterprise administrators to have their personal data erased and access revoked. For more information, see [Revoke Access](revoke-access-ce609bb.md) and [Delete Data of Unregistered Users](delete-data-of-unregistered-users-d548233.md). +In API Management, application developers can contact their Developer Hub administrators to have their personal data erased and access revoked. For more information, see [Revoke Access](revoke-access-ce609bb.md) and [Delete Data of Unregistered Users](delete-data-of-unregistered-users-d548233.md). diff --git a/docs/apim/API-Management/download-bill-details-from-api-business-hub-enterprise-ae61972.md b/docs/apim/API-Management/download-bill-details-from-developer-hub-ae61972.md similarity index 85% rename from docs/apim/API-Management/download-bill-details-from-api-business-hub-enterprise-ae61972.md rename to docs/apim/API-Management/download-bill-details-from-developer-hub-ae61972.md index 9b8ed77f..0a16d1ef 100644 --- a/docs/apim/API-Management/download-bill-details-from-api-business-hub-enterprise-ae61972.md +++ b/docs/apim/API-Management/download-bill-details-from-developer-hub-ae61972.md @@ -1,8 +1,8 @@ -# Download Bill Details from API business hub enterprise +# Download Bill Details from Developer Hub -Download bill details using the API business hub enterprise. +Download bill details using the Developer Hub. @@ -26,7 +26,7 @@ To download the bill details, proceed as follows: ## Procedure -1. Log on to the API business hub enterprise. +1. Log on to the Developer Hub. 2. Navigate to, *My Workspace*. diff --git a/docs/apim/API-Management/edit-an-api-proxy-a64b952.md b/docs/apim/API-Management/edit-an-api-proxy-a64b952.md index 91170630..2094edba 100644 --- a/docs/apim/API-Management/edit-an-api-proxy-a64b952.md +++ b/docs/apim/API-Management/edit-an-api-proxy-a64b952.md @@ -8,7 +8,7 @@ Once you’ve created an API proxy you can further change the proxy, either on t ## Context -When you edit an API proxy either on the or using the API designer, ensure that you save and deploy the API proxy once the changes are made. Saving the API proxy is a design time activity, the changes you've made get pushed to the runtime only when you deploy the changes. Therefore, when you choose *Save* after making the changes, the changes are saved locally and don’t get published on the API business hub enterprise. Choose *Deploy* to perform an explicit deployment to bring in the new changes in the runtime during the API proxy execution. +When you edit an API proxy either on the or using the API designer, ensure that you save and deploy the API proxy once the changes are made. Saving the API proxy is a design time activity, the changes you've made get pushed to the runtime only when you deploy the changes. Therefore, when you choose *Save* after making the changes, the changes are saved locally and don’t get published on the Developer Hub. Choose *Deploy* to perform an explicit deployment to bring in the new changes in the runtime during the API proxy execution. Consider the following examples: @@ -181,7 +181,7 @@ Consider the following examples: > ### Note: > When you’re editing the swagger structure in the API designer, editing the same from the tabs is disabled. - If the API proxy is already in the deployed state, then saving the changes after editing the API doesn’t deploy the latest changes. Similarly, if the API proxy is already published on the API business hub enterprise, the save action doesn’t publish the latest changes. In both cases, a message appears on the *View API* page that the changes you've made aren't deployed. For the changes to reflect during API proxy runtime flow, choose *Click to Deploy* and provide your confirmation on the popup window. + If the API proxy is already in the deployed state, then saving the changes after editing the API doesn’t deploy the latest changes. Similarly, if the API proxy is already published on the Developer Hub, the save action doesn’t publish the latest changes. In both cases, a message appears on the *View API* page that the changes you've made aren't deployed. For the changes to reflect during API proxy runtime flow, choose *Click to Deploy* and provide your confirmation on the popup window. diff --git a/docs/apim/API-Management/externally-managed-apis-848015d.md b/docs/apim/API-Management/externally-managed-apis-848015d.md index 488c5718..5fec4cf9 100644 --- a/docs/apim/API-Management/externally-managed-apis-848015d.md +++ b/docs/apim/API-Management/externally-managed-apis-848015d.md @@ -4,7 +4,7 @@ You can add and view APIs that are not managed by 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 , without adding management capability \(proxy creation and policies\) of and publish them to API business hub enterprise. +You can import an API definition \(Open API Specification 2.0 or 3.0\) of externally managed APIs in , without adding management capability \(proxy creation and policies\) of and publish them to Developer Hub. @@ -17,7 +17,7 @@ You can import an API definition \(Open API Specification 2.0 or 3.0\) of extern - These APIs are only listed in . No aspect of their life cycle is managed by . - Status \(Deployed/Not Deployed\) is not displayed for these APIs. - These APIs are represented by the symbol: ![](images/External_API_94e5ac7.png) -- If you create a product using only externally managed APIs , your consumers can't view the rate plan for these APIs, nor can they subscribe to the product or use custom attributes for the product in the API business hub enterprise. For more information, see [Create a Product](create-a-product-d769622.md). +- If you create a product using only externally managed APIs , your consumers can't view the rate plan for these APIs, nor can they subscribe to the product or use custom attributes for the product in the Developer Hub. For more information, see [Create a Product](create-a-product-d769622.md). - 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). diff --git a/docs/apim/API-Management/images/ABHE_Block_509b298.png b/docs/apim/API-Management/images/ABHE_Block_509b298.png index b95a44a1..b921918f 100644 Binary files a/docs/apim/API-Management/images/ABHE_Block_509b298.png and b/docs/apim/API-Management/images/ABHE_Block_509b298.png differ diff --git a/docs/apim/API-Management/limits-in-api-management-f70f425.md b/docs/apim/API-Management/limits-in-api-management-f70f425.md index 4a2af45d..54d0fbdc 100644 --- a/docs/apim/API-Management/limits-in-api-management-f70f425.md +++ b/docs/apim/API-Management/limits-in-api-management-f70f425.md @@ -89,7 +89,7 @@ Maximum number of resources that can be attached to an API proxy > ### Note: > By selectively choosing resources, we mean avoiding the attempt to select specific resources from the *Add API* dialog while adding an API proxy to a product on the *Create Product* page. -- If you are using API business hub enterprise OData APIs to retrieve resources from an API proxy, please note that the retrieved result may not include all the resources available in the API proxy. +- If you are using Developer Hub OData APIs to retrieve resources from an API proxy, please note that the retrieved result may not include all the resources available in the API proxy. diff --git a/docs/apim/API-Management/manage-developer-access-9df3ece.md b/docs/apim/API-Management/manage-developer-access-9df3ece.md index e51ebc4f..dd2e9c01 100644 --- a/docs/apim/API-Management/manage-developer-access-9df3ece.md +++ b/docs/apim/API-Management/manage-developer-access-9df3ece.md @@ -2,7 +2,7 @@ # 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. +As an Developer Hub 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 Developer Hub. @@ -18,7 +18,7 @@ You need the following role to configure the access control checks: > ### Note: -> The **Manage Access** feature is available only in the new design of the API business hub enterprise on the Cloud Foundry environment. +> The **Manage Access** feature is available only in the new design of the Developer Hub on the Cloud Foundry environment. @@ -26,19 +26,19 @@ You need the following role to configure the access control checks: ## Context -In API business hub enterprise, managing access for different users is important for several reasons like improving user productivity, resource optimization, privacy, and security. +In Developer Hub, managing access for different users is important for several reasons like improving user productivity, resource optimization, privacy, and security. User productivity is enhanced by granting users the appropriate access to carry out their tasks efficiently, without being overwhelmed by unnecessary information or resources. In this context, the **All Visitors** option allows anyone, whether logged in or not, to utilize the APIs without requiring authentication. However, the ability to consume the APIs still depends on obtaining the necessary developer role. -Moreover, by managing access, you can provide access to **Authenticated Users** who do not have a designated role, allowing them to access different pages of the API business hub enterprise based on their specific needs. This facilitates broader exploration and enables users to familiarize themselves with the available resources. Nevertheless, the ability to consume the APIs still relies on obtaining the necessary developer role. +Moreover, by managing access, you can provide access to **Authenticated Users** who do not have a designated role, allowing them to access different pages of the Developer Hub based on their specific needs. This facilitates broader exploration and enables users to familiarize themselves with the available resources. Nevertheless, the ability to consume the APIs still relies on obtaining the necessary developer role. To maintain privacy and security, you can grant access to**Authorized Users** who are logged in and possess the required developer role. This ensures that only authorized individuals can seamlessly access and consume the APIs while upholding privacy and security measures. > ### Note: -> Access to the API business hub enterprise content using the API access plan is not affected by these permissions. +> Access to the Developer Hub content using the API access plan is not affected by these permissions. > ### Note: -> As an administrator of API business hub enterprise, please note that when you update these permissions, it may take up to 5 minutes for the changes to be applied for other users of the API business hub enterprise. +> As an administrator of Developer Hub, please note that when you update these permissions, it may take up to 5 minutes for the changes to be applied for other users of the Developer Hub. @@ -46,9 +46,9 @@ To maintain privacy and security, you can grant access to**Authorized Users** wh ## Procedure -1. Log on to the **API business hub enterprise**. +1. Log on to the **Developer Hub**. -2. Choose *Enterprise Manager* \> *Manage Access* from the top navigation bar. +2. Choose *Admin Center* \> *Manage Access* from the top navigation bar. ![](images/Manage_Access_SUI_492ece2.png) @@ -56,13 +56,13 @@ To maintain privacy and security, you can grant access to**Authorized Users** wh Select the appropriate permission from the following list: - - *Authorised Users*: These are the users who are registered as application developers or have the privilege of the application developer assigned through the SAP BTP cockpit. They can search, discover, and consume the contents of this API business hub enterprise application. + - *Authorised Users*: These are the users who are registered as application developers or have the privilege of the application developer assigned through the SAP BTP cockpit. They can search, discover, and consume the contents of this Developer Hub application. > ### Note: > By default, the option for *Authorised Users* is selected. However, you have the flexibility to change it to either *All Visitors* or *Authenticated Users*, depending on your specific requirements. - - *Authenticated Users*: These users are not registered as application developers but are successfully authenticated by the API business hub enterprise application and can access the following pages: + - *Authenticated Users*: These users are not registered as application developers but are successfully authenticated by the Developer Hub application and can access the following pages: - Home @@ -73,7 +73,7 @@ To maintain privacy and security, you can grant access to**Authorized Users** wh Optionally, you can select the *API Details* checkbox to provide access to the *API Details* page as well. - - *All Visitors*: These are the users who can visit the following pages even before they are authenticated by the API business hub enterprise application, that is without logging in to the API business hub enterprise application: + - *All Visitors*: These are the users who can visit the following pages even before they are authenticated by the Developer Hub application, that is without logging in to the Developer Hub application: - Home diff --git a/docs/apim/API-Management/manage-domain-categories-bd9691d.md b/docs/apim/API-Management/manage-domain-categories-bd9691d.md index 25a07a23..265f0e04 100644 --- a/docs/apim/API-Management/manage-domain-categories-bd9691d.md +++ b/docs/apim/API-Management/manage-domain-categories-bd9691d.md @@ -4,7 +4,7 @@ # Manage Domain Categories -Domain categories are displayed on the API business hub enterprise home page. +Domain categories are displayed on the Developer Hub home page. @@ -32,7 +32,7 @@ You need the following roles to create and update categories: Content administrators can use *Manage Content* to create domain categories and add the related products into relevant categories. They can also configure the order in which these categories and the contained products get displayed in the home page. > ### 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. +> If you've configured the Developer Hub 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. Use the following procedure to configure navigation categories. @@ -42,9 +42,9 @@ Use the following procedure to configure navigation categories. ## Procedure -1. Log on to the **API business hub enterprise**. +1. Log on to the **Developer Hub**. -2. Choose *Enterprise Manager* \> *Manage Domain Categories* from the top navigation bar. +2. Choose *Admin Center* \> *Manage Domain Categories* from the top navigation bar. 3. To add a category, choose *Add New Domain Category*. diff --git a/docs/apim/API-Management/manage-notifications-df32457.md b/docs/apim/API-Management/manage-notifications-df32457.md index 80ce6258..c3f9ddcf 100644 --- a/docs/apim/API-Management/manage-notifications-df32457.md +++ b/docs/apim/API-Management/manage-notifications-df32457.md @@ -4,7 +4,7 @@ # 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. +As a site administrator you can configure notifications for providing information to the Developer Hub end users on any website updates, events or news items. @@ -20,9 +20,9 @@ You’re assigned the *AuthGroup.Site.Admin* role. To assign the role, see [Mana ## Procedure -1. Log on to the API business hub enterprise. +1. Log on to the Developer Hub. -2. Choose *Enterprise Manager* \> *Notifications* from the top navigation bar. +2. Choose *Admin Center* \> *Notifications* from the top navigation bar. 3. Choose *Add Notification*. @@ -40,7 +40,7 @@ You’re assigned the *AuthGroup.Site.Admin* role. To assign the role, see [Mana Enter a name for the notification entity. - **Example**: Experience the new design of the API business hub enterprise! + **Example**: Experience the new design of the Developer Hub! @@ -54,7 +54,7 @@ You’re assigned the *AuthGroup.Site.Admin* role. To assign the role, see [Mana Enter a description for the notification entity. - **Example**: If you’ve subscribed to API business hub enterprise as part of Integration Suite subscription , we now have a new design of the user interface for you to experience. + **Example**: If you’ve subscribed to Developer Hub as part of Integration Suite subscription , we now have a new design of the user interface for you to experience. diff --git a/docs/apim/API-Management/managing-the-access-request-of-the-users-8b79ee8.md b/docs/apim/API-Management/managing-the-access-request-of-the-users-8b79ee8.md index ab0926a5..0e9cbbcb 100644 --- a/docs/apim/API-Management/managing-the-access-request-of-the-users-8b79ee8.md +++ b/docs/apim/API-Management/managing-the-access-request-of-the-users-8b79ee8.md @@ -2,7 +2,7 @@ # Managing the Access Request of the Users -As an API administrator, you can approve or reject the access request made by an application developer to use the API business hub enterprise. +As an API administrator, you can approve or reject the access request made by an application developer to use the Developer Hub. @@ -18,11 +18,11 @@ You’re assigned the *AuthGroup.API.Admin* role. ## Procedure -1. Log on to the **API business hub enterprise**. +1. Log on to the **Developer Hub**. Use the *Manage Users* page to approve or reject the developer's registration requests and manage the roles of the registered users. For assigning roles to the users, use the SAP BTP Cockpit. -2. Choose *Enterprise Manager* \> *Manage Users* \> *E-mail Configuration* and add the administrator’s email in the *E-mail Configuration* textbox. +2. Choose *Admin Center* \> *Manage Users* \> *E-mail Configuration* and add the administrator’s email in the *E-mail Configuration* textbox. The administrator receives email notification of the pending developer registration requests on this email id. Also, the e-mail notifications to the developers or users are sent from this e-mail id. @@ -31,7 +31,7 @@ You’re assigned the *AuthGroup.API.Admin* role. 3. To view the pending requests, navigate to *Manage Users* \> *New Requests*. -4. Look for the request and choose *Accept Request* from the *Actions* coulmn. The application developer can now access the API business hub enterprise. +4. Look for the request and choose *Accept Request* from the *Actions* coulmn. The application developer can now access the Developer Hub. > ### Note: > The user will be added to all the IDPs configured in the sub-account, along with the *ApplicationDeveloper* role. @@ -47,7 +47,7 @@ You’re assigned the *AuthGroup.API.Admin* role. - Register a new user by choosing *Add User*. > ### Note: - > A user must be onboarded to API business hub enterprise only via Self-registration or **Add User** flow. + > A user must be onboarded to Developer Hub only via Self-registration or **Add User** flow. In the *Add User* dialog: @@ -77,7 +77,7 @@ You’re assigned the *AuthGroup.API.Admin* role. - Manages user registration. Create and delete applications on behalf of application developers. In addition, create custom attributes and import the app key. + Manages user registration. Creates and deletes applications on behalf of application developers. In addition, creates custom attributes and imports the app key. @@ -89,7 +89,7 @@ You’re assigned the *AuthGroup.API.Admin* role. - Create applications and check billing and metering data. Test APIs and view analytics data. + Creates applications and checks billing and metering data, tests APIs, and views analytics data. @@ -101,7 +101,7 @@ You’re assigned the *AuthGroup.API.Admin* role. - Configure updates, and perform portal changes like uploading the logo, changing the name and the description, and changing the footer links for the site. + Configures, updates, and performs portal changes such as uploading the logo, changing the name and description, and modifying the footer links for the site. @@ -113,7 +113,7 @@ You’re assigned the *AuthGroup.API.Admin* role. - Manages content categories. + Creates products that include APIs from different business systems and manages the content that application developers can view in the catalog. diff --git a/docs/apim/API-Management/monetize-apis-fcdc89b.md b/docs/apim/API-Management/monetize-apis-fcdc89b.md index c82420fc..c6fe52a6 100644 --- a/docs/apim/API-Management/monetize-apis-fcdc89b.md +++ b/docs/apim/API-Management/monetize-apis-fcdc89b.md @@ -4,9 +4,9 @@ provides monetization feature to all API providers to generate revenue for using the APIs. -As an API Admin, you can create a rate plan, attach it to a product in the , and publish the product in the API business hub enterprise. You can also view bill details of each developer in the . +As an API Admin, you can create a rate plan, attach it to a product in the , and publish the product in the Developer Hub. You can also view bill details of each developer in the . -As an application developer, in the API business hub enterprise you can create an application and add products to the application. Based on the product usage, you can view the corresponding bill details. +As an application developer, in the Developer Hub you can create an application and add products to the application. Based on the product usage, you can view the corresponding bill details. provides this feature through the following services: 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 b21da8f2..c18676ef 100644 --- a/docs/apim/API-Management/onboard-an-application-developer-786d107.md +++ b/docs/apim/API-Management/onboard-an-application-developer-786d107.md @@ -2,23 +2,23 @@ # Onboard an Application Developer -Explains how API administrators can onboard application developers so they can access the API business hub enterprise. +Explains how API administrators can onboard application developers so they can access the Developer Hub. ## Context -A user must be onboarded to API business hub enterprise only via Self-registration or **Add User** flow. +A user must be onboarded to Developer Hub only via Self-registration or **Add User** flow. -To provide application developers with access to the API business hub enterprise, the API Administrator first has to onboard them. The steps to onboard an application developer are as follows: +To provide application developers with access to the Developer Hub, the API Administrator first has to onboard them. The steps to onboard an application developer are as follows: ## Procedure -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). +1. The application developers log on to the Developer Hub application with their IDP user credentials, and register to the Developer Hub. For more information, see [Register on Developer Hub](register-on-developer-hub-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](managing-the-access-request-of-the-users-8b79ee8.md). +2. The API administrator approves or rejects the request to access the Developer Hub. For more information, see [Managing the Access Request of the Users](managing-the-access-request-of-the-users-8b79ee8.md). If you haven’t enabled the automatic creation of shadow users, and you've not explicitly created shadow users for your developers, then they’re unable to log on to the application, and they’re asked to contact the administrator. For more information, see [Shadow Users](APIM-Initial-Setup/shadow-users-a0f5fe5.md) diff --git a/docs/apim/API-Management/other-issues-e6755e1.md b/docs/apim/API-Management/other-issues-e6755e1.md index 70cf910c..28a57a69 100644 --- a/docs/apim/API-Management/other-issues-e6755e1.md +++ b/docs/apim/API-Management/other-issues-e6755e1.md @@ -38,11 +38,7 @@ If yes, please make sure that you have: - Subscribed to Content Agent \(plan: free\). See [Subscribe to Content Agent User Interface](https://help.sap.com/docs/content-agent-service/user-guide/subscribe-to-content-agent-service?version=Cloud). 2. Destination Subaccount \(Example: TMS\_Destination\) - - Subscribed to API Management \(plan: default\). See: - - Integration Suite: [Activate and Configure API Management Capability](https://help.sap.com/docs/integration-suite/sap-integration-suite/enabling-api-management-capability-from-integration-suite?version=CLOUD). - - Standalone: [Setting Up API Portal Application Using API Management Standalone Tile](https://help.sap.com/docs/sap-api-management/sap-api-management/setting-up-api-portal-application-using-api-management-standalone-tile?version=Cloud). + - Standalone: [Setting Up API Portal Application Using API Management Standalone Tile](https://help.sap.com/docs/sap-api-management/sap-api-management/setting-up-api-portal-application-using-api-management-standalone-tile?version=Cloud). - Subscribed to Content Agent \(plan: free\). See [Subscribe to Content Agent User Interface](https://help.sap.com/docs/content-agent-service/user-guide/subscribe-to-content-agent-service?version=Cloud). 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 e9eddc5e..793a1550 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 @@ -431,11 +431,11 @@ 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: +- 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 Developer Hub 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 APIProduct uses the name as the primary key in Developer Hub, 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. diff --git a/docs/apim/API-Management/register-on-api-business-hub-enterprise-c85fafe.md b/docs/apim/API-Management/register-on-developer-hub-c85fafe.md similarity index 68% rename from docs/apim/API-Management/register-on-api-business-hub-enterprise-c85fafe.md rename to docs/apim/API-Management/register-on-developer-hub-c85fafe.md index 01d4bb63..0ea9975a 100644 --- a/docs/apim/API-Management/register-on-api-business-hub-enterprise-c85fafe.md +++ b/docs/apim/API-Management/register-on-developer-hub-c85fafe.md @@ -1,8 +1,8 @@ -# Register on API business hub enterprise +# Register on Developer Hub -Procedure to register as an application developer on the API business hub enterprise to view the products available in the catalog store. The API business hub enterprise also enables you to explore the APIs, read the associated API documentation, and view resources. +Procedure to register as an application developer on the Developer Hub to view the products available in the catalog store. The Developer Hub also enables you to explore the APIs, read the associated API documentation, and view resources. @@ -16,11 +16,11 @@ Procedure to register as an application developer on the API business hub enterp > ### Note: - > If the *AuthGroup.API.ApplicationDeveloper* role is already assigned to you by the SAP BTP admin or via the IDP Role Collection mapping, you will get automatically registered as an application developer in API business hub enterprise when you logon for the first time. + > If the *AuthGroup.API.ApplicationDeveloper* role is already assigned to you by the SAP BTP admin or via the IDP Role Collection mapping, you will get automatically registered as an application developer in Developer Hub when you logon for the first time. > - > If you don't have the *AuthGroup.API.ApplicationDeveloper* role assigned to you in SAP BTP cockpit, complete the self-registration process to access all the funtionalities and features of API business hub enterprise. + > If you don't have the *AuthGroup.API.ApplicationDeveloper* role assigned to you in SAP BTP cockpit, complete the self-registration process to access all the funtionalities and features of Developer Hub. > - > Please note that the *AuthGroup.API.ApplicationDeveloper* role that has been assigned to you will only take effect if you login to API business hub enterprise. Only relevant for New Design of the API business hub enterprise. + > Please note that the *AuthGroup.API.ApplicationDeveloper* role that has been assigned to you will only take effect if you login to Developer Hub. Only relevant for New Design of the Developer Hub. - As an Admin you're trying to onboard multiple users: @@ -39,11 +39,11 @@ Procedure to register as an application developer on the API business hub enterp > > - **Use Case 1: User is no longer in the organization:** > - > If the *AuthGroup.API.ApplicationDeveloper* role is removed from either the SAP BTP cockpit or the IDP Role Collection mapping, as an admin, you should also ensure that the *AuthGroup.API.ApplicationDeveloper* role is removed from the API business hub enterprise, or vice versa. Failing to do so may lead to confusion and discrepancies. + > If the *AuthGroup.API.ApplicationDeveloper* role is removed from either the SAP BTP cockpit or the IDP Role Collection mapping, as an admin, you should also ensure that the *AuthGroup.API.ApplicationDeveloper* role is removed from the Developer Hub, or vice versa. Failing to do so may lead to confusion and discrepancies. > > - **Use Case 2: User is still in the organization:** > - > If a user is still part of the organization, the role removal in BTP will take effect in the API business hub enterprise once the user logs in. If this user wishes to access the API business hub enterprise, they must either follow the self-registration process or have this role assigned to them from the SAP BTP Cockpit. + > If a user is still part of the organization, the role removal in BTP will take effect in the Developer Hub once the user logs in. If this user wishes to access the Developer Hub, they must either follow the self-registration process or have this role assigned to them from the SAP BTP Cockpit. @@ -58,24 +58,24 @@ The procedure below describes the sequence of steps when as a developer you're t ## Procedure -1. Log on to the API business hub enterprise application with your IDP user credentials. +1. Log on to the Developer Hub application with your IDP user credentials. -2. To register to the API business hub enterprise as an Application developer, choose *Register*. +2. To register to the Developer Hub as an Application developer, choose *Register*. A dialog box with the prepopulated data such as, your first name, last name, and e-mail address appears. -3. Enter the country/region and reason for requesting access to the API business hub enterprise. +3. Enter the country/region and reason for requesting access to the Developer Hub. 4. Choose *OK*. The request is sent to the administrator with the AuthGroup.API.Admin role. - - If the administrator approves your request, you’ll receive an e-mail notification. You can log in to the API business hub enterprise via the link provided in the e-mail. + - If the administrator approves your request, you’ll receive an e-mail notification. You can log in to the Developer Hub via the link provided in the e-mail. - If the administrator rejects the request, you’ll receive an e-mail notification with the reason for the rejection. When you log on to the application, you’ll see the reason for request rejection on the display page. > ### Note: - > Application Developers can now email to the administrator by replying to the email notification they receive for any queries regarding their access request to the API business hub enterprise application. + > Application Developers can now email to the administrator by replying to the email notification they receive for any queries regarding their access request to the Developer Hub application. diff --git a/docs/apim/API-Management/revoke-access-ce609bb.md b/docs/apim/API-Management/revoke-access-ce609bb.md index 308bc9ad..bf1b0dd9 100644 --- a/docs/apim/API-Management/revoke-access-ce609bb.md +++ b/docs/apim/API-Management/revoke-access-ce609bb.md @@ -20,7 +20,7 @@ You are an API administrator and the role *AuthGroup.API.Admin* is assigned to y ## Context -As an API administrator, you use this procedure to revoke an application developer's access for using the API business hub enterprise. +As an API administrator, you use this procedure to revoke an application developer's access for using the Developer Hub. @@ -28,9 +28,9 @@ As an API administrator, you use this procedure to revoke an application develop ## Procedure -1. Log on to the **API business hub enterprise**. +1. Log on to the **Developer Hub**. -2. Choose *Enterprise Manager* \> *Manage Users* \> *Registered Users*. +2. Choose *Admin Center* \> *Manage Users* \> *Registered Users*. 3. From the list of application developers, select the application developer whose access you want to revoke and choose the Revoke Usericon under the *Actions* column. @@ -46,5 +46,5 @@ As an API administrator, you use this procedure to revoke an application develop ## Results -You have revoked the access of the user from using API business hub enterprise successfully. +You have revoked the access of the user from using Developer Hub successfully. diff --git a/docs/apim/API-Management/sap-api-management-in-the-cloud-foundry-environment-7d8514b.md b/docs/apim/API-Management/sap-api-management-in-the-cloud-foundry-environment-7d8514b.md index a7c6367e..0c2e10e6 100644 --- a/docs/apim/API-Management/sap-api-management-in-the-cloud-foundry-environment-7d8514b.md +++ b/docs/apim/API-Management/sap-api-management-in-the-cloud-foundry-environment-7d8514b.md @@ -111,5 +111,5 @@ API Management technology helps you to share digital assets and enable developer The Cloud Foundry environment gives you the ability to subscribe to the API Management service, while you may choose a public infrastructure to run the API Management service, such as Amazon Web Services or microsoft Azure. -Get started by subscribing to API portal and API business hub enterprise applications where you can create APIs and consume them. For setting up the API Portal application, see [here](APIM-Initial-Setup/set-up-api-portal-application-29c281b.md). Once the API portal is setup, see [here](APIM-Initial-Setup/set-up-api-business-hub-enterprise-application-using-the-standalone-tile-80c0519.md) to set up the API business hub enterprise application. +Get started by subscribing to API portal and Developer Hub applications where you can create APIs and consume them. For setting up the API Portal application, see [here](APIM-Initial-Setup/set-up-api-portal-application-29c281b.md). Once the API portal is setup, see [here](APIM-Initial-Setup/set-up-developer-hub-application-using-the-standalone-tile-80c0519.md) to set up the Developer Hub application. diff --git a/docs/apim/API-Management/service-to-view-user-details-on-api-business-hub-enterprise-a49c05f.md b/docs/apim/API-Management/service-to-view-user-details-on-developer-hub-a49c05f.md similarity index 63% rename from docs/apim/API-Management/service-to-view-user-details-on-api-business-hub-enterprise-a49c05f.md rename to docs/apim/API-Management/service-to-view-user-details-on-developer-hub-a49c05f.md index df4c0049..8678f82e 100644 --- a/docs/apim/API-Management/service-to-view-user-details-on-api-business-hub-enterprise-a49c05f.md +++ b/docs/apim/API-Management/service-to-view-user-details-on-developer-hub-a49c05f.md @@ -1,15 +1,15 @@ -# Service to View User Details on API business hub enterprise +# Service to View User Details on Developer Hub -API Management allows user to view their personal data stored in the API business hub enterprise. +API Management allows user to view their personal data stored in the Developer Hub. -**Service to view personal data on API business hub enterprise:** +**Service to view personal data on Developer Hub:** - URL: https:///api/1.0/user - Method: GET -- Response: Fetches your personal details stored in API business hub enterprise. +- Response: Fetches your personal details stored in Developer Hub. > ### Sample Code: > Sample response diff --git a/docs/apim/API-Management/spike-arrest-bf441dc.md b/docs/apim/API-Management/spike-arrest-bf441dc.md index d1e8fba9..98c142ca 100644 --- a/docs/apim/API-Management/spike-arrest-bf441dc.md +++ b/docs/apim/API-Management/spike-arrest-bf441dc.md @@ -4,81 +4,366 @@ The Spike Arrest policy limits the number of requests forwarded from the point in the processing flow where the policy is attached as a processing step. -You can attach a Spike Arrest policy at the proxy endpoint or the target endpoint. At the proxy endpoint, this policy limits inbound requests. When you attach this policy at the TargetEndpoint, it limits request forwarded to the backend service. +You can attach a Spike Arrest policy at the proxy endpoint or at the target endpoint. At the Proxy Endpoint, this policy limits the inbound requests. When you attach this policy at the Target Endpoint, it limits the requests forwarded to the backend service. -Unlike Quotas, spike arrests are not implemented as counts. Rather, they are implemented as a rate limit which is based on the time the last matching message was processed. If you specify 6 messages per minute, it means that requests can only be submitted at the rate of one per 10 second interval. A second request within 10 seconds on the same API Management server will be rejected. Even with a larger number \(200 per second\), if two requests come in nearly simultaneously to the same API Management server, one will be rejected. Each successful request will update the spike arrest's last processed count. +Unlike Quotas, spike arrests are not implemented as counts. Rather, they are implemented as a rate limit which is based on the time the last matching message was processed. For example, if you specify 6 messages per minute, it means that the requests can only be submitted at the rate of one per 10 second interval. The second request within the 10 seconds on the same API Management server will be rejected. Even with a larger number of requests \(200 per second\), if two requests come in nearly simultaneously to the same API Management server, one will be rejected. Each successful request will update the spike arrest's last processed count. -No counter is maintained for spike arrests, only a time that the last message was successfully passed through the Spike Arrest policy. On a given API Management server, if a request is received now, all subsequent requests will fail until 10 seconds has elapsed. Since Spike Arrest is not distributed, you might see some discrepancy between the actual behavior of the system and your expected results. In general, you should use Spike Arrest to set a limit that throttles traffic to what your backend services can handle. Do not use Spike Arrest to limit traffic from individual clients. +No counter is maintained for spike arrests, only the time that the last message was successfully passed through the Spike Arrest policy is maintained. On a given API Management server, if a request is received now, all subsequent requests will fail until the duration of 10 seconds has elapsed. Since Spike Arrest policy is not distributed, you might see some discrepancy between the actual behavior of the system and your expected results. In general, you should use Spike Arrest policy to set a limit that throttles traffic to what your backend services can handle. Do not use Spike Arrest policy to limit traffic from individual clients. You can attach the policy in the following locations: ![](images/flow_policy_1_1aa837c.png) An example payload for the policy is as follows: > ### Code Syntax: +> > ### Sample Code: +> > ``` +> >  +> > +> > +> > +> > +> > +> > 30pm +> > +> > ``` + +**`` element** + + + + + + + + + + + + + + + +
+ +Element + + + +Default + + + +Type + + + +Description + +
+ +`Identifier` \(Optional\) + + + +N/A + + + +String + + + +Flow variable used for identifying the application or client. + +> ### Sample Code: > ``` -> -> -> -> > > -> -> 30pm > -> > ``` + +
+ +**`ref` attribute of the `` element** + + + + + + + +
-**Elements and Attributes** +Attribute + + + +Default + + + +Type -**Description** +Description
-Identifier ref +`ref` \(Required\) + + + +N/A -Variable used for uniquely identifying the application or client. +N/A + +Identifies the flow variable by which Spike Arrest groups incoming requests. + +
+ +**`` element** + + + + + + + + + + +
+ +Element + + + +Default + + + +Type + + + +Description + +
-MessageWeight ref +`MessageWeight` \(Optional\) + + + +N/A + + + +Integer Specifies the weight defined for each message. -Message weight is used to modify the impact of a single request on the calculation of the SpikeArrest limit. Message weight can be set by variables based on HTTP headers, query parameters, or message body content. For example, if the SpikeArrest Rate is 10 per minute, and an application submits requests with weight 5, then only 2 messages are permitted per minute from that application. +Message weight modifies the impact of a single request on the calculation of the SpikeArrest limit. Message weight can be set by variables based on HTTP headers, query parameters, or message body content. + +For example, if the SpikeArrest Rate is 10 per minute, and an application submits requests with weight 5, then only 2 messages are permitted per minute from that application. + +> ### Sample Code: +> ``` +> +> +> +> ``` + +
+ +**`ref` attribute of the `` element** + + + + + + + + + + + + + + +
+ +Attribute + + + +Default + + + +Type + + + +Description + +
+ +`ref` \(Required\) + + + +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 + + -Rate +Interger Specifies the rate at which to limit the traffic spike \(or burst\). -Valid value: integer per or or . +Valid value: integer per or or + +> ### Sample Code: +> ``` +> +> 30pm +> +> ``` + + + +
+ +**`` element** + + + + + + + + + + + + + + @@ -208,11 +493,28 @@ FailedToResolveSpikeArrestRate The referenced variable used to specify the rate can't be resolved. + + + + + +
+ +Element + + + +Default + + + +Type + + + +Description + +
+ +`UseEffectiveCount` \(Optional\) + + + +N/A + + + +Boolean + + + +Distributes your Spike Arrest count across Message Processors \(MPs\) when using auto-scalin groups. + +> ### Sample Code: +> ``` +> +> true +> +> ``` + +
+ +InvalidAllowedRate + + + +500 + + + +If the spike arrest rate specified in the `` element of the Spike Arrest Policy is not an integer or if the rate does not have ps or pm as a suffix, then the deployment of the API proxy fails. +
-Following fault variables are set when the policy triggers an error at runtime: +The folFlowing fault variables are set when the policy triggers an error at runtime: **Fault Variables** @@ -243,7 +545,7 @@ Example -The fault variable \[prefix\] is ratelimit. +The fault variable \[prefix\] is rate limit. The \[policy\_name\] is the name of the policy that threw the error. diff --git a/docs/apim/API-Management/subscribe-to-a-product-486d263.md b/docs/apim/API-Management/subscribe-to-a-product-486d263.md index df918e21..603f4cac 100644 --- a/docs/apim/API-Management/subscribe-to-a-product-486d263.md +++ b/docs/apim/API-Management/subscribe-to-a-product-486d263.md @@ -16,7 +16,7 @@ On the homepage, you can find the list of products under various categories. You ## Procedure -1. Log on to the API business hub enterprise. +1. Log on to the Developer Hub. 2. You can either look for the product under various categories, or use the search bar to search for the product. diff --git a/docs/apim/API-Management/test-api-proxies-3ba6151.md b/docs/apim/API-Management/test-api-proxies-3ba6151.md index 6ba20308..96ec1944 100644 --- a/docs/apim/API-Management/test-api-proxies-3ba6151.md +++ b/docs/apim/API-Management/test-api-proxies-3ba6151.md @@ -12,7 +12,7 @@ The API Test Console allows you to test OData and REST-based services. ## Procedure -**Context**: You have logged on to the API portal or API business hub enterprise. +**Context**: You have logged on to the API portal or Developer Hub. 1. Log on to the . diff --git a/docs/apim/API-Management/test-runtime-behavior-of-apis-15c7d52.md b/docs/apim/API-Management/test-runtime-behavior-of-apis-15c7d52.md index 357af986..8ddf40ee 100644 --- a/docs/apim/API-Management/test-runtime-behavior-of-apis-15c7d52.md +++ b/docs/apim/API-Management/test-runtime-behavior-of-apis-15c7d52.md @@ -7,7 +7,7 @@ Use the API Test Environment to test the runtime behavior of APIs. The *Test Environment* enables you to test your APIs. Testing an API is essential to understand the runtime behavior of the APIs. It allows you to explore the resources associated with an API and execute the operations. It also allows you to test OData and REST-based services. > ### Note: -> This document describes the new design of the API business hub enterprise. To view the documentation for the classic design, see [Test API Proxies](test-api-proxies-3ba6151.md). +> This document describes the new design of the Developer Hub. To view the documentation for the classic design, see [Test API Proxies](test-api-proxies-3ba6151.md). @@ -23,7 +23,7 @@ The *Test Environment* tab will be visible to you only if you have the *AuthGrou ## Procedure -1. Log on to the API business hub enterprise. +1. Log on to the Developer Hub. 2. Navigate to the *Test Environment*. diff --git a/docs/apim/API-Management/user-roles-and-responsibilities-in-api-business-hub-enterprise-54b4607.md b/docs/apim/API-Management/user-roles-and-responsibilities-in-api-business-hub-enterprise-54b4607.md deleted file mode 100644 index 7d5fc05e..00000000 --- a/docs/apim/API-Management/user-roles-and-responsibilities-in-api-business-hub-enterprise-54b4607.md +++ /dev/null @@ -1,642 +0,0 @@ - - -# User Roles and Responsibilities in API business hub enterprise - -After activating the API business hub enterprise in the Integration Suite, you need to assign users the necessary roles and role collections to access the various features and functionalities of API business hub enterprise. - -Once the appropriate roles have been assigned, you can configure and customize the API business hub enterprise to align with your organization's needs. - -Your access to various features on the API business hub enterprise will depend on the service plan you have subscribed to. - - - -The roles and features offered in the Standard and Premium service plans include: - -- Key Actions for Admins in API business hub enterprise - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - As... - - - - You can use… - - - - Important Notes - - - - For more information, see… - -
- - An *API Admin*, you already have the *AuthGroup.API.Admin* role collection assigned to you. - - - - *Home Page* to browse and search through the various categories, APIs, and products available on the . - - - -   - - - - [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 - - - - - - - The availability of this feature is dependent on your service plan. For more information about different service plans and their supported feature set, see SAP Note [2903776](https://me.sap.com/notes/2903776). - - - - [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. - - - - The availability of this feature is dependent on your service plan. For more information about different service plans and their supported feature set, see SAP Note [2903776](https://me.sap.com/notes/2903776). - - - - [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](managing-the-access-request-of-the-users-8b79ee8.md) - - [Revoke Access](revoke-access-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 collection 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 collection 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) - -
- -   - - - - *Enterprise Manager* \> *Manage Content* to create products that includes APIs from different business systems and manage the content that application developers can view on the catalog. - - - -   - - - - - -
- -   - - - - *Enterprise Manager* \> *Manage Content* to monitor and manage all requests for product creation and updates. - - - -   - - - - - -
- -- Key Actions for Application Developers in API business hub enterprise - - - - - - - - - - - - - - - - - - - - - - - - - -
- - As... - - - - You can use… - - - - Important Notes - - - - For more information, see… - -
- - An *Application Developer* you already have the *AuthGroup.API.ApplicationDeveloper* role collection assigned to you. - - > ### Note: - > The *AuthGroup.API.ApplicationDeveloper* role collection 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. - - - - - - The *Home page* to explore the product created on API business hub enterprise and view the APIs within the products, but you can't subscribe to them. - - - - - - - - - -
- - *My Workspace* to create applications, view your applications, monitor costs, and analyze reports. - - - - The availability of this feature is dependent on your service plan. For more information about different service plans and their supported feature set, see SAP Note [2903776](https://me.sap.com/notes/2903776). - - - - [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. - - - - The availability of this feature is dependent on your service plan. For more information about different service plans and their supported feature set, see SAP Note [2903776](https://me.sap.com/notes/2903776). - - - - [Test Runtime Behavior of APIs](test-runtime-behavior-of-apis-15c7d52.md) - -
- - - - - - -## Supported Features in Standard and Premium Edition - -The roles and features offered in the Standard and Premium service plans include: - -- Key Actions for Admins in API business hub enterprise - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - As... - - - - You can use… - - - - For more information, see… - -
- - An *API Admin*, you already have the *AuthGroup.API.Admin* role collection 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](managing-the-access-request-of-the-users-8b79ee8.md) - - [Revoke Access](revoke-access-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 collection 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 collection 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) - -
- -   - - - - *Enterprise Manager* \> *Manage Content* to create products that includes APIs from different business systems and manage the content that application developers can view on the catalog. - - - - - -
- -   - - - - *Enterprise Manager* \> *Manage Content* to monitor and manage all requests for product creation and updates. - - - - - -
- -- Key Actions for Application Developers in API business hub enterprise - - - - - - - - - - - - - - - - - -
- - As... - - - - You can use… - - - - For more information, see… - -
- - An *Application Developer* you already have the *AuthGroup.API.ApplicationDeveloper* role collection assigned to you. - - > ### Note: - > The *AuthGroup.API.ApplicationDeveloper* role collection 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/view-applications-feac368.md b/docs/apim/API-Management/view-applications-feac368.md index f5c9c85e..656a40cf 100644 --- a/docs/apim/API-Management/view-applications-feac368.md +++ b/docs/apim/API-Management/view-applications-feac368.md @@ -8,9 +8,9 @@ In the context of API Management, an application is the unit of API consumption. ## Context -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. +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 Developer Hub. -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 application developers have created in the Developer Hub, along with the developer details, associated products and AppKey and secret. diff --git a/docs/apim/API-Management/view-bill-details-in-the-api-business-hub-enterprise-4ddac67.md b/docs/apim/API-Management/view-bill-details-in-the-developer-hub-4ddac67.md similarity index 79% rename from docs/apim/API-Management/view-bill-details-in-the-api-business-hub-enterprise-4ddac67.md rename to docs/apim/API-Management/view-bill-details-in-the-developer-hub-4ddac67.md index fc9d064d..9bd076bc 100644 --- a/docs/apim/API-Management/view-bill-details-in-the-api-business-hub-enterprise-4ddac67.md +++ b/docs/apim/API-Management/view-bill-details-in-the-developer-hub-4ddac67.md @@ -1,8 +1,8 @@ -# View Bill Details in the API business hub enterprise +# View Bill Details in the Developer Hub -View the bill details in the API business hub enterprise for all the applications subscribed by a developer. +View the bill details in the Developer Hub for all the applications subscribed by a developer. @@ -16,7 +16,7 @@ You are assigned the application developer role. ## Procedure -1. Log on to the API business hub enterprise. +1. Log on to the Developer Hub. 2. Navigate to, *My Workspace*. diff --git a/docs/apim/API-Management/what-is-api-management-0aef763.md b/docs/apim/API-Management/what-is-api-management-0aef763.md index f7ce826a..26fadbd1 100644 --- a/docs/apim/API-Management/what-is-api-management-0aef763.md +++ b/docs/apim/API-Management/what-is-api-management-0aef763.md @@ -20,7 +20,7 @@ With API Management you can: - **Transform your APIs**: Apply advance header and payload modifications. -- **Developer Engagements**: API business hub enterprise is a feature-rich, themed, and customizable portal designed specifically for application developers. It provides comprehensive API documentation, code snippets, and more. With API business hub enterprise, developers can easily engage with the platform, enabling them to discover, subscribe to, and consume APIs directly. +- **Developer Engagements**: Developer Hub is a feature-rich, themed, and customizable portal designed specifically for application developers. It provides comprehensive API documentation, code snippets, and more. With Developer Hub, developers can easily engage with the platform, enabling them to discover, subscribe to, and consume APIs directly. ![](images/WhatsAPIMBlock_e136868.png) 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 cef09ccd..131a84a6 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 @@ -89,6 +89,79 @@ API Management + + + +API business hub enterprise rebranded as Developer Hub + + + + +If you have enabled API business hub enterprise as part of the API Mangement capability within Integration Suite, note that it's now been relaunched as Developer Hub with enhanced features. In addition to providing a central, managed, and curated catalog of APIs for developers, the Developer Hub now allows content administrators to discover APIs from various business systems and publish them as products in the catalog. Furthermore, they can manually import additional API specifications and make them accessible in the same catalog. These new features will enhance the experience for both developers and content administrators. + +See: [Developer Hub](https://help.sap.com/docs/integration-suite/sap-integration-suite/api-business-hub-enterprise?version=CLOUD) and [Manage Content](https://help.sap.com/docs/integration-suite/sap-integration-suite/manage-content?version=CLOUD) + +If you have an API business hub enterprise standalone subscription, note that it's now rebranded as Developer Hub. This new name better represents the focus and goals of the solution. For more information, see [Developer Hub](https://help.sap.com/docs/sap-api-management/sap-api-management/api-business-hub-enterprise?&version=Cloud). + + + + +Info only + + + + +General Availability + + + + + + + + + +Technology + + + + +Not applicable + + + + +  + + + + +2024-10-26 + + + + +2024-10-26 + + + + +2409 + + + + + + +API Management + + + + +- Cloud Foundry + + + @@ -170,7 +243,7 @@ Create a Product by Importing an API Specification -As a content administrator, you can discover APIs from various business systems and publish them as products in the API business hub enterprise catalog. However, even if you have an API specification from an external gateway, you can still make it available in the catalog. +As a content administrator, you can discover APIs from various business systems and publish them as products in the Developer Hub catalog. However, even if you have an API specification from an external gateway, you can still make it available in the catalog. See: [Creating a Product by Importing an API Specification](https://help.sap.com/docs/integration-suite/sap-integration-suite/registering-api-manually?version=CLOUD) @@ -399,7 +472,7 @@ Default Credential type for Service Key -In the API business hub enterprise, we've updated the default credential type for the service key. It's now 'binding-secret' instead of 'instance-secret'. We made this change because xsuaa has deprecated the credential type 'instance-secret'. +In the Developer Hub, we've updated the default credential type for the service key. It's now 'binding-secret' instead of 'instance-secret'. We made this change because xsuaa has deprecated the credential type 'instance-secret'. See: [Accessing API business hub enterprise APIs Programmatically](https://help.sap.com/docs/integration-suite/sap-integration-suite/api-access-plan-for-api-business-hub-enterprise?version=CLOUD) @@ -467,7 +540,7 @@ API Management -Manage Content from API business hub enterprise +Manage Content from Developer Hub @@ -476,7 +549,7 @@ You can now expose APIs from SAP systems in the API business hub enterprise cata Following system registration, these systems appear on the API business hub enterprise. Here, you can directly discover and publish the APIs from these systems. This can be done from the Manage Content page in the API business hub enterprise. -See: [Manage Content](https://help.sap.com/docs/integration-suite/sap-integration-suite/api-business-hub-enterprise-developer-edition?version=CLOUD) +See: [Manage Content](https://help.sap.com/docs/integration-suite/sap-integration-suite/manage-content?version=CLOUD) @@ -948,12 +1021,12 @@ API Management -API business hub enterprise Classic Design UI Removed +Developer Hub Classic Design UI Removed -The classic design of the API business hub enterprise has been removed and is no longer accessible. +The classic design of the Developer Hub 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) @@ -1097,7 +1170,7 @@ Short Text -As an API portal administrator, you now have the ability to include a short introductory text in the *Short Text* field when creating an API proxy. This text will be displayed on the details page of the API proxy once you publish it to the API business hub enterprise. Furthermore, this field will also appear when you copy an API. However, during the copy action, the *Short Text* field will be pre-filled along with all other fields. +As an API portal administrator, you now have the ability to include a short introductory text in the *Short Text* field when creating an API proxy. This text will be displayed on the details page of the API proxy once you publish it to the Developer Hub. Furthermore, this field will also appear when you copy an API. However, during the copy action, the *Short Text* field will be pre-filled along with all other fields. See: @@ -1551,12 +1624,12 @@ API Management -Manage Access in API business hub enterprise +Manage Access in Developer Hub -As an API business hub enterprise admin, you now have the ability to manage access control checks for users to search, discover, and consume the content. +As an Developer Hub admin, you now have the ability to manage access control checks for users to search, discover, and consume the content. See: [Manage Access](https://help.sap.com/docs/integration-suite/sap-integration-suite/manage-access?version=CLOUD) \(SAP API Management customers choose: [Manage Access](https://help.sap.com/docs/sap-api-management/sap-api-management/manage-access?version=Cloud&q=Manage%20Access) diff --git a/docs/apim/glossary-2-e96acce.md b/docs/apim/glossary-2-e96acce.md index 4f7a0ffc..bb6264e4 100644 --- a/docs/apim/glossary-2-e96acce.md +++ b/docs/apim/glossary-2-e96acce.md @@ -112,7 +112,7 @@ API Management Account -An API Management account is the highest level of data hierarchy. This account hosts the API platform, which is a combination of API and API business hub enterprise. +An API Management account is the highest level of data hierarchy. This account hosts the API platform, which is a combination of API and Developer Hub. @@ -234,7 +234,7 @@ Consume API -Consume or use APIs 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 APIs. +Consume or use APIs via the Developer Hub. In the Developer Hub, an application developer registers, explores the API exposed by customers, creates applications, and tests APIs. @@ -253,7 +253,7 @@ SAP BTP Cloud Foundry environment contains the Cloud Foundry Application Runtime -API business hub enterprise +Developer Hub @@ -270,7 +270,7 @@ Developer Services -Services that provide tools to manage app developers. Also, provide the ability to onboard developers and creates a API business hub enterprise for publicly available products. +Services that provide tools to manage app developers. Also, provide the ability to onboard developers and creates a Developer Hub for publicly available products. diff --git a/docs/apim/index.md b/docs/apim/index.md index 11061550..2e9851a3 100644 --- a/docs/apim/index.md +++ b/docs/apim/index.md @@ -18,10 +18,8 @@ How to use SAP API Management - [Initial Setup](API-Management/APIM-Initial-Setup/initial-setup-65c5110.md) - [Set Up API Portal Application](API-Management/APIM-Initial-Setup/set-up-api-portal-application-29c281b.md) - [Setting Up API Portal Application Using API Management Standalone Tile](API-Management/APIM-Initial-Setup/setting-up-api-portal-application-using-api-management-standalone-tile-9d8c7ae.md) - - [Set Up API business hub enterprise Application Using the Standalone Tile](API-Management/APIM-Initial-Setup/set-up-api-business-hub-enterprise-application-using-the-standalone-tile-80c0519.md) - [API Management Service Plans](API-Management/APIM-Initial-Setup/api-management-service-plans-e064663.md) - [Accessing API Management APIs Programmatically](API-Management/APIM-Initial-Setup/accessing-api-management-apis-programmatically-24a2c37.md) - - [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) - [Unbinding a Multi-Cloud Foundation Application from an API Management, API portal Service Instance](API-Management/APIM-Initial-Setup/unbinding-a-multi-cloud-foundation-application-from-an-api-management-api-porta-09fd33a.md) - [Accessing On-Premise Systems through API Management](API-Management/APIM-Initial-Setup/accessing-on-premise-systems-through-api-management-2fc7a5b.md) @@ -31,7 +29,7 @@ How to use SAP API Management - [User Roles in API Management](API-Management/APIM-Initial-Setup/user-roles-in-api-management-7010b58.md) - [Assigning Role Collections to Users](API-Management/APIM-Initial-Setup/assigning-role-collections-to-users-80bb02e.md) - [Creating a Custom Role](API-Management/APIM-Initial-Setup/creating-a-custom-role-9d827cd.md) - - [Custom Domain Configuration for API Portal or API business hub enterprise Subscription](API-Management/APIM-Initial-Setup/custom-domain-configuration-for-api-portal-or-api-business-hub-enterprise-subsc-c4e67a9.md) + - [Custom Domain Configuration for API Portal or Developer Hub Subscription](API-Management/APIM-Initial-Setup/custom-domain-configuration-for-api-portal-or-developer-hub-subscription-c4e67a9.md) - [Region-Specific IP Addresses Available for API Management Cloud Foundry Environment](API-Management/APIM-Initial-Setup/region-specific-ip-addresses-available-for-api-management-cloud-foundry-environ-683a97c.md) - [Configuring Additional Virtual Host in Cloud Foundry Environment](API-Management/APIM-Initial-Setup/configuring-additional-virtual-host-in-cloud-foundry-environment-a7b91e5.md) - [Configuring a Default Domain for a Virtual Host](API-Management/APIM-Initial-Setup/configuring-a-default-domain-for-a-virtual-host-1085228.md) @@ -39,11 +37,15 @@ 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](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) + - [Developer Hub](API-Management/APIM-Initial-Setup/developer-hub-3500bc5.md) + - [Set Up Developer Hub Application Using the Standalone Tile](API-Management/APIM-Initial-Setup/set-up-developer-hub-application-using-the-standalone-tile-80c0519.md) + - [User Roles and Responsibilities in Developer Hub](API-Management/APIM-Initial-Setup/user-roles-and-responsibilities-in-developer-hub-54b4607.md) + - [Accessing Developer Hub APIs Programmatically](API-Management/APIM-Initial-Setup/accessing-developer-hub-apis-programmatically-dabee6e.md) + - [Centralized Developer Hub](API-Management/APIM-Initial-Setup/centralized-developer-hub-38422de.md) + - [Create a Connection Request for the Centralized Developer Hub](API-Management/APIM-Initial-Setup/create-a-connection-request-for-the-centralized-developer-hub-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) @@ -217,21 +219,21 @@ How to use SAP API Management - [View Applications](API-Management/view-applications-feac368.md) - [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) + - [Register on Developer Hub](API-Management/register-on-developer-hub-c85fafe.md) - [Managing the Access Request of the Users](API-Management/managing-the-access-request-of-the-users-8b79ee8.md) - [Revoke Access](API-Management/revoke-access-ce609bb.md) - [Delete Data of Unregistered Users](API-Management/delete-data-of-unregistered-users-d548233.md) - - [User Roles and Responsibilities in API business hub enterprise](API-Management/user-roles-and-responsibilities-in-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) + - [User Roles and Responsibilities in Developer Hub](API-Management/APIM-Initial-Setup/user-roles-and-responsibilities-in-developer-hub-54b4607.md) + - [Customize the Visual Format of the Developer Hub](API-Management/customize-the-visual-format-of-the-developer-hub-2eacd52.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) + - [Configure the Visibility of Graph Navigator](API-Management/configure-the-visibility-of-graph-navigator-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) + - [Creating an Application with Developer Hub Administrator Role](API-Management/creating-an-application-with-developer-hub-administrator-role-df4f777.md) - [Example: Accessing the Custom Attributes of an Application](API-Management/example-accessing-the-custom-attributes-of-an-application-1cbd94c.md) - [Consume Applications](API-Management/consume-applications-d4f6fda.md) - [Analyze Applications](API-Management/analyze-applications-deb57dd.md) @@ -256,16 +258,16 @@ How to use SAP API Management - [Delete a Rate Plan](API-Management/delete-a-rate-plan-d4181ad.md) - [Billing Service](API-Management/billing-service-1e20fb5.md) - [View Bill Details in the](API-Management/view-bill-details-in-the-2378110.md) - - [View Bill Details in the API business hub enterprise](API-Management/view-bill-details-in-the-api-business-hub-enterprise-4ddac67.md) + - [View Bill Details in the Developer Hub](API-Management/view-bill-details-in-the-developer-hub-4ddac67.md) - [Download Bill Details from](API-Management/download-bill-details-from-329040d.md) - - [Download Bill Details from API business hub enterprise](API-Management/download-bill-details-from-api-business-hub-enterprise-ae61972.md) + - [Download Bill Details from Developer Hub](API-Management/download-bill-details-from-developer-hub-ae61972.md) - [Create or Update or Read an Application using Subscription key](API-Management/create-or-update-or-read-an-application-using-subscription-key-e2645b5.md) - [Discover API Packages](API-Management/discover-api-packages-5cb804c.md) - [Package Details](API-Management/package-details-f0bf802.md) - [API Documentation](API-Management/api-documentation-e26b332.md) - [Security](API-Management/security-f1f997c.md) - [Data Protection and Privacy for API Management](API-Management/data-protection-and-privacy-for-api-management-d50613e.md) - - [Service to View User Details on API business hub enterprise](API-Management/service-to-view-user-details-on-api-business-hub-enterprise-a49c05f.md) + - [Service to View User Details on Developer Hub](API-Management/service-to-view-user-details-on-developer-hub-a49c05f.md) - [Auditing and Logging Information for API Management](API-Management/auditing-and-logging-information-for-api-management-77024b3.md) - [Troubleshooting for API Management](API-Management/troubleshooting-for-api-management-e765066.md) - [Limits in API Management](API-Management/limits-in-api-management-f70f425.md) diff --git a/docs/ci/ConnectionSetup/oauth-with-client-credentials-grant-for-integration-flow-processing-6c052ce.md b/docs/ci/ConnectionSetup/oauth-with-client-credentials-grant-for-integration-flow-processing-6c052ce.md index ef95b52e..c6027425 100644 --- a/docs/ci/ConnectionSetup/oauth-with-client-credentials-grant-for-integration-flow-processing-6c052ce.md +++ b/docs/ci/ConnectionSetup/oauth-with-client-credentials-grant-for-integration-flow-processing-6c052ce.md @@ -35,7 +35,7 @@ Simply spoken, this authentication is established using the following sequent st > ### 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.sap.com/tutorials/btp-integration-suite-oauth-integration-flow.html) + > [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) 2. Token server issues access token.