Partner Network Module
Page/Section: Module-PartnerNetwork-Overview
The Partner Network module enables configuration and management of partner-specific integrations. It supports connection creation for multiple transport industry segments such as TL, LTL, Parcel, Freight Broker, Telematics, 3PL, AIR, Ocean, and a Custom section that allows creation of generic integration types.
The module supports two login modes:
- SUPER ADMIN Domain
- Other Domains (Client / Partner Domain)
Partner Network Access Modes
Page/Section: Module-PartnerNetwork-Access
## Super Admin Domain
- Can create, update, remove, and manage partner network connection menus.
- Has access to the Actions toolbar with full controls.
- Created connection menus appear in all other domains automatically.
## Other Domains
- Can view the configured menus.
- Can create connection instances under Custom.
- Cannot modify or remove Super Admin managed menus.
Partner Network Actions Toolbar
Page/Section: Module-PartnerNetwork-Actions
Located in the upper-left corner:
| Button | Description |
|---|---|
| + | Create new connection menu |
| Edit | Edit selected Partner Network |
| Delete | Remove selected entry (if allowed) |
| Refresh | Reload list |
| Download | Export list data |
The Create button opens a category menu with tabs:
TL | LTL | Parcel | Freight Broker | Telematics | 3PL | AIR | Ocean | Custom
Inside Custom, users can select:
- JDBC
- REST
- SFTP
- AS2
- SOAP
- SMTP
Connection Creation Forms
Page/Section: Module-PartnerNetwork-Connection-Forms
Each connection type has a unique form layout. Required fields display asterisks (*).
JDBC Connection
Page/Section: Module-PartnerNetwork-JDBC
Key fields:
Category *
Connection Name *
Username *
Password *
URL *
Connection Color
Connection Type
Role
Hostname
Port
OS Authentication (toggle)
Kerberos Authentication (toggle)
Proxy Connection (toggle)
SID / Service Name
Action Buttons:
- Save
- Cancel
REST Connection
Page/Section: Module-PartnerNetwork-REST
Tabs:
Basic Details | Params | Headers | Authorization
Basic Details Fields
Partner Network Name *
Category *
URL *
Endpoint Configuration Section
Name | Sub URL | HTTP Method | Description
Action Buttons:
- Save
- Cancel
SFTP Connection
Category *
Partner Network Name *
Host *
Port *
Username *
Password *
Inbound Directory *
Outbound Directory
Archive Directory
Error Directory
File Pattern
AS2 Connection
Category *
Partner Network Name *
Partner Name *
AS2 Identifier *
Partner AS2 Identifier *
Partner URL *
Username
Password
Encryption Algorithm
Signing Algorithm
Signing Certificate Path
Encryption Certificate Path
Private Key Path
MDN Signed (toggle)
MDN Asynchronous (toggle)
Enable Compression (toggle)
SOAP Connection
Category *
Partner Network Name *
WSDL URL *
Endpoint URL
Service Name *
Port Name *
Username *
Password *
Authentication Type *
WS-Security Type *
Certificate Path
Private Key Path
SAML Token *
Connection Timeout (ms)
Read Timeout (ms)
SOAP Version
Proxy Host
Proxy Port
Proxy Username
Proxy Password
Enable SSL/TLS (toggle)
SMTP Connection
Category *
Partner Network Name *
SMTP Server *
From Email *
Port *
Username *
Password *
Security Type *
Reply-To Email
From Name
Max Connections
Connection Timeout (ms)
Socket Timeout (ms)
Enable Debug Mode (toggle)
Validate SSL Certificates (toggle)
Authentication Required (toggle)
Menu Creation & Propagation Rules
Page/Section: Module-PartnerNetwork-Menu-Behavior
| Action | Super Admin | Other Domains |
|---|---|---|
| Create Menu | ✔ Allowed | ❌ Not Allowed |
| Update Menu | ✔ Allowed | ❌ Not Allowed |
| Delete Menu | ✔ Allowed | ❌ Not Allowed |
| Create Connection | ✔ Allowed | ✔ Allowed |
| Edit Connection | ✔ Allowed | ✔ Allowed (for own created) |
| Delete Connection | ✔ Allowed | ✔ Allowed (for own created) |
Menu Visibility Logic
- Menus created in Super Admin propagate to all other domains.
- Removing a menu in Super Admin removes visibility from all domains.
- Domain users can create and manage their own custom connections independently.
Editing & Deleting Connections
Page/Section: Module-PartnerNetwork-Connection-Management
When selecting a connection record:
- Edit button loads full form with populated values
- Save button updates changes
- Delete removes the connection after confirmation
Summary
Page/Section: Module-PartnerNetwork-Summary
The Partner Network module enables scalable and domain-governed integration configuration. With role-based control, dynamic menu management, and support for major communication protocols (JDBC, REST, SFTP, AS2, SOAP, SMTP), it centralizes connectivity across the integration ecosystem.
Domain Usage of Partner Network Menus
Page/Section: Module-PartnerNetwork-Domain-Usage
After a menu is created in the Super Admin Domain, it becomes automatically available to all Other Domains. Users in these domains can use the existing Partner Network menu to create new connection instances without having permission to update or delete the original menu.
## Domain Behavior Explanation
| Action | Super Admin Domain | Other Domains |
|---|---|---|
| Create Connection Menu | ✔ Allowed | ❌ Not Allowed |
| Edit Connection Menu | ✔ Allowed | ❌ Not Allowed |
| Delete Connection Menu | ✔ Allowed | ❌ Not Allowed |
| Create Connection Instance | ✔ Allowed | ✔ Allowed |
| Edit Connection Instance | ✔ Allowed | ✔ Allowed (only own-created) |
| Delete Connection Instance | ✔ Allowed | ✔ Allowed (only own-created) |
## Domain View Layout
When a domain user accesses the Partner Network page, the list displays:
- ID
- Name
- Type
- Description
- Status toggle
- Search bar
- Category filter
- Column selector
- Record selection checkboxes
- Pagination controls
Example UI elements based on screenshot:
[+] [Refresh] [Edit] [Delete] [Update] [Test] [Export]
| ID | Name | Type | Description | Status |
Users can click the Create (+) button to build a new connection using the selected menu template (e.g., REST, SFTP, AS2, etc.).
Created records appear in the table and support:
- Edit
- Delete
- Search & filtering
- Status toggle (Enable / Disable)
This ensures centralized control managed by Super Admin while allowing partners to configure their communication endpoints independently.