|
| 1 | +<!-- loiob788f20e1d71444eb5568b3c2153087b --> |
| 2 | + |
| 3 | +# Connecting SAP Document Management Service |
| 4 | + |
| 5 | +You can integrate and activate the SAP Document Management service for document storage in SAP Cloud ALM. |
| 6 | + |
| 7 | +If you want to upload [External Files](https://help.sap.com/docs/cloud-alm/applicationhelp/external-files) in the *Documents* app of SAP Cloud ALM, first establish a connection between your SAP Document Management service \(SAP BTP DMS\) and your SAP Cloud ALM tenant. |
| 8 | + |
| 9 | +> ### Note: |
| 10 | +> Make sure you use both the [SAP Document Management Service, Integration Option](https://help.sap.com/docs/document-management-service/sap-document-management-service/initial-setup-for-document-management-service-integration-option?version=Cloud) and the [SAP Document Management Service, Repository Option](https://help.sap.com/docs/document-management-service/sap-document-management-service/document-management-service-repository-option). |
| 11 | +
|
| 12 | + |
| 13 | + |
| 14 | +<a name="loiob788f20e1d71444eb5568b3c2153087b__section_cxr_43g_jdc"/> |
| 15 | + |
| 16 | +## Prerequisites |
| 17 | + |
| 18 | +- You need to provide your own SAP Document Management service instance and establish a connection to SAP Cloud ALM. For more information, see [Initial Setup for Document Management Service, Integration Option](https://help.sap.com/docs/document-management-service/sap-document-management-service/initial-setup-for-document-management-service-integration-option?version=Cloud). You can use an existing service instance for SAP Cloud ALM use. |
| 19 | + |
| 20 | +- You've done the initial setup for the SAP Document Management integration option and you've obtained all the necessary login data. |
| 21 | + |
| 22 | +- You're familiar with the [SAP Business Technology Platform \(SAP BTP\)](https://help.sap.com/docs/btp?version=Cloud) cockpit, and the [Account Administration](https://help.sap.com/docs/btp/sap-business-technology-platform/account-administration?version=Cloud) concepts. |
| 23 | + |
| 24 | +- You've got the role *Subaccount Administrator* for your SAP BTP subaccount of SAP Cloud ALM and SAP Document Management service. |
| 25 | + |
| 26 | + |
| 27 | + |
| 28 | + |
| 29 | +<a name="loiob788f20e1d71444eb5568b3c2153087b__section_p1b_kqg_jdc"/> |
| 30 | + |
| 31 | +## Procedure |
| 32 | + |
| 33 | +1. Set up the HTTP destination. |
| 34 | + |
| 35 | + In the SAP BTP subaccount, where your SAP Cloud ALM is hosted, create a destination targeted at your SAP BTP DMS instance. |
| 36 | + |
| 37 | + > ### Note: |
| 38 | + > If you have several SAP Cloud ALM tenants, you can onboard a separate SAP BTP DMS for each tenant. You can also reuse the same SAP BTP DMS for all your tenants. SAP Cloud ALM automatically creates a unique repository for each SAP Cloud ALM tenant to store the external files. |
| 39 | + > |
| 40 | + > Here's what we recommend: |
| 41 | + > |
| 42 | + > - Only connect your productively used SAP BTP DMS instance to your productive SAP Cloud ALM instance. |
| 43 | + > |
| 44 | + > - Don't connect your productive SAP BTP DMS environment to SAP Cloud ALM instances for non-productive usage. |
| 45 | + > |
| 46 | + > - Only connect the demo and sandbox SAP BTP DMS instances to your test SAP Cloud ALM instance. |
| 47 | +
|
| 48 | + 1. Go to your SAP BTP subaccount and choose *Connectivity* \> *Destinations* \> *Create Destination*. |
| 49 | + |
| 50 | + 2. Under *Destination Configuration*, fill in the required fields. Enter the following information: |
| 51 | + |
| 52 | + - *Name*:`CALM_SD_DMS_INTEGRATION` |
| 53 | + |
| 54 | + - *Type*: HTTP |
| 55 | + |
| 56 | + - *Description* \(optional\): enter a description for your reference |
| 57 | + |
| 58 | + - *URL*: value of `uri` from the service key of your SAP BTP DMS instance |
| 59 | + |
| 60 | + - *Proxy Type*: Internet |
| 61 | + |
| 62 | + - *Authentication*: `OAuth2ClientCredentials` |
| 63 | + |
| 64 | + - *Client ID*: value of `clientid` \(`uaa` section\) from the service key of your SAP BTP DMS instance |
| 65 | + |
| 66 | + - *Client Secret*: value of `clientsecret` \(`uaa` section\) from the service key of your SAP BTP DMS instance |
| 67 | + |
| 68 | + - *Token Service URL*: value of `URL` \(`uaa` section\) from the service key of your SAP BTP DMS instance |
| 69 | + |
| 70 | + Append `/oauth/token` to the `URL` retrieved from the service key. |
| 71 | + |
| 72 | + |
| 73 | + |
| 74 | + You can choose *Check Connection*. When the check is successful, you can ignore the `401: Unauthorized` warning. |
| 75 | + |
| 76 | +2. When you've established the connection, it can take up to 5 minutes before you can start uploading external files with the *Documents* app in SAP Cloud ALM. Choose *External File* on the object page of a document, and you see the following: |
| 77 | + |
| 78 | +  |
| 79 | + |
| 80 | + |
| 81 | +You can now start to use the [External Files](https://help.sap.com/docs/cloud-alm/applicationhelp/external-files) feature in the *Documents* app of SAP Cloud ALM. |
| 82 | + |
| 83 | + |
| 84 | + |
| 85 | +<a name="loiob788f20e1d71444eb5568b3c2153087b__section_fl1_gv1_qdc"/> |
| 86 | + |
| 87 | +## Repository Handling |
| 88 | + |
| 89 | +During the initial communication between SAP Cloud ALM and the SAP Document Management service, the *Documents* app automatically creates a new repository in the SAP Document Management service. |
| 90 | + |
| 91 | +> ### Caution: |
| 92 | +> Do **not** change this repository or any other repositories created by the *Documents* app. The property external ID of a repository is always identical with the tenant ID of the tenant that created it. With this information, the user can always trace which repository belongs to which tenant. |
| 93 | +> |
| 94 | +> Changes done in the repository directly aren't reflected in SAP Cloud ALM and they disrupt the integration. |
| 95 | +
|
| 96 | +The repository has the following characteristics, which you can't change: |
| 97 | + |
| 98 | +- External ID: SAP Cloud ALM tenant UUID \(unique\) |
| 99 | + |
| 100 | + The external ID is always identical to the tenant ID of the tenant that created it. With this information, you can always trace which repository belongs to which tenant. |
| 101 | + |
| 102 | +- Name: SAP Cloud ALM for Implementation |
| 103 | +- Description: Internal Repository for SAP Cloud ALM for Implementation |
| 104 | +- Encryption enabled |
| 105 | +- Virus scan enabled |
| 106 | +- Versioning enabled |
| 107 | +- Thumbnail disabled \(not possible with enabled encryption\) |
| 108 | + |
| 109 | +Files in this repository are automatically managed as follows: |
| 110 | + |
| 111 | +- All files are stored in the `ROOT` folder. No new folders are created. |
| 112 | +- For the file name \(`cmis:name`\), a UUID from the SAP database table is used. |
| 113 | +- The `cmis:name` only contains a technical ID. The real file name is stored in the property `cmis:contentStreamFileName`. |
| 114 | +- SAP Cloud ALM doesn't replicate any additional metadata, for example, the extension field `sap:owner` and other extension fields aren't filled. |
| 115 | +- With every upload of an external file, SAP Cloud ALM creates a new major version in SAP BTP DMS: 1.0, 2.0, … X.0. No minor versions are created. |
| 116 | +- The maximum size for files to upload is 10 MB. |
| 117 | +- Which file types are supported, you can see in [External Files](https://help.sap.com/docs/cloud-alm/applicationhelp/external-files). |
| 118 | + |
| 119 | + |
| 120 | + |
| 121 | + |
| 122 | +<a name="loiob788f20e1d71444eb5568b3c2153087b__section_tml_34s_pdc"/> |
| 123 | + |
| 124 | +## Disabling the External File Feature |
| 125 | + |
| 126 | +There's no process to discontinue the external file feature in the *Documents* app. |
| 127 | + |
| 128 | +If you no longer want to use the feature, you need to manually delete the external files in the *Documents* app. |
| 129 | + |
| 130 | +After that, you can delete the SAP BTP DMS repository and disconnect the configured destination. |
| 131 | + |
0 commit comments