(DTERP-2302) Setup and Installation
- SNP
- OutBoard Service
- Set up and activate OutBoard HTTP service in ICF
- Set up Storage connection in Storage Management
- Define Source ID as archiving client identifier
- Assign Storage to the Source ID
- Archiving Client
- Define Content Repository
- Send system security certificate to the OutBoard Service
- Verify and allow the security certificate by the OutBoard Service
OutBoard Service
ICF HTTP Service
Transaction code: SICF
→ MANUAL STEP – Requires separate setup on each system (no transports)
The OutBoard is deployed as an ICF (Internet Communication Framework) HTTP service running locally on the system. The service definition is delivered out of the box. Parameters requiring attention are listed and described in the table below. Once it is configured, activate the service.
| Parameter | Description | Value example |
|---|---|---|
| Server Path | Host URL of the ICF service. This path is part of the host script identification in the Content Repository definition. | /default_host/dvd_crp_http |
| Logon Group | The logon group delimits application servers that are used to execute incoming HTTP requests from an archiving client. | <optional> |
| Service User | Service user executes incoming HTTP requests from an archiving client. | <mandatory> |
| Handler | Request handler class of the OutBoardTM DataTiering solution. | /DVD/CRP_HAL_CL_REQ_HANDLER |
| SSL | Requirement to use secured communication | Not required – running within an internal network |
Authentication | Only SAP users may request service | Standard SAP User |
Cockpit
Transaction: /DVD/CRP
Service side provides a single point of access that you can use to complete the necessary setup steps.
Menu bar contains the following information:
- Service status
- if the service is inactive please follow the previous section ICF HTTP Service
- Application logs of service
- each time service is used new application logs are written
Main area contains links to setup steps.
Particular setup steps are described in more in subsequent sections.
License
To be able to use the OutBoard service, first, you need to request and install the license.
How to install license
When you access cockpit transaction /DVD/CRP without a valid license you will be reminded to install the license, just click yes.
When you click yes, the license form will appear
Now click on the button Ask for license, this will automatically collect all necessary information required for license generation and send it to our support team.
When you get a reply from our support team please copy the license key and validity date back to the license form and confirm.
How to check/change license details
Use the cockpit transaction and choose License.
In order to be able to use transparent storage or virtual index functionality you need to install a license for Glue in transaction /DVD/GLUE → License
Storage definition
Follow the setup of a Storage ID in Storage Management.
If you want to use data validation functionality, please turn on the hash calculation for created storage ID.
Source definition
Transaction code: /DVD/CRP_SRC
→ Changes written to the workbench transport request
Archiving client represented by a system and a content repository is recognized by the OutBoard as a Source. The Source definition in OutBoard customizing refers to the content repository D1 and is shown in the table below:
| Property | Description | Value Example |
|---|---|---|
| Source ID | Unique source identifier. Recommended naming convention: <system line or ID>_<content repository defined in source> | E1_D1 |
| Source Description | Short description of the source. | System Line E1, Content Rep. D1 |
| Source SID | [Optional] SID of the source system. <initial> = empty | n/a |
| Source Client | [Optional] Client of the source system. <initial> = 0 (zero) | n/a |
Content Repository ID | Content repository defined in the source that is being identified by the source ID. (1:1 mapping) | D1 |
Folder Full Path | [internal use only] Virtual folder path used for the categorization of documents. Follows the name of the Source ID. | /E1_D1 |
No Signature (checkbox) | The property indicates whether the operations must be secured with a signature or not. <not checked> = signature must be present | <not checked> |
Example Values of the properties Source SID and Source Client in the table above are <initial>. The reason for this is to have unified customizing utilizable by all system levels which simplifies transportability as well as future maintenance.
Initial values of the properties do not influence the functionality of the solution - these properties have an informative character.
When the “No Signature“ option is On and then switched Off, all documents that have been stored in the meantime can not be accessed without the signature.
Source to storage mapping
Transaction code: /DVD/CRP_SRC_SM
→ Changes written to the workbench transport request
Each individual Source must be mapped to a target Storage ID which identifies the storage connector and its corresponding customizing. This enables the distribution of different data categories into dedicated storage locations – different storages or just different containers (folders). Mapping of the Source D1 to a Storage ID is shown in the table below:
| Property | Description | Value Example |
|---|---|---|
| Source ID | Unique source identifier. Defined in the OutBoard DataTiering’s Source customizing. | E1_D1 |
Storage ID | Unique storage identifier. It is defined in the Storage Management customizing. | ARCH_STOR |
Storage Type | Type of storage connector. | <storage type> |
Binary Container ID | Prefix for a container name. The container is equivalent to a folder in file-system-like storage. | E1-d1- |
The Binary Container ID (container name prefix) must conform to the naming rules of the Binary Storage platform.
Archiving Client
Content repository Definition
Transaction code: OAC0
→ Can be assigned to a transport request
The archiving client connects with the archiving service using the Content Repository definition. Once setup ends, perform a connection test.
- Content Repository connecting to the OutBoard service: D1
| Property | Description | Value Example |
|---|---|---|
Content Rep. | Content Repository name. | D1 |
Description | OutBoard – <storage type> Content Repository | |
Document Area | Communication interface. | <depends on data to be stored> |
Storage Type | Repository type. | HTTP content server |
Protocol | Protocol is required in case there is a need for a specific application to be used to display ArchiveLink document attachments. | n/a |
Version no. | ArchiveLink protocol version. | 0047 |
HTTP Server | Host name of target storage service. The OutBoard service runs locally on the same SAP system, therefore it must be the system hostname. | <system host name> |
Port Number | HTTP port number of the system. | 8000 |
HTTP Script | Content Server path on the Web server with OutBoard’s Source ID. | dvd_crp_http/E1_D1 |
SSL | Requirement to use secured communication | Not required – running within the internal network |
Basic Path | File path for asynchronous storing of archived data. | <ideally same as the phys. path in the logical file path used as a staging folder for archiving> |
Archive Path | File path for archive file retrieval. | <ideally same as the phys. path in the logical file path used as a staging folder for archiving> |
No signature | Forging communication without signature verification. Accepted if the OutBoard Service is in the “No signature” mode too. | <empty> |
If check of the content repository return message "Content repository <CREP ID> does not exist" issue can be with authentication that is set in HTTP service (t-code SICF). Try to remove SAML Logon from Logon Procedure List of the service.
Security Certificate for OutBoard Service
Transaction code: OAC0
The system’s public security certificate MUST be sent to the OutBoard Service to ensure it can validate the security signatures of incoming data.
Verification and Approval of Client Security Certificate
Transaction code: /DVD/CRP_HAL_CERT
Each archiving client trying to communicate and manage data in OutBoard Service must be verified and approved by an administrator. Without an approved certificate signature verification fails and consequently, the requested operation is aborted.
Verification
Verification, whether the communication from an Archiving client to an External Storage has been correctly set, is performed
- Running the connection test for the Content Repository definition
- Running Storage Check-in Storage Management configuration cockpit
An additional check can be performed using the SAP program RSCMST, see more details provided in the SAP Note 1482012.