Configuration of the Outboard DataTiering ERP is logically divided into configuration steps required on the Outboard service side and Archiving Client side.
- 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
...
| Parameter | Value | Description |
|---|---|---|
| Server Path | /default_host/dvd_crp_http | Host URL of the ICF service. This path is part of the host script identification in the Content Repository definition. |
| Logon Group | <optional> | The logon group delimits applications servers that are used to execute incoming HTTP requests from an archiving client. |
| Service User | <mandatory> | Service user which executes incoming HTTP requests from an archiving client. |
| Handler | /DVD/CRP_HAL_CL_REQ_HANDLER | Request handler class of the OutboardTM DataTiering solution. |
| SSL | Not required – running within an internal network | Requirement to use secured communication |
Authentication | Standard SAP User | Only SAP users may request service |
...
Transaction: /DVD/CRP
Service side provide 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
...
Particular setup steps are described in more in subsequent sections.
License
To be able to use the Outboard service you need to firstly request and install the license first.
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 for and confirm.
How to check/change license details
Use the cockpit transaction and click on the Datavard button and chose License.
Storage definition
...
| Info |
|---|
If you want to use data validation functionality, please turn on the hash calculation for the created storage ID. |
Source definition
...
| 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> |
...
| Info |
|---|
Example Values of the properties Source SID and Source Client in the table above are <initial>. Reason The reason for this is to have an unified customizing utilizable by all system levels which simplifies transportability as well as the future maintenance. Initial values of the properties do not influence the functionality of the solution - these properties have 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. |
...
| 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 an equivalent to a folder in a file-system-like storage. | E1-d1- |
...
The archiving client connects with the archiving service using 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 | Datavard 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 host namehostname. | <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 an internal network |
Basic Path | File path for asynchronous storing of archived data. | <ideally the same as the phys. path in the logical file path used as staging folder for archiving> |
Archive Path | File path for archive file retrieval. | <ideally the same as the phys. path in the logical file path used as staging folder for archiving> |
No signature | Forging communication without signature verification. Accepted if the Outboard Service is in the “No signature” mode too. | <empty> |
Security Certificate for Outboard Service
Transaction code: OAC0
System’s The system’s public security certificate MUST be sent to the Outboard Service to ensure it can validate security signatures of incoming data.
...
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.
...
- Running the connection test for the Content Repository definition
- Running Storage Check-in Storage Management configuration cockpit
Additional The additional check can be performed using the SAP program RSCMST, see more details provided in the SAP Note 1482012 - Check the connection to the content server.
...
Retention management enables content repository to delete stored document when its retention period is over. Functionality The functionality itself is provided by an integration with the product Datavard DataFridge. There are a few steps that you need to accomplish before you can start using retention management.
| Info |
|---|
Please note that retention management can be currently used only for archiving files created and stored using transaction SARA. |
Prerequisites
Datavard DataFridge transports imported the system. License for product Datavard DataFridge and Datavard Glue is required.
Extended cockpit
If you chose to use our service also with Retention management and you imported all relevant transports to the system your product cockpit will be automatically extended with Retention management setup steps.
Please read the complete section to do the proper configuration of retention management.
Archiving object
...
customization
To register archived file into retention management we need to identify two values:
...
To be able to get these values you need to specify which table and field contains these contain this information for all archiving object objects you want to use retention management.
...
Archiving object file contains data of multiple tables, you have to chose choose one table which field will be used to identify retention date and legal entity.
Firstly you have to identify the tables used in the archived object:
- Open DB15 transaction
- Fill desired archiving object
Now you know how to identify tables that could be used for the specified archiving object. Based on your retention management policy chose a table that contains the required information.
| Info |
|---|
For example, if you choose archiving object BC_SBAL, you would probably use header table BALHDR and legal entity field OBJECT and retention date ALDATE |
...
If you already identified the retention date and legal entity field, you can now fill the customising customizing using the mentioned /DVD/CRP_RM_SETUP transaction.
- Click on the New entry button
- Fill required fields
- Click on execute the Execute button
Example for BC_SBAL
Logical system setup
In order to use retention management, you need to setup set up a logical system in Datavard DataFridge and pair it with the required sources created for the Outboard service. Each source in which files should be subject to retention management needs to have a defined logical system. This can give you the possibility for of multiple scenarios.
- One logical system for one source
- One logical system for multiple sources
You can choose based on your use case preferences. However we recommend to have a second option, so you have multiple sources mapped to one logical system.
...
Transaction: /DVD/RMX_SARA_SETUP
Before you create a logical system you need to know for which archiving object/s it will be used. Setup The setup report will generate so-called business objects (for each Archiving object) and assign it to a logical system.
Report parameters
| Parameter | Description |
|---|---|
| Source System ID | Source System ID and Source sys. Client The client is used for the creation of a new logical system name. New name will be created as follows: <Source System ID>_<Source sys. Client> Created logical system will be automatically used for registration of archiving files from sources which that have set identical System ID and Client on Source definition (transaction /DVD/CRP_SRC). Kindly find more information bellow below in section How to pair the logical system to the source. Note that System ID doesn't needs need to be the ID of a real system and also apply for Client, it is possible to choose it freely. |
| Source sys. Client | |
| Archiving Object | List of archiving object that will be assigned as business objects to the system. |
| Storage ID for gen. objects | Transparent storage ID where required tables will be generated. Storage ID created for the primary database is used in most cases. |
| Package for generated objects | Name of development package where generated tables will be created. You can use also the local package $TMP. |
How to pair a logical system to source
Outboard service can store files into multiple sources. If you want to register files from a particular source to retention management you need to map it to a logical system.
Source system definition contain contains the following two fields:
- SID - Source System ID
- Client - Source Client
These fields needs need to be set identically as Source System ID and Source sys. Client during the creation of a logical system.
Example of mapping
Logical system creation
Source definition
As a result, the logical system DV_111 will be created and linked from source DV_CR.
...
Another required step is to set retention definition. There are two options on how to set retention for the archive file.:
- Generally for complete archiving object
- Specifically for the legal entity of archiving object
- This is possible only for sessions/files that contain only one legal entity
Specific retention for archiving object and legal entity can be set in the transaction.
Set retention for complete archiving object
...
- Open transaction /DVD/RMX_EXPERT
- Double click on tree node /DVD/RMX_OBJDIR: Object directory
- node location in tree: /OutBoard DataFridge/Metadata Management/General/Business Object Maintenance/
- Fill Object Identifier with the name of <logical system>.<archiving object> and execute
- example DV_111.BC_SBAL
- Click on the Edit entry button
- Fill desired Retention period and Retention period unit and execute
...
If your use case requires a definition of specific retention for legal entity value, firstly you need to make sure that archiving files in fact sessions fulfil fulfill the following prerequisite.
- All records in archive file have the same legal entity value
Therefore you need to consider this before you start with the creation of archive variants in the SARA transaction.
Retention than can be set using the following step list:
- Open transaction /DVD/CRP
- Double click on Retention definition tree node
- Click on the New entry button
- Fill the following details
- Object Identifier - <logical system>.<archiving object>
- Legal entity - legal entity value relevant for arching object
- Retention and Retention Period
- Execute
Automatic reg. document parameters
Registration of stored documents is a necessary step to be able to use retention management. This can be done manually or automatically when the document is successfully stored into in the storage. Here you can find how to activate automatic registration.
- Open transaction /DVD/CRP
- Double click on Automatic reg. document parameters tree node
- Fill tool as CRP_RM
- Find parameter REG_RET_ENABLED
- Click on edit the Edit button
- Set value to X
- Confirm
Automatic registration will be automatically executed after the next successful store task. Technically registration will be executed in a separate job with job namejobname: DVD_RM_REG_DOCUMENT
Manual registration of the document
There are scenarios when you would need to register document documents manually. For example, you used our content repository without retention management and now you want to use it for already stored files. Also when an error occurs during automatic registration and you solved the reason why it is failed, you would like to catch up also this document to retention management. Here you can find the described report you can use.
- Open transaction /DVD/CRP
- Double click on Manual registration of the document
Report parameters
| Parameter name | Description | |||||
|---|---|---|---|---|---|---|
| Source ID | Source ID where documents are stored | |||||
| Register only new documents | Register that was added after the last execution of this report with this option If you want to check the last execution timestamp please follow:
| |||||
Re/Register selected documents | Register documents from source ID defined by select option Document ID | |||||
| Document ID | Fill document IDs that should be registered, this is valid only for option Re/Register selected documents |
...
For each execution of the report, an application log is created. This apply for applies to manual as well as automatic registration. You can find detailed information about the registered documents.