Sanplex IM is powered by Xuanxuan: (Xuanxuan的链接)

Xuanxuan is a secure IM product that supports private deployment, cross-platform use, and a rich plugin ecosystem.

After integration, Sanplex IM supports member communication, group discussions, file transfer, task assignment, and more—enabling more convenient project management and smoother team collaboration.

Video walkthrough (replace with the Sanplex link when available): （Xuanxuan介绍链接）

（视频介绍）

I. Configure Sanplex IM Server Parameters

Using the Windows 64-bit one-click installation package as an example:

Double-click Sanplex.exe to start Sanplex.

图1

Check whether the following configuration for x.php exists in xampp/runner/res/apache/conf/httpd.conf. If not, add the following content:

 <Files "x.php">
    SetHandler application/x-httpd-php
  </Files>
  <Files "ux.php">
    SetHandler application/x-httpd-php
  </Files> 

After verification, go to Admin > System Settings > Home to configure the parameters.

图2

Note: The Sanplex server address must include the full protocol + host + port, for example http://192.168.1.35 or http://pms.example.com. Do not use 127.0.0.1.

图3

• Sanplex IM integration is enabled by default.
• The key is a randomly generated 32-character password and must match the configuration on the Sanplex IM Server (xxd).
• The default upload size limit is 20 MB and can be adjusted as needed.
• HTTPS is disabled by default. If enabled, you must paste the HTTPS certificate content and key into the input fields.

II. Download and Run the Sanplex IM Server

After configuring the IM parameters, a Download IM Server button will appear.

图4

Notes:

• Supported operating systems currently include Windows 32-bit, Windows 64-bit, Linux 32-bit, Linux 64-bit, and macOS.
• If you have already downloaded the Xuanxuan server, you can download only the configuration file. The configuration file is xxd.conf. After downloading, replace the file with the same name in the existing Xuanxuan server directory and restart the server service.

The downloaded package includes the configuration parameters previously set under Admin > IM.

图5

For example, you can modify the upload size limit in config/xxd.conf.

图6

Double-click xxd.exe in the directory to start the server-side service.

图7

Notes on the Sanplex IM Server (xxd)

• If Sanplex and xxd are on the same server: when logging in to Sanplex IM Client, using the Sanplex access address as the server address is acceptable.
• If Sanplex and xxd are on different servers: when logging in to Sanplex IM Client, the server address must be the listening address of xxd.
• If xxd listens on an internal network address but connections must use a public IP: when logging in to Sanplex IM Client, use the public address as the server address.
• If xxd is deployed on a cloud host and accessed from the public network, ensure the firewall allows access to ports 11444 and 11443.

Recommended placement for the Sanplex IM Server (xxd)

• For Sanplex installed from source code, it is recommended to place xxd in a directory parallel to Sanplex and run ./xxd to start the Sanplex IM Server service.
• For Sanplex installed via the Windows one-click package, you can download only xxd.conf in Admin > IM > Parameter Settings, then overwrite the original file under xampp/xxd/config. Start the xxd service and click Start IM Service in the Sanplex control panel.
• For Sanplex installed via the Linux one-click package, you can download only xxd.conf in Admin > IM > Parameter Settings, then overwrite the original file under /opt/zbox/run/xxd/config.

III. Install and Log In to Sanplex IM Client

Only after the super administrator configures the IM server in Admin will the Download IM Client entry appear.

In an intranet environment, you must manually place the Sanplex IM Client installation package into a specified server directory. Then other users can download it via Download IM Client. For reference (replace with the Sanplex guide when available): （内网环境下载Sanplex客户端）

On the Sanplex home page, click the user avatar > IM > Download IM Client.

图8

Select the operating system and click Save to open the download page.

图9

After downloading, extract the package to obtain the sanplex_im_client.win64 folder. Enter the sanplexclient directory and double-click sanplexclient.exe to start Sanplex IM Client.

图10

Click Server Settings to display server configuration.

图11

Notes:

• The server field should match the server address in the IM server configuration file xxd.conf.
• If you have not changed the default port in xxd.conf, you do not need to append the port to the server address. For example, if Sanplex web access is http://192.168.1.110:8080, then the IM server address can be http://192.168.1.110.
• Use the username and password created in Sanplex.

Troubleshooting IM Client login failures

1. Verify that Sanplex, Sanplex IM Client, and the Sanplex IM Server (xxd) are all running normally.
2. If all are running, check the xxd.conf configuration on the IM server: confirm the server name is correct, the key matches, and default is included if required by the configuration.
3. If the login page reports “Server operation failed” with a 500 error, go to Admin > IM > Server Settings and verify that the server configuration is enabled.

IV. Download Sanplex IM Client in an Intranet Environment

In an intranet environment, you can manually download Sanplex IM Client from the official website, place it into the specified server directory, and then other users can download it via user avatar > IM > Download IM Client.

Download the installation package for the required OS from the official site (replace with the Sanplex download page when available): （在此插入Sanplex客户端官网链接）

图12

Check whether the www/data/client directory exists under the Sanplex installation directory. If not, create it. Then confirm the IM client version and create a directory under client named after the IM client version number. For example, if the IM client version is 2.5.5, create client/2.5.5.

