Embed SEI in Sage X3
Integrate SEI directly into Sage X3 (available since Sage X3 v7) to give users seamless access to analytics and reports within their ERP environment. Integration supports single sign-on (SSO) and can be accomplished in two ways: basic (embedding a widget) or advanced (dynamic filtering using Sage X3 data fields).
| Integration | Description |
|---|---|
| Basic | Embed a SEI URL in Sage X3 as a widget. Use the full SEI URL (see Identify the environment) in Sage X3 widgets, as described in Sage documentation. |
| Advanced | Enable filtering of SEI views based on the active Sage X3 field. This requires patch installation and additional Sage X3 configuration. |
Main steps
| Step | Description |
|---|---|
| Prepare the Sage X3 server | Configure server and security settings to allow embedding and secure integration. |
| Install the Sage X3 patch | (advanced only) Install the patch to enable embedded filtering using Sage X3 data fields. |
| Identify the environment | Obtain the required environment ID and URL from SEI for Sage X3 integration. |
| Set SEI parameters in Sage X3 | Configure Sage X3 with the proper web URL and environment ID for SEI. |
| Configure embedded filters | (advanced only) Set up parameters to filter SEI views using Sage X3 fields. |
| Add a tab in a Sage X3 window | Add the SEI screen as a new tab in a Sage X3 window, such as Customers. |
When embedding content, both the SEI server and Sage X3 ERP must use HTTPS to comply with browser security policies and ensure embedding and SSO work correctly. See Cookie Management for details.
Prepare the Sage X3 server
For Syracuse (starting from X3U9P4)
- Open
nodelocal.jsin a text editor. The default path is:C:\sage\syracuse\syracuse\bin. - After the existing content, add an
x3fusionentry and insert the following security configuration. Update the"child-src"values with the URLs of SEI.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"
}
}
}
} - Save the file and restart the Syracuse server if required.
For SAFE X3 Web Server (starting from X3 2021 R2)
Complete these steps in addition to the Syracuse configuration above.
- Log in to Sage X3.
- In the navigation menu, select Administration.
- Under Settings, click External URL policies.
- Add rules to match the allowed sources you entered in Syracuse
nodelocal.js.
Install the patch (advanced only)
The following steps are for reference only. Patch installation should be supervised by a Sage X3 expert.
- In Sage X3, open the navigation and select Development.
- Under Utilities, click Patch integration (PATCH).
- Choose the destination client type, based on where the patch file is accessible.
- Enable the Patch Integration option.
- In the Folder list, keep only the files required for patch installation.
- Click Ok, then select the
pth_ZBITG_XXXXXXXX_VX.datandscr_ZURLMAKER_XXXXXXXX_VX.datfiles. - Click Ok again to complete the patch installation.
Identify the environment
- Log in to SEI.
- In the navigation panel, select the correct environment.
- Select Data Models and Views, expand a data model and open a view.
- In the Toolbar panel on the right, select the Sharing icon, then click View External Link.
- In the external link URL, locate the
envIDvalue and copy it for use in subsequent steps.
Adjust the SEI parameters in Sage X3
- In Sage X3, open the navigation and select Setup.
- Under General Parameters, then Parameter Values, click SUP.
- In each required folder, update the following parameters (added the patch):
| Parameter | Description | Value |
|---|---|---|
| ZBIURLEID | BI Environment ID | The envID copied from SEI. |
| ZBIURLSRV | BI Web URL | The main SEI URL. |
Configure the filter in the screen (advanced only)
The patch supplies two screens for reference:
- ZBITGEX (generic filtering screen)
- ZBITGEXA (filters the client on
[M:BPC0]BPCNUM)
| Action Paramater | Description |
|---|---|
ZURLDES | Value sent to ZURLMAKER (leave unchanged). |
ZURLFLD* | Specifies the SEI field used for filtering (Table.field). |
ZURLKEY* | Specifies the Sage X3 field used as the filter ([mask]field). |
ZURLPID | Specifies the SEI data model ID. |
ZURLVID | Specifies the SEI view ID. |
ZURLPIDandZURLVIDare linked to the environment ID found in Identify the environment.- You can retrieve PID and VID parameters from the SEI view’s external link URL.
Add a tab in a Sage X3 window
These following steps should be performed by a Sage X3 expert.
- In Sage X3, open the navigation menu and select Development.
- Under Script dictionary, click Window management.
- Find the Customers window (
OBPC). - In the Screen tab, add a line to include the ZBITGEXA screen under the desired tab.