Administrator’s Guide
This guide is for System Administrators. It describes the methods for managing the status, settings and capabilities of Sintelix.
There are two key tabs providing access to key Administrator information and settings: Status and Admin.
In addition, there are a range of System Configuration Files that can be edited to modify Sintelix settings and storage locations.
System Status
The Status tab displays the System Overview, Manage Background Tasks and Manage Local Agents panels (see System Status).
The System Overview displays an overview of your Sintelix System Status Overview including the version number, license status, activated capabilities, system configuration and health. You can also export the System Status to a CSV file (see System Status Summary Export).
You can Manage Background Tasks, such as harvesting, document ingestion and network creation and display the status of the Sintelix Agent Connections.
Admin
The Admin tab (only available to Administrators) provides access to administrative settings and controls (Admin Settings), including:
Configuration Files
There are a range of Configuration Files that can be edited to modify Sintelix settings and storage locations. , including:
- Manage User Accounts and configure external user authentication (Set Up User Accounts)
- Customise the Security Model
- Change the Memory Usage
- Change Port Numbers
- Configure and Secure Libraries
- Manage Datastore Locations
- Reset Administrator Password
Configure Capabilities
Some Sintelix capabilities require connecting and/or configuring before they are available for use. See Integrate Additional Capabilities.
User Accounts
User accounts can be authenticated using different identity and access management (IAM) methods, including:
- Manage Sintelix Users using Sintelix built-in user management
- Configure LDAP Server User Authentication
- Configure Active Directory Server User Authentication
- Configure Single Sign-on Authentication on Windows
- Configure PKI Browser Certificate Authentication (X.509)
- Configure OAuth Authentication for Microsoft Azure to allow users to log in using their Microsoft credentials.
Licensing and Activation
Activation Key
When you change your Sintelix licence, you may be issued with a new activation key. See Update Sintelix Activation Key to update the Sintelix Activation Key.
Dongle Authentication Troubleshooting
If your Sintelix license requires dongle authentication, Sintelix will attempt to find the dongle on startup. See Troubleshoot the Dongle Authentication if you encounter any issues with dongle authentication.
Security
By default, Sintelix comes with a Security Model to allow access to projects, collections and networks to be protected.
However, Administrators may want to customise the Security Model to suit the specific security protocols or standards of their organisation.
See also Manage Project Security.
API Web Services
Sintelix provides JSON-based API Web Services for all critical actions available. The web services are optimised to use the HTTP protocol to exchange data rapidly with other systems.
Detailed Documentation
For detailed documentation and code examples on the API Web Services, click on the Services tab in Sintelix.
Testing
The Services tab also provides the capability to test API commands.
About this guide
Many of the features and access to Sintelix are configurable. There may be small variations between screen images in this guide, and your installation of Sintelix, and some features may not be available.
Most of the images in this guide appear as thumbnails, and can be expanded by clicking on it. Then click on it again to collapse it.
Green text indicates a glossary term. Hover over the term to display the definition. Alternatively, you can look up words directly in the Glossary List of Sintelix specific text definitions..
Copyright
© Sintelix Pty Ltd 2025
This work is copyright. No part of this publication or the accompanying software may be reproduced by any process or disclosed to any third party without prior written permission from Sintelix Pty Ltd.
All rights reserved.
Disclaimer
Sintelix Pty Ltd makes no representation or warranties with respect to the contents of this publication and specifically disclaims any implied warranties of merchantable quality or fitness for any particular purpose. Sintelix Pty Ltd reserves the right to revise this publication from time to time without the obligation to notify any person or organisation of such revision. The screen illustrations in this publication are intended to be representations, not exact duplicates, of the screen layouts generated by the software.