Przejdź do treści

Standard modeli Kamsoft.FAIR

Wszystkie modele (zasoby) opisane w tym Implementation Guide należą do standardu Kamsoft.FAIR.

Co to jest Kamsoft.FAIR?

Kamsoft.FAIR to Fast Adaptive Interoperable Resources — zestaw zasobów kanonicznych zaprojektowanych pod:

  • Fast — szybką implementację i integrację (spójna struktura, Identifier, CodeableConcept, Reference).
  • Adaptive — łatwą adaptację do różnych obszarów (księgowość, magazyn, majątek, kadry) i rozszerzeń (profile, attribute).
  • Interoperable — interoperacyjność między systemami ERP, magazynowymi, kadrowymi i zewnętrznymi partnerami.

FAIR nie jest osobnym standardem zewnętrznym — to marka i standard modeli KAMSOFT dla API.ERP: jeden spójny sposób opisu Party, DocumentReference, Location, InventoryDocument, Employment, PostingInstruction i pozostałych zasobów we wszystkich obszarach.

Gdzie stosujemy modele FAIR?

Obszar Zasoby Kamsoft.FAIR
Księgowość Party (Contractor), PostingInstruction, JournalEntry, Payment, Register, AccountingVariant, CostCarrier, CostAssignment, FormulaComponent; BankAccount jako zasób zagnieżdżony w contained strony
Magazyn Party (Contractor), Location (Warehouse, StorageLocation), ProductDefinition, Inventory, InventoryDocument, InventoryDocumentPosition, ReturnDocument, PurchaseOrder, PurchaseRequisition, Invoice, DocumentReference (WarehouseDocument), Attachment
Majątek Party (AssetHolder), Location (UsagePlace), FixedAsset, AssetComponent, FixedAssetDocument, FixedAssetAllocation, CostCenter
Kadry Party (Employee, Employer), PartyRole, PartyRelationship, Employment, Position, OrganizationUnit, OrganizationAssignment, Qualification, ProfessionalGroup, EmployeeProfessionalGroup, Capability, GrantAssignment, DocumentReference (HrInboxDocument)
Wspólne DomainResource, Identifier, CodeableConcept, Reference, Attribute, ValueItem, ValueSet, CapabilityStatement, NamingSystem, Notification, ProductPricing

Opisy struktur, pól i użycia znajdują się w menu w sekcji Standard Kamsoft.FAIR (lista modeli oraz Przykłady). Pełna lista zasobów z trasami: Kontrakty API.

Zasady modeli FAIR

Co jest w API: zbiór zasobów i operacji wynika z rejestru zasobów API.ERP (Kontrakty API) i z karty wdrożenia GET /v1/metadata danej instalacji; API jest publikowane przez Portal dla Integratorów. Referencje w danych mogą wskazywać typy spoza IG i bez endpointów w tym API — zob. Reference — zakres API a wartości Reference.

  • Identyfikacja — przez Identifier (system, value); rozszerzalne type, use, period.
  • Klasyfikacja — przez CodeableConcept / Coding (status, typ dokumentu, jednostka itd.); systemy kodów w przestrzeni https://api-erp.kamsoft.pl/vs/.
  • Referencje — przez Reference; znaczenie logiczne zawsze przez identyfikator biznesowy (identifier); pole reference to opcjonalne uzupełnienie techniczne. Odczyt celu przez HTTP — tylko jeśli dany typ i operacja są w API dla integratorów.
  • Baza — zasoby domenowe rozszerzają DomainResource (id, meta, status, type, attribute itd.).

Konwencje techniczne API (REST, wersjonowanie, błędy) opisuje Konwencje techniczne.

Odniesienia