Copyright©2025 Yonyou Group All rights reserved.Without the written permission of Yonyou Group, no part or whole of the content of this user manual may be copied, reproduced, translated, or reduced for any purpose. The content of this user manual may change without notice, please be aware.Please note: The content of this user manual does not represent the commitments made by Yonyou.Integrated PublicConnection ManagementHybrid Cloud GatewayFunction DescriptionThe gateway is a bridge that operates in the enterprise DMZ area, helping the internal ERP of the enterprise connect and communicate with external cloud services. It carries important functions such as external system access to ERP management services, API calls, and data synchronization.According to different server operating systems, it is necessary to download the corresponding gateway, install and deploy it, and place the key in the specified file. A single gateway can support connections from multiple systems, and it also supports multiple gateways deployed to connect to the same BIP.Key AppsGateway Homepage: Displays all gateways created by the tenant, allowing users to check the online status of each gateway.Create Gateway: Add a new gateway, maintain gateway code, name, and description information;Edit Gateway: Maintain gateway information, provide modification of basic gateway information, client-side connection information, view connectors under the gateway, update and deploy connector adapters, and other functions;Download Gateway: Download Gateway Client;Download Key: Download Identity Key.Column DescriptionGateway Basic InformationColumn NameDescriptionGateway CodeUser-defined gateway codeGateway NameUser-defined gateway nameGateway Server IPIP address of the server where the gateway is deployed; can be obtained by clicking to get the IP address when the gateway startsOutbound Port NumberDesignated port for internal network calls to the gatewayWhitelistIP whitelist that can call the gateway, separated by commas; if not set, all can access by defaultConnector InformationField NameDescriptionConnector Instance IDIdentifier for the connector instance in the connection configurationConnector CodeIdentifier for the connector typeConnection Adapter CodeIdentifier for the corresponding adapter typeConnection Adapter NameName of the corresponding adapter typeConnection CodeUser-defined connection identifierConnection NameUser-defined connection nameConnection Adapter StatusONLINE indicates the adapter has been deployedConnection Adapter VersionVersion information for the corresponding adapterOperation InstructionsEnter [Connection Integration Service > Data Integration > Gateway > Hybrid Cloud Gateway] function.1.Gateway Home PageDisplay all gateways created by the current tenant, sorted in descending order by gateway creation time.2.Create GatewayClick the
button on the gateway homepage to open the [New Gateway] window.Enter gateway code, name, and description information, where code and name are required fields, and the code must be unique.Select the gateway client deployment mode, where you can choose between single deployment and cluster deployment. Single deployment means installing only one client; cluster deployment means installing multiple clients as needed to form a cluster. These can be installed on the same server or on different servers. Client instances under the same gateway cluster must use the same key file downloaded from the gateway. Clients with different key files cannot form the same gateway cluster.If the deployment mode is set to cluster deployment, all server IPs where the clients are installed need to be entered in the server IP edit box, with each IP on a new line. Only after entering the server IPs and preserving them can the clients on these servers start normally.3.Edit GatewayClick on the gateway card or details in more to enter the gateway editing page. The gateway needs to be online to edit information.Pop up the [Gateway Edit] page, as shown in the figure below:In the [Basic Configuration] tab, the basic information of the gateway, client connection information, and advanced settings are displayed. Click the button to modify the basic configuration information of the gateway, and click the button to save.The interface will display different content based on the deployment mode and connection method, as shown in the figures below:[Single Deployment, WEBSOCKET Long Connection][Single Deployment, HTTP Direct Connection] Figure[Cluster Deployment, WEBSOCKET Long Connection] Figure[Cluster Deployment, HTTP Direct Connection] FigureThe content of each field in the basic information is the same as that in the new gateway page, and will not be repeated.The explanation of each field in the client connection information is as follows:Connection method: Refers to the connection method between YonBIP public cloud and the client, including two methods: 【WEBSOCKET long connection 】 and 【HTTP direct connection】. Among them:【WEBSOCKET Long Connection】: Refers to the connection request initiated by the client to the public cloud server when the client starts. Once connected, this channel will remain effective for a long time, allowing direct communication between the public cloud server and the client without the need to establish an HTTP connection in real-time. This method has higher security, as it only requires the server where the client is located to have network access permissions to the public cloud server, without needing to open external network access permissions to the server where the client is located.【HTTP Direct Connection】: It is necessary to enable external network access permissions for the server where the client is located. Public cloud and client access requests need to be connected in real-time via the HTTP protocol. Due to the need to open external network access permissions, the security level is lower than that of 【WEBSOCKET Long Connection】.Intranet Access IP: Displayed when the deployment mode is single deployment. The client provides an interface that allows the customer's internal system to access public cloud services through the client. The IP and port of this interface are the set 【Intranet Access IP 】 and 【Intranet Access Port】. If the gateway client server has multiple network cards, the administrator needs to select the IP of one of the network cards using the button.Intranet access port: Displayed when the deployment mode is single deployment. The port number automatically assigned by the system after the gateway client starts is defaulted to 【22277】. If this port number is occupied, the gateway client will not start successfully, and the administrator will need to modify this port and preserve it. The customer will use the new port to start.Client Direct Connection Address: Displayed when the deployment mode is single deployment and the connection method is [HTTP Direct Connection]. This address must be accessible from the external network and must be a complete address that includes http(s)://, for example: http://10.10.10.10:8888. The customer can directly grant the client external network access permissions; this address is the external address of the client. The customer can also install an nginx in the DMZ area and route to the client through nginx; this address is the external address of nginx.Client direct connection port: Displayed when the deployment mode is single deployment and the connection method is [HTTP direct connection]. When the client starts, a port number is assigned for direct connection to the public cloud server. If the customer is routed to the client through nginx, it is necessary to add a configuration in nginx to redirect to this port.nginx access address: Displayed when the deployment mode is single deployment of 【HTTP direct connection 】 and 【cluster deployment】. For clients in cluster deployment, a nginx must be pre-installed for routing. If using long connection mode, input the internal network address of the cluster nginx for 【nginx access address】; if using direct connection mode, customers can directly enable external network access for the cluster nginx and input the externally accessible address of the cluster nginx. Customers can also place the cluster nginx in the internal network and separately install an nginx that can be accessed from the external network, configuring it to route to the cluster nginx. In this case, input the external nginx for 【nginx access address】. The access address must be a complete address that includes http(s)://, for example: http://10.10.10.10:8888.Running Instance List: Displayed when the deployment mode is cluster deployment. It shows all client instances under the same cluster, allowing configuration of each instance's instance IP, instance port number, and direct connection port number. The direct connection port number is only displayed when the connection method is [HTTP Direct Connection]. button: Refresh client instance data and client status. button: If the customer adds a new client to the cluster or deletes a client, it is necessary to re【download the nginx Profile】, overwrite the configuration file on the nginx server, and restart nginx. button: If the customer wants to reduce the client in the cluster, in addition to stopping the corresponding client program on the server where the client is located, they also need to delete the corresponding client instance in the [Running Instance List], then re [download the nginx profile], overwrite the configuration file on the nginx server, and restart nginx.IP Whitelist: You can enter a list of IPs that are allowed to directly call the gateway client interface from third-party systems, separated by commas.The 【Connector 】 tab displays all the deployed connectors of the current gateway, allowing the administrator to redeploy and uninstall connectors. button: Used to update the adapter and download the latest adapter file from the cloud. Various functions of the gateway client are implemented by different gateway adapters. For example, the function of the gateway accessing ERP is implemented by the ERP universal adapter; the function of the gateway accessing cloud services is implemented by the ERP service request forwarding adapter. When the gateway is started for the first time, the default adapter is automatically installed. button: Uninstall unused connector adapters.The "Adapter" tab displays all deployed adapters of the current gateway, allowing administrators to redeploy and uninstall connectors. It supports updating, deploying, deleting, and checking various statuses.4.Download GatewayAfter creating a gateway in the [Gateway Home], the administrator needs to first download the gateway client. The download location is indicated by the red box in the image below:Select the corresponding version of the gateway client to download based on the operating system of the server where the gateway client is installed.Installation instructions can be viewed by clicking the button in the upper right corner of the gateway homepage, as shown in the image below:5.Download KeyThe administrator needs to download the key from the specified gateway on the gateway homepage. Please unzip the downloaded key to the config folder in the Client's extraction directory. The download location is shown in the red box in the image below:Note: Each gateway has its own unique key file. You must download the key file from the specified...
