Add DataHUB documentation and API reference
- Introduced new documentation for the DataHUB service, including purpose, roles, and business case. - Added detailed API reference for Quotes and Visits, including search endpoints and response structures. - Created sections for service records, time reports, and visits in the CustomerHUB documentation. - Implemented a change log and test plan for the DataHUB project. - Updated the introduction to include links to the new DataHUB documentation. - Modified navbar configuration to reflect changes in documentation structure.
This commit is contained in:
1 parent
d1251a5f05
commit
928a4451f7
38 files changed
+1725
-3
No files matched your search
@@ -0,0 +1,9 @@
|
||||
{
|
||||
"label": "CustomerHUB",
|
||||
"position": 4,
|
||||
"collapsible": true,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
"description": "User documentation for the CustomerHUB application — reference, guides, and explanations for every module."
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,8 @@
|
||||
{
|
||||
"label": "Explanation",
|
||||
"position": 1,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
"description": "Background and context for understanding how CustomerHUB works and why it is structured the way it is."
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,35 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
title: What is CustomerHUB
|
||||
---
|
||||
|
||||
# What is CustomerHUB
|
||||
|
||||
CustomerHUB is a web portal built on HOIST HUB that centralizes customer-facing operations — from quotes and orders to invoices, assets, and service records. It connects directly to IFS, acting as the operational front end for field teams and back-office staff.
|
||||
|
||||
## How it fits into the ecosystem
|
||||
|
||||
CustomerHUB does not store data independently. Every customer, order, quote, and invoice originates in or synchronizes with IFS. The portal surfaces that data in a structured, role-agnostic interface and allows users to act on it — creating orders, reviewing invoices, logging service records — without needing direct IFS access.
|
||||
|
||||
## Modules at a glance
|
||||
|
||||
| Module | Purpose |
|
||||
|---|---|
|
||||
| Dashboard | At-a-glance summary of open quotes, orders, invoices, and work tasks |
|
||||
| Customers | Manage customer profiles, contacts, addresses, and IFS sync |
|
||||
| Quotes | Create and track sales quotes through their lifecycle |
|
||||
| Customer Orders | Monitor order fulfillment from creation to invoicing |
|
||||
| Invoices | Review and track customer invoice status |
|
||||
| Visits | Log and manage customer site visits |
|
||||
| Assets | Track customer-owned assets |
|
||||
| Sales Parts | Browse the product catalog |
|
||||
| Service Records | Attach and review service documentation |
|
||||
| Forms | Fill and submit structured field forms |
|
||||
| Cases | Manage support or service cases |
|
||||
| Work Tasks | Track field work task status |
|
||||
| Time Report | Log time entries against work |
|
||||
| Administration | Manage users, profiles, and system configuration |
|
||||
|
||||
## IFS synchronization
|
||||
|
||||
Customer records can be imported directly from IFS using the **Import From IFS** tab in the Customers module. Once imported, the record can be kept in sync using the **Sync From IFS** action on the customer detail page. The **Last IFS Sync** field on each customer record shows when the last synchronization occurred.
|
||||
@@ -0,0 +1,8 @@
|
||||
{
|
||||
"label": "How-to Guides",
|
||||
"position": 3,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
"description": "Step-by-step guides for common tasks in CustomerHUB."
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,13 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
title: Find a customer
|
||||
---
|
||||
|
||||
# Find a customer
|
||||
|
||||
1. Click **Customers** in the sidebar.
|
||||
2. Type the customer name or IFS Customer ID in the search field.
|
||||
3. Click **Search**.
|
||||
4. Click the customer card to open the detail view.
|
||||
|
||||
To reset the search, click **Clear Filters**.
|
||||
@@ -0,0 +1,17 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
title: Import a customer from IFS
|
||||
---
|
||||
|
||||
# Import a customer from IFS
|
||||
|
||||
Use this when a customer exists in IFS but does not yet appear in CustomerHUB.
|
||||
|
||||
1. Click **Customers** in the sidebar.
|
||||
2. Click the **Import From IFS** tab.
|
||||
3. Type the customer name or IFS ID and click **Search**.
|
||||
4. Select the customer from the results.
|
||||
|
||||
The customer record is created in CustomerHUB and is immediately available in the **Customers** tab.
|
||||
|
||||
To keep an existing customer record up to date with IFS, use the **Sync From IFS** button on the customer detail page instead.
|
||||
@@ -0,0 +1,8 @@
|
||||
{
|
||||
"label": "Reference",
|
||||
"position": 2,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
"description": "Field-by-field and section-by-section reference for every module in CustomerHUB."
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,44 @@
|
||||
---
|
||||
sidebar_position: 7
|
||||
title: Assets
|
||||
---
|
||||
|
||||
# Assets
|
||||
|
||||
The Assets module tracks customer-owned equipment and functional areas, organized as a hierarchical asset tree synchronized with IFS.
|
||||
|
||||
## List view
|
||||
|
||||
Assets has two tabs: **Assets** (the active asset list) and **Import From IFS**.
|
||||
|
||||
**Search filters:** Asset Name or Code, Customer, Territory, Region. Use **+ Add Asset Attribute Filter** to add dynamic filters based on asset attribute values.
|
||||
|
||||
Results display as a collapsible tree reflecting the asset hierarchy. Use **Expand All** to flatten the view. Each row shows: **Asset** (name and code, links to detail), **Level**, **Type**, **Install Date**, **Customer**, **Created By**, **Belongs To**, **Is Active**, and a **View in IFS** link.
|
||||
|
||||
### Import From IFS tab
|
||||
|
||||
Search IFS for assets not yet in CustomerHUB. Importing creates the asset record and makes it available in the Assets tab.
|
||||
|
||||
---
|
||||
|
||||
## Asset detail
|
||||
|
||||
### General Information
|
||||
|
||||
- **Asset ID** — system-generated identifier
|
||||
- **Asset Level** — hierarchy level (e.g. Functional Area)
|
||||
- **Asset Type** — classification type
|
||||
- **Asset Description** — display name
|
||||
- **Belongs To** — parent asset in the hierarchy
|
||||
- **Customer** — owning customer
|
||||
- **Address** — physical location
|
||||
- **Installation Date** — date installed
|
||||
- **Last Synced On** — date of last IFS synchronization
|
||||
- **HUB Status** — Active or Inactive
|
||||
- **Operational Status** — current operational state (e.g. In Operation)
|
||||
|
||||
Use **Sync From IFS** to refresh the asset data from IFS. Use **Change Operational Status** to update the operational state.
|
||||
|
||||
### Asset Attribute Values
|
||||
|
||||
Custom attributes defined for this asset type, showing attribute name, unit of measure, and current value.
|
||||
@@ -0,0 +1,21 @@
|
||||
---
|
||||
sidebar_position: 11
|
||||
title: Cases
|
||||
---
|
||||
|
||||
# Cases
|
||||
|
||||
The Cases module manages support and service cases. Access is controlled by user permissions — not all users can view this module.
|
||||
|
||||
## List view
|
||||
|
||||
### Search filters
|
||||
|
||||
| Filter | Description |
|
||||
|---|---|
|
||||
| **Case Id** | Search by case identifier |
|
||||
| **Queued To** | Filter by the queue the case is assigned to |
|
||||
|
||||
:::note
|
||||
Cases requires specific permissions. If you see "You don't have permissions to view this screen", contact your system administrator.
|
||||
:::
|
||||
@@ -0,0 +1,54 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
title: Customer Orders
|
||||
---
|
||||
|
||||
# Customer Orders
|
||||
|
||||
The Customer Orders module manages sales orders from creation in HUB through submission to IFS and fulfillment.
|
||||
|
||||
## List view
|
||||
|
||||
**Search filters:** Order No, Customer PO No, IFS Status, HUB Status, Customer, Territory, Region, Tech Id.
|
||||
|
||||
Each result row shows: **Number**, **Customer PO No**, **Customer**, **IFS Status**, **HUB Status**, **Creation Date**, **Created By**, **Total Amount**.
|
||||
|
||||
Use **New Order +** to create a new order.
|
||||
|
||||
---
|
||||
|
||||
## Order detail
|
||||
|
||||
### Header fields
|
||||
|
||||
- **Customer** — customer this order is for (required)
|
||||
- **Wanted Delivery Date** — requested delivery date (required)
|
||||
- **Customer PO No** — customer's purchase order number (required)
|
||||
- **Tag PO No** — optional secondary PO reference
|
||||
- **Delivery Address** — address where goods will be delivered (required)
|
||||
- **Document Address** — address for invoice and document delivery
|
||||
|
||||
The summary bar shows **Total Value** and **Net Weight** across all order lines.
|
||||
|
||||
### Actions
|
||||
|
||||
- **Save** — save changes to the order header
|
||||
- **Refresh From IFS** — pull the latest data from IFS for this order
|
||||
- **Submit to IFS** — submit the order to IFS for processing
|
||||
- **View In IFS** — open the order directly in IFS (link in header)
|
||||
|
||||
---
|
||||
|
||||
## Tabs
|
||||
|
||||
### Lines — Order Lines
|
||||
|
||||
Individual products on the order: Line No, Part No, Part Description, Quantity, UoM, Weight, List Price, Customer Price, Discount (%).
|
||||
|
||||
### Attachments
|
||||
|
||||
Files attached to the order.
|
||||
|
||||
### Notes
|
||||
|
||||
Free-text notes associated with the order.
|
||||
@@ -0,0 +1,82 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
title: Customers
|
||||
---
|
||||
|
||||
# Customers
|
||||
|
||||
The Customers module manages all customer profiles in CustomerHUB. It has two tabs: **Customers** (the active customer list) and **Import From IFS** (for bringing new customers in from IFS).
|
||||
|
||||
## Customers tab
|
||||
|
||||
Search by customer name or IFS Customer ID. Results are not shown until **Search** is clicked. Use **Clear Filters** to reset.
|
||||
|
||||
Each result card shows:
|
||||
|
||||
- **Customer** — customer name and IFS Customer ID
|
||||
- **Representative** — assigned CRM representative(s)
|
||||
- **MSHA** — whether the site is MSHA-regulated
|
||||
- **IC** — inter company customer flag (checkmark if yes)
|
||||
- **Service Contract** — linked service contract, if any
|
||||
- **Agreement** — linked agreement, if any
|
||||
- **Status** — Active or Inactive
|
||||
|
||||
## Import From IFS tab
|
||||
|
||||
Search IFS for customers not yet in CustomerHUB by name or IFS ID. Selecting a result imports the customer record and creates a profile in CustomerHUB.
|
||||
|
||||
---
|
||||
|
||||
## Customer detail
|
||||
|
||||
Clicking a customer opens the detail view. The top bar provides:
|
||||
|
||||
- **Quick Find Customers** — jump to another customer without going back to the list
|
||||
- **Quick Access (In Page)** — scroll directly to a section
|
||||
- **User Profiles** — manage access profiles for this customer's portal users
|
||||
- **Users** — manage individual portal users for this customer
|
||||
|
||||
### General Information
|
||||
|
||||
- **Portal Owner** — the internal owner of this customer's portal
|
||||
- **Number of users allowed** — maximum portal users for this customer
|
||||
- **Status** — Active or Inactive
|
||||
- **Customer Name** — display name (from IFS)
|
||||
- **IFS Customer ID** — the customer's ID in IFS
|
||||
- **Price Group** — assigned pricing group
|
||||
- **Created On** — date the record was created in HUB
|
||||
- **Last Updated** — date of the last manual edit
|
||||
- **Last IFS Sync** — date of the last sync from IFS
|
||||
- **Is MSHA Site** — toggle: whether this is an MSHA-regulated site
|
||||
- **Inter Company Customer?** — whether this is an inter-company customer
|
||||
- **Inter Comp Markup** — markup percentage applied to inter-company orders
|
||||
|
||||
Use **Sync From IFS** to re-fetch all IFS data for this customer.
|
||||
|
||||
### Address Info
|
||||
|
||||
Addresses associated with the customer. Filterable by type (Delivery, Document) and status (All, Active, Inactive).
|
||||
|
||||
### Customer Contacts
|
||||
|
||||
Contacts linked to this customer, showing name, role, and contact details.
|
||||
|
||||
### Communication Methods
|
||||
|
||||
Preferred communication channels (email, phone, etc.) for this customer.
|
||||
|
||||
### CRM Representatives
|
||||
|
||||
Internal representatives assigned to manage this customer relationship.
|
||||
|
||||
### Proprietary Parts
|
||||
|
||||
Parts specific to this customer that are not in the general catalog.
|
||||
|
||||
### Customer Restricted Sales Groups
|
||||
|
||||
Sales groups that are restricted or granted special access for this customer.
|
||||
|
||||
### Customer Service Contracts
|
||||
|
||||
Active and historical service contracts linked to this customer.
|
||||
@@ -0,0 +1,65 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
title: Dashboard
|
||||
---
|
||||
|
||||
# Dashboard
|
||||
|
||||
The Dashboard is the home screen of CustomerHUB. It provides a real-time summary of activity across the main operational modules, filtered by customer and date period.
|
||||
|
||||
## Filters
|
||||
|
||||
- **Customer** — filters all widgets to a specific customer. Defaults to All.
|
||||
- **Period** — date range applied to all widgets. Defaults to the last 90 days.
|
||||
|
||||
## Widgets
|
||||
|
||||
### My Quote Approvals
|
||||
|
||||
Quotes pending your approval. Displays a count badge; shows "No items to show..." when the queue is empty.
|
||||
|
||||
### All Quotes
|
||||
|
||||
All quotes in the system, broken down by status. Each row links to the filtered quote list.
|
||||
|
||||
- **Planned** — quote created but not yet released
|
||||
- **Released** — quote sent to the customer
|
||||
- **Cancelled** — quote cancelled
|
||||
- **Closed** — quote completed
|
||||
|
||||
### My Quotes
|
||||
|
||||
Quotes assigned to the logged-in user. Shows a count badge; empty state when no quotes are assigned.
|
||||
|
||||
### Customer Orders
|
||||
|
||||
Open customer orders, broken down by fulfillment status.
|
||||
|
||||
- **Planned / Created** — order created in HUB, not yet submitted to IFS
|
||||
- **Planned / Ready for IFS** — order staged for IFS submission
|
||||
- **Planned / Submitted to IFS** — order submitted, pending IFS processing
|
||||
- **Invoiced** — order invoiced
|
||||
- **Released** — order released for fulfillment
|
||||
- **Reserved** — stock reserved for the order
|
||||
- **Picked** — items picked for shipment
|
||||
- **Cancelled** — order cancelled
|
||||
|
||||
### Customer Invoices
|
||||
|
||||
Open invoices, broken down by payment status.
|
||||
|
||||
- **Printed** — invoice printed but not yet posted
|
||||
- **Posted Authorized** — invoice posted and authorized
|
||||
- **Paid Posted** — invoice paid and posted
|
||||
|
||||
### Work Tasks
|
||||
|
||||
Active work tasks, broken down by progress status.
|
||||
|
||||
- **New** — task created, not yet started
|
||||
- **Released** — task released to the field
|
||||
- **Work Started** — task in progress
|
||||
|
||||
## Navigation
|
||||
|
||||
Each status row in every widget is a link. Clicking a row navigates to the corresponding module pre-filtered by that status, the selected customer, and the selected period.
|
||||
@@ -0,0 +1,24 @@
|
||||
---
|
||||
sidebar_position: 10
|
||||
title: Forms
|
||||
---
|
||||
|
||||
# Forms
|
||||
|
||||
The Forms module lists all dynamic forms that have been submitted — either standalone or as part of a visit. Forms are structured templates configured per installation; their sections and fields vary by form type.
|
||||
|
||||
## List view
|
||||
|
||||
**Search filters:** Form Name, Customer, Date Submitted, Created By.
|
||||
|
||||
Results load automatically without needing to click Search. Each row shows: **Name** (links to detail), **Customer**, **Form Type**, **Created By**, **As Visit?** (whether submitted as part of a visit), **Date Submitted**, and a PDF download icon.
|
||||
|
||||
---
|
||||
|
||||
## Form detail
|
||||
|
||||
The detail view renders the submitted form with all answers visible, divided into the sections defined by the form template (e.g. People / Location, Task / Equipment).
|
||||
|
||||
The metadata header shows: **Customer**, **Tech Id**, **Created By**, **Territory**, **Region**, **Date Submitted**.
|
||||
|
||||
Form answers are read-only in the detail view.
|
||||
@@ -0,0 +1,46 @@
|
||||
---
|
||||
sidebar_position: 5
|
||||
title: Invoices
|
||||
---
|
||||
|
||||
# Invoices
|
||||
|
||||
The Invoices module provides a read-only view of customer invoices synchronized from IFS.
|
||||
|
||||
## List view
|
||||
|
||||
**Search filters:** Invoice No, Order No, Status.
|
||||
|
||||
Each result row shows: **Invoice No**, **Order No**, **Customer** (with IFS ID), **Date**, **Status** (PaidPosted, PostedAuth, Printed), **Gross Amt**, and a **View In IFS** link.
|
||||
|
||||
Use **Export to Excel** to download the list.
|
||||
|
||||
---
|
||||
|
||||
## Invoice detail
|
||||
|
||||
### General Information
|
||||
|
||||
- **Customer** — customer name and IFS ID
|
||||
- **Series ID** — invoice series identifier
|
||||
- **Invoice No** — invoice number
|
||||
- **Status** — current status
|
||||
- **Invoice Created At** / **Order Created At** — creation dates in IFS
|
||||
- **Currency** — invoice currency
|
||||
- **Gross Amount** — total amount including tax
|
||||
- **Tax Amount** — tax portion
|
||||
- **Net Amount** — amount excluding tax
|
||||
|
||||
Use **View in IFS** (top right) to open the full record in IFS.
|
||||
|
||||
### Invoice Lines
|
||||
|
||||
Each line shows: position number, invoice item description, invoiced quantity, unit price including tax, and originating order number.
|
||||
|
||||
### Attachments
|
||||
|
||||
Files attached to the invoice.
|
||||
|
||||
:::note
|
||||
Invoices are sourced from IFS and cannot be edited in CustomerHUB.
|
||||
:::
|
||||
@@ -0,0 +1,82 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
title: Quotes
|
||||
---
|
||||
|
||||
# Quotes
|
||||
|
||||
The Quotes module manages the full lifecycle of sales quotations, from creation through release, approval, and closure.
|
||||
|
||||
## List view
|
||||
|
||||
**Search filters:** Quotation No, Quotation Name, IFS Status, HUB Status, Quote Type (Transfer Point / Product with Install / Product Only), Customer Contact, Customer, Territory, Region, Tech Id.
|
||||
|
||||
Each result row shows: **Number**, **Name**, **Customer**, **Contact**, **Quote Type**, **IFS Status**, **Hub Status**, **Creation Date**.
|
||||
|
||||
Results are paginated. Use **New Quote +** to create a new quote.
|
||||
|
||||
---
|
||||
|
||||
## Quote detail
|
||||
|
||||
### Header fields
|
||||
|
||||
- **Quotation No** — auto-generated quote number
|
||||
- **Customer** — customer this quote is for (required)
|
||||
- **Customer Contact** — primary contact for this quote (required)
|
||||
- **Address** — delivery address (required)
|
||||
- **Responsible Person** — internal owner of the quote (required)
|
||||
- **Quote Type** — Transfer Point / Product with Install / Product Only (required)
|
||||
- **Quotation Name** — descriptive name for the quote (required)
|
||||
- **Pricing Validity** — how long the quoted prices are valid
|
||||
- **Wanted Delivery Date** — requested delivery date
|
||||
- **Expiration Date** — date the quote expires
|
||||
- **Coordinator** — internal coordinator assigned to the quote
|
||||
- **Formal Proposal Required** — toggle: whether a formal proposal document is needed
|
||||
- **Risk Assessment** — toggle: whether a risk assessment is required
|
||||
- **Region** / **Territory** / **Tech Id** — geographic and assignment context
|
||||
- **Service Contract** — linked service contract, if any
|
||||
- **Created By** — user who created the quote
|
||||
- **Ships From Remote Inventory** — toggle: whether items ship from remote stock
|
||||
|
||||
### Summary bar
|
||||
|
||||
Displayed below the header: **Total Value**, **Net Weight**, **Total Install** (hours), and a **Show Section Total** toggle that displays per-section subtotals in the Lines tab.
|
||||
|
||||
### Actions
|
||||
|
||||
- **Save** — save changes to the quote header
|
||||
- **Cancel Quote** — cancel the quote (sets IFS status to Cancelled)
|
||||
- **Release** — release the quote to the customer (sets IFS status to Released)
|
||||
|
||||
---
|
||||
|
||||
## Tabs
|
||||
|
||||
### Lines
|
||||
|
||||
Quote line items organized into sections. Each section can contain one or more product lines. Sections and individual lines can be added or deleted.
|
||||
|
||||
### Quotation Charges
|
||||
|
||||
Additional charges applied to the quote: Charge Type, Charge Group, Charge %, Charge % Basis, Qty, UoM, Tax Liability, Charge Amt.
|
||||
|
||||
### Quotation Details
|
||||
|
||||
Additional metadata in two groups.
|
||||
|
||||
**General:** Customer Agreement, Customer Price Group, Alternative Quote, Credit Limit, Credit Blocked, Probability, Lead Time (Min / Max / Unit).
|
||||
|
||||
**Miscellaneous:** Channel, Created On, Closed Date, Market, Sales Material.
|
||||
|
||||
### Involved Parties
|
||||
|
||||
Contacts associated with this quote: Name, Phone, Mobile, Email, and whether they are the main contact.
|
||||
|
||||
### Photo Gallery
|
||||
|
||||
Photos attached to the quote.
|
||||
|
||||
### Attachments
|
||||
|
||||
Files attached to the quote.
|
||||
@@ -0,0 +1,44 @@
|
||||
---
|
||||
sidebar_position: 8
|
||||
title: Sales Parts
|
||||
---
|
||||
|
||||
# Sales Parts
|
||||
|
||||
The Sales Parts module is the product catalog — a searchable list of all parts available for quoting and ordering, synchronized with IFS.
|
||||
|
||||
## List view
|
||||
|
||||
Sales Parts has two tabs: **Sales Parts** (the catalog) and **Import from IFS**.
|
||||
|
||||
**Search filters:** Part No or Description, and an **Include Proprietary Parts** toggle (on by default) that adds customer-specific parts to results.
|
||||
|
||||
Each result row shows: **Part No**, **Description**, **Sales Group**, **Product Family**, **UoM**, **Unit Cost**, **List Price**, **Customer Price**, **Net Price**.
|
||||
|
||||
Use **Export To Excel** to download the list. The catalog can contain 20,000+ parts.
|
||||
|
||||
---
|
||||
|
||||
## Part detail
|
||||
|
||||
### General Information
|
||||
|
||||
- **Part No** — part number
|
||||
- **Inventory Part** — whether the part is tracked in IFS inventory
|
||||
- **Proprietary Part** — whether this part is customer-specific
|
||||
- **Sales Group** — sales group classification
|
||||
- **Sales Price Group** — pricing group (e.g. Max Discount 30%)
|
||||
- **Active** — whether the part is available for use
|
||||
- **Estimated Install Time** — estimated installation time
|
||||
- **Description** — full part description
|
||||
- **Unit Cost** / **List Price** / **Unit Price** / **Net Price** — pricing at each level
|
||||
- **Currency** — pricing currency
|
||||
|
||||
Use **Sync with IFS** to refresh the part data from IFS.
|
||||
|
||||
### Sales Lead Times
|
||||
|
||||
- **Next Day** — available for next-day delivery
|
||||
- **Three Days** — available within 3 days
|
||||
- **Five Days** — available within 5 days
|
||||
- **To Be Scheduled** — requires scheduling
|
||||
@@ -0,0 +1,21 @@
|
||||
---
|
||||
sidebar_position: 9
|
||||
title: Service Records
|
||||
---
|
||||
|
||||
# Service Records
|
||||
|
||||
The Service Records module provides a cross-customer view of submitted service forms, filtered by form type. It is the reporting layer on top of Forms — the same data, presented for review and export rather than submission.
|
||||
|
||||
## List view
|
||||
|
||||
**Search filters:** Form\* (required — pre-selected on load), Customer, Territory, Region. Use **+ Service Form Question Filters** to filter by specific answers within the form.
|
||||
|
||||
The **Form** filter is required. Results only appear after selecting a form and clicking Search.
|
||||
|
||||
Each result row shows: **Service Date**, **Created By**, **Customer**, **Address**, **Functional Area**, **Customer Base**, **Transfer Point**.
|
||||
|
||||
### Actions
|
||||
|
||||
- **Service Summary** — generate a summary report for the selected records
|
||||
- **Full Service Report** — generate a full detailed report for the selected records
|
||||
@@ -0,0 +1,23 @@
|
||||
---
|
||||
sidebar_position: 13
|
||||
title: Time Report
|
||||
---
|
||||
|
||||
# Time Report
|
||||
|
||||
The Time Report module provides a weekly view of time entries logged against work tasks. It loads automatically for the current week without requiring a search.
|
||||
|
||||
## Filters
|
||||
|
||||
- **From Date / To Date** — date range for the entries shown. Use the **<** and **>** arrows to navigate week by week.
|
||||
- **Resource** — filter by technician or resource.
|
||||
- **Total Wage Hours** — total hours for the selected period (read-only).
|
||||
|
||||
## Entries
|
||||
|
||||
Each row shows: **Transaction Date**, **W. Task**, **Time Registration Type**, **Wage Code**, **Resource**, **Customer**, **Hours**, **Daily Total**.
|
||||
|
||||
## Actions
|
||||
|
||||
- **Import All In Range** — import all time entries from IFS for the selected date range
|
||||
- **Export To Excel** — download the visible entries as a spreadsheet
|
||||
@@ -0,0 +1,34 @@
|
||||
---
|
||||
sidebar_position: 6
|
||||
title: Visits
|
||||
---
|
||||
|
||||
# Visits
|
||||
|
||||
The Visits module tracks customer site visits and links them to the quotes, service records, and forms produced during each visit.
|
||||
|
||||
## List view
|
||||
|
||||
**Search filters:** Visit Id, Customer, Territory, Region, Tech Id.
|
||||
|
||||
Each result row shows: **Visit Id**, **Customer** (with IFS ID), **Date**, **Created By**, **Region**, **Territory**, **Tech**.
|
||||
|
||||
Use **Export To Excel** to download the list.
|
||||
|
||||
---
|
||||
|
||||
## Visit detail
|
||||
|
||||
The detail page groups all work produced during the visit into three sections.
|
||||
|
||||
### Quotes
|
||||
|
||||
Quotes created during this visit. Each row shows the quote number (links to the full quote), customer, address, name, status, amount, and who created it.
|
||||
|
||||
### Service Records
|
||||
|
||||
Service records submitted during this visit. Each row shows form title, name, asset, status, description, form type, and date submitted.
|
||||
|
||||
### Forms
|
||||
|
||||
Forms completed during this visit. Same columns as Service Records.
|
||||
@@ -0,0 +1,37 @@
|
||||
---
|
||||
sidebar_position: 12
|
||||
title: Work Tasks
|
||||
---
|
||||
|
||||
# Work Tasks
|
||||
|
||||
The Work Tasks module tracks field service work tasks linked to work orders and customer orders, synchronized with IFS.
|
||||
|
||||
## List view
|
||||
|
||||
Work Tasks has two tabs: **Work Tasks** and **Work Assignments**.
|
||||
|
||||
**Search filters:** Search Keyword (task number or description), Customer Order No, Work Task Status.
|
||||
|
||||
Each result row shows: **#** (task and work order numbers, links to detail), **Customer**, **Work Type**, **Description**, **Allocations** (total and unassigned), **Asset**, **W. Task Status**, **Assigned**.
|
||||
|
||||
Use **Import From IFS** to pull new work tasks from IFS.
|
||||
|
||||
---
|
||||
|
||||
## Work Task detail
|
||||
|
||||
- **Work Order No** — parent work order number in IFS
|
||||
- **Work Task No** — task number
|
||||
- **Customer Order No** — linked customer order, if any
|
||||
- **Work Task Status** — current status
|
||||
- **Customer** — customer this task is for
|
||||
- **Asset** — asset being serviced
|
||||
- **Work Type** — type of work
|
||||
- **Maintenance Priority** — priority level
|
||||
- **Address** / **City** / **State** / **Country** — site location
|
||||
- **Territory** / **Region** / **Tech Id** — assignment context
|
||||
- **Description** — task description
|
||||
- **Assignment Status** — toggle between Assigned / Unassigned
|
||||
|
||||
Use **Refresh From IFS** to pull the latest task data from IFS.
|
||||
Reference in new issue
Block a user