Related Topics:
- Solution Center (Reference) - Main interface
- Multi-User Collaboration (Reference) - Team development
- Managing Solutions (How-to) - Step-by-step procedures
On this page:
Table of Contents | ||||
---|---|---|---|---|
|
Solutions Location
Access Modes
Mode | Description | Use Case | License |
---|---|---|---|
Local Computer Files | Direct file system access | Single user development | Standard |
Solution Server | Network access via TWebServices | Multi-user collaboration | Engineering users |
Mode Selection
Setting | Options | Default | Notes |
---|---|---|---|
Solutions list built from | Local/Server | Local | Radio button selection |
Auto-refresh | On/Off | Off | Updates solution list |
Local Computer Files
Local Search Folders
Directories scanned for solution files (.dbsln and .tproj):
Operation | Function | Shortcut |
---|---|---|
Add Search Path | Include new folder | + button |
Remove Search Path | Exclude folder | - button |
Refresh | Rescan folders | F5 |
Folder Properties
Each folder has individual settings:
Property | Description | Default | Impact |
---|---|---|---|
Visible | Show in solution list | Checked | Local display |
Allow Remote | Enable network access | Unchecked | Remote users can view |
Allow Remote Run | Permit remote execution | Unchecked | Remote users can run |
Default Locations
Folder | Path | Purpose |
---|---|---|
User Solutions | Documents\FrameworX\Solutions | Personal projects |
Shared Solutions | Public\Documents\FrameworX | Team projects |
Templates | Documents\FrameworX\Templates | Solution templates |
Solution Server Connection
Connection Parameters
Field | Description | Required | Default |
---|---|---|---|
Server | IP address or hostname | Yes | localhost |
Port | TWebServices port | Yes | 10108 |
Access Key | Security password | If configured | (none) |
Timeout | Connection timeout | No | 30 seconds |
Common Addresses
Address | Description | Use Case |
---|---|---|
127.0.0.1 | Local loopback | Testing |
localhost | Local machine | Development |
192.168.x.x | Local network | Team access |
hostname.domain | Domain name | Enterprise |
Connection Actions
Button | Function | Status Indicator |
---|---|---|
Connect | Establish connection | Green = Connected |
Update | Refresh server info | Yellow = Updating |
Disconnect | Close connection | Gray = Disconnected |
Connected Server Information
Server Details Display
Information | Description | Example |
---|---|---|
Operating System | Server OS version | Windows Server 2022 |
Server URL | Full connection string | http://192.168.1.100:10108 |
Server IP | Network address | 192.168.1.100 |
Version | FrameworX version | 10.2.0.1234 |
Platform | .NET version | .NET 8.0 |
Running Services
Service | Purpose | Default Port | Status |
---|---|---|---|
TWebServices | Solution access | 10108 | Required |
MQTT Broker | MQTT communications | 1883 | Optional |
HardKey | License service | 10109 | As needed |
OPC UA Server | OPC UA endpoint | 48030 | Optional |
Service Management
Action | Function | Requires |
---|---|---|
Start Service | Launch service | Admin rights |
Stop Service | Halt service | Admin rights |
Install as Windows Service | Auto-start on boot | Admin rights |
View Logs | Check service logs | Read access |
Local Computer Management
Access Key Configuration
Security for remote connections:
Field | Description | Requirements |
---|---|---|
Set AccessKey | Define password | 8+ characters recommended |
Verify | Confirm password | Must match |
Apply | Save settings | Restarts service |
?? Warning: Pressing Apply with empty fields removes the AccessKey
Security Settings
Setting | Description | Default |
---|---|---|
Require AccessKey | Password for remote access | Disabled |
Allow Guest Access | Permit anonymous viewing | Disabled |
SSL/TLS | Encrypted connections | Disabled |
IP Restrictions | Limit by IP range | None |
TWebServices Configuration
Service Requirements
Component | Requirement | Check Method |
---|---|---|
Port Available | 10108 not in use | netstat -an |
Firewall | Port open | Windows Defender |
Permissions | Read/write access | Folder properties |
License | Valid runtime | License panel |
Starting TWebServices
Method 1: From Solution Center
- Go to Server Information
- In Connected Server section
- Select WebService in Add Services
- Click Start
Method 2: Manual Start
- Navigate to installation folder
- Run TWebService.exe
- Check system tray icon
- Verify port in tooltip
Method 3: Windows Service
- Open Services (services.msc)
- Find "TWebService-FrameworX"
- Start service
- Set to Automatic
Service Status Indicators
Indicator | Location | Meaning |
---|---|---|
Tray Icon | System tray | Green = Running |
Services Panel | Windows Services | Status column |
Task Manager | Processes tab | CPU/Memory usage |
Server Info | Solution Center | Running Services list |
Multi-User Configuration
Requirements for Collaboration
Component | Server | Client |
---|---|---|
Software | FrameworX installed | FrameworX installed |
License | Engineering users > 1 | Valid license |
Service | TWebServices running | Network access |
Connection | Solution Server mode | Server connection |
Setup Steps
On Server:
- Set Solution Server to http://localhost
- Configure folders with Allow Remote
- Start TWebServices
- Optional: Set AccessKey
On Client:
- Select Solution Server mode
- Enter server IP:Port
- Enter AccessKey if required
- Connect
Important Notes
- Cannot mix local and remote editing of same solution
- Server must also connect to itself for multi-user
- Each folder has independent remote permissions
Web Interface Access
Browser URL Format
http://<server>:10108/solutions
http://<server>:10108/solutions?accesskey=<key>
https://<server>:10108/solutions (if SSL enabled)
ClickOnce Support
For Designer launch from browser:
Browser | Support | Notes |
---|---|---|
Edge | Full | Recommended |
Chrome | With extension | ClickOnce addon |
Firefox | Limited | Manual launch |
Safari | No | Use desktop client |
Troubleshooting
Connection Issues
Problem | Cause | Solution |
---|---|---|
Can't connect | Service not running | Start TWebServices |
Access denied | Wrong AccessKey | Verify password |
No solutions | Wrong path | Check folder settings |
Timeout | Network issue | Check firewall/ports |
Service Issues
Problem | Cause | Solution |
---|---|---|
Won't start | Port in use | Change port or stop conflict |
Crashes | Permission issue | Run as administrator |
Not in services | Not installed | Install as Windows Service |
File Access Issues
Problem | Cause | Solution |
---|---|---|
Solutions not visible | Not in search path | Add folder |
Can't save | Read-only | Check permissions |
Locked files | Open elsewhere | Close other instances |
Log Locations
Log Type | Path | Content |
---|---|---|
TWebServices | Logs\WebService\ | Connection logs |
Access | Logs\Access\ | Login attempts |
Errors | TraceLogs\ | Error details |
Best Practices
Folder Organization
- Separate folders for Dev/Test/Production
- Use descriptive folder names
- Set appropriate visibility per folder
- Regular backup of solution folders
Security
- Always use AccessKey for production
- Limit remote access to specific folders
- Use SSL for sensitive environments
- Regular license audits
Performance
- Limit search paths to active folders
- Regular cleanup of old solutions
- Monitor service resource usage
- Optimize network connectivity
See Also
Parent Page:
- Solution Center (Reference) - Main interface
Related Pages:
- Multi-User Collaboration (Reference) - Team setup details
- Service Verification (Reference) - Service diagnostics
- Installing on IIS (Reference) - IIS configuration
Solutions Location
The list of solutions presented can include files from your local computer or connecting with a Solution Server running the TWebServices service. If you select Solution Server, you will need to specify the server address and connect to it.
To connect to a solution server, use the IP address and port of the target Solution Server. You may be required to enter an Access Key, which is the password defined on the target server. This configuration is available under Local Computer Management.
Local Computer Files
The Solutions exhibited in the Solution Selector list are the ones set in Local Search Folders when the application starts to run.
If you copy a new Solution (.tproj or .dbsln file) to a folder listed in Local Search Folders, it will not be exhibited in the Solution Selector until you click the Refresh button. To add or remove a folder from the search paths:
Click Find Solutions file.
Click Add Search Path to insert a new path;
Click Remove Search Path to remove a path.
Check Allow Remote Access and Allow Remote Run for multi-user development. (Optional)
Solution Server
To display the Solution List from a server running the TWebServices, the client computer must be connected to the Solution Server using its IP address and port.
If you have a computer where the solution files are stored and managed, and other computers from which you want to work remotely on those solution files, both computers must have the software platform installed and licensed. The client computer needs to connect to the solution server by using the IP address and port of the computer that stores the solutions. You can also connect to the solution server on your own computer using the IP address 127.0.0.1 and the port where the Solution Server is running. By default, the Solution Server runs on port 10108.
The TWebServices must be running to accept remote connections. See Service Verification for more information.
If using the Embedded Web Service (TWebService) platform, no configuration is required. If using Microsoft IIS web server, see Installing on Microsoft IIS.
Tip | ||
---|---|---|
| ||
When using Distributed Engineering, allowing users from remote computers to access the solution, you need to connect using the Solution Server instead of direct File Access. |
Connected Server Information
The Connected Server Information displays details such as the operating system, server URL, server IP, installed versions, and running services. By default, the SolutionServer operates on port 10108 and includes services like Hardkey and WebServices. Additionally, you can configure services (WebServices, MQTT Broker, and Hardkey) to start as Windows services.
Local Computer Management
The Local Computer Management defines an AccessKey to connect securely with the Solution Server hosted on the local computer, adding an extra security layer for remote access. It includes configuration fields for setting and verifying the AccessKey: the "Set AccessKey" field for entering the password and the "Verify" field for re-entering the password to confirm it. The "Apply" button saves the AccessKey settings.
Warning |
---|
Pressing "Apply" with any input removes the AccessKey. |
Finding Solutions Folders
After clicking Find Solutions in the Manager Workspace, you will be addressed to the Server Information, which allows to easily set a solution to auto-startup and define if the Solution Selector list will exhibit Solutions from a local or remote computer.
Solution Server
Field
Description
Solutions list built from
It shows the options below, where user can choose either if the Solution list will be built from local computer files or a server.
Local Computer Files
It sets Solution selector list to be built from the local computer.
Solution Server
It sets a server to build the Solution selector list from.
Connect
It connects to the Solution server set.
Update...
It updates Solution server status.
Server Information
It shows server IPs.
Running Services
It shows current server's running services.
Local Search Folders
Exhibit local folders set to search Solutions and the options below.
Add Search Path
It adds new local path to search for Solutions.
Remove Search Path
It removes a local path to search for Solutions.
Visible
It shows the local paths in the Solution List, enabling you to select the solutions in the Manager workspace.
Allow Remote
It enables remote access to the local paths set.
Info |
---|
The platform will scan for .dbSln files in the paths set. If the list is empty, check the search paths or the connection with the solution server. Also, try Creating a New Solution. If an error occurs when the Solution is loading, a log is created at "TraceLogs" folder |
Folder Visibility and Remote Access configuration
Any folder included in Local Search Folders has controls for visibility and remote access.
Permissions for remote access are set by folder, so place your solutions in the folders accordingly. You can keep many solutions in one folder or create a separate folder for each one.
To manage your Solutions Folders:
After adding a search path, select the one you would like to allow remote access.
Check Visible to enable remote access for selected folder.
Check Allow Remote to enable Solutions from selected folder to be run by remote users.
title | Multi-user Development |
---|
In this section:
Page Tree | ||||
---|---|---|---|---|
|