Embedding SEI into Sage X3

This feature has been available since Sage X3 v7. There are two ways to integrate SEI views:

  • The traditional/simple way is to take the SEI URL component and use it in Sage X3. Use the complete URL as found in Identify the Environment and add it as a widget in Sage X3 (refer to the Sage documentation).

  • The advanced integration allows filtering of SEI views according to the active field in Sage X3. To use this functionality, a patch must be applied.

In every case, you must make Adjustment for Syracuse (starting from X3U9P4 only) to post the SEI elements in Sage X3.

Important

Web browsers have updated their policy regarding cookies and these changes must be applied to your Web Server if you want SEI embedded into your ERP website, or use Single Sign-On (SSO). Refer to Cookie Management for more details.

Prepare the Sage X3 server

Adjustment for Syracuse (starting from X3U9P4 only)

  1. Open the file nodelocal.js with a text editor (Notepad, Notepad++). The default path for this file is: C:\sage\syracuse\syracuse\bin
  2. After the tag, add x3fusion and the following content (do not forget the initial comma), and change the web application address in "child-src".

,
                security:{
                "http": {
                        // HTTP headers added
                        "headers": {
                                "content-security-policy": {
                                         "child-src": [
                                                "'self'",
                                                "https://biprod.yourcompany.com:444","https://bidev.yourcompany.com:444"
                                         ]
                                },
                        }
                },
                "client": {
                        "iframe": {
                                "sandbox": {
                                        // The html vignettes allow 3 levels of security ('low', 'medium' and 'high') for sandboxing iframes
                                        "low": "allow-same-origin allow-forms allow-scripts allow-downloads allow-popups",
                                        "medium": "allow-same-origin allow-forms allow-scripts allow-downloads allow-popups",
                                        "high": "allow-same-origin allow-forms allow-scripts allow-downloads allow-popups"
                                }
                        }
                }
        }

Adjustment for SAFE X3 Web Server (starting from X3 2021 R2)

  1. In addition to the previous steps, Sage X3 has introduced a new security feature which allows iframes. Select the navigation menu and then go to Administration > Administration > Settings > External URL policies.

  2. Add new rules to match what you previously entered in the Syracuse nodelocal.js file.

Install the Patch

Important

The following steps are given as a guide only and should be supervised by a Sage X3 expert.

  1. Connect to the X3 folder and navigate to: Development > Utilities > Patch integration (PATCH).
  2. Choose the type of destination client, if the patch file is accessible from the work station.
  3. Tick the Patch Integration checkbox .
  4. In the Folder list, leave only the files that are required for the patch installation.


    Note

    Installing it in the X3 folder is not required.

  5. Click OK, choose the pth_ZBITG_XXXXXXXX_VX.dat and scr_ZURLMAKER_XXXXXXXX_VX.dat files, then click on OK again to complete the patch installation.

Identify the Environment

This information is necessary for the section Adjust the SEI parameters in Sage X3 and is found here:

  1. In SEI, go to the desired environment and open any view.

  2. In the Settings menu (right panel), click and select View External Link.
  3. In the new external link URL, read the value of envID in the URL and copy it to use in the next step.

Adjust the SEI parameters in Sage X3

  1. Go to the Sage X3 parameters: Setup > General Parameters > Parameter Values > SUP
  2. In all the folders where this is required, modify in DEF (default value) the following two parameters (installed by the patch):
Parameter Description Value
ZBIURLEID BI Environment ID

The environment identifier associated with the Sage X3 folder (obtained in the previous step).

ZBIURLSRV BI Web URL

The URL used to connect to SEI.

Configure the filter in the screen

The patch is supplied with 2 screens ready to be used and serves as the base to copy for the different possible filters:

  • ZBITGEX
  • ZBITGEXA: Filters the client on [M:BPC0]BPCNUM
Action Parameters Description
ZURLDES Value sent to ZURLMAKER. (no change)
ZURLFLD* Identifies SEI in the field used for the filter (Table.field).
ZURLKEY* Identifies Sage X3 in the corresponding filed serving the filter ([mask]field).
ZURLPID Identifies the SEI data model.
ZURLVID Identifies the SEI view.
Note

ZURLPID and ZURLVID are found in the following steps with the same environment ID described in Identify the Environment. The parameters to recuperate the URL are respectively PID and VID.

Adding a tab in a Sage X3 window

The following steps are given for information only and should be supervised by a Sage X3 expert.

The screen must be added to a window to be visible. For example, to add a tab in the Customers window:

  1. In the window (Development > Script dictionary > Window management), identify the Customers window (OBPC).
  2. In the screen tab, add a line in the screen ZBITGEXA under the tab.