[space] Link Enterprise [title] Graph API: Sites Selected [path] Repository Specific Guides/Link Enterprise for M365/Installation and Base Configuration Guide/Configure app within M365 - Application based permissions - Certificate Based (recommended)/ To setup granular permissions for the middleware application you will need to create an azure application that already has the permission - **Microsoft Graph \:: Sites.Selected** - **SharePoint \:: Sites.Selected** for with admin consent granted. (See the below screenshot to setup granular permissions for the middleware application.) ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/eu06E2aSQrsxcu_fd6mWw_image.png" size="50" width="1717" height="770" position="center" darkWidth="1347" darkHeight="674" darkSrc="https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/qAhNLh6GebFKrVmzVimLS_entra-app-permision-selected.png" showCaption="false"} Once that is completed we will use the graph explorer to give permissions to our azure application for the selected site. - Visit [https://developer.microsoft.com/en-us/graph/graph-explorer](https://developer.microsoft.com/en-us/graph/graph-explorer) (login as a tenant admin) - In the URL input for query enter the following [https://graph.microsoft.com/beta/sites/\:/sites/\ ](https://graph.microsoft.com/beta/sites/ybvp4.sharepoint.com:/sites/middleware)(See example below) and click run query. \*\*subsites are not supported ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/aH193Lujc36ozYBfINp5e_image.png) - In the response object copy the highlighted value under "id". **(This is different for each tenant and site. Do not use the sample site id provided in the screenshot)** ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/_ED8kPloVoPal_eSKmKMu_image.png) - In URL input for query enter the following and run the following query. [https://graph.microsoft.com/beta/sites/\/permissions](https://graph.microsoft.com/beta/sites/ybvp4.sharepoint.com,d7fc546c-1aa1-4207-85fa-d324776a235b,85566eaa-b416-4c76-8998-67fda9c1ee96/permissions) You may recieve a 403 forbidden access response. If so click modify response and consent the permissions ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/1Pp51uDT19h6jw3roAjib_image.png) - Change the request from a GET to POST. Click request body tab and modify the following json object sample below with the applicable azure application id and display name for your organization. Copy and paste the modified object into the request body tab. (You can get the azure app id and display name from the overview page of the azure application). Run the query. ```json { "roles": [ "fullcontrol" ], "grantedToIdentities": [ { "application": { "id": "Insert Azure Application ID", "displayName": "Insert Azure Application Display Name" } } ] } ``` ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/Q2W63zcqReZixFPLpd1sb_image.png) Below is a screenshot if the permissions have been setup successful. ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/Rx2P_GqK7_hmEBMXSZuts_image.png) [title] Configuring an S3 Connection in middleware [path] Repository Specific Guides/Link Enterprise for S3/Installation and Base Configuration Guide/ 1. Visit the middleware web interface in the browser. 2. Under "Connections" select "S3" 3. Click 'Add Row' 4. Under System name, use an identifier (used to reference this connection with docuflow). Example: S3QA,S3DEV,S3PRD 5. Enter the access key ID specified in the previous step and its secret access key. Finally, enter a default bucket name to be used if not specified in certain scenario. ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/hm2zvlneT5U4i_XzL4ocb_image.png) To add an Archive Link compliant S3 content server you can select "Add Content Server". An example configuration is included below. You will need one entry for each repository ID in OAC0 and each entry must have a unique port. ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/uYb61i5MCTdzSmL0uqKLD_image.png) [title] Anonymous Shared URL Configuration [path] Repository Specific Guides/Link Enterprise for M365/Installation and Base Configuration Guide/Configure app within M365 - Application based permissions - Certificate Based (recommended)/ To configure shared URL's in SharePoint, we have the following options. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/45LQ6M7RnC8PvpucN7jv2_image.png" size="72" width="643" height="393" position="center" showCaption="false"} To enable sharing URL with anyone (using expiry time) the following steps are required to do so: - Enter the browser the following URL and hit enter. https\://\.sharepoint.com/\_layouts/15/online/AdminHome.aspx#/home - Under active sites, select the site we want to modify the sharing URL permissions. ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/JGXrhoUMPxf2jTKZzZF3t_image.png) - Under the tab "Settings" click on the link "More sharing settings". - Select the following options in the provided screenshot ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/I1d4PzIJI0fWprWDDyzpb_image.png) - To change the default expiry timing of shared URL'S on the left side navigation panel under 'Policies' select 'Sharing'. Below, you will see the default number of days you can set the expiry time to. (You can override this in the middleware) ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/gQc52C1rB265p936xaXBq_image.png) - To shorten the default expiry time and override the default tenant level, we can do so via the middleware. - Enter the number of seconds in the highlighted field in the screenshot and hit save. Restart the Gimmal Link service via Windows services after saving. - To visit this URL, enter https\://localhost:82 default user: admin default password: admin ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/Jg7GSEfVhktYDkKijNpFK_image.png) [title] SharePoint Implementation Guide [path] Repository Specific Guides/Link Enterprise for M365/ ### Introduction This documentation provides a comprehensive overview of Link Enterprise's integration with SAP and SharePoint Online, covering inbound and outbound storage, metadata management, content server vs. ECM server functionality, dynamic location routing, document libraries and folders, viewing options, and various configurations and considerations for optimal performance and user experience. It highlights key features and benefits, as well as pros and cons of different approaches and technologies used in this integration. ### Getting Started 1. Go to the guide applicable to your scenario 2. Review the guide to understand some of the architecture decisions that are made along the way 3. Review the information Discovery Template to collect required information for implementation 4. Follow the implementation guide ### Discovery Template [Click here to view the link.](https://app.box.com/s/ch37keof7mqi3ot08cizmgnn5v9nv0qu) [title] Archiving API Gateway Log/Tables [path] Repository Specific Guides/Link Enterprise for M365/Installation and Base Configuration Guide/Untitled/ This tool allows you to maintain and archive API gateway log tables that may grow in size over time. In particular the below tables contain the bulk of the gateway data: 1. /DFLOW/ZAPIL01 - CMS API Log - Header 2. /DFLOW/ZAPIL06 - CMS API Log - MetaData 3. /DFLOW/ZAPIL10 - CMS API Log - Return It is highly recommended that you determine how long you would like to keep a line item level log vs header detail log and then create/schedule a background job to delete anything greater (either nightly or weekly). You have the choice to delete line item data (the highest volume by a hundred fold) and header data (less volume) as well as saving the entries to an export file as part of the deletion process. Line item detail is the data contained behind any drill down activity, eg: viewing metadata, viewing the full return table, etc. We recommend 1 year for line item detail and 5 years for header detail. Please observe foreground vs. background file locations. (SAP app/DB server vs. user presentation server). To archive Ggateway, first create a logical filename as shown below and then set up a background job with a variant via the following steps.  a. Create the logical filename "ZGLINK\_API\_GATEWAY\_SAVED\_LOG\_FILES" via transaction FILE. Assign to a logical path of the same name and configure that logical path to the directory to save the log files. The physical path must have the filename placeholder as \. b. Create a variant on the "Archive Gateway Data" selection screen to determine what to archive from the Gateway logs a. Go to the Gimmal Link Enterprise System Dashboard by utilizing transaction /DFLOW/SYS. b. Select the “Archive Gateway Data” menu option under the “Execute” menu. c. Enter in the criteria to determine what data to archive. We suggest leaving the last year’s worth of detail information and leaving all header information intact. Initially only the date and max header rows filters will need to have information entered. Note that in order to do advanced date calculations you will need to adjust on the “Save as Variant…” screen. | **Setting** | **Description** | **Sample Value(s)**  | | ------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------- | | CMS Profile  | The content management system profile to limit archiving on.  | | | CMS Use Tag  | The use tag to limit archiving on.  | | | CMS Repository Type | The content management system repository type to limit archiving on.  | | | CMS RFC Destination  | The remote function call (RFC) destination to limit archiving on.  | | | API Source  | The source of the api calls to limit archiving on.  | | | API Type  | The particular api call type to limit archiving on.  | | | SAP object ID | The particular SAP ArchiveLink object keys to limit archiving on. | | | Document Type  | The SAP ArchiveLink document types to limit archiving on. 
| | | Unique Entry Key  | The unique entry in the gateway log to limit archiving on. 
| | | Date  | The date range to limit archiving to. It is recommended to configure this at a minimum to limit how much data is archived.  | | | Time  | The time range to limit archiving on.  | | | User Name  | The SAP user name to limit archiving on.  | | | CMS Message Type  | The particular message types from the logs to limit archiving on.  | | | CMS SAP User  | The SAP user name to limit archiving on. 
| | | CMS Rep./Store  | The content management system repository or object store to limit archiving on.  | | | CMS ID  | The content management system id(s) to limit archiving on.  | | | CMS Filename  | The content management system filename(s) to limit archiving on. 
| | | CMS Type 
| The content management system document class, object type or metadata template to limit archiving on.  | | | CMS Property  | The content management system property that a choice list is defined to be configured against to limit archiving on. | | | CMS Choice List Prefix  | The content management system choice list prefix to limit archiving on.  | | | Test Only 
| If selected the archiving isn’t actually performed and the process is just simulated.  | | | Delete Headers – not recommended  | If selected the header information from the gateway log will be deleted as well. Typically only the detail information needs to be deleted for space saving reasons so try to leave the headers when possible.  | | | Max Header Rows 
| This determines how many at one given time are checked to see if their data should be archived. This helps for performance reasons to help limit the amount of processing. We suggest trying a value representative of the amount of processing that goes on in the given system.  | 500 | | Save selected entries  | Optionally if selected the archived entries can be stored in an output file for later analysis.  | | | PC file path (online execution only) | When this program is executed manually from the menu path and not via a scheduled job this determines the output file location for the archived data. 
| | | Dataset file path  | When this program is executed in the background (potentially by the scheduled job) a dataset file is used for storing the archived data.  | | d. Save the criteria as a variant that can be used by the scheduled job. a. Select "Save as Variant..." from the "Goto" menu under the "Variants". b. Adjust the date range by selecting "X\:Dynamic Date Calculation (System DA\ate)" for the selection variable of the "Date" Field name. c. Configure the "Name of Variable (Input Only Using F4)" to select the particular date range to archive. a. We suggest selecting I for include (the I in the I/E column) with the LT (for less than) option the "Current date +/- ??? days" selection from the choices. b. Enter 365 - for the ??? value. c. This archives all non-header data older than a year. d. Make sure to enter a unique variant name that will be needed when scheduling the job. Ex: ARCHIVEGATEWAY e. Also enter a description for the information entered. Ex: Archive the Gateway Logs c. Configure a scheduled job to archive the gateway data periodically. 1. Go to transaction SM36 to configure a new background job to archive the data. 2. Enter a unique name for the job that reflects the archiving of Gimmal Link Enterprise data. Ex: zglink\_archive\_gateway. 3. Define a step to call the particular archive program with the variant defined previously. 1. Define an ABAP program by pressing the “ABAP program” button. 2. Enter “/DFLOW/ZCMSAPI\_GTW\_ARCHIVE” for the “Name”. 3. Select the variant name previously defined in the “Variant” field. 4. Then finally save the step information by clicking on the floppy disk at the bottom. 5. Green arrow back to view the background job and you should see that a job step was successfully defined. 4. Define the start condition by clicking on the “Start condition” button along the top. 1. Press the “Date/Time” button along the top and define a start date and time for the archiving background job. We suggest starting the job off hours at night or on the weekend. The job shouldn’t affect any current processing so it isn’t required to run off hours but just suggested. 2. Press the “Period value” at the bottom to make the job run periodically to archive the gateway logs. We suggest running the archiving program weekly so that the job performs quickly and logs are maintained fairly regularly. 3. Finally save the start condition by clicking on the floppy disk at the bottom. 4. Confirm that the background job now mentions the planned start time along with how frequently it will be run. 5. Save the background job so that the archiving of gateway logs can occur. [title] Configure SAP RFC destinations – ECM Only [path] Repository Specific Guides/Link Enterprise for S3/Installation and Base Configuration Guide/ Base configuration for ECM requires (at least one) SAP RFC to be created. This allows Link Enterprise ECM within SAP to execute RFC calls to an instance of the Enterprise Connector (in theory you can utilize more than one) acting as an SAP JCo Server.  The RFC destination configured here will be selected in the Link Enterprise configuration outlined the step Base SAP Link Enterprise Configuration – ECM Only (API Destination).  1. Destination Name: Z\_CMSAPI\_01 1. We suggest the following naming convention: Z\_CMSAPI\_\ but any destination name can be used. 2. Connection Type: T (TCP/IP Connection) 3. Technical Settings: 1. Select Registered Server Program radio button 2. Program ID: Z\_CMSAPI\_01 1. We suggest to keep the program ID name the same as the RFC destination name for simplicity as this will need to match the program ID in the Enterprise Connector. 3. Gateway Options (Optional if only one gateway host for the SAP environment) 1. Gateway Host: \ 2. Gateway Service: \ 4. Unicode: 1. Select Unicode radio button - Note: **You cannot test the RFC destination** until the Enterprise Connector has at least 1 RFC Destination (Outbound Rule) configured is also completed below and the windows service is running. When the windows service is installed, configured and running, refer to section Milestone: Establish SAP \<-> Enterprise Connector Connectivity Configuration to test connectivity. - The Program ID and Gateway Host and Service must match that configured in the Enterprise Connector (section “Base Enterprise Connector Configuration”), work with your Gimmal Link Enterprise configurator to ensure this is the case.You may need to repeat RFC destination creation above for additional processing threads and load balancing. Initially however only one RFC destination is needed. - ** Important This RFC destination chosen must match the API Destination configured in **Link Enterprise Connector in step Base Enterprise Connector Configuration – ECM Only. [title] SAP S4 Rise / Private Cloud [path] Repository Specific Guides/Link Enterprise for S3/Technical Overview/ This information is based on SAP's current best practices for connectivity: [https://blogs.sap.com/2023/01/31/rise-with-sap-s-4hana-cloud-private-edition-secure-cloud-connectivity/](https://blogs.sap.com/2023/01/31/rise-with-sap-s-4hana-cloud-private-edition-secure-cloud-connectivity/) The following three options are recommended for connectivity to S/4HANA Cloud, Private Edition / S/4 Rise. - VPN (IPSEC) - VPC or VNET Peering - Internet Based Firewall Access (***Content Server Only***) The connectivity architecture between AWS, Azure and Google Cloud are analogous, with minor variances in implementation ## VPN (IPSEC) In this scenario, a Virtual Private Network (VPN) Gateway client is deployed in the GimmalLink Tenant and is configured to connect to the SAP RISE Tenant VPN Gateway. Traffic for the SAP communications are routed through this secured connection. Azure and AWS provide options for Highly Available connections as an option. ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/w1Oan0HKV5UtFEq5amO2A_image.png) ## VPC (AWS/Google) or VNET (MS) Peering Virtual Network Peering is a mechanism that connects two virtual networks between Tenants in a Virtual Private Cloud (VPC). Microsoft calls their implementation VNET and AWS/Google use the term VPC Peering. In all cases, Peering provides a virtual, ***internal***, low latency, high bandwidth network connection between Tenants in the same VPC provider. ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/vmV1LFyVcQjQtdqKvzk_b_image.png) ## Internet Based Firewall Access In this scenario, a Web Application Firewall (WAF) is configured to allow specific traffic connectivity into the SAP RISE Tenant. AWS, Google and Azure all offer WAF as a service within the tenant. ***NOTE: The WAF solutions only supports HTTPS outbound connections from SAP RISE deployments (i.e. Content Server only)*** ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/B58A-KvQv7aknXWE02PRp_image.png) [title] SAP Connection - ECM Only [path] Repository Specific Guides/Link Enterprise for M365/Installation and Base Configuration Guide/Base Enterprise Connector Configuration/ This is required for ECM only. Ensure the Enterprise Connector windows service is turned on. 1. Visit the Enterprise Connector configuration ui via https\://localhost:82 (enter user name: link, password: link) 2. Under the "Connections" category in the left navigation panel click "SAP". 3. Click "Add Row". (SAP connection config dialog box will appear) 4. Complete the rest of the SAP configuration information by filling in the relevant details in the input box's. (For help setting some of these values work with SAP Basis team members.) 5. Click "Test Connection" if a text displays "Success" then proceed to save the connection. 6. If "Success" does not appear, you may need to check if the connection details are correct. (Check with basis team) | **Setting** | **Description** | **Sample Value ** | | ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- | | Client  | Client number to connect to  | 800  | | Language  | Language can only be EN for English currently but the setting is available for future international use  | EN  | | System  | The system number  | 00 | | Unicode  | True if the system is a Unicode system and communication will be in Unicode. This is recommended to be enabled.  | | | User ID | The SAP non dialogue system account with elevated permissions to allow the middleware to communicate with SAP.  | GIMMAL  | | Password  | The non expiring password for the SAP system account  | \*\*\*\*\*\*\*\*\*\*\*  | | App. Server Host  | The application server host name or ip address(disabled if using load balancing)  | | | Gateway Host  | The gateway host name or ip address that the RFC destinations are configured to.  | 127.0.0.1 
| | Gateway Port  | The port number used to communicate with the gateway. Typically 33## with the ##’s being the system number  | 3300 | | Use Load Balanced Server  | When enabled a message server can be configured to handle incoming Enterprise Connector calls. If available it is recommended that this be utilized  | | | Msg. Server Host | The message server host name or ip address.  | 127.0.0.1 
| | Msg. Server Port  | The port number to use to communicate with the message server. Typically 36## with the ##’s being the system number.  | 3600 | | R3 System Name  | The system name  | ED1  | | Group Name  | The group name used with the message server  | Production  | | Use Secure Network Connection (SNC)  | If enabled secure communication will be used between the Enterprise Connector and SAP. Generally this is not needed since all communication is from servers behind a firewall.  | | | SNC Name  | The SNC Name to use  | | | SNC Partner  | The SNC Partner name  | | | QOS  | The SNC quality of service  | | | SNC Library  | The SNC library location  | | | Use SAP Router  | If enabled SAP router technology is used for communication. 
| | | SAP Router  | The SAP router configuration  | | If an error message occurs, or if there is no response at all, please refer to the Enterprise Connector log file.  Note: A typical reason for no response is either the SAP Gateway has security enabled and Basis must allow access (refer to above section Configure SAP Gateway – Enterprise ECM Only) or the SAP Jco library does not exist in the Jco folder.  \*the Windows service must be restarted for changed to take effect [title] Follow up SharePoint Team Tasks [path] Repository Specific Guides/Link Enterprise for M365/Installation and Base Configuration Guide/ This section contains any follow up tasks for the SharePoint team. [title] Base SAP ArchiveLink Configuration [path] Repository Specific Guides/Link Enterprise for M365/Installation and Base Configuration Guide/ Both ECM and Content Server require basic ArchiveLink configuration for connectivity. This involves creating one (or more) Content Repository ID via transaction OAC0.  ***Please review the functionality referenced in the "Introduction and Overview" section of this document for a matrix of ECM vs. Content Server functionality.*** NOTE: - For ECM usage - Each repository ID will equate to a SharePoint top-level site collection. If you have multiple top-level site collections, a repository ID for each will need to be created. For final content sub-site / library / locations, this is dictated/configuration at the document type level. - For Content Server usage - Each repository ID will equate to a SharePoint top-level site collection PLUS a final content sub-site / library / location. If you have multiple various of this final location, a repository ID for each will need to be created.  Additional ArchiveLink configuration may be required depending on the integration pattern implemented such as creation of doctypes (OAC2), assigning link tables (OAC3).  This configuration is not outlined in this guide – refer to the Solutions Guide for further information.  Optionally if you have big-bucket organization of content across sites within you site collections, you may choose to create a repository id for each, such as: Human Resources, Finance, Supply Chain, Health and Safety, etc. Please work with your Gimmal Link Enterprise team to determine the best setup to meet your requirements. Regardless, a minimum of one repository is required (and for the purpose of basic setup and configuration). [title] System Requirements [path] Repository Specific Guides/Link Enterprise for S3/Technical Overview/ The middleware component (Enterprise Connector) can be deployed on-premise, in a private cloud or as a fully managed service from Gimmal. When deploying on premise or in a private cloud environment, physical or virtual hardware is supported. The following server resources are the **minimum** requirements: | **Operating Systems** | **CPU** | **Disk Space** | **RAM** | **SAPJco** | | ------------------------------------- | ------------------------------------------------------- | -------------- | ------- | ---------------------------------------------------------------------------------------------------- | | Windows Server 2016, 2019, 2022, 2025 | Minimum 2 cores or 2 physical CPUs with at least 2.0Ghz | 40 GB | 8 GB | 3.1 and above
(JCo 3.1 requires the Microsoft Visual Studio 2015-2022 C/C++ runtime libraries ) | When deploying on premise or in a private cloud environment, physical or virtual hardware is supported. The following server resources are the **recommended** requirements: | **Operating Systems** | **CPU** | **Disk Space** | **RAM** | **SAPJco** | | ------------------------------------- | ------------------------------------------------------- | -------------- | ------- | ---------------------------------------------------------------------------------------------------- | | Windows Server 2019, 2022, 2025
| Minimum 4 cores or 2 physical CPUs with at least 2.0Ghz | 128 GB | 64 GB | 3.1 and above
(JCo 3.1 requires the Microsoft Visual Studio 2015-2022 C/C++ runtime libraries ) | ## Production/Non Production Environments SAP typically follows a 3-tier landscape: 1. Development (DEV) 2. Quality Assurance (QUAL) 3. Production (PROD) Albeit Link Enterprise supports a 1 middleware to \ SAP connection, it is recommended to have 1 middleware environment (separate windows machine/VM) for each SAP system ie: most common is 3 separate windows machines/VM's. a. Development - can be minimum server requirement specs if desired b. We recomend QUAL be identical to production (recomended requirement specs). Reasons why you may choose to share the DEV and QUAL SAP connections to a single non-production midldeware server instance: 1. low volume and load 2. no migration testing 3. little or no concurrent "inbound to SAP" processing where you might want some event to go up to both DEV and QUAL SAP at the same time ## Enterprise Connector Middleware Service The Gimmal Link Enterprise middleware service requires Read/Write permission to the Gimmal Link Enterprise installation root directory and sub-directories. This can be accomplished via two methods based on your server configuration: 1. Running as local host 2. A specified service account where local host does not have Read/Write permissions. ## SAP Firewall Access The Gimmal Link Enterprise Content server application communicates via HTTP/HTTPS and can be configured to use any port number. 1. The Gimmal Link Enterprise Content Server application communicates via HTTP/HTTPS and can be configured to use any port number (ex: 8085) (Inbound to middleware and Outbound from SAP. Refer to organization's internal IT security and project team on which IP address to allow). 2. Note that each SAP repository (Z1, Z2, etc) requires its own set of ports, for example: 1. Z1 1. 1 unique port for HTTP eg: 8085 2. 1 unique port for HTTPS eg: 8086 2. Z2 1. 1 unique port for HTTP eg: 8087 2. 1 unique port for HTTPS eg: 8088 The Gimmal Link Enterprise ECM application communicates via SAP JCo over the following ports: 1. Gateway Port: The port number used to communicate with the gateway. Typically, 33## with the ##’s being the system number (ex: 3300) (Inbound to sap) 2. Message Server Host (if applicable): The port number used to communicate with the gateway. Typically, 36## with the ##’s being the system number (ex: 3600) (Inbound to sap. Refer to organization's internal IT security and project team on which IP address to allow) `Confirm with your SAP Basis team for the values specific to your SAP installation.` ## URL and Firewall Configuration for S3 API Access Access to the following URLs is required from the server: - Base URL: \ - Source: the IP of the Gimmal Link Enterprise server - Port: HTTPS is 443 - Protocol: HTTPS - This provides the basic functionality that Link Enterprise requires for its processing. [title] Welcome [path] / ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/Zwi2e5KAZlmZijYlXixhn_image.png" size="54" width="1210" height="462" position="center" darkWidth="1210" darkHeight="462" showCaption="false"} ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/a9EXFAnHd3Drulu3gfKnI_image.png" size="54" width="1227" height="243" position="center" darkWidth="1227" darkHeight="243" showCaption="false"} [title] Architecture Overview [path] Repository Specific Guides/Link Enterprise for S3/Technical Overview/ The below diagram outlines the basic components of the Gimmal Link Enterprise stack for S3: ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/_8vuOED8hPIXth-8gu_7y_.blob) [title] Follow up Basis Tasks [path] Repository Specific Guides/Link Enterprise for M365/Installation and Base Configuration Guide/ [title] Follow up Middleware Team Tasks [path] Repository Specific Guides/Link Enterprise for M365/Installation and Base Configuration Guide/ This section contains any follow up tasks for the middleware teams. Any changes requires the Windows service must be restarted for changed to take effect. [title] Milestone: Establish SAP <-> Enterprise Connector Connectivity [path] Repository Specific Guides/Link Enterprise for M365/Installation and Base Configuration Guide/ Establishing connectivity from SAP to the Enterprise Connector and SharePoint depends on whether ECM or Content Server is being utilized.  This is a good milestone to reach for a base install and connectivity.  [title] Installation Overview [path] Repository Specific Guides/Link Enterprise for S3/Installation and Base Configuration Guide/ The below outlines the necessary Gimmal Link Enterprise installation tasks:  1. Install Enterprise Connector 2. Configure S3 Credentials/Connection 3. Install SAP transports (mandatory ECM, optional Content Server) 4. Create SAP SAP system account with appropriate authorizations (mandatory ECM) 5. Configure SAP RFC destinations and Gateway (ECM only) 6. Configure SAP Gateway - ECM Only 7. Base SAP ArchiveLink Configuration 8. Base SAP Link Enterprise Configuration 9. Base Enterprise Connector Configuration - SAP / ECM / Content Server / RFC Destination 10. Milestone: Establish SAP \<-> Enterprise Connector \<-> SharePoint Connectivity 11. Determine Viewing Strategy (located in Solution Guide) Optional follow up steps (not required to achieve base the connectivity milestone) and notes include: 1. Follow Up Basis Tasks 2. Follow Up Security Tasks 3. Follow Up Middleware Team Tasks 4. Follow up S3 Team Tasks For additional integration patterns (i.e.: document storage, inbound processing, metadata transfer, etc.…) this functional configuration is NOT included in this guide - refer to the Solution Guide. Such activity includes: 1. Configure SAP ArchiveLink document type and link tables 2. Configure S3 collections, sites, libraries, and content types 3. Configure Link Enterprise document storage, linking, migration, metadata transfer, etc. 4. Customize or extend SCRUD functionality (ECM only) [title] Create SAP system account – ECM Only [path] Repository Specific Guides/Link Enterprise for S3/Installation and Base Configuration Guide/ *`relevant to Gimmal Link `*`Enterprise `*`ECM only`* In order for the Link Enterprise Connector to log in via SAP Jco to register on the SAP Gateway to receive outbound processing requests, as well as execute inbound processing (if configured), an SAP system (non-dialogue) account is required. This user ID requires the below privileges: ### Authorization Object: S\_RFC ACTVT: 16 ### RFC\_TYPE values: 1. FUGR 2. FUNC ### RFC\_NAME values:  1. /DFLOW/ZDOCMANAGER\_SAPLINK\_V2 2. DDIF\_FIELDINFO\_GET 3. RFC1 4. RFCPING 5. RFC\_GET\_FUNCTION\_INTERFACE 6. SDIFRUNTIME 7. RFC\_METADATA 8. RFC\_METADATA\_GET ### Transactions 1. /DFLOW/GTW This authorization covers most standard Gimmal Link Enterprise processing. For custom requirements, please either use a copy of WF-BATCH with SAP\_ALL / SAP\_NEW or add the relevant authorizations via trace evaluation. Please note the user ID create and password and work with your Gimmal Link Enterprise implementor – this will be need to be configured in Gimmal Link Enterprise Connector in step Base Gimmal Link Enterprise Connector Configuration – Gimmal Link Enterprise ECM Only.  [title] Configuring SSL communication with Content Server [path] Repository Specific Guides/Link Enterprise for M365/Installation and Base Configuration Guide/Follow up Middleware Team Tasks/ The content server communication with SAP can optionally have an SSL port enabled which also requires some certificates to be adjusted so that communication with SAP can be secure. The following example uses the command line tool called openssl. There are various ways to generate certificates so this example is just one way. Getting the openssl utility installed in your environment is not part of this guide. This example also generates what are known as self signed certificates. Generating signed certificates from certificate authorities is outside the scope of this document.  First you’ll need to get a private key and convert it to the appropriate format required by the Gimmal Link Enterprise Connector.  1. Generate an encrypted private key using openssl. openssl genrsa -aes256 -out my\_private\_key.pem 2048  This generates an RSA private key using AES256 encryption (other types of encryption are possible if AES256 is deemed insecure by your organization. It will prompt you to enter in a passphrase for the encryption, make sure to choose something that you will remember. The format of this certificate should be human readable since it is in the PEM format. The 2048 at the end of the command tells this key to be 2048 bits long (you could also use something like 4096 here instead of 2048)  2\. Convert the private key to the pkcs8 structure openssl pkcs8 -topk8 -inform pem -in my\_private\_key.pem -outform pem -nocrypt -out entlink\_private\_key\_pkcs8.pem  This command takes the input file generated in the previous step and converts it into the pkcs8 structure used by the Enterprise Connector. Note that the nocrypt command here also unencrypts the private key. Since this could allow vulnerabilities you may wish to restrict who has access to the folder where the certificates are stored. Just make sure that the Windows server that runs the Gimmal Link Enterprise Connector has access to the folder by creating a logon user for the service if need be.  3\. Store the private key in the config directory under the installation folder. 4\. Change the private key name to be entlink\_private\_key\_pkcs8.pem if you chose a different name in the previous steps. if you wish to keep the name that you originally chose you can optionally adjust the Config.properties file found under the config directory under the installation folder to point tp the new peivate key file you have created. You will need to adjust the content.pem.file to be the name of the file you have chosen. Ex: content.pem.file=my\_private\_key\_pkcs8.pem (if you chose my\_private\_key\_pkcs8.pem as the output file when converting to the pkcs8 structure.  5\. Generate a public cerificate from the private key using openssl. Make surethat the common name matches the host used in the OAC0 ArchiveLink configuration (ip or hostname). openssl req -new -x509 -key my\_private\_key.pem -out entlink\_public.cer -days 3650  This command creates a new self signed certificate that is valid for 3,650 days.  It will prompt you to enter the passphrase you chose earlier for your private key.  Then it will ask you to enter in a country designation, state or province, and city.  Next enter in your company name and an optional organizational unit from within your company (this can be left blank).  For the common name make sure to enter the ip address or hostname you used or will use when configuring the ArchiveLink repository under OAC0.  You can optionally enter in an email address as well.  6\. Store the public certificate in the config directory under the installation folder. 7\. Change the public certificate name to be entlink\_public.cer if you chose a different name in the previous steps. If you wihs to keep the name that you originally chose you can optinally adjust the Config.properties file under the config directory under the installation folder to point to the new public certificate you have created. You will need to adjust the content.cer.file to be the name of the file you have chosen. Ex: content.cer.file=my\_public.cer (if you chose my\_public.cer as the output file when creating the certificate).  8\. Store the publiccertificate in SAP using the transaction STRUST. This lets SAP know that calls out to the content server using this public certificate are trusted. 1. Execute transaction STRUST 2. Double click on the SSL System Client SSL Client on the left hand side (note there may be two variants of the System SSL client so repeat the process for both SSL clients ) 3. Verify that the right hand side says "SSL System Client SSL Client" at the top 4. On the bottom certificate section on the right hand side click on the import certificate button found in the lower left. 5. Select the certificate file that was previously generated and upload the certificate. 6. Verify that the certificate details get loaded up into the screen. 7. Finally click on the “Add to Certificate List” 8. Verify that the certificate list in the middle of the right hand side now contains an entry for the newly created public certificate (you may have to scroll down through the list of certificates). 9. Repeat the process if there was more than one SSL System client. 9\. Adjust the content server configuration tab in the Profile Wizard that will be using SSL communication by adding an SSL port number to configuration. 10\. Make sure that the same port number is configured in the ArchiveLink repository that will be used with this configuration via transaction OAC0. 11\. Make sure to save configuration to active profile and restart the Gimmal Link Enterprise Connector Windows service for the changes to take effect. 12\. In order to verify that the SSL configuration is correct you will need to attempt to store and retrieve (view) a business document that is associated with the ArchiveLink repository configured to use SSL. Note that testing the connection to the ArchiveLink repository does not test the SSL connection since that information is sent over the non-SSL port. This also means that ArchiveLink repository configurations must have both an SSL port and a regular port configured. [title] SharePoint - Inbound Storage [path] Repository Specific Guides/Link Enterprise for M365/SharePoint Implementation Guide/ Link Enterprise has a process to query the SharePoint Online system looking for documents to link to SAP. These are called ‘inbound rules’ and are only available with ECM Server.  ECM Server is a communication specification based on SAP’s RFC socket protocol called JCo (Java Connector). The ECM server unlocks remote function calls and Link Enterprise provides an API within SAP to leverage this technology, allowing enhanced functionality over standard Content Server.  Documents to link are determined by a metadata flag that is set to True and some optional filters to help specify a sub-set of documents to process. In addition to this metadata flag, additional business information in metadata is required to identify the object in SAP to link to. This additional metadata is based on the business process/SAP Object to be identified.  The following is a high level overview of the inbound process:  1. The documents and any configured metadata (columns) are returned  2. Link Enterprise calls an SAP RFC and sends the list of documents and their metadata  3. SAP finds the corresponding object for each document and creates an archive link entry for it  4. SAP returns a success and additionally, any configured metadata to update SharePoint with  5. Link Enterprise updates the documents in SharePoint with SAP required metadata along with any configured custom metadata  ## 2. Custom Metadata  Custom metadata can be set in SharePoint as columns in content types. Custom metadata is any values from SAP beyond those required by Link Enterprise and SAP for linking.   During the inbound linking process, once the SAP Object is found and the document linked, custom metadata can be pushed back to SharePoint columns on the document.  Custom metadata is most valuable when there is the desire to:   - Allow end-users to access SAP-linked documents directly in the SharePoint interface, especially through search  - Enables Microsoft Search  - Enables access to Search Refiners in SharePoint  - Trigger a Power Automate workflow  - Allow other Business Systems to access/link to documents stored by SAP (i.e. SalesForce)  ### Metadata enables inbound scenarios. For example, a document arriving in SharePoint can:   - Link to an existing SAP object  - Trigger an SAP workflow with container values  - Trigger custom ABAP code  ### Custom Metadata Considerations:  Pros:   - Can enable metadata based searching and search result filtering for users accessing content within SharePoint  - Enables the ability to do inbound rules when using ECM connectivity  Cons:  - Requires additional transaction time and SharePoint Graph API calls.  - Please see the section ‘Application Throttling’ in the following Microsoft information page: [https://learn.microsoft.com/en-us/sharepoint/dev/general-development/how-to-avoid-getting-throttled-or-blocked-in-sharepoint-online](https://learn.microsoft.com/en-us/sharepoint/dev/general-development/how-to-avoid-getting-throttled-or-blocked-in-sharepoint-online)  [title] Base Enterprise Connector Configuration [path] Repository Specific Guides/Link Enterprise for M365/Installation and Base Configuration Guide/ Base Enterprise Connector configuration contains the following components: 1. SharePoint Endpoint - required for both ECM and Content Server 2. SAP Connection - required for ECM only 3. Content Server - required for Content Server only   The above will finalize base connectivity between SAP and SharePoint.. For specific configuration of SharePoint *\<-> *SAP integration patters and use cases, please refer to the Solution Guide (separate).  [title] OAC0 Repository ID Configuration [path] Repository Specific Guides/Link Enterprise for M365/Installation and Base Configuration Guide/Base SAP ArchiveLink Configuration/ **1. For ECM:  **the repository ID, albeit mandatory, only requires it to be created with a meaningful description – the HTTP server and HTTP script are not needed. No certification needs to be sent as well as additional repository ID CS administration functionality is not relevant (and will fail if you try as this is only utilized by Content Servers). A content server does NOT need to be configured in the Enterprise Connector.  Make sure the changes are saved and captured in a transport so that they can be transported to other environments. **2. For Content Server: **full configuration of the repository ID is required. A corresponding Content Server must also be configured in the Enterprise Connector.  This configuration contains SAP system level details (DEV vs. QUAL vs. PRODUCTION). *This should not be transported, but instead created manually in each SAP system if possible.* Below is an example: ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/TWzclgQBbzSRZLPvHCuqa_image.png) - Note: You cannot send the certificate or test connectivity until the Enterprise Connector configuration is also completed below and the windows service is running. When the windows service is installed, configured and running, refer to section Establishing SAP \<-> Enterprise Connector Connectivity Configuration to send the SAP certificate and test connectivity. [title] SharePoint - Outbound Storage [path] Repository Specific Guides/Link Enterprise for M365/SharePoint Implementation Guide/ ##  ​​1. Outbound Storage Description  Outbound storage allows SAP users to attach content/documents to objects within SAP. Instead of storing the document into the SAP database, Link Enterprise will store the document in your SharePoint environment.  ## 2. Content Server vs ECM  When storing outbound documents, there are two options:  1. Content Server  2. ECM Server  **Content Server ** Content Server is a communication specification defined by SAP that uses HTTPS to communicate with the Link Enterprise middleware. Link Enterprise is an SAP Content Server certified application.  **ECM Server ** ECM Server is a communication specification based on SAP’s RFC socket protocol called JCo (Java Connector). The ECM server unlocks remote function calls and Link Enterprise provides an API within SAP to leverage this technology, allowing enhanced functionality over standard Content Server.  While we are only discussing Outbound communications, ECM with JCo does allow for bi-directional communication between Link Enterprise and SAP, Inbound and Outbound.    ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/PaqAtMykUHkZ2m-ox1_Tj_image.png) **Content Server Considerations: ** Pros:   - HTTPS protocol – routes well over the public internet and can be used with stateful packet inspection firewalls  - Does not require Link Enterprise transports to be deployed in SAP  Cons:  - Does not inherently allow for custom metadata to be sent during upload to SharePoint ### ECM Considerations:   Pros:   - Custom metadata can be sent  - Allows for a ‘do anything’ pipeline into SAP  Cons:  - RFC protocol requires non-standard ports to be opened  ## 3. Metadata  Custom metadata can be set in SharePoint as columns in content types. Custom metadata is any values from SAP beyond those required by Link Enterprise.  Custom metadata is most valuable when there is the desire to:   - Allow end-users to access SAP-linked documents directly in the SharePoint interface, especially through search.  - Enables Microsoft Search.   - Enables access to Search Refiners in SharePoint.   - Trigger a Power Automate workflow.   - Allow other Business Systems to access/link to documents stored by SAP (i.e. SalesForce).   Metadata enables inbound scenarios. For example, a document arriving in SharePoint can:   - Link to an existing SAP object.   - Trigger an SAP workflow with container values.   - Trigger custom ABAP code.   How custom metadata is applied to SharePoint varies based on the method of outbound storage, ECM or Content Server.  ECM has native support for selecting a SharePoint Content Type and its column values when creating the document in a document library. Content Server, based on the SAP specification, does not allow custom metadata to be set during the creation of the document in SharePoint. This must be done through a Link Enterprise technology called a ‘call back’.  Call backs utilize the ECM connectivity and update the document metadata/columns once the SAP Content Server store/create operation has been completed. This means there are additional API calls/time required to update the document with business metadata.  ### Callback:  Call backs utilize the ECM connectivity and update the document metadata once the SAP Content Server store/create operation has been completed. This means there are additional API calls/time required to update the document with business metadata.  \[Graphic overview to be added at a future date] ### Custom Metadata Considerations:  Pros:   - Can enable metadata based searching and search result filtering for users accessing content within SharePoint  - Enables the ability to do inbound rules when using ECM connectivity  Cons:  - Content Server does not inherently allow for custom metadata to be sent during upload to SharePoint. This then requires an ECM call to back populate the custom metadata which adds additional transaction time and SharePoint Graph API calls.  - Please see the section ‘Application Throttling’ in the following Microsoft information page: [https://learn.microsoft.com/en-us/sharepoint/dev/general-development/how-to-avoid-getting-throttled-or-blocked-in-sharepoint-online](https://learn.microsoft.com/en-us/sharepoint/dev/general-development/how-to-avoid-getting-throttled-or-blocked-in-sharepoint-online)  ## 4. Dynamic Location Routing  Dynamic Location Routing Dynamic Location Routing is a feature that allows documents to be automatically stored in different SharePoint folders based on associated SAP data when the document is transferred from SAP to SharePoint. This capability enables organizations to create rules and logic that determine the storage location of documents based on specific SAP attributes or metadata. By leveraging Dynamic Location Routing, companies can: - Automatically categorize and file documents according to business-specific criteria - Ensure consistent and organized storage of documents across various departments or processes - Simplify document management and improve information accessibility Here are a couple of examples to illustrate how Dynamic Location Routing can be used: **Example1: Routing based on code:** Documents attached to Sales Orders within a Sales Organzization with code 1000, go to SharePoint location 1000: SAPDocs->Sales Orders->1000 Documents attached to Sales Orders within a Sales Organzization with code 2000, go to SharePoint folder 2000 : SAPDocs->Sales Orders->2000 **Example2: Internal vs. External documents:** SAP information, such as ArchiveLink document type, classification, or vendor number, can be used to automatically classify documents as either internal or external and route them to the appropriate SharePoint folders. External documents, intended for vendor access, are stored in a SharePoint folder that the specific vendor can view. Internal documents, meant for internal use only, are stored in a separate SharePoint folder inaccessible to vendors, even if the document is related to a specific vendor. This automated categorization and routing process, based on SAP metadata, helps organizations maintain better control over document access and ensures that information is shared appropriately. 5\. Document Libraries and Folders  ----------------------------------- Document Libraries and/or Folders are sometimes leveraged to logically bundle a series of documents together.   SharePoint implements Permission inheritance from Site Collection->Site/Subsite->Document Library->Folder. Permission inheritance can be broken at any of these levels up until 100,000 items exist, at which point it is no longer possible. As a general best practice, it is best to break inheritance at the highest possible level in the hierarchy.   ECM will allow dynamic selection at any level of Site/Subsite/Document Library/Folder/SubFolder.   Content Server allows for only a single target Document Library to be selected per Content Repository configuration.  ### Document Libraries and Folders Considerations:  Pros:   - Can ensure security models are followed  - Can implement business logic around folders. E.g. create a new Document Library folder for every new Work Order that is created in Plant Maintenance  - ECM can link folders to SAP business objects vs individual documents. This can be used for scenarios where large batches of documents need to be easily linked to SAP Business Objects  Cons:  - Content Server does not inherently allow for custom folders to be created in its specification  ## 6. Viewing Options  There are three options available when deciding how to view SAP content stored and linked to SharePoint Online:  - SAP Viewer: The document is downloaded to the user’s computer and the SAP viewer will display the document  - SharePoint Authenticated URL Link: A SharePoint Viewing URL is returned to the user who must then authenticate to SharePoint to view the document. The user must have permissions to the Document. The document is viewed in the SharePoint web based viewer  - SharePoint Unauthenticated (Short Lived) URL Link: A short lived unauthenticated URL is generated and returned to the user. The user does not need to authenticate to SharePoint Online to view the item. The document is viewed in the SharePoint web based viewer. By default the URL expires in 1 minute, but this expiry period is configurable in Link Enterprise  Each of the above options has pros and cons listed below:  ### SAP Viewer Considerations:  Pros:  - SAP Viewer allows notes to be attached to documents  Cons:  - SAP Viewer has limited file type support  - SAP Viewer must be maintained on the user’s desktop (IT overhead)  - The document is downloaded (highest bandwidth) to the local computer before viewing  ### SharePoint Authenticated URL Link Considerations:  Pros:  - SharePoint Online Viewer has a wide range of file type support  - SharePoint Online Viewer is web based and runs in the browser  - The SAP viewer does not have to be installed or maintained  - The document does not need to be downloaded to the local computer before viewing (lowest bandwidth)  Cons:  - The user must have access rights to the document in the SharePoint Online document library  ### SharePoint Online Unauthenticated (Short Lived) URL Link Considerations:  Pros:  - SharePoint Online Viewer has a wide range of file type support  - SharePoint Online Viewer is web based and runs in the browser  - The SAP viewer does not have to be installed or maintained  - The document does not need to be downloaded to the local computer before viewing (lowest bandwidth)  - The user does not need access rights to the document in the SharePoint Online document library, SAP controls access  Cons:  - Additional configuration of SharePoint site collections to allow unauthenticated URLs to be generated. Configuration of this setting is per Site Collection  [title] OAC0 Repository ID Configuration [path] Repository Specific Guides/Link Enterprise for S3/Installation and Base Configuration Guide/Base SAP ArchiveLink Configuration/ **1. For ECM:  **the repository ID, albeit mandatory, only requires it to be created with a meaningful description – the HTTP server and HTTP script are not needed. No certification needs to be sent as well as additional repository ID CS administration functionality is not relevant (and will fail if you try as this is only utilized by Content Servers). A content server does NOT need to be configured in the Enterprise Connector.  Make sure the changes are saved and captured in a transport so that they can be transported to other environments. **2. For Content Server: **full configuration of the repository ID is required. A corresponding Content Server must also be configured in the Enterprise Connector.  This configuration contains SAP system level details (DEV vs. QUAL vs. PRODUCTION). *This should not be transported, but instead created manually in each SAP system if possible.* Below is an example: ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/vfv64QRgMk9E0-QidhXeO_image.png) - Note: You cannot send the certificate or test connectivity until the Enterprise Connector configuration is also completed below and the windows service is running. When the windows service is installed, configured and running, refer to section Establishing SAP \<-> Enterprise Connector Connectivity Configuration to send the SAP certificate and test connectivity. [title] Anonymous Shared URL Configuration [path] Repository Specific Guides/Link Enterprise for M365/Installation and Base Configuration Guide/Configure app within M365 - Application based permissions - Client Secret (Not Recommended)/ To configure shared URL's in SharePoint, we have the following options. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/45LQ6M7RnC8PvpucN7jv2_image.png" size="72" width="643" height="393" position="center" darkWidth="643" darkHeight="393" showCaption="false"} To enable sharing URL with anyone (using expiry time) the following steps are required to do so: - Enter the browser the following URL and hit enter. https\://\.sharepoint.com/\_layouts/15/online/AdminHome.aspx#/home - Under active sites, select the site we want to modify the sharing URL permissions. ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/JGXrhoUMPxf2jTKZzZF3t_image.png) - Under the tab "Settings" click on the link "More sharing settings". - Select the following options in the provided screenshot ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/I1d4PzIJI0fWprWDDyzpb_image.png) - To change the default expiry timing of shared URL'S on the left side navigation panel under 'Policies' select 'Sharing'. Below, you will see the default number of days you can set the expiry time to. (You can override this in the middleware) ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/gQc52C1rB265p936xaXBq_image.png) - To shorten the default expiry time and override the default tenant level, we can do so via the middleware. - Enter the number of seconds in the highlighted field in the screenshot and hit save. Restart the Gimmal Link service via Windows services after saving. - To visit this URL, enter https\://localhost:82 default user: admin default password: admin ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/Jg7GSEfVhktYDkKijNpFK_image.png) [title] Milestone: Establish SAP <-> Enterprise Connector Connectivity [path] Repository Specific Guides/Link Enterprise for S3/Installation and Base Configuration Guide/ Establishing connectivity from SAP to the Enterprise Connector and S3 depends on whether ECM or Content Server is being utilized.  This is a good milestone to reach for a base install and connectivity.  [title] Installation Overview [path] Repository Specific Guides/Link Enterprise for M365/Installation and Base Configuration Guide/ The below outlines the necessary Gimmal Link Enterprise installation tasks:  1. Install Enterprise Connector 2. Configure M365 application 3. Install SAP transports (mandatory ECM, optional Content Server) 4. Create SAP SAP system account with appropriate authorizations (mandatory ECM) 5. Configure SAP RFC destinations and Gateway (ECM only) 6. Configure SAP Gateway - ECM Only 7. Base SAP ArchiveLink Configuration 8. Base SAP Link Enterprise Configuration 9. Base Enterprise Connector Configuration - SAP / ECM / Content Server / RFC Destination 10. Milestone: Establish SAP \<-> Enterprise Connector \<-> SharePoint Connectivity 11. Determine Viewing Strategy (located in Solution Guide) Optional follow up steps (not required to achieve base the connectivity milestone) and notes include: 1. Follow Up Basis Tasks 2. Follow Up Security Tasks 3. Follow Up Middleware Team Tasks 4. Follow up SharePoint Team Tasks For additional integration patterns (i.e.: document storage, inbound processing, metadata transfer, etc.…) this functional configuration is NOT included in this guide - refer to the Solution Guide. Such activity includes: 1. Configure SAP ArchiveLink document type and link tables 2. Configure SharePoint collections, sites, libraries, and content types 3. Configure Link Enterprise document storage, linking, migration, metadata transfer, etc. 4. Customize or extend SCRUD functionality (ECM only) [title] Grant Necessary SAP authorizations – ECM Only [path] Repository Specific Guides/Link Enterprise for M365/Installation and Base Configuration Guide/ In order to configure and monitor Link Enterprise , the below two transactions should be granted to the configurator and administrator of Link Enterprise :  - /DFLOW/SYS - /DFLOW/GTW Note: Depending on what functional integration patterns you are implementation, there may be additional transaction codes to grant access to a broader group of users: 1. Workflow Configuration: /DFLOW/WFCONFIG 2. Workflow AP Rollover: /DFLOW/APROLLOVER 3. Workflow AP Statistics: /DFLOW/APSTAT 4. Workflow ASL: /DFLOW/APASL 5. Workflow AP TrackLink: /DFLOW/APTRACKLINK 6. Workflow DMS TrackLink: /DFLOW/DMSTRACKLINK 7. Workflow General TrackLink: /DFLOW/TRACKLINK 8. Delete Link Manager: /DFLOW/LINKM 9. API Mass Load: /DFLOW/MLOAD 10. Migration Utility: /DFLOW/MIGRATOR 11. AuditLink Create: /DFLOW/AUDITLINK 12. AuditLink Dashboard: /DFLOW/AUDITLINKDASH If your security roles also check table maintenance authorizations, the authorization object Z/D1 must be granted via S\_TABU\_DIS for those who will configure Gimmal Link Enterprise. \*If Z/D1 does not exist in your system, the transport that contains Z/D1 is a customizing transport and must be imported separately. Please contact your Link Enterprise implementation specialist to obtain this transport. [title] Overview for S3 and Middleware Team [path] Repository Specific Guides/Link Enterprise for S3/Installation and Base Configuration Guide/ Refer to the below sections for steps relevant to the S3 and Middleware teams. This is often a collaborative effort and maybe also require support from SAP Basis for SAP connectivity.  1. Installing the Enterprise Connector 2. Create S3 Credentials in AWS. 3. Configure S3 Connection in Middleware. 4. Establishing SAP \<-> Enterprise Connector Connectivity 5. Follow up Middleware Team Tasks 6. Follow up S3 Teams Tasks [title] Mandatory ECM Indexes [path] Repository Specific Guides/Link Enterprise for M365/Installation and Base Configuration Guide/Follow up SharePoint Team Tasks/ ECM uses search query to enable real time search of documents uploaded using ECM for Inbound to SAP Processing (SAPLink) An index should be created for: - LinkEnterpriseSaplinkTrigger Please consult your integration team to determine if ECM is being implemented for the above pattern. [title] Purpose of Guide [path] Repository Specific Guides/Link Enterprise for M365/Installation and Base Configuration Guide/ The goal of this guide is to establish base installation, minimal configuration, and connectivity testing to a point that SAP and Link Enterprise can communicate with SharePoint and vice-versa.  For details on architecture, supported environments, and system requirements please refer to the docuflow [Technical Overview](https://linkenterprise.docs.gimmal.com/technical-overview). For detailed configuration of specific integration patterns and docuflow add-ons please refer to the docuflow [Solution Guide](https://linkenterprise.docs.gimmal.com/solution-guide).  For custom development, please refer to the [Developers Guide](https://linkenterprise.docs.gimmal.com/developers-guide). [title] Customer Resources Required [path] Repository Specific Guides/Link Enterprise for S3/Installation and Base Configuration Guide/ Customer resources typically required for a Gimmal Link Enterprise installation and implementation are:  - SAP Basis: install SAP transports, support base configuration, and QUAL, PROD migration (see below Overview for SAP Basis) - SAP Security: create SAP user (Gimmal Link ECM) and grant necessary ArchiveLink and Gimmal Link Enterprise authorizations (see below Overview for SAP security) - SAP Developer: if Gimmal Link Enterprise integration patters are to be extended or customized, an ABAP developer (customer or Gimmal) will be required along with corresponding developer key and SAP transports (see separate Gimmal Link Enterprise Solution Guide) - S3 Admin: support installation of Gimmal Link Enterprise middleware and SharePoint configuration - Middleware Server/Network/Security Team: support installation of Gimmal Link Enterprise Connector - Business/SAP End-User/Tester: support unit and user acceptance testing. [title] Content Server [path] Repository Specific Guides/Link Enterprise for M365/Installation and Base Configuration Guide/Milestone: Establish SAP <-> Enterprise Connector Connectivity/ When you are ready to completed connectivity between SAP and the Enterprise Connector for Content Server, you must first send the certificate from SAP to Enterprise Content Server.  Both sending of the certificate and testing connectivity is done via the SAP CS Admin functionality in transaction OAC0.  \* Make sure the Enterprise Connector server is turned on (windows service “Gimmal Link Enterprise Connector”) prior to executing the SM59 test connection.  1. From OAC0 find the repository ID configured prior and open the details 2. Choose the “Send Certificate” icon 3. The message in the bottom toolbar should read “Certificate sent successfully” 4. Click the “Info” icon next to confirm the content server is fully operational [title] Adding SAP JCO logging information to any windows service [path] Repository Specific Guides/Link Enterprise for M365/Installation and Base Configuration Guide/Follow up Middleware Team Tasks/ In order for additional JCO logging to take place it may be necessary to adjust the configuration for the Windows service. Open the Gimmal Link Enterprise Service configuration by clicking on the “Gimmal Service” application in the Gimmal program group (Optionally you can double click on the gimmal.exe application found under the service folder in the installation directory) Click on the “Java” tab and scroll the “Java Options:” window all the way to the bottom. There will be two lines that determine where the JCO logs will go (jco.trace\_path) and the amount of logging to perform (jco.trace\_level). For more information on the trace level refer to SAP JCO documentation. For this example the setting of 10 gives complete logging information. For that reason it is best to leave this additional logging only enabled when needed to better understand a JCO communication error with SAP and not leave it enabled in a production environment.  -Djco.trace\_path="\\logs\\"  -Djco.trace\_level=10  [title] Overview for SAP Security [path] Repository Specific Guides/Link Enterprise for S3/Installation and Base Configuration Guide/ Refer to the below section or links for the steps relevant to SAP Security team:  1. Create SAP system account – Gimmal Link Enterprise ECM Only 2. Grant Necessary SAP Gimmal Link Enterprise authorizations – Gimmal Link Enterprise ECM Only 3. Grant Necessary SAP ArchiveLink authorizations – Gimmal Link Enterprise ECM or Content Server 4. Follow up Security Tasks [title] Technical Overview [path] Repository Specific Guides/Link Enterprise for S3/ ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/Zwi2e5KAZlmZijYlXixhn_image.png" size="54" width="1210" height="462" position="center" showCaption="false"} ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/a9EXFAnHd3Drulu3gfKnI_image.png" size="54" width="1227" height="243" position="center" showCaption="false"} [title] Configure SAP Gateway – ECM Only [path] Repository Specific Guides/Link Enterprise for S3/Installation and Base Configuration Guide/ Gateway security via SMGW may need to be configured depending on your reginfo file settings in order that connections are permitted from the host where the Link Enterprise Connector is installed. Note the below values need to reflect the naming convention chose above in the RFC destination:  1. Ex: P TP=Z\* (Allows the Gimmal Link Enterprise middleware registered server programs to connect from any host) 2. Ex: P TP=Z\* HOST=\*.\ (Allows the Gimmal Link Enterprise middleware registered server programs to connect from any host on the domain specified. 3. Ex: P TP= Z\_CSM\_API\_01 HOST=\ (Only allows the specified registered server program to connect from the specified host) Example:  P TP=Z\_CMSAPI1 HOST=\*  [title] Grant Necessary SAP ArchiveLink authorizations – ECM or Content Server [path] Repository Specific Guides/Link Enterprise for M365/Installation and Base Configuration Guide/ Base configuration for both Gimmal Link Enterprise components requires (at least one) SAP ArchiveLink repository to be created. Thus, access to the below transactions should be granted to the configurator and administrator of Gimmal Link Enterprise:  - OAC0 - Content Repositories - OAA3 - Protocols In some instances, the SAP Basis team will already have access and may prefer to control this configuration. This configuration is outlined below sections.  Business process configuration requires access to additional ArchiveLink transactions. Albeit not covered in this guide, these transactions should also be granted to the Gimmal Link Enterprise configurator:  - OAC2 - document types - OAC3 – business object /document type / link table assignment [title] Configure app within M365 - Application based permissions - Certificate Based (recommended) [path] Repository Specific Guides/Link Enterprise for M365/Installation and Base Configuration Guide/ The preferred method to authenticate with the graph api is via application based permissions. Using M365 SharePoint as a Gimmal Link Enterprise repository you will need to ensure that the Enterprise Connector is configured and able to connect to the Microsoft graph API. You must create an enterprise application via the Microsoft Azure portal to complete this procedure. This will require an account with appropriate level of permissions to grant correct access rights to a user (connector user) using the graph API when inside the azure portal.  You can either self-grant access or have an admin grant access to the graph API and its corresponding access rules inside the azure portal if and only if that user has authority to grant access to those rules.  The following steps below outline this process:  i. Visit https\://portal.azure.com/ then login using an appropriate account. ii. Click on Active Directory, then click on App Registrations and click on new registration. Name the application GimmalLinkENT\_suffix (Either DEV, TEST,PROD) depending on environment provisioning. Select single tenant. Click register. Click Api Permissions under Manage. Click Add Permissions. *We have also included a summary of the site level permissions *[here](docId\:b5UKq8Dzz49AtdKe2yDay) Click Grant admin consent for GimmalLinkENT\_suffix app Click certificates and secrets. ![Certificates & Secret](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/V1ysLrJ2yVTUqGRYe-zei_image.png "Certificates & Secret") Click on 'Upload certificate' under 'Certificates' tab. ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/UKjU8uB9QOFsD2q1HhuhM_image.png) select a public key/certificate by selecting it via file choose. ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/uABhgokoCWkB9ZdoJ6Nqp_image.png) Provide appropriate description of the certificate in 'Description' field. Click on 'Add' If everything is well, certificate basic details will be populated in the table along with Thumbprint, Description, start date, Expiry Date and certificate ID. ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/CqcggDNwHuJLL7fCEjsZa_image.png) Click on overview and save the following information. App ID, and tenant ID. ** [title] Introduction and Overview - S3 [path] Repository Specific Guides/Link Enterprise for S3/Technical Overview/ Gimmal Link Enterprise is an SAP certified suite of functionality that provides integration between SAP and content service repositories. This integration includes document storage, linking, bidirectional metadata transfer, process and workflow automation, as well as ArchiveLink processing. Line of business solutions (such as Accounts Payable) and additional add-ons (such as SAP DMS integration and AuditLink bundle creation) can be leveraged in addition to the baseline functionality. In addition, Gimmal Link Enterprise provides a robust SAP based migration tool that handles migration of content from any ArchiveLink, File, or SAP database (both attachments and notes) source to S3. The Gimmal Link Enterprise offering consists of two separate integration options or approaches that can be used independently or in combination to provide the best value for your implementation: 1\. Link Enterprise ECM Leveraging components both inside (SAP transport component) and outside the SAP boundary (middleware component), Gimmal Link Enterprise ECM provides the most powerful and flexible SAP to content services integration options. Enhanced user-based storage and linking, no-code bidirectional metadata transfer and workflow triggering, all supported by comprehensive SAP based administrator workbench monitoring, utilities, user delete link request management, Audit and Compliance bundle creation, and reporting functions are just some of the highlights. In addition, Gimmal Link Enterprise provides a robust SAP based migration tool that will handle migration of content from any ArchiveLink, File, or SAP database (both attachments and notes) source to S3. Gimmal Link Enterprise ECM also provides a powerful Content API set of SAP BAPI’s to allow the customer to perform full SCRUD (Search, Create, Read, Update, and Delete) functionality to fulfill any custom requirements within the SAP boundary. 2\. Link Enterprise Content Server Based on the SAP ArchiveLink framework, the Gimmal Link Enterprise Content Server (middleware component only), provides SAP message output, document storage, print list support, data archiving, and other standard ArchiveLink functionality from SAP to your content services platform. Which Gimmal Link Enterprise approach and tool is utilized depends on the integration pattern/add-on required: `*put your mouse over the below table to scroll left/right` | | Web Services Integration | Business Document
Storage | Enhanced SFO / GOS Attachment List | Enhanced Business
Document Storage | Outbound from SAP
Metadata Transfer | Inbound to SAP
Metadata Transfer | Migration Utilities | Federated Services | Administrator
Workbench | Message Output
Storage | Print List Storage | Data Archiving (ADK) | Enhanced Inbound
Processing | Inbound SAP DMS
Integration | Outbound SAP DMS
Support | Bi-Directional
Workflow
Integration\Process | Dynamic Folder Creation | Delete Link Management | Automation AuditLink | TrackLink Workflow | List Creation (SAP reference data) | Accounts Payable | S3 SAP
Content API | | ------------------- | ------------------------ | ------------------------------ | ---------------------------------- | --------------------------------------- | ---------------------------------------- | ------------------------------------- | ------------------- | ------------------ | ---------------------------- | --------------------------- | ------------------ | -------------------- | -------------------------------- | -------------------------------- | ----------------------------- | ----------------------------------------------------- | ----------------------- | ---------------------- | -------------------- | ------------------ | ---------------------------------- | ---------------- | ----------------------- | | ECM | x | x | x | x | x | | x | x | x | x | | | x | | x | x | x | x | x | x | | x | x | | Content
Server | | x | x | | x | | | | | x | x | x | | | x | | | | | | | | | Figure 1: Toolset vs. Integration Pattern Reasons you may need to use content server: 1. SAP message output without ECM plug in 2. ADK data archiving 3. Fiori apps using document service (ie: without SFO/GOS functionality) 4. Outbound DMS 5. Any other application or 3rd party that relies on ArchiveLink directly [title] WebSocket RFC (Cloud Connections) [path] Repository Specific Guides/Link Enterprise for M365/Installation and Base Configuration Guide/ ## Cloud Configuration The Cloud Configuration allows on-premise solutions to communicate with Internet based Gimmal Link Enterprise servers over **HTTPS/SSL**. ### Import Certificate To allow SSL handshake between SAP and a hosted Link Enterprise Environment we require importing Gimmal Link Enterprise public certificate into SAP's Trust Manager. 1. In SAP start the **Trust Manager** (**STRUST**) 2. **Import **the Gimmal Link Enterprise public certificate into ***SSL Client (Standard)*** (This will enable SAP to identify Gimmal certificate during TLS handshake) 3. Enter **Change Mode (Ctrl + F1)** 4. Click **SSL Client Standard**. Click **Import **and select the Gimmal Link Enterprise public certificate provided. Click **Add to Certificate List** and **Save** ### Export Certificates The Gimmal Link Enterprise middleware requires an export of the SAP public root certificate for SSL Client and SSL Server. This is to identify the SAP system connecting into the hosted environment. 1. In SAP start the **Trust Manager (STRUST)** 2. Export the root certificate from **SSL Client (Standard) and SSL Server (Standard)**. 3. Click** SSL server Standard **and double click the subject ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/y4-PmOMlv6QKsXzoEzYKx_exp1.png) 4. It will be appear in the Certificate section 5. Scroll down and export (provided below is a sample image) of export icon ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/CZrLjYYsqbfQ9w3rJVQJC_root-cert-2.png) 6. Click **SSL server Client **and double click the Subject 7. Scroll down and export the certificate ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/lWsasF1o0ZYHXUBh6N8dP_exp2.png) 8. Send both certificates to your Gimmal representative ### Setup RFC Destination To enable a endpoint for the SAP to connect into the middleware we require an **RFC Destination** to be created 1. Visit transaction **SM59** 2. Click **Create **and give the destination an appopriate name. An example is Z\\_\ 3. Ensure the connection type is type **'W'** ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/EkYksHsPCFz57o8WjU7oT_zweb.png) 4. Under technical settings we need to prove the **Target System Settings** 5. For **host name** enter the provided hostname given to you by your Gimmal Representative 6. For **port** enter the provided port given to you by your Gimmal Representative 7. ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/Yrpx4JlTuSoTO4IlhGLSu_initalsettings.png) 8. Click the **Logon & Security** tab and enter Language as **EN** 9. Set the** Explicit Client** to **by Hostname** 10. Set the **Authentication Method** to by **X.509 certificate** 11. Under **Security Options** set to **SSL Client (Standard)** 12. ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/fqsL5NnIBlPywM9A8scW5_securiy.png) 13. Click **Save** 14. ***Provide the RFC Destination to your Gimmal representative*** ### Firewall The firewall needs to be configured to allow **HTTPS **traffic through to the Gimmal Link Enterprise server. To find or define these ports: ***Inbound Rule*** - In SAP, review the value for ***icm/server\_port\_x*** (where x=0,1,2,3...,n) that is used for **HTTPS**. This port will need to be opened for inbound traffic to the SAP system. ***Outbound Rule*** - Review the section ***Setup RFC Destination*** for the port that has been configured in **SM59 **for the ***WebSocket RFC*** communication to the Gimmal Link Enterprise Server. - This port will be given to you by the Gimmal representative ### Changing Profile Parameters To allow quick setup of websocket connetivity we can dynamically change the parameters to quickly confirm connectivity. Work with your SAP BASIS to configure the parameters to hold. 1. Enter transacation RZ11. 2. Type in rfc/websocket/external\_active 3. Change the value from 2 to 1. (This will allow us to bypass UCONN and enable logon, even if UCON is not activated and configured) 4. Confirm ucon/websocketrfc/active is set to 1. [title] ECM [path] Repository Specific Guides/Link Enterprise for M365/Installation and Base Configuration Guide/Milestone: Establish SAP <-> Enterprise Connector Connectivity/ At this point no additional configuration is required to establish connectivity and ECM connectivity testing can be done so via:  1. The test connection button at the Enterprise Connector level for the SAP endpoint (refer to Base Enterprise Connector Configuration – ECM Only) 2. Using transaction SM59 within SAP to ensure the RFC connection configured in Configure SAP RFC destinations – Enterprise ECM Only can now communicate with the Enterprise Connector. \* Make sure the Enterprise Connector windows service is turned on prior to executing the SM59 test connection.  Select the Connection Test button. You should see a successful connection with timing. In addition, via the System Dashboard, you should now see a green light under the column “API” as shown below. This indicates that SAP has the RFC connection to the matching Enterprise Connector middleware and configuration.  Note that until the API destination(s) and CMS Use Tags are utilized in a processing rule such as DocManager or Migrator, etc., they will show as “unused”.  [title] Content Server [path] Repository Specific Guides/Link Enterprise for S3/Installation and Base Configuration Guide/Milestone: Establish SAP <-> Enterprise Connector Connectivity/ When you are ready to completed connectivity between SAP and the Enterprise Connector for Content Server, you must first send the certificate from SAP to Enterprise Content Server.  Both sending of the certificate and testing connectivity is done via the SAP CS Admin functionality in transaction OAC0.  \* Make sure the Enterprise Connector server is turned on (windows service “Gimmal Link Enterprise Connector”) prior to executing the SM59 test connection.  1. From OAC0 find the repository ID configured prior and open the details 2. Choose the “Send Certificate” icon 3. The message in the bottom toolbar should read “Certificate sent successfully” 4. Click the “Info” icon next to confirm the content server is fully operational [title] Content Server [path] Repository Specific Guides/Link Enterprise for S3/Installation and Base Configuration Guide/Base Enterprise Connector Configuration/ Below is the configuration needed for a S3 Content Server. \*\*\* please refer to the section Follow Up S3 Team Tasks for more information on required indexes \*\*\* 1. Under "Connections" click "S3" 2. Under "S3" click modify on a previously created box connection. 3. Click "Add Content Server" 4. Hover over each input box to see example values. 5. Click "Add" 6. Click "Save". 7. Restart service via Windows services.   ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/sXK8kJEqLKdTfPxiiBo2f_screenshot-624.png" size="58" width="536" height="720" position="center" showCaption="false"} Image CaptionImage alt text The below table is a description of each configuration entry above, along with possible value.  | Setting | Description | Sample Value(s) | | ---------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | | enabled | YES/NO | Yes to enable, No to not but still configure. | | signature required | YES | Used for verify authentic origin requests.  | | csHost | Binds to local IP address  | 127.0.01 | | port | Port we want content server to be deployed on. | 8089 | | threads | Max Number of threads to allocate for parallel processing.  | 50 | | contentType | CMS Custom metadata needs to specify the name of template | invoices | | SAPType | Configured SAP System utilized  | S4 | | tmpDir | Directory to temporary use for storage | C:\\\\\\\\config\\\tmp | | certDir | Directory where certificates are located | C:\\\\\\\\config\\\certificates | | RepoId | SAP repository for content Server | ZS | | Location | S3 Bucket ID | For S3: i.e. 13213213 | | repository | For S3 n/a | n/a | | callBackEnabled(for version 6.6.8) | Enable callbackHandler to link and monitor content server activities from SAP and to allow for ECM/SAPDocID mapping. ie: for each content server call from SAP to M365, a separate return call is made via SAP Jco RFC to log in the Link Enterprise SAP Gateway as well for a CREATE, it will map SAPDocID to the ECM M365 object id.

The recommended setting is YES as this will support:
- ECM based viewing
- ECM API support for documents stored via Content Server
In extremely high volume content server scenarios where no ECM will be in play, this setting should be set to NO | YES | \*the Windows service must be restarted for changed to take effect [title] Architecture Overview [path] Repository Specific Guides/Link Enterprise for M365/Technical Overview/ The below diagram outlines the basic components of the Gimmal Link Enterprise stack for Microsoft 365: ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/si0HKb_hOG9dKP66ebs3u_image.png) [title] Creating S3 Credentials for middleware [path] Repository Specific Guides/Link Enterprise for S3/Installation and Base Configuration Guide/ To create an S3 Connection in middleware you must have an aws Access Key and a secret access key. We recommend using the IAM interface in AWS to configure a user with an access key with the appropriate permissions, however it is possible to use a root access/secret access key. For demonstration and simplicity purposes on how to create an access key and secret access key, the below instructions are using a root account. - In the IAM Panel click "Create Access Key". ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/7lBt05ngd2Rb9-05QY9b3_image.png) - Note down the "Access Key" and "Secret access key" for later use as seen below. You can also download the record as a csv file. ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/QHNnEObWsrQcTARO_aZ0G_image.png) [title] Mandatory Content Server Indexes [path] Repository Specific Guides/Link Enterprise for M365/Installation and Base Configuration Guide/Follow up SharePoint Team Tasks/ Content server uses search query to enable real time search of documents uploaded using content server for : 1. Viewing from SAP 2. ADK data archiving Indexes should be created for: - compId - docID Please consult your integration team to determine if Content Server is being implemented for any of the above patterns. [title] Overview for SAP Basis [path] Repository Specific Guides/Link Enterprise for S3/Installation and Base Configuration Guide/ Refer to the below section or links for the steps relevant to SAP Basis team:  1. Installing the Gimmal Link Enterprise SAP Transports – Gimmal Link Enterprise ECM Only  2. Configure SAP RFC destinations – Gimmal Link Enterprise ECM Only 3. Configure SAP Gateway – Gimmal Link Enterprise ECM Only  4. Base SAP ArchiveLink Configuration 5. Establishing SAP \<-> Gimmal Link Enterprise Connector Connectivity Configuration 6. Follow up Basis Tasks – Gimmal Link Enterprise ECM Only  [title] Overview for SharePoint and Middleware Team [path] Repository Specific Guides/Link Enterprise for M365/Installation and Base Configuration Guide/ Refer to the below sections for steps relevant to the SharePoint and Middleware teams. This is often a collaborative effort and maybe also require support from SAP Basis for SAP connectivity.  1. Installing the Enterprise Connector 2. Configure App within M365 - Application based permissions (recommended) 3. Configure App within M365 Account - User Based (not recommended) 4. Configure App within M365 Account – Legacy Registration (not recommended) 5. Establishing SAP \<-> Enterprise Connector Connectivity 6. Follow up Middleware Team Tasks 7. Follow up SharePoint Teams Tasks [title] Adjusting log4j logging [path] Repository Specific Guides/Link Enterprise for M365/Installation and Base Configuration Guide/Follow up Middleware Team Tasks/ The Windows service can have what is logged adjusted by adjusting the log4j configuration files. These configuration files work in conjunction with a logging utility called log4j which is well documented online. The configuration files (found under the config directory in the installation folder):  log4j2-gimmal.xml (The Gimmal Link Enterprise Windows service log configuration)  Using your preferred text editor you can go in and adjust these configuration files to increase logging as well as change how the log files look. Once the changes have been made make sure to either restart the profile wizard or the Windows service so that the changes can take affect. Please refer to log4j information online for assistance in changing the format of these configuration files.  [title] Installation and Base Configuration Guide [path] Repository Specific Guides/Link Enterprise for S3/ ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/Z5Y48ZCc_-BUkADQDuJUI_image.png" size="54" width="1210" height="462" position="center" showCaption="false"} ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/b8OaCikFuJjB6GJS6ZKml_image.png" size="54" width="1227" height="243" position="center" showCaption="false"} ² [title] Customer Resources Required [path] Repository Specific Guides/Link Enterprise for M365/Installation and Base Configuration Guide/ Customer resources typically required for a Gimmal Link Enterprise installation and implementation are:  - SAP Basis: install SAP transports, support base configuration, and QUAL, PROD migration (see below Overview for SAP Basis) - SAP Security: create SAP user (Gimmal Link ECM) and grant necessary ArchiveLink and Gimmal Link Enterprise authorizations (see below Overview for SAP security) - SAP Developer: if Gimmal Link Enterprise integration patters are to be extended or customized, an ABAP developer (customer or Gimmal) will be required along with corresponding developer key and SAP transports (see separate Gimmal Link Enterprise Solution Guide) - SharePoint Admin: support installation of Gimmal Link Enterprise middleware and SharePoint configuration - Middleware Server/Network/Security Team: support installation of Gimmal Link Enterprise Connector - Business/SAP End-User/Tester: support unit and user acceptance testing. [title] Overview for SAP Basis [path] Repository Specific Guides/Link Enterprise for M365/Installation and Base Configuration Guide/ Refer to the below section or links for the steps relevant to SAP Basis team:  1. Installing the Gimmal Link Enterprise SAP Transports – Gimmal Link Enterprise ECM Only  2. Configure SAP RFC destinations – Gimmal Link Enterpsrise ECM Only 3. Configure SAP Gateway – Gimmal Link Enterprise ECM Only  4. Base SAP ArchiveLink Configuration 5. Establishing SAP \<-> Gimmal Link Enterprise Connector Connectivity Configuration 6. Follow up Basis Tasks – Gimmal Link Enterprise ECM Only  [title] SharePoint On-Prem Endpoint [path] Repository Specific Guides/Link Enterprise for M365/Installation and Base Configuration Guide/Base Enterprise Connector Configuration/ Using a SharePoint On-Prem repository you will need to ensure that the enterprise connector is configured and able to talk to the Microsoft SharePoint Rest API.  Note: SharePoint On-Prem requires utilization of Windows NTLM Authentication to access the SharePoint Rest API. This is enabled via your Microsoft IIS server and is an option that must be enabled for connector usage.  From the information gathered in the step Configure Gimmal Link Enterprise app within M365 Account, update the configuration file located at \\config\INILocator.properties the following parameters where “companySP” is the name of your system in the connector, under section “\[Sharepoint Connection]”.  An example is shown below:  companySP.sharepoint.onprem.login=administrator  companySP.sharepoint.onprem.password=\  companySP.sharepoint.onprem.domain=DEVAD002  companySP.sharepoint.onprem.host= devsp2013srv1  Use the PasswordGenerator.jar located under \ enter using command prompt java -jar PasswordGenerator \ to receive the encrypted hash to enter in the configuration file.  Also under \[General Preferences]:  sharepointOnPrem.systems=companySP  \*the Windows service must be restarted for changed to take effect [title] Configure SAP Gateway – ECM Only [path] Repository Specific Guides/Link Enterprise for M365/Installation and Base Configuration Guide/ Gateway security via SMGW may need to be configured depending on your reginfo file settings in order that connections are permitted from the host where the Link Enterprise Connector is installed. Note the below values need to reflect the naming convention chose above in the RFC destination:  1. Ex: P TP=Z\* (Allows the Gimmal Link Enterprise middleware registered server programs to connect from any host) 2. Ex: P TP=Z\* HOST=\*.\ (Allows the Gimmal Link Enterprise middleware registered server programs to connect from any host on the domain specified. 3. Ex: P TP= Z\_CSM\_API\_01 HOST=\ (Only allows the specified registered server program to connect from the specified host) Example:  P TP=Z\_CMSAPI1 HOST=\*  [title] Base Enterprise Connector Configuration [path] Repository Specific Guides/Link Enterprise for S3/Installation and Base Configuration Guide/ Base Enterprise Connector configuration contains the following components: 1. S3 Connection/Endpoint - required for both ECM and Content Server 2. SAP Connection - required for ECM only 3. Content Server - required for Content Server only   The above will finalize base connectivity between SAP and S3.. For specific configuration of SharePoint *\<-> *SAP integration patters and use cases, please refer to the Solution Guide (separate).  [title] Installation and Base Configuration Guide [path] Repository Specific Guides/Link Enterprise for M365/ ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/Z5Y48ZCc_-BUkADQDuJUI_image.png" size="54" width="1210" height="462" position="center" showCaption="false"} ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/b8OaCikFuJjB6GJS6ZKml_image.png" size="54" width="1227" height="243" position="center" showCaption="false"} ² [title] Uninstalling the Enterprise Connector [path] Repository Specific Guides/Link Enterprise for M365/Installation and Base Configuration Guide/Follow up Middleware Team Tasks/ 1. In order to uninstall the Enterprise Connector we recommend that you first stop the Windows service by either using the “Administrative Tools” “Services” option under the “Control Panel” or by using the “Gimmal Link Enterprise Service” configuration found in the Gimmal program group. 2. Once the service has been stopped you will need to uninstall the service by running the “uninstallService.bat” script found in the “service” directory found under the installation folder. Verify that the service was truly removed from the list of services. If for some reason the service isn’t removed you can run “SC DELETE Gimmal Link” from a DOS command prompt window” 3. Once the service has been removed you can run the uninstaller found in the “Uninstaller” directory under the installation folder. Double clicking on the uninstaller.jar file will then walk you through uninstalling the Gimmal Link Enterprise Connector. Note: The uninstaller may not be able to delete some of the files and folders that were created so additional cleanup may have to be done manually for the installation location. If you have any problems uninstalling the Gimmal Link Enterprise Connector please don’t hesitate to speak to your system administrator or a Gimmal support team member.  [title] How to change Enterprise Connector username and password [path] Repository Specific Guides/Link Enterprise for M365/Installation and Base Configuration Guide/Follow up Middleware Team Tasks/ 1. Turn off the Gimmal Link Enterprise service 2. Open command prompt in windows 3. Change directory to the installation directory of Gimmal Link Enterprise 4. Type in java -jar PasswordGenerator.jar insertyourpassword 5. Copy the encrypted password returned to the console 6. Open up config.properties located in the /config directory where Gimmal Link Enterprise is installed 7. Locate the fields user.name=gimmal password=r0TMzjlSeMkURTcC77ocxg== 8. Replace "gimmal" if you would like to change the previous username, and replace password with your copied encrypted password from step 5 and replace the previous password 9. Save your changes 10. Start the Gimmal Link Enterprise service 11. Open browser in privacy/icognito mode or with cleared cache/cookies/passwords. Type in your new username and password, [title] Overview for SAP Security [path] Repository Specific Guides/Link Enterprise for M365/Installation and Base Configuration Guide/ Refer to the below section or links for the steps relevant to SAP Security team:  1. Create SAP system account – Gimmal Link Enterprise ECM Only 2. Grant Necessary SAP Gimmal Link Enterprise authorizations – Gimmal Link Enterprise ECM Only 3. Grant Necessary SAP ArchiveLink authorizations – Gimmal Link Enterprise ECM or Content Server 4. Follow up Security Tasks [title] ECM [path] Repository Specific Guides/Link Enterprise for S3/Installation and Base Configuration Guide/Milestone: Establish SAP <-> Enterprise Connector Connectivity/ At this point no additional configuration is required to establish connectivity and ECM connectivity testing can be done so via:  1. The test connection button at the Enterprise Connector level for the SAP endpoint (refer to Base Enterprise Connector Configuration – ECM Only) 2. Using transaction SM59 within SAP to ensure the RFC connection configured in Configure SAP RFC destinations – Enterprise ECM Only can now communicate with the Enterprise Connector. \* Make sure the Enterprise Connector windows service is turned on prior to executing the SM59 test connection.  Select the Connection Test button. You should see a successful connection with timing. In addition, via the System Dashboard, you should now see a green light under the column “API” as shown below. This indicates that SAP has the RFC connection to the matching Enterprise Connector middleware and configuration.  Note that until the API destination(s) and CMS Use Tags are utilized in a processing rule such as DocManager or Migrator, etc., they will show as “unused”.  [title] SharePoint M365 Endpoint [path] Repository Specific Guides/Link Enterprise for M365/Installation and Base Configuration Guide/Base Enterprise Connector Configuration/ This is required for both ECM and Content Server. Using an M365 SharePoint repository you will need to ensure that the enterprise connector is configured and able to talk to Microsoft Graph API.  From the information gathered in the step Configure App within M365 Account, update the configuration file through middleware GUI [https://localhost:82/ ](#) To Configure, Select SharePoint Online under Connections and click on"add row" to establish a new SharePoint connection. | SharePoint Details | Description | Sample Values | | --------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | | System name | Unique name for the Content Management System to be configured
in middleware. | M365\_1 | | User Name Property | Property defined in SharePoint for User Name | LinkEnterpriseUserName | | Time Property | Property defined in SharePoint for Time Stamp | LinkEnterpriseTimeStamp | | Tenant Id | find Tenant id in azure active directory registered application. | 4dexxxx-xxxx-xxxxx | | Application Id | find Application id in azure active directory registered application. | fbxxxxxx-xxxxxx | | Graph Url | find graph url in azure active directory registered application. | [https://graph.windows.net/tenantId](https://graph.windows.net/tenantId) | | Token Url | find token url in azure active directory registered application | [https://login.microsoftonline.com/](#)
[{tenantId}/oauth2/token](#) | | Enable Application based Authentication | Set the value to true to enable app based authentication. | Set to true to enable app based Authentication. | | Client Secret | For App Based Authentication, find client secret in azure active directory registered application | Combination of characters and integers. | | Scope | For App Based Authentication, find scope in azure active directory registered application | [https://graph.microsoft.com/XXXX](https://graph.microsoft.com/XXXX) | | UserName | For User Based Authentication, provide your username for sharepoint. | \@xxx.com | | Password | For User Based Authentication, Provide your password for sharepoint | Password to login into SharePoint | | Anonymous url expiry time | Provide the url expiry time | | | API Headers | Provide the API Headers included | Mozilla/5.0 (Windows NT 10.0; Win64; x64) | | Retry Count | When A call fails, provide number of retry attempts | 5 | | Default retry Time | Provide the time until the request attempts retrying | 1000 | | Throttle Filter Size | For a Large query, Provide the the filter size(recommended less than 1000) | 500 | | Enable REST API | Enable sharepoint rest api | true/false | | REST API scope | Find scope in azure active directory registered application(when rest api is enabled) | For App Based Authentication, find scope in azure active directory registered application
https\://\/.default | | certBasedAuthentication | Enable if sharepoint certificate based authentication is required.(Only enable if authenticate | true/false | | Grant Type | Type of grant - when certBasedAuth is enabled / when rest api is enabled | eg\:client\_credentials | | Client assertion type | client assertion type - when certBasedAuth is enabled / when rest api is enabled | eg: urn\:ietf\:params\:oauth\:client-assertion-type\:jwt-bearer | | certificate private key path | path to the certificate file- when certBasedAuth is enabled / when rest api is enabled | C:\Users\\...\tp\_135b7b49\_a876\_492d\_9716\_64d272f5a425.pem | | private key encrypted | enable if the private key provided certificate private key path is encrypted- when certBasedAuth is enabled / when rest api is enabled | YES/NO | | private key password | password for certificate file provided above- when certBasedAuth is enabled / when rest api is enabled | dgf\*\*\*\* | | public key path | Path to public certificate- when certBasedAuth is enabled / when rest api is enabled | eg\:C:\Users\\..\publiccert.cer | | JWT type | Type of assertion- when certBasedAuth is enabled / when rest api is enabled | JWT | | JWT Algorithm | Algorithm used for assertion- when certBasedAuth is enabled / when rest api is enabled | RS256 | | JWT Expiration | exipration of assertion token- when certBasedAuth is enabled / when rest api is enabled | 3600000 | Hit save button and re-run the service to apply all the changes. To verify is the connection is established, click on modify and hit test connection. If established successfully, A dialog box with connection success message is displayed. \*the Windows service must be restarted for changed to take effect [title] Purpose of Guide [path] Repository Specific Guides/Link Enterprise for S3/Installation and Base Configuration Guide/ The goal of this guide is to establish base installation, minimal configuration, and connectivity testing to a point that SAP and Link Enterprise can communicate with S3 and vice-versa.  For details on architecture, supported environments, and system requirements please refer to the docuflow [Technical Overview](https://linkenterprise.docs.gimmal.com/technical-overview). For detailed configuration of specific integration patterns and docuflow add-ons please refer to the docuflow [Solution Guide](https://linkenterprise.docs.gimmal.com/solution-guide).  For custom development, please refer to the [Developers Guide](https://linkenterprise.docs.gimmal.com/developers-guide). [title] Configure app within M365 Account – Legacy Registration [path] Repository Specific Guides/Link Enterprise for M365/Installation and Base Configuration Guide/ Note: The app registration has recently changed for some accounts – please refer to this section only if the above description does not match your M365 account.  Using M365 SharePoint as a Gimmal Link Enterprise repository you will need to ensure that the Enterprise Connector is configured and able to connect to the Microsoft graph API. You must create an enterprise application via the Microsoft Azure portal to complete this procedure. This will require an account with appropriate level of permissions to grant correct access rights to a user (connector user) using the graph API when inside the azure portal.  You can either self-grant access or have an admin grant access to the graph API and its corresponding access rules inside the azure portal if and only if that user has authority to grant access to those rules.  The following steps below outline this process:  i. Visit https\://portal.azure.com/ then login using an appropriate account. ii. Click on **Azure active directory**, then click on **app registrations** and select **new application registration**. ::Image[]{src="https://archbee-doc-uploads.s3.amazonaws.com/image_072e388f-c8ca-4d3c-af7b-f88faf0e544c.png" size="58" position="center" width="1374" height="172" darkWidth="1374" darkHeight="172" showCaption="false"} iii. Fill in the follow details and then click **create.** ::Image[]{src="https://archbee-doc-uploads.s3.amazonaws.com/image_e026d394-7114-41b2-a341-def763a630ca.png" size="28" position="center" width="480" height="372" darkWidth="480" darkHeight="372" showCaption="false"} iv. Click **Settings.** v. Click **required permissions** \[Symbol] click **add** \[Symbol] click **select an api** \[Symbol] click **"Microsoft graph"**. ::Image[]{src="https://archbee-doc-uploads.s3.amazonaws.com/image_0bd3ff77-2717-4087-81e1-3839abf459e7.png" size="42" position="center" width="832" height="458" darkWidth="832" darkHeight="458" showCaption="false"} vi. Set appropriate permissions for SharePoint online. But ensure “Create, edit, and delete items and lists in all site collections” is checked. ::Image[]{src="https://archbee-doc-uploads.s3.amazonaws.com/image_6d713ee9-c3ab-4bdf-b784-8b43d7288862.png" size="62" position="center" width="976" height="72" darkWidth="976" darkHeight="72" showCaption="false"} vii. Click done viii. Click grant permissions (may have to do this on an admin account if account used does not have appropriate permissions) ::Image[]{src="https://archbee-doc-uploads.s3.amazonaws.com/image_b484c272-305e-45e5-a043-ec3b689a8cf9.png" size="58" position="center" showCaption="false"} ix. Make sure owner is set to the account being used for the connector. Example: demouser\@company.com. ::Image[]{src="https://archbee-doc-uploads.s3.amazonaws.com/image_d8846dd0-70d3-40d0-807f-76721c43e3a5.png" size="40" position="center" showCaption="false"} x. Click on properties and note down the **application id**, along with the **username**, **email** and **password **for base configuration of the connector detailed in the step Base Gimmal Link Enterprise Connector Configuration - Gimmal Link ECM only. xi. Go back to app registrations, then click on endpoints and note down the graph endpoint API url and token url for base configuration of the connector detailed in the step Base Gimmal Link Enterprise Connector Configuration - Gimmal Link ECM only. [title] Installing the Enterprise Connector [path] Repository Specific Guides/Link Enterprise for M365/Installation and Base Configuration Guide/ # Link Enterprise 6.x.x Installation Instructions ## Obtain the Latest Installer Download the latest Link-Enterprise-6.x.x-release.zip from a Gimmal representative. ## Extract the Installation Files Extract the contents of Link-Enterprise-6.x.x-release.zip into your desired installation folder (e.g., C:\LinkEnterprise). ## Run the Installation Script 1. Navigate to the service folder inside the extracted directory and execute the installation script with administrative privileges: - **Open a Command Prompt** with administrative permissions. - Navigate to the service folder. For example: - Run the installation script: installservice.bat 2. This will configure and install Link Enterprise 6.x.x on your system. ## Adjust Windows Service Log On Properties If folder permissions on the server restrict processing: - Adjust the **Log On** properties of the Gimmal Link Enterprise Windows services. - Use the **service account** mentioned in the installation requirements. ## Extract SAP JCO 1. **Download SAP JCO:** - Obtain the appropriate SAP JCO 64-bit version from SAP’s marketplace (provided by your SAP Basis team). [https://support.sap.com/en/product/connectors/jco.html?anchorId=section#section\_2129803369](https://support.sap.com/en/product/connectors/jco.html?anchorId=section#section_2129803369) 2. **Place the Extracted Files:** - Extract the contents into the jco folder under lib. - For Windows installations, ensure sapjco3.dll is also placed in the jco folder. - **Note:** If SAP JCO comes as two compressed files, ensure all levels are extracted. The correct files should include sapjco3.jar in the top-level jco folder under lib. ## Obtain Authorization Token 1. Request a **Gimmal Link Enterprise authorization token** from a Gimmal representative. 2. Use this token during the Gimmal Link Enterprise Connector configuration: - Enter the token in the **active configuration .ini file** under the field authentication.token. - Alternatively, use the GUI navigating to Settings at [https://localhost:82](https://localhost:82). ⚠️ The service will shut down within 30 seconds if no active token is present, so using the .ini file method is recommended for reliability. For further details, refer to **Base Gimmal Link Enterprise Connector Configuration – Gimmal Link Enterprise ECM Only**. Let me know if you need further adjustments or additional formatting! \*\*\*JCO Requires Visual C++ [title] Supported Environments [path] Repository Specific Guides/Link Enterprise for S3/Technical Overview/ The following environments are supported with Gimmal Link Enterprise: | **SAP** | | | | | | -------------------------------------- | ------------------- | ----------------------------------- | - | - | | ECC 6.0
Basis 7.40 SP4 and higher | S/4 1809 and higher | CRM
Basis 7.40 SP4 and higher | | | | **Amazon** | | | | | ---------- | - | - | - | | S3 | | | | | | | | | ------ | - | - | | | | | :::BlockQuote Note: Gimmal Link Enterprise passes all P1/P2/P3 SAP CVA SLIN\_SEC checks. ::: [title] Configure app within M365 Account [path] Repository Specific Guides/Link Enterprise for M365/Installation and Base Configuration Guide/ Using M365 SharePoint as a Gimmal Link Enterprise repository you will need to ensure that the Enterprise Connector is configured and able to connect to the Microsoft graph API. You must create an enterprise application via the Microsoft Azure portal to complete this procedure. This will require an account with appropriate level of permissions to grant correct access rights to a user (connector user) using the graph API when inside the azure portal.  You can either self-grant access or have an admin grant access to the graph API and its corresponding access rules inside the azure portal if and only if that user has authority to grant access to those rules.  The following steps below outline this process:  I. Visit [https://portal.azure.com](https://portal.azure.com) and login with appropriate credentials. II. Click on Azure Active Directory ::Image[]{src="https://archbee-doc-uploads.s3.amazonaws.com/image_45f4a4b8-85e5-44fa-a72f-0c177b7f7e4c.png" size="30" position="center" width="600" height="116" darkWidth="600" darkHeight="116" showCaption="false"} III. Under Manage select ::Image[]{src="https://archbee-doc-uploads.s3.amazonaws.com/image_59bb60fd-a2c0-4346-b026-44cce6d4cafe.png" size="42" position="center" width="668" height="90" darkWidth="668" darkHeight="90" showCaption="false"} IV. Click on ::Image[]{src="https://archbee-doc-uploads.s3.amazonaws.com/image_0fddd8a3-3e35-4e1f-aaa5-a48eb2922eb4.png" size="26" position="center" width="402" height="120" darkWidth="402" darkHeight="120" showCaption="false"} V. Type in an appropriate name for application. ![](https://archbee-doc-uploads.s3.amazonaws.com/image_6dc1bdc0-eb2a-4565-a7de-3cb921391736.png) VI. Click Register ::Image[]{src="https://archbee-doc-uploads.s3.amazonaws.com/image_95200717-9fcf-429d-869e-4bb37c1a557c.png" size="16" position="center" width="238" height="68" darkWidth="238" darkHeight="68" showCaption="false"} VII. Under manage click on manifest, and look for "allowPublicClient", ensure this is set to True, for example '"allowPublicClient"\:true,' and then click save. ::Image[]{src="https://archbee-doc-uploads.s3.amazonaws.com/image_ea4cee10-9479-40f4-a4f5-91e23f8f6082.png" size="20" position="center" width="450" height="96" darkWidth="450" darkHeight="96" showCaption="false"} VIII. Click on API permissions under manage, and click on add a permission. Click on Microsoft graph, then click on application permissions. Select all options as per your organizations security policies, but allow Sites.ReadWrite.All at a minimum. ![](https://archbee-doc-uploads.s3.amazonaws.com/image_cf00e67a-61bc-4b53-92bb-087c73c87550.png) IX. Click on owners, and add owners for all accounts that will use the connector. (optional) X. Log in under an account with admin permissions and grant consent to the previous API rules, the button is located in the screenshot below. ![](https://archbee-doc-uploads.s3.amazonaws.com/image_03202244-7c14-4b20-aa5c-36dde56aec3d.png) XI. Under app registrations click on endpoints and note down your oauth 2.0 token endpoint url. You will need this url later for base configuration of the connector detailed in the step Base Gimmal Link Enterprise Connector Configuration - Gimmal Link ECM only. ![](https://archbee-doc-uploads.s3.amazonaws.com/image_e341dd1e-15c6-41d0-86fb-eb73f8280a10.png) XII. Click on overview, and note down the **application id**, located in the below screenshot. Note down the application id, along with the **username**, **email** and **password** and **OAuth 2.0** **Token Endpoint URL** for base configuration of the connector detailed in the step Base Gimmal Link Enterprise Connector Configuration - Gimmal Link ECM only. ![](https://archbee-doc-uploads.s3.amazonaws.com/image_a85914e1-2158-40a2-9e8f-039e7604f1b1.png) [title] Technical Overview [path] Repository Specific Guides/Link Enterprise for M365/ ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/Zwi2e5KAZlmZijYlXixhn_image.png" size="54" width="1210" height="462" position="center" darkWidth="1210" darkHeight="462" showCaption="false"} ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/a9EXFAnHd3Drulu3gfKnI_image.png" size="54" width="1227" height="243" position="center" darkWidth="1227" darkHeight="243" showCaption="false"} [title] System Requirements [path] Repository Specific Guides/Link Enterprise for M365/Technical Overview/ The middleware component (Enterprise Connector) can be deployed on-premise, in a private cloud or as a fully managed service from Gimmal. When deploying on premise or in a private cloud environment, physical or virtual hardware is supported. The following server resources are the **minimum** requirements: | **Operating Systems** | **CPU** | **Disk Space** | **RAM** | **SAPJco** | | ------------------------------------- | ------------------------------------------------------- | -------------- | ------- | ---------------------------------------------------------------------------------------------------- | | Windows Server 2016, 2019, 2022, 2025 | Minimum 2 cores or 2 physical CPUs with at least 2.0Ghz | 40 GB | 8 GB | 3.1 and above
(JCo 3.1 requires the Microsoft Visual Studio 2015-2022 C/C++ runtime libraries ) | When deploying on premise or in a private cloud environment, physical or virtual hardware is supported. The following server resources are the **recommended** requirements: | **Operating Systems** | **CPU** | **Disk Space** | **RAM** | **SAPJco** | | -------------------------------------- | ------------------------------------------------------- | -------------- | ------- | ---------------------------------------------------------------------------------------------------- | | Windows Server 2019, 2022, 2025
| Minimum 4 cores or 2 physical CPUs with at least 2.0Ghz | 128 GB | 64 GB | 3.1 and above
(JCo 3.1 requires the Microsoft Visual Studio 2015-2022 C/C++ runtime libraries ) | ## Production/Non Production Environments SAP typically follows a 3-system landscape: 1. Development (DEV) 2. Quality Assurance (QUAL) 3. Production (PROD) Albeit Link Enterprise supports a 1 middleware to \ SAP connection, it is recommended to have 1 middleware environment (separate windows machine/VM) for each SAP system ie: most common is 3 separate windows machines/VM's. a. Development - can be minimum server requirement specs if desired b. We recomend QUAL be identical to production (recomended requirement specs). Reasons why you may choose to share the DEV and QUAL SAP connections to a single non-production midldeware server instance: 1. low volume and load 2. no migration testing 3. little or no concurrent "inbound to SAP" processing where you might want some event to go up to both DEV and QUAL SAP at the same time ## Enterprise Connector Middleware Service The Gimmal Link Enterprise middleware service requires Read/Write permission to the Gimmal Link Enterprise installation root directory and sub-directories. This can be accomplished via two methods based on your server configuration: 1. Running as local host 2. A specified service account where local host does not have Read/Write permissions. ## SAP Firewall Access The Gimmal Link Enterprise Content server application communicates via HTTP/HTTPS and can be configured to use any port number. 1. The Gimmal Link Enterprise Content Server application communicates via HTTP/HTTPS and can be configured to use any port number (ex: 8085) (Inbound to middleware and Outbound from SAP. Refer to organizations internal IT security and project team on which IP address to allow). 2. Note that each SAP repository (Z1, Z2, etc) requires its own set of ports, for example: 1. Z1 1. 1 unique port for HTTP eg: 8085 2. 1 unique port for HTTPS eg: 8086 2. Z2 1. 1 unique port for HTTP eg: 8087 2. 1 unique prt for HTTPS eg: 8088 The Gimmal Link Enterprise ECM application communicates via SAP JCo over the following ports: 1. Gateway Port: The port number used to communicate with the gateway. Typically 33## with the ##’s being the system number (ex: 3300) (Inbound to sap) 2. Message Server Host (if applicable): The port number used to communicate with the gateway. Typically 36## with the ##’s being the system number (ex: 3600) (Inbound to sap. Refer to organizations internal IT security and project team on which IP address to allow) `Confirm with your SAP Basis team for the values specific to your SAP installation.` ## URL and Firewall Configuration for M365 API Access Access to the following URLs is required from the server: - Base url: \ - Source: the IP of the Gimmal Link Enterprise server - Port: https is 443 - Protocol: https - This provides the basic functionality that Link Enterprise requires for its processing. [title] Supported Environments [path] Repository Specific Guides/Link Enterprise for M365/Technical Overview/ The following environments are supported with Gimmal Link Enterprise: | **SAP** | | | | | | -------------------------------------- | ------------------- | ----------------------------------- | - | - | | ECC 6.0
Basis 7.40 SP4 and higher | S/4 1809 and higher | CRM
Basis 7.40 SP4 and higher | | | | **Microsoft 365** | | | | | ----------------- | - | - | - | | SharePoint Online | | | | | **Microsoft On-Prem or Azure Private Cloud** | | | | -------------------------------------------- | --------------- | --------------- | | SharePoint 2013 | SharePoint 2016 | SharePoint 2019 | :::BlockQuote Note: Gimmal Link Enterprise passes all P1/P2/P3 SAP CVA SLIN\_SEC checks. ::: [title] Link Enterprise for S3 [path] Repository Specific Guides/ [title] Link Enterprise for M365 [path] Repository Specific Guides/ [title] Graph API: Sites Selected [path] Repository Specific Guides/Link Enterprise for M365/Installation and Base Configuration Guide/Configure app within M365 - Application based permissions - Client Secret (Not Recommended)/ [title] Public Certificate Creation using win-acme (Optional) [path] Repository Specific Guides/Link Enterprise for M365/Installation and Base Configuration Guide/Configure app within M365 - Application based permissions - Certificate Based (recommended)/ In order to authenticate using a certificate, both a public and a private key are required. The following steps outline how to generate a keystore on the server using Win-ACME and later use KeyStore Explorer to manage the public and private keys. **This step is optional if the client already has a trusted certificate issued by a recognized Certificate Authority (CA). ** Download win-acme from official website ([https://www.win-acme.com/](https://www.win-acme.com/)) The downloaded file should be in ZIP format. Hence, extract the contents of the file and place them in the middleware server, e.g., c:/wacs now open command prompt as administrator and navigate to folder location c:\wacs execute wacs.exe choose "M" from menu. ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/7-YOVbXMg-f1Zi_UP-Wci_image.png) type 2 to manually entered all the domain. ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/hoE9MVarwJSEER6QbdUW9_image.png) Now provide DSN name. you can enter multiple seprated by ,. ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/2L-1L7nh4KqZSMdXpLx8__image.png) The next prompt will ask for the friendly name of the generated certificate. Enter suitable name ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/LtHhmCoVDuYavNlyfBzPE_image.png) Type 4 to generate a single certificate. ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/WCsM8k9aLX0nNK8800SPq_image.png) Type 2 for "Serve verification files from memory" ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/m4f0wKlbv9i_LE-6LSXHK_image.png) Type 2 for RSA Key. ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/EoWr3Th10l-rTolELPY9l_image.png) Type 3 to generate PFX archive ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/Zy4wKqon4aJvZdB75Js1Q_image.png) Next provide desired folder path where pfx file will be saved. ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/ydWW0VGauJSixzIKYh0ln_image.png) Next 1 to not associate a password or 2 to protect pfx with password. Here I will choose 1. ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/y4FOPE7PwAJdrfszEiENf_image.png) Now select 5 for No additional store steps. ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/VMS9EK9KD_WL_vuSpwO3K_image.png) Type 3 for No Addtional installation steps. ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/TAT358dF56UsvVCwHfyfJ_image.png) Now it will run generate pfx file in desired location. ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/-x4u0QXEx9qWJqQrlnH9D_image.png) Press Q to Quit. Now, the PFX file has been generated. It is time to extract the public and private keys from it. To achieve this, we will use a tool called 'KeyStore Explorer'. It can be downloaded from this link : ([https://keystore-explorer.org/downloads.html](https://keystore-explorer.org/downloads.html)) Once downloaded, install it with the default settings open KeyStore Explorer. Drag and drop the newly generated PFX file onto the KeyStore Explorer window, or choose to open an existing keystore. ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/8lMT6H4FIhbmdHIi-9oSt_image.png) Enter the password if provided at the time of PFX creation; otherwise, press Enter or click OK. You should be able to see the certificate chain details with the DNS name. ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/bH97IWlsIea78duyX-l_6_image.png) Right-click on the certificate chain, select 'Export' → 'Export Private Key' to export the private key. ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/7DEPo_vBPmo8VwC4prOBf_image.png) For the password, enter the password you provided earlier, or press Enter or click OK. Select 'PCS#8' for the private key export type and click OK. ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/HxrHvfCJZhOpjpFDx_Mnf_image.png) Next, it will provide an option to encrypt and specify the export file location. For this, we will use an unencrypted private key. Uncheck 'Encrypt.' In the 'Export File' field, change the folder location and file name. ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/9KS6sHUCYfK6zbiczV1Oh_image.png) Click 'Export,' and a success message should appear. ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/ZxctDhwrvWwGf1YIQY1Ar_image.png) Now, generate the public certificate by right-clicking, selecting 'Export' → 'Export Certificate Chain.' ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/9r_RTwADwhNLFLRQiwYv0_image.png) Next, select 'Entire Chain' in the Export Length, 'X.509' in the Export Format, and change the folder location and file name in the 'Export File' field. ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/NRq6yv0Sf5jOx9m4SoASq_image.png) Click on 'Export,' and a success message should appear. ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/x4HYOr0ZRTI0jlk6EcZ8e_image.png) Now, go to the folder location, and there should be two files exported. ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/hkNb0nekNbzLu4ij1iwpw_image.png) The PEM file represents the private key, and the CER file is the public certificate. The next step is to place those files under the config folder of the Middleware installation and modify the init file: - 'sharepoint.cert.privatekey.path' to the private key path - 'sharepoint.cert.publickey.path' to the public certificate path - 'sharepoint.cert.privatekey.encrypted' to 'Yes' or 'No' if the private key is encrypted - 'sharepoint.cert.privatekey.password' to the decrypted private key password via the Encryption utility For more details, please refer to the 'SharePoint M365 Endpoint' section." # SharePoint (SP365) Cert Authentication Configuration Example Authentication Modes App-Based Authentication Enables service-to-service communication without user interaction. sp365.sharepoint.appBasedAuthentication = true Certificate-Based Authentication Uses certificates for enhanced security. sp365.sharepoint.certBasedAuthentication = true ## OAuth 2.0 Parameters Grant Type sp365.sharepoint.granttype = client\_credentials Client Assertion Type sp365.sharepoint.client.assertion.type = urn\:ietf\:params\:oauth\:client-assertion-type\:jwt-bearer Resource URL sp365.sharepoint.resource.url = https\://graph.microsoft.com ## Certificate Configuration Private Key Path Path to the private key file used to sign JWTs. sp365.sharepoint.cert.privatekey.path = \ Private Key Encryption Indicates whether the private key file is encrypted. sp365.sharepoint.cert.privatekey.encrypted = YES Private Key Password (use encryption utility) Provide only if encryption is enabled. sp365.sharepoint.cert.privatekey.password = \ Public Key Path Path to the public certificate used to validate signatures. sp365.sharepoint.cert.publickey.path = \ ## JWT Settings Type sp365.sharepoint.jwt.type = JWT Algorithm sp365.sharepoint.jwt.algorithm = RS256 Expiration Example: 1 hour = 3600000 ms sp365.sharepoint.jwt.expiration.millisec = 3600000 [title] Repository Specific Guides [path] / [title] Introduction and Overview - Microsoft 365 [path] Repository Specific Guides/Link Enterprise for M365/Technical Overview/ Gimmal Link Enterprise is an SAP certified suite of functionality that provides integration between SAP and content service repositories. ![](https://archbee-doc-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/Ydxeysrxy2Qy5MQXNtiji_image.png) This integration includes document storage, linking, bi-directional metadata transfer, process and workflow automation, as well as ArchiveLink processing. Line of business solutions (such as Accounts Payable) and additional add-ons (such as SAP DMS integration and AuditLink bundle creation) can be leveraged in addition to the baseline functionality. In addition, Gimmal Link Enterprise provides a robust SAP based migration tool that handles migration of content from any ArchiveLink, File, or SAP database (both attachments and notes) source to Sharepoint. The Gimmal Link Enterprise offering consists of two separate integration options or approaches that can be used independently or in combination to provide the best value for your implementation: 1\. Link Enterprise ECM Leveraging components both inside (SAP transport component) and outside the SAP boundary (middleware component), Gimmal Link Enterprise ECM provides the most powerful and flexible SAP to content services integration options. Enhanced user-based storage and linking, no-code bi-directional metadata transfer and workflow triggering, all supported by comprehensive SAP based administrator workbench monitoring, utilities, user delete link request management, Audit and Compliance bundle creation, and reporting functions are just some of the highlights. In addition, Gimmal Link Enterprise provides a robust SAP based migration tool that will handles migration of content from any ArchiveLink, File, or SAP database (both attachments and notes) source to SharePoint. Gimmal Link Enterprise ECM also provides a powerful Content API set of SAP BAPI’s to allow the customer perform full SCRUD (Search, Create, Read, Update, and Delete) functionality to fulfill any custom requirements within the SAP boundary. 2\. Link Enterprise Content Server Based on the SAP ArchiveLink framework, the Gimmal Link Enterprise Content Server (middleware component only), provides SAP message output, document storage, print list support, data archiving, and other standard ArchiveLink functionality from SAP to your content services platform. Which Gimmal Link Enterprise approach and tool is utilized depends on the integration pattern/add-on required: `*put your mouse over the below table to scroll left/right` | | Web Services Integration | Business Document
Storage | Enhanced SFO / GOS Attachment List | Enhanced Business
Document Storage | Outbound from SAP
Metadata Transfer | Inbound to SAP
Metadata Transfer | Migration Utilities | Federated Services | Administrator
Workbench | Message Output
Storage | Print List Storage | Data Archiving (ADK) | Enhanced Inbound
Processing | Inbound SAP DMS
Integration | Outbound SAP DMS
Support | Bi-Directional
Workflow
Integration\Process | Dynamic Folder Creation | Delete Link Management | Automation AuditLink | TrackLink Workflow | SharePoint List Creation (SAP reference data) | Accounts Payable | Microsoft 365 SAP
Content API | | ------------------- | ------------------------ | ------------------------------ | ---------------------------------- | --------------------------------------- | ---------------------------------------- | ------------------------------------- | ------------------- | ------------------ | ---------------------------- | --------------------------- | ------------------ | -------------------- | -------------------------------- | -------------------------------- | ----------------------------- | ----------------------------------------------------- | ----------------------- | ---------------------- | -------------------- | ------------------ | --------------------------------------------- | ---------------- | ---------------------------------- | | ECM | x | x | x | x | x | x | x | x | x | x | | | x | x | x | x | x | x | x | x | x | x | x | | Content
Server | | x | x | | x | | | | | x | x | x | | | x | | | | | | | | | Figure 1: Toolset vs. Integration Pattern Reasons you may need to use content server: 1. SAP message output without ECM plug in 2. ADK data archiving 3. Fiori apps using document service (ie: without SFO/GOS functionality) 4. Outbound DMS 5. Any other application or 3rd party that relies on ArchiveLink directly [title] Create SAP system account – ECM Only [path] Repository Specific Guides/Link Enterprise for M365/Installation and Base Configuration Guide/ *`relevant to Gimmal Link `*`Enterprise `*`ECM only`* In order for the Link Enterprise Connector to log in via SAP Jco to register on the SAP Gateway to receive outbound processing requests, as well as execute inbound processing (if configured), an SAP system (non-dialogue) account is required. This user ID requires the below privileges: ### Authorization Object: S\_RFC ACTVT: 16 ### RFC\_TYPE values: 1. FUGR 2. FUNC ### RFC\_NAME values:  1. /DFLOW/ZDOCMANAGER\_SAPLINK\_V2 2. DDIF\_FIELDINFO\_GET 3. RFC1 4. RFCPING 5. RFC\_GET\_FUNCTION\_INTERFACE 6. SDIFRUNTIME 7. RFC\_METADATA 8. RFC\_METADATA\_GET ### Transactions 1. /DFLOW/GTW This authorization covers most standard Gimmal Link Enterprise processing. For custom requirements, please either use a copy of WF-BATCH with SAP\_ALL / SAP\_NEW or add the relevant authorizations via trace evaluation. Please note the user ID create and password and work with your Gimmal Link Enterprise implementor – this will be need to be configured in Gimmal Link Enterprise Connector in step Base Gimmal Link Enterprise Connector Configuration – Gimmal Link Enterprise ECM Only.  [title] Installing the SAP Transports – ECM Only [path] Repository Specific Guides/Link Enterprise for S3/Installation and Base Configuration Guide/ The following steps outline how to install Link Enterprise ECM Flow within SAP. Installing the Enterprise Connector (Link Enterprise middleware component) and configuring the Link Enterprise base connectivity is covered in other sections.  1\. Obtain the latest Link Enterprise transports from a Gimmal representative. The transports provided will be determined by the Link Enterprise Content API base plus add-ones licensed.  2\. Import the Link Enterprise transports into the target SAP system.  - The Gimmal Link Enterprise product resides entirely in its own namespace (/DFLOW) - These transports should be imported with all import options enabled: ::Image[]{src="https://archbee-doc-uploads.s3.amazonaws.com/image_1217ed1f-6f97-4f4c-8239-d0ecd2438f60.png" size="54" position="center" showCaption="false"} 3\. This is a good time to enjoy a hot beverage of your choice while the import is running.  4\. Confirm that the transports were imported into the SAP system without any issues  - Note: Warnings will occur, for example regarding domains over 255 characters among others. Errors (return code 8) should not occur. If they do, stop further import of additional transports and contact your Gimmal Link implementer. [title] SAP Connection - ECM Only [path] Repository Specific Guides/Link Enterprise for S3/Installation and Base Configuration Guide/Base Enterprise Connector Configuration/ This is required for ECM only. Ensure the Enterprise Connector windows service is turned on. 1. Visit the Enterprise Connector configuration ui via https\://localhost:82 (enter user name: link, password: link) 2. Under the "Connections" category in the left navigation panel click "SAP". 3. Click "Add Row". (SAP connection config dialog box will appear) 4. Complete the rest of the SAP configuration information by filling in the relevant details in the input box's. (For help setting some of these values work with SAP Basis team members.) 5. Click "Test Connection" if a text displays "Success" then proceed to save the connection. 6. If "Success" does not appear, you may need to check if the connection details are correct. (Check with basis team) | **Setting** | **Description** | **Sample Value ** | | ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- | | Client  | Client number to connect to  | 800  | | Language  | Language can only be EN for English currently but the setting is available for future international use  | EN  | | System  | The system number  | 00 | | Unicode  | True if the system is a Unicode system and communication will be in Unicode. This is recommended to be enabled.  | | | User ID | The SAP non dialogue system account with elevated permissions to allow the middleware to communicate with SAP.  | GIMMAL  | | Password  | The non expiring password for the SAP system account  | \*\*\*\*\*\*\*\*\*\*\*  | | App. Server Host  | The application server host name or ip address(disabled if using load balancing)  | | | Gateway Host  | The gateway host name or ip address that the RFC destinations are configured to.  | 127.0.0.1 
| | Gateway Port  | The port number used to communicate with the gateway. Typically 33## with the ##’s being the system number  | 3300 | | Use Load Balanced Server  | When enabled a message server can be configured to handle incoming Enterprise Connector calls. If available it is recommended that this be utilized  | | | Msg. Server Host | The message server host name or ip address.  | 127.0.0.1 
| | Msg. Server Port  | The port number to use to communicate with the message server. Typically 36## with the ##’s being the system number.  | 3600 | | R3 System Name  | The system name  | ED1  | | Group Name  | The group name used with the message server  | Production  | | Use Secure Network Connection (SNC)  | If enabled secure communication will be used between the Enterprise Connector and SAP. Generally this is not needed since all communication is from servers behind a firewall.  | | | SNC Name  | The SNC Name to use  | | | SNC Partner  | The SNC Partner name  | | | QOS  | The SNC quality of service  | | | SNC Library  | The SNC library location  | | | Use SAP Router  | If enabled SAP router technology is used for communication. 
| | | SAP Router  | The SAP router configuration  | | If an error message occurs, or if there is no response at all, please refer to the Enterprise Connector log file.  Note: A typical reason for no response is either the SAP Gateway has security enabled and Basis must allow access (refer to above section Configure SAP Gateway – Enterprise ECM Only) or the SAP Jco library does not exist in the Jco folder.  \*the Windows service must be restarted for changed to take effect [title] Follow up Basis Tasks [path] Repository Specific Guides/Link Enterprise for S3/Installation and Base Configuration Guide/ [title] Grant Necessary SAP ArchiveLink authorizations – ECM or Content Server [path] Repository Specific Guides/Link Enterprise for S3/Installation and Base Configuration Guide/ Base configuration for both Gimmal Link Enterprise components requires (at least one) SAP ArchiveLink repository to be created. Thus, access to the below transactions should be granted to the configurator and administrator of Gimmal Link Enterprise:  - OAC0 - Content Repositories - OAA3 - Protocols In some instances, the SAP Basis team will already have access and may prefer to control this configuration. This configuration is outlined below sections.  Business process configuration requires access to additional ArchiveLink transactions. Albeit not covered in this guide, these transactions should also be granted to the Gimmal Link Enterprise configurator:  - OAC2 - document types - OAC3 – business object /document type / link table assignment [title] SharePoint - Message Output [path] Repository Specific Guides/Link Enterprise for M365/SharePoint Implementation Guide/ ## 1. Message Output Description  Message Output in SAP allows users to generate and distribute documents from SAP to various output channels. With Link Enterprise, these generated documents can be routed to your Sharepoint environment for storage and distribution. Key benefits include: 1. Centralized document storage in Sharepoint 2. Secure distribution with SharePoint's permission settings 3. Seamless integration with SAP processes 4. Support for multiple output formats 5. Audit trail and compliance features 6. Reduced manual effort through automation Example use cases: - Distributing invoices, shipping notifications, and order confirmations to customers, partners, and suppliers via SharePoint ## 2. Content Server vs ECM  When storing Message Output documents, there are two options:  1. Content Server  2. ECM Server  ### Content Server  Content Server is a communication specification defined by SAP that uses HTTPS to communicate with the Link Enterprise middleware. Link Enterprise is an SAP Content Server certified application.  ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/6Dakw1eFc_MOdAZo6mLqi_image.png) ### ECM Server  ECM Server is a communication specification based on SAP’s RFC socket protocol called JCo (Java Connector). The ECM server unlocks remote function calls and Link Enterprise provides an API within SAP to leverage this technology, allowing enhanced functionality over standard Content Server.  While we are only discussing Outbound communications, ECM with JCo does allow for bi-directional communication between Link Enterprise and SAP, Inbound and Outbound.   \[Architecture Diagram]    ### Content Server Considerations:  Pros:   - HTTPS protocol – routes well over the public internet and can be used with stateful packet inspection firewalls  - Does not require Link Enterprise transports to be deployed in SAP  - There will be no modifications to print program required  Cons:  - Does not inherently allow for custom metadata to be sent during upload to SharePoint unless call back is used. See Call Back Guide below. - See the below section on custom metadata - Does not inherently get dynamic routing unless call back is used  - No Dynamic folder creation unless call back is used    ### ECM Considerations:   Pros:   - Custom metadata can be sent real-time  - Real-time dynamic routing  - Real-time dynamic folder creation  Cons:  - RFC protocol requires non-standard ports to be opened  - Modification to Z version of print program required  ## 3. Metadata  Custom metadata can be set in SharePoint as columns in content types. Custom metadata is any values from SAP beyond those required by Link Enterprise.  Custom metadata is most valuable when there is the desire to:   - Allow end-users to access SAP-linked documents directly in the SharePoint interface, especially through search.  - Enables Microsoft Search.   - Enables access to Search Refiners in SharePoint.   - Trigger a Power Automate workflow.   - Allow other Business Systems to access/link to documents stored by SAP (i.e. SalesForce).   Metadata enables inbound scenarios. For example, a document arriving in SharePoint can:   - Link to an existing SAP object.   - Trigger an SAP workflow with container values.   - Trigger custom ABAP code.   How custom metadata is applied to SharePoint varies based on the method of outbound storage, ECM or Content Server.  ECM has native support for selecting a SharePoint Content Type and its column values when creating the document in a document library. Content Server, based on the SAP specification, does not allow custom metadata to be set during the creation of the document in SharePoint. This must be done through a Link Enterprise technology called a ‘call back’.  Call backs utilize the ECM connectivity and update the document metadata/columns once the SAP Content Server store/create operation has been completed. This means there are additional API calls/time required to update the document with business metadata.  ### Callback:  Call backs utilize the ECM connectivity and update the document metadata once the SAP Content Server store/create operation has been completed. This means there are additional API calls/time required to update the document with business metadata.  \[Graphic Overview to be added at a future date] ### Custom Metadata Considerations:  Pros:   - Can enable metadata based searching and search result filtering for users accessing content within SharePoint  - Enables the ability to do inbound rules when using ECM connectivity  Cons:  - Content Server does not inherently allow for custom metadata to be sent during upload to SharePoint. This then requires an ECM call to back populate the custom metadata which adds additional transaction time and SharePoint Graph API calls.  - Please see the section ‘Application Throttling’ in the following Microsoft information page: [https://learn.microsoft.com/en-us/sharepoint/dev/general-development/how-to-avoid-getting-throttled-or-blocked-in-sharepoint-online](https://learn.microsoft.com/en-us/sharepoint/dev/general-development/how-to-avoid-getting-throttled-or-blocked-in-sharepoint-online)  ## 4. Dynamic Location Routing  Dynamic Location Routing Dynamic Location Routing is a feature that allows documents to be automatically stored in different SharePoint folders based on associated SAP data when the document is transferred from SAP to SharePoint. This capability enables organizations to create rules and logic that determine the storage location of documents based on specific SAP attributes or metadata. By leveraging Dynamic Location Routing, companies can: - Automatically categorize and file documents according to business-specific criteria - Ensure consistent and organized storage of documents across various departments or processes - Simplify document management and improve information accessibility Here are a couple of examples to illustrate how Dynamic Location Routing can be used: **Example1: Routing based on code:** Documents attached to Sales Orders within a Sales Organzization with code 1000, go to SharePoint location 1000: SAPDocs->Sales Orders->1000 Documents attached to Sales Orders within a Sales Organzization with code 2000, go to SharePoint folder 2000 : SAPDocs->Sales Orders->2000 **Example2: Internal vs. External documents:** SAP information, such as ArchiveLink document type, classification, or vendor number, can be used to automatically classify documents as either internal or external and route them to the appropriate SharePoint folders. External documents, intended for vendor access, are stored in a SharePoint folder that the specific vendor can view. Internal documents, meant for internal use only, are stored in a separate SharePoint folder inaccessible to vendors, even if the document is related to a specific vendor. This automated categorization and routing process, based on SAP metadata, helps organizations maintain better control over document access and ensures that information is shared appropriately. 5\. Document Libraries and Folders  ----------------------------------- Document Libraries and/or Folders are sometimes leveraged to logically bundle a series of documents together.   SharePoint implements Permission inheritance from Site Collection->Site/Subsite->Document Library->Folder. Permission inheritance can be broken at any of these levels up until 100,000 items exist, at which point it is no longer possible. As a general best practice, it is best to break inheritance at the highest possible level in the hierarchy.   ECM will allow dynamic selection at any level of Site/Subsite/Document Library/Folder/SubFolder.   Content Server allows for only a single target Document Library to be selected per Content Repository configuration.  ### Document Libraries and Folders Considerations:  Pros:   - Can ensure security models are followed  - Can implement business logic around folders. E.g. create a new Document Library folder for every new Work Order that is created in Plant Maintenance  - ECM can link folders to SAP business objects vs individual documents. This can be used for scenarios where large batches of documents need to be easily linked to SAP Business Objects  Cons:  - Content Server does not inherently allow for custom folders to be created in its specification  ## 6. Viewing Options  There are three options available when deciding how to view SAP content stored and linked to SharePoint Online:  - SAP Viewer: The document is downloaded to the user’s computer and the SAP viewer will display the document  - SharePoint Authenticated URL Link: A SharePoint Viewing URL is returned to the user who must then authenticate to SharePoint to view the document. The user must have permissions to the Document. The document is viewed in the SharePoint web based viewer  - SharePoint Unauthenticated (Short Lived) URL Link: A short lived unauthenticated URL is generated and returned to the user. The user does not need to authenticate to SharePoint Online to view the item. The document is viewed in the SharePoint web based viewer. By default the URL expires in 1 minute, but this expiry period is configurable in Link Enterprise  Each of the above options has pros and cons listed below:  ### SAP Viewer Considerations:  Pros:  - SAP Viewer allows notes to be attached to documents  Cons:  - SAP Viewer has limited file type support  - SAP Viewer must be maintained on the user’s desktop (IT overhead)  - The document is downloaded (highest bandwidth) to the local computer before viewing  ### SharePoint Authenticated URL Link Considerations:  Pros:  - SharePoint Online Viewer has a wide range of file type support  - SharePoint Online Viewer is web based and runs in the browser  - The SAP viewer does not have to be installed or maintained  - The document does not need to be downloaded to the local computer before viewing (lowest bandwidth)  Cons:  - The user must have access rights to the document in the SharePoint Online document library  ### SharePoint Online Unauthenticated (Short Lived) URL Link Considerations:  Pros:  - SharePoint Online Viewer has a wide range of file type support  - SharePoint Online Viewer is web based and runs in the browser  - The SAP viewer does not have to be installed or maintained  - The document does not need to be downloaded to the local computer before viewing (lowest bandwidth)  - The user does not need access rights to the document in the SharePoint Online document library, SAP controls access  Cons:  - Additional configuration of SharePoint site collections to allow unauthenticated URLs to be generated. Configuration of this setting is per Site Collection  [title] Base SAP ArchiveLink Configuration [path] Repository Specific Guides/Link Enterprise for S3/Installation and Base Configuration Guide/ Both ECM and Content Server require basic ArchiveLink configuration for connectivity. This involves creating one (or more) Content Repository ID via transaction OAC0.  ***Please review the functionality referenced in the "Introduction and Overview" section of this document for a matrix of ECM vs. Content Server functionality.*** NOTE: - For ECM usage - Each RepoID will equate to a S3 Bucket. - For Content Server usage - Each RepoID will equate to a S3 Bucket. Additional ArchiveLink configuration may be required depending on the integration pattern implemented such as creation of doctypes (OAC2), assigning link tables (OAC3).  This configuration is not outlined in this guide – refer to the Solutions Guide for further information.  Optionally if you have big-bucket organization of content across Buckets within your Bucket collections, you may choose to create a oaco repository id for each, such as: Human Resources, Finance, Supply Chain, Health and Safety, etc. Please work with your Gimmal Link Enterprise team to determine the best setup to meet your requirements. Regardless, a minimum of one repository is required (and for the purpose of basic setup and configuration). [title] Archiving API Gateway Log/Tables [path] Repository Specific Guides/Link Enterprise for S3/Installation and Base Configuration Guide/Follow up Basis Tasks/ This tool allows you to maintain and archive API gateway log tables that may grow in size over time. In particular the below tables contain the bulk of the gateway data: 1. /DFLOW/ZAPIL01 - CMS API Log - Header 2. /DFLOW/ZAPIL06 - CMS API Log - MetaData 3. /DFLOW/ZAPIL10 - CMS API Log - Return It is highly recommended that you determine how long you would like to keep a line item level log vs header detail log and then create/schedule a background job to delete anything greater (either nightly or weekly). You have the choice to delete line item data (the highest volume by a hundred fold) and header data (less volume) as well as saving the entries to an export file as part of the deletion process. Line item detail is the data contained behind any drill down activity, eg: viewing metadata, viewing the full return table, etc. We recommend 1 year for line item detail and 5 years for header detail. Please observe foreground vs. background file locations. (SAP app/DB server vs. user presentation server). To archive Ggateway, first create a logical filename as shown below and then set up a background job with a variant via the following steps.  a. Create the logical filename "ZGLINK\_API\_GATEWAY\_SAVED\_LOG\_FILES" via transaction FILE. Assign to a logical path of the same name and configure that logical path to the directory to save the log files. The physical path must have the filename placeholder as \. b. Create a variant on the "Archive Gateway Data" selection screen to determine what to archive from the Gateway logs a. Go to the Gimmal Link Enterprise System Dashboard by utilizing transaction /DFLOW/SYS. b. Select the “Archive Gateway Data” menu option under the “Execute” menu. c. Enter in the criteria to determine what data to archive. We suggest leaving the last year’s worth of detail information and leaving all header information intact. Initially only the date and max header rows filters will need to have information entered. Note that in order to do advanced date calculations you will need to adjust on the “Save as Variant…” screen. | **Setting** | **Description** | **Sample Value(s)**  | | ------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------- | | CMS Profile  | The content management system profile to limit archiving on.  | | | CMS Use Tag  | The use tag to limit archiving on.  | | | CMS Repository Type | The content management system repository type to limit archiving on.  | | | CMS RFC Destination  | The remote function call (RFC) destination to limit archiving on.  | | | API Source  | The source of the api calls to limit archiving on.  | | | API Type  | The particular api call type to limit archiving on.  | | | SAP object ID | The particular SAP ArchiveLink object keys to limit archiving on. | | | Document Type  | The SAP ArchiveLink document types to limit archiving on. 
| | | Unique Entry Key  | The unique entry in the gateway log to limit archiving on. 
| | | Date  | The date range to limit archiving to. It is recommended to configure this at a minimum to limit how much data is archived.  | | | Time  | The time range to limit archiving on.  | | | User Name  | The SAP user name to limit archiving on.  | | | CMS Message Type  | The particular message types from the logs to limit archiving on.  | | | CMS SAP User  | The SAP user name to limit archiving on. 
| | | CMS Rep./Store  | The content management system repository or object store to limit archiving on.  | | | CMS ID  | The content management system id(s) to limit archiving on.  | | | CMS Filename  | The content management system filename(s) to limit archiving on. 
| | | CMS Type 
| The content management system document class, object type or metadata template to limit archiving on.  | | | CMS Property  | The content management system property that a choice list is defined to be configured against to limit archiving on. | | | CMS Choice List Prefix  | The content management system choice list prefix to limit archiving on.  | | | Test Only 
| If selected the archiving isn’t actually performed and the process is just simulated.  | | | Delete Headers – not recommended  | If selected the header information from the gateway log will be deleted as well. Typically only the detail information needs to be deleted for space saving reasons so try to leave the headers when possible.  | | | Max Header Rows 
| This determines how many at one given time are checked to see if their data should be archived. This helps for performance reasons to help limit the amount of processing. We suggest trying a value representative of the amount of processing that goes on in the given system.  | 500 | | Save selected entries  | Optionally if selected the archived entries can be stored in an output file for later analysis.  | | | PC file path (online execution only) | When this program is executed manually from the menu path and not via a scheduled job this determines the output file location for the archived data. 
| | | Dataset file path  | When this program is executed in the background (potentially by the scheduled job) a dataset file is used for storing the archived data.  | | d. Save the criteria as a variant that can be used by the scheduled job. a. Select "Save as Variant..." from the "Goto" menu under the "Variants". b. Adjust the date range by selecting "X\:Dynamic Date Calculation (System DA\ate)" for the selection variable of the "Date" Field name. c. Configure the "Name of Variable (Input Only Using F4)" to select the particular date range to archive. a. We suggest selecting I for include (the I in the I/E column) with the LT (for less than) option the "Current date +/- ??? days" selection from the choices. b. Enter 365 - for the ??? value. c. This archives all non-header data older than a year. d. Make sure to enter a unique variant name that will be needed when scheduling the job. Ex: ARCHIVEGATEWAY e. Also enter a description for the information entered. Ex: Archive the Gateway Logs c. Configure a scheduled job to archive the gateway data periodically. 1. Go to transaction SM36 to configure a new background job to archive the data. 2. Enter a unique name for the job that reflects the archiving of Gimmal Link Enterprise data. Ex: zglink\_archive\_gateway. 3. Define a step to call the particular archive program with the variant defined previously. 1. Define an ABAP program by pressing the “ABAP program” button. 2. Enter “/DFLOW/ZCMSAPI\_GTW\_ARCHIVE” for the “Name”. 3. Select the variant name previously defined in the “Variant” field. 4. Then finally save the step information by clicking on the floppy disk at the bottom. 5. Green arrow back to view the background job and you should see that a job step was successfully defined. 4. Define the start condition by clicking on the “Start condition” button along the top. 1. Press the “Date/Time” button along the top and define a start date and time for the archiving background job. We suggest starting the job off hours at night or on the weekend. The job shouldn’t affect any current processing so it isn’t required to run off hours but just suggested. 2. Press the “Period value” at the bottom to make the job run periodically to archive the gateway logs. We suggest running the archiving program weekly so that the job performs quickly and logs are maintained fairly regularly. 3. Finally save the start condition by clicking on the floppy disk at the bottom. 4. Confirm that the background job now mentions the planned start time along with how frequently it will be run. 5. Save the background job so that the archiving of gateway logs can occur. [title] SAP S4 Rise / Private Cloud [path] Repository Specific Guides/Link Enterprise for M365/Technical Overview/ This information is based on SAP's current best practices for connectivity: [https://blogs.sap.com/2023/01/31/rise-with-sap-s-4hana-cloud-private-edition-secure-cloud-connectivity/](https://blogs.sap.com/2023/01/31/rise-with-sap-s-4hana-cloud-private-edition-secure-cloud-connectivity/) The following three options are recommended for connectivity to S/4HANA Cloud, Private Edition / S/4 Rise. - VPN (IPSEC) - VPC or VNET Peering - Internet Based Firewall Access (***Content Server and WebSockets Only***) The connectivity architecture between AWS, Azure and Google Cloud are analogous, with minor variances in implementation ## VPN (IPSEC) In this scenario, a Virtual Private Network (VPN) Gateway client is deployed in the GimmalLink Tenant and is configured to connect to the SAP RISE Tenant VPN Gateway. Traffic for the SAP communications are routed through this secured connection. Azure and AWS provide options for Highly Available connections as an option. ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/w1Oan0HKV5UtFEq5amO2A_image.png) ## VPC (AWS/Google) or VNET (MS) Peering Virtual Network Peering is a mechanism that connects two virtual networks between Tenants in a Virtual Private Cloud (VPC). Microsoft calls their implementation VNET and AWS/Google use the term VPC Peering. In all cases, Peering provides a virtual, ***internal***, low latency, high bandwidth network connection between Tenants in the same VPC provider. ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/vmV1LFyVcQjQtdqKvzk_b_image.png) ## Internet Based Firewall Access In this scenario, a Web Application Firewall (WAF) is configured to allow specific traffic connectivity into the SAP RISE Tenant. AWS, Google and Azure all offer WAF as a service within the tenant. **NOTE: Only HTTPS is supported. This includes all Content Server connections and ECM Server when WebSockets are enabled (WebSockets require S/4 Hana 1909 or later)** **\*https\://community.sap.com/t5/technology-blogs-by-sap/websocket-rfc-rfc-for-the-internet/ba-p/13502531** ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/B58A-KvQv7aknXWE02PRp_image.png) [title] Base SAP Link Enterprise Configuration [path] Repository Specific Guides/Link Enterprise for S3/Installation and Base Configuration Guide/ ## ECM ECM requires base configuration regardless of what integration patterns, use cases, or functionality you would like to utilize. ## Content Server Content Server requires no more SAP Link Enterprise specific configuration unless you are going to use the below functionality with Content Server: 1. Outbound document storage (GOS/SFO or message output) WITH outbound metadata transfer 2. URL/Web viewing (instead of ArchiveLink standard viewing) 3. docMover 4. 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: 1. SAP message output without ECM plug in 2. ADK data archiving 3. Fiori apps using document service (ie: without SFO/GOS functionality) 4. Outbound DMS 5. 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.* ## Overview The base configuration consists of the following components:  1. One or more CMS Profiles 2. One or more CMS Use Tags 3. One or more API Destinations 4. Environment variables (optional) 5. 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 prerequisite.  All configuration must be saved in a transport for migration to QUAL and Production (among other) environments.  ## CMS Profiles | **Setting** | **Description** | **Sample Value(s) ** | | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------- | | CMS Profile  | CMS Profiles equate to top level site collections in S3. Typically, there is only one CMS Profile per Repository Type of an organization.  | S3\_1  | | Repository Type  | S3 Type  | S3   | | Description  | An English description given to the describe the CMS Profile  | Main Site: ACME  | ## CMS Use Tags | **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 Destinations 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.  | **Setting** | **Description** | **Sample Value(s) ** | | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | | CMS Profile  | CMS Profile that will use this API/RFC Destination  | S3\_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.  | Z\_CMSAPI\_01 

| Environment Variables --------------------- Environment variables are used for two reasons. The primary/most common reason is when a Enterprise 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 Enterprise 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.: \, or \  | **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 Enterprise ECM configuration.  | • SPOnPremHost
or
• reallylongsubsitestring | | Variable Value 1 
| The value to be substituted in the ECM configuration per SAP environment/system ID. 
| http\://devsp2013srv1/ 
http\://qualsp2013srv1/ 
http\://prodsp2013srv1/ 
or 
mycompany.sharepoint.com/sites/sapdemo  | ## Repository ID’s | **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 Link Enterprise legacy installations if dictated by your Link Enterprise 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 S3 versions require a location. | ON/OFF 
| | CMS Profile  | CMS profile that is relevant to this repository ID.  | S3\_1  | | CMS Rep/Store 
| For S3, this is your top-level construct that uniquely determines your online repository. This is a bucket id. 
| 4123123123 | | 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 S3 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 name (bucket in S3) 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). *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 \<-> Enterprise Connector Connectivity Configuration**. * [title] Follow up Security Tasks [path] Repository Specific Guides/Link Enterprise for M365/Installation and Base Configuration Guide/ Albeit not required for initial installation and configuration, in almost all scenarios viewing of attachment from SAP will be required. For this to occur, standard SAP authorization will be checked and therefore will need to be added to the user profiles at some point in the future. This is a heads up (as we know SAP Security does not like surprises ☺ ) that depending on what is implemented for document types (and you may already be utilizing ArchiveLink currently), the access to object S\_WFAR\_OBJ will need to be granted. Below is an overview of the elements involved:  | **Setting** | **Description** | **Sample Value(s) ** | | ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- | | OAARCHIV  | Content Repository  | \* 
Z1  | | | You can use the wildcard (\*) configuration entry here or you can restrict permissions to a particular ArchiveLink repository or set of ArchiveLink repositories. | ZA | | OADOKUMENT 
| Document Type 

You can use the wildcard (\*) configuration entry here or you can restrict permissions to a particular business object or set of business objects.  | \* 
ZAPINV01  | | OAOBJEKTE 

| Object Type 

You can use the wildcard (\*) configuration entry here or you can restrict permissions to a particular ArchiveLink document type or set of ArchiveLink document types.  | \* 
BKPF 
BUS2014 
| | ACTVT 
| Activity 

01 for creating attachments 
03 for displaying attachments
06 for deleting attachment links  | \* 
01,03,06 

Typically, 01 & 03 is granted only  | [title] Installing the Enterprise Connector [path] Repository Specific Guides/Link Enterprise for S3/Installation and Base Configuration Guide/ The following steps outline how to install the Gimmal Link Enterprise Connector.  1. Obtain the latest Gimmal Link Enterprise installer from a Gimmal representative. 2. Run the Gimmal Link Enterprise installer with administrative permissions on the server where Gimmal Link Enterprise is to be installed.  1. By default, Gimmal Link Enterprise will install to: C:\Gimmal Link Enterprise Connector\\ 2. We recommend changing the installation folder by adjusting the installation path (on the target path page) to: D:\Gimmal Link Enterprise Connector\ or to an extra drive available on the server that is not on the C: drive. 3. Optionally you can unselect the Windows Service from being installed by unselecting “Service“ on the installation package options. This is useful if you wish to administer Gimmal Link Enterprise manually or without using a service. 3. Adjust the “Log On” properties of the Gimmal Link Enterprise Windows services if folder permissions on the server restrict processing. Use the service account mentioned in the installation requirements. 4. Extract SAP JCO into the “jco” folder: 1. Download the appropriate SAP JCO 64bit version from SAP’s marketplace (this will be provided by your SAP Basis team) 2. Place the extracted contents into the jco folder under lib. 3. For windows installations sapjco3.dll is also required to be placed into the jco folder. 1. Note: JCO is sometimes two different compressed or zipped up files. Ensure the lowest level is extracted and placed in the jco folder. You will know the correct files are present if sapjco3.jar is found in the top level jco folder under lib. 5. Configure SAP JCO particulars . 1. In order to use service names in the SAP configuration you will need to adjust the services file to map message and gateway services to their port numbers. When configuring the services, you also have the option to use the port numbers instead of service names in which case you can skip this step. Ex for system number 21 and system name SAPQA: 1. sapmsSAPQA 3621/tcp 2. sapgw213321/tcp 2. The services file can typically be found at: C:\WINDOWS\system32\drivers\etc 6. Obtain a Gimmal Link Enterprise authorization token from a Gimmal representative. This token will be used when configuring the Gimmal Link Enterprise Connector. In the active configuration .ini file you will enter this token under the field “authentication.token=” or also via the Profile Wizard under the Profile->Authorize menu path (see Base Gimmal Link Enterprise Connector Configuration – Gimmal Link Enterprise ECM Only) for more information. [title] Changing Config.properties [path] Repository Specific Guides/Link Enterprise for M365/Installation and Base Configuration Guide/Follow up Middleware Team Tasks/ The Config.properties file is a text file that is found under the config directory in the installation folder. This text file contains advanced settings that are only to be configured by Gimmal Link Enterprise administrators since some of the settings can break Gimmal Link Enterprise functionality. Some of the important information found in the Config.properties file is mentioned below.  | **Setting** | **Description** | **Sample Value ** | | --------------------------------------- | ------------------------------------------------------------------------------------------------------- | ---------------------------------------- | | version  | The version of the Enterprise Connector  | 6.0 
| | jco.client.poolcount  | The number of JCO connections to keep in the JCO client pool count  | 4 | | jco.saplink.client.poolcount  | The number of JCO connections to keep in the JCO client pool count for SAPLink processing  | 6 | | sap.client.saplink.function  | SAP BAPI name used in processing  | /DFLOW/ZCMSSAPLINK\_V1  | | sap.client.softlink.function  | SAP BAPI name used in processing  | /DFLOW/ZCMSSAPLINK\_V1  | | sap.client.backpop.function  | SAP BAPI name used in processing  | /DFLOW/ZCMSSAPLINK\_V1 
| | sap.client.auditlink.function  | SAP BAPI name used in processing  | /DFLOW/ZCMSSAPLINK\_V1  | | sap.server.softlink.function  | SAP BAPI name used in processing  | /DFLOW/ZJCOSERV\_001 
| | sap.server.backpop.function  | SAP BAPI name used in processing  | /DFLOW/ZJCOSERV\_001  | | sap.server.auditlink.function  | SAP BAPI name used in processing  | /DFLOW/ZJCOSERV\_001 
| | sap.server.email.function  | SAP BAPI name used in processing  | /DFLOW/ZJCOSERV\_002 
| | sap.server.read.function  | SAP BAPI name used in processing  | /DFLOW/ZCMS\_API\_READ\_V1  | | sap.server.search.function  | SAP BAPI name used in processing | /DFLOW/ZCMS\_API\_SEARCH\_V1 
| | sap.server.search.V2.function  | SAP BAPI name used in processing  | /DFLOW/ZCMS\_API\_SEARCH\_V2  | | sap.server.create.function  | SAP BAPI name used in processing  | /DFLOW/ZCMS\_API\_CREATE\_V1 
| | sap.server.update.function  | SAP BAPI name used in processing  | /DFLOW/ZCMS\_API\_UPDATE\_V1 
| | sap.server.delete.function  | SAP BAPI name used in processing  | /DFLOW/ZCMS\_API\_DELETE\_V1 
| | sap.server.typesAndProperties.function  | SAP BAPI name used in processing  | /DFLOW/ZCMS\_API\_LOAD\_TANDP\_V1  | | sap.server.repositories.function  | SAP BAPI name used in processing  | /DFLOW/ZCMS\_API\_LOAD\_REPOS\_V1 
| | sap.server.metadata.function  | SAP BAPI name used in processing  | /DFLOW/ZCMS\_API\_LOAD\_META\_V1 
| | sap.server.choicelist.function  | SAP BAPI name used in processing  | /DFLOW/ZCMSCREATECHOICELIST\_V1 
| | sap.server.filenetPing.function  | SAP BAPI name used in processing | /DFLOW/ZCMS\_API\_PING\_CMS\_V1 
| | sap.server.middlewarePing.function  | SAP BAPI name used in processing  | /DFLOW/ZCMS\_API\_PING\_MID\_V1 
| | sap.client.saplink2.function  | SAP BAPI name used in processing  | /DFLOW/ZDOCMANAGER\_SAPLINK\_V2 
| | saplink.dateTime.format  | The date and time format to use when sending SAPLink information to SAP  | MM/dd/yyyy hh\:mm\:ss a z 
| | content.pem.file  | The private certificate to use when configuring SSL communication with the Gimmal Link Content Server.  | gimmal\_private\_key\_pkcs8.pem  | | content.cer.file  | The public certificate to use when configuring SSL communication with the Gimmal Link Content Server.  | gimmal\_public.cer  | [title] Base SAP Link Enterprise Configuration [path] Repository Specific Guides/Link Enterprise for M365/Installation and Base Configuration Guide/ ## ECM ECM requires base configuration regardless of what integration patterns, use cases, or functionality you would like to utilize. ## Content Server Content Server requires no more SAP Link Enterprise specific configuration unless you are going to use the below functionality with Content Server: 1. Outbound document storage (GOS/SFO or message output) WITH outbound metadata transfer 2. URL/Web viewing (instead of ArchiveLink standard viewing) 3. docMover 4. 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: 1. SAP message output without ECM plug in 2. ADK data archiving 3. Fiori apps using document service (ie: without SFO/GOS functionality) 4. Outbound DMS 5. 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.* ## Overview The base configuration consists of the following components:  1. One or more CMS Profiles 2. One or more CMS Use Tags 3. One or more API Destinations 4. Environment variables (optional) 5. 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.  ## CMS Profiles | **Setting** | **Description** | **Sample Value(s) ** | | ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------- | | CMS Profile  | CMS Profiles equate to top level site collections in SharePoint. Typically, there is only one CMS Profile per Repository Type of an organization.  | M365\_1  | | Repository Type  | Version of SharePoint that you are connecting to  | SharePoint M365  | | Description  | An English description given to the describe the CMS Profile  | Main Site: ACME  | ## CMS Use Tags | **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 Destinations 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.  | **Setting** | **Description** | **Sample Value(s) ** | | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | | CMS Profile  | CMS Profile that will use this API/RFC Destination  | M365\_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.  | Z\_CMSAPI\_01 

| Environment Variables --------------------- Environment variables are used for two reasons. The primary/most common reason is when a Enterprise 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 Enterprise 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.: \, or \  | **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 Enterprise ECM configuration.  | • SPOnPremHost
or
• reallylongsubsitestring | | Variable Value 1 
| The value to be substituted in the ECM configuration per SAP environment/system ID. 
| http\://devsp2013srv1/ 
http\://qualsp2013srv1/ 
http\://prodsp2013srv1/ 
or 
mycompany.sharepoint.com/sites/sapdemo  | ## Repository ID’s | **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 Link Enterprise legacy installations if dictated by your Link Enterprise 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: 
\  | | 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 name (top level site name in SharePoint) 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). *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 \<-> Enterprise Connector Connectivity Configuration**. * [title] Attachment List Options [path] Repository Specific Guides/Link Enterprise for M365/SharePoint Implementation Guide/ These settings are configured at the SAP business object level, which corresponds to one or more transactions. For example: - BUS2007 (Work Order): iw32/iw33 - BUS2012 (Purchase Order): me22n/me23n ### Virtual Linking 1. Determines the display of virtual links in the "Document Flow" node of the attachment list navigation pane. 2. Displays attachments from other SAP records. ### Virtual Folders 1. Determines the display of the folders node in the attachment list navigation pane. 2. Provides a cosmetic folder structure for attachment list "browsing". ### Overall Delete Link Strategy 1. Determines the behavior of the delete button on the attachment list. 1. Uses SAP standard S\_WFAR\_OBJ authorizations. 2. Options: 1. Allow users to delete links. 2. Allow users to delete links with admin review (requires Link Manager to be enabled). 3. Allow content to be deleted with links (requires Link Manager to be enabled). ### Attachment List Options 1. Determines the functionality available on the toolbar of the attachment list. 1. Enable/Disable display of SAP Database Attachments. 2. Enable/Disable display of SAP Database Notes. 3. Enable/Disable Delete Link Manager. - Controls options for users or administrators to delete links or content (with optional review). 4. Enable/Disable download of attachments. 5. Enable/Disable creation of notes in the SAP Database (not recommended). 6. Enable/Disable creation of notes in the content repository. [title] Configure SAP RFC destinations – ECM Only [path] Repository Specific Guides/Link Enterprise for M365/Installation and Base Configuration Guide/ Base configuration for ECM requires (at least one) SAP RFC to be created. This allows Link Enterprise ECM within SAP to execute RFC calls to an instance of the Enterprise Connector (in theory you can utilize more than one) acting as an SAP JCo Server.  The RFC destination configured here will be selected in the Link Enterprise configuration outlined the step Base SAP Link Enterprise Configuration – ECM Only (API Destination).  1. Destination Name: Z\_CMSAPI\_01 1. We suggest the following naming convention: Z\_CMSAPI\_\ but any destination name can be used. 2. Connection Type: T (TCP/IP Connection) 3. Technical Settings: 1. Select Registered Server Program radio button 2. Program ID: Z\_CMSAPI\_01 1. We suggest to keep the program ID name the same as the RFC destination name for simplicity as this will need to match the program ID in the Enterprise Connector. 3. Gateway Options (Optional if only one gateway host for the SAP environment) 1. Gateway Host: \ 2. Gateway Service: \ 4. Unicode: 1. Select Unicode radio button - Note: **You cannot test the RFC destination** until the Enterprise Connector has at least 1 RFC Destination (Outbound Rule) configured is also completed below and the windows service is running. When the windows service is installed, configured and running, refer to section Milestone: Establish SAP \<-> Enterprise Connector Connectivity Configuration to test connectivity. - The Program ID and Gateway Host and Service must match that configured in the Enterprise Connector (section “Base Enterprise Connector Configuration”), work with your Gimmal Link Enterprise configurator to ensure this is the case.You may need to repeat RFC destination creation above for additional processing threads and load balancing. Initially however only one RFC destination is needed. - ** Important This RFC destination chosen must match the API Destination configured in **Link Enterprise Connector in step Base Enterprise Connector Configuration – ECM Only. [title] RFC Destination (Outbound Rule) - ECM Only [path] Repository Specific Guides/Link Enterprise for M365/Installation and Base Configuration Guide/Base Enterprise Connector Configuration/ At least 1 RFC destination is required for ECM integration. This must match the RFC created in SAP (refer to Configure SAP RFC destination). This is a 1 to 1 relationship with RFC's configured in SAP for Link Enterprise integration. 1. Navigate to Mappings->RFC Destinations tab in the Enterprise Connector. 2. Choose Add Row 3. Configure the below fields: | **Setting** | **Description** | **Sample Value(s) ** | | ------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- | | Enabled | Turns RFC destination on or off | true | | IncludeSubFolders | Not applicable to M365 | false | | ErrorifDuplicate (Box) | For Box only: if same filename being created, error (enabled) or overwrite/version (false) | true | | Rename On-Duplicate (SP Online) | For M365 only: if same filename being created, rename automatically (\_1, \_2, etc) (enabled) or overwrite/version (false)
true | true | | Enable GUID ON Filenames (SP Online) | For M365 only: append unique GUID onto filename every time (no duplicate check) | false | | CMS name | The CMS system to connect to | M365\_DEV | | SAP name | The SAP system to connect to
| SAPDEV | | RFCDestination | The RFC configuration in SAP (must match) |
Z\_CMSAPI\_01 | | Server Count | How many connections per RFC destination
\*increase this number if the number of simultaneous RFC calls is being approached / throttled | 30 | | MaxResults | An optional setting to limit the number of entries returned when searching for documents.
 
A setting of 0 has no limit (limit set by Graph API). | 0 | | Working Directory | temporary directory
\*\* must contain double slashes | c:\\\\\//tmp | \*the Windows service must be restarted for changed to take effect [title] Installing the SAP Transports – ECM Only [path] Repository Specific Guides/Link Enterprise for M365/Installation and Base Configuration Guide/ The following steps outline how to install Link Enterprise ECM Flow within SAP. Installing the Enterprise Connector (Link Enterprise middleware component) and configuring the Link Enterprise base connectivity is covered in other sections.  1\. Obtain the latest Link Enterprise transports from a Gimmal representative. The transports provided will be determined by the Link Enterprise Content API base plus add-ones licensed.  2\. Import the Link Enterprise transports into the target SAP system.  - The Gimmal Link Enterprise product resides entirely in its own namespace (/DFLOW) - These transports should be imported with all import options enabled: ::Image[]{src="https://archbee-doc-uploads.s3.amazonaws.com/image_1217ed1f-6f97-4f4c-8239-d0ecd2438f60.png" size="54" position="center" showCaption="false"} 3\. This is a good time to enjoy a hot beverage of your choice while the import is running.  4\. Confirm that the transports were imported into the SAP system without any issues  - Note: Warnings will occur, for example regarding domains over 255 characters among others. Errors (return code 8) should not occur. If they do, stop further import of additional transports and contact your Gimmal Link implementer. [title] WebSocket RFC (Cloud Connections) [path] Repository Specific Guides/Link Enterprise for S3/Installation and Base Configuration Guide/ ## Cloud Configuration The Cloud Configuration allows on-premise solutions to communicate with Internet based Gimmal Link Enterprise servers over **HTTPS/SSL**. ### Import Certificate To allow SSL handshake between SAP and a hosted Link Enterprise Environment we require importing Gimmal Link Enterprise public certificate into SAP's Trust Manager. 1. In SAP start the **Trust Manager** (**STRUST**) 2. **Import **the Gimmal Link Enterprise public certificate into ***SSL Client (Standard)*** (This will enable SAP to identify Gimmal certificate during TLS handshake) 3. Enter **Change Mode (Ctrl + F1)** 4. Click **SSL Client Standard**. Click **Import **and select the Gimmal Link Enterprise public certificate provided. Click **Add to Certificate List** and **Save** ### Export Certificates The Gimmal Link Enterprise middleware requires an export of the SAP public root certificate for SSL Client and SSL Server. This is to identify the SAP system connecting into the hosted environment. 1. In SAP start the **Trust Manager (STRUST)** 2. Export the root certificate from **SSL Client (Standard) and SSL Server (Standard)**. 3. Click** SSL server Standard **and double click the subject ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/y4-PmOMlv6QKsXzoEzYKx_exp1.png) 4. It will be appear in the Certificate section 5. Scroll down and export (provided below is a sample image) of export icon ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/CZrLjYYsqbfQ9w3rJVQJC_root-cert-2.png) 6. Click **SSL server Client **and double click the Subject 7. Scroll down and export the certificate ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/lWsasF1o0ZYHXUBh6N8dP_exp2.png) 8. Send both certificates to your Gimmal representative ### Setup RFC Destination To enable a endpoint for the SAP to connect into the middleware we require an **RFC Destination** to be created 1. Visit transaction **SM59** 2. Click **Create **and give the destination an appopriate name. An example is Z\\_\ 3. Ensure the connection type is type **'W'** ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/EkYksHsPCFz57o8WjU7oT_zweb.png) 4. Under technical settings we need to prove the **Target System Settings** 5. For **host name** enter the provided hostname given to you by your Gimmal Representative 6. For **port** enter the provided port given to you by your Gimmal Representative 7. ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/Yrpx4JlTuSoTO4IlhGLSu_initalsettings.png) 8. Click the **Logon & Security** tab and enter Language as **EN** 9. Set the** Explicit Client** to **by Hostname** 10. Set the **Authentication Method** to by **X.509 certificate** 11. Under **Security Options** set to **SSL Client (Standard)** 12. ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/fqsL5NnIBlPywM9A8scW5_securiy.png) 13. Click **Save** 14. ***Provide the RFC Destination to your Gimmal representative*** ### Firewall The firewall needs to be configured to allow **HTTPS **traffic through to the Gimmal Link Enterprise server. To find or define these ports: ***Inbound Rule*** - In SAP, review the value for ***icm/server\_port\_x*** (where x=0,1,2,3...,n) that is used for **HTTPS**. This port will need to be opened for inbound traffic to the SAP system. ***Outbound Rule*** - Review the section ***Setup RFC Destination*** for the port that has been configured in **SM59 **for the ***WebSocket RFC*** communication to the Gimmal Link Enterprise Server. - This port will be given to you by the Gimmal representative ### Changing Profile Parameters To allow quick setup of websocket connetivity we can dynamically change the parameters to quickly confirm connectivity. Work with your SAP BASIS to configure the parameters to hold. 1. Enter transacation RZ11. 2. Type in rfc/websocket/external\_active 3. Change the value from 2 to 1. (This will allow us to bypass UCONN and enable logon, even if UCON is not activated and configured) 4. Confirm ucon/websocketrfc/active is set to 1. ### Middleware Setup Configure websockets through rfc destinations in middleware. INI File configuration. | **settings** | **Description** | **Sample Value(s) ** | | ----------------- | --------------------------------------------------------- | ------------------------- | | enable websockets | Enable websocket when a websocket connection is required. | true/false | | wsPortClient | SAP client port number. | 44300 | | wsPortServer | middleware port configured to websockets. | 8812 | | wsportHost | SAP host name/ ip address | XX.XX.XXX.XX | [title] Mandatory Microsoft Metadata Properties [path] Repository Specific Guides/Link Enterprise for M365/Installation and Base Configuration Guide/Follow up SharePoint Team Tasks/ Important note: albeit not required for base installation and connectivity, a heads-up: any content type used for SAP integration with Link Enterprise must include the following mandatory columns based on the usage pattern (ECM vs. Content Server). :::BlockQuote *\*\*\* *It is recommended that all properties (both ECM and Content Server) be added for all content types used for Link Enterprise integration \*\*\* ::: ## ECM Required Metadata Properties These names are suggestions and recommended, but are configurable in the Enterprise Connector. | SharePoint Column (suggested case sensitive name) | Data Type | Attribute Settings | | ------------------------------------------------- | ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | LinkEnterpriseUsername | single line of text |   | | LinkEnterpriseTimestamp | single line of text |   | | LinkEnterpriseSaplinkTrigger | single line of text | The only values Link Enterprise will recognize are "True" and "False" as triggers.

The resulting values are True and False by default, but can be changed in the config.properties file under your installation directory.

saplinkfalse.value=\ (for success)
saplinkerror.value=\
- eg: "DoNotProcessSuccess" and "DoNotProcessError"
- saplinkfalse.value=DoNotProcessSuccess
- saplinkerror.value=DoNotProcessError | | LinkEnterpriseSaplinkError | single line of text |   | ## Content Server Required Metadata Properties :::BlockQuote `*** Please ensure these are EXACT casing as below *****` ::: | SharePoint Column (mandatory case sensitive name) | Data Type | Attribute Setting | | ------------------------------------------------- | --------- | ----------------- | | contRep | Text | | | docID | Text | | | dateC | Text | | | compId | Text | | | pVersion | Text | | | docProt | Text | | | contentLength | Text | | | accessMode | Text | | | charset | Text | | | compStatus | Text | | | sapVersion | Text | | [title] Content Server [path] Repository Specific Guides/Link Enterprise for M365/Installation and Base Configuration Guide/Base Enterprise Connector Configuration/ Below is the configuration needed for a SharePoint Content Server. \*\*\* please refer to the section Follow Up SharePoint Team Tasks for more information on required indexes \*\*\* 1. Under "Connections" click "SharePoint Online" 2. Under "SharePoint Online" click modify on a previously created box connection. 3. Click "Add Content Server" 4. Hover over each input box to see example values. 5. Click "Add" 6. Click "Save". 7. Restart service via Windows services.   ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/sXK8kJEqLKdTfPxiiBo2f_screenshot-624.png" size="58" width="536" height="720" position="center" showCaption="false"} Image CaptionImage alt text The below table is a description of each configuration entry above, along with possible value.  | Setting | Description | Sample Value(s) | | ---------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | | enabled | YES/NO | Yes to enable, No to not but still configure. | | signature required | YES | Used for verify authentic origin requests.  | | csHost | Binds to local IP address  | 127.0.01 | | port | Port we want content server to be deployed on. | 8089 | | threads | Max Number of threads to allocate for parallel processing.  | 50 | | contentType | CMS Custom metadata needs to specify the name of template | invoices | | SAPType | Configured SAP System utilized  | S4 | | tmpDir | Directory to temporary use for storage | C:\\\\\\\\config\\\tmp | | certDir | Directory where certificates are located | C:\\\\\\\\config\\\certificates | | RepoId | SAP repository for content Server | ZS | | Location | subsite and or document library value where the data is stored

i.e /insertsubsitename/insertdocumentlibraryname | For SharePoint: /fi/ap | | repository | For SharePoint, Provide site Information | tenantname.sharepoint.com/sites/test | | callBackEnabled(for version 6.6.8) | Enable callbackHandler to link and monitor content server activities from SAP and to allow for ECM/SAPDocID mapping. ie: for each content server call from SAP to M365, a separate return call is made via SAP Jco RFC to log in the Link Enterprise SAP Gateway as well for a CREATE, it will map SAPDocID to the ECM M365 object id.

The recommended setting is YES as this will support:
- ECM based viewing
- ECM API support for documents stored via Content Server
In extremely high volume content server scenarios where no ECM will be in play, this setting should be set to NO | YES | \*the Windows service must be restarted for changed to take effect ### Mapping SharePoint Fields to docuflow Metadata SharePoint stores columns with internal names that may differ from those expected by docuflow. To synchronize document metadata correctly, the field names must be mapped in the defaultConfig.ini file. Add the following line: :::BlockQuote contentServer.contentType.columns = \{"DOCID":"docID","COMPID":"compId","PVERSION":"pVersion","CONTREP":"contRep","DOCPROT":"docProt"} ::: - The keys on the left (e.g., DOCID) represent standard metadata fields used by docuflow. - The values on the right (e.g., docID) correspond exactly to the internal SharePoint field names. This mapping enables docuflow to correctly interpret SharePoint metadata fields for indexing and synchronization. ### Multi-Library Support for SharePoint The **Multi-Library Support** feature enables Link Enterprise to search documents across multiple repositories and document libraries within the same SharePoint tenant, providing a unified and seamless search experience. To enable this feature, update the defaultConfig.ini configuration file with the following settings: :::BlockQuote contentServer.searchAll = YES contentServer.AdditionalSearchRepositoryWithLocation = xxxx.sharepoint.com/sites/repository/library ::: - contentServer.searchAll = YES activates Multi-Library Support. - contentServer.AdditionalSearchRepositoryWithLocation lists additional SharePoint document libraries (comma-separated) to include in the search. Once configured, Link Enterprise will search across the main repository and all specified SharePoint document libraries within the tenant. [title] Configure app within M365 - Application based permissions - Client Secret (Not Recommended) [path] Repository Specific Guides/Link Enterprise for M365/Installation and Base Configuration Guide/ The preferred method to authenticate with the graph api is via application based permissions. Using M365 SharePoint as a Gimmal Link Enterprise repository you will need to ensure that the Enterprise Connector is configured and able to connect to the Microsoft graph API. You must create an enterprise application via the Microsoft Azure portal to complete this procedure. This will require an account with appropriate level of permissions to grant correct access rights to a user (connector user) using the graph API when inside the azure portal.  You can either self-grant access or have an admin grant access to the graph API and its corresponding access rules inside the azure portal if and only if that user has authority to grant access to those rules.  The following steps below outline this process:  i. Visit https\://portal.azure.com/ then login using an appropriate account. ii. Click on Active Driectory, then click on App Registrations and click on new registration. Name the application GimmalLinkENT\_suffix (Either DEV, TEST,PROD) depending on environment provisioning. Select single tenant. Click register. Click Api Permissions under Manage. Click Add Permissions. Select Microsoft Graph, and then select application permissions. Type "Sites" in the search and select Sites.FullControl.All and Sites.Manage All for permissions. (Creating site permissions requires Sites.FullControl.All) *If you want to do permissions granularly at the site level follow, you may choose Site.Selected. Please reference this guide from Microsoft for site level permissions. [https://learn.microsoft.com/en-us/graph/api/site-post-permissions?view=graph-rest-beta\&tabs=http ](https://learn.microsoft.com/en-us/graph/api/site-post-permissions?view=graph-rest-beta\&tabs=http)* ** *(We have also included a summary of the site level permissions [here](https://linkenterprise.docs.gimmal.com/graph-api-sites-selected)*) Click Grant admin consent for GimmalLinkENT\_suffix Click certificates and secrets. Click new client secret Type in for the description GimmalLinkENT\_suffix. (Where the suffix is DEV/TEST/PRD. Select the appropriate expiry time. Save the Value which is the secret required to configure the Gimmal Link Enterprise middleware later. ~~CLick on manifest and change "allowPublicClient" to true and click save.~~ (not required app based permissions) Click on overview and save the following information. App ID, and tenant ID. Secret Id Configure Gimmal Link Enterprise in middleware GUI: 1. Visit http\://localhost:82 (enter the default user and password). 2. Click "Sharepoint Online" 3. Click "Add Row" 4. Enter the saved details in the previous page and enter them in the correct locations. 5. Click test connection. If "Success" is displayed the configuration has was done correctly. :::BlockQuote \*Note for our application scope will always be [https://graph.microsoft.com/.default](https://graph.microsoft.com/.default) \*The token URL and graph url always contain the tenant id in the URL Graph Url: [https://graph.windows.net/\/oauth2/token](https://login.microsoftonline.com/4de6eaf6-cf7a-47de-b747-6e3bffb4a/oauth2/token) ::: ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/W_jCpoM_c4g3Af9UBU10z_image.png "These are only sample values (replace with actual values from steps above)") These are only sample values in screenshot. (replace with actual values from steps above) ** [title] Grant Necessary SAP authorizations – ECM Only [path] Repository Specific Guides/Link Enterprise for S3/Installation and Base Configuration Guide/ In order to configure and monitor Link Enterprise , the below two transactions should be granted to the configurator and administrator of Link Enterprise :  - /DFLOW/SYS - /DFLOW/GTW Note: Depending on what functional integration patterns you are implementation, there may be additional transaction codes to grant access to a broader group of users: 1. Workflow Configuration: /DFLOW/WFCONFIG 2. Workflow AP Rollover: /DFLOW/APROLLOVER 3. Workflow AP Statistics: /DFLOW/APSTAT 4. Workflow ASL: /DFLOW/APASL 5. Workflow AP TrackLink: /DFLOW/APTRACKLINK 6. Workflow DMS TrackLink: /DFLOW/DMSTRACKLINK 7. Workflow General TrackLink: /DFLOW/TRACKLINK 8. Delete Link Manager: /DFLOW/LINKM 9. API Mass Load: /DFLOW/MLOAD 10. Migration Utility: /DFLOW/MIGRATOR 11. AuditLink Create: /DFLOW/AUDITLINK 12. AuditLink Dashboard: /DFLOW/AUDITLINKDASH If your security roles also check table maintenance authorizations, the authorization object Z/D1 must be granted via S\_TABU\_DIS for those who will configure Gimmal Link Enterprise. \*If Z/D1 does not exist in your system, the transport that contains Z/D1 is a customizing transport and must be imported separately. Please contact your Link Enterprise implementation specialist to obtain this transport. [title] RFC Destination (Outbound Rule) - ECM Only [path] Repository Specific Guides/Link Enterprise for S3/Installation and Base Configuration Guide/Base Enterprise Connector Configuration/ At least 1 RFC destination is required for ECM integration. This must match the RFC created in SAP (refer to Configure SAP RFC destination). This is a 1 to 1 relationship with RFC's configured in SAP for Link Enterprise integration. 1. Navigate to Mappings->RFC Destinations tab in the Enterprise Connector. 2. Choose Add Row 3. Configure the below fields: | **Setting** | **Description** | **Sample Value(s) ** | | ------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- | | Enabled | Turns RFC destination on or off | true | | IncludeSubFolders | Not applicable to M365/S3 | false | | ErrorifDuplicate (Box) | For Box only: if same filename being created, error (enabled) or overwrite/version (false) | true | | Rename On-Duplicate (SP Online) | For M365 only: if same filename being created, rename automatically (\_1, \_2, etc) (enabled) or overwrite/version (false)
true | true | | Enable GUID ON Filenames (SP Online) | For M365 only: append unique GUID onto filename every time (no duplicate check) | false | | CMS name | The CMS system to connect to | S3\_DEV | | SAP name | The SAP system to connect to
| SAPDEV | | RFCDestination | The RFC configuration in SAP (must match) |
Z\_CMSAPI\_01 | | Server Count | How many connections per RFC destination
\*increase this number if the number of simultaneous RFC calls is being approached / throttled | 30 | | MaxResults | An optional setting to limit the number of entries returned when searching for documents.
 
A setting of 0 has no limit (limit set by Graph API). | 0 | | Working Directory | temporary directory
\*\* must contain double slashes | c:\\\\\//tmp | \*the Windows service must be restarted for changed to take effect [title] Migration Concepts and Strategies [path] Agnostic Guides/Solution Guide/Untitled/ Migration content from a source to Gimmal Link Enterprise Target with DocMigrator is a combination of DocManager business rules (SAP Business Objects and DocTypes), RFCs and their connections, and SAP background jobs. All of these, plus consideration of day-to-day Gimmal Link Enterprise processing and how quickly you want to migrate your content determines the constellation of these components. The diagram below provides a high level overview: ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/JGEeKXm19yBQF1-lroZK0_image.png) Typically there is a timeline for a migration, and together with the volume of content to be migrated, a seconds/per document or document/per second target is determined. The below sections outline the components, consideration, and best practices involved in order to achieve a successful migration. `Along with overall best practices, each content repository may have an additional notes or best practices section, please ensure you reference if applicable.` # Sharing of DocManager Rules and RFCs The first determination is whether content to be migrated will be sharing DocManager rules (which are at the SAP Business Object and/or DocType level) with day-to-day Gimmal Link processing. Things that will force separate DocManager rules: - If there is a need for separate bucket locations in S3 - If there is a need for separate SAP security - If there is a need for different meta-data In short, RFC destinations (and their number of RFC connections per destination) are how Gimmal Link can be load balanced to allow: 1. multiple Gimmal Link Enterprise Migrator SAP background jobs to be ran in parallel 2. sharing or separation of RFC processing between migration processing and day-to-day processing  In typical day-to-day Gimmal Link Enterprise processing, the DocManager rules determine the RFC destination, however DocMigrator can override this to force use of dedicated RFC destinations at runtime (more on this below). # Parallel vs. Single Stream Processing The second determination is whether your volume vs. timeline/milestones require multiple migration processes to run in parallel, or whether a single processing stream will suffice, in other words, how fast do you want or need your content to be migrated. ## Single Stream - Additional consideration into carving and chunking migration is not required - The only consideration is whether to share existing RFCs with day-to-day processing using a higher number of RFC connections (more on this below) ## Parallel Processing (most common and recommended) - Ideally is executed using separate RFC destinations than day-to-day processing, and further ideal over separate Gimmal Link Enterprise middleware connectors - The number of dedicated SAP background tasks available for migration dictates how many parallel processes can be executed - For Parallel Processing, there are 2 ways to carve and chunk a migration within the Gimmal Link DocMigrator, both leverage the input/selection criteria to the DocMigrator: - ArchiveLink Link parameters (most common and recommended) - All fields in TOA01 are available, both for “source” and “target” link entries in the migrator table once loaded/staged - Typical and easiest levels of carving are SAP Business Object and/or DocType - The advantage of using these two elements is it typically prevents from job running in parallel for the same migration load table entry at the exact same time - The other fields in a link entry can be used (such as SAP record/object\_id range) but extra caution must be given to not processing a load table entry at the same time over multiple jobs - Loading with custom ABAP to assign unique tags (requires development) - This method typically has the chunks set by Tag name set at time of the load process, and thus migration of the load table is done at the tag level `*note: it is imperative that parallel jobs do not have input criteria that allow it to process the same rule at the same time - they must be “unique” jobs to avoid runtime conflict. Running a migration for a document that is already migrated is OK, Gimmal Link will not migrate or process a document twice. ` # RFC Destinations and Connections Regardless of the processing style chosen able, but imperative to consider for Parallel Processing, is how to load balance the migration process over RFC destinations and RFC connections.  ## Sharing DocManager Rules If sharing the same DocManager rule as day-to-day processing is not concern, and load is not a concern, DocMigrator can be run to leverage the DocManager rule in it’s entirety, including which RFC to use In this scenario, it is recommended to increase the number of RFC connections at the middleware level for each RFC to be shared, thus reducing the chance of migration activity and day-to-day processing waiting for an available RFC destination connection ## Forcing RFC Destination(s) To take full control over which RFC destination is to be used, DocMigrator can be run explicitly specifying the RFC destination to use for that background job by using the "Force RFC" input parameter **(most common and recommended)** - In this scenario, ideally use 1 RFC destination per background job - If background jobs are to share an RFC destination, increase the number of RFC connections to match the number of SAP jobs running against that RFC at the same time (assuming no day-to-day processing is using that same RFC) - Ideally each background job uses 1 RFC destination with 1 RFC connection - It is recommended to have a maximum of 10 RFC destinations per Gimmal Link Enterprise middleware connectors - It is recommended to have a maximum of 10 RFC connections per RFC destination - In theory, that is 100 RFC destination/connection combinations registered in your SAP Gateway, therefore mind your maximum allowed users as logged in clients in SMGW # Additional Best Practises - SAP Background Jobs - **Never have migration table entries shared between background jobs for parallel processing.** A potential collision could occur to process the same entry at the same time across more than 1 background job - Unique Filenames from Source Content - If your source files may contain non-unique filenames, and there is a chance they may be migrated to the same repository location for a CMS that does *not* allow same name files, **versioning must be prevented**. This can be handled in two ways: - 1\) In the DocMigrator, choose the "Force Unique Filename". This will append a unique UUID stamp to the source filename. - 2\) In the Gimmal Link Enterprise middleware, at the RFC destination level - enable "Error On Duplicate". This will result in an erorr for documents attempted to be migrated to the same folder if there is an file with that existing name. These erorrs can then be triaged after the fact to either modify the filename in the source system, or re-run the Gimmal Link migration for those errors and choose "Force Unique Filename" above. - RFC’s and Gimmal Link Enterprise Middleware - Ideally avoid sharing Gimmal Link Enterprise migration RFC destinations with production day-to-day Gimmal Link processing RFC destinations - Ideally avoid sharing Gimmal Link Enterprise migration with production day-to-day Gimmal Link processing across the same middleware instance - Ideally have dedicated 1 or more Gimmal Link Enterprise middleware instances for migration (unless shared doctypes and DocManager rules for migration and day-to-day) - Consider total number of RFC destinations/RFC connections in your SAP Gateway maximum user count - For production day-to-day Gimmal Link Enterprise processing and migration processing, servers hosting Gimmal Link Enterprise middleware should be dedicated to Gimmal Link Enterprise - Often 1 non-prod Gimmal Link Enterprise middleware instance/server is enough, ideally 1 per SAP instance (DEV/QUAL/PROD/TRAINING) but that is optional/nice to have. This only affects Inbound to SAP processing/testing as when you add a document to S3, how does the connector know which SAP system to go to (hint for the fancy pants out there: yes you can add more than one metadata field at the SAPLink rule level in the mdfilters string). - If your source data is also from a Gimmal Link Enterprise endpoint - ensure the CMS Use Tag in the DocMigrator configuration is separate from DocManager business rules and/or is configured to a dedicated RFC as a Gimmal Link Enterprise READ will be performed on that RFC - Also important to ensure there are multiple RFC connections for a READ RFC destination to ensure maximum throughput and performance. - Repository ID’s and Doctype’s - Mapping to new Repository ID’s is almost always required and highly recommended - Mapping to new document types is optional. Remember that new document types typically requires updated SAP Security roles/profiles. - theory recap: ArchiveLink uses S\_WFAR\_OBJ authorization object which has repository id, SAP business object, and doctype - thus if repository ID is already part of your security model, you will have to accommodate the new repository ID at a minimum - recap section “Sharing of DocManager Rules and RFCs” above to determine if you have to have new doctypes (in addition to reasons you may have as well) - Deleting Links / Attachments List - During migration of SAP Business Objects/Doctypes buckets, if the source content is to remain intact, and if using then Gimmal Link Enterprise DocManager attachment list ONLY, consider “hiding” those from the attachment list until migration for that combination is complete (DocManager config) - After migration buckets of SAP Business Objects/Doctypes are completed, and if using then Gimmal Link Enterprise DocManager attachment list ONLY, consider “hiding” those from the attachment list until final verification (DocManager config) - Deletion of source links is only recommended after a verification window post-migration. This is also optional if using the DocManager attachment list, as you can also simply hide the original links as well. # Performance Notes - Set logging in Gimmal Link Enterprise middleware to ERROR only. Less logging, less writing to disk - Increase the JVM size for Gimmal Link Enterprise middleware server to 2048 initial/4096 max. - Have Gimmal Link Enterprise Profile Wizard closed during processing - Including metadata as part of the migration requires an additional API call as part of the “create”, but allows for the migration to process in one enchilada. However, If migration milestones are short and if metadata isn’t required Day 1, or if API max calls are a concern, consider transferring metadata as a second wave using the Gimmal Link MDPro in SAP to execute a mass push of metadata after the fact. **** [title] Utilities: Archiving Gateway Data [path] Agnostic Guides/Solution Guide/ An overview and instructions on how to schedule the Gimmal Link Enterprise API maintenance job can be found in our Base Installation and Configuration Guide. [title] Additional Utilities [path] Agnostic Guides/Solution Guide/Untitled/ # Export Copy of Source / Target Content DocMigrator can be used as a content exporter for any entries in the Migration Table. Specify a valid path available to the program (ie: foreground or background). This process uses all the input criteria available for selection parameters. ## Delete Target Content You can use DocMigrator to delete target content. This is typically only done when backing out a migration or portion thereof and should be approached using EXTREME CAUTION. This process uses all the input criteria available for selection parameters. ## Delete Target Link You can use DocMigrator to delete target ArchiveLink links. This is typically only done when backing out a migration or portion thereof and should be approached using EXTREME CAUTION. This process uses all the input criteria available for selection parameters. The results of the Load phase are displayed on the screen according to the option "Display Results in ALV" checkbox. If this option is chosen, all entries are displayed in the ALV report format, else a simple message indicating the number of entries loaded successfully, with info message, or errors is displayed. If ALV is chosen, the header will display information as to the breakdown of entries loaded successfully, with info message, or errors. `Be careful when choosing "Display Results in ALV" as for large datasets this will significantly increase runtime and potential SAP system memory usage and timeouts. It is therefore suggested to use the "Display" mode of the migrator afterwards instead of displaying the results in ALV format. ` Clicking on the source or target hotspot/hyperlink in the ALV allows you to view the image prior to deleting the link or content, but of course is not supported after. [title] Invoice Processing Rules [path] Agnostic Guides/Solution Guide/Untitled/Untitled/ ## Overview Processing rules determine the baseline behaviour for an invoice based on its classification. Albeit you can dynamically change the processing rule during the life cycle of an invoice via customizing (optional — refer to the Customizing section later in this document), the processing rule will set the default behaviour. ## Setup Based on the Gimmal Link Enterprise Classification configuration, below are the processing rule options. Unless specified otherwise, the options below are relevant to *both* NON-PO and PO Invoice Types. 1. **Enable Auto Create NON-PO/PO:** Attempt to automatically park the invoice given metadata from the content management system 2. **Enable Auto Keep:** If Auto Create is enabled and successful, keep the invoice at the Initial AP Stage (enable Auto Keep IA) or send directly for the next processing stage (disable Auto Keep IA) 3. **Enable Pre-Pop NON-PO/PO: **If Auto Create is not enabled, or is enabled and fails, the Initial AP team must first create the invoice (or send for exception). This option allows you to pre-populate the SAP invoice entry screen with metadata from the content management system if available. 4. **Enable Auto Send Initial AP:** 1. Auto Create successful: work-item will be sent to the next processing stage after Initial AP (ie: Initial AP will be skipped) 2. Invoice "manually" created successfully (ie: Auto Create is not enabled or fails, or the Initial AP clerk parks the invoice successfully), the Gimmal Link Enterprise pop-up window can be skipped and the invoice can be sent directly for the next processing stage. 5. **Enable Skip Approvals for PO Invoices: **Skip all approval levels for PO based invoices. 6. **Deadline (Days) Initial AP:** In days, how long a work-item will stay at the Initial AP stage before escalation. Who receives this escalation is configured in the Agents configuration (outlined later in this document). 7. **Enable Level 1 thru 5 Approvals:** Enable approval level based on configured thresholds. 8. **Level 1 thru 5 Minimum Amounts: **Minimum dollar amount of invoice to enable the relevant approval level. Leave blank to indicate no minimum. 9. **Deadline (Days) Approval Level 1 thru 5:** In days, how long a work-item will stay at particular Approval stage before escalation. Who receives this escalation is configured in the Agents configuration (outlined later in this document). 10. **Skip Final AP for Posted Document NON-PO/PO:** if the invoice is already posted when it arrives at this stage of the workflow, Final AP will be skipped entirely and the Gimmal Link Enterprise AP workflow will be completed automatically. 11. **Enable Final AP NON-PO/PO:** Enable the Final AP stage. 12. **Enable AutoPost NON-PO/PO:** Gimmal Link Enterprise can attempt to Automatically post the invoice at the Final AP stage. This is only attempted if "Enable Final AP" is enabled above. If Auto Post fails, a work-item is automatically sent to a Final AP agent. 13. **Enable Auto Send Final AP:** 1. Auto Post successful: workflow will be set to complete (ie: Final AP will be skipped). 2. Invoice "manually" posted successfully (ie: Auto Post is not enabled or fails, or the Final AP clerk posts the invoice successfully), the Gimmal Link Enterprise pop-up window can be skipped and the workflow will be set to complete automatically. 14. **Force Post: **If Final AP is enabled, and in the case that a work-item is sent to an agent (ie: AutoPost is enabled and either fails or AutoKeep is enable / Skip Final AP is disabled) if the invoice is *not* posted, then the "Complete Workflow" on the Gimmal Link pop-up window will be disabled. 15. **Deadline (Days) Final AP: **In days, how long a work-item will stay at the Final AP stage before escalation. Who receives this escalation is configured in the Agents configuration (outlined later in this document). ## Role Resolution / Agent Determination Who will receive dialogue (foreground) work-items for workflow Initial AP, Approval, Final AP, and Exception stages is configured in the Agent configuration. Refer to the section "Agents" later in this document. ## Customizing Options The following customizing options are available for Invoice Processing. For information on how to implement, please refer to the section "Customizing" later in this document. 1. **Custom Rule Determination: **To manipulate the Processing Rule for an invoice. 2. **Custom Auto Create:** To implement your own Auto Create logic. 3. **Custom Pre-Pop:** To implement your own Pre-Pop logic. 4. **Custom Work-item Text: **To implement your own Work-item text. 5. **Custom Auto Exceptions:** To implement your Auto Exceptions. 6. **Custom Auto Post Logic:** To implement your own Auto Post logic. 7. **Custom Approval ASL Check:** To implement your own ASL check 8. **Custom Role Resolution / Agent Determination:** To implement your own logic to determine work-item recipients 9. **Custom Notifications:** To implement your own method of notifying agents. 10. **Custom Pre-Processor Logic: **Powerful BADI to take control of all pre-processing logic 11. **Custom Post-Processor Logic: **Powerful BADI to take control of all post-processing logic 12. **Custom POPUP PBO Logic: **To implement your own changes to the Gimmal Link pop-up windows for processing. 13. **Custom POPUP PAI Logic:** To implement your own logic to the Gimmal Link pop-up windows for processing. [title] Read [path] Agnostic Guides/Developers Guide/FileNet Endpoints/ Link Enterprise provides a web service endpoint that will allow you to retrieve a file metadata. Included below are example of reading a files metadata. :::ApiMethodV2 ```json { "tab": "examples", "url": "https://localhost:82/scrud/read", "name": "Read (metadata)", "method": "POST", "request": { "pathParameters": [], "queryParameters": [], "headerParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "cmsName", "type": "string", "description": "Name of the filenet system configured in Link Enterprise ." }, { "kind": "required", "name": "selectedCMS", "type": "string", "description": "Value should always be set to \"filenet\" to let Link Enterprise know which configured content system to search." }, { "name": "location", "kind": "required", "type": "string", "description": "filenet folder where the document need to be read.", "children": [] }, { "name": "repository", "kind": "required", "type": "string", "description": "filenet repository Value", "children": [] }, { "name": "domain", "kind": "required", "type": "string", "description": "Filenet Domain name", "children": [] }, { "name": "checkout", "kind": "optional", "type": "string", "description": "If true, Does an Exclusive Checkout for filenet document.", "children": [] }, { "name": "id", "kind": "required", "type": "string", "description": "Filenet unique Document Id", "children": [] }, { "name": "selectClause", "kind": "optional", "type": "string", "description": "metadataField name which is required in response.", "children": [] }, { "name": "getContent", "kind": "optional", "type": "string", "description": "If true, Returns binary content of the Document. If false, returns metadata properties.", "children": [] }, { "name": "dateTimeFormat", "kind": "required", "type": "string", "description": "add datetime property in this provided format.", "children": [] }, { "name": "maxSize", "kind": "optional", "type": "string", "description": "Maximum number of entries in response.", "children": [] } ], "formDataParameters": [] }, "results": { "languages": [ { "id": "ymgovs5m1fdI32-gkqqCH", "code": "{\n\t\"someMetadataFieldName\": \"someMetadataFieldValue\"\n}", "language": "200" }, { "id": "guaZg_Kjaci06qaXI6hoD", "code": "", "language": "500" } ], "selectedLanguageId": "ymgovs5m1fdI32-gkqqCH" }, "examples": { "languages": [ { "id": "yA6PAHJgLMNa-NjR8XpmC", "code": "{\n \"cmsName\":\"Name of the filenet system configured in Link Enterpri.\", \n \"repository\":\"Filenet_Repository\",\n \"domain\":\"Domain_Name\",\n\t\"checkout\":false,\n\t\"id\":\"filenet document id\",\n\t\"dateTimeFormat\":\"MM/dd/yyyy hh:mm:ss a z\",\n\t\"selectClause\":\"someMetadataFieldName\",\n\t\"getContent\":false,\n\t\"maxSize\":100\n \"selectedCMS\":\"filenet\",\n \"location\":\"filenet folder name\"\n\t\n}", "language": "json" } ], "selectedLanguageId": "yA6PAHJgLMNa-NjR8XpmC" }, "description": "Retrieve a file metadata by using filenet unique Id.", "currentNewParameter": { "label": "Body Parameter", "value": "bodyDataParameters" }, "autoGeneratedAnchorSlug": "read-metadata", "legacyHash": "RTkIuAhig8f9DkChR6cM4" } ``` ::: :::ApiMethodV2 ```json { "tab": "examples", "url": "https://localhost:82/scrud/read", "name": "Read (Content)", "method": "POST", "request": { "pathParameters": [], "queryParameters": [], "headerParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "cmsName", "type": "string", "description": "Name of the filenet system configured in Link Enterprise ." }, { "kind": "required", "name": "selectedCMS", "type": "string", "description": "Value should always be set to \"filenet\" to let Link Enterprise know which configured content system to search." }, { "name": "location", "kind": "required", "type": "string", "description": "filenet folder where the document need to be read.", "children": [] }, { "name": "repository", "kind": "required", "type": "string", "description": "filenet repository Value", "children": [] }, { "name": "domain", "kind": "required", "type": "string", "description": "Filenet Domain name", "children": [] }, { "name": "checkout", "kind": "optional", "type": "string", "description": "If true, Does an Exclusive Checkout for filenet document.", "children": [] }, { "name": "id", "kind": "required", "type": "string", "description": "Filenet unique Document Id", "children": [] }, { "name": "selectClause", "kind": "optional", "type": "string", "description": "metadataField name. While retrieving content. add \"ContentElements\" as selectClause to get file information in response header.", "children": [] }, { "name": "getContent", "kind": "optional", "type": "string", "description": "If true, Returns binary content of the Document. If false, returns metadata properties.", "children": [] }, { "name": "dateTimeFormat", "kind": "required", "type": "string", "description": "add datetime property in this provided format.", "children": [] }, { "name": "maxSize", "kind": "optional", "type": "string", "description": "Maximum number of entries in response.", "children": [] }, { "name": "tmpDirectory", "kind": "optional", "type": "string", "description": "Temporary directory where the file content is stored in the local system. Required while getContent is set to true.", "children": [] } ], "formDataParameters": [] }, "results": { "languages": [ { "id": "ymgovs5m1fdI32-gkqqCH", "code": "file content", "language": "200" }, { "id": "guaZg_Kjaci06qaXI6hoD", "code": "", "language": "500" } ], "selectedLanguageId": "ymgovs5m1fdI32-gkqqCH" }, "examples": { "languages": [ { "id": "yA6PAHJgLMNa-NjR8XpmC", "code": "{\n \"cmsName\":\"Name of the filenet system configured in Link Enterpri.\", \n \"repository\":\"Filenet_Repository\",\n \"domain\":\"Domain_Name\",\n\t\"checkout\":false,\n\t\"id\":\"filenet document id\",\n\t\"dateTimeFormat\":\"MM/dd/yyyy hh:mm:ss a z\",\n\t\"selectClause\":\"someMetadataFieldName\",\n\t\"getContent\":true,\n\t\"maxSize\":100\n \"selectedCMS\":\"filenet\",\n \"location\":\"filenet folder name\",\n \"tmpDirectory\":\"C:\\\\somefolderlocation\"\n\t\n}", "language": "json" } ], "selectedLanguageId": "yA6PAHJgLMNa-NjR8XpmC" }, "description": "Retrieve a file metadata by using filenet unique Id.", "currentNewParameter": { "label": "Body Parameter", "value": "bodyDataParameters" }, "autoGeneratedAnchorSlug": "read-content", "legacyHash": "vfL_H1ym3b69iCwb8tkz1" } ``` ::: [title] Upload [path] Agnostic Guides/Developers Guide/S3 Endpoints/ Link Enterprise provides an endpoint to upload files to. This is strictly for uploading files, and if you require metadata to be transferred following up with an update endpoint call is required. :::ApiMethodV2 ```json { "tab": "request", "url": "https://localhost:82/scrud/upload", "name": "Upload", "method": "POST", "request": { "pathParameters": [], "queryParameters": [], "headerParameters": [ { "kind": "required", "name": "cmsName", "type": "string", "description": "Name of the content management system configured in Link Enterprise." }, { "kind": "optional", "name": "location", "type": "String", "description": "S3 Bucket Name. By Default, Bucket name under s3 configuration in ini file is considered." }, { "kind": "optional", "name": "Content-Type", "type": "string", "description": "multipart/form-data; boundary=(insert boundary)\n\nExample is included in code examples" } ], "bodyDataParameters": [], "formDataParameters": [] }, "results": { "languages": [ { "id": "81EVM7WXdGrYfDwshYJW6", "code": "SUCCESS EXAMPLE\n{\n\t\"id\": \"POSPaper COD-04.pdf\",\n\t\"result\": \"success\"\n}\n\nFAILED EXAMPLE\n{\n\t\"id\": null.\n\t\"result\": \"fail\"\n}", "language": "200" }, { "id": "6U9gw-gSaolDqS3WcFi9t", "code": "", "language": "500" } ], "selectedLanguageId": "81EVM7WXdGrYfDwshYJW6" }, "examples": { "languages": [ { "id": "xY6nLYt-BP3jeEy_-jkb3", "code": "POST /scrud/upload HTTP/1.1\nCookie: vertx-web.session=135e85c919328477ec243e270a692c4d\nUser-Agent: insomnia/2023.5.8\nCmsname: blob\nLocation: dflow123\nAccept: */*\nAuthorization: Basic YWRtaW46YWRtaW4=\nContent-Type: multipart/form-data; boundary=---011000010111000001101001\nHost: localhost:82\nContent-Length: 172\n\n-----011000010111000001101001\nContent-Disposition: form-data; name=\"\"; filename=\"POSPaper COD-04.pdf\"\nContent-Type: application/pdf\n\n\n-----011000010111000001101001--", "language": "none" } ], "selectedLanguageId": "xY6nLYt-BP3jeEy_-jkb3" }, "description": "Upload a file using HTTP multi part form data. HTTP headers specifying location, and the content system named must be specified.", "currentNewParameter": { "label": "Header Parameter", "value": "headerParameters" }, "autoGeneratedAnchorSlug": "upload", "legacyHash": "SYWoaQaa1CeAs6I_xHZZn" } ``` ::: [title] Search [path] Agnostic Guides/Developers Guide/S3 Endpoints/ Link Enterprise provides a web service endpoint that will allow you to retrieve a subset of documents based on a search criteria. :::ApiMethodV2 ```json { "tab": "examples", "url": "https://localhost:82/scrud/search", "name": "Search ", "method": "POST", "request": { "pathParameters": [], "queryParameters": [], "headerParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "cmsName", "type": "String", "description": "Name of the s3 system configured in Link Enterprise ." }, { "kind": "required", "name": "whereClause", "type": "string", "description": "A where clause Used to query s3 to return a set of files/folders depending on criteria set." }, { "kind": "required", "name": "selectedCMS", "type": "string", "description": "Value should always be set to \"s3\" to let Link Enterprise know which configured content system to search." }, { "name": "location", "kind": "optional", "type": "string", "description": "S3 Bucket name where you want to search the document.", "children": [] } ], "formDataParameters": [] }, "results": { "languages": [ { "id": "l7mAccvIkcMGyR03J3_aP", "code": "[\n\t{\n\t\t\"compid\": \"data24\",\n\t\t\"content-length\": \"3000\",\n\t\t\"contrep\": \"K2456\",\n\t\t\"docid\": \"1234\",\n\t\t\"scanperformed\": \"true\"\n\t}\n]", "language": "200" }, { "id": "C0tj4vmrgrTV7Xq8ZvvAu", "code": "", "language": "500" } ], "selectedLanguageId": "l7mAccvIkcMGyR03J3_aP" }, "examples": { "languages": [ { "id": "RinXZo0WaAz3lEkUOH2ux", "code": "{\n \"cmsName\":\"insertProductionSystemName (located in Link Enterprise gui)\",\n \"selectedCMS\":\"s3\",\n\t\"whereClause\":\"contRep,K2456\",\n\t \"location\":\"S3 Bucket Name\"\n}", "language": "json" } ], "selectedLanguageId": "RinXZo0WaAz3lEkUOH2ux" }, "description": "Search for all documents using a where clause. If successful will return a JSON Array with a size greater then or equal to zero with status code of 200. Otherwise status code 500 is returned. If it's a known error returns 200 with error message in response.\n", "currentNewParameter": { "label": "Body Parameter", "value": "bodyDataParameters" }, "autoGeneratedAnchorSlug": "search", "legacyHash": "2I1lkUo-tBmvDr0MrlixB" } ``` ::: [title] Publisher: Triggering Storing and Linking [path] Agnostic Guides/Developers Guide/Untitled/ In your custom code or enhancements (primarily in the "processing" or appropriate form of your Z version of the message output), add code that calls the “publish\_message” method of the “/dflow/cl\_publishing”.   The example below shows the retrieval of the spool id as well as various other input parameters like the filename (used for the document that will be stored in the content management system) so that the call to the “publish\_message” method can be made.   Calls to the method can also be made using the SAP OTF table or by passing in the PDF as a string instead of using the spool id.  Adjustments will need to be made for the particular message output program/function module that is getting Gimmal Link Enterprise functionality added to it.   Consult with an ABAP developer for assistance in gathering the correct information so that a call to the “publish\_message” can be made successfully.   ## Example \* Ensure the user has selected to PRINT the document (ie. Not Fax/EDI/etc) IF finaa-nacha = 1. "Print   “ define the variables we need to make the call to Gimmal Link publisher   DATA lo\_publishing TYPE REF TO /dflow/cl\_publishing.   DATA lv\_object\_id  TYPE /dflow/cl\_publishing=>gt\_object\_id.   DATA lv\_arc\_doc\_id TYPE /dflow/cl\_publishing=>gt\_id.   DATA lv\_filename   TYPE file\_table-filename. DATA lv\_document\_linked type abap\_bool. DATA lv\_document\_stored type abap\_bool. DATA lv\_message type string.   “ get an instance of the Gimmal Link publisher object   lo\_publishing = /dflow/cl\_publishing=>get\_instance( ).     " set FILENAME (format the filename to how you would like)   CONCATENATE bkorm-konto bkorm-bukrs INTO lv\_filename SEPARATED BY '\_'.     “ determine the SAP object id for this particular object   lv\_object\_id+0(10) = bkorm-konto. "Customer number   lv\_object\_id+10(4) = bkorm-bukrs. "Company code     “ try to make the call to the Publisher method and catch any exceptions   “ in this example the sap object type and document type are hard coded   TRY.       CALL METHOD lo\_publishing->publish\_message             EXPORTING               iv\_spool\_id   = itcpp-tdspoolid \*             it\_otf        = \*             iv\_pdf\_xstring            =               iv\_filename   = lv\_filename               iv\_sap\_object = 'KNB1'               iv\_ar\_object  = 'ZCRMPUBL01'               iv\_object\_id  = lv\_object\_id         IMPORTING ev\_arc\_doc\_id = lv\_arc\_doc\_id ev\_error = lv\_error             ev\_document\_stored = lv\_document\_stored             ev\_document\_linked = lv\_document\_linked             et\_return     = lt\_return.           .       CATCH /dflow/cx\_common .  lv\_message = lo\_error->get\_text( ). lv\_error = abap\_true. MESSAGE lv\_message TYPE 'I'.   ENDTRY.    READ TABLE lt\_return INTO ls\_return WITH KEY type = 'E'. IF sy-subrc EQ 0. MOVE: 'ZTC' TO syst-msgid, 'E' TO syst-msgty, '018' TO syst-msgno, ls\_return-message(50) TO syst-msgv1, ls\_return-message+50(50) TO syst-msgv2, ls\_return-message+100(50) TO syst-msgv3, ls\_return-message+150(50) TO syst-msgv4. PERFORM protocol\_update. MOVE: '/DFLOW/ZDOCUFLOW' TO syst-msgid, 'E' TO syst-msgty, '001' TO syst-msgno, 'Link Enterprise storage connection error - contact admin' TO syst-msgv1. PERFORM protocol\_update. MOVE c\_rc01 TO g\_subrc. ELSE. MOVE: '/DFLOW/ZDOCUFLOW' TO syst-msgid, 'S' TO syst-msgty, '001' TO syst-msgno, 'Link Enterprise storage success' TO syst-msgv1. PERFORM protocol\_update. ENDIF. ENDIF. [title] Migration Table Flags [path] Agnostic Guides/Solution Guide/Untitled/ Over the entire migration process (including optional steps and flags), below are the list of flags set (if applicable) in the migration table as DocMigrator is executed across the different phases of the migration, post-processing, etc. These flags are included as input to DocMigrator, allowing you to report on, or execute migration tasks based on. eg: Only process migration table entries for a particular SAP object and document type that have NOT been migrated yet - Target Cont. Migrated NE 'X' 1. Source MD Exists (if applicable) 2. New MD Exists (if applicable) 3. Source Validated (during validation runs only) 4. Target Cont. Migrated (during migration) 5. Metadata Migrated (if applicable) 6. Target Link Created (during migration) 7. Src Content Exported (used as an optional utility) 8. Src Content Deleted (used as an optional post-processing step) 9. Src Link Deleted (used as an optional post-processing step) 10. Target Content Deleted (used as an optional utility) 11. Target Content Link Deleted (used as an optional utility) 12. Target Content Exported (used as an optional utility) These flags are extremely useful when running the migrator in Display mode to report on subsets of your migration content and activity. [title] DocMigrator Custom Source Link Determination [path] Agnostic Guides/Developers Guide/Untitled/ Not specified in the configuration as the other Gimmal Link Enterprise class/method plug-ins, but rather at runtime in the DocMigrator load screen, this ABAP method allows you to compile the source entries for a migration. This is useful in scenarios where the standard ArchiveLink source selection criteria does not satisfy your query (ie: all PO based invoices from a particular company code, thus you cannot use the object\_id to determine those from a company code since MM invoices do not have company code as part of the SAPKey).  # Example Method: /DFLOW/CL\_MIGRATOR\_HELPER=> GET\_ABAP\_LINKS\_EXAMPLE *The below example is provided with the *Gimmal Link Enterprise *product.* Signature:  | **Type** | **Parameter** | **Description** | **Sample Value** | | ---------- | ----------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------- | | Exporting  | EV\_SOURCE\_TYPE  | The source type is either an ArchiveLink Content Server (A) or Gimmal Link Enterprise ECM (D)  | A or D 
| | Exporting  | ET\_CONNECT  | The ArchiveLink table entries that you either custom retrieve or custom build.  | Structure of TOAV0 – standard SAP ArchiveLink links  | [title] Configuring SSL communication with Content Server [path] Repository Specific Guides/Link Enterprise for S3/Installation and Base Configuration Guide/Follow up Middleware Team Tasks/ The content server communication with SAP can optionally have an SSL port enabled which also requires some certificates to be adjusted so that communication with SAP can be secure. The following example uses the command line tool called openssl. There are various ways to generate certificates so this example is just one way. Getting the openssl utility installed in your environment is not part of this guide. This example also generates what are known as self signed certificates. Generating signed certificates from certificate authorities is outside the scope of this document.  First you’ll need to get a private key and convert it to the appropriate format required by the Gimmal Link Enterprise Connector.  1. Generate an encrypted private key using openssl. openssl genrsa -aes256 -out my\_private\_key.pem 2048  This generates an RSA private key using AES256 encryption (other types of encryption are possible if AES256 is deemed insecure by your organization. It will prompt you to enter in a passphrase for the encryption, make sure to choose something that you will remember. The format of this certificate should be human readable since it is in the PEM format. The 2048 at the end of the command tells this key to be 2048 bits long (you could also use something like 4096 here instead of 2048)  2\. Convert the private key to the pkcs8 structure openssl pkcs8 -topk8 -inform pem -in my\_private\_key.pem -outform pem -nocrypt -out entlink\_private\_key\_pkcs8.pem  This command takes the input file generated in the previous step and converts it into the pkcs8 structure used by the Enterprise Connector. Note that the nocrypt command here also unencrypts the private key. Since this could allow vulnerabilities you may wish to restrict who has access to the folder where the certificates are stored. Just make sure that the Windows server that runs the Gimmal Link Enterprise Connector has access to the folder by creating a logon user for the service if need be.  3\. Store the private key in the config directory under the installation folder. 4\. Change the private key name to be entlink\_private\_key\_pkcs8.pem if you chose a different name in the previous steps. if you wish to keep the name that you originally chose you can optionally adjust the Config.properties file found under the config directory under the installation folder to point tp the new peivate key file you have created. You will need to adjust the content.pem.file to be the name of the file you have chosen. Ex: content.pem.file=my\_private\_key\_pkcs8.pem (if you chose my\_private\_key\_pkcs8.pem as the output file when converting to the pkcs8 structure.  5\. Generate a public cerificate from the private key using openssl. Make surethat the common name matches the host used in the OAC0 ArchiveLink configuration (ip or hostname). openssl req -new -x509 -key my\_private\_key.pem -out entlink\_public.cer -days 3650  This command creates a new self signed certificate that is valid for 3,650 days.  It will prompt you to enter the passphrase you chose earlier for your private key.  Then it will ask you to enter in a country designation, state or province, and city.  Next enter in your company name and an optional organizational unit from within your company (this can be left blank).  For the common name make sure to enter the ip address or hostname you used or will use when configuring the ArchiveLink repository under OAC0.  You can optionally enter in an email address as well.  6\. Store the public certificate in the config directory under the installation folder. 7\. Change the public certificate name to be entlink\_public.cer if you chose a different name in the previous steps. If you wihs to keep the name that you originally chose you can optinally adjust the Config.properties file under the config directory under the installation folder to point to the new public certificate you have created. You will need to adjust the content.cer.file to be the name of the file you have chosen. Ex: content.cer.file=my\_public.cer (if you chose my\_public.cer as the output file when creating the certificate).  8\. Store the publiccertificate in SAP using the transaction STRUST. This lets SAP know that calls out to the content server using this public certificate are trusted. 1. Execute transaction STRUST 2. Double click on the SSL System Client SSL Client on the left hand side (note there may be two variants of the System SSL client so repeat the process for both SSL clients ) 3. Verify that the right hand side says "SSL System Client SSL Client" at the top 4. On the bottom certificate section on the right hand side click on the import certificate button found in the lower left. 5. Select the certificate file that was previously generated and upload the certificate. 6. Verify that the certificate details get loaded up into the screen. 7. Finally click on the “Add to Certificate List” 8. Verify that the certificate list in the middle of the right hand side now contains an entry for the newly created public certificate (you may have to scroll down through the list of certificates). 9. Repeat the process if there was more than one SSL System client. 9\. Adjust the content server configuration tab in the Profile Wizard that will be using SSL communication by adding an SSL port number to configuration. 10\. Make sure that the same port number is configured in the ArchiveLink repository that will be used with this configuration via transaction OAC0. 11\. Make sure to save configuration to active profile and restart the Gimmal Link Enterprise Connector Windows service for the changes to take effect. 12\. In order to verify that the SSL configuration is correct you will need to attempt to store and retrieve (view) a business document that is associated with the ArchiveLink repository configured to use SSL. Note that testing the connection to the ArchiveLink repository does not test the SSL connection since that information is sent over the non-SSL port. This also means that ArchiveLink repository configurations must have both an SSL port and a regular port configured. [title] Tasks [path] Agnostic Guides/Developers Guide/Box Endpoints/ Currently Link Enterprise has an endpoint to create tasks on top of files and assign them to a user (among other things). :::ApiMethodV2 ```json { "tab": "examples", "url": "https://localhost:82/scrud/createTask", "name": "Create Tasks", "method": "POST", "request": { "pathParameters": [], "queryParameters": [], "headerParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "id", "type": "string", "description": "Unique id of box file or folder." }, { "kind": "required", "name": "type", "type": "string", "description": "Name of metadata template in box." }, { "kind": "required", "name": "selectedCMS", "type": "string", "description": "Value should always be set to \"box\" to let Link Enterprise know which configured content system to search." }, { "kind": "required", "name": "body", "type": "Array", "description": "Json Array of strings (each index being a seperate line). \n\nOr can take a single string value \"singleLineExample\"" }, { "kind": "required", "name": "dueDate", "type": "string", "description": "Date the task is due\n\n2100-12-31 (YYYY-MM-DD)\n" }, { "kind": "required", "name": "recipients", "type": "Array", "description": "Array of strings of recipients of the task (email id)\n\n*User may require permissions to file before being able to be assigned a task." } ], "formDataParameters": [] }, "results": { "languages": [ { "id": "qNYNaQPOhJ1UW-zegaFJ6", "code": "", "language": "200" }, { "id": "FRMYak2F3gPEAHrtkDAvt", "code": "", "language": "500" } ], "selectedLanguageId": "qNYNaQPOhJ1UW-zegaFJ6" }, "examples": { "languages": [ { "id": "npeO0usSroLpgszC5fpHh", "code": "{\r\n \"cmsName\":\"insertProductionSystemName (located in Link Enterprise gui)\",\r\n \"id\": \"insert box file id\",\r\n\t\"taskType\":\"insert Task type (described in params)\",\r\n\t\"recipients\":\r\n [\r\n \"admin@gimmal.com\",\r\n \t \"admin2@gimmal.com\"\r\n ],\r\n\t\"body\": [\r\n \"Hi\",\r\n \t \"Thank you.\"\r\n ],\r\n\t\"dueDate\":\"2021-12-30\", \r\n \"selectedCMS\":\"box\",\r\n\r\n\r\n}", "language": "json" }, { "id": "ZhU-IX53oNPcu7rTsSn1n", "code": "", "language": "none" } ], "selectedLanguageId": "npeO0usSroLpgszC5fpHh" }, "description": "Create a task on a file", "currentNewParameter": { "label": "Body Parameter", "value": "bodyDataParameters" }, "autoGeneratedAnchorSlug": "create-tasks", "legacyHash": "qY7HAGpZETj9t2-9xMoY7" } ``` ::: :::ApiMethodV2 ```json { "tab": "examples", "url": "https://localhost:82/scrud/createTask", "name": "Create Tasks", "method": "POST", "request": { "pathParameters": [], "queryParameters": [], "headerParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "id", "type": "string", "description": "Unique id of box file or folder." }, { "kind": "required", "name": "type", "type": "string", "description": "Name of metadata template in box." }, { "kind": "required", "name": "selectedCMS", "type": "string", "description": "Value should always be set to \"box\" to let Link Enterprise know which configured content system to search." }, { "kind": "required", "name": "body", "type": "Array", "description": "Json Array of strings (each index being a seperate line). \n\nOr can take a single string value \"singleLineExample\"" }, { "kind": "required", "name": "dueDate", "type": "string", "description": "Date the task is due\n\n2100-12-31 (YYYY-MM-DD)\n" }, { "kind": "required", "name": "recipients", "type": "Array", "description": "Array of strings of recipients of the task (email id)\n\n*User may require permissions to file before being able to be assigned a task." } ], "formDataParameters": [] }, "results": { "languages": [ { "id": "qNYNaQPOhJ1UW-zegaFJ6", "code": "", "language": "100" }, { "id": "FRMYak2F3gPEAHrtkDAvt", "code": "", "language": "500" } ], "selectedLanguageId": "qNYNaQPOhJ1UW-zegaFJ6" }, "examples": { "languages": [ { "id": "npeO0usSroLpgszC5fpHh", "code": "{\r\n \"cmsName\":\"insertProductionSystemName (located in Link Enterprise gui)\",\r\n \"id\": \"insert box file id\",\r\n\t\"taskType\":\"insert Task type (described in params)\",\r\n\t\"recipients\":\r\n [\r\n \"admin@gimmal.com\",\r\n \t \"admin2@gimmal.com\"\r\n ],\r\n\t\"body\": [\r\n \"Hi\",\r\n \t \"Thank you.\"\r\n ],\r\n\t\"dueDate\":\"2021-12-30\", \r\n \"selectedCMS\":\"box\",\r\n\r\n\r\n}", "language": "json" }, { "id": "ZhU-IX53oNPcu7rTsSn1n", "code": "", "language": "none" } ], "selectedLanguageId": "npeO0usSroLpgszC5fpHh" }, "description": "Create a task on a file", "currentNewParameter": { "label": "Body Parameter", "value": "bodyDataParameters" }, "autoGeneratedAnchorSlug": "create-tasks-1", "legacyHash": "8Ulfr4LyHjkK0bR5Eq25B" } ``` ::: [title] Follow up Security Tasks [path] Repository Specific Guides/Link Enterprise for S3/Installation and Base Configuration Guide/ Albeit not required for initial installation and configuration, in almost all scenarios viewing of attachment from SAP will be required. For this to occur, standard SAP authorization will be checked and therefore will need to be added to the user profiles at some point in the future. This is a heads up (as we know SAP Security does not like surprises ☺ ) that depending on what is implemented for document types (and you may already be utilizing ArchiveLink currently), the access to object S\_WFAR\_OBJ will need to be granted. Below is an overview of the elements involved:  | **Setting** | **Description** | **Sample Value(s) ** | | ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- | | OAARCHIV  | Content Repository  | \* 
Z1  | | | You can use the wildcard (\*) configuration entry here or you can restrict permissions to a particular ArchiveLink repository or set of ArchiveLink repositories. | ZA | | OADOKUMENT 
| Document Type 

You can use the wildcard (\*) configuration entry here or you can restrict permissions to a particular business object or set of business objects.  | \* 
ZAPINV01  | | OAOBJEKTE 

| Object Type 

You can use the wildcard (\*) configuration entry here or you can restrict permissions to a particular ArchiveLink document type or set of ArchiveLink document types.  | \* 
BKPF 
BUS2014 
| | ACTVT 
| Activity 

01 for creating attachments 
03 for displaying attachments
06 for deleting attachment links  | \* 
01,03,06 

Typically, 01 & 03 is granted only  | [title] Follow up Middleware Team Tasks [path] Repository Specific Guides/Link Enterprise for S3/Installation and Base Configuration Guide/ This section contains any follow up tasks for the middleware teams. Any changes requires the Windows service must be restarted for changed to take effect. [title] Changing Config.properties [path] Repository Specific Guides/Link Enterprise for S3/Installation and Base Configuration Guide/Follow up Middleware Team Tasks/ The Config.properties file is a text file that is found under the config directory in the installation folder. This text file contains advanced settings that are only to be configured by Gimmal Link Enterprise administrators since some of the settings can break Gimmal Link Enterprise functionality. Some of the important information found in the Config.properties file is mentioned below.  | **Setting** | **Description** | **Sample Value ** | | --------------------------------------- | ------------------------------------------------------------------------------------------------------- | ---------------------------------------- | | version  | The version of the Enterprise Connector  | 6.0 
| | jco.client.poolcount  | The number of JCO connections to keep in the JCO client pool count  | 4 | | jco.saplink.client.poolcount  | The number of JCO connections to keep in the JCO client pool count for SAPLink processing  | 6 | | sap.client.saplink.function  | SAP BAPI name used in processing  | /DFLOW/ZCMSSAPLINK\_V1  | | sap.client.softlink.function  | SAP BAPI name used in processing  | /DFLOW/ZCMSSAPLINK\_V1  | | sap.client.backpop.function  | SAP BAPI name used in processing  | /DFLOW/ZCMSSAPLINK\_V1 
| | sap.client.auditlink.function  | SAP BAPI name used in processing  | /DFLOW/ZCMSSAPLINK\_V1  | | sap.server.softlink.function  | SAP BAPI name used in processing  | /DFLOW/ZJCOSERV\_001 
| | sap.server.backpop.function  | SAP BAPI name used in processing  | /DFLOW/ZJCOSERV\_001  | | sap.server.auditlink.function  | SAP BAPI name used in processing  | /DFLOW/ZJCOSERV\_001 
| | sap.server.email.function  | SAP BAPI name used in processing  | /DFLOW/ZJCOSERV\_002 
| | sap.server.read.function  | SAP BAPI name used in processing  | /DFLOW/ZCMS\_API\_READ\_V1  | | sap.server.search.function  | SAP BAPI name used in processing | /DFLOW/ZCMS\_API\_SEARCH\_V1 
| | sap.server.search.V2.function  | SAP BAPI name used in processing  | /DFLOW/ZCMS\_API\_SEARCH\_V2  | | sap.server.create.function  | SAP BAPI name used in processing  | /DFLOW/ZCMS\_API\_CREATE\_V1 
| | sap.server.update.function  | SAP BAPI name used in processing  | /DFLOW/ZCMS\_API\_UPDATE\_V1 
| | sap.server.delete.function  | SAP BAPI name used in processing  | /DFLOW/ZCMS\_API\_DELETE\_V1 
| | sap.server.typesAndProperties.function  | SAP BAPI name used in processing  | /DFLOW/ZCMS\_API\_LOAD\_TANDP\_V1  | | sap.server.repositories.function  | SAP BAPI name used in processing  | /DFLOW/ZCMS\_API\_LOAD\_REPOS\_V1 
| | sap.server.metadata.function  | SAP BAPI name used in processing  | /DFLOW/ZCMS\_API\_LOAD\_META\_V1 
| | sap.server.choicelist.function  | SAP BAPI name used in processing  | /DFLOW/ZCMSCREATECHOICELIST\_V1 
| | sap.server.filenetPing.function  | SAP BAPI name used in processing | /DFLOW/ZCMS\_API\_PING\_CMS\_V1 
| | sap.server.middlewarePing.function  | SAP BAPI name used in processing  | /DFLOW/ZCMS\_API\_PING\_MID\_V1 
| | sap.client.saplink2.function  | SAP BAPI name used in processing  | /DFLOW/ZDOCMANAGER\_SAPLINK\_V2 
| | saplink.dateTime.format  | The date and time format to use when sending SAPLink information to SAP  | MM/dd/yyyy hh\:mm\:ss a z 
| | content.pem.file  | The private certificate to use when configuring SSL communication with the Gimmal Link Content Server.  | gimmal\_private\_key\_pkcs8.pem  | | content.cer.file  | The public certificate to use when configuring SSL communication with the Gimmal Link Content Server.  | gimmal\_public.cer  | [title] Follow up S3 Team Tasks [path] Repository Specific Guides/Link Enterprise for S3/Installation and Base Configuration Guide/ This section contains any follow up tasks for the S3 team. [title] Adding SAP JCO logging information to any windows service [path] Repository Specific Guides/Link Enterprise for S3/Installation and Base Configuration Guide/Follow up Middleware Team Tasks/ In order for additional JCO logging to take place it may be necessary to adjust the configuration for the Windows service. Open the Gimmal Link Enterprise Service configuration by clicking on the “Gimmal Service” application in the Gimmal program group (Optionally you can double click on the gimmal.exe application found under the service folder in the installation directory) Click on the “Java” tab and scroll the “Java Options:” window all the way to the bottom. There will be two lines that determine where the JCO logs will go (jco.trace\_path) and the amount of logging to perform (jco.trace\_level). For more information on the trace level refer to SAP JCO documentation. For this example the setting of 10 gives complete logging information. For that reason it is best to leave this additional logging only enabled when needed to better understand a JCO communication error with SAP and not leave it enabled in a production environment.  -Djco.trace\_path="\\logs\\"  -Djco.trace\_level=10  [title] CMS_API_READ [path] Agnostic Guides/Developers Guide/Untitled/ | **Functionality ** | **Description** | **FileNet Notes ** | **Documentum Notes**  | **Box Notes ** | **M365/SharePoint Notes ** | | ------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- | ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | IV\_CMSPROFILE  | Required: Determines which configured CMS Profile in Enterprise SAP to utilize. Combination of CMS Profile and CMS Tag determine the API destination and thus load across an RFC destination.  | | | | | |  IV\_CMSTAG 



| Required: Determine which configured CMS Profile in Enterprise SAP to utilize. Combination of CMS Profile and CMS Tag determine the API destination and thus load across an RFC destination.  | | | | | | IV\_REPOSITORY 

| Required: Determines which configured repository in Link Enterprise SAP to utilize  | Object Store 
| Docbase 

| Default is the only Store/Repository supported since Box currently doesn’t support the notion of different repositories.  | Site, site collection  | | IV\_TYPE 
| Optional: what CMS type to create.  | DOCUMENT CLASS  | OBJECT TYPE  | METADATA TEMPLATE  | CONTENT TYPE 
| | IV\_USE\_MAPPING  | Optional: use mapping of IV\_TYPE to CMS type in Enterprise Connector if CMS. Used if ArchiveLink doctype name to CMS type mapping is required.  | | | | | | IV\_ID  | Optional: id to use for versioning a document. When specified a new version of the existing id is created with the given content.  | GUID 



| r\_object\_id 



| id 



| Versioning not supported 



| | IV\_CHECKOUT | Optional: allows you to checkout a document.  | Only available in newer versions.  | Only available in newer versions. 
| | Not supported 

| | IV\_GET\_CONTENT  | Optional: Indicates whether to pass the content of the document back in table ET\_CONTENT\_MULTI  | | | | | | IV\_LOCATION  | Optional: (Mandatory for M365/SharePoin to only and not used in any other CMS system) Specified where to read the document from.  | Not utilized 



| Not utilized 



| Not utilized 



| This is required and is the Document Library. For documents created by Link Enterprise, this is stored at the time of create in a Link Enterprise table in the scenario that the config changes and thus can be used for subsequent reads.  | | IT\_METADATA\_FILTER  | If specified, only metadata properties indicated will be returned. By default of no filter is provided, all metadata for a document is retrieved.  | | | | | | ET\_METADATA  | Contains the metadata retrieved.  | | | | | | ET\_FILES  | Table containing the filename, size, and mime-type of the files retrieved if get content is enabled.  | | | | | | ET\_RETURN  | Table that indicates a success of an error. The TYPE field will contain an ‘S’ or ‘E’ respectively and the MESSAGE field will contain information in the case of an error.  | | | | | | CT\_CUSTOM  | Future use  | | | | | General FileNet comments:  - For performance considerations it’s best to limit the read to the particular metadata that is necessary for processing and not retrieve all of the available metadata. ## General Documentum comments:  - For performance considerations it’s best to limit the read to the particular metadata that is necessary for processing and not retrieve all of the available metadata. ## General Box comments:  - For performance considerations it’s best to limit the read to the particular metadata that is necessary for processing and not retrieve all of the available metadata. - Currently VersionSeries isn’t supported with Box since there is currently no unique id that represents all versions of a document. - FoldersFiledIn only returns the parent folder for a Box document. Example Link Enterprise has a test hardness that is located under the API Gateway. You can choose to either: 1. Single click on a gateway entry and choose the menu path Execute->Read Again. This will populate values into the test harness from the line you have selected 2. Choose the the menu path Execute->Read New. This provide a blank test harness. To set a break-point to see how this call is executed, the program the test harness uses for READ is: Program SE38: /DFLOW/ZCMSAPI\_READ\_01 Below is a sample call: ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/NrcB7kGZUUhV6tpvjTMlI_image.png" size="68" width="698" height="530" position="flex-start" showCaption="false"} [title] Adjusting log4j logging [path] Repository Specific Guides/Link Enterprise for S3/Installation and Base Configuration Guide/Follow up Middleware Team Tasks/ The Windows service can have what is logged adjusted by adjusting the log4j configuration files. These configuration files work in conjunction with a logging utility called log4j which is well documented online. The configuration files (found under the config directory in the installation folder):  log4j2-gimmal.xml (The Gimmal Link Enterprise Windows service log configuration)  Using your preferred text editor you can go in and adjust these configuration files to increase logging as well as change how the log files look. Once the changes have been made make sure to either restart the profile wizard or the Windows service so that the changes can take affect. Please refer to log4j information online for assistance in changing the format of these configuration files.  [title] Uninstalling the Enterprise Connector [path] Repository Specific Guides/Link Enterprise for S3/Installation and Base Configuration Guide/Follow up Middleware Team Tasks/ 1. In order to uninstall the Enterprise Connector we recommend that you first stop the Windows service by either using the “Administrative Tools” “Services” option under the “Control Panel” or by using the “Gimmal Link Enterprise Service” configuration found in the Gimmal program group. 2. Once the service has been stopped you will need to uninstall the service by running the “uninstallService.bat” script found in the “service” directory found under the installation folder. Verify that the service was truly removed from the list of services. If for some reason the service isn’t removed you can run “SC DELETE Gimmal Link” from a DOS command prompt window” 3. Once the service has been removed you can run the uninstaller found in the “Uninstaller” directory under the installation folder. Double clicking on the uninstaller.jar file will then walk you through uninstalling the Gimmal Link Enterprise Connector. Note: The uninstaller may not be able to delete some of the files and folders that were created so additional cleanup may have to be done manually for the installation location. If you have any problems uninstalling the Gimmal Link Enterprise Connector please don’t hesitate to speak to your system administrator or a Gimmal support team member.  [title] Link Enterprise SCRUD Web Services [path] Agnostic Guides/Developers Guide/ [title] Classification [path] Agnostic Guides/Solution Guide/Untitled/Untitled/ ## Overview Classification of your invoices allows you to configure the rest of the Gimmal Link Enterprise AP Workflow accordingly. This include: 1. Rule processing options such as auto-create, auto-post, etc 2. Approval levels 3. Agent Determination 4. Agent Load Balancing 5. Applicable Manual and Auto Exceptions 6. Prioritization Further more, classification of invoices provides you many more options when working within Gimmal Link Enterprise TrackLink for: 1. Inbox Work-item queue management 2. Load Balancing 3. Sorting 4. Filtering 5. Prioritization 6. Searching In additional, for Gimmal Link Enterprise Statistics as well as your own, classification can provide further options for analysis. Each tier of classification is optional, and you can also created additional custom tiers if you need. Each tier can be logically associated with additional tiers to create a hierarchal structure, but this is optional as well. ## Classification Sources In order for classification to be functional, the values of the classification have to come from somewhere. These typically come from the below scenarios but again this is flexible to suite your AP process and business: 1. Metadata from the time of invoice capture / ingestion - direct values 2. Metadata from the time of invoice capture / ingestion - derived values based on business logic 3. Values within SAP based on business logic and metadata from 1. and 2. above 4. Values obtained only after the creation of an invoice `Values of classification are completely for your purpose only, and each tier can represent whatever you wish them to represent, with each tier being optional ` Classification tiers that come with Gimmal Link Enterprise are: ## Document Type This represent the ArchiveLink Document Type determine by the configuration of Gimmal Link Enterprise DocManager which receives the inbound to SAP request from you content management system. The document type (not accounting document type) is the highest overall classification of an invoice. Companies often just have 1 document type. *This is the minimum classification you must have for the and is already built into the Gimmal Link system.* Note: Document type determine who can view images attached to invoices (outside of the Gimmal Link AP workflow). If you require certain invoices to have different security requirements, consider implementing more document types. ## Locations Location typically represent geographical regions. ## Invoice Categories Invoice categories are the highest level of invoice specific classification. Some common examples are: Commercial Critical Standard Request for Funds Confidential ## Business Units Business Units and Departments can also be used stand alone or with a relationship to Location, Invoice Categories, or each other. ## Departments Business Units and Departments can also be used stand alone or with a relationship to Location, Invoice Categories, or each other. ## Invoice Flags Invoice Flags tend to be very granular in nature and typically identify a very specific instance of an invoice that requires "special" processing along its lifecycle. Whether that be high priority processing from the AP team such as Early Pay Discounts to an Auto Exception such as Admin Kick-out. ## Invoice Types Invoice Types are pre-built in Gimmal Link Enterprise and consist of: - PO - NON-PO Gimmal Link determines this as to whether there is a PO number at time of capture/ingestion *or * based on which type of invoice is chosen to be created by the system or the Initial AP team. Invoice Type is the minimum an invoice can be classified as. ## Workflow Container Names In the Workflow Trigger metadata mapping (or your customizing options), below are the corresponding workflow container names (must be upper case): ZAR\_OBJECT ZLOCATION ZINVOICECATEGORY ZBUSINESSUNIT ZDEPARTMENT ZINVOICEFLAG ZINVOICETYPE ## Customizing Options The following customizing options are available for Invoice Processing. For information on how to implement, please refer to the section "Customizing" later in this document. 1. **Custom Invoice Classification: **To manipulate the Classification for an invoice. [title] DocManager Inbound Processing [path] Agnostic Guides/Developers Guide/Untitled/ In your CMS system, the property configured to be polled for as the indicator whether a document should be processed/call SAP (referred to as the Gimmal Link Enterprise SAPLink Trigger property or filter), when found, will trigger a call to the Gimmal Link Enterprise SAP gateway BAPI at a configured interval.  The DocManager Inbound Processing class/method allows you to either:  1. Custom: Execute your own custom process entirely or in combination with any other DocManager configured option mentioned above 2. Link Create: Optionally manipulate all exporting and changing method parameters for subsequent DocManager configured Create Link processing (called after Custom if configured). Primarily this is used to find/confirm/format/compile/specify the “SAPKey” for what SAP record to link to. # Example Method: /DFLOW/CL\_DOCMANAGER\_HELPER=>SAPLINK\_EXAMPLE  *The below example is provided with the *Gimmal Link* product.* Signature:  | **Type** | **Parameter** | **Description** | **Sample Value** | | ------------------------ | ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------- | | Importing** ** | IV\_MODE 



| This class/method is shared in the Gimmal Link Enterprise configuration for both “types” of processing (custom vs. SAP Key determination). Which processing is being executed by Gimmal Link Enterprise configuration is indicated by this value.  | SAPKEY or CUSTOM 



| | Importing | IV\_DOCUMENTID 
| The CMS unique identifier (ie: UUID/GUID)  | 485029877609 
| | Exporting  | EV\_GOON\_FLAG 
| CUSTOM processing only: setting the goon flag to ABAP\_TRUE (ie: X)  | ABAP\_FALSE or empty vs. ABAP\_TRUE (X) 
| | Exporting | ET\_RETURN 
| Anything other than a line added with the value ‘E’ in the TYPE field (ie: any line with S or I or W as a TYPE) will result in the Gimmal Link middleware considering the process a success and the inbound request will be set to complete (ie: the SAPLInk “trigger” property set to false and will NOT be reprocessed). If a line in the table with the value ‘E’ in the TYPE field is found, the entry in the CMS system will be reprocessed at the next interval. Regardless of the TYPE value, all entries added to this table will be logged and viewable in the Gimmal Link Enterprise API Gateway and thus can be leverage to log/report on the processing of your logic using any fields of the table (Message Text being the most common)  | | | Exporting | EV\_SAPKEY 

| Used extensively in Link Enterprise Create, this is the fully formatted SAPKey that will be used to create the ArchiveLink Link  | FI Invoice: 300019000002222019 Vendor Master: 0000033985 
| | Exporting  | EV\_GUID 


| Used only in CRM: this is the GUID that will be used in place of EV\_SAPKEY to generate the viewing URL to link  | | | Changing  | CT\_METADATA 



| This table contains the metadata from your CMS system (what is sent over to SAP is determined by the Gimmal Link Enterprise middleware configuration for Inbound Processing metadata). 

This table it not typically changed, but rather read to leverage the metadata from your CMS system to either execute a custom process or in the case of Link Create, determine the EV\_SAPKEY. This might be to take different metadata fields and do a lookup to get a key, or maybe simply formatting the key to be padded so ArchiveLink will recognize it, or possible to verify the incoming key is correct (and if not, add an E type line to the return table). 

The values of this table can be viewed under the “SMD” (SAPLink Metadata) column in the Gimmal Link Enterprise API Gateway.  | | | Changing  | CT\_FILES  | Table containing the CMS inbound files related to the triggering of the SAPLink process.  | | | Changing  | CT\_CUSTOM  | For future use.  | | | Changing  | CS\_ZDMC01  | Table containing the existing DocManager configuration.  | | | Changing  | CS\_ZCMSC05  | Table containing the existing Repository ID configuration.  | | | Changing  | CS\_ZCMSC01  | Table containing the existing CMS Profile configuration.  | | Notes:  - Custom processing is executed first, follow by Link Create (SAPKey) processing ‘2nd’ (if no goon flag is received). - Any exporting or changing parameter values manipulated by Custom processing will be passed on to Link Create (SAPKey) processing. [title] System Messages [path] Agnostic Guides/Solution Guide/ System messages prevent or inform/warn users and API usage when needed during downtime or critical changes across the Gimmal Link Enterprise platform. Examples of this may include: 1. When there is an issue storing documents to the backend content repository and you wish to inform the users to take a chill pill rather than create an abundance of help desk tickets 2. You are in the middle of making a change to production that requires a temporary hands off 3. The content management system is undergoing maintenance and a particular interface that uses the Gimmal Link Enterprise SCRUD API needs to stop processing temporarily There are two types of system messages (see below for the "Message Type"): "E" - stops processing and informs the user/process "I" - informs the user/process but continues processing For user based Gimmal Link Enterprise processing, such as Store New and Assing (ie: GOS menu based document storage and linking), the message (regardless of type I or E) will be displayed to the end user and will also will be added to the return table in the Gimmal Link Enterprise API gateway. For API or background based Gimmal Link Enterprise processing, such as SCRUD usage, the message (regardless of type I or E) will be added to the return table in the Gimmal Link Enterprise API gateway. To create a System Message, enter transaction /dflow/sys and choose the menu path Configure->System Messages. | Setting | Description | Sample Value(s) | | ------------------- | ------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------- | | API Source | The particular type of processing that needs to have a message displayed on. | DocManager: Store New and Assign | | CMS Profile | The content management system profile associated with this particular message | \ | | CMS Use Tag | The content management system use tag associated with this particular message. | \ | | API Type | Optional API type of call that you wish the message to be associated with. |   | | Enable/Disable | If enabled this message will be displayed to users utilizing the associated processing tied to this message. | | | Message Type | The type of message which can be just informational or an error which will restrict further processing. | Information | | Message Text | The first line of text to display to the user. | We are currently experiencing a network slowdown. | | Message Text | The second line of text to display to the user. |  Please be patient! | | Message Text | The third line of text to display to the user. |   | | En. Verbose Logging | If enabled additional logging will be added to the gateway dashboard logging. Note this has a small hit to performance. | | [title] Create [path] Agnostic Guides/Developers Guide/FileNet Endpoints/ Link Enterprise provides a web service endpoint that will allow you to create a document. The following endpoint allows the following capabilities. 1. Create a File 2. Create a File with metadata :::ApiMethodV2 ```json { "tab": "examples", "url": "https://localhost:82/scrud/create", "name": "Create a File", "method": "POST", "request": { "pathParameters": [], "queryParameters": [], "headerParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "selectedCMS", "type": "string", "description": "Value should always be set to \"filenet\" to let Link Enterprise know which configured content system to search." }, { "kind": "required", "name": "cmsName", "type": "string", "description": "Name of the filenet system configured in docuflow." }, { "name": "fileLocation", "kind": "required", "type": "string", "description": "file location in local system that needs to be stored in filenet.", "children": [] }, { "name": "repository", "kind": "required", "type": "string", "description": "filenet repository Value", "children": [] }, { "name": "location", "kind": "required", "type": "string", "description": "filenet folder where the document need to be created.", "children": [] }, { "name": "domain", "kind": "required", "type": "string", "description": "Filenet Domain name", "children": [] }, { "name": "checkout", "kind": "optional", "type": "string", "description": "If true, Enables file checkout ", "children": [] }, { "name": "dateTimeFormat", "kind": "required", "type": "string", "description": "Update datetime property in this provided format. ", "children": [] }, { "name": "checkinAsMinor", "kind": "optional", "type": "string", "description": "If true, The document is checkedIn as minor.", "children": [] }, { "name": "findCurrent", "kind": "optional", "type": "string", "description": "Enable to search for the latest version of Document.", "children": [] } ], "formDataParameters": [] }, "results": { "languages": [ { "id": "VzFOzYGCxsoPbWzdx0yew", "code": "{\n\t\"docId\": [\n\t\t\"{18CFCD6C-FFBF-CC9C-8780-89272DA000}\",\n\t\tnull,\n\t\tnull\n\t]\n}", "language": "200" }, { "id": "VQkVXQFKVKg-X3yyvKCWC", "code": "", "language": "500" } ], "selectedLanguageId": "VzFOzYGCxsoPbWzdx0yew" }, "examples": { "languages": [ { "id": "CXPum3DlkEh5CtlxE_mJB", "code": "{\n \"cmsName\":\"Name of the filenet system configured in Link Enterpri.\", \n \"repository\":\"Filenet_Repository\",\n \"selectedCMS\":\"filenet\",\n \"domain\":\"Domain_Name\",\n\t\"checkout\":false,\n\t\"dateTimeFormat\":\"MM/dd/yyyy hh:mm:ss a z\",\n \"fileLocation\":\"C:\\\\someFolder\\\\someFile.txt\",\n \"selectedCMS\":\"filenet\",\n\t\"checkinAsMinor\":false,\n\t\"findCurrent\":false,\n\t\"location\":\"/folderName\"\n}", "language": "json" } ], "selectedLanguageId": "CXPum3DlkEh5CtlxE_mJB" }, "description": "Create a file with no metadata", "currentNewParameter": { "label": "Body Parameter", "value": "bodyDataParameters" }, "autoGeneratedAnchorSlug": "create-a-file", "legacyHash": "LTZYKRF4XjDFS4dN8yyEx" } ``` ::: :::ApiMethodV2 ```json { "tab": "examples", "url": "http://localhost:82/scrud/create", "name": "Create a File (metadata)", "method": "POST", "request": { "pathParameters": [], "queryParameters": [], "headerParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "selectedCMS", "type": "string", "description": "Value should always be set to \"filenet\" to let Link Enterprise know which configured content system to search." }, { "kind": "required", "name": "cmsName", "type": "string", "description": "Name of the filenet system configured in docuflow." }, { "kind": "required", "name": "mdArray", "type": "Array", "description": "A JSON array where each index is a json object with the keys \"md1\" and \"md2\". Where md1 is the column name, and md2 is the value to be inserted in that column." }, { "name": "fileLocation", "kind": "required", "type": "string", "description": "file location in local system that needs to be stored in filenet.", "children": [] }, { "name": "location", "kind": "optional", "type": "string", "description": "filenet folder where the document need to be created.", "children": [] }, { "name": "repository", "kind": "required", "type": "string", "description": "filenet repository Value", "children": [] }, { "name": "domain", "kind": "required", "type": "string", "description": "Filenet Domain name", "children": [] }, { "name": "type", "kind": "optional", "type": "string", "description": "Filenet Class name attached to the document. Default is \"Document\"", "children": [] }, { "name": "checkinAsMinor", "kind": "optional", "type": "string", "description": "If true, The document is checkedIn as minor.", "children": [] }, { "name": "findCurrent", "kind": "optional", "type": "string", "description": "Enable to search for the latest version of Document.", "children": [] } ], "formDataParameters": [] }, "results": { "languages": [ { "id": "0iMkCF4s-yKchRAaXWJq3", "code": "{\n\t\"docId\": [\n\t\t\"{18CFCD6C-FFBF-CC9C-8780-89272DA00}\",\n\t\tnull,\n\t\tnull\n\t]\n}", "language": "200" }, { "id": "Idjmyl-woaWfo4s5K3_bg", "code": "", "language": "500" } ], "selectedLanguageId": "0iMkCF4s-yKchRAaXWJq3" }, "examples": { "languages": [ { "id": "YYkmw0EaCT-jCk9-cGJJs", "code": "{\n \"cmsName\":\"Name of the sharepoint system configured in Link Enterpri.\", \n \"repository\":\"Filenet_Repository\",\n \"selectedCMS\":\"filenet\",\n \"domain\":\"Domain_Name\",\n\t\"checkout\":false,\n\t\"dateTimeFormat\":\"MM/dd/yyyy hh:mm:ss a z\",\n \"fileLocation\":\"C:\\\\someFolder\\\\someFile.txt\",\n \"selectedCMS\":\"filenet\",\n \"type\":\"MetadataClassName\",\n\t\"checkinAsMinor\":false,\n\t\"findCurrent\":false,\n\t\"location\":\"/folderName\",\n\t\"mdArray\":[\n\t{\"md1\": \"metadataField\", \"md2\": \"metadataValue\"}]\n}", "language": "json" } ], "selectedLanguageId": "YYkmw0EaCT-jCk9-cGJJs" }, "description": "Create a file with metadata", "currentNewParameter": { "label": "Body Parameter", "value": "bodyDataParameters" }, "autoGeneratedAnchorSlug": "create-a-file-metadata", "legacyHash": "jwu3C_6nkyZkTjqhuztuj" } ``` ::: [title] Search [path] Agnostic Guides/Developers Guide/Box Endpoints/ Link Enterprise provides a web service endpoint that will allow you to retrieve a subset of documents/folders based on a search criteria. Link Enterprise supports two types of search within box. One using metadata filters and another using metadata queries (real-time). To enable or disable metadata queries (real-time search) you can do so within the Link Enterprise configurator interface. We are providing below an example of both a metadata filter example (with search query disabled in the configurator), and a metadata query example (with search query enabled in the configurator). :::ApiMethodV2 ```json { "tab": "examples", "url": "https://localhost:82/scrud/search", "name": "Search (query)", "method": "POST", "request": { "pathParameters": [], "queryParameters": [], "headerParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "cmsName", "type": "String", "description": "Name of the box system configured in Link Enterprise ." }, { "kind": "required", "name": "whereClause", "type": "string", "description": "A where clause (JSON in string form). Used to query box to return a set of files/folders depending on criteria set." }, { "kind": "required", "name": "selectedCMS", "type": "string", "description": "Value should always be set to \"box\" to let Link Enterprise know which configured content system to search." } ], "formDataParameters": [] }, "results": { "languages": [ { "id": "l7mAccvIkcMGyR03J3_aP", "code": "[\n\t{\n\t\t\"name\": \"check\",\n\t\t\"id\": \"895736641171\",\n\t\t\"type\": \"file\"\n\t},\n\t{\n\t\t\"name\": \"demo1.txt\",\n\t\t\"id\": \"897859484481\",\n\t\t\"type\": \"file\"\n\t}\n]", "language": "200" }, { "id": "C0tj4vmrgrTV7Xq8ZvvAu", "code": "", "language": "500" } ], "selectedLanguageId": "l7mAccvIkcMGyR03J3_aP" }, "examples": { "languages": [ { "id": "RinXZo0WaAz3lEkUOH2ux", "code": "{\r\n \"cmsName\":\"insertProductionSystemName (located in Link Enterprise gui)\",\r\n \"whereClause\":\"{\\\"from\\\":\\\"enterprise_InsertEnterpriseId.insertMetaDataTemplate\\\",\\\"query\\\":\\\"insertMetaDataColumnName = :value\\\",\\\"query_params\\\":{\\\"value\\\":\\\"insertMetaDataValue\\\"},\\\"ancestor_folder_id\\\":\\\"insertFolderId\\\"}\",\r\n \"selectedCMS\":\"box\"\r\n}\r\n\r\n", "language": "json" } ], "selectedLanguageId": "RinXZo0WaAz3lEkUOH2ux" }, "description": "Search for all documents using a where clause. If succesfull will return a JSON Array with a size greater then or equal to zero with status code of 200. Otherwise status code 500 is returned.\n\nPrecondition: insertName.searchQueryEnabled=true (located in inifile)", "currentNewParameter": { "label": "Body Parameter", "value": "bodyDataParameters" }, "autoGeneratedAnchorSlug": "search-query", "legacyHash": "2I1lkUo-tBmvDr0MrlixB" } ``` ::: :::ApiMethodV2 ```json { "tab": "examples", "url": "https://localhost:82/scrud/search", "name": "Search (mdfilters)", "method": "POST", "request": { "pathParameters": [], "queryParameters": [], "headerParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "cmsName", "type": "string", "description": "Name of the box system configured in Link Enterprise ." }, { "kind": "optional", "name": "whereClause", "type": "string", "description": "A where clause (JSON in string form). Used to query box to return a set of files/folders depending on criteria set." }, { "kind": "optional", "name": "selectedCMS", "type": "string", "description": "Value should always be set to \"box\" to let Link Enterprise know which configured content system to search." } ], "formDataParameters": [] }, "results": { "languages": [ { "id": "fGXdotBZMqjtdKDUmY0WT", "code": "[\n\t{\n\t\t\"name\": \"check\",\n\t\t\"id\": \"895736641171\",\n\t\t\"type\": \"file\"\n\t},\n\t{\n\t\t\"name\": \"demo1.txt\",\n\t\t\"id\": \"897859484481\",\n\t\t\"type\": \"file\"\n\t},\n\t{\n\t\t\"name\": \"Cataray.pdf\",\n\t\t\"id\": \"901051603311\",\n\t\t\"type\": \"file\"\n\t},\n\t{\n\t\t\"name\": \"Version3.pdf\",\n\t\t\"id\": \"901048740163\",\n\t\t\"type\": \"file\"\n\t},\n\t{\n\t\t\"name\": \"TEST XLS.xls\",\n\t\t\"id\": \"900741822394\",\n\t\t\"type\": \"file\"\n\t},\n\t{\n\t\t\"name\": \"TEST HTM.htm\",\n\t\t\"id\": \"900747633313\",\n\t\t\"type\": \"file\"\n\t},\n\t{\n\t\t\"name\": \"TEST GIF.gif\",\n\t\t\"id\": \"900747915499\",\n\t\t\"type\": \"file\"\n\t}\n]", "language": "200" }, { "id": "J0Ifgft2wz-db1qWGif2B", "code": "", "language": "500" } ], "selectedLanguageId": "fGXdotBZMqjtdKDUmY0WT" }, "examples": { "languages": [ { "id": "jGF6SQdzbwLQ6_z9ZiwPF", "code": "{\r\n \"cmsName\":\"insertProductionSystemName (located in Link Enterprise gui)\",\r\n\t \"whereClause\":\"mdfilters=[{\\\"templateKey\\\":\\\"insertMetaDataTemplateName\\\",\\\"scope\\\":\\\"enterprise\\\",\\\"filters\\\":{\\\"insertMetaDataColumnName\\\":\\\"insertMetaDataValue\\\"}}]\",\r\n \"selectedCMS\":\"box\"\r\n}\r\n\r\n", "language": "json", "customLabel": "JSON" } ], "selectedLanguageId": "jGF6SQdzbwLQ6_z9ZiwPF" }, "description": "Search for all files/folders using a where clause. If succesfull will return a JSON Array with a size greater then or equal to zero with status code of 200. Otherwise status code 500 is returned.", "currentNewParameter": { "label": "Body Parameter", "value": "bodyDataParameters" }, "autoGeneratedAnchorSlug": "search-mdfilters", "legacyHash": "1XRHrMjsJLILx9kjnW4Vl" } ``` ::: [title] Attachment List Options [path] Agnostic Guides/Solution Guide/DocManager/ Using the Gimmal Link Enterprise Attachment List provides the below additional benefits: 1. Gimmal Link Enterprise Attachment list displays all ArchiveLink Attachments whether they were created via Gimmal Link Enterprise ECM or other content services 2. Allow document storage to both Gimmal Link Enterprise ECM supported CMS system AND non-Gimmal Link Enterprise supported CMS systems (ie: any ArchiveLink endpoint) 3. Gimmal Link Enterprise Virtual Link Manager allows you display links that are not linked to the SAP record you are viewing, but rather linked to an associated SAP record. Instead of implementing a process that duplicates links, you can use Virtual Link Manager to show these links as if they were attached. For example, when viewing a Purchase Order and its attachments, you can also display any attachments that were directly linked to the Goods Receipt. 4. Gimmal Link Enterprise Virtual Link Manager also allows you to manipulate what is shown on the attachment list as a whole: meaning you can hide links, blank out sensitive information, add additional security checks, and so forth. 5. You can choose to display or hide SAP DB Attachments and Notes 6. You can choose to hide particular SAP Object / doctype combinations. This is used often during migrations when for a window of time, you may have duplicate links from the source system as well as the new target system prior to validation and link deletion. 7. For those earlier release systems that do not have table TOAAT implemented, the Gimmal Link Attachment List fills the gap in providing the columns of who created the attachment, time stamp, filename, and extension Regardless of #1 above, the Gimmal Link Enterprise Attachment List provides the full ArchiveLink link record (repository UUID, doctype, etc) 8. Easy "tab" based interface for drag and drop document storage and viewing in one window 9. Consistent interface regardless of windows or java based SAP GUI 10. Allow "Notes" to be created in your external repository instead of your SAP database 11. Supports Viewing attachments by auto-group via classification, document flow, or file extension Gimmal Link Enterprise provides the above functionality config and code free (with the exception of the Virtual Link Manager - refer to the below). **Configuration is located within the Gimmal Link Enterprise System Dashboard (/dflow/sys) and choose the menu path Configure->Services for Object** Below is an overview of the configuration required to enable the Gimmal Link Enterprise DocManager Attachment List: ## SGOSATTR Entries / Utility This utility is in beta and should not be used. Instead, the following entries must be manually created in the table SGOSATTR. These entries enable the Gimmal Link SFO/GOS menu path(s) to be shown (note: the Gimmal Link Enterprise DocManager, Workflow and AuditLink will only be displayed IF that option is *independently and separately *configured for a particular SAP Object), else they will not appear. Below are the entries that must be created in SGOSATTR via transaction SM30 (note this is cross-client): ### Name of service: GIMMALSTOR ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/16wEJ3iV_JRiLAz8oa9I-_image.png) ### Name of service: GIMMALWFM ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/SrlkYHSakrvKOs2xvAsFw_image.png) ### Name of service: GIMMALAUDC ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/pytmLjX9bsiBDmueAM34o_image.png) ## TOAEX Utility Except in the case where a (Gimmal Link Enterprise) Content Server is being used for viewing, an entry in the table TOAEX must be created to allow for Gimmal Link Enterprise to handle viewing request and integrate your web browser. First check whether you have an existing entry in table TOAEX (use transaction SE16 or SE17) under the two exit ID's: 1. OA\_DISPLAYJAVA\_01  2. OA\_OBJECTDISPLAY\_01 If you DO, please consult your development team to work with your Gimmal Link Enterprise implementer to merge your existing logic within those function modules and the Gimmal Link Enterprise function module "/DFLOW/ZUTIL\_TOAEX\_FUNCTION\_01". If you DO NOT have entries in the TOAEX able for the above exits ID's, choose the sub menu path Configure->Services for Object->**TOAEX Utility.** From there simply execute using the “Update Settings” option. If utilizing this method, ensure you execute this in each SAP environment that Gimmal Enterprise Link will be used.  Your TOAEX table should now look like the below for the two exit ID's: | **EXIT ID** | **Status (ACTIVE)**  | **Function Module (EXIT\_FUB) ** | **VALUE ** | | ---------------------------------- | -------------------- | ------------------------------------- | --------------- | | OA\_DISPLAYJAVA\_01** ** | X | /DFLOW/ZUTIL\_TOAEX\_FUNCTION\_01  | | | OA\_OBJECTDISPLAY\_01  | X | /DFLOW/ZUTIL\_TOAEX\_FUNCTION\_01  | | | | | | | ## MENU OPTIONS Below are the menu options for the Gimmal Link Enterprise DocManager Attachment List: ### Object Type This is your SAP Object such as BKPF, BUS2012, etc. This must match the business object for the SAP transaction you are configuration. Note you can also use a wildcard "\*" to set options system wide. You can subsequently add individual SAP Objects that will override the system "\*" wildcard. ### SAP Key1/2/3 Length Specifies the SAP Business Object's key length. Only required if "En. WF TrackLink" or "En. Late WF" is enabled below. For example, vendor numbers are a single key field, and are 10 characters in length for LFA1. Put a 10 in the SAPKey1 Length. For example, vendor numbers at the company code level are a composite key (ie: two fields) for LFB1. 10 characters in length. Put a 10 in the SAPKey1 Length, and 4 in SAPKey2 Length. ### En. Atta.w/ Fold If enabled, the 2nd generation of the Gimmal Link Enterprise DocManager attachment list will be used. This newer version contains the following changes: 1. Supports Viewing attachments by auto-group via classification, Gimmal Link Enterprise flow, or file extension 2. Move the attachment list tab to the first tab, and the "Store" tab to the 2nd position. ### SAP DB Attach If enabled, Attachments stored in the SAP database will be displayed in the attachment list. ### SAP DB Notes If enabled, Notes stored in the SAP database will be displayed in the attachment list. ### Attachments Link Manager If enabled, users will be allowed to delete items from the attachment list leveraging Gimmal Link Enterprise Delete Link Management functionality. Please refer to the section Delete Link Management via Gimmal Link Enterprise Link Manager for more information. ### En. Download If enabled, users will be allowed to download content in the attachment list to their local/network drive. ### En. Cr.Note DB If enabled, users will be allowed to create/store Notes in the SAP database. ### En. Cr.Note GOS If enabled, users will be allowed to create/store Notes in your content repository (stored as .txt files). ### En. AuditLink GOS If enabled, the Gimmal Link Enterprise AuditLink TrackLink option will show on the SFO/GOS menu path. ### En. WF TrackLink If enabled, the Gimmal Link Enterprise TrackLink option will show on SFO/GOS menu path. ### En. Late WF Document Type ## Hiding particular SAP Object / doctype combinations 1. via the Gimmal Link Enterprise System Dashboard (/dflow/sys) choose the menu path Configure->API Rules->Document Manager 2. Create/find the entry for the SAP Object/document type rule. 3. Enable the "Hide Att.List" checkbox: ## Virtual Link Manager Please refer to the Gimmal Link Enterprise Developers Guide on more information on implementing. ## Delete Link Manager Configuration and usage is outlined in the next section. [title] Enabling Store New and Assign / Attachment List Menu Path [path] Agnostic Guides/Solution Guide/DocManager/ For all Store New and Assign (ie: Business Document Storage), or to use the Gimmal Link Enterprise Attachment List for any other purposes, you must add the DocManager menu path to the Services for Object / Global Object Services configuration table via the instructions below: 1. Maintain the table SGOSATTR via SM30 in your development configuration client. Note that this configruation is client independent, but will generate a transport to must be moved with other ArchiveLink and Gimmal Link configuration. 2. Find the entry with the name INFO\_SERVICE and double click to change the entry. 3. Change the field value for "Next Service" to GIMMALSTOR as shown below. Save your entry and green arrow back. 4\. Click the button "New Entries" and create the following entry named "GIMMALSTOR": ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/jwBApDRVXMKC7KJR_eXVB_image.png) \- ensure the class name /DFLOW/CL\_DOCMANAGER is spelled correctly and that the "Commit Required" is enabled! 5\. You must then find a menu item to link it too. The most common entry is the INFOSERVICE, but **it is recommended that you choose the "last" entry in your systems SFO menu list (add as the "Next Service"):** ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/WqXPGRYRrwKN0q-l_jHyt_image.png) 6\. Save your entry and include this transport in your migration to QUAL and PROD list of transports. [title] Required Metadata Properties [path] Agnostic Guides/Solution Guide/DocManager/ Note: you might already have some properties during your Base Installation and Configuration. :::BlockQuote *\*\*\* *It is mandatory that all properties (both ECM and Content Server) be added for any content type/metadata template/document class used for Link Enterprise integration \*\*\* ::: ## ECM Required Metadata Properties These names are suggestions and recommended, but are configurable in the Enterprise Connector. | SharePoint Column (suggested) | Data Type | Attribute Settings | | ----------------------------- | ------------------- | -------------------------------------------------------------------------------------------- | | LinkEnterpriseUsername | single line of text |   | | LinkEnterpriseTimestamp | single line of text |   | | LinkEnterpriseSaplinkTrigger | single line of text | No settings, however - the only values Link Enterprise will recognize are "True" and "False" | | LinkEnterpriseSaplinkError | single line of text |   | ## Content Server Required Metadata Properties :::BlockQuote `*** Please ensure these are EXACT casing as below *****` ::: | SharePoint Column (mandatory) | Data Type | Attribute Setting | | ----------------------------- | --------- | ----------------- | | contRep | Text | | | docID | Text | | | dateC | Text | | | compId | Text | | | pVersion | Text | | | docProt | Text | | | contentLength | Text | | | accessMode | Text | | | charset | Text | | | compStatus | Text | | | sapVersion | Text | | [title] Utilities: Link Maintenance [path] Agnostic Guides/Solution Guide/ Link Maintenance allows a simple tool to maintain ArchiveLink links. This is often used after client refreshes in order to "reset" the links in non-production environments as well. This utility differs from the Attachment List Dashboard in that allows for multiple links to be deleted at one time while the dashboard only allows for one deletion at a time.  To execute Link Maintenance, enter transaction /dflow/sys and choose the menu path Configure->Dashboards->Link Manager->Mass Maintenance. `Make sure to limit the search results by at least a Doctype and Archive ID (required fields) to help narrow down the results.`   This utility can also be run in the background for large processing to be completed in the background to avoid timeout issues with foreground/dialogue processing. | Setting | Description | Sample Value(s) | | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------- | | Test Only | If selected the actual processing of the ArchiveLink entries will only be simulated and not actually run. | | | Production System Override | If selected this allows for ArchiveLink entries to be adjusted in a production environment.   | | | Wipe ArchiveLink Links | If selected the ArchiveLink entries filtered on will be deleted from the underlying ArchiveLink tables. | | | Link Table (eg: TOA01) | The link table to restrict processing on. | TOA01 | | SAP Object | The SAP business object in particular to filter the ArchiveLink entries on. | BUS2014 | | Object ID | A particular unique object id to filter the ArchiveLink entries on.  This unique object id will only be unique to a particular SAP business object so make sure to include additional filter criteria. | 0000000001 | | Archive ID | The ArchiveLink repository to filter the ArchiveLink entries on. | ZC | | CMS ID | The content management system document id in particular to filter the ArchiveLink entries on. | 1232456 | | Doctype | The ArchiveLink document type to filter the ArchiveLink entries on. | ZCONTRACT | | Archive Date | The ArchiveLink archive date to filter the ArchiveLink entries on. | 12/25/2020 | | Reserve | The ArchiveLink reserve entry to filter the ArchiveLink entries on. |   | [title] Approvals [path] Agnostic Guides/Solution Guide/Untitled/Untitled/ ## Overview ## Setup The below configuration is available for Gimmal Link Enterprise AP Workflow Approvals. ### Rejection Codes Setup rejection codes and a descriptive text. These will be available to the approvers to choose when rejecting. ### Role Resolution / Agent Determination Who will receive dialogue (foreground) work-items for Approval is by default configured in the Agent configuration. Refer to the section "Agents" later in this document. ## Customizing Options The following customizing options are available for Approvals. For information on how to implement, please refer to the section "Customizing" later in this document. 1. **Custom ASL Check:** To implement your own ASL check 2. **Custom Workitem Text:** To implement your own Workitem text. 3. **Custom Auto Exceptions:** To implement your Auto Exceptions. 4. **Custom Role Resolution / Agent Determination:** To implement your own logic to determine work-item recipients 5. **Custom Notifications:** To implement your own method of notifying agents. 6. **Custom Pre-Processor Logic: ** Powerful BADI to take control of all pre-processing logic. 7. **Custom Post-Processor Logic:** Powerful BADI to take control of all post-processing logic 8. **Custom POPUP PBO Logic: T**o implement your own changes to the Gimmal Link pop-up windows for processing. 9. **Custom POPUP PAI Logic: **To implement your own logic to the Gimmal Link pop-up windows for processing. [title] Utilities: Metadata Push (MDPro) [path] Agnostic Guides/Solution Guide/ Metadata Push (or MDPro), is a utility that allows you to manually trigger or schedule metadata updates from SAP to your CMS system based on configured DocManager rules. There are two way to execute a metadata push: 1. Directly via the MDPro transaction/menu path and you enter the input criteria to determine what gets pushed 1. To execute MDPro, enter transaction /dflow/sys and choose the menu path Configure->Execute->Metadata Push. 2. From a Gimmal Link Enterprise API Gateway results set, and then "loading" MDPro from that result set. Using the Gimmal Link Enterprise API gateway allows you to use entries in the gateway to populate the input selection screen to MDPro. If entering MDProd directly, leverage the Link Selection to determine which ArchiveLink link entries MDPro will push metadata for. `Note that all MDPro activity is logged in the Gimmal Link API Gateway.` ## Link Selection Use any combination of the standard ArchiveLink link table elements to filter which links you would like to push metadata for ## Action | **Setting** | **Description** | | -------------------------- | ------------------------------------------------------------------------------------------------------- | | Production System Override | Enable this for production environments | | Descriptive Label | Give your "run" a meaningful label. This will assist you in searching the Gimmal Link API Gateway. | | View Only | This does not execute the (U)pdate API call to the content repository. It is equivalent to a test run. | | Push Metadata | This is an actual run that will update the content repository. | ## Gateway Update | **Setting** | **Description** | | ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Update Existing (Slower) | If there are any previous ERROR entries from (U)pdate for a particular SAP object / Object ID / Archive ID / CMS ID / AR Object unique key in the Gimmal Link API gateway, it will be updated to reflect a success. Therefore, you can report on all ERRORS in the gateway for outstanding errors if desired. There is performance overhead with this option. You can always report (via date or label or other criteria) the MDPro run as an alternative. | | No Update (Faster) | This option does not update historical gateway entries. | ## Display Options | **Setting** | **Description** | | ----------------- | ----------------------------------------------------------------- | | Detail ALV | Results are displayed in ALV report format | | Summary Text Only | A simple text summary only is displayed instead of the ALV report | [title] Accounts Payable [path] Agnostic Guides/Solution Guide/ ## Introduction Gimmal Link Enterprise Accounts Payable is an extremely powerful SAP based Invoice Processing and Approval workflow built on the SAP workflow runtime system. Even with its powerful design, the Gimmal Link Enterprise Accounts Payable Workflow is simple and fully configurable to handle all types of invoice processing: from straightforward to complex to fully customized. Compatible with any scanning or ingestion method to your content repository, Gimmal Link Enterprise AP is a powerful and flexible solution to process, track, manage, and automate your accounts payable process - resulting in greater efficiencies and promoting shorter invoice processing times, enhanced exception management, and much more - allowing you to pay invoices faster, easier, and achieve vendor discounts. ## Features Below are some of the Gimmal Link Enterprise AP features: - automatic creation of invoices - data pre-population for manual invoice creating - full integration with your content repository - enhanced exception management - auto posting - built in agent management - multi level approvals inside and outside of SAP (including mobile phone) - ASL integration - built in notifications - leverages your standard SAP screen and functions to ensure 2 and 3 way matching and data validation - back-population of metadata to your content management system along entire invoice lifecycle - deadline monitoring to ensure no invoices stall - powerful and fast searching and tracking of invoices - work queues with powerful sort, filter, and load balancing capabilties - based on the powerful and robust SAP workflow runtime system - a suite to tools to support administrative functionality including year end rollover - supports delegation - works with SAP UWL - fully configurable - code-free implementations - customizable - fast implementation timelines - no SAP workflow in-house skill set required [title] S3 Endpoints [path] Agnostic Guides/Developers Guide/ [title] HTTPS Setup (JKS/PEM) [path] Agnostic Guides/Developers Guide/Link Enterprise SCRUD Web Services/ # PEM/CER To enable Link Enterprise to use the following formats you must add to the ini file **cert.type = pem** under \[General Preferences]. - Do not use encrypted private key **Using a generated private key file in pkcs8 format for the server and place in the config folder of the Link Enterprise instance.** ```Text * Using openssl and your private key this is created by: * openssl pkcs8 -topk8 -inform pem -in your_private_key.pem -outform pem -nocrypt -out your_private_key_pkcs8.pem ``` ** Generating the public certificate for the server. Place in the config folder of the Link Enterprise instance.** ```Text * * openssl req -new -x509 -key your_private_key.pem -out your_public.cer -days 3650 * ``` Update Config.properties and remove the default values for content.cer.file and content.pem.file with the ones generaged above. Save the file and restart the service. content.cer.file=your\_public.cer content.pem.file=your\_private\_key\_pkcs8.pem # JKS Link Enterprise supports utilizing the JKS format for it's web services API. If you are not familiar with java key stores you can learn more about them [here](https://en.wikipedia.org/wiki/Java_KeyStore). In most cases inside a keystore a private key is accompanied by the corresponding public key certificate. To view the certificates currently installed in your Link Enterprise middleware for web services you can view the JKS file using a key store viewer such as [https://keystore-explorer.org/](https://keystore-explorer.org/) Once downloaded you can open the "keystore.jks" file using the password !DFLOW! to open the JKS file. The JKS file is located at **C:\\\\config\certificates\keystore.jks** For information on **trusted certificates** and importing them you can visit the following link [https://keystore-explorer.org/doc/5.4/trustedCertificates.html](https://keystore-explorer.org/doc/5.4/trustedCertificates.html) For information on using a generated key-pair certificate you can visit the following link [http://keystore-explorer.org/doc/5.4/keyPairs.html#generate-a-key-pair](http://keystore-explorer.org/doc/5.4/keyPairs.html#generate-a-key-pair) Alternatively you can utilize pem and cer files for encrypting the Link Enterprise web service. Upon any changes of the JKS the service must be restarted. [title] Working with the API Gateway and SCRUD Test Harness [path] Agnostic Guides/Solution Guide/ The Gimmal Link API gateway provides the below functions: 1. Reporting of all Gimmal Link Enterprise processing, useful for a wide array of reporting and analysis 2. An entry point to the SCRUD (and PL) Test Harness 3. Load MDPro (metadata push) from an API gateway results set Regardless of the function above, execute the Gimmal Link Enterprise API gateway via either: 1. Transaction /dflow/sys and choose the button API Gateway 2. Enter the transaction /dflow/gtw Once a results set is displayed, you see all data columns left to right -** these can be filtered** to provide a more focused view depending on what you are looking for/at by choosing the `"Views" menu path `when viewing the report results. Within the both summary and detail level line, you can drill down on the columns indicated with a green checkbox to view further data, eg: viewing metadata, viewing the full return table, etc. Due to the volume of logging, it is recommended you routinely purge the gateway (primarily at the detail level) to keep table space to a minimum. Refer to the section in this document "Utilities: Archiving Gateway Data". # Selection Criteria | Setting | Description | Sample Value(s) | | ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | | CMS Profile | The CMS profile to filter on. | Box\_1 | | CMS Tag | The CMS Use Tag to filter on. | Gimmal Link Document Storage | | CMS Repository Type | The CMS repository type (FileNet P8, Documentum, or Box) | BX | | RFC Destination | The RFC destination to filter on. | ZDOCUFLOW\_CMSAPI\_01 | | API Source | The source of the process to filter on like viewing or choice list processing. | STORENEW | | API Type | The underlying API call to filter on (search, create, read, update, delete, ping and load).  These calls are used together to form various processing so it may be interesting to focus the results on just a port of say the viewing process. | READ | | SAP Key | The unique SAP ArchiveLink key for a particular object to filter on. | 00000000013000 | | DocType | The ArchiveLink document type to filter on. | ZCONTRACT | | Call Date | The date when the api call was made to filter on | 12/25/2020 | | Call Time | The time when the api call was made to filter on | 00:00:00 | | Call User | The originating user that made the API call. | GIMMAL | | Call Return Message Type | The return that was associated with the API call which can either be an (E)rror, (S)uccess, (W)arning, or (I)nfo. | E | | SAP User | The originating user that made the API call. | GIMMAL | | CMS ID | The content management system document id number to filter on. | 123456 | | Label | Migration and MDPro labels |  Gimmal Link is great | | Hide System Ping | If selected the ping API messages are not reported. |   | | Hide DocViewing | If selected, and if Gimmal Link Enterprise DocManager or the TOAEX method is used for viewing content, then those entries are not reported. |   | | Hide Detail Entries | If selected the detail API messages are not reported.  By default, the gateway summarizes API calls into 1 “summary” entry in the gateway for ease of reporting.  If you wish to see the underlying API calls (for example, the CREATE and UPDATE for a DocManager Storage request), click this off. |   | | Default Layout | Optionally you can select a previously saved layout for the gateway dashboard before displaying the results. | DEFAULT | # Reporting on Gimmal Link Enterprise Processing All Gimmal Link Enterprise processing is logged at a summary and detail level within the API Gateway, and therefore reporting can done so for various reasons such as: 1. Viewing general activity 2. Troubleshooting and unhappy path scenerios 3. Exporting results for performance and load analysis 4. etc... Familiarize yourself with the input selection criteria and drill down information available. Also note that by default document viewing activity and "detailed entries" are hidden. See input criteria above "Hide DocViewing" and "Hide Detail Entries" for more information and to see what additional data is available. # SCRUD "Test" Harness The SCRUD "Test" Harness allows the testing of basic SCRUD API's with no coding via the Gimmal Link Enterprise API Gateway. The (S)earch, (C)reate, (R)ead, (U)pdate, and (D)elete API's that are executed are identical to those called when using the ABAP SCRUD API set (refer to the Gimmal Link Developers Guide) or the Gimmal Link Enterprise Connector test harness. All Gimmal Link Enterprise processing leverages the same endpoint API calls and resulting calls in the Gimmal Link Enterprise middleware and therefore the test harness can provide you the ability to simulate all Gimmal Link Enterprise processing. To enter the SCRUD "Test" Harness: 1. Execute the API gateway using input parameters that will return: 1. a small dataset *or* 2. NO dataset *or* 3. a dataset that contains the line(s) that you wish to use to action (or "re-process") using SCRUD functions 1. "Re-process" in this context means that for Read and Update, you can choose an existing line in the API gateway report and the test harness will use those values as the input to the test harness (you have the option to change those values of course, but they can be handy to reduce entring all the data). 2. Choose the "Execute" menu path and choose the applicable SCRUD function. 1. The ...."New" options bring up a new/empty SCRUD input screen 2. The ...."Again" options require you to select a reported line (click once anywhere on the desired results screen on the line of choice) and basically pre-populates the SCRUD input screen with already utilized values in the case of (R)ead and (U)pdate. Not to worry....these values can be changed prior to execution. `**** NOTE **** Even though this is referred to as "test harness", all actions are processed fully to the CMS endpoint. So albeit you can use this to test (Search/Read of course have no lasting effect other than load and performance), in the case of Create/Update/Delete, especially in a production environment, these actions must be approached with caution.` # Loading MDPro MDPro allows you to push metadata from SAP to your CMS endpoint, and can be executed directly *or *alternatively, you can "load" the input selection criteria from the API Gateway if you are reporting on (U)pdate API activity. Refer to the section "Utilities: Metadata Push (MDPro) for more detail on how to run MDPro. [title] Developers Guide [path] Agnostic Guides/ ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/3xSWehIIfwUKO96kXvAq1_image.png" size="54" width="1210" height="462" position="center" showCaption="false"} ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/Sk1DFPg1rPxoJR3zfIQYN_image.png" size="54" width="1227" height="243" position="center" showCaption="false"} [title] SAP Logon Pad Security Configuration [path] Agnostic Guides/Solution Guide/DocManager/ By default, the SAP Logon Pad generates a pop-up warning each time a local file is accessed *or* a file is accessed from an external content management system. Due to the fact that Gimmal Link Enterprise DocManager does this...a LOT!, it is recommended that you disable this warning pop-up to avoid end-user frustration. Follow the steps below to avoid this pop-up message: - From the SAP GUI Logon Pad, choose: - for Windows: Click on the top left icon and select Options or Preference (depending on your SAP GUI version): ::Image[]{src="https://archbee-doc-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/tdn3CooBurSPsEjdLruIx_Image%202020-07-13%20at%203.28%20PM.jpg" size="70" position="center" showCaption="false"} - for Java: via the menu bar path SAPGUI->Preferences: ::Image[]{src="https://archbee-doc-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/Ki6X3w2yN57VpHZkPDBle_Image%202020-07-13%20at%203.29%20PM.jpg" size="56" position="center" showCaption="false"} - Location the Security folder on the left, highlight Security Settings, and then choose "Open Security Configuration": ::Image[]{src="https://archbee-doc-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/autdGo4ZXs47vIPXsckJb_image.png" size="66" position="center" showCaption="false"} - Change the default Action to "Allow", and click OK/Apply: ![](https://archbee-doc-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/RrdD-BR-JuFF1YnJRJ5Na_image.png) [title] Create [path] Agnostic Guides/Developers Guide/S3 Endpoints/ Link Enterprise provides a web service endpoint that will allow you to create a document. The following endpoint allows the following capabilities. 1. Create a File 2. Create a File with metadata :::ApiMethodV2 ```json { "tab": "examples", "url": "https://localhost:82/scrud/create", "name": "Create a File", "method": "POST", "request": { "pathParameters": [], "queryParameters": [], "headerParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "selectedCMS", "type": "string", "description": "Value should always be set to \"s3\" to let Link Enterprise know which configured content system to search." }, { "kind": "required", "name": "cmsName", "type": "string", "description": "Name of the s3 system configured in docuflow." }, { "name": "fileLocation", "kind": "required", "type": "string", "description": "file location in local system that needs to be stored in s3.", "children": [] }, { "name": "location", "kind": "optional", "type": "string", "description": "S3 Bucket name where you want to create the document.", "children": [] } ], "formDataParameters": [] }, "results": { "languages": [ { "id": "VzFOzYGCxsoPbWzdx0yew", "code": "{\n\t\"docId\": [\n\t\t\"01KWRZNISOYOOXWOQBKJGIRKQBPPKM\",\n\t\tnull,\n\t\tnull\n\t],\n\t\"FolderIds\": [\n\t\tnull,\n\t\tnull,\n\t\tnull,\n\t\tnull,\n\t\tnull,\n\t\tnull,\n\t\tnull,\n\t\tnull,\n\t\tnull,\n ...\n\t]\n}", "language": "200" }, { "id": "VQkVXQFKVKg-X3yyvKCWC", "code": "{\n\t\"docId\": [\n\t\t\"123demotest\",\n\t\tnull,\n\t\tnull\n\t]\n}", "language": "500" } ], "selectedLanguageId": "VQkVXQFKVKg-X3yyvKCWC" }, "examples": { "languages": [ { "id": "CXPum3DlkEh5CtlxE_mJB", "code": "{\n \"cmsName\":\"Name of the s3 system configured in Link Enterpri.\", \n \"fileLocation\":\"C:\\\\someFolder\\\\someFile.txt\",\n \"selectedCMS\":\"s3\",\n \"location\":\"S3 Bucket Name\"\n}", "language": "json" } ], "selectedLanguageId": "CXPum3DlkEh5CtlxE_mJB" }, "description": "Create a file with no metadata", "currentNewParameter": { "label": "Body Parameter", "value": "bodyDataParameters" }, "autoGeneratedAnchorSlug": "create-a-file", "legacyHash": "LTZYKRF4XjDFS4dN8yyEx" } ``` ::: :::ApiMethodV2 ```json { "tab": "examples", "url": "http://localhost:82/scrud/create", "name": "Create a File (metadata)", "method": "POST", "request": { "pathParameters": [], "queryParameters": [], "headerParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "selectedCMS", "type": "string", "description": "Value should always be set to \"s3\" to let Link Enterprise know which configured content system to search." }, { "kind": "required", "name": "cmsName", "type": "string", "description": "Name of the s3 system configured in docuflow." }, { "kind": "required", "name": "mdArray", "type": "Array", "description": "A JSON array where each index is a json object with the keys \"md1\" and \"md2\". Where md1 is the column name, and md2 is the value to be inserted in that column." }, { "name": "fileLocation", "kind": "required", "type": "string", "description": "file location in local system that needs to be stored in s3.", "children": [] }, { "name": "location", "kind": "optional", "type": "string", "description": "S3 Bucket name where you want to create the document.", "children": [] } ], "formDataParameters": [] }, "results": { "languages": [ { "id": "0iMkCF4s-yKchRAaXWJq3", "code": "{\n\t\"docId\": [\n\t\t\"123demotest\",\n\t\tnull,\n\t\tnull\n\t]\n}", "language": "200" }, { "id": "Idjmyl-woaWfo4s5K3_bg", "code": "", "language": "500" } ], "selectedLanguageId": "0iMkCF4s-yKchRAaXWJq3" }, "examples": { "languages": [ { "id": "YYkmw0EaCT-jCk9-cGJJs", "code": "{\n \"cmsName\":\"Name of the sharepoint system configured in Link Enterpri.\",\n\"fileLocation\":\"C:\\\\someFolder\\\\1GB.bin\",\n \"mdArray\":[\n {\n \"md1\":\"contRep\",\n \"md2\":\"K1\"\n }\t\t \n ],\n \"selectedCMS\":\"s3\",\n \"location\":\"S3 Bucket Name\"\n}", "language": "json" } ], "selectedLanguageId": "YYkmw0EaCT-jCk9-cGJJs" }, "description": "Create a file with metadata", "currentNewParameter": { "label": "Body Parameter", "value": "bodyDataParameters" }, "autoGeneratedAnchorSlug": "create-a-file-metadata", "legacyHash": "jwu3C_6nkyZkTjqhuztuj" } ``` ::: [title] CMS_API_LOAD [path] Agnostic Guides/Developers Guide/Untitled/ | **Functionality ** | **Description** | **FileNet Notes** | **Documentum Notes** | **Box Notes** | **M365/SharePoint Notes** | | --------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- | -------------------- | ------------- | ------------------------- | | IV\_CMSPROFILE 



| Required: Determines which configured CMS Profile in Link Enterprise SAP to utilize. Combination of CMS Profile and CMS Tag determine the API destination and thus load across an RFC destination.  | | | | | | IV\_CMSTAG 



| Required: Determine which configured CMS Profile in Link Enterprise SAP to utilize. Combination of CMS Profile and CMS Tag determine the API destination and thus load across an RFC destination.  | | | | | | IV\_LOAD\_REPOSITORIES 
| Load list of repositories for a CMS tab and profile  | | | | | | IV\_LOAD\_METADATA 

| Load list of metadata available for each repository  | | | | | | IV\_LOAD\_TYPESANDPROPS 
| Load list of types and their properties for each repository  | | | | | | IV\_LOAD\_DATABASE 
| Save results to Link Enterprise SAP tables  | | | | | | IV\_LOAD\_INITIALIZE\_DB 
| When Load DB is specified, whether to clear existing Link Enterprise SAP tables to be loaded into  | | | | | | IV\_REPOSITORY 
| Which repositories to load (Mandatory if Load Repositories is specified).  | | | | | | ET\_REPOSITORIES 
| Retrieved list of repositories.  | | | | | | ET\_METADATA\_STRUCT 
| Retrieved list of metadata  | | | | | | ET\_TYPESANDPROPS 
| Retrieved list of types and properties  | | | | | | ET\_RETURN 

| Table that indicates a success of an error. The TYPE field will contain an ‘S’ or ‘E’ respectively and the MESSAGE field will contain information in the case of an error.  | | | | | | CT\_CUSTOM  | Future use  | | | | | [title] DocManager [path] Agnostic Guides/Developers Guide/Untitled/ The below BADI’s/enhancement spots are available within the DocManager Add-On:  ## /DFLOW/DOCMANGER\_CRM\_BO\_DETAIL - BADI: /DFLOW/BADI\_DOCMGR\_CRM\_BO\_DTL - Allows custom manipulation of CRM Store New processing business object, sap\_object, doctype, object\_id, and filename details. ## /DFLOW/DOCMANGER\_SFO\_STATUS - BADI: /DFLOW/BADI\_DOCMGR\_SFO\_STATUS - Allows custom determination of whether to enabled or disable the DocManager SFO menu option. - In the code, leverage the input parameter IS\_LPORB to determine the SAP Object and ArchiveLink document type - Set the parameter CV\_EP\_STATUS with one of the following values: - 0 Active 1 Inactive 2 Invisible - Note that you do NOT have to set to 0 - Active, as this is the default ## /DFLOW/DOCMANGER\_STOREANDLINK - BADI: /DFLOW/BADI\_DOCMGR\_STORE\_LINK - Allows custom processing of the Store New process *prior* to the Content API “CREATE” call with iv\_caller 'B'. - One of the most common reasons to implement this BADI under iv\_caller 'B' is to create a folder structure during the document creation process. - To do so, you two options: - 1\. 1 parent with \ flat folders - 2\. All folders as nested folders: in this case, set the variable cv\_nested\_folders to "X". - Note: you can pass the folder name each time you create a document. Link Enterprise will first check to see if that name exists under the configured location/folder ID in the DocManager rule. If it does not exist, it will create it. If it exists, no action is performed for a folder creation. - When you create a multi level folder structure, you will be able to indicate which folder to store the document in. By default, the document is stored in the top level sub-folder. To place the content (if you are storing content, which is optional) in a folder other than the top parent folder, indicate this with a \~ tild. - Example of CT\_CUSTOM to create 4 folders, and place content in parent folder: - SAP\_4500017723 SAP\_SubFolder1 SubFolder2 SubFolder3 - or - \~SAP\_4500017723 SAP\_SubFolder1 SubFolder2 SubFolder3 - Example of CT\_CUSTOM to create 4 folders, and place content in lowest sub-folder: - SAP\_4500017723 SAP\_SubFolder1 SubFolder2 \~SubFolder3 - Below is an example to create 1 sub folder showing the ABAP debugger: ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/U8-Gf6rq0pQP9-QiSsHAw_image.png) ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/EZZxh15sVomjfjfRc00db_image.png" size="64" width="930" height="486" position="flex-start" showCaption="false"} - Allows custom processing of the Store New process *after* the Content API “CREATE” call and also the ArchiveLink create link with iv\_caller 'A'. - This is called in both success and error occurrences which is indicated by the entries in the return table - In the case of success, IV\_ARC\_DOC\_ID will be populated - Some customers implement this to interpret the return table CT\_RETURN when creating folders. In some scenarios the folder ID's created are useful to know. - When you use the IT\_CUSTOM folder to create folders, the return table will also pass back the folder ID's created. The parent folder is indicated by a ! exclamation point, all sub-folders are indicated by a \~ tild. - Example of return table when folders are created: !SAP\_4500017723,147811962292 \~SAP\_SubFolder1,938382828 \~SAP\_SubFolder2,938382829 \~SAP\_SubFolder3,938382830 [title] Creating a DocManager Rule [path] Agnostic Guides/Solution Guide/DocManager/ To create a DocManager Rule, enter transaction /dflow/sys and choose the menu path Configure->API Rules->DocManager. | **Parameter** | **Description** | **Sample Value** | | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------- | | Object Type | The SAP Business Object that is relevant to this DocManager rule.  This and Document Type make up the unique rule key. | BKPF | | Document Type | The ArchiveLink Document Type configured in OAC2 that is relevant to this DocManager rule.  This and SAP Business Object make up the unique rule key.
For link creation, and entry in OAC3 must exists for these two and the configured Cont.Rep.ID below (and in the Gimmal Link Enterprise Base product and OAC0). | ZWFINVSP01 | | En. DM Store New SFO | Enable Services for Object (SFO or GOS) for SAP to CMS business document storage.  | True or False | | En. DM Link Ex SFO | Enable Link Existing document via drag and drop from CMS to SAP via OLE (future use) | OFF | | En. SL CS CB | Enable SAPink Content Server Callback. If enabled, for Content Server "create": SAPLink will create CMSID\<->SAPDoc mapping and will execute metadata transfer or other docManager rules if configured. | | | En. SL CS Move | Enable SAPink Content Server Callback file mover. If enabled, for Content Server "create": SAPLink will move from a Content Server dropzone (via a re-store) to a final location. This allows for a full feature set even though a document is stored via content server, such as: folder creation, dynamic location, external BPM and task creation, etc....in short: everything that a document stored via ECM can do. (metadata and viewing is handled above with En. SL CS CB). | | | En. DM SL Cr. Link | Enable SAPLink Create Link which automatically creates ArchiveLink links for CMS inbound to SAP processing requests.  This is used with CMS M.data Key or S.Link Cust Class/Method to determine the SAP key to link to (ie: must match exactly ArchiveLink object\_id). | True or False | | En. SL WFConnect | Enable Workflow Connect to trigger SAP workflow code free (and fill workflow containers with metadata from CMS) for CMS inbound to SAP processing requests.   | True or False | | En.  SL Custom | Enable custom ABAP code for CMS inbound to SAP processing requests (code is contained in .Link Cust Class/Method). | True or False | | En. DM SL v1B | Enable passing of CSM inbound to SAP processing requests to Gimmal Link V1.   | True or False | | Allow SL NoCont. | For repositories that support contentless records, enable this to allow these to send inbound to Gimmal Link SAP SAPLink requests | True or False | | En. DM Publish | Enable SAP to CMS outbound saving of message output data with metadata. | True or False | | En. DM Custom | Enable custom API usage for SAP to CMS outbound processing (code is container in your own Z namespace ABAP). | True or False | | En. Migration | Enable DocMigrator for this rule.  | True or False | | Hide Att.List | Hide this SAP Business Object/DocType combination on the Gimmal Link Enterprise SFO/GOS attachment list menu for existing links.   | True or False | | Hide Act.List | Hide the Activity List tab on the SFO/GOS attachment list menu to prevent showing activity for this SAP Business Object/DocType. | True or False | | CMS Profile | Determines which configured CMS Profile in Gimmal Link SAP to utilize.  Combination of CMS Profile and CMS Tag determine the API destination and thus load across an RFC destination. | Gimmal\_Demo | | CMS Use Tag | Determine which configured CMS Profile in Gimmal Link SAP to utilize.
Combination of CMS Profile and CMS Tag determine the API destination and thus load across an RFC destination. | Gimmal\_Demo | | Cont.Rep.ID | Determines which configured repository in Gimmal Link SAP to utilize for SAP to CMS processing. | ZF | | CMS Type | Determines which CMS Types to use for Gimmal Link SAP to CMS outbound processing (typically Create).
 
FileNet:
-        document class
-        for create, defaults to the “Document” document class if unspecified. 
 
Documentum:
-        object type
-        for create, defaults to the “dm\_document” class if unspecified.
 
Box:
-        metadata template
-        for create, defaults to creating a document with no metadata template if not specified.
 
SharePoint On-Prem/SharePoint M365:
-        content type
-        for create, defaults to creating a document of content type Document if not specified. | accountsPayable | | CMS Location | Specifies where the content resides for Gimmal Link Enterprise SAP to CMS outbound processing (typically Create).
 
\*\* CMS Location allows Environment Variable usage.  In short these allow for different values based on your SAP system id (ex: DEV / QA1 / PRD).  Please refer to the Gimmal Link Enterprise Installation and Base Configuration Guide under “Environment Variables” for detail on how to configure and utilize. \*\*
 
FileNet:
-        if unspecified documents are left unfiled. 
 
Documentum:
-        If unspecified documents are stored in root of the user’s cabinet.
 
Box:
-        Best practice: folder number/id for the exact folder location can be specified
-        If unspecified documents are stored in the configured root folder of the Enterprise Connector
-        relative folder names can be used with a / being the root.  If a root folder is configured for the Box CMS in the Enterprise connector all relative folder locations will be relative to the root folder configured.
-        Relative folder names are not recommended for performance reasons.
 
SharePoint On-Prem/SharePoint M365:
-        optional sub-site URL (added on to repository URL) with mandatory document library specified last
  | 5523993 | | Own Folder | Determines whether a file is stored in the CMS Location (not enabled), versus when enabled the Enterprise Connector will check if there is a folder with the name “SAP\_\”.  
 
If there is one (as a subfolder to CMS Location), the file is stored there.  
 
Otherwise it will create one automatically and store the file there. | True or False | | Link Folder | If Own Folder is enabled, whether to create an ArchiveLink link to the folder vs. the file.
 
Linking to a folder, when viewed from SAP, will show the folder view and all of it’s contents.
 
Linking to a file will bring up the Box preview of the file being viewed.   | True or False | | CMS M.data Key | For inbound from CMS to SAP processing requests for “En. DM SL Cr. Link” (ie: automatic link creation), if an SAP key does not need to be formatted or retrieve and is an exact match in your CMS system to the ArchiveLink key required (with formatting/padding, etc..), you can specify that property name here.  
 
Otherwise, you must use a S.Link Cust Class/Method to determine the SAP key to link to | InvoiceSAPKey | | S.Link Cust Class | For inbound from CMS to SAP processing requests for “En. DM SL Cr. Link” (ie: automatic link creation), if an SAP key sneed to be formatted or retrieve or is NOT an exact match in your CMS system, you can compile the SAPKey here (either with the metatata or SAP lookup).  
 
Otherwise, you must specify the key in the CMS M.data Key field to determine the SAP key to link to.
 
Refer to the Gimmal Link Enterprise Developers Guide for more information on how to program these class/methods. | /DFLOW/CL\_DOCMANAGER\_HELPER | | S.Link Cust Method | See above “S.Link Cust Class” | SAPLINK\_EXAMPLE | | En. MD Trans.Map | Applicable to both inbound and outbound processing patterns, this no-code option generates metadata mapping from SAP to your CMS system
 
If enabled, a metadata map must exist under the Configure->Metadata mapping on the Gimmal Link SAP System Dashboard. | True or False | | En. MD Trans.Cus. | Applicable to both inbound and outbound processing patterns, this CODE option generates metadata mapping from SAP to your CMS system
 
If enabled, the below metadata class/method must be specified.  | True or False | | Metadata Class | Refer to the Gimmal Link Enterprise Developers Guide for more information on how to program these class/methods. | /DFLOW/CL\_DOCMANAGER\_HELPER | | Metadata Method | See above “Metadata Class”.   | METADATA\_EXAMPLE | | Description | English description for cosmetic reasons on the overall System  | “FI Invoice Processing” | [title] Configuration [path] Agnostic Guides/Solution Guide/Untitled/ There are three levels of configuration for DocMigrator: 1. SAP ArchiveLink Document Class to Mime-type Mappings - these entries are in the table TOADD and contain the file extension (document class) to mime-type mapping. This is required for all file types to be migrated regardless of their source. 2. DocMigrator - source repository id setup and mapping, doctype mapping, and source metadata mapping. 3. DocManager Rule - all configuration needed to store content from SAP to your target repository such as location, metadata, etc. *All business objects and content must be configured in DocManager.* 4. If you are using flat files as input, create a logical filename "ZDOCUFLOW\_MIGRATOR\_SOURCE\_FILES" 5. If you are export file copies, create a logical filename "ZDOCUFLOW\_MIGRATOR\_EXPORT\_COPY\_FILES" ## SAP ArchiveLink Document Class to Mime-Type Mappings SAP comes with pre-populated mappings. If a combination is missing in your TOADD table, you can add new entries via the menu path: SPRO->SAP Reference IMG->SAP Net weaver->Application Server-> Basic Services->Archive Links->Basic Customizing-> Edit Document Classes ## DocMigrator Locate the DocMigrator config under the Gimmal Link System Dashboard (txn /dflow/sys) and the menu path Configure->DocMigrator - Source Connectivity - Not required for SAP database attachements or notes - Choose between a Gimmal Link Enterprise endpoint, a non-Gimmal Link ArchiveLink content server, the SAP database, or File input for each repository ID that will be used in the Load Table - Provided CMS Use Tag. For non-Gimmal Link Enterprise endpoints, this is for description purposes only. For Gimmal Link Enterprise endpoints, this will be used along with standard Gimmal Link configuration to determine the RFC destination to perform the READ from. - Repository Mapping - Not required for SAP database attachments or notes - This is required in all cases except where you are reading from the same source Gimmal Link repository as the target, or if you have/will populate the Load table from an ABAP class/method or file method (as those determine the target repository ID). - It is strongly recommended not to sharing repository IDs for different repository type. - DocType Mapping - Not required for SAP database attachments or notes - Mapping of document types is optional in all cases. - Typically only recommended if SAP security is to be different between source and target content, or if you want to merge document types. - Remember that new document types typically requires updated SAP Security roles/profiles. - Wildcards (\*) can be used in the Source Object Type and Source Document Type columns and take second precedence over an exact matching entry. - Original MD Map - Not required for SAP database attachments or notes - If metadata is supported from the source content, mapping of original/source metadata names to new target metadata field/property names can be done. - If only new metadata from SAP is being sent to the target system as part of the migration, this mapping is not required. - Wildcards (\*) can be used in the Source Object Type and Source Document Type columns and take second precedence over an exact matching entry. - SAP DB as Source Map - Required *only* for SAP database attachments or notes - For all SAP database attachments or notes you must specify a target repository ID and doctype per SAP Object. - A wildcard (\*) can be used in the Source Object Type column and take second precedence over an exact matching entry. ## DocManager Rule Locate the DocManager config under the Gimmal Link Enterprise System Dashboard (txn /dflow/sys) and the menu path Configure->API Rules->Document Manager. Since DocMigrator utilizes DocManager for all content to be migrated to determine location, metadata, etc, a DocManager rule must exist for every business object and doctype combination to be migrated. For detail on this configuration, refer to the DocManager section of the Gimmal Link Enterprise Solution Guide. ## Logical Filename: Source Files Create the logical filename "ZGIMMALLINK\_MIGRATOR\_SOURCE\_FILES" via transaction FILE. Assign to a logical path of the same name and configure that logical path to the directory to save the log files. The physical path must have the filename placeholder as \. Example below: ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/pFfkMactpJpq9qsSPVXXJ_image.png) ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/bYX3UpT5mC_3BDikIszcx_image.png) ## Logical Filename: Export Copy Create the logical filename "ZGIMMAL\_MIGRATOR\_EXPORT\_COPY\_FILES" via transaction FILE. Assign to a logical path of the same name and configure that logical path to the directory to save the log files. The physical path must have the filename placeholder as . Use the examples above as guidance if necessary.  [title] Execution: Load [path] Agnostic Guides/Solution Guide/Untitled/ Loading the migration table sets the stage for: - what content is to be migrated and from what source (a Gimmal Link endpoint, file, SAP content server, SAP DB) - any SAP repository ID or doctype mapping (via configuration) - where the content is to be migrated to (ie: what Gimmal Link endpoint repository ID) This can be done using 3 separate "Source" methods: 1. ArchiveLink Links 2. .CSV file containing file references and required ArchiveLink data 3. Custom ABAP Class-Method 4. Content stored in your SAP database Regardless of the method used, it is highly recommended to enter a useful descriptor/tag that identifies this migration run. You can run the load process in test mode without making any chances to the load table. The results of the Load phase are displayed on the screen according to the option "Display Results in ALV" checkbox. If this option is chosen, all entries are displayed in the ALV report format, else a simple message indicating the number of entries loaded successfully, with info message, or errors is displayed. If ALV is chosen, the header will display information as to the breakdown of entries loaded successfully, with info message, or errors. `Be careful when choosing "Display Results in ALV" as for large datasets this will significantly increase runtime and potential SAP system memory usage and timeouts. It is therefore suggested to use the "Display" mode of the migrator afterwards instead of displaying the results in ALV format. ` Clicking on the source or target hotspot/hyperlink in the ALV allows you to view the image. The DocManager rule and/or metadata mapping *does not happen* at the Load stage. This is done in the Migrate phase. No additional flags are set at this stage, as the Load phase creates the entries in the migration table. ## ArchiveLink Links This method relies entirely on existing link entries in your ArchiveLink link tables (TOA01, etc). 1. Specify the parameters in the section "Source ArchiveLink Selection Criteria" to determine which entries will be read by the DocMigrator 2. Each entry found will equate to an entry in the load table 3. Before writing the entry to the load table, DocMigrator reads the DocMigrator configuration to determine repository ID and doctype mapping The source of this content must be accessible through an ArchiveLink content server or equivalent to be read. ## .CSV File This method relies entirely on an input .CSV file that you compile yourself to add entries to the Migration table. The source type of these entries are data files only (ie: *you cannot* use this method to load ArchiveLink link entries into the migration table). The .CSV file must follow the below columns, in order: - sap\_object - object\_id - archiv\_id - arc\_doc\_id - ar\_object - ar\_date - del\_date (optional) - reserve (this must align with your viewing platform, thus either \* or file extension) - source file path - source file name These files must be accessible by the DocMigrator program, be sure to take into consideration if the migration run will be executed in the background (and therefore the files must be accessible by the SAP server). ## Custom ABAP Class-Method This method relies entirely on an ABAP class-method that you can develop yourself to add entries to the Migration table, which takes the form of ArchiveLink links. Refer to /DFLOW/CL\_MIGRATOR\_HELPER=>GET\_ABAP\_LINKS\_EXAMPLE for an example of this logic. The custom class method MUST set the following: ArchiveLink Source: - EV\_SOURCE\_TYPE: - \= "A" for ArchiveLink content server - \= "D" for Gimmal Link ECM - sap\_object - object\_id - archiv\_id - arc\_doc\_id - ar\_object - ar\_date - del\_date (optional) - reserve (this must align with your viewing platform, thus either \* or file extension) ## SAP Database With the information available to us for this as a source being limited, this method relies on specifying and SAP Business Object and the corresponding object ID "range". Not that as part of the LOAD phase, unlike the other sources, mime-type and therefore extension (reserve) will not be known until migration is executed (or even in validation mode). An example would be "EQUI" for Equipment, and then specifying the object ID "range", ie: the equipement numbers that you like to migrate the content for. Select either/both Attachments or Notes options. The SAP Object and Object ID (the SAP Key) are optional. If you are unsure of what is in your database, you can run this wide open to see! [title] Utilities: Cleaning Gateway Errors [path] Agnostic Guides/Solution Guide/ This function allows you to maintain (ie: delete) errors in the Gimmal Link Enterprise API gateway that may have subsequently been processed successfully. This allows the API gateway to be more "clean" and have less false negatives as its history grows and as corrections are made. We recommend you run the program monthly, with the input variant set for a date equal to + 1 day since the last time it was ran, or, aligned with how often you run the API gateway to use the errors to trigger a resolution action. To execute a gateway error clean, enter transaction /dflow/sys and choose the menu path Configure->Execute->Clean Gateway Errors. # Selection Criteria | Setting | Description | Sample Value(s) | | ------------------- | ----------------------------------------------------------------------------------------------------- | --------------- | | CMS Profile | The content management system profile to limit cleaning on. |   | | CMS Use Tag | The use tag to limit cleaning on. |   | | CMS Repository Type | The content management system repository type to limit cleaning on. |   | | CMS RFC Destination | The remote function call (RFC) destination to limit cleaning on. |   | | API Source | The source of the api calls to limit cleaning on. | SAPLINK | | API Type | The particular api call type to limit cleaning on. |   | | SAP object ID | The particular SAP ArchiveLink object keys to limit cleaning on. |   | | Document Type | The SAP ArchiveLink document types to limit cleaning on. |   | | Date | The date range to limit cleaning to. |   | | Time | The time range to limit cleaning on. |   | | User Name | The SAP user name to limit cleaning on. |   | | CMS SAP User | The SAP user name to limit cleaning on. |   | | CMS Rep./Store | The content management system repository or object store to limit cleaning on. |   | | CMS ID | The content management system id(s) to limit cleaning on. |   | | CMS Filename | The content management system filename(s) to limit cleaning on. |   | | CMS Type | The content management system document class, object type or metadata template to limit cleaning on.  |   | | Test Only | If selected the cleaning isn’t actually performed and the process is just simulated. | | # Creating and Scheduling Background Job 1. Consult with your SAP Basis team to create the job using the program “/DFLOW/ZCMSAPI\_GTW\_ERROR\_CLEAN” 2. Create a variant for the above program using a dynamic date selection per the below (as an example) 1. Select “Save as Variant…” from the “Goto” menu under the “Variants“. 2. Adjust the date range by Selecting “X\:Dynamic Date Calculation (System Date)” for the Selection variable of the “Date” Field name. 3. Configure the “Name of Variable (Input Only Using F4)” to select the particular date range to archive. 1. We suggest selecting I for include (the I in the I/E column) with the LT (for less than) option the “Current date +/- ??? days” selection from the choices. 4. Enter 31- for the ??? value. 5. This cleans errors that have been processed successfully older than 31 days. [title] Utilities: Attachment List Dashboard [path] Agnostic Guides/Solution Guide/ This is a simple report on ArchiveLink links with an enhanced selection criteria across all link tables, that also allows for adjustment of individual link entries. This utility differs from the Link Maintenance utility in that it only allows for single links to be maintained/deleted versus the Link Maintenance dashboard allows for mass deletion. To execute the attachment list report, enter transaction /dflow/sys and choose the menu path Configure->Dashboards->Attachment List. Make sure to limit the search results by at least an SAP Object or AR Object(Doctype) to help narrow down the results. The toolbar that runs along the top of the attachment list dashboard can allow you to further refine your view of the attachment list table.  Included in the toolbar is some additional functionality like the ability to customize layouts and delete link entries. | Setting | Description | Sample Value(s) | | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------- | | SAP Object | The SAP business object in particular to filter the ArchiveLink entries on. | BUS2014 | | Object ID | A particular unique object id to filter the ArchiveLink entries on.  This unique object id will only be unique to a particular SAP business object so make sure to include additional filter criteria. | 0000000001 | | Archive ID | The ArchiveLink repository to filter the ArchiveLink entries on. | ZC | | CMS ID | The content management system document id in particular to filter the ArchiveLink entries on. | 1232456 | | AR Object (Doctype) | The ArchiveLink document type to filter the ArchiveLink entries on. | ZCONTRACT | | Archive Date | The ArchiveLink archive date to filter the ArchiveLink entries on. | 12/25/2020 | | Reserve | The ArchiveLink reserve entry to filter the ArchiveLink entries on. |   | | Layout | Optionally you can select a previously saved layout for the gateway dashboard before displaying the results. | DEFAULT | [title] Upload [path] Agnostic Guides/Developers Guide/FileNet Endpoints/ Link Enterprise provides an endpoint to upload files to. This is strictly for uploading files, and if you require metadata to be transferred following up with an update endpoint call is required. :::ApiMethodV2 ```json { "tab": "request", "url": "https://localhost:82/scrud/upload", "name": "Upload", "method": "POST", "request": { "pathParameters": [], "queryParameters": [], "headerParameters": [ { "kind": "required", "name": "cmsName", "type": "string", "description": "Name of the content management system configured in Link Enterprise." }, { "kind": "required", "name": "location", "type": "String", "description": "Folder id where Link Enterprise is uploading the file. (box folder id) else root folder used." }, { "kind": "optional", "name": "Content-Type", "type": "string", "description": "multipart/form-data; boundary=(insert boundary)\n\nExample is included in code examples" }, { "name": "repository", "kind": "required", "type": "string", "description": "Filenet repository where the file exists", "children": [] }, { "name": "domain", "kind": "required", "type": "string", "description": "Filenet domain where the file exists", "children": [] } ], "bodyDataParameters": [], "formDataParameters": [] }, "results": { "languages": [ { "id": "81EVM7WXdGrYfDwshYJW6", "code": "SUCCESS EXAMPLE\n{\n\t\"id\": \"{75C8F438-A625-C99B-848E-8AD7C2F00000}\",\n\t\"result\": \"success\"\n}\n\nFAILED EXAMPLE\n{\n\t\"id\": null.\n\t\"result\": \"fail\"\n}", "language": "200" }, { "id": "6U9gw-gSaolDqS3WcFi9t", "code": "", "language": "500" } ], "selectedLanguageId": "81EVM7WXdGrYfDwshYJW6" }, "examples": { "languages": [ { "id": "xY6nLYt-BP3jeEy_-jkb3", "code": "POST /scrud/upload HTTP/1.1\nCookie: vertx-web.session=135e85c919328477ec243e270a692c4d\nUser-Agent: insomnia/2023.5.8\nCmsname: FN_TEST\nLocation: /TestFilenet\nAccept: */*\nRepository: ABC_OS1\nDomain: ABC_P8Dom\nAuthorization: Basic YWRtaW46YWRtaW4=\nContent-Type: multipart/form-data; boundary=---011000010111000001101001\nHost: localhost:82\nContent-Length: 172\n\n-----011000010111000001101001\nContent-Disposition: form-data; name=\"\"; filename=\"POSPaper COD-04.pdf\"\nContent-Type: application/pdf\n\n\n-----011000010111000001101001--", "language": "none" } ], "selectedLanguageId": "xY6nLYt-BP3jeEy_-jkb3" }, "description": "Upload a file using HTTP multi part form data. HTTP headers specifying repository, location, domain and the content system named must be specified.", "currentNewParameter": { "label": "Header Parameter", "value": "headerParameters" }, "autoGeneratedAnchorSlug": "upload", "legacyHash": "SYWoaQaa1CeAs6I_xHZZn" } ``` ::: [title] Solution Guide [path] Agnostic Guides/ ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/QamDSdA_HA5nxKzgdxmrh_image.png" size="54" width="1210" height="462" position="center" showCaption="false"} ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/1ir6CI5Lz1y4l0Zuns-3k_image.png" size="54" width="1227" height="243" position="center" showCaption="false"} [title] Class/Method Plug-In’s [path] Agnostic Guides/Developers Guide/ Class/method ABAP development may be necessary in the below Gimmal Link Enterprise processing scenarios:  1. DocManager/DocMigrator/Publisher: Metadata maps for sending SAP data to your CMS 2. DocManager: Custom processing during Inbound Processing/SAPLink 3. DocManager: SAPKey determination during Inbound Processing/SAPLink 4. DocMigrator: Custom source link determination and compilation 5. Publisher: Triggering storing and linking via docManager to your CMS Each one of these is optional within their respective Gimmal Link Enterprise configuration. Refer to the Gimmal Link Enterprise Solution Guide (separate) for more information on this configuration.  [title] User Permissions [path] Agnostic Guides/Developers Guide/Link Enterprise SCRUD Web Services/ Every user created in Link Enterprise has the ability to be restricted to different parts of the product. Currently, Link Enterprise allows users to the following: 1\) Enable/disable users access to admin interface. 2\) Enable/disable user access to web services. To add or remove users visit the admin interface. Click on the users menu item on the left navigation panel. Click add row, and enter the details of the user. Hit save to complete creating the user. ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/yf8Nop6mYzrbUw9X0K0gH_image.png) [title] Create [path] Agnostic Guides/Developers Guide/Box Endpoints/ Link Enterprise provides a web service endpoint that will allow you to create a document or folder. The following endpoint allows the following capabilities. 1. Create a File 2. Create a File with metadata 3. Create a folder 4. Create a folder with metadata 5. Create a nested folder structure (with parent obtaining metadata) 6. Create a single level tree structure (with parent obtaining metadata) :::ApiMethodV2 ```json { "tab": "examples", "url": "https://localhost:82/scrud/create", "name": "Create a File", "method": "POST", "request": { "pathParameters": [], "queryParameters": [], "headerParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "type", "type": "string", "description": "Metdata template name in box." }, { "kind": "required", "name": "location", "type": "string", "description": "Folder id where the file will be located in box." }, { "kind": "required", "name": "selectedCMS", "type": "string", "description": "Value should always be set to \"box\" to let Link Enterprise know which configured content system to search." }, { "kind": "required", "name": "cmsName", "type": "string", "description": "Name of the box system configured in docuflow." } ], "formDataParameters": [] }, "results": { "languages": [ { "id": "VzFOzYGCxsoPbWzdx0yew", "code": "", "language": "200" }, { "id": "VQkVXQFKVKg-X3yyvKCWC", "code": "", "language": "500" } ], "selectedLanguageId": "VzFOzYGCxsoPbWzdx0yew" }, "examples": { "languages": [ { "id": "CXPum3DlkEh5CtlxE_mJB", "code": "{ \r\n \"cmsName\": \"Name of the box system configured in Link Enterpri.\",\r\n \"fileLocation\": \"C:\\\\someFolder\\\\someFile.txt\",\r\n \"type\":null,\r\n \"location\":\"Insert unique box folder id\",\r\n \"selectedCMS\":\"box\"\r\n}", "language": "json" } ], "selectedLanguageId": "CXPum3DlkEh5CtlxE_mJB" }, "description": "Create a file with no metadata", "currentNewParameter": { "label": "Body Parameter", "value": "bodyDataParameters" }, "autoGeneratedAnchorSlug": "create-a-file", "legacyHash": "LTZYKRF4XjDFS4dN8yyEx" } ``` ::: :::ApiMethodV2 ```json { "tab": "examples", "url": "http://localhost:82/scrud/create", "name": "Create a File (metadata)", "method": "POST", "request": { "pathParameters": [], "queryParameters": [], "headerParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "type", "type": "string", "description": "Metdata template name in box." }, { "kind": "required", "name": "location", "type": "string", "description": "Folder id where the file will be located in box." }, { "kind": "required", "name": "selectedCMS", "type": "string", "description": "Value should always be set to \"box\" to let Link Enterprise know which configured content system to search." }, { "kind": "required", "name": "cmsName", "type": "string", "description": "Name of the box system configured in docuflow." }, { "kind": "required", "name": "mdArray", "type": "Array", "description": "A JSON array where each index is a json object with the keys \"md1\" and \"md2\". Where md1 is the column name, and md2 is the value to be inserted in that column." } ], "formDataParameters": [] }, "results": { "languages": [ { "id": "0iMkCF4s-yKchRAaXWJq3", "code": "", "language": "200" }, { "id": "Idjmyl-woaWfo4s5K3_bg", "code": "", "language": "500" } ], "selectedLanguageId": "0iMkCF4s-yKchRAaXWJq3" }, "examples": { "languages": [ { "id": "YYkmw0EaCT-jCk9-cGJJs", "code": "{ \r\n \"cmsName\": \"Name of the box system configured in Link Enterprise.\",\r\n \"fileLocation\": \"C:\\\\someFolder\\\\someFile.txt\",\r\n \"type\":\"insertMetaDataTemplate\",\r\n \"location\":\"Insert unique box folder id\",\r\n \"selectedCMS\":\"box\",\r\n \"mdArray\":[\r\n {\r\n \"md1\":\"insertColumnName\",\r\n \"md2\":\"insertValue\"\r\n },\r\n {\r\n \"md1\":\"someVendor\",\r\n \"md2\":\"Gimmal Inc\"\r\n }\r\n\t\t ]\r\n}", "language": "json" } ], "selectedLanguageId": "YYkmw0EaCT-jCk9-cGJJs" }, "description": "Create a file with metadata", "currentNewParameter": { "label": "Body Parameter", "value": "bodyDataParameters" }, "autoGeneratedAnchorSlug": "create-a-file-metadata", "legacyHash": "jwu3C_6nkyZkTjqhuztuj" } ``` ::: :::ApiMethodV2 ```json { "tab": "examples", "url": "https://localhost:82/scrud/create", "name": "Create a Folder", "method": "POST", "request": { "pathParameters": [], "queryParameters": [], "headerParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "type", "type": "string", "description": "Metdata template name in box." }, { "kind": "required", "name": "location", "type": "string", "description": "Folder id where the file will be located in box." }, { "kind": "required", "name": "selectedCMS", "type": "string", "description": "Value should always be set to \"box\" to let Link Enterprise know which configured content system to search." }, { "kind": "required", "name": "cmsName", "type": "string", "description": "Name of the box system configured in Link Enterprise." }, { "kind": "required", "name": "custom1", "type": "string", "description": "Name of the folder you would like to create." } ], "formDataParameters": [] }, "results": { "languages": [ { "id": "59h-A2k0zONjIeSYsWRxE", "code": "", "language": "200" }, { "id": "-CFsYXvO_LjjekeThBmeD", "code": "", "language": "500" } ], "selectedLanguageId": "59h-A2k0zONjIeSYsWRxE" }, "examples": { "languages": [ { "id": "r7afh-lQ7ej9Kyrx6_sDW", "code": "{ \r\n \"cmsName\": \"Name of the box system configured in Link Enterprise.\",\r\n \"type\":null,\r\n \"location\":\"Insert unique box folder id\",\r\n \"selectedCMS\":\"box\",\r\n \"custom1\":\"insert Folder Name\"\r\n}", "language": "json" } ], "selectedLanguageId": "r7afh-lQ7ej9Kyrx6_sDW" }, "description": "Create a folder with no metadata", "currentNewParameter": { "label": "Body Parameter", "value": "bodyDataParameters" }, "autoGeneratedAnchorSlug": "create-a-folder", "legacyHash": "wIxsI8djIx6QeX1UJGwdT" } ``` ::: :::ApiMethodV2 ```json { "tab": "examples", "url": "https://localhost:82/scrud/create", "name": "Create a Folder (metadata)", "method": "POST", "request": { "pathParameters": [], "queryParameters": [], "headerParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "type", "type": "string", "description": "Metdata template name in box." }, { "kind": "required", "name": "location", "type": "string", "description": "Folder id where the file will be located in box." }, { "kind": "required", "name": "selectedCMS", "type": "string", "description": "Value should always be set to \"box\" to let Link Enterprise know which configured content system to search." }, { "kind": "required", "name": "cmsName", "type": "string", "description": "Name of the box system configured in Link Enterprise." }, { "kind": "required", "name": "custom1", "type": "string", "description": "Name of the folder you would like to create." }, { "kind": "required", "name": "mdArray", "type": "Array", "description": "A JSON array where each index is a json object with the keys \"md1\" and \"md2\". Where md1 is the column name, and md2 is the value to be inserted in that column." }, { "kind": "required", "name": "metaDataFolderFlag", "type": "Boolean", "description": "true if setting metadata for folders\nfalse if not setting metadata for folders" } ], "formDataParameters": [] }, "results": { "languages": [ { "id": "ecFzJ0cYeEURQk6_xyi-w", "code": "", "language": "200" }, { "id": "lxCnVEL7Gh2NxD-xcILS3", "code": "", "language": "500" } ], "selectedLanguageId": "ecFzJ0cYeEURQk6_xyi-w" }, "examples": { "languages": [ { "id": "9wXKSoMG0n4VQQCVfQNcy", "code": "{ \r\n \"cmsName\": \"Name of the box system configured in .\",\r\n \"fileLocation\": \"C:\\\\someFolder\\\\someFile.txt\",\r\n \"type\":\"insertMetaDataTemplate\",\r\n \"location\":\"Insert unique box folder id\",\r\n \"selectedCMS\":\"box\",\r\n \"mdArray\":[\r\n {\r\n \"md1\":\"insertColumnName\",\r\n \"md2\":\"insertValue\"\r\n },\r\n {\r\n \"md1\":\"someVendor\",\r\n \"md2\":\"Gimmal Inc\"\r\n }\r\n\t\t ],\r\n \"custom1\":\"folderName\",\r\n \"metaDataFolderFlag\":true\r\n}", "language": "json" } ], "selectedLanguageId": "9wXKSoMG0n4VQQCVfQNcy" }, "description": "Create a Folder with metadata", "currentNewParameter": { "label": "Body Parameter", "value": "bodyDataParameters" }, "autoGeneratedAnchorSlug": "create-a-folder-metadata", "legacyHash": "Jv0MnAE3164FpSznGPg08" } ``` ::: :::ApiMethodV2 ```json { "tab": "examples", "url": "https://localhost:82/scrud/create", "name": "Create a Folder (metadata and nested)", "method": "POST", "request": { "pathParameters": [], "queryParameters": [], "headerParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "type", "type": "string", "description": "Metdata template name in box." }, { "kind": "required", "name": "location", "type": "string", "description": "Folder id where the file will be located in box." }, { "kind": "required", "name": "selectedCMS", "type": "string", "description": "Value should always be set to \"box\" to let Link Enterprise know which configured content system to search." }, { "kind": "required", "name": "cmsName", "type": "string", "description": "Name of the box system configured in Link Enterprise." }, { "kind": "required", "name": "custom1", "type": "string", "description": "Name of the folder you would like to create. If using nested the delimiter is #DFLOW#" }, { "kind": "required", "name": "mdArray", "type": "Array", "description": "A JSON array where each index is a json object with the keys \"md1\" and \"md2\". Where md1 is the column name, and md2 is the value to be inserted in that column." }, { "kind": "required", "name": "enableNested", "type": "Boolean", "description": "true (if wanting each folder to have one child in a nested manner)\n\nfalse (if all children are located under the first folder name)" }, { "kind": "required", "name": "metaDataFolderFlag", "type": "Boolean", "description": "true if setting metadata for folders\nfalse if not setting metadata for folders" } ], "formDataParameters": [] }, "results": { "languages": [ { "id": "1P4dxmaXpscwhcaiJsF-W", "code": "", "language": "200" }, { "id": "YFJvJP7JqIuUdivzIep9B", "code": "", "language": "500" } ], "selectedLanguageId": "1P4dxmaXpscwhcaiJsF-W" }, "examples": { "languages": [ { "id": "ueWIFObFukX7uxGDL9XBi", "code": "{ \r\n \"cmsName\": \"Name of the box system configured in Link Enterprise.\",\r\n \"fileLocation\": \"C:\\\\someFolder\\\\someFile.txt\",\r\n \"type\":\"insertMetaDataTemplate\",\r\n \"location\":\"Insert unique box folder id\",\r\n \"selectedCMS\":\"box\",\r\n \"mdArray\":[\r\n {\r\n \"md1\":\"insertColumnName\",\r\n \"md2\":\"insertValue\"\r\n },\r\n {\r\n \"md1\":\"someVendor\",\r\n \"md2\":\"Gimmal Inc\"\r\n }\r\n\t\t ],\r\n \"custom1\":\"folderName#DFLOW#folderName2#DFLOW#folderName3\",\r\n \"metaDataFolderFlag\":true,\r\n \"enableNested\":true\r\n}", "language": "json" } ], "selectedLanguageId": "ueWIFObFukX7uxGDL9XBi" }, "description": "Create a Folder with metadata", "currentNewParameter": { "label": "Body Parameter", "value": "bodyDataParameters" }, "autoGeneratedAnchorSlug": "create-a-folder-metadata-and-nested", "legacyHash": "wCBvhfT17RLyLiW_SsYpj" } ``` ::: :::ApiMethodV2 ```json { "tab": "examples", "url": "https://localhost:82/scrud/create", "name": "Create a Folder (metadata and nested false)", "method": "POST", "request": { "pathParameters": [], "queryParameters": [], "headerParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "type", "type": "string", "description": "Metdata template name in box." }, { "kind": "required", "name": "location", "type": "string", "description": "Folder id where the file will be located in box." }, { "kind": "required", "name": "selectedCMS", "type": "string", "description": "Value should always be set to \"box\" to let Link Enterprise know which configured content system to search." }, { "kind": "required", "name": "cmsName", "type": "string", "description": "Name of the box system configured in Link Enterprise." }, { "kind": "required", "name": "custom1", "type": "string", "description": "Name of the folder you would like to create. If using nested the delimiter is #DFLOW#" }, { "kind": "required", "name": "mdArray", "type": "Array", "description": "A JSON array where each index is a json object with the keys \"md1\" and \"md2\". Where md1 is the column name, and md2 is the value to be inserted in that column." }, { "kind": "required", "name": "enableNested", "type": "Boolean", "description": "true (if wanting each folder to have one child in a nested manner)\n\nfalse (if all children are located under the first folder name)" }, { "kind": "required", "name": "metaDataFolderFlag", "type": "Boolean", "description": "true if setting metadata for folders\nfalse if not setting metadata for folders" } ], "formDataParameters": [] }, "results": { "languages": [ { "id": "eZnSiYCQgdUwGzVHVCpC-", "code": "", "language": "200" }, { "id": "N2NeRZSPkxazHkQm-jwrV", "code": "", "language": "500" } ], "selectedLanguageId": "eZnSiYCQgdUwGzVHVCpC-" }, "examples": { "languages": [ { "id": "bgcmLQUzSw5m7cmhH8kbV", "code": "{ \r\n \"cmsName\": \"Name of the box system configured in Link Enterpris.\",\r\n \"fileLocation\": \"C:\\\\someFolder\\\\someFile.txt\",\r\n \"type\":\"insertMetaDataTemplate\",\r\n \"location\":\"Insert unique box folder id\",\r\n \"selectedCMS\":\"box\",\r\n \"mdArray\":[\r\n {\r\n \"md1\":\"insertColumnName\",\r\n \"md2\":\"insertValue\"\r\n },\r\n {\r\n \"md1\":\"someVendor\",\r\n \"md2\":\"Gimmal Inc\"\r\n }\r\n\t\t ],\r\n \"custom1\":\"folderName#DFLOW#folderName2#DFLOW#folderName3\",\r\n \"metaDataFolderFlag\":true,\r\n \"enableNested\":false\r\n}", "language": "json" } ], "selectedLanguageId": "bgcmLQUzSw5m7cmhH8kbV" }, "description": "Create a Folder with metadata", "currentNewParameter": { "label": "Body Parameter", "value": "bodyDataParameters" }, "autoGeneratedAnchorSlug": "create-a-folder-metadata-and-nested-false", "legacyHash": "GD-3v2PH9Zpl5L7CzrcqT" } ``` ::: :::ApiMethodV2 ```json { "tab": "examples", "url": "https://localhost:82/scrud/create", "name": "Create a Folder (no metadata and nested false)", "method": "POST", "request": { "pathParameters": [], "queryParameters": [], "headerParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "type", "type": "string", "description": "Metdata template name in box." }, { "kind": "required", "name": "location", "type": "string", "description": "Folder id where the file will be located in box." }, { "kind": "required", "name": "selectedCMS", "type": "string", "description": "Value should always be set to \"box\" to let Link Enterprise know which configured content system to search." }, { "kind": "required", "name": "cmsName", "type": "string", "description": "Name of the box system configured in Link Enterprise." }, { "kind": "required", "name": "custom1", "type": "string", "description": "Name of the folder you would like to create. If using nested the delimiter is #DFLOW#" }, { "kind": "required", "name": "mdArray", "type": "Array", "description": "A JSON array where each index is a json object with the keys \"md1\" and \"md2\". Where md1 is the column name, and md2 is the value to be inserted in that column." }, { "kind": "required", "name": "enableNested", "type": "Boolean", "description": "true (if wanting each folder to have one child in a nested manner)\n\nfalse (if all children are located under the first folder name)" }, { "kind": "required", "name": "metaDataFolderFlag", "type": "Boolean", "description": "true if setting metadata for folders\nfalse if not setting metadata for folders" } ], "formDataParameters": [] }, "results": { "languages": [ { "id": "Vo9jNEPrIAjJ6wvW4Sip-", "code": "", "language": "200" }, { "id": "L4O7Oo2z1FBfXmQCA-pGy", "code": "", "language": "500" } ], "selectedLanguageId": "Vo9jNEPrIAjJ6wvW4Sip-" }, "examples": { "languages": [ { "id": "m_86XorHlr5Rl-54vrddu", "code": "{ \r\n \"cmsName\": \"Name of the box system configured in Link Enterprise.\",\r\n \"fileLocation\": \"C:\\\\someFolder\\\\someFile.txt\",\r\n \"type\":null\r\n \"location\":\"Insert unique box folder id\",\r\n \"selectedCMS\":\"box\",\r\n \"custom1\":\"folderName#DFLOW#folderName2#DFLOW#folderName3\",\r\n \"metaDataFolderFlag\":false,\r\n \"enableNested\":false\r\n}", "language": "json" } ], "selectedLanguageId": "m_86XorHlr5Rl-54vrddu" }, "description": "Create a Folder with metadata", "currentNewParameter": { "label": "Body Parameter", "value": "bodyDataParameters" }, "autoGeneratedAnchorSlug": "create-a-folder-no-metadata-and-nested-false", "legacyHash": "iamkEN4dx3y-wyZdXaiVe" } ``` ::: [title] Customer Resources Required [path] Agnostic Guides/Solution Guide/ Customer resources required for a Gimmal Link Enterprise configuration and utility usage typically falls on the shoulders of an SAP Basis and/or an SAP technical resource (often an SAP developer who has experience in or nominated to be the document management guru. Configuration flows between SAP ArchiveLink (OAC2, OAC3) and Gimmal Link Enterprise SAP configuration, so can be handled by one resource with the appropriate authorizations. In situations where Gimmal Link Enterprise plug-ins are utilized (such as more complex meta-data mapping or inbound processing SAP Key manipulation or custom usage), working with your SAP developer (if not that document admin already) will be necessary. On-going correspondence and collaboration will of course be required between your Middleware and CMS teams for configuration and testing of new patterns.   As new document types are configured, SAP Security may need to grant the necessary authorizations.  [title] SCRUD API’s [path] Agnostic Guides/Developers Guide/ All standard Link Enterprise functionally and processing relies on 5 methods within the class **/DFLOW/CL\_CMS\_API**. These methods are listed below and are free to use directly.  1. CMS\_API\_SEARCH 2. CMS\_API\_CREATE 3. CMS\_API\_READ 4. CMS\_API\_UPDATE 5. CMS\_API\_DELETE When using the SCRUD API's, you may wish to use the Link Enterprise Custom API Rule configuration table. This table with a key of "Label", allows you to specify input parameters to the SCRUD API set and thus avoid potential hard coding of the input parameters required. By using a "Label" to uniquely identify a Custom API Rule, you can then query the table /DFLOW/ZCMSC06 using that label to get such parameters as CMS Profile, CMS Use Tag, Repository ID, Location, etc. To create a Custom API Rule when DocManager is not installed, enter transaction /dflow/sys and choose the menu path Configure->API Rules->Custom. [title] Ping and Load API's [path] Agnostic Guides/Developers Guide/ Ok, we weren’t completely truthful, there are more than 5 API’s that made up the Link Enterprise SCRUD platform. Actually it is SCRUDPL. But it doesn’t sound the same when you say it. Here are the two additional API’s:  1. [CMS\_API\_PING](https://archbee.io/doc/S5CoH-hbYE3WVirr0PAcX/uelUumjbKwJRIfF3S0-ar) 2. [CMS\_API\_LOAD](https://archbee.io/doc/DKZ1T8K_JJwpxRYVu7bOJ/gpJqX-DBapcH42dz5OoRz) [title] Purpose of Guide [path] Agnostic Guides/Solution Guide/ The goal of this guide is to provide detailed configuration of specific integration patterns and Gimmal Link add-ons as well as an overview of all Gimmal Link Enterprise utilities. For details on architecture, supported environments, and system requirements please refer to the docuflow [Technical Overview](https://linkenterprise.docs.gimmal.com/technical-overview). For custom development, please refer to the [Developers Guide](https://linkenterprise.docs.gimmal.com/developers-guide). [title] Upload [path] Agnostic Guides/Developers Guide/Box Endpoints/ Link Enterprise provides an endpoint to upload files to. This is strictly for uploading files, and if you require metadata to be transferred following up with an update endpoint call is required. :::ApiMethodV2 ```json { "tab": "request", "url": "https://localhost:82/scrud/upload", "name": "Upload", "method": "POST", "request": { "pathParameters": [], "queryParameters": [], "headerParameters": [ { "kind": "required", "name": "cmsName", "type": "string", "description": "Name of the content management system configured in Link Enterprise." }, { "kind": "optional", "name": "location", "type": "String", "description": "Folder id where Link Enterprise is uploading the file. (box folder id) else root folder used." }, { "kind": "optional", "name": "Content-Type", "type": "string", "description": "multipart/form-data; boundary=(insert boundary)\n\nExample is included in code examples" } ], "bodyDataParameters": [], "formDataParameters": [] }, "results": { "languages": [ { "id": "81EVM7WXdGrYfDwshYJW6", "code": "SUCCESS EXAMPLE\n{\n\t\"id\": \"910645979785\",\n\t\"result\": \"success\"\n}\n\nFAILED EXAMPLE\n{\n\t\"id\": null.\n\t\"result\": \"fail\"\n}", "language": "200" }, { "id": "6U9gw-gSaolDqS3WcFi9t", "code": "", "language": "500" } ], "selectedLanguageId": "81EVM7WXdGrYfDwshYJW6" }, "examples": { "languages": [ { "id": "xY6nLYt-BP3jeEy_-jkb3", "code": "EXAMPLE\r\n-------\r\n> POST /scrud/upload HTTP/1.1\r\n> Host: localhost:82\r\n> User-Agent: insomnia/2021.7.2\r\n> Cookie: vertx-web.session=8c1a5313de4babf8825fe2114505da7e\r\n> Content-Type: multipart/form-data; boundary=X-INSOMNIA-BOUNDARY\r\n> location: 154829431337\r\n> cmsName: demoprod\r\n> Authorization: Basic ZG9jdWZsb3c6ZG9jdWZsb3c=\r\n> Accept: */*\r\n> Content-Length: 3693\r\n\r\n| --X-INSOMNIA-BOUNDARY\r\n| Content-Disposition: form-data; name=\"\"; filename=\"gimmal_4C.png\"\r\n| Content-Type: image/png\r\n| �PNG\r\n| \u001a\r\n-------\r\nEXAMPLE", "language": "none" } ], "selectedLanguageId": "xY6nLYt-BP3jeEy_-jkb3" }, "description": "Upload a file using HTTP multi part form data. HTTP headers specifying folder id, and the content system named must be specified.", "currentNewParameter": { "label": "Header Parameter", "value": "headerParameters" }, "autoGeneratedAnchorSlug": "upload", "legacyHash": "SYWoaQaa1CeAs6I_xHZZn" } ``` ::: [title] Delete [path] Agnostic Guides/Developers Guide/Box Endpoints/ Link Enterprise provides a web service endpoint that will allow you to delete a file. :::ApiMethodV2 ```json { "tab": "request", "url": "https://localhost:82/scrud/delete", "name": "Delete a file.", "method": "POST", "request": { "pathParameters": [], "queryParameters": [], "headerParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "id", "type": "string", "description": "id of the document" }, { "kind": "required", "name": "cmsName", "type": "string", "description": "Name of the box system configured in Link Enterprise." }, { "kind": "required", "name": "selectedCMS", "type": "string", "description": "Value should always be set to \"box\" to let Link Enterprise know which configured content system to search." } ], "formDataParameters": [] }, "results": { "languages": [ { "id": "ZbT9xDTdXEpCuzbNprahQ", "code": "", "language": "200" }, { "id": "b89YgQOhw-hoyU4iXf1ZM", "code": "", "language": "500" } ], "selectedLanguageId": "ZbT9xDTdXEpCuzbNprahQ" }, "examples": { "languages": [ { "id": "C4pSfZHstrxmG8KSy6hS0", "code": "{\n\n \"cmsName\": \"insertProductionSystemName (located in Link Enterprise gui)\",\n \"id\": \"127595030790\",\n \"selectedCMS\": \"box\"\n\n}", "language": "json" } ], "selectedLanguageId": "C4pSfZHstrxmG8KSy6hS0" }, "description": "Delete a File ", "currentNewParameter": { "label": "Body Parameter", "value": "bodyDataParameters" }, "autoGeneratedAnchorSlug": "delete-a-file", "legacyHash": "RZpY6k9dlIB2WTVx-E1YN" } ``` ::: [title] Link Enterprise BADI’s [path] Agnostic Guides/Developers Guide/ Link Enterprise provides BAPI's/enhancements spots in the following modules: 1. Base Content API 2. DocManager [title] Update [path] Agnostic Guides/Developers Guide/Box Endpoints/ Link Enterprise provides a web service endpoint that will allow you to update a document or folders metadata. :::ApiMethodV2 ```json { "tab": "request", "url": "https://localhost:82/scrud/update", "name": "Update File/Folder metadata", "method": "POST", "request": { "pathParameters": [], "queryParameters": [], "headerParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "id", "type": "string", "description": "Unique id of box file or folder." }, { "kind": "required", "name": "cmsName", "type": "string", "description": "Name of the box system configured in Link Enterprise." }, { "kind": "required", "name": "selectedCMS", "type": "string", "description": "Value should always be set to \"box\" to let Link Enterprise know which configured content system to search." }, { "kind": "required", "name": "type", "type": "string", "description": "Name of metadata template in box." }, { "kind": "required", "name": "metaDataFolderFlag", "type": "Boolean", "description": "true if setting metadata for folders\nfalse if not setting metadata for folders" }, { "kind": "required", "name": "mdArray", "type": "Array", "description": "A JSON array where each index is a json object with the keys \"md1\" and \"md2\". Where md1 is the column name, and md2 is the value to be inserted in that column." } ], "formDataParameters": [] }, "results": { "languages": [ { "id": "NP6_JKLUVfKwgT7ZC9ANV", "code": "", "language": "200" }, { "id": "2Qv2Iy-Q0df7ncSX-i60q", "code": "", "language": "500" } ], "selectedLanguageId": "NP6_JKLUVfKwgT7ZC9ANV" }, "examples": { "languages": [ { "id": "JlNcgO8TqXpNzQxN2xT04", "code": "{\r\n \"cmsName\":\"insertProductionSystemName (located in Link Enterprise gui)\",\r\n \"type\": \"insertMetaDataTemplateName\",\r\n \"id\": \"insert box folder id\",\r\n \"mdArray\": [\r\n {\r\n \"md1\": \"someColumnToBeUpdated\",\r\n \"md2\": \"newValue\"\r\n }\r\n ],\r\n \"selectedCMS\": \"box\",\r\n\t\"metaDataFolderFlag\":true\r\n\r\n}", "language": "json" } ], "selectedLanguageId": "JlNcgO8TqXpNzQxN2xT04" }, "description": "Update a file or folder metadata", "currentNewParameter": { "label": "Body Parameter", "value": "bodyDataParameters" }, "autoGeneratedAnchorSlug": "update-filefolder-metadata", "legacyHash": "TlPao_NbsVcmi0eER-y03" } ``` ::: [title] Delete [path] Agnostic Guides/Developers Guide/FileNet Endpoints/ Link Enterprise provides a web service endpoint that will allow you to delete a file. :::ApiMethodV2 ```json { "tab": "request", "url": "https://localhost:82/scrud/delete", "name": "Delete a file.", "method": "POST", "request": { "pathParameters": [], "queryParameters": [], "headerParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "ids", "type": "string", "description": "id of the document" }, { "kind": "required", "name": "cmsName", "type": "string", "description": "Name of the filenet system configured in Link Enterprise." }, { "kind": "required", "name": "selectedCMS", "type": "string", "description": "Value should always be set to \"filenet\" to let Link Enterprise know which configured content system to search." }, { "name": "location", "kind": "optional", "type": "string", "description": "filenet folder where the document needs to be deleted.", "children": [] }, { "name": "repository", "kind": "required", "type": "string", "description": "filenet repository Value", "children": [] }, { "name": "domain", "kind": "required", "type": "string", "description": "Filenet Domain name", "children": [] } ], "formDataParameters": [] }, "results": { "languages": [ { "id": "ZbT9xDTdXEpCuzbNprahQ", "code": "\"[completed]\"", "language": "200" }, { "id": "b89YgQOhw-hoyU4iXf1ZM", "code": "", "language": "500" } ], "selectedLanguageId": "ZbT9xDTdXEpCuzbNprahQ" }, "examples": { "languages": [ { "id": "C4pSfZHstrxmG8KSy6hS0", "code": "{\n \"cmsName\":\"Name of the filenet system configured in Link Enterpri.\", \n \"repository\":\"Filenet_Repository\",\n \"selectedCMS\":\"filenet\",\n \"domain\":\"Domain_Name\",\n\t\"location\":\"/folderName\"\n\t\"ids\":\"filenet Document Id\"\n}", "language": "json" } ], "selectedLanguageId": "C4pSfZHstrxmG8KSy6hS0" }, "description": "", "currentNewParameter": { "label": "Body Parameter", "value": "bodyDataParameters" }, "autoGeneratedAnchorSlug": "delete-a-file", "legacyHash": "RZpY6k9dlIB2WTVx-E1YN" } ``` ::: [title] Execution: Migration [path] Agnostic Guides/Solution Guide/Untitled/ The migration process is the phase in which for the entries selected (via the selection screen) in the migration table, content is READ from the source type (ArchiveLink content server, Gimmal Link Enterprise ECM endpoint, data file, or SAP DB) and created in the target system (ArchiveLink content server, Gimmal Link ECM endpoint, or SAP DB). This process uses all the input criteria available for selection parameters. Below is a description of your migration options. ## Keep Original SAPDocID This option allows you preserver the source SAPDocID (ie: \-arc\_doc\_id. This should only be done if required by another 3rd party or other dependency. `This option is only available for ECM target endpoints.` ## Check Multiple Links This option will check if a other migration entries exist for the the same: 1. source repository ID 2. source document ID (ie: SAPDocID / arc\_doc\_id) This is only valid if you have an artifact assigned to more than 1 SAP record. If you know or are unsure if you have 1 to many linkages, this option is safe to choose. There is no harm in choosing this option however it comes with decreased performance as each entry, before it migrated, reads the entire migration table to see if an entry with the same source repository ID/document ID has been migrated. If it finds an entry that is migrated, it does not "re-migrate" the document. Instead, it preserves the 1 to \ multiple link entries and simply creates the appropriate ArchiveLink link and marks the entry as migrated. Additional note: if you have or suspect multiple links, it is safest to choose single stream processing (For more information on these consideration, refer to the section/node "Migration Concepts and Strategies - Box" below). In theory, if parallel batches contain entries of the same source repository ID/document ID combination, and if they are attempted to be migrated at the same time, duplicate documents in your document repository could occur. This is the worst case. The migration will still be valid. ## Force RFC (recommended) This option allows you to override the RFC that the DocManager rule for the target entry will determine. If this is shared with day-to-day Gimmal Link Enterprise processing, it is highly recommended to have a dedicated RFC (and migration Gimmal Link connector) to migration only. For more information on these considerations, refer to the section/node "Migration Concepts and Strategies - Box" below. ## Force Source Rep ID This option allows you to force a source repository ID different than the source repository ID in the load table. `Should be used for unique testing in non-production systems only and should only be used if required.` ## Force Unique Filename This option allows you to force a unique filename in the target content repository, and in some cases (such as Box), this is mandatory to prevent versioning. The target filename will have the format \\_\.\ ## Replace Characters with SP This option allows you to identify a list of special characters all in a sequence (eg: %, or %\`@) and have them replaced by a space. ## Include Metadata (Gimmal Link Enterprise ECM only) Get/Map Source Metadata to Target Metadata If the source is a Gimmal Link Enterprise ECM endpoint - metadata can be* read *from the source and moved along with the content to the migrated. This requires the DocMigrator configuration described above "Source Metadata Mapping". Only properties configured will be transferred. You can make source metadata mandatory, in which case the entry will be flagged with an error if not found. Enhance/Compile New Target Metadata If the source does not support metadata, metadata can still be *added* to the content being migrated via DocManager, OR in addition to. This metadata can come from any available dataset since you can create an ABAP class-method to compile that metadata, thus you have full control. Of course, you can also add SAP metadata code free using the metadata map option in DocManager. You can make New Target metadata mandatory, in which case the entry will be flagged with an error if not found or compiled via the found DocManager rule. *\*If both sources of metadata are leveraged, the metadata compiled by DocManager will override any metadata with duplicate target property names.* Validate Only / Store Content You can choose to run a validation run only to ensure your configuration and metadata options are correct. A validation run will read data from the source, compile metadata if applicable, but will NOT create the content in the source system nor an ArchiveLink link. In a validation run, the following flags are set: 1. Source MD Exists (if applicable) 2. New MD Exists (if applicable) 3. Source Validated Auto Delete Return Table on Success - This flag helps delete the return table upon success. Auto Delete Source Content and Link on Success (SAP Db Only) - This flag is relevant for Source as SAP Database or GOS Attachments and if True, post migration the Source Content and link will be deleted including the reorganization of the database space used by the attachment in source db/repository. Auto Delete Source Link on Success (ArchiveLink Only) - Upon successful migration of the source document this flag if set will ensure deletion of the Archivelink entry from the link table defined in OAC3 against the Business Object and Source Archive Doc Type and Source Repository. Store content WILL create migrate the content (with metadata if applicable) and if successful, will also create an ArchiveLink link entry and set the following flags: 1. Source MD Exists (if applicable) 2. New MD Exists (if applicable) 3. Target Cont. Migrated 4. Metadata Migrated (if applicable) 5. Target Link Created Note that if you migrate an entry twice, the DocMigrator will skip that entry and place a message in the status table. The results of the Load phase are displayed on the screen according to the option "Display Results in ALV" checkbox. If this option is chosen, all entries are displayed in the ALV report format, else a simple message indicating the number of entries loaded successfully, with info message, or errors is displayed. If ALV is chosen, the header will display information as to the breakdown of entries loaded successfully, with info message, or errors. `Be careful when choosing "Display Results in ALV" as for large datasets this will significantly increase runtime and potential SAP system memory usage and timeouts. It is therefore suggested to use the "Display" mode of the migrator afterwards instead of displaying the results in ALV format. ` Clicking on the source or target hotspot/hyperlink in the ALV allows you to view the image. # [title] Execution [path] Agnostic Guides/Solution Guide/AuditLink/ The /DFLOW/AUDITLINK transaction provides functionality for retrieving and bundling attachments in SAP. ## Modes of Execution 1. Report This mode executes a predefined report program that supports filtering based on specific business objects. It displays details of the selected objects and uses them to determine which attachments are included in the bundle. Only documents that meet the inputted selection criteria are processed. 2. Spreadsheet In this mode, an Excel spreadsheet is uploaded containing a list of business objects. The transaction uses this list to locate and retrieve the relevant attachments. This is useful when the selection criteria are already defined externally or provided by another team. 1. The spreadsheet must be in a format where the first three colums are the exact say key(s). If the SAP key is a single field, columns 2 and 3 must remain empty. See the below example. Notice B and C colums are intentionally left empty. ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/Ve_ksXn-OIvRNbo8aJADI_image.png) 2. If the SAP key is a multi-part key, leverage columns 2 and 3 (if needed) accordingly. Below is an example of an FI invoice that has a three part key, thus columns B and C are leveraged. They must be in the order in which they appear concatenated in the SAP ArchiveLink table. 3. Everything after the first 3 columns is for cosmetic/informational only purpose on the SAP report and the resulting .html (if chosen), and can contain any values. 4. If there is a header line, make sure to select "Spreadsheet Has Header Line" so that AuditLink knows to treat it as such. 3. ArchiveLink This mode retrieves attachments using ArchiveLink metadata. Required parameters include the SAP object, object ID, archive ID, and CMS GUID. It directly accesses attachments based on these identifiers, bypassing the need for report-based or list-based selection. ## Optional Output Features 1. Include HTML When enabled, this option generates an HTML file that provides a structured summary of all the attachments included in the bundle. Each attachment is listed with a hyperlink, allowing for quick and convenient access. 2. Include Results File This feature creates a plain text (TXT) file summarizing the results of the attachment retrieval process. It includes counts of successfully retrieved attachments and notes the count files that failed to be retrieved, helping with auditing or troubleshooting. 3. Email When Done Enabling this option sends a completion email to the user once the bundle creation process finishes. This helps keep users informed without requiring them to manually check the transaction status. ## Execute The result list generated by the transaction includes a “**Create Local Bundle**” button. When the user clicks this button, they are prompted to enter a Bundle Name. This name is then concatenated with the designated folder name used for storing the bundle, allowing for more organized output file management. Once confirmed, this action triggers the bundle creation process. For Excel as a source based bundles, you must have the spreadsheet closed. Note: The excel method is only compatible with a windows user machine. After bundles are created, users can view them through the **Bundle Dashboard**, which displays all bundles created by the user to date. The dashboard provides key information for each bundle, including: - Bundle ID – Links to the list of business objects included in the bundle. - Execution date and time – Indicates when the bundle was created. - Number of attachments retrieved – Includes a count of both successful and failed retrievals. - Additional details – Displays the CMS Filename, the corresponding AuditLink report, and the full CMS Filepath, providing comprehensive visibility and traceability for each bundle. [title] Configuration Overview [path] Agnostic Guides/Solution Guide/ This document assumes as a precursor that Gimmal Link Enterprise SAP and middleware has been installed, base configuration has been completed, and that you have connectivity between Gimmal Link Enterprise SAP\<->Gimmal Link Enterprise Connector\<->CMS System as well as the base repository ID, CMS profiles, tags, destinations and repository ID’s ready to roll. :::BlockQuote Please ensure all steps in the Installation and Base Configuration Guide have been completed. ::: SAP Security is assumed to already by in place for the Gimmal Link Enterprise transactions and that future SAP authorization for adding and viewing documents (ex: S\_WFAR\_OBJ) has been considered. Please refer to the Gimmal Link Enterprise Installation and Base Configuration Guide (separate) for further information on the above. For Gimmal Link Enterprise SAP ABAP plug-in or direct web services development please refer to the Developer guide (separate). For technical overview please refer to the Technical Overview guide for that particular repository (separate). The below outlines an overview of the various configuration components of Gimmal Link Enterprise covered in this guide: 1. **SAPLink: **Provides automated Inbound processing from your CMS system to SAP for a wide variety of integration: automated link creation, triggering of workflows, execute custom ABAP code, and more 2. **DocManager: **Controls outbound document storage (via message output as well as Service for Object) as well as inbound (SAPLink) options such as linking and custom code triggering, as well as metadata transfer in both directions 3. **Custom API Usage:** Typically for use when only the base Gimmal Link API product is installed 4. **ChoiceLists: **Send SAP metadata in the form or flat and hierarchal list for use as drop-down and choice menus in your CMS system 5. **Workflow Connect: **Code free triggering of SAP Workflow including container fulfillment. WFConnect leverages DocManager for SAPLink inbound processing. 6. **AuditLink: **Utility to extract documents from your CMS system and generate HTML report with drill down to the extracted images for a disconnected from your SAP and CMS system access to an Audit “bundle” 7. **DocMigrator: **Migrate content (and metadata) from various sources to a Gimmal Link ECM endpoint, creating new links, deletion of old ones, as well as various utilities to go with 8. **Accounts Payable: ** A powerful yet flexible SAP based Invoice Processing and Approval workflow built on the SAP workflow runtime system. 9. **Publisher: **Routines to allow for message output (SmartForms, AdobeForms, etc.) to be stored with metadata in your CMS system 10. **LinkManger:** Provides and approval process for end users to delete links, with link managers controlling the final deletion as well as the content as an option 11. **Viewing and Attachment List Options: **Configure whether Gimmal Link DocManager is leveraged to store and view content including advanced viewing options, SAP DB Attachment and Note option, and more 12. **System Messages: **Prevent or warn users and API usage when needed during downtime or critical changes across the Gimmal Link Enterprise platform 13. **Utilities:** 1. **CMS Load: **Load various CMS system components into SAP (properties, docclasses, etc.) 2. **Link Maintenance: **Maintain ArchiveLink links 3. **Metadata Push: **Manually or scheduled metadata updates from SAP to your CMS system based on configured DocManager rules 4. **Cleaning Gateway Errors: **Maintenance of error in the Gimmal Link Enterprise API gateway 5. **Archiving Gateway Data: **Maintenance and archiving of Gimmal Link AEnterprise PI gateway log tables that may grow in size over time 6. **Attachment List Dashboard: **Report on ArchiveLink links with an enhanced selection criteria across all link tables 14. **Working with the API Gateway and SCRUD Test Harness: ** All Gimmal Link Enterprise processing is logged and reportable, including the testing of basic SCRUD API's with no coding. 15. **Fiori-based Link Enterprise DocManager Plugin:** This is an optional component for customers using Fiori user experience for end-users and wish to extend the Link Enterprise DocManager functionality to SAP Fiori Apps allowing users to attach and view documents via Fiori Launchpad on browser. `All configuration and utilities can be accessed via transaction `**`/dflow/sys`** [title] DocManager [path] Agnostic Guides/Solution Guide/ DocManager is the central component, actioned by “rules”, that enables and controls most Gimmal Link processing in both directions inbound and outbound from SAP.  This includes enabling further Gimmal Link Enterprise add-on’s that might leverage DocManager such as Custom API Usage, DocMigrator, WFConnect and Publisher for example.  It also allows you to specify what metadata is transferred in both directions, as well as viewing capabilities, options, and link management. We also provide a Fiori User Experience-based Link Enterprise DocManager that works seamlessly standard Fiori Apps and delivered as a Fiori Lanuchpad plugin. Check page "***Fiori DocManager - Launchpad Plugin***" for more details. ## Inbound to SAP DocManager processes 1. SAPLink Create Link 2. SAPLink Workflow Connect (WFConnect) 3. SAPLink Accounts Payable 4. SAPLink DMS 5. SAPLink Custom Processing (class-method ABAP) Note that all *inbound *to SAP DocManager processes require a rule in the Gimmal Link Enterprise Enterprise Connector to determine what content or events in your content management system are relevant to Gimmal Link Enterprise processing. `Refer to the SAPLink section of this document for more information.` ## Outbound from SAP DocManager processes: 1. Store New and Assign 2. Publisher 3. Custom API usage 4. DocMigrator *Outbound *from SAP DocManager processes requires only base installation and configuration. Please keep in mind however as you add outbound DocManager processes to consider load balancing the volume for performance reasons. Refer to the Gimmal Link Enterprise Installation and Base Configuration Guide for more information for information on these considerations. Note that you can also use Gimmal Link Enterprise to store business documents to non-Gimmal Link Enterprise Content Servers. Simply configure the repository ID and relevant DocManager rule within Gimmal Link Enterprise for a consistent user interface for all your storage, linking, and viewing. ## DocManager SFO/GOS Interface and Viewing Below are some of the advantage to using the Gimmal Link DocManager SFO/GOS interface: 1. Enhanced link attributes 2. Link Attributes for older systems with no implementation of table TOAAT 3. Delete Link Management via Gimmal Link Enterprise Link Manager 4. Multiple file / drag & drop that also support SAP GUI for JAVA 5. Virtual Link Manager to view links from connected SAP records without the duplication of link entries 6. Activity Logging and Viewing 7. `Allows storage/linking/viewing to both Gimmal Link and non-Link connections` 8. Advanced viewing options to show and hide SAP DB notes, SAP DB attachments, as well as all ArchiveLink attachments 1. The "hide" option is very useful for in-flight migrations for example 9. Advanced BADI options for a wide variety of customizing options 10. Allow "Notes" to be created in your external repository instead of your SAP database 11. Supports Viewing attachments by auto-group via classification, Gimmal Link flow, or file extension ## Configuration DocManager leverages standard SAP ArchiveLink and therefore entries for specified Document Types must exist already in OAC2, and have their link entry with SAP Business Object configured in OAC3. Additionally, with Gimmal Link Enterprise ECM it is highly recommended that you clear/disable the value in OAG1 "Always Copy Document Class from Document Type". This allows you to use the "\*" in the OAC2 document class column whilst at the same time letting Gimmal Link add the appropriate file extension (ie: document class) in the Reserve field of the SAP ArchiveLink table (eg: PDF, XLSX, etc). Configuring DocManager requires the below components: 1. Creating a DocManager Rule 1. Required for both inbound and outbound 2. Enabling Store New and Assign / Attachment List Menu Path 1. Required if you choose to use the Gimmal Link DocManager SFO/GOS dialogue window for either document linking, viewing, storage to non-Gimmal Link Enterprise repositories, or usage of Gimmal Link Enterprise Link Manager 3. SAPLink / Inbound to SAP Processing 1. Required for inbound processing only 2. Configured at the Gimmal Link Enterprise middleware level 4. Delete Link Management via Gimmal Link Enterprise Link Manager 5. Attachment List Options 6. SAP Logon Security Configuration ## Note on ArchiveLink Doctypes When creating document types in OAC2, consider the following: 1. Doctypes drive SAP create and viewing authorization 2. For Link Enterpise ECM or Content Server with Callback/Callback File move enabled: Doctypes drive location and metadata of document in SharePoint (and optional folder creation) 1. Reminder: Native Content Server (without Link Enterprise Callback File Move) uses repository ID for location. 3. If storing through content server AND viewing through content server (vs. any source of storage and viewing with ECM), you must create a document type for every file type/extension/mime-type ie: pdf, xls, xlsx, doc, docx, etc - which can result in a LOT of doctypes. 1. This can be avoided by using an \* in OAC2 and ensuring URL viewing is used. 1. No further config required when using ECM to view via URL, however for content server basic Content Server Callback must be configured/enabled. [title] SAPLink / Inbound to SAP Processing [path] Agnostic Guides/Solution Guide/DocManager/ \*Unsupported in S3 SAPLink is the inbound processing from your content repository ***to*** SAP. This can be leveraged to execute a number of Link Enterprise delivered functions in SAP or your own custom logic. Thus why we call SAPLink the "do anything pipe" into SAP. There are three components involved in SAPLink processing: 1. Ensure the CMS document class/object type/metadata template has the required fields for SAPLink processing 2. Configuration a "rule" in the Enterprise Connector middleware: This determines what content is to be processed, when, and what (if any) metadata is to be transferred. What is processing is dependent on the CMS system being used (outline more below). 3. Configuration of a corresponding DocManager rule in SAP that matches the document type configured in Step 2: This determines what action is to be performed in SAP (link a document, trigger custom code, start Accounts Payable workflow, etc.) Note: the Link Enterprise SAP system account specified in the middleware must have access to the transaction /DFLOW/GTW in its security profile to execute inbound to SAP Jco calls. Please refers to the section "Create SAP System Account" in the Base Installation and Configuration guide. The inbound processing rule determines: 1. What is to be processed 2. What metadata is to be sent to SAP ### How to configure a SAPLink rule in Enterprise Connector 1. Load up in the browser the Enterprise Connector [https://localhost:82/](https://localhost:82/Box) 2. Under "Mappings" click inbound to SAP. 3. Hover over each of the input boxes in the UI to look at sample values for each input box. 4. Click Save. 5. Restart the Link Enterprise windows service. ### Notes The DocManager rule in SAP determines what action is to be performed in SAP for each item "found" from a SAPLink rule in the connector. Each request is processing and calls a Link Enterprise BAPI within the SAP, which then reads the DocManager rule configuration found for that doctype. There can only be one ArchiveLink document type and SAP business object combination ever configured in the DocManager configuration, thus avoid sharing document types across SAP object (to avoid an inbound collision). Gimmal Link Enterprise will then execute the configured action and pass back a return, either an error or success. In the case of a success, the trigger property is set to False to prevent a re-processing of that item found. In the case of an error, the error property, if relevant to your CMS system, will be updated. In both scenarios, the doucflow user name and time stamp fields are updated. Upon a success SAPLink, metadata can also be enable to be transferred back to your CMS system. ### Rule Config: What is to be processed Inbound to SAP entries search for documents that meet a specific criteria and send the information to SAP for processing.  If processing completes successfully the trigger property is adjusted so that the document is not processed again.  If the processing were to fail by default the processing is tried again.  In order to not retry failed documents adjustments can be made to the filter string to omit documents that were in error.   | Setting | Description | Sample Value(s) | | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Enable Inbound to SAP | If checked configuration for Inbound to SAP is enabled and can be configured for inbound to SAP processing. |   | | SAP | The SAP system to send document metadata too. | SAP DEV ED1 | | CMS | The CMS system to get document metadata from. | | | Trigger data Type | Data type by which the saplink rule is triggered.
Task and Sign task type only applicable for Box workflow tasks. | Boolean, TimeStamp,
task and signtask. | | SAP Repo. | The SAP ArchiveLink repository that should be associated with this metadata being passed. | ZC | | SAP Type | The SAP ArchiveLink document type associated with this metadata being passed. | ZCONTRACT | | CMS Repo. | The content management system object store or repository.
| | | CMS Type | The content management system document class, object type or metadata template to look for the requested metadata in. | scmContracts | | Interval | The Inbound to SAP process searches for documents matching the configured criteria and then sends the information to SAP.  This interval determines how often the underlying content management system is searched.   | 10 | | Trigger Prop. | The content management system property or attribute associated with when to trigger sending information to SAP.


By default, Link Enterprise sets this property to True or False based on the result of a SAPLink call to SAP. These values can be manipulated via the Config.properties file with the below entries:

saplinkfalse.value=\ (for success)
saplinkerror.value=\









saplinkfalse.value=DoNotProcessSuccess
saplinkerror.value=DoNotProcessError | | Type | The trigger property or attribute type.
 
Boolean triggers happen when the Boolean property or attribute is set to true.
 
Timestamp triggers happen when the configured date/time property or attribute has no value.
 
**Currently, Box and M365 implementations only support Boolean trigger types (even though in Box the type is Single Value Dropdown Text and SharePoint is single line of text)** | Boolean | | Error Prop. | If an error happens while trying to process a particular file you can optionally store the error information in the content management system. | LinkEnterpriseSaplinkError | | Type | The error property or attribute type.
 
Boolean error types are only set to true if an error happens.
 
Timestamp error types only set a date/time stamp when an error happens.
 
String errors put as much of the error as they can into the configured error property or attribute.  This is the preferred configuration.

Currently M365 implementations only support String (single line of text) and Box supports Text. | String | | Max | An optional setting to limit the number of entries returned when searching for documents.
 
A setting of 0 has no limit. | 0 | | Filter | An optional (with FileNet and Documentum and implementations but required for Box) filter string to finely tune what is searched for in the underlying content management system. 
 
Refer to the where clause documentation for working with the Search Utility in the appendix for help configuring a filter clause.
 
For Documentum and FileNet filter clauses you must start with AND or OR since the documents are already being searched for by the configured trigger type so this additional filter logic needs to be added on with AND or OR notations.
 
Some examples are:
 
AND \ IS NULL  
(which omits documents that have already errored when using a String based Error Property)

OR LastModifier \<> ‘\’
(which handles updates to documents as well as the first time they are created)
 
OR LastModifier \<> ‘\’ AND \ IS NULL
(which omits error documents and also handles updates to documents)
 
OR r\_modifier \<> ‘\’
(which handles updates to documents as well as the first time they are created)
 
OR r\_modifier \<> ‘\’ AND \ IS NULL
(which omits error documents and also handles updates to documents)
 
For Box implementations you must enter in a filter clause which is the input to the metadata search web service for Box. | **(Box example): Search API**
mdfilters=\[\{"templateKey":"scmContracts",
"scope":"Hi enterprise","filters":\{"docuflowSaplinkTrigger":"True"}}]
\&limit=50\&offset=0
 
**(Box example): Metadata query:**
\{"from":"enterprise\_761921826.metadatatemplate","query":"docuflowSaplinkEnabled = \:value","query\_params":\{"value":"True"},"ancestor\_folder\_id":"131865107948"}
 
**(FileNet example not including documents in error)**
AND DocuFlow\_SAPLinkError
IS NULL

**(Sharepoint example)**:
fields/SAPFacility eq 'Complete' and fields/docuflowSaplinkTrigger eq 'True' | | Location | An optional location to further limit where documents are searched for.
 
This is only possible with FileNet and Documentum implementations and not possible with Box and SharePoint implementations. |   | | Order By | An optional order by clause to order the returned results.  Make sure to include the metadata being ordered by in the metadata comma separated list.
 
This is only possible with FileNet and Documentum implementations and not possible with Box and SharePoint implementations. |   | | Sub. | If enabled sub folders will be searched.
 
For more information refer to the Search Utility in the appendix for help.
 
This is only possible with FileNet and Documentum implementations and not possible with Box and SharePoint implementations. |   | | lineItemColumn | The line item column name which is referred to the csv files containing the line item information. | | ### Rule Config: What metadata is to be sent to SAP What metadata is sent from your repository to SAP is determined by the Metadata column: | Setting | Description | Sample Value(s) | | -------- | -------------------------------------------------------------------------------------------------------------------------------------------- | ------------------- | | Metadata | The comma separated list of metadata to send to SAP in the specified order.  These must match the SharePoint column names with exact casing. | title,contract,name | ### Rule Config: Sign Task sign task Config | Setting | Description | Sample Value(s) | | --------------------- | ---------------------------------------------------------------------------------------------------------- | ----------------------- | | sourceTriggerProperty | The content management system property or attribute associated to trigger when the sign task is completed. | middlewareOriginaldocId | [title] Using Microsoft Graph Explorer to Debug SharePoint Filters in Link Enterprise Middleware [path] Agnostic Guides/Solution Guide/DocManager/Untitled/ ## 1. Purpose Demonstrated how to use Microsoft Graph Explorer to debug SharePoint filters in Link Enterprise middleware. This helps identify whether issues originate from Microsoft Graph or the middleware layer. ## 2. Tools & References - **Graph Explorer:** https\://developer.microsoft.com/en-us/graph/graph-explorer - **Demo Tenant:** (yourtenant).sharepoint.com - **Sample Site ID:** https\://graph.microsoft.com/v1.0/sites/(yourtenant).sharepoint.com:/sites/VFSGMiddleware - **Sample Library:** /VFSGMiddleware/Equip/ ## 3. Benefits of Using Graph Explorer - Test filters instantly without restarting middleware - Isolate root causes between Graph and Link Enterprise - Discover internal SharePoint field names - Simulate customer scenarios for debugging **4. Corrected Graph API Filter Example** **Correct Syntax:** :::BlockQuote https\://graph.microsoft.com/v1.0/sites/.../list/items?$expand=fields&$filter=fields/SAPFacility eq 'Complete' and fields/LinkEtnerpriseSaplinkError0 ne 'True' ::: **URL-Encoded Version (for code):** :::BlockQuote ...?$expand=fields&$filter=fields/SAPFacility%20eq%20'Complete'%20and%20fields/LinkEtnerpriseSaplinkError0%20ne%20'True' ::: **5. Boolean Field Values** | Value | Boolean | | ----- | ------- | | 0 | False | | 1 | True | **6. Common Pitfalls** | Mistake | Result | | ---------------------- | ------------------------------------------- | | Using = instead of eq | Filter ignored | | Missing fields/ prefix | Query fails or returns incorrect results | | Unindexed fields | Filter errors unless workaround header used | | Null Boolean values | Ignored by Graph API | [title] Untitled [path] Agnostic Guides/Developers Guide/ [title] Agnostic Guides [path] / [title] AuditLink [path] Agnostic Guides/Solution Guide/ AuditLink is a tool that facilitates the secure collection, packaging, and sharing of audit-related files. It enables users to gather documents and content linked to SAP objects (ArchiveLink only), organize them into audit bundles, and distribute those bundles to auditors or relevant personnel. At the end of the process, AuditLink generates an optional HTML file that contains a summarized list of the all the collected contents. There are 4 methods to run AuditLink: 1. Delivered reports 2. Customized or new reports by yourself the customer - Best practice is to copy delivered report and change to suite your needs 3. Excel Spreadsheet 4. Direct ArchiveLink Table Selectdion Refer to the section 'Execution' for User instructions on how to run the various methods. ## Pre-Configuration Requirements Setup Content Repositories, CMS profiles and tags, and RFC destination as part of a standard Link Enterprise implementation. These will enable RFC communication between SAP and external repository(ies). ## SAP Security Requirements Running AuditLink requires 2 types of SAP authorizations: ### Link Enterprise SAP T-Code Authorization 1. Mandatory: Any AuditLink End-User will need access to the below transaction to create AuditLink Bundles. This should be granted by your SAP Securitiy Team: 1. /DFLOW/AUDITLINK 2. Optional: For a user to view previously create AuditLink bundles (for everyone), the below transaction can be granted: 1. /DFLOW/AUDITLINKDASH ### Link Enterprise Global or Attachment Level Authorization When you create a bundle, Link Enterprise checks its own config via transaction /dflow/sys and choose the menu path Configure->AuditLink->Security. At least 1 entry in this table must exist. For details on this configuration, please refer to the section below labeled AuditLink Configuration #3: Security. ## Bundle Location Configuration The destination for saving audit bundles must be a mounted drive (e.g., network share or mapped drive) accessbile by both the SAP system (in the background) and the User. This is setup in the 3 elements of setup/configuration below. Albeit configured in different methods and syntax, these three elements must resolve to the exactly the same location (ie: be a 3-way match). ### 1) Transaction FILE 1. Assign the physical path of the mounted drive to the logical path ZAUDITLINK using transaction FILE in SAP. - You must create the ZAUDITLINK logical file and ZAUDITLINK file path in your system - The destination (ie: home base for the bundles), albeit may not match in terms of format (example: Linux SAP system vs. windows network drive), must resolve to the same location as the User Workstation Accessbile drive below, as well as the section AuditLink Configurations 2.1.1 below. - Confirm the mounted drive is properly connected to the SAP system, allowing read/write access during audit bundle generation. - The physical path must have the parmaers \\\\ in exact casing wih the '\\' in between. - Example of Logical File: ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/QO4Mi_G3j9KI5e84l4Ecc_image.png) - Example of a Windows mounted drive logical path: ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/9QWU98H8kVrhhm1Ev45fu_image.png) - Example of an Azure file share mount logical file path: ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/jsHl2QZm1lgkNEF24r1K5_image.png) ### 2) User Workstation (OS) Accessible - Ensure the end user has appropriate read and write permissions to a mounted drive to the same location as the above FILE transaction as well as the section AuditLink Configurations 2.1.1 below. - Example of user workstation windows share: - ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/S5IwZbgTaKNis6IAER49B_image.png) ### 3) Bundle Locations See section AuditLink Configurations 2.1.1 below. ## Additional AuditLink Configuration Configure the AuditLink rule via transaction /dflow/sys and choose the menu path Configure->AuditLink. There are four AuditLink rule elements to configure: 1. Base Connectivity: Assign CMS tag to content repository. This tag identifies the RFC connection used to retrieve content from defined repository. 2. Bundle Locations: Define allowed locations where users can save audit bundles. 1 "root" location configuration entry is required, user based locations are optional. 1. WRoot Location: This must match the mounted drive in the "**Transaction FILE**" and "**User Workstation Accessbile**" location in the requirements outlined above. - This entry is specified with a '\*' in the user field. Example: - ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/wTL3sxbTuwfNQihFsxukf_image.png) 2. User Location (optional): This entry is at the user ID level and forces a bundle to be created in a folder within the root location. This could be by user or by controlling area or however you wish to organize your bundles. This typically is only used when you want to keep certain bundles separate for security or organization reasons. - Specify a location with no '\\', just a folder name. Example: - ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/9bjZYX_gX2VmETcMJLAQq_image.png) - NOTE: The folder COA1000 must ALREADY exist within the root location. 3. Security: This table specifies whether or not to enforce an S\_WFAR\_OBJ authorization check. This can be used to prevent users who do not typcially have authorization to view attachments to still create bundles. This can be determined by: 1. Option 1: A "global rule" level (\* or user id) OR whether to enforace at attachment level using the . 1. User ID Level: This is checked first. Leave all fields BLANK except for enter the SAP USER ID in the user name field. Example: 2. ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/sntIpaJ605PLdujm-DukD_image.png" size="40" width="564" height="540" position="center" showCaption="false"} 3. Wildcard Level: This is checked 2nd. Leave all fields BLANK except for a \* in the user name field. This is the most straight forward way to configuration AuditLink with or without S\_WFAR\_OBJ authorization (see below). Example: ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/MuFGvKwjTOyNtREc3znSe_image.png" size="40" width="628" height="462" position="center" showCaption="false"} 2. Option 2: This is only check if a global rule in Option 1 is not found. Based on content repository, SAP object, and document type. (note: user name field is ignored in this check). Do not uses \*'s. This option will perform 4 levels of granularity: 1. Exact match at Repository ID and SAP Object and DocType. 2. Exact match at Repository ID and SAP Object. DocType left BLANK 3. Exact match at Repository ID and DocType. SAP Object left BLANK 4. Exact match at Repository ID. DocType and SAP Object left BLANK 3. Regardless of which option, a rule must be found, and that rule determine whether S\_WFAR\_OBJ (Activity 03) is checked at the attachment level. This is determine by within the found rule, enabling/disabling the field "En.AuthCheck" as shown in the above example. 4. Note: At least one entry is required in this table. 4. Reports: Define reports to be executed when generating an audit bundle. Reports are based on a business object and tailored to the audit context. - Incl. HeaderDocs: Include attachments at the header level of the document in the final bundle. - Include HTML: Generate and include an HTML file summarizing the list of attachments. This file will be saved in the bundle folder. - Include Results: Add a .TXT results file to the bundle, showing a summarized count of successfully retrieved attachments and noting any failures. - Email: Send an automatic notification email to the user once the bundle creation process is complete. - Run Auto: Automatically generates a bundle name using the current date, time, and SAP user. Skips manual naming prompts. [title] Functional Overview [path] Agnostic Guides/Solution Guide/Untitled/ ## Summary The functional diagram below illustrates Gimmal Link Enterprise AP at a high level followed by a brief summary of each step. For more detail on each step and their configuration and options, please refer to the additional sections in this document: 1. Configuration 2. Working with TrackLink 3. Working with Statistics 4. Administration 5. Customization ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/Zh_BEMPFI9-ZX1bO-eBYa_image.png) ## Steps ### Invoice Capture Gimmal Link allows you to choose your method of capturing/scanning and ingesting your invoices. Once the invoice is in your content repository, Gimmal Link is configured to recognize they are ready to be sent to Gimmal Link in SAP to start the Gimmal Link Accounts Payable Workflow. ### i. Original Invoice Metadata It is ideal that your Invoice Capture process is able to recognize original invoice metadata at the time of comital to your content repository. Any metadata captured can be sent to SAP to assist the Gimmal Link Accounts Payable Workflow and drives Step 1 Initial Invoice Processing, drastically improving efficiencies in the overall processing of an invoice. This step is done automatically in the background by Gimmal Link. ### 1. Initial Invoice Processing This is the first step of the Gimmal Link Accounts Payable Workflow within SAP. This step can be configured for: 1. Pre-population of data to decrease data entry time and errors 2. Optional auto invoice creation 3. Exception Mangement 4. Optional auto exceptions 5. Dynamic Prioritization 6. Approver Selection (optional) 7. Initial AP Inbox Queue Load Management and Agent Routing 8. Optional Coordinator stage As mentioned above in the Invoice Capture Stage, any original invoice metadata that is available can be leveraged in the above configuration Gimmal Link Accounts Payable Workflow options. Users work from the Gimmal Link TrackLink queue which can be filtered and sorted and customized to be the most effective for your AP processing team. In addition to processing the invoice work-item, it also has a host of additional functionality for note taking, raising exceptions, reprocessing, and much more. In addition to flexible Gimmal Link Accounts Payable Workflow agent / role resolution setup, AP processing team can also configure Gimmal Link TrackLink to load balance work-items across a group. It is in the Initial Invoice Processing stage that once an invoice is created (parked, held, posted), Gimmal Link automatically creates a link to this invoice in your content management system. ### 2. Invoice Approvals After Initial Invoice Processing, and after any exceptions are triaged, is the approval stage. Gimmal Link Accounts Payable Workflow comes with up to 5 levels of approval. Approvers can be determined by the Gimmal Link Agent table (with optional dollar value thresholds), selected manually by the AP Clerk, or previous Approver (with optional ASL check), or more common ASL limits set forth in either your Organization Structure. Approver determination is also fully customizable if you would like to implement your own role resolution. The approval step can be configured to be skipped for PO based invoices. Rejections (based on configurable rejection codes), note taking, raising exceptions, display original attachments as well as adding optional additional document to your invoice and content repository are all standard functionality. In addition, external / outside of SAP approvals are available based on Gimmal Link's integration with your content repository or any non-SAP workflow runtime workflow engine, included mobile applications. ### 3. Final Invoice Processing The last step in the Gimmal Link Accounts Payable Workflow is final Invoice Processing. This step can be configured for: 1. Automatic posting of invoices 2. Skipping of this step if invoice is already posted 3. Exception Management 4. Optional auto exceptions 5. Dynamic Prioritization 6. Final AP Inbox Queue Load Management and Agent Routing This step is optional, and is often a different agent or group of agents than initial AP, as the last step in the workflow it is also the last chance to manipulate/check the invoice before posting and thus submitted to your standard SAP payment run. ### 4. Exception Management Exception Management is a big part and strength of the Gimmal Link Accounts Payable Workflow. Each dialogue step (ie: a work-item that is delivered to a user or group of users) has the option to "manually" raise an exception. We say "manual", as each step whether it be a dialogue step or a background step (a step in the workflow that is behind the scenes/automatic), can also be configured for pre delivered auto-exceptions as well as custom auto-exceptions. Auto Exceptions are those that occur before and Initial AP Clerk, Approver, or Final AP Agent receive a work-item. For exceptions of either variety, a work-item is generated to an agent/set of agents via configuration who in turn process / resolve the exception. When resolved, the work-item returns to the stage in which the exception originated. Exceptions can also be configured to allow termination of the workflow (duplicates, etc) as well as customized to trigger a non-Gimmal Link process, as well as optionally select approvers. Note that you can also choose to configure or customize the auto-completion of an exception as well (regardless whether it was raised automatically or manually). An example of raising an auto-exception would be for a PO based invoice in which the goods have not yet been received. The invoice (whether parked or not created) work-item can be automatically routed to an "Goods Not Received" exception. An example of auto-completion of an exception would be in the same scenario - you may choose to have a nightly job run that determine whether any work-items in the "Goods Not Received" exception have now been fully received. If they have been received, the exception is automatically set to resolved and the work-item returns to the next stage in the workflow. ### ii. SAP Invoice Metadata You can optionally configure any SAP metadata to be sent "back" to your content management system throughout the lifecycle of the invoice in the Gimmal Link Accounts Payable Workflow. This sending of metadata from SAP to your content management system before and after each every stage in the workflow, ensuring your content management system (CMS) is in sync. Some potential reasons to do this are: 1. Enable reporting in your CMS system 2. Enable retention in your CMS system 3. Enable workflows in your CMS system This step is done automatically in the background by Gimmal Link. ### a. Gimmal Link TrackLink Gimmal Link TrackLink is your home base for almost all elements related to the Gimmal Link Accounts Payable Workflow. Leveraging an SAP ALV "report" approach, the TrackLink toolset provides the following functionality: 1. Allows all agents (ie: Initial AP Agents, Exception Agents, Approvers, Final AP Agents) to process their assigned work-items 2. Acts as shared Inbox for work-items with multiple agents (no SAP Office required) 3. Fully configurable sorting and filtering of customer defined layouts to allow for prioritization, queue management, and different "views" of invoices to be processed 4. Advanced note taking and viewing 5. Viewing of images from your content management system 6. A suite of Administrator utilities such as: 1. forcing work-items to complete or terminated 2. mass note taking 3. year end rollover 4. agent re-assignment 5. and more. For more detail please refer to the section "Working with TrackLink" located in this document. ### b. Gimmal Link Statistics (beta only) Gimmal Link Statistics provides comprehensive analysis of your Gimmal Link Accounts Payable Workflow processing. These metrics include: 1. Average processing times per stage 1. Time to create/park/hold invoices 2. Time to approve 3. Time to post 4. Exception resolution 2. Average processing times per rule unit: 1. ArchiveLink DocType 2. Company Code 3. Invoice Type 4. Invoice Category 5. Business Unit 6. Invoice Flag 3. Deadlines missed 4. Discounts achieved and missed All metrics can be drilled down into for further detail and recognizance and analysis. You maybe also implement your own statistic gathering methods for additional metrics. For more detail please refer to the section "Working with Statistics" located in this document. ## DeadLine Monitoring Each dialogue step of the Gimmal Link Accounts Payable Workflow can be configured with deadline monitoring. Deadline monitoring is a feature of the SAP workflow runtime engine of which the Gimmal Link Accounts Payable Workflow is built upon. Each rule configured can be assigned a number of days in which a work-item must be processed within. If this does not occur, the work-item is automatically escalated. Escalation agents (or deadline agents) can be configured per rule or according to your needs such as based on your HR organizational structure. ## Notifications Each dialogue step of the Gimmal Link Accounts Payable Workflow can be configured for basic and customized notifications. Basic notifications send an email based on the agents SAP profile. This can be optionally customized to send notifications based on your preferred corporate communication platform. [title] DocMigrator [path] Agnostic Guides/Solution Guide/ Gimmal Link Enterprise DocMigrator provides an SAP based toolset to migrate content from a source system to a target Gimmal Link Enterprise supported repository, including SAP linkage maintenance, metadata transfer, plus additional follow up processing tasks. DocMigrator supports the following `sources:` 1. SAP Database Attachments 2. SAP Database Notes (these are represented as .txt files in the target system or export) 3. SAP ArchiveLink Content Server 4. Custom ABAP Class-Method 5. FileSystem 6. Gimmal Link ECM And the following `target` end-points: 1. SAP Database 2. Gimmal Link ECM 3. Content Server A Gimmal Link migration consists of **4 stages**: 1. Configuration 2. Load Migration Table - sets the stage for what is to be moved, where it is to go, and what options. These can be done via four methods: 1. ArchiveLink link table entries (most common) 2. .CSV file containing entries to be migrated and corresponding data files 3. A custom ABAP Class-Method to create either of the above two options 4. Content stored in your SAP database 3. Migrating Entries in the Migration Table - migrates the content w/ metadata if applicable and updates the status of the Migration Table 4. Perform any post-processing tasks or utilities - allows you to delete source content and links if applicable, plus more utilities A very useful utilities is the abilty to export content to a filesystem for review or validation. **In addition, for SAP Database Notes and SAP Database Attachments, the DocMigrator can be used to see what you have in your database if you are unsure. Often users will have been allowed to store content in the SAP Database without document administration or business owners knowing. ** In addition, you can delete the entire, or a portion (using all the Source and Target selection criteria) of the docManager load/migration table using the "Delete Migration Table option. Take extreme caution when doing so as your entries cannot be retrieved (albeit they can be re-loaded). As you process your migration steps, the DocMigrator updates link entries in the Migration table with the status and flags each step as it is completed. At any point you can display your Migration Table and its current state using the "Display" option. Compiled metadata (if applicable) and status messages can be drilled down/single clicked into from the ALV report for more detail (indicated by an underline). It is highly recommended to read the `Migration Concepts and Strategies `section on how to architect and execute your migration as it pertains to Gimmal Link Enterprise setup. In addition, `each content repository may have an additional notes or best practices section`, please ensure you reference if applicable. To configure DocMigrator, enter transaction /dflow/sys and choose the menu path Configure->DocMigrator. To enter the DocMigrator Dashboard, enter transaction /dflow/sys and choose the menu path Dashboards->DocMigrator. [title] Customizing [path] Agnostic Guides/Solution Guide/Untitled/ Albeit Gimmal Link Enterprise AP can be implemented code-free with its flexible and configurable platform, you can tailor the workflow even further to suite your precise needs via customization. All Gimmal Link Enterprise customization is accomplished via provided Gimmal Link Enterprise BADI's. Each BADI's interface is described more in the Gimmal Link Enterprise Developers Guide. Below is a list of all Gimmal Link Enterprise AP Workflow BADI's: `ENHANCEMENT SPOT: /DFLOW/APWF` ## Initialization - Classification BADI: /DFLOW/APWF\_BADI\~CLASSIFICATION Initialization of the workflow container occurs once per workflow at the start. This BADI allows you to modify the Classification of an invoice entry prior identification of a process rule (see below). ## Initialization - Processing Rule BADI: /DFLOW/APWF\_BADI\~PROCESSING\_RULE Initialization of the workflow container occurs once per workflow at the start. This BADI allows you to modify the Processing Rule for an invoice. ## Workitem Text BADI: /DFLOW/APWF\_BADI\~WORKITEMTEXT Gimmal Link Enterprise comes with default workitem text: Gimmal Link Enterprise AP: \ \ This BADI allows you to modify or create your own. ## Auto Create BADI: /DFLOW/APWF\_BADI\~AUTOCREATE Gimmal Link Enterprise comes with built in Auto Create logic for both NON-PO and PO based invoices. This BADI allows you to modify or create your own logic. ## Pre-Population Gimmal Link Enterprise comes with built in Pre-Population logic (in the form of BDC routines) for both NON-PO and PO based invoices. This BADI allows you to modify or create your own logic. BADI: /DFLOW/APWF\_BADI\~PREPOPULATION ## Auto Post BADI: /DFLOW/APWF\_BADI\~AUTOPOST Gimmal Link Enterprise comes with built in Auto Post logic for both NON-PO and PO based invoices. This BADI allows you to modify or create your own logic. ## Approver ASL Check BADI: /DFLOW/APWF\_BADI\~ASLCHECK Gimmal Link comes with built in ASL logic against its own Gimmal Link tables. This BADI allows you to modify or create your own ASL logic. ## Role Resolution / Agent Determination BADI: /DFLOW/APWF\_BADI\~ROLERESOLUTION Gimmal Link cEnterprise omes with built in Role Resolution logic against its own Gimmal Link tables. This BADI allows you to modify or create your own ASL logic. ## Notifications BADI: /DFLOW/APWF\_BADI\~NOTIFICATIONS Gimmal Link Enterprise comes with built in Notifications logic against a work-item recipient using their SAP profile. This BADI allows you to modify or create your own ASL logic. ## TrackLink BADI: /DFLOW/APWF\_BADI\~TRACKLINK\_DATA Gimmal Link comes with built in TrackLink queue monitoring, searching, and reporting. This BADI allows you to modify what data is being constantly updated and tracked by Gimmal Link. ## TrackLink ALV BADI: /DFLOW/APWF\_BADI\~TRACKLINK\_ALV Gimmal Link Enterprise comes with built a TrackLnk reporting ALV. This BADI allows you to modify columns and data displayed. ## Statistics BADI: /DFLOW/APWF\_BADI\~STATISTICS\_DATA Gimmal Link Enterprise comes with built in Statistics gathering and reporting. This BADI allows you to modify or create your own analysis logic. ## Statistics ALV BADI: /DFLOW/APWF\_BADI\~STATISTICS\_ALV Gimmal Link Enterprise comes with built a Statistics reporting ALV. This BADI allows you to modify columns and data displayed. ## Pre-Processor BADI: /DFLOW/APWF\_BADI\~PREPROCESSOR This BADI allows you to modify the workflow in-progress buffer and rule processing entry *prior *to each step of the Gimmal Link Enterprise AP workflow, for both foreground/dialogue work-items (Initial AP, Approvals, Final AP, Exceptions) as well as background steps (such as Auto Create, Auto Post). CAUTION: This BADI allows you to take complete control of the pre-process aside from possible agents. Use with caution. ## Post-Processor BADI: /DFLOW/APWF\_BADI\~POSTPROCESSOR This BADI allows you to modify the workflow in-progress buffer and rule processing entry *after* to each step of the Gimmal Link Enterprise AP workflow. This typically determines the "next stage" in processing. CAUTION: This BADI allows you to take complete control of the post-process. Use with caution. ## Pop-Up PBO BADI: /DFLOW/APWF\_BADI\~POPUP\_PBO This BADI allows you to modify the Gimmal Link Enterprise AP processing popup screen for Initial AP, Exception Manager, Approvals, and Final AP. You can enable and disable button, as well as change text. ## Pop-Up PAI BADI: /DFLOW/APWF\_BADI\~POPUP\_PAI This BADI allows you to modify the Gimmal Link Enterprise AP processing popup for logic Initial AP, Exception Manager, Approvals, and Final AP based on which pushbutton is selected. [title] Fiori DocManager - SAP Fiori Launchpad Plugin [path] Agnostic Guides/Solution Guide/DocManager/ **Deployment Guide for DocManager Fiori plugin (v3.0)** | | | | ------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Topic** | **Description** | | **Plugin Features** | | | Required Back-End Product |
SAP S/4HANA FPS 2021 and above
S4 CORE 106 or above (for draft mode support) | | Required Back-End ECM Components | SAP Transport (ECM) add-on | | Minimum UI5 Version Requirements | SAP UI5 1.114.11 | | Description |
Attachments are an integral part of business applications and processes. In SAP S/4HANA, the DocManager Fiori plugin is offered as a central unified solution for uploading attachments across applications. The applications can integrate operations such as upload, download, delete and access to virtual links.
The Link Enterprise DocManager Fiori plugin is a reusable component that can be integrated to any standard SAP Fiori Object based app e.g. Purchase Order based application to enable attachment capabilities in SAP S/4HANA. | | **Implementation Information - SAP Transports** | Contact Account Manager or VersaFile point of contact. | | **Implementation Information - Installation & Configuration** | - The app consists of front-end components (such as the user interfaces) and back-end components (such as the OData service). The back-end and front-end components are delivered as SAP transports and have to be installed in a system landscape that is enabled for SAP Fiori.

Front-End Components
• SAP BSP Application - /DFLOW/FIODOCMAN
• ICF Path - /sap/bc/ui5\_ui5/dflow/fiodocman
• UI5 Component - dflow\.fiori.plugin.docmanager.Component
• Package - /DFLOW/Link Enterprise\_FIO\_DOCMANAGER

Back-End Components (ABAP)
• OData Service –
External Service Name – /DFLOW/FIORI\_DOCMANAGER\_SRV
Technical Service Name - /DFLOW/FIORI\_DOCMANAGER\_SRV\_0001
Version – 0001
Package – /DFLOW/Link Enterprise\_FIO\_DOCMANAGER

• Plugin Definition –
Navigate to transaction - /UI2/FLP\_CONF\_DEF to define properties for your plugin as shown in screenshot below. (taken care by transports so more of validation)
-
:inlineImage[]{src="https://archbee-image-uploads.s3.amazonaws.com/eihAf9nQ3O9NUnS2cAmi6-hgfiLWVJX0Zm-PueN7tEB-20250616-145214.png" alt caption}

**Properties**: Below property definitions explained are key to the overall functioning of the plugin component. (These entries are delivered with package. Please consult your product support contact for any questions.)
:inlineImage[]{src="https://archbee-image-uploads.s3.amazonaws.com/eihAf9nQ3O9NUnS2cAmi6-D2BFW1aj8gkNx6jnKQp8N-20250616-145710.png" alt caption size="80" width="825" height="309"}
• BADGE\_MAX\_VALUE = badgeMaxValue
- The maximum number to display in the buttons' badge. If the number of attachments is greater than the maximum number, the maximum number followed by a plus sign will be displayed.
• DISPLAY\_BADGE = displayBadge
- Controls whether or not to display a badge next to the plugin button with the number of attachments.
• DISPLAY\_TYPE = displayType
- Is linked to the appearance or user experience of the plugin which basically is defaulted to ‘Dialog’ but alternatively ‘Popover’ is supported too.
• DRAFT\_ENABLED = draftEnabled
- This property is used to control the availability of draft feature in general.

**Enabling/Activating the Plugin (Customizing): **
/UI2/FLP\_CUS\_CONF → To make your plugin available in specific clients
:inlineImage[]{src="https://archbee-image-uploads.s3.amazonaws.com/eihAf9nQ3O9NUnS2cAmi6-bTMldYvVywWpdryohkO2k-20250616-145821.png" alt caption size="82" width="922" height="310"}

Property Values: Providing values to the property defined is performed in this transaction. These values govern the app behavior and shouldn’t be changed without consulting product support. Values are case-sensitive too.
:inlineImage[]{src="https://archbee-image-uploads.s3.amazonaws.com/eihAf9nQ3O9NUnS2cAmi6-vn4-fsx3MFLXA9fZXPHnh-20250616-150007.png" alt caption size="80" width="837" height="357"}
• UI Adaptation
The DocManager plugin was developed to replace SAP’s standard Attachment Services UI, addressing its limitations and offering additional functionality. To prevent users from seeing the default “Attachments” tab in Fiori apps, use the Key User Adaptation approach to hide the standard “Attachment” feature wherever DocManager is enabled.

Our solutions team will help adapting apps during implementation but for further details please refer to standard SAP guide here to learn more about pre-requisites and approach.

• Plugin Activation Control: In addition to the core ECM configurations in order for the Fiori plugin to work we also deliver an configuration cluster /DFLOW/FDMCFG that can be accessed via T-Code **/DFLOW/SYS -> Menu Path -> Configure -> “Attachment Services” -> “Fiori Options”** to control the plugin activation per any standard or customer Fiori apps and along with other additional technical details. Our solutions team works with customers to identify potential SAP Business Processes to be enabled and accordingly help populate required information based on your SAP S/4HANA version. Below is a sample entry for activating DocManager plugin for Business Partner app.
:inlineImage[]{src="https://archbee-image-uploads.s3.amazonaws.com/eihAf9nQ3O9NUnS2cAmi6-oa6PgKzwx82muQg9-D1YF-20250616-150121.png" alt caption size="80" width="754" height="226"}
| | **Validation Checklist** | - Validate Customers S/4HANA and Fiori Versions for compatibility and support. - Import DocManager related transports into development environment. - Activate (if needed) SICF services for oData and Plugin. - Validate entries for Fiori DocManager Plugin definition and activation entries in SAP Fiori Launchpad customizing. - Identify and enable plugin to desired SAP Standard Fiori apps. - Support customers to complete UI Adaptation on standard SAP Fiori Apps to hide “Attachment” tab. - Launch and validate Fiori DocManager plugin on all respective standard Fiori apps. | | **Technical Considerations – HDM Dependancies** |
- DocManager plugin works in absence of HDM functionality however if HDM is enabled below matrix will help clarify any limitation towards support for draft-mode in Fiori Apps.
:inlineImage[]{src="https://archbee-image-uploads.s3.amazonaws.com/eihAf9nQ3O9NUnS2cAmi6-LwNpXiESNiXsiXgUtJIl5-20250616-144342.png" alt caption size="82" width="601" height="139"}
| | **Technical Considerations – Standard Fiori Apps** | - Only limitation with standard Fiori Apps would be with support for Draft-Mode attachment feature as the plugin only supports SAP Standard Fiori Apps that are built using BOPF framework that provides the ability to handle drafts. Learn more [here](https://experience.sap.com/fiori-design-web/draft-handling/#top) about SAP draft handling concept and dependencies.
- URLs are well-formed and provide required information like Semantic Object, Action and Object Keys for the plugin to support effectively. Business Objects that are single-valued e.g. Purchase Order number or multi-valued object keys e.g. Purchase Requisition Item must be coded into URL with appropriate key-value pairing e.g.* PurchaseRequisition='1000489',PurchaseRequisitionItem='00030',*
- Recommendation - When customers leverage Fiori DocManager plugin, we recommend to hide the standard "Attachments" tab in SAP Fiori Apps to ensure the users are not storing attachments using standard SAP options. "Attachments" tab can be hidden using Fiori "**Key User Adaptation**" as explained here - [click here](https://help.sap.com/docs/ABAP_PLATFORM_NEW/a7b390faab1140c087b8926571e942b7/5c424437bf794f809087fdce391149f2.html)
:inlineImage[]{src="https://archbee-image-uploads.s3.amazonaws.com/eihAf9nQ3O9NUnS2cAmi6-AseBFYIvv-6ThdpiP89LF-20250618-162731.png" alt caption} | | **Technical Considerations – Custom Fiori Apps** | * Custom Apps must have a valid Semantic Object and Action associated with it. * Custom Apps must be associated to a BOR Business Object (standard or custom) to associate with ArchiveLink document types. * Custom Apps built using SAP’s standard guidelines for handling draft will be able to take advantage of draft-mode support in DocManager plugin. (*Learn more [here](https://experience.sap.com/fiori-design-web/draft-handling/#top) about SAP draft handling concept and dependencies*). * Custom Apps built using non-standard SAP Fiori floorplans need to be reviewed and tested on a case-to-case basis provided other points above meet the requirements. | | | | To conclude, this page is updated from time to time and any discrepancies found please reach out to your customer success contact. [title] Working with TrackLink [path] Agnostic Guides/Solution Guide/Untitled/ ## Overview Gimmal Link Enterprise TrackLink is a ALV based "report" that is considered home-base for all users and administrators. TrackLink is used as the end users processing queue as well as a host of additional functionality for inbox management, searching and tracking, and administrator functions. Below is a sample view of TrackLink (\*\*note: this is sample only — you configure and choose which columns are displayed — from available Gimmal Link pre-available columns to your own custom fields): ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/uaaveq3r-m7S_8g9pRIFb_image.png) Below is a list of functionality offered: 1. User inbox processing 2. Load balancing across processing group 3. Dynamic filtering and sorting 4. Wide range of search options 5. Configurable layout at the global or user level 6. Customizable layout content 7. Drill-down functionality to invoices, purchase orders, etc. 8. Integration with your SAP payment run status 9. Enhanced Work-Item Processing function: 1. Security based forwarding (optional) 2. Displaying image from content repository 3. Enhanced "note" taking and viewing 4. Exception processing 5. Reprocessing 10. Administrator functions: 1. Single and mass Reassignment 2. Single and mass forced completion and buffer status management 3. Single and mass enhanced "note" taking 4. Single and mass Role Resolution update 5. Full invoice year-end rollover toolset with link management ## Searching The ability to search and find a work-item quickly for customer support or other reasons is essential. Gimmal Link Enterprise TrackLink and its underlying structure means the data is at your fingertips without any data compilation that would result in long wait times. A wide variety of search options are available in standard SAP format (ie: select-options). Results are displayed in a straightforward layout and then be further filtered and sorted. Search results are independent of whether the user searching is able to process the work-item or not (they are of course prevented from processing if they are not a "possible agent"). You can choose to display in-progress invoices only or included completed workitems. ## User Inbox Processing and Functions User inbox processing is the day to day work queue of your AP team and Exception managers. Albeit TrackLink is also used by approvers when outside-of-sap or mobile approval is not configured, TrackLink flexibility is realized when leveraged as home-base for end-users main job is to process work-items. Working in tandem with configured role-resolution to determine "possible agents," Gimmal Link Enterprise AP and the underlying SAP workflow runtime system manages the sharing of these work-items and prevents work-items from being processed more than once. Once a user has "touched" a work-item, it is reserved by them for processing until it is either completed or resubmitted back to the larger "team". Therefore, at the highest level, a user can view any list of work-items (which is basically equivalent to Searching), but they can also choose to view work-items that they are a "possible agent" for / are allowed to process. By choosing to only view "their" work-items, this enables TrackLin to be their SAP Inbox for processing. A user can further filter and sort by configurable and saveable layouts to provide different "views" of their queue. Within their queue, there are 9 processing functions available: 1. **Execute Work-item: **The most common function, this allows the user to execute the work-item of which they are a possible agent of. What happens upon execution depends on the workflow stage and configured functionality (ie: create invoices, display invoice, approve invoice, triage an exception, etc). 2. **Display History: **Every detail about an invoice is logged extensively and is viewable for light reading enjoyment as well as analysis into the history of an invoice and its processing. 3. **Forwarding:** If *and only if* a user has the appropriate authorization, forwarding a work-item outside of the possible agent group is available. Enabling forwarding is completely optional and is typically driven by a customers internal process. 4. **Create Note: ** Allows you too notes to a work-item. 5. **Display Note List: ** Display a list of all notes for a work-item. You can then view the note itself by drilling down into that note. 6. **Display Note Summary: ** Displays a summary of all notes so you do not have to search through all the notes if there are a number of them. 7. **Display Work-item: ** Displays the SAP workflow runtime system work-item. 8. **Display CMS Image:** Displays the original invoice from your content management system. 9. **Drill-down: ** If the SAP invoice has been created, you can drill down to display without processing the work-item. You can also drill down into the purchase order. ## Administrator Functions If configured as a Gimmal Link Enterprise Administrator, the below functions are available. These functions can be processed for single work-items as well as mass processing: 1. **Force Buffer Status(Terminated/Completed/Reprocessed): **Administrators can force work-items to a particular status. 2. **Re-Assign:** Individual work-items can re-assigned to a different invoice. 3. **Create Note: ** Above what is available at the end-user level, Administrators can add mass notes to the list of work-items displayed. 4. **Forward:** Above what is available at the end-user level, Administrators can mass forward the list of work-items displayed. 5. **Role-Resolution Redo:** If agent configuration is changed, this allows the redo of the role-resolution logic to update the appropriate agents/possible agents. 6. **Year End Rollover: **SAP document number contain the fiscal year. For in-process work-items with SAP invoices that are not posted and year-end occurs, the year end process changes the key for the SAP invoice (including the SAP document number itself depending on your SAP configuration). The Gimmal Link Enterprise Year End Rollover Utility automatically: 1. Re-creates the invoice in the new year 2. Updates the Gimmal Link Enterprise AP database 3. Re-establishes any linkages to your content management system attachments 4. Can optionally set the previous years invoice as marked for deletion [title] Exceptions [path] Agnostic Guides/Solution Guide/Untitled/Untitled/ ## Overview Exception management is a very powerful and flexible component of the Gimmal Link Enterprise Accounts Payable Workflow. Exceptions take two forms with regard to how they are raised: 1. Manually by the agent of a work-item 2. Automatically by either Gimmal Link Enterprise pre-configured Auto Exceptions or by customization via customer BADI's Exceptions are in turn resolved via two methods: 1. Manually by the agent of a work-item 2. Automatically by either Gimmal Link Enterprise pre-configured Auto Exceptions or by customization via customer BADI's Exceptions can also be configured to call custom logic to suite unique customer requirements. ## Setup Below are the options for configuring Exceptions: 1. **Exception ID: **The exception ID is a 2-digit code that you create. You can use numbers such as 01-99 or letters. Typical use is 01 thru 99 with a zero padding for 01 thru 09. 2. **Workflow Stage:** Exceptions are configured per "workflow stage" levels. There are three levels to the Gimmal Link Enterprise Accounts Payable Workflow: a. Initial AP b. Approval c. Final AP If an exception is relevant to all three stages you can leave that field flag empty and it will be available in all three levels. 3. **Exception Code Text:** This is a free form description of the exception. 4. **Allow WF Termination:** Enabling this option provides the exception agent the option to terminate the entire workflow for this invoice. If this is disabled that pushbutton is greyed out. 5. **Force Resolve: **Enabling this option forces the originator of the exception to acknowledge that the exception has been resolved before processing further. 6. **Deadline (Days):** In days, how long a work-item will stay at the Exception stage before escalation. Who receives this escalation is configured in the Agents configuration (outlined later in this document). ## Role Resolution / Agent Determination Who will receive dialogue (foreground) work-items for Exceptions is configured in the Agent configuration. Refer to the section "Agents" later in this document. ## Customizing Options The following customizing options are available for Exception Management. For information on how to implement, please refer to the section "Customizing" later in this document. 1. **Custom Workitem Text:** To implement your own Workitem text. 2. **Custom Role Resolution / Agent Determination:** To implement your own logic to determine work-item recipients 3. **Custom Notifications:** To implement your own method of notifying agents. 4. **Custom Pre-Processor Logic:** Powerful BADI to take control of all pre-processing logic 5. **Custom Post-Processor Logic: **Powerful BADI to take control of all post-processing logic 6. **Custom POPUP PBO Logic: **To implement your own changes to the Gimmal Link pop-up windows for processing. 7. **Custom POPUP PAI Logic: **To implement your own logic to the Gimmal Link pop-up windows for processing. [title] Search [path] Agnostic Guides/Developers Guide/FileNet Endpoints/ Link Enterprise provides a web service endpoint that will allow you to retrieve a subset of documents based on a search criteria. :::ApiMethodV2 ```json { "tab": "examples", "url": "https://localhost:82/scrud/search", "name": "Search ", "method": "POST", "request": { "pathParameters": [], "queryParameters": [], "headerParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "cmsName", "type": "String", "description": "Name of the filenet system configured in Link Enterprise ." }, { "kind": "required", "name": "whereClause", "type": "string", "description": "A where clause Used to query filenet to return a set of files depending on criteria set." }, { "kind": "required", "name": "selectedCMS", "type": "string", "description": "Value should always be set to \"filenet\" to let Link Enterprise know which configured content system to search." }, { "name": "location", "kind": "optional", "type": "string", "description": "filenet folder where the file exists.", "children": [] }, { "name": "repository", "kind": "required", "type": "string", "description": "Filenet repository where the file exists.", "children": [] }, { "name": "domain", "kind": "required", "type": "string", "description": "Filenet domain where the file exists.", "children": [] }, { "name": "selectClause", "kind": "required", "type": "string", "description": "filenet metadata field on which search is performed.", "children": [] }, { "name": "fromClause", "kind": "required", "type": "string", "description": "metadata Class name where the metadata fields and values are available.", "children": [] }, { "name": "recursive", "kind": "required", "type": "string", "description": "enable it to check if the file exists inside a subfolder.", "children": [] }, { "name": "orderBy", "kind": "required", "type": "string", "description": "filenet property that needs to be displayed in response. This can multiple values separated with \",\".", "children": [] } ], "formDataParameters": [] }, "results": { "languages": [ { "id": "l7mAccvIkcMGyR03J3_aP", "code": "[\n\t{\n\t\t\"someRequiredMetadataField\": \"someRequiredMetadataValue\"\n\t}\n]", "language": "200" }, { "id": "C0tj4vmrgrTV7Xq8ZvvAu", "code": "", "language": "500" } ], "selectedLanguageId": "l7mAccvIkcMGyR03J3_aP" }, "examples": { "languages": [ { "id": "RinXZo0WaAz3lEkUOH2ux", "code": "{\n\"cmsName\":\"insertProductionSystemName (located in Link Enterprise gui)\",\n\"repository\":\"filenet_repository_name\",\n\"domain\":\"filenet_Domain_Name\",\n\"selectedCMS\":\"filenet\",\n\t\"selectClause\":\"someMetadataField\",\n\t\"whereClause\":\"This INFOLDER '/someFolderName' AND This = OBJECT('someMetadataValue')\",\n\t\"fromClause\":\"metadataClassName\",\n\t\"recursive\":\"True\",\n\"orderBy\":\"someRequiredMetadataField\",\n\t\"includeSubFolders\":\"True\"\n}", "language": "json" } ], "selectedLanguageId": "RinXZo0WaAz3lEkUOH2ux" }, "description": "Search for all documents using a where clause. If successful will return a JSON Array with a size greater then or equal to zero with status code of 200. Otherwise status code 500 is returned. If it's a known error returns 200 with error message in response.\n", "currentNewParameter": { "label": "Body Parameter", "value": "bodyDataParameters" }, "autoGeneratedAnchorSlug": "search", "legacyHash": "2I1lkUo-tBmvDr0MrlixB" } ``` ::: [title] CMS_API_CREATE [path] Agnostic Guides/Developers Guide/Untitled/ | **Functionality ** | **Description** | **FileNet Notes ** | **Documentum Notes**  | **Box Notes ** | **M365/SharePoint Notes ** | | ----------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------- | | IV\_CMSPROFILE** **



| Required: Determines which configured CMS Profile in Link Enterprise SAP to utilize. Combination of CMS Profile and CMS Tag determine the API destination and thus load across an RFC destination.  | | | | | | IV\_CMSTAG 



| Required: Determine which configured CMS Profile in Enterprise SAP to utilize. Combination of CMS Profile and CMS Tag determine the API destination and thus load across an RFC destination.  | | | | | | IV\_REPOSITORY 



| Required: Determines which configured repository in Link Enterprise SAP to utilize  | Object Store 



| Docbase 



| Default is the only Store/Repository supported since Box currently doesn’t support the notion of different repositories.  | Site, site collection 

| | IV\_TYPE 



| Optional: what CMS type to create. 
| DOCUMENT CLASS 

Defaults to the “Document” document class if unspecified.  | OBJECT TYPE 

Defaults to the “dm\_document” class if unspecified. 
| METADATA TEMPLATE 

Defaults to creating a document with no metadata template if not specified. | CONTENT TYPE 

Defaults to creating a document of content type Document if not specified.  | | IV\_USE\_MAPPING 



| Optional: use mapping of IV\_TYPE to CMS type in Enterprise Connector if CMS. Used if ArchiveLink doctype name to CMS type mapping is required.  | | | | | | IV\_ID 



| Optional: id to use for versioning a document. When specified a new version of the existing id is created with the given content.  | GUID 



| r\_object\_id 



| id 



| Versioning not supported 



| | IV\_FILENAME 



| Optional: the filename of the content being added to the CMS. If omitted some systems allow for a contentless document to be added.  | Used for the “content element” as well as the “DocumentTitle” unless “DocumentTitle” is set in the metadata which will override this. 

May be empty for a contentless document.  | Used as the “object name “as well as the “title” metadata property unless title is set in the metadata which will override this. If the filename is empty then the “title” is set to the “object id.” 

May be empty for a contentless document.  | Used as the “name” metadata property unless “name” is set in the metadata which will override this. 

Box requires that a filename and subsequent content be passed in since currently there is no support for a contentless document.  | Used as the “LinkFilename” metadata property 



| | IV\_CHECKIN\_AS\_MIN 
| Optional: performs the check-in as a minor version. | | | Not supported 
| Not supported 
| | IV\_CHECKOUT 

| Optional: allows you to checkout a document prior to creating a new version of the document.  | Only available with new versions. 



| Only available with new versions. 



| Checks out the document prior to creation and cancels the checkout after the creation has occurred to help guarantee no other person or process modifies the document while the creation call is happening.  | Not supported 



| | IV\_FIND\_CURFROM\_ID 



| Optional: allows you to find the latest version from the given id (since the id might not be the latest version of the document).  | | | Not supported since currently Box ids are the same for every version.  | Not supported since currently SharePoint ids are the same for every version. | | IV\_LOCATION 



| Optional: (Mandatory for M365/SharePoint) allows you to specify where to add the document in the content management system. | If unspecified documents are left unfiled. 



| If unspecified documents are stored in root of the users cabinet. 



| A number for the exact folder location can be specified. 

If unspecified documents are stored in the configured root. 

Relative folder names can be used with a / being the root. If a root folder is configured for the Box CMS in the Enterprise connector all relative folder locations will be relative to the root folder configured. 

Relative folder names are not recommended for performance reasons.  | This is required and is the Document Library 



| | IT\_FOLDER\_METADATA | Optional: metadata will be applied at the folder level instead of the file level. | Not supported | Not supported | Applies metadata at the top level folder only | Applies metadata at the top level folder only | | IV\_FOLDER\_NESTED | Optional: set to X if the use of CT\_CUSTOM you choose to use nested folders. | Not supported | Not supported | X = nested folders | Not supported | | IT\_METADATA 



| Optional: metadata to set during creation. 

Some metadata cannot be set during creation and is only read only (some system properties). 

Updating some system properties in certain repositories may lead to unknown results. 

The Link Enterprise username and timestamp properties are automatically set as metadata during creation if they are configured on the particular CMS tab in the Link Enterprise Connector. 

When the same keys are used multi valued properties are set with all of the specified values. The ZMULTI flag is ignored during a create since the same key signifies a multi valued property by default.  | To assist with the date format for FileNet, you may choose to utilize the Link Enterprise helper method ‘/dflow/cl\_utilities\_helper=>format\_date’ to format a system date field to the format desired 



| To assist with the date format for Documentum, you may choose to utilize the Link Enterprise helper method ‘/dflow/cl\_utilities\_helper=>format\_date’ to format a system date field to the format desired 



| Currently doesn’t support multi valued metadata. 

Where a date field is part of the metadata being sent, the format must be MM/dd/yyyy hh\:mm\:ss a z, where a z = the AM/PM and TIMEZONE 

example: 12/31/9999 12:00:00 PM MST T o assist with the date format for Box, you may choose to utilize the Link Enterprise helper method ‘/dflow/cl\_utilities\_helper=> format\_date\_plus\_sys\_timezone’ to format a system date field to the format desired and also appending the system timezone 



| Currently doesn’t support multi valued metadata. 



| | IT\_CONTENT | Optional if CMS supports folder creation and 1 or more folder are specified | | | | | | EV\_RETURNID 
| The id of the document added to the CMS.  | | | | | | ET\_RETURN 



| Table that indicates a success of an error. The TYPE field will contain an ‘S’ or ‘E’ respectively and the MESSAGE field will contain information in the case of an error. When you use the IT\_CUSTOM folder to create folders, the return table will also pass back the folder ID's created. The parent folder is indicated by a ! exclamation point, all sub-folders are indicated by a \~ tild. Example of return table when folders are created:
!SAP\_4500017723,147811962292
\~SAP\_SubFolder1,938382828
\~SAP\_SubFolder2,938382829
\~SAP\_SubFolder3,938382830 Refer to the below examples for more return table samples. | | | | | | CT\_CUSTOM 



| Optional: If supported by your CMS repository, the list of folder(s) to create.

This requires the BADI /DFLOW/DOCMANGER\_STOREANDLINK to be implemented.

You have two choices:
1. Flat Folder Structure
2. Nested Folder Structure

For nested, you must set the flag IV\_FOLDER\_NESTED

The first line is the parent folder, lines 2 and above are subfolders (optional).

By default, Link Enterprise places the content (when applicable) in the first folder/first line (when flat) or top level folder (when nested).

You can override this by placing a \~ tild preceding the folder name.

Example 1:
SAP\_PO\_HEADER\_4500012349 SAP\_PO\_LINE\_00010 SAP\_PO\_LINE\_00020 (content will be placed in first/top folder by default)

Example 2:
SAP\_PO\_HEADER\_4500012349 SAP\_PO\_LINE\_00010 \~SAP\_PO\_LINE\_00020 (content will be placed in last/lowest sub-folder)

\*note: the flag CS\_ZDMC01-ZOWNFOLDER must be set for fodlers to be created.

This can be et either in the docManager rule or directly via the BADI. | | | | Not supported 



| ### General Box comments:  - It is recommended to configure the “error on duplicate” in the Link Enterprise Connector since automatically versioning of documents with the same name can produce unpredictable results. - Locations can be specified either using the exact folder number or via a relative path with / being the root. If the location is specified via a relative path the folder names can take upwards of 1-2 minutes before a create using a relative path in the location field will find it. - General cleanup utilities are present in Box so that if an error happens when creating a document the document is attempted to be permanently deleted if permissions allow it. Otherwise subsequent cleanup may be required for failed documents. For instance if setting the metadata fails but creation of the document succeeds. They are handled via separate calls to Box so grouping them into a single transaction that can be rolled back is not possible. - By default (for performance reasons), Link comes with the updating of Box system properties (referred to as Basic Metadata) turned OFF. This affects both the CREATE and UPDATE API's. If you want to update Basic Metadata (note the any metadata templates and properties you create on your own are considered Custom Metadata, of which is always enabled), you will need to change the config.properties property box.basicMetadataUpdate=YES. Refer to the section "Adjusting Box Rate Limit and Basic Metadata" in the Base Installation and Configuration guide for more detail. ## Example Below is an example call from storing a document via Services for Object. Place a breakpoint at ![](https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/8yTXx9zXGFmARFGlCoyTH_image.png) ### Metadata passed ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/Xa3_dG7X44HUcH2uvpdaH_image.png" size="46" width="904" height="624" position="flex-start" showCaption="false"} ### Custom table passed In this example, we instructed Link Enterprise to create a 1 level subfolder. This is done by filling the CUSTOM table with the folder name: ::Image[]{src="https://archbee-image-uploads.s3.amazonaws.com/1hH4CNQG9tP4YS-TB-TC6/GXcydddLSdEHI3vPqf125_image.png" size="54" width="990" height="492" position="flex-start" showCaption="false"} ### Return table received note: in this return table, we see that we also have Link Enterprise configured to create a folder. When this occurs, the '!' indicates the folder name and the second value is the folder ID. [title] Base Content API [path] Agnostic Guides/Developers Guide/Untitled/ The below Link Enterprise BADI’s/enhancements spots are available within the Content API base component:  ## /DFLOW/ATTACHMENT\_LIST - BADI: /DFLOW/BADI\_ATTACHMENT\_LIST - Allows custom processing of the attachment list(s) used within Link Enterprise components (including API Gateway and DocManager). Useful for hiding attachments in certain situations that might be confidential to certain users (ex: document title for HR)above and beyond SAP authorization checks as well as to enable Virtual Linking functionality. - Virtual Linking is the concept of being able to display links in an attachment list that are from another SAP record (or object) as if they were linked to the SAP record being viewed. Examples of this are to show original MM invoices on the resulting FI invoice, original outline agreement attachments when viewing a purchase order, etc. ## /DFLOW/GENERATE\_VIEWING\_URL - BADI: /DFLOW/BADI\_GEN\_VIEWING\_URL - Allows custom manipulation of the URL generated and launched when viewing documents from the SAP or DocManager attachment list. [title] CMS_API_DELETE [path] Agnostic Guides/Developers Guide/Untitled/ | **Functionality** | **Description** | **FileNet notes** | **Documentum Notes** | **Box Notes** | **M365/SharePoint Notes** | | ----------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------- | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | IV\_CMSPROFILE** ** | Required: Determines which configured CMS Profile in Link Enterprise SAP to utilize. Combination of CMS Profile and CMS Tag determine the API destination and thus load across an RFC destination.  | | | | | | IV\_CMSTAG  | Required: Determine which configured CMS Profile in Enterprise SAP to utilize. Combination of CMS Profile and CMS Tag determine the API destination and thus load across an RFC destination.  | | | | | | IV\_REPOSITORY  | Required: Determines which configured repository in Link Enterprise SAP to utilize 
| Object Store 


| Docbase 



| Default is the only Store/Repository supported since Box currently doesn’t support the notion of different repositories.  | Site, site collection 



| | IV\_TYPE 
| Optional: what CMS type to delete.  | DOCUMENT CLASS  | OBJECT TYPE  | METADATA TEMPLATE  | CONTENT TYPE 
| | IV\_USE\_MAPPING 



| Optional: use mapping of IV\_TYPE to CMS type in Enterprise Connector if CMS. Used if ArchiveLink doctype name to CMS type mapping is required.  | | | | | | IV\_LOCATION 

| Optional: (Mandatory for M365/SharePoint only and not used in any other CMS system) Specifies where to delete the document from. 

| Not utilized. 

| Not utilized. 

| Not utilized. 

| This is required and is the Document Library. For documents originally created by Link Enterprise, this is stored at the time of create in a Link Enterprise table in the scenario that the config changes and thus can be used for subsequent deletes.  | | ET\_RETURN 



| Table that indicates a success of an error. The TYPE field will contain an ‘S’ or ‘E’ respectively and the MESSAGE field will contain information in the case of an error.  | | | | | | CT\_CUSTOM  | Future use  | | | | | [title] Sign (available version > 6.6.5) [path] Agnostic Guides/Developers Guide/Box Endpoints/ Currently Link Enterprise has an endpoint to create a request to sign documents and send them to multiple users to sign the file. :::ApiMethodV2 ```json { "tab": "request", "url": "https://localhost:82/scrud/createTask", "name": "Sign Documents", "method": "POST", "request": { "pathParameters": [], "queryParameters": [], "headerParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "id", "type": "string", "description": "Unique id of box file or folder." }, { "kind": "required", "name": "type", "type": "string", "description": "Name of metadata template in box." }, { "kind": "required", "name": "selectedCMS", "type": "string", "description": "Value should always be set to \"box\" to let Link Enterprise know which configured content system to search." }, { "kind": "required", "name": "body", "type": "Array", "description": "Json Array of strings (each index being a seperate line). \n\nOr can take a single string value \"singleLineExample\"" }, { "kind": "required", "name": "dueDate", "type": "string", "description": "Number of days from today the sign request is valid for.\n" }, { "kind": "required", "name": "recipients", "type": "Array", "description": "Array of strings of recipients of the task (email id)\n\n*User may require permissions to file before being able to be assigned a sign request." }, { "kind": "optional", "name": "enableSameDestination", "type": "Boolean", "description": "If true, signed document and signing log is stored in the same location as source file (destination id auto filledis generated by middleware).\n\nIf false, Signed Document and signing log is stored in the destination location.\n" }, { "kind": "required", "name": "destinationId", "type": "string", "description": "location where the signed document and signing log is stored (Only when enableSameDestination is false)\n" } ], "formDataParameters": [ { "kind": "optional", "name": "Parameter name", "type": "string", "description": "" } ] }, "results": { "languages": [ { "id": "qNYNaQPOhJ1UW-zegaFJ6", "code": "", "language": "200" }, { "id": "FRMYak2F3gPEAHrtkDAvt", "code": "", "language": "500" } ], "selectedLanguageId": "qNYNaQPOhJ1UW-zegaFJ6" }, "examples": { "languages": [ { "id": "npeO0usSroLpgszC5fpHh", "code": "{\r\n \"cmsName\":\"demoprod\",\r\n \"id\":\"917235734365\",\r\n \"taskType\":\"SIGN\",\r\n \"recipients\":[\r\n \"bhavanis@gimmal.com\"\r\n ],\r\n \"destinationId\":\"156906751612\",\r\n \"type\":\"purchaseOrder\",\r\n \"selectedCMS\":\"box\",\r\n \"dueDate\":\"1\",\r\n \"enableSameDestination\":false\r\n}", "language": "json" }, { "id": "ZhU-IX53oNPcu7rTsSn1n", "code": "", "language": "none" } ], "selectedLanguageId": "npeO0usSroLpgszC5fpHh" }, "description": "Create a sign request on a document", "currentNewParameter": { "label": "Body Parameter", "value": "bodyDataParameters" }, "autoGeneratedAnchorSlug": "sign-documents", "legacyHash": "HXHKMmNOQG4Wu9Aaw6lE_" } ``` ::: :::ApiMethodV2 ```json { "tab": "examples", "url": "https://localhost:82/scrud/createTask", "name": "Sign Documents", "method": "POST", "request": { "pathParameters": [], "queryParameters": [], "headerParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "id", "type": "string", "description": "Unique id of box file or folder." }, { "kind": "required", "name": "type", "type": "string", "description": "Name of metadata template in box." }, { "kind": "required", "name": "selectedCMS", "type": "string", "description": "Value should always be set to \"box\" to let Link Enterprise know which configured content system to search." }, { "kind": "required", "name": "body", "type": "Array", "description": "Json Array of strings (each index being a seperate line). \n\nOr can take a single string value \"singleLineExample\"" }, { "kind": "required", "name": "dueDate", "type": "string", "description": "Number of days from today the sign request is valid for.\n" }, { "kind": "required", "name": "recipients", "type": "Array", "description": "Array of strings of recipients of the task (email id)\n\n*User may require permissions to file before being able to be assigned a sign request." }, { "kind": "optional", "name": "enableSameDestination", "type": "Boolean", "description": "If true, signed document and signing log is stored in the same location as source file (destination id auto filledis generated by middleware).\n\nIf false, Signed Document and signing log is stored in the destination location.\n" }, { "kind": "required", "name": "destinationId", "type": "string", "description": "location where the signed document and signing log is stored (Only when enableSameDestination is false)\n" } ], "formDataParameters": [ { "kind": "optional", "name": "Parameter name", "type": "string", "description": "" } ] }, "results": { "languages": [ { "id": "qNYNaQPOhJ1UW-zegaFJ6", "code": "", "language": "200" }, { "id": "FRMYak2F3gPEAHrtkDAvt", "code": "", "language": "500" } ], "selectedLanguageId": "qNYNaQPOhJ1UW-zegaFJ6" }, "examples": { "languages": [ { "id": "npeO0usSroLpgszC5fpHh", "code": "{\r\n \"cmsName\":\"demoprod\",\r\n \"id\":\"917235734365\",\r\n \"taskType\":\"SIGN\",\r\n \"recipients\":[\r\n \"bhavanis@gimmal.com\"\r\n ],\r\n \"destinationId\":\"156906751612\",\r\n \"type\":\"purchaseOrder\",\r\n \"selectedCMS\":\"box\",\r\n \"dueDate\":\"1\",\r\n \"enableSameDestination\":false\r\n}", "language": "json" }, { "id": "ZhU-IX53oNPcu7rTsSn1n", "code": "", "language": "none" } ], "selectedLanguageId": "npeO0usSroLpgszC5fpHh" }, "description": "Use case scenario: Store signed document and signing log where orginal document is.\n\nWhen the enableSameDestination is set to true the signed document and signing log will be stored in the same location as source file (i.e; the parent folder of id)\n", "currentNewParameter": { "label": "Body Parameter", "value": "bodyDataParameters" }, "autoGeneratedAnchorSlug": "sign-documents-1", "legacyHash": "PIpIPihk5V3X_YsFdpJ32" } ``` ::: :::ApiMethodV2 ```json { "tab": "examples", "url": "https://localhost:82/scrud/createTask", "name": "Sign Documents", "method": "POST", "request": { "pathParameters": [], "queryParameters": [], "headerParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "id", "type": "string", "description": "Unique id of box file or folder." }, { "kind": "required", "name": "type", "type": "string", "description": "Name of metadata template in box." }, { "kind": "required", "name": "selectedCMS", "type": "string", "description": "Value should always be set to \"box\" to let Link Enterprise know which configured content system to search." }, { "kind": "required", "name": "body", "type": "Array", "description": "Json Array of strings (each index being a seperate line). \n\nOr can take a single string value \"singleLineExample\"" }, { "kind": "required", "name": "dueDate", "type": "string", "description": "Number of days from today the sign request is valid for.\n" }, { "kind": "required", "name": "recipients", "type": "Array", "description": "Array of strings of recipients of the task (email id)\n\n*User may require permissions to file before being able to be assigned a sign request." }, { "kind": "optional", "name": "enableSameDestination", "type": "Boolean", "description": "If true, signed document and signing log is stored in the same location as source file (destination id auto filledis generated by middleware).\n\nIf false, Signed Document and signing log is stored in the destination location.\n" }, { "kind": "required", "name": "destinationId", "type": "string", "description": "location where the signed document and signing log is stored (Only when enableSameDestination is false)\n" } ], "formDataParameters": [ { "kind": "optional", "name": "Parameter name", "type": "string", "description": "" } ] }, "results": { "languages": [ { "id": "qNYNaQPOhJ1UW-zegaFJ6", "code": "", "language": "200" }, { "id": "FRMYak2F3gPEAHrtkDAvt", "code": "", "language": "500" } ], "selectedLanguageId": "qNYNaQPOhJ1UW-zegaFJ6" }, "examples": { "languages": [ { "id": "npeO0usSroLpgszC5fpHh", "code": "{\r\n \"cmsName\":\"demoprod\",\r\n \"id\":\"917235734365\",\r\n \"taskType\":\"SIGN\",\r\n \"recipients\":[\r\n \"bhavanis@gimmal.com\",\r\n \"singetambhavani7@gmail.com\"\r\n ],\r\n \"destinationId\":\"156906751612\",\r\n \"type\":\"purchaseOrder\",\r\n \"selectedCMS\":\"box\",\r\n \"dueDate\":\"1\",\r\n \"enableSameDestination\":false\r\n}", "language": "json" }, { "id": "ZhU-IX53oNPcu7rTsSn1n", "code": "", "language": "none" } ], "selectedLanguageId": "npeO0usSroLpgszC5fpHh" }, "description": "Use case scenario: Multiple Sign Recipients.\n\nThe request can be sent to multiple signers. If one signer declines the request the whole request will be cancelled.\n", "currentNewParameter": { "label": "Body Parameter", "value": "bodyDataParameters" }, "autoGeneratedAnchorSlug": "sign-documents-2", "legacyHash": "0leZNxFv7elThWwOxLyQK" } ``` ::: [title] Configuration [path] Agnostic Guides/Solution Guide/Untitled/ ## Summary There are 5 categories of configuration for Gimmal Link Enterprise AP. Below is a brief summary. Refer to each categories section in this same document for complete details. `All Gimmal Link `Enterprise `AP configuration can accessed via two methods:` 1. Directly via transaction `/dflow/apconfig` 2. Via the Gimmal Link Enterprise System Dashboard (transaction /dflow/sys) and the menu path Configure->Accounts Payable. ## 1. Classification Locations, Invoice categories, business units, departments, and invoice flags help classify your invoices for processing and set how the below components can be configured. ## 2. Invoice Processing Rules Based on the classification of an invoice, processing rules determine the behaviour and flow the Gimmal Link AP workflow. ## 3. Rejection Codes Setup rejection codes for approvers. ## 4. Exceptions Define exceptions that suite your business. These can be raised automatically or via workflow agents. ## 5. Agents Setup role resolution to determine standard Gimmal Link Enterprise agent assigned for all stages of the workflow including Initial AP, Exceptions, Approvers, and Final AP. ## Customization Albeit Gimmal Link Enterprise AP can be implemented code-free with its flexible and configurable platform, you can tailor the workflow even further to suite your precise needs via customization. Customization is available throughout the Gimmal Link Enterprise AP Workflow in the form of customer BADI's. Refer to each section for customization options available relevant to that workflow stage, as well the section "Customizing" for a view of all customizations available. [title] Post-Processing Tasks [path] Agnostic Guides/Solution Guide/Untitled/ ## Delete Source Content You can use DocMigrator to delete source content after a successful migration. The source link must exist for the DocMigrator to do so. This is only applicable to source types: 1. SAP DB - ***In this case both Source Content and Link is deleted at same time.*** 2. ArchiveLink Content Server 3. ArchiveLink Gimmal Link Enterprise ECM Actual Source File deletion is not supported at this time for Archivelink based attachments. This process uses all the input criteria available for selection parameters. ## Delete Source Link You can use DocMigrator to delete source ArchiveLink links after a successful migration. Typically this is done after validation of your migration. If during the migration and validation time frame, you wish to not show duplicate entries in the SAP attachment list (if using the DocManager attachment list), you can optionally hide the target entries via the DocManager config until after all is completed and verified. Then unhide the new attachments and delete the old, or optionally keep the old links and simply hide them as well. This process uses all the input criteria available for selection parameters. The results of the Load phase are displayed on the screen according to the option "Display Results in ALV" checkbox. If this option is chosen, all entries are displayed in the ALV report format, else a simple message indicating the number of entries loaded successfully, with info message, or errors is displayed. If ALV is chosen, the header will display information as to the breakdown of entries loaded successfully, with info message, or errors. `Be careful when choosing "Display Results in ALV" as for large datasets this will significantly increase runtime and potential SAP system memory usage and timeouts. It is therefore suggested to use the "Display" mode of the migrator afterwards instead of displaying the results in ALV format. ` Clicking on the source or target hotspot/hyperlink in the ALV allows you to view the image prior to deleting the link or content, but of course is not supported after. [title] Custom API Usage [path] Agnostic Guides/Solution Guide/ Custom API usage is typically for use when only the base Gimmal Link Enterprise API product is installed. Usage of the Gimmal Link Enterprise (S)earch (C)reate (R)ead (U)pdate (D)elete API platform within SAP is outlined in detail the Gimmal Link Enterprise Developer Guide.  When using the SCRUD API set in a custom scenario and you have DocManager installed on your system, this section is may not relevant as you are encouraged to leverage DocManager rules to control API usage. In the scenario you have only the base CMS API installed, you may choose to utilized the creation of Custom API Rules to house relevant config, especially the mandatory input parameters for the SCRUD API set such as CMS Profile, CMS Use Tag, Repository ID, Location, etc, allowing you to leverage a unique "Label". You are responsible for what you use the available fields for as well the retrieval of them, as the SCRUD API set will only log itself in the Gimmal Link Enterprise API Gateway by default in terms of functionality.    To create a Custom API Rule when DocManager is not installed, enter transaction /dflow/sys and choose the menu path Configure->API Rules->Custom. Please also consult the Gimmal Link Enterprise Developer Guide for more information. [title] Update [path] Agnostic Guides/Developers Guide/FileNet Endpoints/ Link Enterprise provides a web service endpoint that will allow you to update a document metadata. :::ApiMethodV2 ```json { "tab": "request", "url": "https://localhost:82/scrud/update", "name": "Update File metadata", "method": "POST", "request": { "pathParameters": [], "queryParameters": [], "headerParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "ids", "type": "string", "description": "Unique id of filenet file." }, { "kind": "required", "name": "cmsName", "type": "string", "description": "Name of the filenet system configured in Link Enterprise." }, { "kind": "required", "name": "selectedCMS", "type": "string", "description": "Value should always be set to \"filenet\" to let Link Enterprise know which configured content system to search." }, { "kind": "required", "name": "mdArray", "type": "Array", "description": "A JSON array where each index is a json object with the keys \"md1\" and \"md2\". Where md1 is the column name, and md2 is the value to be inserted in that column. Sharepoint allows multi value field. while updating multi value fields separate the field values with \"!DFLOW!\"." }, { "name": "location", "kind": "required", "type": "string", "description": "filenet folder where the document need to be updated.", "children": [] }, { "name": "repository", "kind": "required", "type": "string", "description": "filenet repository Value", "children": [] }, { "name": "domain", "kind": "required", "type": "string", "description": "Filenet Domain name", "children": [] }, { "name": "checkout", "kind": "optional", "type": "string", "description": "If true, Does an Checkout on filenet document.", "children": [] }, { "name": "dateTimeFormat", "kind": "required", "type": "string", "description": "Update datetime property in this provided format.", "children": [] }, { "name": "type", "kind": "optional", "type": "string", "description": "Filenet Class name attached to the document. Default is \"Document\"", "children": [] }, { "name": "cancelCheckout", "kind": "optional", "type": "string", "description": "If true, cancel checkout on filenet Document.", "children": [] } ], "formDataParameters": [] }, "results": { "languages": [ { "id": "NP6_JKLUVfKwgT7ZC9ANV", "code": "", "language": "200" }, { "id": "2Qv2Iy-Q0df7ncSX-i60q", "code": "", "language": "500" } ], "selectedLanguageId": "NP6_JKLUVfKwgT7ZC9ANV" }, "examples": { "languages": [ { "id": "JlNcgO8TqXpNzQxN2xT04", "code": "{\n \"cmsName\":\"Name of the filenet system configured in Link Enterpri.\", \n \"repository\":\"Filenet_Repository\",\n \"selectedCMS\":\"filenet\",\n \"domain\":\"Domain_Name\",\n\t\"checkout\":false,\n\t\"dateTimeFormat\":\"MM/dd/yyyy hh:mm:ss a z\",\n \"type\":\"MetadataClassName\",\n\t\"location\":\"/folderName\",\n\t\"mdArray\":[\n\t{\"md1\": \"metadataField\", \"md2\": \"metadataValue\"}]\n\t\"id\":\"filenet document id\",\n\t\"cancelCheckout\":false\n}\n", "language": "json" } ], "selectedLanguageId": "JlNcgO8TqXpNzQxN2xT04" }, "description": "", "currentNewParameter": { "label": "Body Parameter", "value": "bodyDataParameters" }, "autoGeneratedAnchorSlug": "update-file-metadata", "legacyHash": "TlPao_NbsVcmi0eER-y03" } ``` ::: [title] DocManager Metadata maps [path] Agnostic Guides/Developers Guide/Untitled/ As a more powerful option to using the metadata map configuration, class/method metadata maps allow you to compile the SAP data via ABAP that will update your CMS documents (if configured) for outbound Gimmal Link storage and mass metadata push/updates. # Example Method: /DFLOW/CL\_DOCMANAGER\_HELPER=>METADATA\_EXAMPLE *The below example is provided with the *Gimmal Link Enterprise *product.* Signature:  | **Type** | **Parameter** | **Description** | **Sample Value** | | ---------------------------------- | ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------- | | Importing 
| IV\_SAP\_OBJECT 
| The SAP business object associated with this process  | BKPF  | | Importing 
| IV\_DOCTYPE 
| The ArchiveLink document type to use for linking documents with this process  | ZINVOICE01  | | Importing 
| IV\_SAPKEY 
| The unique identifier of the SAP records the link will be created to  | 300019000000002013 
| | Importing 
| IV\_ARC\_DOC\_ID 
| The unique identifier of the CMS document  | {83281172-DD17-4B8A-8913-9E5E69BA3125} | | Exporting 



| ET\_METADATA 



| This is the resulting table of key (case sensitive CMS property name) value (SAP data) pairs of the SAP data to update the CMS document with that you must fill with your ABAP code  | | Notes:  - If you want to update a multi-line property (only supported in Documentum and FileNet CMS systems), place an X in the field ZMULTI - For Box CMS systems where a date field is part of the metadata being sent, the format must be MM/dd/yyyy hh\:mm\:ss a z, where a z = the AM/PM and TIMEZONE - example: 12/31/9999 12:00:00 PM MST - To assist with the date format for Box, you may choose to utilize the Gimmal Link Enterprise helper method ‘/dflow/cl\_utilities\_helper=> format\_date\_plus\_sys\_timezone’ to format a system date field to the format desired and also appending the system timezone - To assist with the date format for FileNet and Documentum, you may choose to utilize the Gimmal Link Enterprise helper method ‘/dflow/cl\_utilities\_helper=>format\_date’ to format a system date field to the format desired [title] Publisher [path] Agnostic Guides/Solution Guide/ Publisher provides the ability to store your message output (such as SAPScript, SmartForms, AdobeForms, as well as any PDF, OTF, or Spool output) from SAP to your CMS system using Gimmal Link ECM (an\s an alternative to Gimmal Link Enterprise Content Server).   Typically a background process, your SAP generated content is stored, optionally linked to your SAP record, and metadata can be transferred from SAP to your CMS system.  This may be implemented using various methods depending on your SAP module such as but not limited to: message output, spool generation, workflow event, business transaction events, as well as customer enhancements spots. When utilizing Publisher for a particular message output you will need to add a call to a Gimmal Link Enterprise class-method at the end of your message output (program/function module).  If the message output is the delivered message output (program/function module) from SAP and has not be customized (sometimes referred to as a “Z” version) you will need to create an implicit enhancement point to include the Gimmal Link Enterprise code.  Creating the implicit enhancement point is outside the scope of this document. # Calling the Gimmal Link Enterprise Publisher code snippet In your custom code or enhancements, add code that calls the “publish\_message” method of the “/dflow/cl\_publishing”.   Please refer to the Gimmal Link Enterprise Development Guide for more info and an example. [title] CMS_API_SEARCH [path] Agnostic Guides/Developers Guide/Untitled/ | **Functionality ** | **Description** | **FileNet Notes ** | **Documentum Notes**  | **Box Notes ** | **M365/SharePoint Notes ** | | -------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | IV\_CMSPROFILE 



| Required: Determines which configured CMS Profile in Link Enterprise SAP to utilize. Combination of CMS Profile and CMS Tag determine the API destination and thus load across an RFC destination.  | | | | | | IV\_CMSTAG 



| Required: Determine which configured CMS Profile in Link Enterprise SAP to utilize. Combination of CMS Profile and CMS Tag determine the API destination and thus load across an RFC destination.  | | | | | | IV\_REPOSITORY 



| Required: Determines which configured repository in Link Enterprise SAP to utilize  | Object Store 



| Docbase 



| Default is the only Store/Repository supported since Box currently doesn’t support the notion of different repositories. | Site, site collection 



| | IV\_TYPE 



| Optional: what CMS type to create. 



| DOCUMENT
CLASS 
Defaults to the searching “Document” document class if unspecified. If “Include Subfolders” configuration is enabled on connector it will also include all sub classes of the document class. | OBJECT TYPE 
Defaults to the searching “dm\_document” class and all sub types if unspecified. 
| METADAT TEMPLATE 
Includes all documents with or without metadata templates if empty. 
| CONTENT TYPE 
Defaults to searching a document of content type Document if not specified. 
| | IV\_USE\_MAPPING 
| Optional: use mapping of IV\_TYPE to CMS type in Enterprise Connector if CMS. Used if ArchiveLink doctype name to CMS type mapping is required.  | | | | | | IV\_WHERE 



| Allows for adding additional search criteria with the search. With Box if used it is the only thing that can be specified while searching. 
| Refer to the “Relational Queries” section from the online FileNet P8 Info Center documentation for help with constructing advanced where clauses. 

Examples: DocumentTitle = ‘TEST.tif” \ IS NULL DateCreated > 20160801T080000Z DateCreated > 2016-08-01T12:00:00-08:00  | Refer to the Documentum DQL reference material for more information on constructing advanced where clauses.

Examples: \ IS NULL r\_modifer \<> '\' \ IS NOT NULL r\_modify\_date > DATE('08/01/2016')  | Refer to the Box api for the search api call for what can be used as the where clause. 

Examples: mdfilters=\[\{"templateKey”:”\