admin / Synapse-Cortex
publicSelf Hosted ITSM Tool with RBAC/Tenanting and MFA
Synapse-Cortex / synapse-cortex / docs / user-guide.md
5844 B · main
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 | # Synapse-Cortex — User Guide This guide covers day-to-day use of Synapse-Cortex for agents and requesters: logging in, working tickets, and browsing assets. ## 1. Logging In Go to your organization's Synapse-Cortex URL and sign in with the email and password your admin gave you. **If you have MFA enabled**, after entering your password you'll be asked for a 6-digit code from your authenticator app before you're let in. **If your admin has required MFA for your account** but you haven't set it up yet, you'll be sent straight to the enrollment screen the moment you log in — you can't reach the dashboard until you finish it. To enroll: 1. Open your authenticator app (Google Authenticator, Authy, 1Password, etc.) and scan the QR code shown, or type in the manual entry code below it. 2. Enter the 6-digit code your app is currently showing and click **Confirm & Enable**. You can also turn MFA on yourself any time from **Settings → Profile & MFA**, even if it isn't required. ## 2. The Dashboard The dashboard opens with four **queue cards**: - **Unassigned** — open tickets nobody is working yet. - **Awaiting User** — tickets waiting on a reply from the requester. - **SLA Breaching** — open tickets past their resolution deadline. This card glows red when it's non-zero — check it first. - **Resolved Today** — tickets closed out today. **Click any card** to jump straight to the Tickets list, pre-filtered to that exact set — no need to build a filter yourself. Below the cards is a table of the most recent tickets tenant-wide. ## 3. Working Tickets ### Searching and sorting Above the ticket table is a search box and a sort dropdown. Type one or more keywords and click **Search** — it matches against the ticket number, title, and description, and requires every keyword you type to appear somewhere (so "printer lobby" narrows to tickets mentioning both words, not either one). Combine it with a dashboard queue-card filter if one's active. The sort dropdown reorders the current list by newest, oldest, priority, or status, and re-applies immediately when changed. Click **× clear search** to drop the keyword filter. ### Creating a ticket From **Tickets**, click **+ New Ticket**. Fill in a title, optional description, type (Incident or Request), priority, and optionally link it to an asset or assign it to someone. Priority determines the SLA clock — Critical tickets have the tightest deadlines. ### Viewing and updating a ticket Click any **ticket reference** (e.g. `TCK-000042`) — in the dashboard table, the Tickets list, or an asset's linked-tickets panel — to open its detail page. From there you can edit: - **Title and description** — the main text fields at the top. - **Status** — New, In Progress, Awaiting User, Resolved, Closed. - **Priority** — changing this recalculates the SLA deadline based on the new priority's target. - **Assigned To** — pick any agent, tenant admin, or global admin in your organization. Click **Save Changes** — each field updates independently, and you'll see a confirmation banner when it's saved. The sidebar also shows the linked asset (if any), requester, resolution deadline, and whether the ticket is currently breaching SLA. ### Logging actions taken Below the title and description is an **Actions Taken** section — a running, timestamped log of what's actually been done on the ticket, separate from the description. Type what you did into the box and click **Log Action**; it's recorded with your name and the current date/time, newest entry first. There's no edit or delete for a logged action — it's a permanent record, so write it once it's actually done. Anyone who can view the ticket can see its action history, which is useful for handoffs between agents. If you're a `global_admin` or `tenant_admin`, you'll also see a **Delete Ticket** button on this page. Deleting a ticket is permanent (it removes its action history too) and can't be undone. ### Deleting multiple tickets at once Admins also get a checkbox in the leftmost column of the Tickets list — check the box on any tickets you want to remove (or the header checkbox to select every ticket currently shown), then click **Delete Selected** and confirm. This is just as permanent as deleting one ticket at a time from its detail page. ## 4. Browsing Assets **Assets (CMDB)** lists every registered device: its Asset ID, name, type, MAC/IP, status, location, and where it came from (**Manual** or **NetscanXi**). Click any **Asset ID** to open its detail page, which is organized into three independently-editable sections: - **Core Info** — name, type, status, location, and who it's assigned to. - **Network** — MAC and IP address. - **Discovered OS & Software** — operating system and installed software. For assets imported from NetscanXi, you'll also see the raw device-type label NetscanXi reported, even if Cortex categorized it differently. Each section has its own **Save** button, so you can update one part without touching the others. Any tickets linked to the asset are listed at the bottom — click through to jump straight to them. To register a new asset yourself, click **+ Register Asset** from the Assets list and fill in at least a name and MAC address (MAC is required for manually-created assets; it must be unique within your organization). Assets imported automatically from NetscanXi don't have this restriction, since some devices are discovered without a usable MAC address. The options in the **Type** dropdown are set by your admin (**Admin → Asset Types**), so the list you see may differ from another organization's. ## 5. Settings **Settings → Profile & MFA** shows your name, email, role, and tenant, lets you change your password, and manage your own MFA enrollment (see Section 1). |