Administration

Overview of administrative tasks for the Form Portal.

Administrator Responsibilities

As a Form Portal administrator, you are responsible for:

  • Installation and Configuration - Deploy and configure the module
  • Access Control - Manage user permissions and roles
  • Monitoring - Track usage and performance
  • Troubleshooting - Resolve user issues
  • Maintenance - Keep the system running smoothly

Quick Links

Module Overview

Module Information

  • Module ID: form-portal
  • Module Name: Form Portal
  • URL: form-portal/index.html

Dependencies

The Form Portal requires: - Ambience kernel (elx-ambience-server) - Form module (for form definitions) - Workflow module (for workflow integration) - ETL-core module (for form instance creation)

Architecture

The Form Portal consists of:

Client (Scala.js) - Browser-based user interface - View and Create tabs - Form rendering and interaction

Server (JVM) - REST API for form data - Access control and authorization - Integration with form and workflow modules

Common - Shared data models - Form metadata - Role information

Common Administrative Tasks

User Management

Granting Access 1. Assign mod-form-portal privilege 2. Assign mod-form or mod-checklist privilege 3. Add user to appropriate roles 4. Assign to workgroups

Removing Access 1. Remove privileges 2. Remove from roles 3. Remove from workgroups

Form Access Control

Configuring Form Access 1. Set form access.roles in Form Designer 2. Set form owner field 3. Configure workgroup assignments 4. Enable/disable forms

Troubleshooting Access 1. Verify user privileges 2. Check role membership 3. Verify workgroup membership 4. Check form enabled status

Monitoring

Log Monitoring - Check server logs regularly - Monitor for errors - Track access patterns - Review performance

Maintenance

Regular Tasks - Monitor database size - Review archival process - Check form template status - Update documentation

Periodic Tasks - Review user access - Audit form permissions - Optimize database indexes - Plan for capacity

Configuration

Module Configuration

Basic configuration in ambience.conf:

ambience {
  form-portal {
    archive-after-days = 90
  }
}

See Installation and Configuration for details.

Access Control Configuration

Privileges required: - mod-form-portal - Basic access - mod-form - Form features - mod-checklist - Checklist features

See Access Control for details.

Integration

Form Module Integration

The Form Portal depends on the Form module for: - Form definitions (templates) - Form runtime (rendering) - Form submission processing - Validation

Workflow Module Integration

For workflow-integrated forms: - Workflow definitions - Workflow instances - Workflow state tracking - Event processing

ETL Module Integration

The Form Portal uses ETL for: - Form instance creation - Checklist instance creation - Data processing

Troubleshooting

Common Issues

Users can’t access portal - Check privileges - Verify role membership - Check workgroup assignment

Forms not appearing - Check form enabled status - Verify access.roles configuration - Check workgroup matching

Form creation fails - Check ETL configuration - Verify workflow exists (for workflow forms) - Check server logs

See Installation and Configuration for detailed troubleshooting.

Support

User Support

When users report issues: 1. Gather details (what, when, error messages) 2. Check user permissions 3. Verify form configuration 4. Review server logs 5. Escalate if needed

Administrator Resources

  • Server logs for debugging
  • Database access for verification
  • Configuration files
  • Module documentation

Next Steps

Next: Installation and Configuration