Skip to main content

Building a Support Tickets Entity

An entity is the primary element for storing data, similar to tables in databases. They are defined in each system to represent different sections or elements. For more information about entities, refer to Entities.

Adding a Support Tickets Entity

To build an entity within the Customer Support module that includes operations on support tickets, follow these steps:

  1. Click on the Customer Support module.
  2. Click on the Add Entity button.

Add Entity

A window for adding an entity appears, where you need to fill in the entity information:

  1. Name (Mandatory): Name it "Support Tickets" in both Arabic and English.
  2. Icon (Mandatory): The system administrator should select an icon for the entity; let's choose the "wrench" icon.
  3. Entity Type (Mandatory): The system administrator should define the entity type. In this case, it will be "Natural Entity". For more information on entity types, refer to Entities.
  4. Model Field (Mandatory): This field is generated automatically once the entity name is entered in Arabic or English, but the system administrator can modify this field. It cannot be left empty. For more information on the model field, refer to Model Field.
  5. Unit Field (Mandatory): This is a locked field that cannot be modified, automatically filled with the unit name where the entity is created, "Customer Support System".
  6. Singular Name (Optional): This is the singular name of the entity entries, which will be "Support Ticket" in both Arabic and English.
  7. Plural Name: This is the plural name of the entity elements, which will be "Support Tickets" in both Arabic and English.
  8. Permissions Management (Optional): The system administrator can control the entity's permissions as needed. For more information on permissions, refer to Permissions.
  9. Click the "Create" button to create the "Support Tickets" entity.

Entity Details

Adding Entity Structure

Once the entity is added, the user is directed to the entity details page. To build the entity structure, follow these steps:

  1. Click on the Structure tab.
  2. An empty page appears.
  3. Drag and drop the structure fields into the empty area. The fields are as follows:

Entity Structure

  • Ticket Number (Sequential Field).
  • Ticket Title (Multi-language Text).
  • Ticket Description (Multi-language Text).
  • Ticket Status (Classification): Status options (Open, In Progress, Responded, Duplicate, Closed).
  • Assignee (User).
  • Ticket Opening Date (Date and Time).
  • Ticket Closing Date (Date and Time).
  • Solution (Block).
  • Solution (Multi-language Text).
  • Service Rating (Block).
  • Rating Score (Converter): Add rating options from 1-5.
  • Comment (Multi-language Text).
  1. Click the "Save" button to save the structure of the "Support Tickets" entity.

Save Structure Save Structure Save Structure

Adding Workflow:

To build a workflow for the entity, follow these steps:

  1. Click on the Workflow tab.
  2. The workflow page appears.
  3. Click on "Click to activate the workflow" in the middle of the page to activate the workflow.

Workflow Tab

  1. Click on "Start" to change the step name.
  2. Workflow step settings appear.
  3. Change the name "Start" to "Open Ticket".

Workflow Step

  1. Change the action name "Start" to "Submit Request".

Change Action Name

  1. Change the field settings in the step by clicking on "Open Ticket".
  2. Click on "Editable" to display field options and select what you want to display.

Field Settings Field Settings

  1. Build the second step, "Support Desk", by clicking on "Add Step".

Add Step

  1. A popup window appears to fill in the step information.
  2. Click the "Finish" button to save the step.

Save Step Save Step

  1. To delete a step, click on "Delete Step". Delete Step

  2. Change the name of the main action to "Send for Processing" as done in the first step.

Change Action Name Change Action Name

  1. Build a new step, "Ticket Processing", by following the same steps as before.

Build New Step Build New Step

  1. Change the name of the main action to "Review Solution".
  2. Change the target step to "Previous Step".

Change Target Step

  1. Add a new step, "Service Rating", by following the same steps as before.
  2. Change the name of the main action to "Rated".
  3. Change the target step to "Support Desk".
  4. Change the field settings for the "Service Rating" step.

Service Rating Step Service Rating Step

  1. Change the target step in the "Send for Processing" action in the "Support Desk" step to "Ticket Processing".

Change Target Step Change Target Step

  1. Add a new action "Close Ticket" by clicking the + sign at the top of the step.
  2. A popup window appears to fill in the action information.

Add Action

  1. Add a new action "Send Solution".

Add Action Add Action

  1. Build a new step, "Manager Approval", by following the same steps as before.
  2. Change the name of the main action to "Approve".
  3. Change the target step to "Previous Step".

Build New Step Build New Step Field Settings

  1. Add a new action for the "Manager Approval" step called "Reject" by following the same steps as before.

Add Action

  1. Add a new action in the "Support Desk" step called "Manager Approval" as done before.
  2. Click the + sign at the top of the step.

Add Action

  1. Change the field settings of the "Support Desk" step.

Change Field Settings Change Field Settings

  1. Change the field settings of the "Ticket Processing" step.
  2. You can also delete a step by clicking on the "Delete Step" button in the step settings.

Delete Step Delete Step

  1. Click the "Save" button to save the workflow.
  2. To delete the workflow, click on the trash can icon at the top of the workflow.

Save Workflow

For more information about workflows, refer to Workflows.

Adding Reactions

Reactions allow you to set up notifications and send them to the concerned parties. To add a notification, follow these steps:

  1. Click on the Reactions tab on the entity details page.
  2. Click on the + sign.

Add Reaction

  1. A popup window appears to fill in the reaction information.
  2. Add a reaction called "Customer Response".

Customer Response Customer Response Customer Response

  1. Add another reaction called "New Ticket Arrival" by following the same steps.

New Ticket Arrival New Ticket Arrival New Ticket Arrival

  1. Add a new reaction called "Ticket Assigned to You" by following the same steps.

Ticket Assigned Ticket Assigned Ticket Assigned

  1. Add a new reaction called "Solution Review" by following the same steps.

Solution Review Solution Review Solution Review

  1. Add a new reaction called "Solution Reviewed".

Solution Reviewed Solution Reviewed Solution Reviewed

  1. Add a reaction called "Request Solved".

Request Solved Request Solved Request Solved

  1. Add a reaction called "Service Rating".

Service Rating Service Rating Service Rating

  1. Click the "Save" button to save the reactions.

Save Reactions

For more information about reactions, refer to Reactions.