- Group hub-documentation into explanation/, how-to/, and reference/ per Diátaxis - Move ifs-integration.md to new hoist-hub/ category - Add contributing/ category with Diátaxis framework explainer - Move tutorial-basics and tutorial-extras under docusaurus-guide/ - Rewrite docs/intro.mdx as site entry point with category navigation - Update all doc titles to reflect their Diátaxis type - Add HOIST logo to homepage hero and fix Get Started link
130 lines
4.6 KiB
Markdown
130 lines
4.6 KiB
Markdown
---
|
||
sidebar_position: 3
|
||
title: Technical Design Definition
|
||
---
|
||
|
||
# Technical Design Definition
|
||
|
||
This section is owned by the developer and should be updated with the solution as it was developed. The Hoist Business Analyst will be consulted as needed.
|
||
|
||
:::warning[Mandatory]
|
||
This section is **mandatory** for all desired HUB Specs. All unused sections must be deleted.
|
||
:::
|
||
|
||
---
|
||
|
||
## HUB Tables / Columns Mapping to IFS
|
||
|
||
List of HUB fields and their mapping into IFS fields:
|
||
|
||
| HUB Screen / Tab | HUB Label | HUB Table / Field Name | IFS Screen / Tab | IFS Label | IFS View / Field Name |
|
||
|------------------|-----------|------------------------|------------------|-----------|----------------------|
|
||
| Quote / Header | Quotation No | Quote / Quote_No | Sales Quotation / Header | Quotation No | Order_Quotation / Quotation_no |
|
||
|
||
---
|
||
|
||
## HUB to IFS API Calls
|
||
|
||
List of HUB Events that call IFS APIs:
|
||
|
||
| HUB Screen / Tab | HUB Button / Event | IFS API | Purpose |
|
||
|------------------|-------------------|---------|---------|
|
||
| Quote / Header | Save Button | Create_Quotation | To send the Quotation entered on HUB into IFS. API will return the Quotation No for saving on HUB |
|
||
|
||
---
|
||
|
||
## Report Layout
|
||
|
||
This section applies to both IFS Report Designer and Crystal Reports. IFS encourages customers to do their own layout modifications (as long as they're using Report Designer layouts).
|
||
|
||
Include an illustration or picture of the existing report or a data drawing of how it should look. Since a report can have multiple layouts, create a subsection within this section for each layout to be modified.
|
||
|
||
### `[REPORT_ID]` – `[REPORT_TITLE]`
|
||
|
||
#### Layout
|
||
|
||
`[layout_file_name.rdl]`
|
||
|
||
#### Description of Report Layout Properties
|
||
|
||
Document the following aspects where an exact match is required (e.g., for legal purposes, automatic processing):
|
||
|
||
- Paper size and orientation
|
||
- Font (type, size, bold/italic/underline, etc.)
|
||
- Position (e.g., 2cm from left margin, directly below line x)
|
||
- Text alignment (left, right, centered, top, bottom)
|
||
- Text wrapping or truncating
|
||
- Date format
|
||
- Number format (thousands and decimal separator, decimal places)
|
||
- Conditional displaying
|
||
- Graphics (e.g., company logo)
|
||
- Calculations/formulas
|
||
- Headers and footers
|
||
- Page breaks
|
||
- Special considerations for First Page, Repeat Section, and Last Page
|
||
- Barcodes
|
||
|
||
#### Mockup of the Report Layout
|
||
|
||
Include a screenshot of a mockup of the intended report layout.
|
||
|
||
---
|
||
|
||
## Scheduled Task
|
||
|
||
### Purpose
|
||
|
||
Describe the purpose/need of the Scheduled Task.
|
||
|
||
### Description
|
||
|
||
Describe the Scheduled Task.
|
||
|
||
### Scheduled Task Setup
|
||
|
||
| Schedule name | Task Name | Schedule | Advanced |
|
||
|---------------|-----------|----------|----------|
|
||
| | Select from LOV | Daily / Weekly / Monthly / Scheduled / Interval / Custom + Time | e.g., language code or start and end date |
|
||
|
||
### Parameters
|
||
|
||
Define any special parameters to be used by the scheduled task.
|
||
|
||
---
|
||
|
||
## Workflow
|
||
|
||
### Workflow Purpose
|
||
|
||
Describe the background/purpose for the Workflow.
|
||
|
||
### Workflow Description
|
||
|
||
Describe the objective(s) of the Workflow. Is it principally about Process Enrichment, User Interaction, or Data Validation?
|
||
|
||
### Workflow Key
|
||
|
||
Format should be CamelCase (e.g., `WorkTaskZoneCharge`).
|
||
|
||
### Workflow Description / Outcomes
|
||
|
||
Describe in non-technical terms what the Workflow should do. This can be a bulleted list or a flow chart if requirements are complex.
|
||
|
||
**Example:**
|
||
> When a Service Work Task is Released, the workflow should:
|
||
> - IF Site = 999 → do nothing
|
||
> - ELSE → look up the service object on the task, then look up the service location for that object, then fetch the Location Type from the Scheduling tab on the Location; this location type ID will match a Non-Inventory Sales Part number; the workflow will add a Work Task Sales Line based on this Sales Part number with quantity 1; standard pricing rules apply to the sales line.
|
||
|
||
### Workflow Activation
|
||
|
||
Describe under what situations the Workflow should be triggered. Also indicate scenarios under which it should **not** be triggered.
|
||
|
||
**Projection Reactions vs. Custom Events:**
|
||
|
||
- Use **Projection Reactions** when the workflow should be triggered by a change on a specific page but not on other pages for the same database table.
|
||
- Use **Custom Events** when the workflow should be triggered by database changes at a table level, regardless of which IFS Cloud Web page the user made the change on.
|
||
|
||
**Capturing different scenarios:**
|
||
|
||
Describe all scenarios that should lead to the workflow being triggered. Consider all creation paths: manual creation, adding to an existing request, from the Mobile Work Order app, from a Recurring Service Program (manually or by scheduled generation), etc.
|