Department Management
This section outlines the functionalities for managing departments within the system, including access levels and core workflows.
Access & Permissions
| Role | Access Level | Restrictions (Web Admin) |
|---|---|---|
| Superadmin | Full access (Add, Edit, Block) | None |
| Account Holder | Full access (Add, Edit, Block) | None |
| Admin | Full access (Add, Edit, Block) | Can add, edit, and block. |
| Supervisor | Can not add, edit, or block | Focused on checklists in the application. |
| Auditor | Can not add, edit, or block | Focused on checklists in the application. |
| Customized Role | Depends on inherited user role | Inherits restrictions based on the assigned user role. |
Key Capabilities
- Create new departments.
- Modify existing department details (e.g., name, associated users, sites, and questionnaires).
- Prevent access to a department, potentially archiving or temporarily disabling it.
- View essential information about existing departments.
Core Workflows & UI Walkthrough
-
Adding a Department (Admin, Account Holder, Superadmin):
- Navigate to the “Department” section.
- Click the “Add department” button.
- Fill in the required details in the form (e.g., “Department Name,” “Description,” “Email”).
- Click “Save.”
-
Editing Department Information (Admin, Account Holder, Superadmin):
- Go to the “Department” section.
- Locate and click the “Edit” icon (e.g., a pencil) or the department name.
- Modify the pre-populated details in the form.
- Click “Save.”
-
Blocking a Department (Admin, Account Holder, Superadmin):
- Navigate to the “Department” section.
- Find the department to block.
- Click the “Block” icon.
- Confirm the action in the dialog if prompted.
-
Viewing Department Information (Account Holder, Admin, Superadmin):
- Access the “Department” section.
- A list or table displaying key details (unique key, department name, description) will appear.
- Clicking a department name may open a detailed view.
Configuration & Customization
System administrators can configure roles and permissions, customize department information fields, and define workflows for blocking/unblocking departments.
Related Features & System Connections
- User Management: Departments are linked to users, defining organizational structure and access.
- Reporting: Department information is used in various reports for analysis.
- Site Management: Departments are associated with site settings.
Best Practices
- Clearly define department structures to align with organizational hierarchy.
- Regularly review and update department information for accuracy.
- Use the “Block” functionality judiciously, understanding its impact on associated users and data.
Questionnaire Management
This section details the functionalities for managing questionnaires, including access levels, creation, modification, and deletion.
Access & Permissions
| Role | Access Level | Restrictions (Web Admin) |
|---|---|---|
| Superadmin | Full access (View, Create/Clone, Edit, Delete) | None |
| Account Holder | No access shown (Refer to Admin access for this role) | No direct access, typically managed by Admin roles. |
| Admin | Can View, Create/Clone, Edit, Delete | Can View, Create/Clone, Edit, Delete. |
| Supervisor | Can not View, Create/Clone, Edit, Delete | Focused on checklists in the application. |
| Auditor | Can not View, Create/Clone, Edit, Delete | Focused on checklists in the application. |
| Customized Role | Depends on inherited user role | Inherits restrictions based on the assigned user role. |
Key Capabilities
- View existing questionnaires.
- Create new questionnaires from scratch or by duplicating existing ones.
- Modify the structure, questions, and settings of questionnaires.
- Remove questionnaires from the system.
Core Workflows & UI Walkthrough
-
Viewing Questionnaires (All Roles with Access):
- Navigate to the “Questionnaire” section.
- A list of questionnaires will display.
- Click a questionnaire name to view its questions and structure.
-
Creating a New Questionnaire (Admin, Account Holder, Superadmin):
- Go to the “Questionnaire” section.
- Click the “Add Questionnaire” button.
- Add questions, define question types, and set validation rules.
- Save the questionnaire.
-
Cloning a Questionnaire (Admin, Account Holder, Superadmin):
- In the “Questionnaire” list, locate the questionnaire to clone.
- Click the “Clone” icon.
- A duplicate will be created (e.g., “Original Title (Copy)”).
- Edit the cloned questionnaire as needed.
-
Editing a Questionnaire (Admin, Account Holder, Superadmin):
- Navigate to the “Questionnaire” section.
- Find the questionnaire to edit.
- Click the “Edit” icon.
- Modify existing questions, add new ones, delete questions, or change the order.
- Save changes.
-
Deleting a Questionnaire (Admin, Account Holder, Superadmin):
- Go to the “Questionnaire” section.
- Locate the questionnaire to delete.
- Click the “Trash” icon.
- Confirm deletion in the dialog. The questionnaire will be removed from the system and any [schedules](../../Schedule/Schedule Listing/ScheduleListingOverview.md).
Configuration & Customization
Administrators can define question types, brand questionnaires, and set usage rules. Workflows for publishing and archiving questionnaires may also be configurable.
Related Features & System Connections
- Reporting [Schedule](../../Schedule/Schedule Listing/ScheduleListingOverview.md): Questionnaires link to scheduled reports for data collection.
- User Management: Questionnaires can be assigned to specific users or roles for scheduling.
- Data Analysis: Responses from completed questionnaires feed into data analysis and reporting tools.
Best Practices
- Plan questionnaire structure carefully to gather relevant data.
- Use clear and concise language in questions.
- Test questionnaires before deployment.
- Regularly review and update questionnaires for relevance.
User Management
This section describes the processes for managing user accounts, including adding, editing, updating roles, and blocking access.
Access & Permissions
| Role | Access Level | Restrictions (Web Admin) |
|---|---|---|
| Superadmin | Full access (Add, Edit, Update Role, Block) | None |
| Account Holder | Full access (Add, Edit, Update Role, Block) | None |
| Admin | Can Add, Edit, Update Role, Block | Can Add, Edit, Update Role, Block. |
| Supervisor | Can not modify | Focused on checklists in the application. |
| Auditor | Can not modify | Focused on checklists in the application. |
| Customized Role | Depends on inherited user role | Inherits restrictions based on the assigned user role. |
Key Capabilities
- Create new user accounts.
- Modify existing user details (e.g., contact information, department assignment).
- Change user roles and associated permissions.
- Temporarily or permanently restrict user access.
Core Workflows & UI Walkthrough
-
Adding Users (Admin, Account Holder, Superadmin):
- Navigate to the “User” section.
- Click the “Add User” button.
- Fill in user details (Username, Password, Email, Name, Department).
- Assign an initial user role.
- Click “Save.”
-
Editing User Information (Admin, Account Holder, Superadmin):
- Go to the “User” section.
- Locate the user and click the “Pencil” icon.
- Modify the pre-populated “Edit User” form.
- Click “Save.”
-
Updating User Role (Admin, Account Holder, Superadmin):
- Navigate to the “User” section.
- Find the user and click the “Pencil” icon.
- Select the new role from the dropdown menu.
- Save the changes.
-
Blocking User Access (Admin, Account Holder, Superadmin):
- Go to the “User Management” section.
- Locate the user to block.
- Click the “Block” icon (e.g., a lock) or “Block” button.
- Confirm the action in the dialog if prompted.
Configuration & Customization
System administrators define user roles and permissions, configure password settings, and manage assignments to sites, departments, and user roles.
Related Features & System Connections
- Department Management: Users are typically assigned to departments.
- Access & Permissions: User roles determine access to different features and data.
- Audit Logs: User actions (creation, modification, blocking) are often logged for security and compliance.
Best Practices
- Follow the principle of least privilege when assigning user roles.
- Establish clear guidelines for password creation and management.
- Regularly review user accounts and access levels.
- Promptly block or remove accounts of departing employees.
Sites Management
This section covers the management of sites within the system, including viewing, adding, editing, and deleting site entries.
Access & Permissions
| Role | Access Level | Restrictions (Web Admin) |
|---|---|---|
| Superadmin | Full access (View, Add, Edit, Delete) | None |
| Account Holder | Full access (View, Add, Edit, Delete) | None |
| Admin | Full access (View, Add, Edit, Delete) | Can View, Add, Edit, Delete. |
| Supervisor | Can not View, Add, Edit, Delete | Focused on checklists in the application. |
| Auditor | Can not View, Add, Edit, Delete | Focused on checklists in the application. |
| Customized Role | Depends on inherited user role | Inherits restrictions based on the assigned user role. |
Key Capabilities
- View a comprehensive list of all defined sites.
- Create new site entries.
- Modify details of existing sites (e.g., name, address, associated users).
- Remove site entries from the system.
Core Workflows & UI Walkthrough
-
Viewing All Sites (All Roles with Access):
-
Adding a Site (Admin, Superadmin, Account Holder):
-
Editing Site Information (Admin, Supervisor, Superadmin, Store Manager, Auditor):
-
Deleting a Site (Admin, Supervisor, Superadmin, Store Manager, Auditor):
Configuration & Customization
The types of information tracked for each site can be configured, and integration with mapping services might be an option.
Related Features & System Connections
- Department Management: Sites might be associated with specific departments.
- User Management: Users are often associated with particular sites.
- Reporting [Schedule](../../Schedule/Schedule Listing/ScheduleListingOverview.md): Reports might be specific to certain sites.
Best Practices
- Maintain an accurate and up-to-date list of all operational sites.
- Use clear and consistent naming conventions for sites.
Reporting [Schedule](../../Schedule/Schedule Listing/ScheduleListingOverview.md)
This section outlines the process for defining and assigning reporting [schedules](../../Schedule/Schedule Listing/ScheduleListingOverview.md) within the system.
Access & Permissions
| Role | Access Level | Restrictions (Web Admin) |
|---|---|---|
| Superadmin | Full access (Create, Assign) | None |
| Account Holder | Full access (Create, Assign) | None |
| Admin | Full access (Create, Assign) | Can Create, Assign. |
| Supervisor | Can not Create, Assign | Focused on checklists in the application. |
| Auditor | Can not Create, Assign | Focused on checklists in the application. |
| Customized Role | Depends on inherited user role | Inherits restrictions based on the assigned user role. |
Key Capabilities
- Define [schedules](../../Schedule/Schedule Listing/ScheduleListingOverview.md) for generating and distributing reports.
- Assign specific reporting [schedules](../../Schedule/Schedule Listing/ScheduleListingOverview.md) to relevant users, departments, or sites.
Core Workflows & UI Walkthrough
-
Creating a Reporting [Schedule](../../Schedule/Schedule Listing/ScheduleListingOverview.md) (Admin, Superadmin, Account Holder):
- Go to the “Reporting [Schedule](../../Schedule/Schedule Listing/ScheduleListingOverview.md)” section.
- Define the report type, frequency (e.g., daily, weekly, monthly), delivery method (e.g., email), and recipients in the form.
- Configure and save the [schedule](../../Schedule/Schedule Listing/ScheduleListingOverview.md) details.
-
Assigning a Reporting [Schedule](../../Schedule/Schedule Listing/ScheduleListingOverview.md) (All Roles with Access):
- Navigate to the “Reporting [Schedule](../../Schedule/Schedule Listing/ScheduleListingOverview.md)” section or a related “Assignment” area.
- Select a reporting [schedule](../../Schedule/Schedule Listing/ScheduleListingOverview.md) from the list.
- Choose the users, departments, or sites to apply the [schedule](../../Schedule/Schedule Listing/ScheduleListingOverview.md) to.
- Save the assignments.
Configuration & Customization
The types of reports available for scheduling are typically predefined but can be customized. Delivery methods and scheduling options might also be configurable.
Related Features & System Connections
- User Management: Reporting [schedules](../../Schedule/Schedule Listing/ScheduleListingOverview.md) can be linked to users for delivery.
- Department Management: [Schedules](../../Schedule/Schedule Listing/ScheduleListingOverview.md) can be assigned to specific departments.
- Site Management: Reports can be tailored to specific sites.