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,332 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
title: DataSET Details
|
||||
---
|
||||
|
||||
# DataSET Details
|
||||
|
||||
The following data sets will be exposed through the DataHUB APIs. Each data set includes its primary identifiers, key business attributes, and relationships to other HUB entities.
|
||||
|
||||
## Quote
|
||||
|
||||
```
|
||||
Quote
|
||||
├── Quotation No (PK)
|
||||
├── Customer ID (FK → Customer)
|
||||
├── Customer Contact
|
||||
├── Address ID (FK → Customer Address)
|
||||
├── Responsible Person
|
||||
├── Quote Type
|
||||
├── Quotation Name
|
||||
├── Pricing Validity
|
||||
├── Wanted Delivery Date
|
||||
├── Coordinator
|
||||
├── Formal Proposal Required
|
||||
├── Territory
|
||||
├── Tech Id
|
||||
├── Service Contract
|
||||
├── Created By
|
||||
├── Source (MobileHUB, HUB)
|
||||
└── Customer Agreement
|
||||
```
|
||||
|
||||
```
|
||||
Quote
|
||||
├── Quote Line
|
||||
├── Quote Charge
|
||||
├── Labor Worksheet
|
||||
├── Additional Information
|
||||
└── Quotation Detail
|
||||
```
|
||||
|
||||
### Quote → Line
|
||||
|
||||
```
|
||||
Quote Line
|
||||
├── Id (PK)
|
||||
├── Quotation No (FK → Quote)
|
||||
├── Line No
|
||||
├── Adjusted Estimated Installation Time (H)
|
||||
├── Estimated Installation Time (H)
|
||||
├── Part Number (FK → Sales Part)
|
||||
├── Quantity
|
||||
├── Status
|
||||
├── Weight
|
||||
├── Optional
|
||||
├── List Price
|
||||
├── Customer Price
|
||||
├── Discount %
|
||||
├── Discount Value
|
||||
└── Total Price
|
||||
```
|
||||
|
||||
### Quote → Charge
|
||||
|
||||
```
|
||||
Quote Charge
|
||||
├── Id (PK)
|
||||
├── Quotation No (FK → Quote)
|
||||
├── Charge No
|
||||
├── Charge Type
|
||||
├── Charge Group
|
||||
├── Charge %
|
||||
├── Charge % Basis
|
||||
├── Qty
|
||||
├── UoM
|
||||
├── Tax Liability
|
||||
└── Charge Amt
|
||||
```
|
||||
|
||||
### Quote → Labor Worksheet
|
||||
|
||||
```
|
||||
Labor Worksheet
|
||||
├── Id (PK)
|
||||
├── Quotation No (FK → Quote)
|
||||
├── Installation Type
|
||||
├── Labor Total
|
||||
├── Equipment Ratio
|
||||
├── Travel Total
|
||||
├── Site Required Days
|
||||
├── Site Specified Days
|
||||
├── Site Required Hours per Day
|
||||
├── Firewatch
|
||||
├── Total Install Hours
|
||||
└── Total Adjusted Hours
|
||||
```
|
||||
|
||||
### Quote → Additional Information
|
||||
|
||||
```
|
||||
Additional Information
|
||||
├── Id (PK)
|
||||
├── Quotation No (FK → Quote)
|
||||
├── Proposal Type
|
||||
├── Type of Upgrade
|
||||
├── Current Problem
|
||||
├── Installation Type
|
||||
├── Available Hours per Day
|
||||
├── Install Difficulty Factor
|
||||
├── Install Notes
|
||||
└── Describe the Scope of Work Requested
|
||||
```
|
||||
|
||||
### Quote → Quotation Detail
|
||||
|
||||
```
|
||||
Quotation Detail
|
||||
├── Id (PK)
|
||||
├── Quotation No (FK → Quote)
|
||||
├── Customer Agreement
|
||||
├── Customer Price Group
|
||||
├── Alternative Quote
|
||||
├── Credit Blocked
|
||||
├── Probability
|
||||
├── Channel
|
||||
├── Created On
|
||||
├── Closed Date
|
||||
├── Market
|
||||
├── Sales Material
|
||||
├── Internal Comments
|
||||
├── Customer Comments
|
||||
└── Additional Information
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Visit
|
||||
|
||||
```
|
||||
Visit
|
||||
├── Visit Id (PK)
|
||||
├── Customer No (FK → Customer)
|
||||
├── Customer Address No (FK → Customer Address)
|
||||
├── Date
|
||||
└── Created By
|
||||
```
|
||||
|
||||
```
|
||||
Visit
|
||||
├── Visit Quote
|
||||
├── Visit Service Record
|
||||
├── Visit Form
|
||||
└── Visit Work Task
|
||||
```
|
||||
|
||||
### Visit → Quote
|
||||
|
||||
```
|
||||
Visit Quote
|
||||
├── Id (PK)
|
||||
├── Visit Id (FK → Visit)
|
||||
├── Quote No (FK → Quote)
|
||||
├── Quote Name
|
||||
├── Quote Status
|
||||
├── Amount
|
||||
├── Created By
|
||||
├── Connected Object No (FK → FunObject)
|
||||
└── Connected Object Type
|
||||
```
|
||||
|
||||
### Visit → Service Record
|
||||
|
||||
```
|
||||
Visit Service Record
|
||||
├── Id (PK)
|
||||
├── Visit Id (FK → Visit)
|
||||
├── Object Id (FK → FunObject)
|
||||
├── Object Name
|
||||
├── Status
|
||||
├── Form Name
|
||||
├── Form Id (FK → Form Builder)
|
||||
├── Submission Id (FK → Form)
|
||||
└── Date Submitted
|
||||
```
|
||||
|
||||
### Visit → Form
|
||||
|
||||
```
|
||||
Visit Form
|
||||
├── Id (PK)
|
||||
├── Visit Id (FK → Visit)
|
||||
├── Form Name
|
||||
├── Form Id (FK → Form Builder)
|
||||
├── Submission Id (FK → Form)
|
||||
├── Connected Object Id (FK → FunObject)
|
||||
├── Connected Object Type
|
||||
└── Status
|
||||
```
|
||||
|
||||
### Visit → Work Task
|
||||
|
||||
```
|
||||
Visit Work Task
|
||||
├── Id (PK)
|
||||
├── Visit Id (FK → Visit)
|
||||
├── Task No (FK → Work Task)
|
||||
├── Work Type
|
||||
├── Status
|
||||
├── Date Submitted
|
||||
└── Created Date
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Service Record
|
||||
|
||||
```
|
||||
Service Record
|
||||
├── Record Id (PK)
|
||||
├── Object Id (FK → FunObject)
|
||||
├── Object Level
|
||||
├── Object Type
|
||||
├── Form Id (FK → Form Builder)
|
||||
├── Form Name
|
||||
├── Service Date
|
||||
├── Customer Id (FK → Customer)
|
||||
├── Customer Name
|
||||
├── Address Id (FK → Customer Address)
|
||||
├── Address Name
|
||||
└── Parent Object Id (FK → FunObject)
|
||||
```
|
||||
|
||||
**Questions**
|
||||
|
||||
```json
|
||||
[
|
||||
{
|
||||
"Question Key": "",
|
||||
"Question Label": "",
|
||||
"Type": "",
|
||||
"Answer": ""
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Form
|
||||
|
||||
```
|
||||
Form
|
||||
├── Submission Id (PK)
|
||||
├── Form Name
|
||||
├── Customer Id (FK → Customer)
|
||||
├── Customer Name
|
||||
├── Form Type
|
||||
├── Created By
|
||||
├── Date Submitted
|
||||
└── Visit
|
||||
```
|
||||
|
||||
**Questions**
|
||||
|
||||
```json
|
||||
[
|
||||
{
|
||||
"Question Key": "",
|
||||
"Question Label": "",
|
||||
"Type": "",
|
||||
"Answer": ""
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Time Report
|
||||
|
||||
```
|
||||
Time Report
|
||||
├── Transaction Id (PK)
|
||||
├── Transaction Date
|
||||
├── Created By
|
||||
├── Time Registration Type
|
||||
├── Work Task Id (FK → Work Task)
|
||||
├── Resource Id (FK → Resource)
|
||||
├── Resource Name
|
||||
├── Customer Id (FK → Customer)
|
||||
├── Customer Name
|
||||
├── Address Id (FK → Customer Address)
|
||||
├── Address Name
|
||||
├── Hours
|
||||
├── Daily Total
|
||||
├── MSHA
|
||||
├── Update Needed
|
||||
└── Status
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Form Builder (Form Definition and Question Definitions)
|
||||
|
||||
```
|
||||
Form Builder
|
||||
├── Form Id (PK)
|
||||
├── Form Name
|
||||
├── Service Report
|
||||
├── Created Date
|
||||
├── Last Update Date
|
||||
├── Version
|
||||
├── Active
|
||||
└── Connect to Visit
|
||||
```
|
||||
|
||||
**Sections**
|
||||
|
||||
```json
|
||||
[
|
||||
{
|
||||
"Section Name": "",
|
||||
"Repeatable": "",
|
||||
"Questions": [
|
||||
{
|
||||
"Question Key": "",
|
||||
"Question Label": "",
|
||||
"Type": "",
|
||||
"Answer": ""
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
```
|
||||
Reference in new issue
Block a user