Base SAP docuflow Configuration
ECM requires base configuration regardless of what integration patterns, use cases, or functionality you would like to utilize.
Content Server requires no more SAP docuflow specific configuration unless you are going to use the below functionality with Content Server:
- Outbound document storage (GOS/SFO or message output) WITH outbound metadata transfer
- URL/Web viewing (instead of ArchiveLink standard viewing)
- docMover
- Folder Creation
It is recommended to use ECM unless you must use Content Server. If you must use Content Server, this must be a separate (set of) OAC0 repository ID(s).
Reasons you may need to use content server:
- SAP message output without ECM plug in
- ADK data archiving
- Fiori apps using document service (ie: without SFO/GOS functionality)
- Outbound DMS
- Any other application or 3rd party that relies on ArchiveLink directly
If you are not implementing outbound metadata transfer you do NOT need to perform the below configuration. You will most likely require standard SAP ArchiveLink OAC2 and OAC3 configuration.
The base configuration consists of the following components:
- One or more CMS Profiles
- One or more CMS Use Tags
- One or more API Destinations
- Environment variables (optional)
- One or more Repository ID’s
All above configuration is navigated via the Content API System Dashboard (transaction /dflow/sys) utilizing the top left menu path “Configure”.
Configuration must be done in sequence, and requires the Repository ID(s) to be created as a pre-requisite.
All configuration must be saved in a transport for migration to QUAL and Production (among other) environments.
Setting | Description | Sample Value(s) |
|---|---|---|
CMS Profile | CMS Profiles equate to the domain in Box. Typically, there is only one CMS Profile per Repository Type of an organization for Box. | Box_Account_1 |
Repository Type | This value must be set to Box | Box |
Description | An English description given to the describe the CMS Profile | Main Box System |
Setting | Description | Sample Value(s) |
|---|---|---|
CMS Use Tag
| CMS Use Tags, in combination with CMS Profiles, will together determine an API Destination (below) to be utilized. API Destinations in turn determine the SAP RFC to be leveraged, and thus load on that RFC and in turn a group of SAP JCo server threads. In short, this combination allows you to load balance processing across multiple RFC/SAP JCo connections. A very common approach to at a minimum to break out viewing from the rest of your processing. As let’s face it, end users hate when they can’t view their documents and if you are hammering an RFC with other processing, well, insert hourglass icon. Also, have one or more use tags for custom usage. This way if you mess up you don’t affect everyone else ;-) The load balancing features of Use Tags is not relevant to Content Server usage. | Doc_Storage_FI Doc_Storage_SCM Doc_Storage_HR Custom_API_Usage_1 Migration_1 Migration_2 AuditLink_1 Etc.…
|
Description | An English description given to the describe the CMS Tag | Outbound document storage for FI |
API Designations are a unique combination of CMS Use Tags and CMS Profiles that determines the SAP RFC to be leveraged, and thus load on that RFC and in turn a group of SAP JCo server threads, allowing you to manually control the load balance processing across multiple RFC/SAP JCo connections.
This is not relevant to Content Server integration.
Note that for extreme load, you can also have multiple Enterprise Connectors configure for an SAP system, allowing you to spread API destinations (i.e.: RFC Destination) across multiple connector instances and possibly physical/virtual servers.
** Important ** This RFC destination chosen must match the API Destination configured in Enterprise Connector in step Base Enterprise Connector Configuration – Enterprise ECM Only.
Settings | Description | Sample Value(s) |
|---|---|---|
CMS Profile | CMS Profile that will use this API/RFC Destination | Box_System_1 |
CMS Tag | CMS Use Tag that will use this API/RFC Destination | •Outbound document storage for FI or • Viewing |
Disable | Used to temporary disable processing on this API Destination | ON/OFF |
CMS RFC Destination
| SAP RFC to be used to communicate with a specific instance of a Enterprise Connector. This RFC destination chosen must match the API Destination configured in Enterprise Connector in step Base Enterprise Connector Configuration – ECM Only. | ZDOCUFLOW_CMSAPI_01 |
Environment variables are used for two reasons. The primary/most common reason is when a docuflow configuration element requires a value that might change depending on which SAP environment (i.e.: SAP System ID) you are in. An example of this would be a development server vs. a production server for saving AuditLink bundles. Viewing URL’s are often different for development vs. production as well. This is leveraged extensively for on-prem content repositories when there are more server and host names involved.
This is not relevant to Content Server integration.
The second reason and less common, is if the docuflow configuration field is too small in length to hold a crazy long value you may have. Yes, we have seen it.
NOTE: when used in configuration, the environment variable must be specified within brackets, i.e.: <hostname>, or <reallylongsubsitestring>
Setting | Description | Sample Value(s) |
|---|---|---|
SAP System ID | SAP system id that should use the value specified | DEV QA1 PRD |
Variable Name | Variable name that will be specified in any relevant ECM configuration. | •BoxDomain or • reallylongviewingURLstrin |
Variable Value 1 | The value to be substituted in the ECM configuration per SAP environment/system ID. | http://ACMEdev.app.box.com/ http://ACMEqal.app.box.com/ http://ACMEprd.app.box.com/ or https://<boxviewingURL>/files/0/f/<folder>/1/f_<guid> |
Setting | Description | Sample Value(s) |
|---|---|---|
Cont.Rep.ID | The content repository ID matching OAC0 | Z1 |
Disable | The ability to temporarily turn off all usage of the repository ID for ECM usage. | OFF |
Use CMSID | Relevant to ECM only: this uses CMSID (instead of SAPDocID) for all ArchiveLink entries. For all implementations it is highly recommended this be KEPT OFF and shoud only be turned on in docuflow legacy installations if dictated by your docuflow SME. | OFF |
Is ArchiveLink | If this repository ID is a Content Server (ie: not ECM), this must be enabled. *** You cannot share an “Is ArchiveLink” repository ID with an ECM repository ID *** | ON/OFF |
Use Direct API | Future use | n/a |
Req. Location | Determines whether the repository requires location as part of the ECM Processing. Currently all SharePoint versions require a location. | ON/OFF |
CMS Profile | CMS profile that is relevant to this repository ID. | M365_1 |
CMS Rep/Store | For SharePoint, this is your top-level construct that uniquely determines your online repository. This is typically your top-level site collection. | http://mysharepoint.com/ or environment variable: <reallylongsubsitestring> |
Viewer Medium | The method of viewing you would like to utilized. | |
CMS Portal URL | Typically used for specifying viewing URL and future use. Not needed for SharePoint as the enterprise connector compiles the viewing URL at request time. | N/A |
En. Embedded URL | Use this to prevent user logon to the repository when viewing by using short lived expiring unauthenticated URLs. Currently not available in M365 but expected soon from Microsoft. | OFF |
CMS Use Tag V. | The use tag to be utilized for viewing requests as API calls are required to compile information in order to view content. This is typically a separate Use Tag so that either from the start or in the future you can split viewing off to its own API/RFC destination. | Viewing |
Repository ID’s are the final element to the base configuration and tie in the top-level CMS profile with the repository store along with which viewing mechanism and elements to use and a few other options.
At this point if you are viewing the System Dashboard (** make sure to hit refresh to show your new changes! **) you will see your entry(ies). Below is an example showing the values used in the above documentation:
The API Status column will be red until the Enterprise Connector is configured for that API/RFC Destination. Check with your middleware installation and once completed and the windows service is turn on, see section Establishing SAP <-> docuflow Enterprise Connector Connectivity Configuration below.