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,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.
|
||||
Reference in new issue
Block a user