Command Line Interface (CLI)
14/11/2025Command Line Interface
The Command Line Interface (CLI) allows patient information to be automatically added to 3Shape Unite and provide a seamless workflow saving time and avoiding manual errors. This guide coveres how to setup a custom integration to Unite using the Command Line integration. Please note that an overview of official integrations can be found here.
The following two key benefits are provided via integration:
Automation of patient management in 3Shape Unite/TRIOS from external system (like the Practice Management system) avoiding manual errors in patient identification. To save time and avoid manual errors.
Open 3Shape Unite/TRIOS on correct patient directly from the patient chart for faster and easier workflows. To save time with seamless workflows.
The Command Line Interface is delivered via a dedicated module (Web Service module) within 3Shape Unite. Release notes for the Web Service (PMSWEB) Module are available here.
In addition to Command Line Interface; VDDS and a modern Web Service interface are also available.
Running multiple devices or TRIOS MOVE?
Different clinic setups are supported. Check this article for different options: Practice management system & Imaging system setup overview
How to activate Command Line Interface?
To activate the interface in Unite please follow the article How to install "Command Line interface" App from Unite Store.
How to configure an integration using Command Line Interface?
Command Line Interface (CLI) works by launching an application executable (.exe file) with optional arguments ( -firstname="Jane") like this:
"C:\Program Files\3Shape\Dental Desktop\Plugins\ThreeShape.PracticeManagementIntegration\DentalDesktopCmd.exe" -integrationid="d53cad11-32f0-4de2-8d0b-aeda00d10001" -firstname="Jane" -lastname="Doe" -birthday="19991224" -patientid="112" -merge -email="janedoe@mail.com"-gender="2" -notes="some notes" -phone="+4552515043"Default path to executable:
C:\Program Files\3Shape\Dental Desktop\Plugins\ThreeShape.PracticeManagementIntegration\DentalDesktopCmd.exeSupported arguments:
-integrationid="d53cad11-32f0-4de2-8d0b-aeda00d10001"
-firstname="Jane"
-lastname="Doe"
-birthday="19991224"
-patientid="19991224-1234"
-email="jane.doe@mail.com"
-gender="2"
-notes="some notes"
-phone="+4552515043"| Argument | Required | Description | Example |
|---|---|---|---|
-integrationid="<string, unique>" |
Yes |
Internal not-visible identification of the patient used for mapping between 3Shape and client-application. Must be unique. Required.
|
-integrationid="d53cad11-32f0-4de2-8d0b-aeda00d10001" |
-firstname="<string>" |
First name(s) of the patient.
|
-firstname="Jane" |
|
-lastname="<string>" |
Yes |
Last name of the patient. Required.
|
-lastname="Doe" |
-birthday="<DateTime>" |
Date of birth of the patient as YYYY-MM-DD
|
-birthday="19991224" |
|
-patientid=">string, unique>" |
Visual patient specific identification for example Social Security Number (SSN). This value is visible in 3Shape Unite. Must be unique.
|
-patientid="19991224-1234" |
|
|
|
The gender of the patient that conforms to ISO 5218: 0 = Not known; 1 = Male; 2 = Female; 9 = Not applicable. This value is not displayed anywhere in Unite. Note: Available since PMSWEB 3.4.x and newer. |
-gender="2" |
|
-email="<string>" |
The E-mail of the patient. Note: Available since PMSWEB 3.4.x and newer. |
-email="jane.doe@mail.com" |
|
-phone="<string>" |
The phone number of the patient. Formatted according to E.164: +4521234567. Values are validated by the libphonenumber library. OBS: Incorrectly formatted values will invalidate the request. Note: Available since PMSWEB 3.4.x and newer. |
-phone="+4552515043" |
|
-notes="<string>" |
Notes for any additional patient information. Note: Available since PMSWEB 3.4.x and newer. |
-notes="some notes" |
Icons for launch 3Shape button?
Icons for buttons are available from this directory. Requires that 3Shape Unite has been installed.
C:\Program Files\3Shape\Dental Desktop\Plugins\ThreeShape.PracticeManagementIntegration\Icons