Sentient Guide
Cases
Cases is the core of the Support module. It allows agents to:
- Create and manage support cases (issues, bugs, requests).
- Assign cases to owners (team members).
- Track status, priority, severity, age, and affected site or client.
- Cases are auto-refreshed every 2 seconds by default, with options to change the refresh rate to 30 seconds, 1 minute, or pause it.
- Filter and search cases by department/team, board, condition, and case number.
1. Add New Case
- Go to Support > Cases
- Click “+ Case” and fill required fields then Save.
- If contact not found, click the green "+" icon beside the Company/Contact field and fill in the required information for the new contact under the specific company.
- If site not found, click the green "+" icon beside the Site field and fill in the required information.
Fields marked with a red asterisk ( * ) are mandatory and must be filled out before submitting the case.
1.1 Assign Multiple Cases
After selecting one or multiple cases, you can either assign them directly to a specific user or move them to another board.
1.2 Merge Cases
Cases must share the same Company, Site, and Contact.
How it works:
- Select the cases you want to merge.
- Once validated (same company, site, and contact), choose which case will act as the parent.
- The other selected cases will be merged under the chosen parent as child cases.
1.3 Delete Cases
You can also delete one or multiple cases. A confirmation popup will appear, requiring you to type the word "delete" to confirm and proceed with the deletion.
2. Generate Report
The Generate Report functionality allows agents to filter and export case-related data based on multiple criteria mentioned above.
The Table View dropdown includes three report formats:
- Support Report: Shows full case details with team, site, and product information.
-
Generic Report: When using the Generic Report view, a new filter appears:
Additional Resources- Choose to display:- All Cases
- With Additional Resources
- Without Additional Resources
- Notes View Report: Focused on case notes — you can filter by Note From Date and by Note Sender.
Also includes the option to export the filtered report to a downloadable format (typically Excel or CSV).
3. Filter Table
Clicking on the checkbox toggles visibility:
- Checked – Column is shown
- Unchecked – Column is hidden
- Drag & Drop – Click and drag each field to reorder the columns. This changes the order in which columns appear in the main table view.
4. Edit Case
By simply clicking on the case number, the Edit Case modal opens, allowing you to perform a variety of updates.
4.1 SLA Overview
This section displays the Service Level Agreement (SLA) tracking for the selected case. It includes the following metrics:
- Response Time: Time taken to provide an initial response after the case was created.
- Workaround Time: Time taken to apply a temporary solution or assign the case.
- Closure Time: Total time taken to fully resolve and close the case.
Each metric is represented by a colored badge that clearly indicates whether the SLA was met or breached for that stage.
You can toggle the visibility of this section using the arrow button in the top-right corner — click to expand or collapse the SLA details.
4.2 Basic Updates
You can update all basic fields that were initially available during case creation, such as the title, severity, contact, site, team, and description.
4.3 Linked Cases
The Link Cases toggle allows you to associate one case with another — ideal when multiple cases are related or stem from the same root issue.
When enabled, you can select and link relevant cases to group and track interconnected tickets more efficiently.
To link another case:
- Click the green "+" button under the Linked Cases section.
- A "Choose Case" popup will appear, allowing you to:
- Search by Case Number, Company, or Title.
- Select the case(s) to link by checking the box.
- Use the red "Clear" button to reset filters.
- Click Save to establish the link.
4.4 Supplier Escalation
Enable this option if the case needs to be escalated to a third-party vendor or supplier.
Once toggled on, it indicates escalation beyond the internal support team. Additional fields such as Vendor SR# and RMA# will appear to help track the supplier-side resolution.
4.5 External Board
External Boards enable secure case escalation between two separate tenants by linking them through configurable permissions. Before a case can be escalated, an approval workflow must be completed to ensure proper authorization and control.
Agents can view escalated cases by applying the relevant board filter in the cases list. Escalated cases are clearly identifiable once the external board is selected.
To escalate or manage a case, agents can update the board assignment directly from the Edit Case modal. Escalation is performed by changing the case's board assignment to the appropriate external board from the case details view.
5. Navigation Tabs
Located at the top of the panel, these tabs allow you to access different functions related to the case:
- Info: View and edit core case details.
- Notes: Add or review internal or client-facing notes.
- Resource Requests: Request internal resources.
- Change Requests, Survey, Activity: Manage workflows, collect feedback, and view the full history of actions taken on the case.
6. Notes Tab
In the Notes tab, agents can view, search, and manage all case-related notes.
The panel is divided into five sections: All Notes, External Notes, Internal Notes, Attachments, and My Drafts.
Agents can filter by each type, search within notes, and save notes as drafts.
6.1 Add Notes
A. Choose Type:
- Internal w/ Email: For internal communication only. Cannot send to external emails.
- Internal w/o Email: For internal tracking or documentation. No email is sent.
- External: Used to communicate with the client. Supports external emails and attachments.
- External Close Case: Sends a closure email to the client. Updates case status to Closed.
- External Cancel Case: Notifies the client the case is canceled. Includes cancellation reason and updates case status to Canceled.
B. Choose Status:
- Pending Internal: Waiting for internal action.
- Pending Customer: Waiting for a response or action from the customer.
- Workaround Provided: A solution has been given.
C. Working Hours:
Specify the time spent on the case (From / To). The system will automatically calculate total hours.
D. Description:
Write a clear message or update relevant to the status.
Note: Editing rights may vary depending on the user's role.
6.2 Editing Notes – Rules by Type
External Notes:
- Only the Worked Hours field is editable.
- Content and attachments cannot be changed after submission.
Internal Notes / Task Types:
- All fields are editable, including:
- Text content
- Note type
- Attachments (add/remove)
- Worked hours
6.3 Draft Option
Drafts can be edited before sending or deleted. They are clearly highlighted when the "My Drafts" section is selected.
7. Resources Tab
Request resources directly from the case.
Click “Create New Request” to open the request form.
You can specify:
- Intervention type (On Site or Remote)
- Affected site
- Onsite contact details
- Resource team
- Preferred resource (optional)
- Date of intervention
- Action plan
The request will remain pending approval by the person configured in the Resource Request settings.
8. Change Requests
To submit a change request from the case:
- Fill the required fields in the change request form
- Select a change request process (configured in the Change Management settings)
- Submit for approval based on the predefined workflow
9. Resources Overview
The Resources section in Edit Case > Info displays the time logged by each user on the case.
Tracked time is broken down into:
- IWH (Inside Working Hours)
- OWH (Outside Working Hours)
- Total Hours
These hours are pulled from the Worked Hours specified in each note.
The color-coded bars provide a quick visual representation of how effort was distributed.
Note: Working hour schedules (IWH/OWH) are configured by the admin in another section of the system.
Cases Settings
1. Define Case Owners
This section allows admins to define who can own a case by selecting the department, team, and specific agents. Once configured, click Save to apply the changes.
2. Send Survey to Contact Upon Case Closure
When a case is closed, a survey can be automatically sent to the contact via email. This can be configured in two ways:
- Enable for all companies, with the option to exclude specific companies
- Enable only for selected companies
3. Notify Contact When Case is Assigned
When a case is assigned to an owner, an email notification can be sent to the case contact. You can configure this to:
- Send to all companies, with optional exclusions
- Send only to selected companies
4. Enable Editing Incident Date
When enabled, agents will be able to manually edit the incident date and time of a case after submission or during review. This field appears in the Edit Case modal based on the configuration:
- The main toggle enables or disables the feature
- You can choose whether it's enabled for all companies or only specific ones
5. Status Board Configuration
This section handles automatic and manual case board changes based on status or user actions:
- Automatic Board Change: Define status, department, and board. When a case reaches this status (e.g., Closed), it will automatically move to the configured board.
- Manual Board Change: Allows agents to move the case to a new board while submitting a note. This appears as an additional dropdown during note creation.
6. Linked Case Rules
This configuration controls behavior for parent-child linked cases:
- Enable Link Case: Toggles visibility of the Linked Cases section in the Edit Case modal. If disabled, all link-related options are hidden.
- Require Closure of Child Cases: When enabled, the parent case cannot be closed unless all child cases are either Closed or Cancelled.
7. Linking Affected Assets
This option enables associating relevant company assets with a case:
- Enable Asset Linking: When turned on, agents can add affected assets to the case.
- Link with Exception: Enable for all except specific companies (excluded list).
- Link with Inclusion: Enable only for specified companies.
8. Make Technology Mandatory
If the flipswitch is enabled, a value for the technology field must be entered before creating the case. Turn it off if you do not want to enter a value.
9. Open Case by Email
This modal allows you to create a configuration where you select one or more companies and define subject keywords.
- You can choose the operator (AND / OR) between the subject words.
- If an incoming email subject matches these keywords for the selected companies, the system will override the severity.
- The severity defined in this configuration will become the dominant severity for the case created, instead of the severity selected in the “Add Company” modal in the database.
Reports
This section allows agents to upload and organize reports in a structured folder system. To add a new report:
- Select Company: Choose the company to associate with the report.
- Main Folder: Pick the top-level category under which the report should be saved.
- Sub Folder: Define a year or specific label to group reports further (e.g., “2025”).
- Attachments: Use the green “+” button to upload one or more report files. You can also clear all uploaded files using the “Clear All” option.
- Click Save to finalize the upload. The report will be listed in the corresponding folder and visible to agents with access permissions.
Surveys
The Surveys Tab displays all responses submitted after a case is closed. It shows the case timeline, ownership, feedback, and submission metadata.
You can filter the results by date opened, date closed, company, contact, and survey status. Use the export options to download the displayed data.
The Surveys section also includes a dashboard with its own filters for analyzing survey data and responses.
Contracts
The Contracts Tab displays a list of active contracts linked to each company. It includes essential metadata like contract number, dates, and service type.
You can filter contracts by start date, end date, or company name to narrow down results.
Case Scheduler
- Create scheduled cases that repeat automatically (e.g., every month, quarter, year...)
- Add the company/contact, site, severity, schedule, and other required details
- If the contact or site do not exist, click the green + button to add it on the spot
- Edit or delete any existing scheduled case directly from the list after selecting a case scheduler
The Case Scheduler interface showing options to create scheduled cases that repeat automatically, with fields for company/contact, site, severity, schedule, and the ability to add contacts/sites using the green "+" button.
Rules,Routes & Boards
1. Rules
- Creating a rule involves 4 steps:
- Enter a description
- Set one or more conditions
- Define the actions to take
- Preview and confirm
- Configure actions triggered by specific case conditions (e.g., severity, time unassigned, status).
- You can:
- Add, Edit, Copy, Delete rules
- Filter the rules based on the Actions dropdown
Rules Conditions Overview showing how to set one or more conditions for rules based on case properties like severity, time unassigned, and status.
Rules Actions showing how to define actions to take when rule conditions are met, with options to configure automated responses.
Rule Overview.
2. Routes
- Routes define how cases are directed to boards based on predefined filters.
- Each route includes:
- A priority number to determine execution order
- Conditions (source, company, severity, etc.)
- Actions (e.g., route to a specific board, notify contact)
- Just like rules, routes can be added, edited, copied, or deleted.
3. Boards
Boards help divide cases by team. Super Boards help monitor and manage multiple boards in one place — especially useful for escalation, oversight, or reporting.
- Create and manage Boards and Super Boards for organizing cases by department and team.
- You can assign visibility by department, team, and user.
- Super Boards can group multiple boards together for centralized management.
- Filter boards, and use actions: Add, Edit, Delete.
3.1 External Boards
- Enter a description
- Set one or more conditions
- Define the actions to take
- Preview and confirm
- Add, Edit, Copy, Delete rules
- Filter the rules based on the Actions dropdown
- A priority number to determine execution order
- Conditions (source, company, severity, etc.)
- Actions (e.g., route to a specific board, notify contact)
Boards help divide cases by team. Super Boards help monitor and manage multiple boards in one place — especially useful for escalation, oversight, or reporting.
External Boards allow you to link two separate tenants and enable case escalation between them based on configured permissions. This feature includes an approval process that must be completed before a case can be escalated from one tenant to another.
SLA
1. SLA Configuration
- What is an SLA?
SLA (Service Level Agreement) defines the expected Response, Workaround, and Closure times for support cases based on their severity (S1 to S4). - Purpose:
To ensure timely and consistent support service levels for different types of issues — for example, emergencies (S1) are handled faster than minor issues (S4). - In this section you can:
- View existing SLAs and their priority values.
- Add new SLAs with custom Response / Workaround / Closure times.
- Specify if the SLA applies during holidays.
- Associate SLAs to specific Sites and Companies.
- Set individual Schedules for each association.
- Available actions: Add, Edit, Copy, Delete SLA
2. Schedules
- Schedules define the working days and hours that can be applied to SLA configurations.
- You can create custom schedules by specifying:
- Schedule name
- Working days
- Time from and Time to (in HH:MM format)
- These schedules can later be associated with SLAs to determine when timing should be counted (e.g., exclude holidays or non-working hours).
- Each schedule can be added, edited, or deleted.
3. Dashboard
The Dashboard provides a visual interface for monitoring support team performance and SLA metrics.
It displays key metrics including active cases, response times, resolution times, and hours spent per engineer or customer.
Escalation
Escalation Overview
- Purpose: Escalation Suppliers allow cases to be automatically escalated via email to external parties or vendors when configured conditions are met.
- Setup:
- Supplier Name: Unique identifier for the escalation vendor.
- Approval Process: Specify the required approvers and their sequence (e.g., L1, L2...)
- Email Destination: Define the primary recipient (To) and optional CCs for the escalation email.
- Email Content:
- Supports system variables such as
%case_number%,%case_description%,%owner_fullname%to auto-fill email content. - You can customize both the subject and body of the escalation email.
- Supports system variables such as
- Actions: You can add, edit, or delete escalation suppliers from the list view.
Dashboard
Dashboard Overview
- Visual interface for monitoring support team performance.
- Displays key metrics:
- Active, Overdue, Assigned, and Closed cases per engineer
- Response & Resolution time per case owner
- Hours Spent:
- Per Engineer
- Per Customer
- IWH = Inside Working Hours
- OWH = Outside Working Hours
- Available filters:
- Severity
- Timeframe (e.g., Yesterday, This Week, Customized)
- Toggle to include/exclude Internal Cases
Scheduled Reports
Scheduled Reports Overview
- Used to automate and schedule report delivery to designated recipients.
- Each row includes:
- Title of the report
- Schedule (e.g., First of the Month)
- Company linked to the report
- Status (Enabled or not)
- Clicking the Add button opens the configuration form where you:
- Select the company and upload its logo
- Choose the schedule and template
- Customize the report title, file name, subject, and body
- Define the recipients (To and Cc)
Projects
1. Projects
- Allows agents to manage projects similar to how support cases are handled.
- Each row represents a single project with fields such as:
- Project #, SO #, REF #, Project Manager, Status, Company, etc.
- Includes filters by:
- Project Manager
- Status
- Team
- Resource
- Project#
- Support types configured in project settings second tab.
- Clicking the + button opens a form to create a new project with fields for:
- Project details, stakeholders, kickoff date, SO#/REF#, expected duration, and description.
2. Generate Report
The Generate Report functionality allows agents to filter and export case-related data based on multiple criteria mentioned above.
The Table View dropdown includes two report formats:
- Default View: Basic report layout.
- Notes View Report: Focused on projects notes — you can filter by Note From Date and by Note Sender.
Also includes the option to export the filtered report to a downloadable format (typically Excel or CSV).
3. Navigations
-
Tabs per Project:
- Notes: View/add Internal, External notes, tasks, and drafts similar to the case module. Tracks worked hours (IWH / OWH).
- Documents: Attach files or URLs related to the project.
- Tasks: Manage project-specific tasks with status, priority, assignee, due date, and progress.
- Risk Management:
- Add risks with likelihood and impact sliders.
- See risk matrix and distribution.
- Change Requests: Similar to case change requests with implementation date, affected site, tech, reason, and checklist.
- Survey: (If applicable) Displays customer survey data for the project.
- Activity: Timeline/log of changes and updates.
Project Settings
1. Project Managers & Email Configuration
1.1 Define Project Managers
This section allows administrators to assign project managers by selecting a specific department, team, and agents. Once configured, these agents will be recognized as project managers within the system.
1.2 New Project Email Configuration
Configure the recipients of the email notification that is sent when a new project is created. Add the desired email addresses in the "To" and "Cc" fields. You can enable or disable this email via the toggle switch.
1.3 Closed Project Email Configuration
Similar to the new project email, this section defines who will be notified via email once a project is marked as closed. Recipients can be configured in both "To" and "Cc" sections, and the feature can be toggled on or off as needed.
2. Project Status, Types & Risks Management
2.1 Project Status Configuration
This section allows administrators to define the various statuses a project can have throughout its lifecycle. You can:
- Add new statuses by specifying a name and a display order.
- Edit existing statuses.
- Two default statuses — Initiation and Closed — cannot have their order changed, but their names can be edited.
2.2 Risk Management Categories
Admins can define and manage risk categories associated with projects. These categories help classify potential risks and ensure structured mitigation tracking. You can:
- Add new categories by entering a name.
- Edit or delete existing categories as needed.
2.3 Project Types Configuration
This section allows administrators to define the various types a project can have throughout its lifecycle.
3. Documents Management
Document Types Configuration
Define various types of project documents and mark whether each is required before project closure.
Documents Settings
Toggle whether documents can be added or deleted after a project is marked as closed. This ensures better control over final project documentation integrity.
Task Settings
1. Define Task Assignee
Specify the Department, Team, and Agents to assign responsibility for tasks. This helps ensure clear accountability within the team structure.
2. Define Task Priority
Configure the task priority levels (e.g., Low, Medium, High) to help organize and manage tasks based on urgency and importance. Each level can have a custom name, order, and color.
3. Define Task Status
Configure task statuses to track and manage task progress efficiently. You can define the name, display order, and color for each status.
Contracts Management
Contracts Overview
This page displays all existing contracts in a tabular format with advanced filtering options:
- Filter by Company, Contract Type, Start Date, and End Date.
- Use the action buttons to create a new contract, edit an existing one, or generate a report.
To create a new contract, click the green "+" button and provide the required information:
- Contract Name and Company/Contact (You can create a new contact from here if not already available).
- Contract Type: Choose from SLA, Managed Services, or Resident Engineer.
- Start Date and End Date.
- Scope: Provide a detailed description of the contract.
we have three Contract Type
- SLA Contracts: Additional tabs for Case Scheduler and Inventory will appear, allowing you to define planned cases and associate assets , Type of Cases and Number of Cases covered under the contract.
- Managed Services, Resident Engineer: Allows selection of the Covered Technology.
The Covered technologies and the Types of Cases are configured in the Contracts Settings section.
Surveys
The Surveys Tab displays all responses submitted after a project is closed. It shows the project timeline, ownership, feedback, and submission metadata.
You can filter the results by date opened, date closed, company, contact, and survey status. Use the export options to download the displayed data.
My Workspace
The My Workspace tab provides a personalized view of all projects and cases assigned to you.
- You can filter the displayed list using the View dropdown:
- My Active Projects
- My Pending Handover Projects
- My Closed Projects
- All My Projects
- Selecting a project opens its details where you can:
- View Info related to the project
- Add or read Notes
- Access Tasks assigned to you and associated with the project
- Tasks can be filtered by status, priority, date, and range. Each task shows the assignee, priority, creator, and due date.
Dashboard
Dashboard Overview
- Visual interface for monitoring support team performance.
- Displays key metrics:
- Hours Spent:
- Per Engineer
- Per Customer
- IWH = Inside Working Hours
- OWH = Outside Working Hours
- Hours Spent:
- Available filters:
- Severity
- Timeframe (e.g., Yesterday, This Week, Customized)
- Toggle to include/exclude Internal Projects
Shifts Management
1. Shifts Definition
The Shifts module allows to define working schedules for agents.
Agents can perform the following actions within the Shifts module:
- Add Shift: Create a new shift by specifying the shift name, working days, and working hours.
- Edit Shift: Update existing shift details such as name, working days, or working hours.
- Delete Shift: Remove shifts that are no longer needed.
2. Shift Assignments
The Shift Assignments module allows to assign predefined shifts to departments, teams, or specific agents.
Agents can perform the following actions within the Shift Assignments module:
-
Add Shift Assignment: Create a new assignment by selecting a previously created shift and assigning it to a department, team, or specific agents.
- You can define whether the assignment is recurring or for a specific date.
- If it is for a specific date, you must specify the date and the assigned shift.
- Multiple shift assignments can be created as needed.
- You can enable the holiday switch to apply the shift during holidays.
- Edit Shift Assignment: Update existing assignment details such as shift, scope, or schedule.
- Delete Shift Assignment: Remove assignments that are no longer needed.
Shift assignments can be filtered by: Department, team, agent.
Note: Even if a specific agent is not directly assigned to a shift, if their department or team is included in the assignment, the shift will still apply to them. When searching for an agent, their associated department or team assignments will be automatically considered.
Holidays
Holidays Overview
The Holidays module allows to define and manage holidays within the system.
Agents can perform the following actions within the Holidays module:
- Add Holiday: Create a new holiday by specifying the holiday name and date. You can also define whether the holiday is a one-time event or a recurring annual holiday.
- Edit Holiday: Update existing holiday details such as name, date, or recurrence type.
- Delete Holiday: Remove holidays that are no longer needed.
Holidays can be filtered using the following criteria: Name and Year.
Overtime
1. Requests
The Overtime module allows agents to create and manage overtime requests based on work completed outside regular working hours.
Agents can perform the following actions within the Overtime module:
-
Add Overtime Request: Create a new overtime request by selecting a previously created note that reflects the work done after hours. Once selected, click save to submit the request.
- The request will go through approval levels depending on the configuration defined in the Settings module.
-
View Overtime Request: Access submitted requests and review their details.
- You can view the content of the associated note by opening the request and clicking the eye icon in the content column.
- Approve/Reject Request: If you are included in the configured approval levels, you are responsible for reviewing and either approving or rejecting the overtime request.
2. Settings
The Settings module allows to configure approval workflows and email notifications related to overtime requests.
Agents can configure the following within the Settings module:
- Approval Levels Configuration: Define the users responsible for approving overtime requests by assigning them to specific approval levels.
- Email Notification for Approvers: Configure email notifications for users assigned as approvers. If enabled, approvers will receive email notifications, in addition to system notifications, prompting them to review and approve or reject requests.
- Overtime Report Email Configuration: Configure the email notification used to send overtime reports to designated users.
Vacation & Leave
1. Requests
The Vacation / Leave module allows agents to submit and manage leave requests within the system.
Agents can perform the following actions within the Vacation / Leave module:
-
Add Leave Request: Create a new vacation or leave request by entering the required details such as leave type, dates, and any additional notes.
- The request will go through approval levels based on the configuration defined in the Settings module.
- View Leave Requests: Track the status of submitted requests (e.g., Pending, Approved, Rejected).
- Approve/Reject Request: If assigned within the approval levels, users are responsible for reviewing and approving or rejecting leave requests.
The module also includes a Dashboard that provides insights into leave data through visualizations such as graphs and tables, allowing administrators to monitor trends and user activity.
2. Settings
The Settings module allows to configure approval workflows and leave balance rules for vacation and leave requests.
Agents can configure the following within the Settings module:
- Approval Levels Configuration: Define the approval workflow for vacation and leave requests by assigning users to specific approval levels.
-
Balance Configuration: Configure the number of leave days available for users.
- The default number of days is applied when no custom configuration is defined.
- If a custom number of days is configured, it takes priority over any defined range.
Database
Companies
This section allows you to create and manage companies, define their attributes, configure their flags, and handle related contacts, sites, and integrations.
Create a New Company
Click the green "+" button to add a new company. You must provide:
- Company Name and Associated Domain (required fields).
- Account Manager, Focus On, and Company Tags.
- Phone Numbers and Teams (you can add multiple entries).
- Flags: Used to control visibility and enablement of features like:
- Enable Case Brief
- Enable Workaround Time
- Enable as Vendor / Contractor / Distributor
- Do Not Serve
- Allow Report Access for Contacts
- Open Case by Email: Enables automatic case creation via email. If toggled on, the relevant fields like Default Severity and Default Site Name become required.
Edit an Existing Company
When editing a company, the following tabs are available:
- Info: Displays the general company details filled during creation.
- Contacts: Allows you to add and manage people under the company. You can define their team, email, and case visibility level (e.g., My Cases, All Company Cases, etc.).
- Sites: Register physical or logical locations for the company, including country and site description.
- Integrations:
- PRTG Tab: Configure PRTG monitoring parameters including cluster, probes, default site/contact, and map URL.
- API Tab: Manage API integrations (if enabled for the tenant).
Flags determine how the company interacts with different modules (e.g., Vendor/Contractor visibility). Make sure to configure them properly during setup.
Contacts
This section enables you to manage all contacts linked to companies. You can filter, create, and edit contacts easily using the interface shown.
Search and Filter
You can filter contacts by: Company, Name, Email, Phone
Create a New Contact
Click the green "+" button to create a new contact. Required fields are marked with an asterisk (*):
- Company and Team (linked to the associated company)
- First Name and Last Name
- Support Portal Access: Toggle access to the support portal. If enabled, a password must be defined.
- Job Title, Case Visibility (e.g., “My Cases”, “Team’s Cases”, “All Company Cases”)
- Country, Phone, and Mobile numbers
Edit Existing Contact
Click on an existing contact’s row to update their details. You can also enable or disable their portal access directly from the contact table view.
Each contact must be linked to a valid company and team. Case visibility controls what cases the contact can access from the portal.
Sites
This section allows you to manage all sites associated with companies. You can view, filter, and create new sites using the provided interface.
Search and Filter
You can filter sites by: Company, Country, Site Name
Create a New Site
Click the green "+" button to create a new site. Required fields are marked with an asterisk (*):
- Company: Select the company to which the site belongs
- Site Name: Enter the name of the site
- Country: Choose the country where the site is located
- Description (optional): Provide additional details or context for the site
Edit Existing Site
Click on an existing site's row to update its details. You can modify the name, associated company, location, and description as needed.
Each site must be linked to a valid company. Sites can be referenced in contracts, assets, and support cases for precise location-based tracking.
Technologies
This section allows you to manage the list of technologies used across contracts, assets, and cases. Technologies are centralized here for consistency and reuse throughout the platform.
View and Search
You can browse all existing technologies and filter the list by:
- Technology Name
- Created Date
Create a New Technology
Click the green "+" button to create a new technology. Simply enter the desired Technology Name and click Save.
Edit or Copy Technology
- Edit: Click the purple edit button to rename an existing technology.
- Copy: Click the orange copy button to duplicate a selected technology for quick creation of a similar entry.
Technologies created here are referenced in Contract Configuration and Asset Classification. Ensure proper naming for consistency across modules.
Categories
This section lets you manage asset or service categories used across the platform for classification, filtering, and reporting purposes.
View and Filter
You can view all existing categories. Use the built-in filters to quickly locate a category by name.
Create a New Category
Click the green "+" button to create a new category. Provide a unique Category Name and click Save to add it to the list.
Edit or Copy Category
- Edit: Click the purple edit button to update the category name.
- Copy: Click the orange copy button to duplicate an existing category.
Categories created here are used in asset tagging and reporting. Maintain consistent naming to ensure accurate classification.
Change Management
Requests Overview
The Change Management module allows agents to create, track, and manage change requests in a structured and controlled manner, ensuring proper approval workflows and full visibility across the organization.
Creating a Change Request
A Change Request can be created in three different ways:
- From a Case: A change request can be initiated directly from an existing service desk case, ensuring traceability between the case and the related change.
- From a Project: Change requests can be created from within a project.
- From the Change Management Module (Standalone): Agents can create a change request directly from the Change Management module without linking it to any case or project. This option is used for standalone changes.
Each change request includes key information such as implementation date, company, change request process, affected technology, site, description, change reason, and service test checklist.
The change request process is configured through the Settings section.
Editing and Resending Change Requests
- While a change request is in Pending a Resend Email button is available, allowing notifications to be resent to approvers or stakeholders when required.
Reporting
The Change Management module provides reporting capabilities, allowing agents to generate reports on change requests. Reports can be filtered based on relevant criteria and used for tracking, auditing, and operational analysis.
Settings Overview
The Settings section allows administrators to configure two key components related to Change Management.
Change Management Request Process
This configuration defines how a change request is processed within the system. It allows administrators to set up the approval workflow and control how change requests move through different stages.
- Define the change request process and approval levels.
- Configure approval levels based on company requirements.
- Assign approvers who will receive email notifications and bell (system) notifications when action is required.
- Processes can be configured per company, allowing different workflows for different organizations.
Email Notification for Approvers Configuration
This configuration controls email notifications sent to approvers.
If the agents listed below are configured as Approvers, they will receive, in addition to the system notification, an email notification prompting them to review and approve change requests.
Asset Management
Assets Overview
The Asset Management module enables agents to manage organizational assets efficiently, providing full visibility, control, and approval.
Agents can perform the following actions within the Asset Management module:
- Add Asset: Create new assets with detailed information such as company, site, type, vendor, status, and assignment.
- Edit Asset: Update asset details as required.
- Delete Asset: Remove assets when they are no longer needed.
- Group Assignment: Assign one or multiple assets to a specific asset group for better organization and management.
Settings Overview
The Settings section allows administrators to configure key components related to Asset Management.
Asset Configuration
- Define asset groups based on company structure.
- Configure vendors associated with assets.
- Manage asset statuses (e.g. Opened, In Progress, Inactive).
- Define asset types (e.g. Firewall, Router, VM, Access Point).
Asset Approval Levels
The system supports an Asset Assignment Approval process.
- When enabled, the approval process is triggered during the asset creation phase.
- Asset creation or assignment will remain pending until the required approvals are completed.
- If this option is disabled, assets can be automatically approved without requiring manual approval.
Email Notification for Approvers Configuration
This configuration manages email notifications sent to asset approvers.
If the agents listed are configured as Approvers, they will receive, in addition to the system (bell) notification, an email notification requesting them to review and approve asset-related requests.
Contract Management
Contracts Overview
The Contract Management module enables agents to manage contracts efficiently, providing full visibility, control, and tracking of contractual agreements.
Agents can perform the following actions within the Contract Management module:
- View Contracts: Access a complete list of contracts with key details such as company, contract number, services, start and end dates, status, and creator.
- Filter & Search Contracts: Easily find contracts using filters like company, status, contract number, and date range.
- Add Contract: Create new contracts by entering details such as title, external ID, company, services, duration, and price.
- Upload Documents: Attach relevant files or provide URLs to supporting contract documents.
- Edit Contract: Modify existing contract information when updates are required.
- Export Contracts: Export contract data for reporting or external use.
- Track Status: Monitor contract status (e.g., Active or Expired) for better lifecycle management.
Settings Overview
The Settings section allows administrators to configure key components related to Contract Management.
Services Configuration
- Define and manage services that can be linked to contracts.
- Add, edit, or delete services that can be linked to contracts.
- Ensure proper categorization of contracts through service association.
Currency Configuration
- Select the default currency used for contract pricing.
- Ensure consistency in financial data across all contracts.
Notify Before Expiry
The system supports a contract expiry notification feature to alert agents before contracts expire.
- When enabled, notifications are sent a specified number of days before the contract expiration date.
- Define the notification timing (e.g., 10 days before expiry).
- Configure recipients in the To and Cc fields.
This configuration allows customization of the email notifications sent for contract expiry.
- Use default templates or define custom email subject and body.
- Insert system variables (e.g., %contract_title%, %contract_number%) to dynamically populate content.
- Ensure clear and informative communication regarding contract expiration.
Case Close Settings
This configuration controls contract selection behavior when closing a case.
- Enable Require Contract Selection to enforce selecting a contract before closing a case.
- If disabled, cases can be closed without linking to a contract.
- Customize how contracts appear in contract dropdown when closing a case using format templates and variables.
Nearly Expiry Days
Define the number of days before contract expiry that is considered as "nearly expiry".
Show Active Contracts Only
Configure whether to show only active contracts when selecting a contract in cases and notes.
Agents & Roles
Agents & Roles Overview
1. Agents
To create an Agent, the following elements must be created before: A department, a team and a role.
Agents can perform the following actions within the module:
- Add Agent: Create new agents with detailed information.
- Edit Agent: Update agents details as required.
- Delete Agent: Remove agents when they are no longer needed or turn off the status.
Authentication defines how the agent logs into the system:
- Local Login: The agent receives an email upon account creation to set their password.
- Google Login: The agent can log in using their Google account (if enabled).
- Microsoft Login: The agent can log in using their Microsoft account (if enabled).
When an agent’s status is set to Off, they are removed from all dropdown lists across the system and are no longer able to access or log into the portal.
2. Roles
To create a Role, a department must be created before.
Agents can perform the following actions within the role module:
- Add Role: Create new roles with detailed information.
- Edit Role: Update roles details as required.
- Delete Role: Remove roles when they are no longer needed.
The Roles module provides highly detailed permission control, where each action within every page and module is assigned a specific permission. Administrators can grant access to agents based on their responsibilities by selecting the relevant permission checkboxes. Each role is defined by a name and is associated with a specific department.
3. Departments
To create a Department, you need to define the department name, assign a Head of Department, and choose the department type.
Agents can perform the following actions within the Department module:
-
Create Department: Add a new department by entering the name, selecting the head, and choosing the department type:
- Support Department: Agents under this type are intended for all activities within the support process (Main Tab "Service Desk").
- Sales Department: Agents under this type are intended for all activities within the sales process (Main Tab "Sales").
- Project Department: Agents under this type are intended for all activities within the project process (Main Tab "Project Management").
- Edit Department: Update department details such as name, head, or type.
- Delete Department: Remove departments that are no longer needed.
4. Teams
To create a Team, a department must be created first.
Agents can perform the following actions within the Team module:
- Add Team: Create a new team by providing the team name, selecting the associated department, and specifying the page redirection. This determines which page users in this team are redirected to after logging in.
- Edit Team: Update existing team details such as name, department, or page redirection.
- Delete Team: Remove teams that are no longer needed.
Knowledge Base
Knowledge Base Overview
1.Requests
The Knowledge Base module allows agents to create and share articles based on resolved cases or recurring issues. This helps other agents quickly find solutions and improve efficiency.
Agents can perform the following actions within the Knowledge Base module:
- Add Article: Create a new knowledge base article by documenting the issue and its solution.
- Edit Article: Update existing articles as needed.
- Delete Article: Remove articles that are no longer relevant.
Articles can be filtered for easy access using the following criteria:
- Department
- Team
- Agent
- Technology
- Status
The module also includes a Leaderboard, allowing agents to track and identify agents who contribute the most articles to the knowledge base.
2. Settings
In the Settings module, agents can configure the approval levels for knowledge base articles, ensuring that articles follow the required review and approval process before being published.
Education Tracker
Requests Overview
1. Requests
The Requests module allows agents to create and manage various types of requests, including exams, certifications, and training.
Agents can perform the following actions within the Requests module:
-
Schedule Exam: Create a new exam request by entering all required details. Each exam follows approval levels configured in the Settings module.
- Once an exam is approved, you must record the exam results (Pass/Fail), the start and end dates, and attach any relevant exam files.
- Add Certification: Create a certification request. Approval is required if the related switch is enabled in Settings.
- Add Training: Create a training request. Approval is required if the related switch is enabled in Settings.
2. Entries
The Entries module allows agents to manage the core components used in requests, including exams, certifications, vendors, and training classifications.
Agents can perform the following actions within the Entries module:
- Exams: Add new exam names, edit existing exams, or delete exams that are no longer needed.
- Certifications: Add, edit, or delete certifications as required.
- Vendors: Add, edit, or delete vendors that are associated with certifications or training.
- Training Classifications: Add, edit, or delete training classifications for organizing training requests.
- All Entries: Agents can manage all entries comprehensively, ensuring the system remains up-to-date.
3. Settings
The Settings module allows administrators to configure approval levels, notifications, and email templates for requests such as exams and certifications.
Agents can configure the following within the Settings module:
- Approval Levels Configuration: Define the approval workflow for exams, certifications, and training requests. This ensures that requests follow the proper approval hierarchy before being processed.
- Notify Before Expiry: Configure email notifications to alert designated users before a certification or exam expires. The email content can be customized or use the default template.
- Exam Booking Email Configuration: If enabled, configure the email notifications that inform designated users to book an exam for a requester. This ensures timely scheduling and tracking of exams.