user guide
NovekAI User Guide
Introduction
Welcome to Novek.ai, the intelligent document management platform designed to transform how organizations handle their documents and information. This comprehensive user guide will help you navigate the platform's features and capabilities, ensuring you can maximize the value of NovekAI for your organization.
Getting Started
Accessing the Platform
Cloud Deployment
If your organization uses the cloud deployment of Novek.ai:
- Open your web browser and navigate to your organization's NovekAI URL
- Enter your credentials (username/email and password)
- If configured, complete any multi-factor authentication steps
- You will be directed to the NovekAI dashboard
On-Premise Deployment
If your organization uses the on-premise deployment of Novek.ai:
- Connect to your organization's network (or VPN if accessing remotely)
- Open your web browser and navigate to the internal NovekAI URL
- Enter your credentials and complete authentication
- You will be directed to the NovekAI dashboard
User Interface Overview
Dashboard
The dashboard is your starting point in Novek.ai, providing:
- Quick access to recent documents
- Overview of document activities and notifications
- Shortcuts to common tasks and workflows
- System status and announcements
- Personalized widgets based on your role and preferences
Navigation
The main navigation menu provides access to key areas of the platform:
- Search: Advanced document search capabilities
- Documents: Document management and organization
- Workflows: Access to document workflows and tasks
- Analytics: Reports and insights on document usage
- Administration: System configuration (for admin users)
User Profile
Access your user profile to:
- Update personal information
- Manage notification preferences
- Configure display settings
- View activity history
- Manage API keys (if applicable)
Document Management
Uploading Documents
Manual Upload
To upload documents manually:
- Navigate to the Documents section
- Click the "Upload" button
- Select files from your computer or drag and drop them
- Add metadata as required
- Click "Upload" to complete the process
Bulk Upload
For uploading multiple documents at once:
- Navigate to the Documents section
- Click "Bulk Upload"
- Select multiple files or a folder
- Configure batch metadata settings
- Start the upload process
- Monitor progress in the upload queue
Email Submission
If configured, you can submit documents via email:
- Compose a new email to your organization's NovekAI email address
- Attach documents to the email
- Use the subject line and email body for metadata (as configured)
- Send the email
- Documents will appear in your NovekAI account
Organizing Documents
Folders and Collections
Organize documents using:
- Folders: Hierarchical organization similar to file systems
- Collections: Dynamic groupings that can contain documents from different folders
To create a folder:
- Navigate to the Documents section
- Click "New Folder"
- Enter a name and description
- Set permissions if needed
- Click "Create"
To create a collection:
- Navigate to Collections
- Click "New Collection"
- Enter a name and description
- Add documents by searching or browsing
- Click "Save"
Tagging
Use tags to categorize documents across folders:
- Select a document or open its details
- Click "Manage Tags"
- Add existing tags or create new ones
- Save your changes
Metadata Management
Enrich documents with metadata:
- Select a document or open its details
- Click "Edit Metadata"
- Fill in or modify metadata fields
- Save your changes
Note: Many metadata fields may be automatically populated by Novek.ai's AI capabilities.
Viewing and Editing Documents
Document Viewer
The document viewer provides:
- High-fidelity rendering of various document formats
- Text selection and copying
- Annotation tools
- Page navigation for multi-page documents
- Zoom and fit options
- Side panel for metadata and properties
Annotations
Add annotations to documents:
- Open a document in the viewer
- Select the annotation tool (highlight, note, drawing, etc.)
- Create your annotation on the document
- Add any annotation text or properties
- Save the annotation
Version Control
Manage document versions:
- Open a document's details
- Click "Upload New Version" to update the document
- View version history to see previous versions
- Compare versions to see changes
- Restore previous versions if needed
Searching and Finding Information
Basic Search
Use the search bar at the top of the interface to:
- Enter keywords or phrases
- View instant results as you type
- Select a result to open the document
Advanced Search
For more complex searches:
- Click "Advanced Search" next to the search bar
- Specify search criteria using multiple fields
- Combine criteria with AND/OR operators
- Filter by document properties, metadata, date ranges, etc.
- Save searches for future use
Natural Language Search
Leverage Novek.ai's AI capabilities with natural language queries:
- Enter questions or descriptive phrases in the search bar
- The system will interpret your intent and find relevant documents
- Results are ranked by relevance to your query
Example queries:
- "Find safety reports from the last quarter"
- "Show me contracts expiring next month"
- "Where are the maintenance procedures for pump station 3?"
Saved Searches
Save frequently used searches:
- Perform a search with your desired criteria
- Click "Save Search"
- Name your search and add a description
- Access saved searches from your dashboard or search page
AI Assistant
Chatbot Interface
Interact with Novek.ai's AI assistant:
- Click the chat icon in the lower right corner
- Type your question or request
- The AI will respond with information from your documents
- View document references in the response
- Click references to open source documents
Document Q&A
Ask questions about specific documents:
- Open a document in the viewer
- Click the "Ask AI" button
- Enter your question about the document
- Receive answers based on the document content
- Follow up with additional questions for clarification
Information Extraction
Extract specific information from documents:
- Select a document or open its details
- Click "Extract Information"
- Choose the type of information to extract (dates, entities, values, etc.)
- Review the extracted information
- Save or export the results
Workflows
Accessing Workflows
Access document workflows:
- Navigate to the Workflows section
- View available workflow templates
- See your assigned tasks
- Monitor workflow progress
Starting a Workflow
Initiate a new workflow:
- Select a document or multiple documents
- Click "Start Workflow"
- Choose a workflow template
- Fill in any required workflow parameters
- Click "Start" to begin the workflow
Completing Tasks
Complete workflow tasks assigned to you:
- Go to your task list in the Workflows section
- Select a task to open it
- Review the associated documents and instructions
- Complete the required actions
- Submit the task to move the workflow forward
Monitoring Workflows
Track workflow progress:
- Navigate to the Workflows section
- Select "Active Workflows"
- View the status of each workflow
- See completed and pending tasks
- Access workflow history and audit trail
Collaboration
Sharing Documents
Share documents with colleagues:
- Select a document or open its details
- Click "Share"
- Enter recipient names or email addresses
- Set permission levels (view, edit, etc.)
- Add an optional message
- Click "Share" to send
Comments and Discussions
Collaborate through document comments:
- Open a document in the viewer
- Click the comments icon or select text to comment on
- Enter your comment
- Tag colleagues using @ followed by their name
- Submit your comment
- Reply to existing comments to create threads
Notifications
Stay informed about document activities:
- Receive notifications when:
- Documents are shared with you
- Comments mention you
- Workflows require your attention
- Documents are updated
- Access notifications from the bell icon in the header
- Configure notification preferences in your user profile
Analytics and Reporting
Document Analytics
Gain insights into document usage:
- Navigate to the Analytics section
- View document access statistics
- See most frequently accessed documents
- Track document lifecycle metrics
- Analyze search patterns and effectiveness
User Activity Reports
Monitor user engagement:
- Navigate to the Analytics section (admin access required)
- Select "User Activity"
- View login statistics and active users
- See document creation and modification trends
- Track workflow participation
Custom Reports
Create tailored reports:
- Navigate to the Analytics section
- Click "Create Report"
- Select report type and parameters
- Configure visualization options
- Save and schedule the report if needed
Mobile Access
Mobile Web Interface
Access NovekAI on mobile devices:
- Open your mobile browser
- Navigate to your organization's NovekAI URL
- Log in with your credentials
- Use the responsive interface optimized for mobile
Key Mobile Features
Mobile-optimized capabilities include:
- Document viewing and basic editing
- Search functionality
- Task completion in workflows
- Notifications and alerts
- Document capture using device camera
Administration (for Admin Users)
User Management
Manage system users:
- Navigate to Administration > Users
- View existing users
- Create new user accounts
- Edit user properties and permissions
- Deactivate or delete user accounts
Role and Permission Management
Configure access controls:
- Navigate to Administration > Roles
- View existing roles
- Create new roles with specific permissions
- Assign users to roles
- Configure role hierarchies if needed
System Configuration
Configure system settings:
- Navigate to Administration > Settings
- Adjust general system parameters
- Configure security settings
- Set up integration parameters
- Customize user interface elements
Monitoring and Maintenance
Monitor system health:
- Navigate to Administration > System
- View system status and performance metrics
- Check storage usage and quotas
- Review system logs
- Schedule maintenance tasks
Best Practices
Document Organization
Optimize your document management:
- Develop a consistent folder structure
- Use descriptive document names
- Apply metadata consistently
- Create collections for cross-cutting concerns
- Regularly review and clean up document repositories
Search Optimization
Improve search effectiveness:
- Use specific terms in natural language queries
- Save frequently used searches
- Provide feedback on search results
- Ensure documents have complete metadata
- Use filters to narrow down large result sets
Workflow Efficiency
Streamline workflow processes:
- Select appropriate workflow templates for different document types
- Set realistic deadlines for workflow tasks
- Monitor workflow progress regularly
- Identify and address bottlenecks
- Collect feedback for workflow improvement
Security Practices
Maintain document security:
- Use strong, unique passwords
- Enable multi-factor authentication if available
- Be mindful of document sharing permissions
- Regularly review access rights
- Report suspicious activities to administrators
Troubleshooting
Common Issues
Solutions for frequent challenges:
Document Upload Failures
- Check file size limits
- Verify supported file formats
- Ensure stable network connection
- Try uploading smaller batches
Search Problems
- Check spelling and try alternative terms
- Use fewer, more specific keywords
- Verify document permissions
- Contact admin if index may need rebuilding
Workflow Delays
- Check for tasks awaiting action
- Verify all required fields are completed
- Ensure assignees have appropriate permissions
- Contact workflow owner for escalation
Getting Help
Access support resources:
- Click the Help icon in the interface
- Browse the knowledge base
- View video tutorials
- Contact support through the help desk
- Consult your organization's NovekAI administrator
Glossary
AI Assistant: The intelligent chatbot interface that answers questions based on your document content.
Collection: A dynamic grouping of documents that can span multiple folders.
Document Lifecycle: The stages a document goes through from creation to archival or deletion.
Extraction: The AI-powered process of identifying and capturing specific information from documents.
Metadata: Structured information about documents, such as author, date, category, etc.
Natural Language Search: The ability to search using conversational questions rather than keywords.
OCR (Optical Character Recognition): Technology that converts images of text into machine-readable text.
Role-Based Access Control: Security model that restricts system access based on user roles.
Tagging: The process of applying labels to documents for organization and retrieval.
Workflow: A defined sequence of tasks and approvals for document processing.
Conclusion
This user guide provides a foundation for using NovekAI effectively. As you become more familiar with the platform, you'll discover additional features and capabilities that can further enhance your document management processes. Remember that NovekAI is designed to learn from your usage patterns, so the system will become more tailored to your needs over time.
For additional assistance, please contact your organization's NovekAI administrator or the NovekAI support team.