图13

Place the downloaded IM client installation package into the newly created 2.5.5 directory so users can download it. Note: On Linux servers, ensure file permissions and ownership are set correctly.

V. Use Sanplex IM Client

For basic usage of the IM client, refer to Xuanxuan’s official “Client User Guide”: （在此插入Xuanxuan客户端使用说明链接）

After integrating Sanplex with Sanplex IM Client:

• Accounts and passwords are shared with Sanplex.
• Sanplex pages can be opened and browsed directly in Sanplex IM Client.
• Actions in Sanplex can trigger message notifications in Sanplex IM Client.
• You can right-click messages to create Bug, User Story, Task, Document, and To-do items.
• Sanplex IM Client displays details pages for Bug, User Story, Task, Document, and Test Case as cards, and provides action buttons.

1. Log In with Sanplex Username and Password

Sanplex IM Client uses the same username and password as Sanplex.

• After the administrator configures the IM server, add users in Admin > Users > Users.
• Other users can download Sanplex IM Client and log in with their Sanplex credentials.

图14

2. Open Sanplex Pages in Sanplex IM Client

Click the Sanplex icon in the left navigation of Sanplex IM Client to browse Sanplex information directly within the IM client.

图15

3. IM Notifications

In Sanplex, go to Admin > Notifications > Settings > IM and select the actions that should send notifications. After configuration, when users perform those actions in Sanplex, the assignee will receive notifications in Sanplex IM Client.

图16

Using task assignment as an example: the assignee will receive an assignment notification in the IM client Notification Center. Click the notification to view task details. When the IM client is minimized to the system tray, sound alerts and pop-up prompts may appear.

图17

4. Right-Click Messages to Create Bug/User Story/Task/Document/To-do

Right-click a message within Sanplex IM Client to create a Bug, User Story, Task, Document, or To-do directly.

图18

Note: The administrator must grant the relevant permissions in Sanplex. If permissions are not granted, the creation options will not appear when right-clicking messages in Sanplex IM Client.

For example, click Create To-do to open Sanplex in the IM client and create a to-do using the message content.

图19

5. Card View for User Story/Task/Bug/Test Case/Document Details

In an IM conversation, you can send links to Sanplex item detail pages (User Stories, Tasks, Bugs, Test Cases, Documents). After sending, the content will be displayed as a card.

图20

6. Group Chat in Sanplex IM Client

Click Chats and select users to create a discussion group. This supports communication and collaboration among project team members.

图21

VI. Sanplex IM Client and Web IM

Sanplex provide a new desktop IM client and introduce Web IM.

With Sanplex IM, users can communicate and collaborate with team members within the Sanplex web interface, enabling efficient communication while also providing convenient access to Sanplex modules.

Messages in Sanplex IM Client and Web IM can be synchronized.

1. Sanplex IM Client

In Sanplex, after integrating IM under Admin > IM, download Sanplex IM Client from the user center > Dashboard.

Start the xxd service, and you can use the new Sanplex IM Client.

图22

In the IM client, the top-left navigation displays the Sanplex left navigation. Click to directly access corresponding modules.

The bottom-left navigation provides the IM client address book, apps, and chat icons.

图23

Click the user avatar in the bottom-left to configure the IM client and change online status.

图24

Click Recent Chats to chat in real time and transfer images/files.

图25

2. Web IM

After enabling Sanplex IM, an IM window icon appears in the bottom-right corner of the Sanplex page.

If the IM configuration is completed successfully and the xxd service is running, users can use Web IM directly in the Sanplex web interface without logging in to the desktop IM client.

图26

Click the bottom-right icon to use Web IM.

图27

Click Chats to start Web IM conversations.

图28

3. Sync Between Sanplex IM Client and Web IM

Messages in Sanplex IM Client and Web IM can be synchronized in real time.

If a user is offline, whichever side (IM client or web) logs in first will receive offline messages first. If the IM client logs in first, it receives offline message prompts; when the web logs in later, it does not show offline prompts but will synchronize the IM client messages.

Sanplex IM Client message display:

• Sanplex IM Client displays details pages (e.g., User Stories, Tasks, Bugs) as cards and provides action buttons for direct operations.

图29

Web IM display:

• The content is consistent with Sanplex IM Client. The web interface directly shows Sanplex links; click to open the corresponding pages in Sanplex.

图30

4. Audio/Video in Sanplex IM Client

Audio/video features are available in the Standard, Premium, and Enterprise versions.

After enabling audio/video and configuring the audio/video server, you can use Sanplex IM Client to initiate 1-to-1 and group audio/video meetings.

Go to Admin > IM > Audio/Video, click Edit, enable audio/video, and configure the service settings.

图31

Enable and configure the audio/video server:

图32

After the server configuration is completed, configure video resolution:

图33

Log in to Sanplex IM Client. In group chats and 1-to-1 chat windows, the meeting button will appear in the top-right corner.

图34

For group chats, you can start an all-hands meeting or select participants to start a meeting.

图35

During an audio/video meeting, you can mute, start/stop video, share the screen, and view participants.

图36