外观
lib-arcKit 库参考
原文: https://finproducts.atlassian.net/wiki/spaces/JIDD3/pages/34793554199/FIN+5.3.1+lib-arcKit 中文整理基于 FIN 5.3.1
导读： 标准文档工作流程
以下为 API 参考，保留英文以便对照源码；目录已列出（英文标题便于检索）；概述已尽量中译。
目录（导读）
概述（中译）
标准文档工作流程
API 正文（英文）
tags
| arcBreakdown | Mechanical failure |
| arcBug | Software defect causing improper behavior |
| arcDamage | Equipment has been physically damaged |
| arcElectrical | Task is electrical in nature |
| arcEnhancement | Software request to add new functionality |
| arcHvac | Task is HVAC in nature |
| arcInspection | Equipment requires inspection |
| arcMaintenance | Preventative or scheduled maintenance task |
| arcPlumbing | Task is plumbing in nature |
| arcSafety | Hazardous situation |
| arcSupport | Assistance required |
| arcWish | Wish list for future enhancement |
| note | Note is a simple document without workflow |
| ticket | Ticket tracks a software or help case |
| ticketState | Workflow state for a ticket |
| workorder | Workorder tracks maintenance case |
| workorderState | Workflow state for a workorder |
def
arcBreakdown
Mechanical failure
meta
| color | #ff8c00 |
| def | arcBreakdown |
| disKey | ui::breakdown |
| is | arcLabel |
| lib | lib:arcKit |
| tagOn | workorder |
supertypes
| marker | Marker labels a dict with typing information |
| arcLabel | Base type for arc document label tags |
def
arcBug
Software defect causing improper behavior
meta
| color | #ff8c00 |
| def | arcBug |
| disKey | ui::bug |
| is | arcLabel |
| lib | lib:arcKit |
| tagOn | ticket |
supertypes
| marker | Marker labels a dict with typing information |
| arcLabel | Base type for arc document label tags |
def
arcDamage
Equipment has been physically damaged
meta
| color | #e74c3c |
| def | arcDamage |
| disKey | ui::damage |
| is | arcLabel |
| lib | lib:arcKit |
| tagOn | workorder |
supertypes
| marker | Marker labels a dict with typing information |
| arcLabel | Base type for arc document label tags |
def
arcElectrical
Task is electrical in nature; electrician might be required
meta
| color | #c2b280 |
| def | arcElectrical |
| disKey | ui::electrical |
| is | arcLabel |
| lib | lib:arcKit |
| tagOn | workorder |
supertypes
| marker | Marker labels a dict with typing information |
| arcLabel | Base type for arc document label tags |
def
arcEnhancement
Software request to add new functionality
meta
| color | #2ecc71 |
| def | arcEnhancement |
| disKey | ui::enhancement |
| is | arcLabel |
| lib | lib:arcKit |
| tagOn | ticket |
supertypes
| marker | Marker labels a dict with typing information |
| arcLabel | Base type for arc document label tags |
def
arcHvac
Task is HVAC in nature
meta
| color | #9b59b6 |
| def | arcHvac |
| disKey | ui::hvac |
| is | arcLabel |
| lib | lib:arcKit |
| tagOn | workorder |
supertypes
| marker | Marker labels a dict with typing information |
| arcLabel | Base type for arc document label tags |
def
arcInspection
Equipment requires inspection
meta
| color | #2ecc71 |
| def | arcInspection |
| disKey | ui::inspection |
| is | arcLabel |
| lib | lib:arcKit |
| tagOn | workorder |
supertypes
| marker | Marker labels a dict with typing information |
| arcLabel | Base type for arc document label tags |
def
arcMaintenance
Preventative or scheduled maintenance task
meta
| color | #f1c40f |
| def | arcMaintenance |
| disKey | ui::maintenance |
| is | arcLabel |
| lib | lib:arcKit |
| tagOn | ticket, workorder |
supertypes
| marker | Marker labels a dict with typing information |
| arcLabel | Base type for arc document label tags |
def
arcPlumbing
Task is plumbing in nature; plumber might be required
meta
| color | #3498db |
| def | arcPlumbing |
| disKey | ui::plumbing |
| is | arcLabel |
| lib | lib:arcKit |
| tagOn | workorder |
supertypes
| marker | Marker labels a dict with typing information |
| arcLabel | Base type for arc document label tags |
def
arcSafety
Hazardous situation
meta
| color | #e74c3c |
| def | arcSafety |
| disKey | ui::safety |
| is | arcLabel |
| lib | lib:arcKit |
| tagOn | workorder |
supertypes
| marker | Marker labels a dict with typing information |
| arcLabel | Base type for arc document label tags |
def
arcSupport
Assistance required
meta
| color | #9b59b6 |
| def | arcSupport |
| disKey | ui::support |
| is | arcLabel |
| lib | lib:arcKit |
| tagOn | ticket, workorder |
supertypes
| marker | Marker labels a dict with typing information |
| arcLabel | Base type for arc document label tags |
def
arcWish
Wish list for future enhancement
meta
| color | #27ae60 |
| def | arcWish |
| disKey | ui::wish |
| is | arcLabel |
| lib | lib:arcKit |
| tagOn | ticket, workorder |
supertypes
| marker | Marker labels a dict with typing information |
| arcLabel | Base type for arc document label tags |
def
note
Note is a simple document without workflow
meta
| def | note |
| disKey | ui::note |
| icon | note |
| is | arc |
| lib | lib:arcKit |
usage
| note arc |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| arc | Arc document |
tags
| arcOn | Subject of the document |
| arcType | Document type which determines workflow |
| by | Author of a document or part |
| created | The timestamp when entity was created |
| dis | Display name for an entity |
| id | Defines the unique identifier of an entity in system using a ref value type |
| viewLink | View name and state for linking to a saved view |
def
ticket
Ticket tracks a software or help case
meta
| def | ticket |
| disKey | ui::ticket |
| icon | debug |
| is | arc |
| lib | lib:arcKit |
usage
| ticket arc |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| arc | Arc document |
tags
| arcBug | Software defect causing improper behavior |
| arcEnhancement | Software request to add new functionality |
| arcMaintenance | Preventative or scheduled maintenance task |
| arcOn | Subject of the document |
| arcPriority | Priority level of the document |
| arcSupport | Assistance required |
| arcType | Document type which determines workflow |
| arcWish | Wish list for future enhancement |
| assignedTo | Person who is currently responsible for the workflow task |
| by | Author of a document or part |
| created | The timestamp when entity was created |
| dis | Display name for an entity |
| dueDate | Date expected for completion of the workflow task |
| id | Defines the unique identifier of an entity in system using a ref value type |
| ticketState | Workflow state for a ticket |
| viewLink | View name and state for linking to a saved view |
def
ticketState
Workflow state for a ticket
meta
| arcTransitions | {new:{from:start, to:new}, open:{from:start, new, pending, to:open, admin}, pend:{from:new, open, to:pending, admin}, resolve:{from:new, pending, open, to:resolved, admin}, cancel:{from:new, pending, open, to:cancelled, admin}, reopen:{from:resolved, cancelled, to:open, admin}} |
| def | ticketState |
| enum | See below |
| is | arcState |
| lib | lib:arcKit |
| tagOn | ticket |
enum
| new | New unassigned ticket |
| open | In progress |
| pending | Waiting on additional input |
| resolved | Completed |
| cancelled | No resolution required |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| str | Unicode string of characters |
| arcState | Defines work flow state of an arc document |
def
workorder
Workorder tracks maintenance case
meta
| def | workorder |
| disKey | ui::workorder |
| icon | wrench |
| is | arc |
| lib | lib:arcKit |
usage
| workorder arc |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
| arc | Arc document |
tags
| arcBreakdown | Mechanical failure |
| arcDamage | Equipment has been physically damaged |
| arcElectrical | Task is electrical in nature |
| arcHvac | Task is HVAC in nature |
| arcInspection | Equipment requires inspection |
| arcMaintenance | Preventative or scheduled maintenance task |
| arcOn | Subject of the document |
| arcPlumbing | Task is plumbing in nature |
| arcPriority | Priority level of the document |
| arcSafety | Hazardous situation |
| arcSupport | Assistance required |
| arcType | Document type which determines workflow |
| arcWish | Wish list for future enhancement |
| assignedTo | Person who is currently responsible for the workflow task |
| by | Author of a document or part |
| created | The timestamp when entity was created |
| dis | Display name for an entity |
| dueDate | Date expected for completion of the workflow task |
| id | Defines the unique identifier of an entity in system using a ref value type |
| viewLink | View name and state for linking to a saved view |
| workorderState | Workflow state for a workorder |
def
workorderState
Workflow state for a workorder
meta
| arcTransitions | {new:{from:start, to:new}, open:{from:new, to:open, admin}, resolve:{from:new, open, to:resolved, admin}, cancel:{from:open, to:cancelled, admin}, reopen:{from:resolved, cancelled, to:open, admin}} |
| def | workorderState |
| enum | See below |
| is | arcState |
| lib | lib:arcKit |
| tagOn | workorder |
enum
| new | New unassigned workorder |
| open | In progress |
| resolved | Completed |
| cancelled | No resolution required |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| str | Unicode string of characters |
| arcState | Defines work flow state of an arc document |