Skip to main content

Setup Assistant

The Vectense Platform Setup Assistant provides a guided, step-by-step process to configure your installation and get you up and running quickly.

Overview​

The Setup Assistant walks you through all essential configuration steps:

  1. License activation
  2. Administrative user creation
  3. Workspace setup
  4. Model configuration
  5. Knowledge base creation
  6. First workflow setup

Starting the Setup Assistant​

Access the Assistant​

After installation, the Setup Assistant is automatically available at:

http://your-server:3000/setup

If you've already completed setup and want to create additional workspaces, you can access the guided workspace creation from the main interface.

Setup Steps​

Step 1: Get Started​

What it does: Introduction and environment preparation

  • Welcomes you to Vectense Platform
  • Explains the setup process
  • Checks system readiness

User Actions:

  • Click "Start Setup" to begin the guided process
  • Review the overview of what will be configured

Step 2: License Setup​

What it does: Activates your Vectense Platform license

  • Upload your license file
  • Validate license terms and features
  • Enable licensed capabilities

User Actions:

  • Upload your license file (.lic format)
  • Accept terms and conditions
  • Verify license information is correct

License Options:

  • Trial License: Free evaluation with limited features
  • Production License: Full features for production use
  • Enterprise License: Advanced features and support

Step 3: Create Admin Account​

What it does: Sets up the first administrative user

  • Creates the primary administrator account
  • Configures basic user preferences
  • Establishes administrative access

Required Information:

  • Full Name: Administrator's display name
  • Email Address: Primary contact and login email
  • Preferred Language: Interface language (English, German, French)

User Actions:

  • Enter administrator details
  • Complete email verification if required
  • Set initial preferences

Step 4: Create Your First Workspace​

What it does: Sets up the initial workspace for your team

  • Creates an isolated environment for your projects
  • Configures workspace access controls
  • Sets up organizational structure

Required Information:

  • Workspace Name: Descriptive name (e.g., "AI Automation Team")
  • Workspace URL: Unique identifier for accessing the workspace
  • Description: Optional workspace description

User Actions:

  • Enter workspace details
  • Verify workspace URL availability
  • Confirm workspace creation

Step 5: Set up Models & Knowledge (Guided)​

What it does: Configures your first AI model and knowledge base

  • Guides through model provider selection
  • Sets up knowledge base with sample data
  • Establishes the foundation for AI workflows

Model Options:

  • Commercial AI: OpenAI, Anthropic, Mistral (requires API keys)
  • Local AI: Ollama for self-hosted models

Knowledge Options:

  • File Bucket: Upload documents directly
  • Local Files: Connect to file systems
  • Web Content: Crawl websites for knowledge

Step 6: Create Your First Workflow​

What it does: Builds a simple workflow to demonstrate capabilities

  • Uses the configured model and knowledge
  • Creates a working automation example
  • Demonstrates the workflow execution process

Options:

  • AI Assistant: Guided workflow creation with AI help
  • Manual Creation: Build workflow from scratch
  • Skip: Go directly to the dashboard

Guided Setup Features​

Model Configuration​

The assistant helps you configure your first AI model:

Commercial AI Models:

  • OpenAI: Enter API key, select model (GPT-4, GPT-3.5)
  • Anthropic: Configure Claude API access
  • Mistral: Set up Mistral AI connection

Local AI Models:

  • Ollama: Configure self-hosted model endpoint
  • Model Selection: Choose from available local models
  • Performance Testing: Verify model connectivity

Knowledge Base Setup​

Create your first knowledge base:

File Bucket:

  • Upload sample documents
  • Configure file processing settings
  • Set up automatic indexing

Local Filesystem:

  • Specify directory paths
  • Configure file patterns and filters
  • Set up monitoring for new files

Web Content:

  • Configure starting URLs
  • Set crawling depth and limits
  • Define content extraction rules

Workflow Creation​

Build your first automation:

AI Assistant Mode:

  • Describe your business process in natural language
  • Let AI design the workflow structure
  • Review and approve the generated workflow

Manual Mode:

  • Choose triggers (schedule, webhook, file changes)
  • Add processing steps (AI analysis, data transformation)
  • Configure actions (notifications, API calls, file operations)

Completion and Next Steps​

Setup Complete​

Once all steps are finished:

  • Access your workspace dashboard
  • Review created models and knowledge bases
  • Test your first workflow
  • Explore additional features
  1. Invite Team Members: Add users to your workspace
  2. Expand Knowledge: Add more documents and data sources
  3. Create More Workflows: Build additional automations
  4. Configure Integrations: Connect to external systems
  5. Set Up Monitoring: Configure alerts and notifications

Troubleshooting​

Common Issues​

License Upload Fails:

  • Verify file format (.lic extension)
  • Check file permissions and size
  • Contact support for license issues

Model Connection Errors:

  • Verify API keys are correct
  • Check network connectivity
  • Confirm model provider service status

Workspace Creation Fails:

  • Ensure workspace URL is unique
  • Check for special characters in names
  • Verify sufficient system resources

Knowledge Processing Issues:

  • Check file formats are supported
  • Verify file access permissions
  • Monitor processing job status

Getting Help​

If you encounter issues during setup:

  • In-App Help: Click the help button for contextual assistance
  • Documentation: Refer to specific feature documentation
  • Support: Contact technical support for complex issues
  • Community: Join user forums for community assistance

After Setup​

Once the Setup Assistant is complete:

  • All core components are configured and ready to use
  • You can immediately start creating workflows
  • Additional configuration can be done through the main interface
  • The workspace is ready for team collaboration

Continue to Create Workspace for advanced workspace configuration options.