This page is for PhixFlow administrators who need to know the configuration and maintenance tasks that are needed to keep PhixFlow running.
Minimum Set-up After Installation
If you have installed PhixFlow for the first time, you may want to do the minimum set-up so that you can start creating models and basic applications.
- Login as the startup user.
- Add your licence key to System Configuration → Advanced → Licence Key
Create a user with Administrator privileges.
- Check your new user account works.
- Logout
- Login using your new user account
- Once your account works, delete the startup user.
- Set up the two essential file locations in System Configuration → System Directories:
- Temporary File Location: e.g. /opt/phixflow/data/temp – needed for exporting and importing applications and models between PhixFlow instances.
- File Upload Directory: e.g. /opt/phixflow/data/upload – needed for uploaded files ( via file collectors)
Full System Configuration
For a full system with multiple users, you need to configure:
- Connections to external data sources, e.g. databases, email servers.
- All the system directories and other System Configuration options; see System Configuration and System Logging Configuration
Users and privileges, either in PhixFlow or by integrating with external login systems; see User Administration. For integration with other authentication systems, see:
- Configure Active Directory Integration: users are authenticated using one or more Active Directory servers in addition to users that are defined locally within the PhixFlow database.
- Configure SAML Integration: map the PhixFlow user groups to user groups in your existing single-sign-on system.
- Data formats; see Configuring Data Formats
You can optionally configure:
- Localisation; see Configuring System Localisation and also Localising Applications
- Home screen messages to display on user login: see Configuring a Home Screen
- PhixFlow for mobile access; see Deploying PhixFlow for Web and Mobile Access
To monitor and maintain PhixFlow, you need to:
set up scheduled maintenance using task plans that include system and archive tasks; see Tasks, Task Plans and Archiving
Use task plans to schedule tasks that maintain the PhixFlow system. The system task includes processes that clear the data from incomplete stream sets. It is important to run a system task daily, or at a minimum weekly. We recommend that you add a system task to a task plan that is scheduled to run daily
- configure a stand-by webapp to shadow the active webapp. The standby webapp will automatically take over in the event that the active server fails; see Configuring for Resilience.
- monitor PhixFlow processes, tasks and user activity; see System Monitoring
- prepare server machines for installing or upgrading to a new version of PhixFlow; see the Installation and Upgrade pages:
If you have several PhixFlow instances, for example a development instance and production instance, you may also need to move packages, applications, models and streams between PhixFlow instances; see Administration Menu and Managing Data.
Other useful information is available in:
Pages in the Administration Topic
Pages in the User Administration Topic
- Managing User Accounts
- Managing User Groups and Privileges
- Configure Groups for External Login
- Configure Active Directory Integration
- Configure Login Forms
- Configure AAD Integration via SAML
- User Notification Rule
- Email Account
- Restricting Access During System Maintenance
- Understanding Password Encryption
- Setting up OAUTH2 Email Integration