Connect SEAL Operator/Web Portal¶
This use case describes how to configure distribution via the WEBPORTAL channel: PLOSSYS Distribution Engine uploads distributed files to a new SEAL Operator/Web Portal share and can notify receivers by e-mail. For more information refer to the SEAL Operator documentation.
The connector seal-dpf-workingunit-webportal is part of PLOSSYS Distribution Engine. SEAL Operator/Web Portal is not included and must be licensed and installed separately, refer to Architecture Overview.
Prerequisites¶
- SAP DDD is connected to PLOSSYS Distribution Engine, refer to Architecture Overview. For the SAP-side setup, refer to the chapter "Output via PLOSSYS Distribution Engine" in the SAP Document Distribution Director documentation.
- SEAL Operator/Web Portal is installed and reachable.
- The Web Portal connector is not active in SEAL Operator by default. Activate it and obtain a client ID and secret, refer to Connect the Web Portal on Linux or Windows.
- The SEAL-specific Keycloak provides a preconfigured client named
seal-webportalfor this purpose, refer to SEAL Clients. seal-dpf-workingunit-webportalis installed as part of PLOSSYS Distribution Engine and running, refer to Services.
Activate the Web Portal Channel¶
To activate the Web Portal channel, execute the following steps in SAP:
-
Start transaction
/n/seal/img. -
Navigate to
SEAL BC Sets→BC Sets PLOSSYS Distribution Engine(BC Set/SEAL/DDD_DST_DEV, registers theWEBPORTALoutput device together withEMAILandFILEOUTin one shared BC Set). -
Check the delivered defaults and activate the BC Set for the desired SAP order type, for example
PUR.Hint - related BC Set
/SEAL/DDD_DST_WP_DATpresets the job-level fieldsWP_DESCRIPTION,WP_EXP_DATE,WP_NAME,WP_NOTIFY,WP_PUBLIC, andWP_SHAREWITHfor order typePUR, and maps them to theWEBPORTAL_COLLECTION_*parameters, refer to Web Portal.
Configure the Distribution Engine Server¶
Execute the following steps on the Distribution Engine server.
Hint - work with a copy in the customer directory
We recommend copying webportal.ini from %DPFSRV%/conf/dpf4distribute/ to %SEAL_CUSTOMDIR%/server/dpf/conf/dpf4distribute/ and editing only the copy. For the directories, refer to DPFSRV and SEAL_CUSTOMDIR. If the copy exists, DPF reads it instead of the delivered file. The copy replaces the delivered file completely. Keep all entries of the delivered file in the copy.
-
Open
webportal.ini.Hint - file name follows
DIST_CONFIGThe file name follows the
DIST_CONFIGvalue passed from SAP. For the default valueWEBPORTAL, this iswebportal.ini. -
Check that the file contains the channel activation entry:
DistChannel_1 = dpf4distribute.DistributeWebportalCaution -
DistChannel_1is requiredWithout this
DistChannel_nentry, no file is uploaded even if the connection parameters are set correctly. -
Set the Web Portal connection parameters. Choose the variant that the identity provider supports:
-
Authentication with user name and password. This is the default:
WEBPORTAL_UI_URL = https://<web-portal-host>/ WEBPORTAL_OPERATOR_URL = https://<web-portal-api-host>:3008 WEBPORTAL_CLIENT_ID = <client-id> WEBPORTAL_CLIENT_SECRET = <client-secret> WEBPORTAL_USERNAME = <user-name> WEBPORTAL_PASSWORD = <password> -
Authentication with client credentials. Use this variant if the identity provider rejects the
passwordgrant type, for example because of multi-factor authentication. Available as of PLOSSYS Distribution Engine 2.2.0:WEBPORTAL_UI_URL = https://<web-portal-host>/ WEBPORTAL_OPERATOR_URL = https://<web-portal-api-host>:3008 WEBPORTAL_AUTH_GRANT_TYPE = client_credentials WEBPORTAL_CLIENT_ID = <client-id> WEBPORTAL_CLIENT_SECRET = <client-secret> WEBPORTAL_X_USER_AUTH_FILE = <directory>/xuserauth.jsonThe file in
WEBPORTAL_X_USER_AUTH_FILEcontains the claims of the Web Portal user for whom PLOSSYS Distribution Engine creates the share, for example:{"sub":"<user-id>","name":"<name>","preferred_username":"<user-name>"}Instead of the file, you can set the JSON object directly in
WEBPORTAL_X_USER_AUTH.Caution - client must be the trusted client of SEAL Operator
The client in
WEBPORTAL_CLIENT_IDmust have the client credentials flow enabled in the identity provider. It must also be the client configured inTRUSTED_CLIENTforseal-operator-webportal. Otherwise, SEAL Operator ignores the user information without an error message, and the share is not created for this user.
Hint - job-level parameters
Share-specific settings (name, description, expiration, sharing, public access) are passed per job via the
WEBPORTAL_COLLECTION_*parameters, refer to Web Portal. -
-
Open the configuration file for the connector service:
- Windows:
C:\ProgramData\SEAL Systems\config\seal-dpf-workingunit-webportal.yml - Linux:
/opt/seal/etc/seal-dpf-workingunit-webportal.yml
- Windows:
-
Set
RESTWU_URL_ORIGINto match the installation mode:HTTPS only(default):https://localhost:9126HTTP:http://localhost:9125
Caution - port 9126 is hardcoded
Refer to Ports. The DPF REST WU Manager port itself cannot be changed. Only which of the two (
9125/9126) this service connects to is configurable.
Create a Folder Structure¶
By default, PLOSSYS Distribution Engine places every distributed file directly in the share, without subfolders.
To create a folder structure in the share:
-
Set
DIST_FILENAMEto a path that includes one or more folder names, followed by the file name, for example:DIST_FILENAME = folder one/folder two/file.pdfPLOSSYS Distribution Engine creates the folders
folder one/folder two/inside the share and places the file there. -
To generate this path per SAP order or document automatically, configure a data evaluation in SAP, for example one folder per order and a subfolder per document level. If a data evaluation is not sufficient, a user exit can fill the
DIST_FILENAMERLI column using the working unitrli.fillcolumn.Hint - underlying job parameter
PLOSSYS Distribution Engine translates
DIST_FILENAMEinto theWEBPORTAL_TARGET_FILE_Njob parameter internally, refer to Web Portal.
Validate¶
-
In SAP, trigger a message for a purchase order that uses the
WEBPORTALchannel. -
On the Distribution Engine server, check that the output order was processed in the DPF Tracker.
-
In SEAL Operator/Web Portal, check that a new share was created with the expected files and receivers.