Skip to content

Class: Shift

_Generally referring to a period of operation or work performed. Whether the shift is open/closed can be derived from attributes 'activityInterval.start' and 'activityInterval.end'. _

_The grand total for receipts (i.e., cumulative total of all actual receipted amounts during this shift; bankable + non-bankable; excludes rounding error totals) can be derived from receipt: _

_=sum('Receipt.receiptAmount'); includes bankable and non-bankable receipts. _

_It also has to be reconciled against: _

_=sum('receiptsGrandTotalBankable' + 'receiptsGrandTotalNonBankable') _

_and against receipt summary: _

_=sum('ReceiptSummary.receiptsTotal'). _

The attributes with "GrandTotal" defined in this class may need to be used when the source data is periodically flushed from the system and then these cannot be derived.

URI: cim:Shift

 classDiagram
    class Shift
      IdentifiedObject <|-- Shift


      Shift <|-- CashierShift
      Shift <|-- VendorShift


      Shift : activity_interval

          Shift --> DateTimeInterval : activity_interval

      Shift : alias_name

      Shift : description

      Shift : diagram_objects

          Shift --> DiagramObject : diagram_objects

      Shift : instance_set

          Shift --> InstanceSet : instance_set

      Shift : m_rid

      Shift : names

          Shift --> Name : names

      Shift : properties_cimdata_object

          Shift --> ChangeSetMember : properties_cimdata_object

      Shift : receipts_grand_total_bankable

          Shift --> Money : receipts_grand_total_bankable

      Shift : receipts_grand_total_non_bankable

          Shift --> Money : receipts_grand_total_non_bankable

      Shift : receipts_grand_total_rounding

          Shift --> Money : receipts_grand_total_rounding

      Shift : targeting_cimdata_object

          Shift --> ChangeSetMember : targeting_cimdata_object

      Shift : transactions_grand_total

          Shift --> Money : transactions_grand_total

      Shift : transactions_grand_total_rounding

          Shift --> Money : transactions_grand_total_rounding

Inheritance

Slots

Name Cardinality and Range Description Inheritance
activity_interval 0..1
DateTimeInterval		 Interval for activity of this shift direct
receipts_grand_total_bankable 0..1
Money		 Total of amounts receipted during this shift that can be manually banked (cas... direct
receipts_grand_total_non_bankable 0..1
Money		 Total of amounts receipted during this shift that cannot be manually banked (... direct
receipts_grand_total_rounding 0..1
Money		 Cumulative amount in error due to process rounding not reflected in receiptsG... direct
transactions_grand_total 0..1
Money		 Cumulative total of transacted amounts during this shift direct
transactions_grand_total_rounding 0..1
Money		 Cumulative amount in error due to process rounding not reflected in transacti... direct
alias_name 0..1
String		 The aliasName is free text human readable name of the object alternative to I... IdentifiedObject
description 0..1
String		 The description is a free human readable text describing or naming the object IdentifiedObject
m_rid 0..1
String		 Master resource identifier issued by a model authority IdentifiedObject
diagram_objects 0..*
DiagramObject		 The diagram objects that are associated with the domain object IdentifiedObject
instance_set 1..1
InstanceSet		 Dataset containing the data objects IdentifiedObject
names 0..*
Name		 All names of this identified object IdentifiedObject
properties_cimdata_object 0..1
ChangeSetMember		 The single CIM data object in the appropriate dataset context IdentifiedObject
targeting_cimdata_object 0..*
ChangeSetMember		 Data objects registered IdentifiedObject

Identifier and Mapping Information

Schema Source

  • from schema: https://cim.ucaiug.io/ns#TC57CIM

Mappings

Mapping Type Mapped Value
self cim:Shift
native cim:Shift

LinkML Source

Direct

name: Shift
description: "Generally referring to a period of operation or work performed. Whether\
  \ the shift is open/closed can be derived from attributes 'activityInterval.start'\
  \ and 'activityInterval.end'.\r\nThe grand total for receipts (i.e., cumulative\
  \ total of all actual receipted amounts during this shift; bankable + non-bankable;\
  \ excludes rounding error totals) can be derived from receipt:\r\n=sum('Receipt.receiptAmount');\
  \ includes bankable and non-bankable receipts.\r\nIt also has to be reconciled against:\r\
  \n=sum('receiptsGrandTotalBankable' + 'receiptsGrandTotalNonBankable')\r\nand against\
  \ receipt summary:\r\n=sum('ReceiptSummary.receiptsTotal').\r\nThe attributes with\
  \ \"GrandTotal\" defined in this class may need to be used when the source data\
  \ is periodically flushed from the system and then these cannot be derived."
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: IdentifiedObject
attributes:
  activity_interval:
    name: activity_interval
    description: Interval for activity of this shift.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Shift.activityInterval
    multivalued: false
    domain_of:
    - Shift
    range: DateTimeInterval
    required: false
  receipts_grand_total_bankable:
    name: receipts_grand_total_bankable
    description: "Total of amounts receipted during this shift that can be manually\
      \ banked (cash and cheques for example). Values are obtained from Receipt attributes:\r\
      \n=sum(Receipt.receiptAmount) for all Receipt.bankable = true."
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Shift.receiptsGrandTotalBankable
    multivalued: false
    domain_of:
    - Shift
    range: Money
    required: false
  receipts_grand_total_non_bankable:
    name: receipts_grand_total_non_bankable
    description: "Total of amounts receipted during this shift that cannot be manually\
      \ banked (card payments for example). Values are obtained from Receipt attributes:\r\
      \n=sum(Receipt.receiptAmount) for all Receipt.bankable = false."
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Shift.receiptsGrandTotalNonBankable
    multivalued: false
    domain_of:
    - Shift
    range: Money
    required: false
  receipts_grand_total_rounding:
    name: receipts_grand_total_rounding
    description: "Cumulative amount in error due to process rounding not reflected\
      \ in receiptsGrandTotal. Values are obtained from Receipt attributes:\r\n=sum(Receipt.receiptRounding)."
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Shift.receiptsGrandTotalRounding
    multivalued: false
    domain_of:
    - Shift
    range: Money
    required: false
  transactions_grand_total:
    name: transactions_grand_total
    description: "Cumulative total of transacted amounts during this shift. Values\
      \ are obtained from transaction:\r\n=sum('Transaction.transactionAmount'). It\
      \ also has to be reconciled against transaction summary:\r\n=sum('TransactionSummary.transactionsTotal')."
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Shift.transactionsGrandTotal
    multivalued: false
    domain_of:
    - Shift
    range: Money
    required: false
  transactions_grand_total_rounding:
    name: transactions_grand_total_rounding
    description: "Cumulative amount in error due to process rounding not reflected\
      \ in transactionsGandTotal. Values are obtained from Transaction attributes:\r\
      \n=sum(Transaction.transactionRounding)."
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Shift.transactionsGrandTotalRounding
    multivalued: false
    domain_of:
    - Shift
    range: Money
    required: false
class_uri: cim:Shift

Induced

name: Shift
description: "Generally referring to a period of operation or work performed. Whether\
  \ the shift is open/closed can be derived from attributes 'activityInterval.start'\
  \ and 'activityInterval.end'.\r\nThe grand total for receipts (i.e., cumulative\
  \ total of all actual receipted amounts during this shift; bankable + non-bankable;\
  \ excludes rounding error totals) can be derived from receipt:\r\n=sum('Receipt.receiptAmount');\
  \ includes bankable and non-bankable receipts.\r\nIt also has to be reconciled against:\r\
  \n=sum('receiptsGrandTotalBankable' + 'receiptsGrandTotalNonBankable')\r\nand against\
  \ receipt summary:\r\n=sum('ReceiptSummary.receiptsTotal').\r\nThe attributes with\
  \ \"GrandTotal\" defined in this class may need to be used when the source data\
  \ is periodically flushed from the system and then these cannot be derived."
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: IdentifiedObject
attributes:
  activity_interval:
    name: activity_interval
    description: Interval for activity of this shift.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Shift.activityInterval
    multivalued: false
    alias: activity_interval
    owner: Shift
    domain_of:
    - Shift
    range: DateTimeInterval
    required: false
  receipts_grand_total_bankable:
    name: receipts_grand_total_bankable
    description: "Total of amounts receipted during this shift that can be manually\
      \ banked (cash and cheques for example). Values are obtained from Receipt attributes:\r\
      \n=sum(Receipt.receiptAmount) for all Receipt.bankable = true."
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Shift.receiptsGrandTotalBankable
    multivalued: false
    alias: receipts_grand_total_bankable
    owner: Shift
    domain_of:
    - Shift
    range: Money
    required: false
  receipts_grand_total_non_bankable:
    name: receipts_grand_total_non_bankable
    description: "Total of amounts receipted during this shift that cannot be manually\
      \ banked (card payments for example). Values are obtained from Receipt attributes:\r\
      \n=sum(Receipt.receiptAmount) for all Receipt.bankable = false."
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Shift.receiptsGrandTotalNonBankable
    multivalued: false
    alias: receipts_grand_total_non_bankable
    owner: Shift
    domain_of:
    - Shift
    range: Money
    required: false
  receipts_grand_total_rounding:
    name: receipts_grand_total_rounding
    description: "Cumulative amount in error due to process rounding not reflected\
      \ in receiptsGrandTotal. Values are obtained from Receipt attributes:\r\n=sum(Receipt.receiptRounding)."
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Shift.receiptsGrandTotalRounding
    multivalued: false
    alias: receipts_grand_total_rounding
    owner: Shift
    domain_of:
    - Shift
    range: Money
    required: false
  transactions_grand_total:
    name: transactions_grand_total
    description: "Cumulative total of transacted amounts during this shift. Values\
      \ are obtained from transaction:\r\n=sum('Transaction.transactionAmount'). It\
      \ also has to be reconciled against transaction summary:\r\n=sum('TransactionSummary.transactionsTotal')."
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Shift.transactionsGrandTotal
    multivalued: false
    alias: transactions_grand_total
    owner: Shift
    domain_of:
    - Shift
    range: Money
    required: false
  transactions_grand_total_rounding:
    name: transactions_grand_total_rounding
    description: "Cumulative amount in error due to process rounding not reflected\
      \ in transactionsGandTotal. Values are obtained from Transaction attributes:\r\
      \n=sum(Transaction.transactionRounding)."
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Shift.transactionsGrandTotalRounding
    multivalued: false
    alias: transactions_grand_total_rounding
    owner: Shift
    domain_of:
    - Shift
    range: Money
    required: false
  alias_name:
    name: alias_name
    description: "The aliasName is free text human readable name of the object alternative\
      \ to IdentifiedObject.name. It may be non unique and may not correlate to a\
      \ naming hierarchy.\r\nThe attribute aliasName is retained because of backwards\
      \ compatibility between CIM relases. It is however recommended to replace aliasName\
      \ with the Name class as aliasName is planned for retirement at a future time.\r\
      \n\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:IdentifiedObject.aliasName
    multivalued: false
    alias: alias_name
    owner: Shift
    domain_of:
    - IdentifiedObject
    range: string
    required: false
  description:
    name: description
    description: The description is a free human readable text describing or naming
      the object. It may be non unique and may not correlate to a naming hierarchy.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:IdentifiedObject.description
    multivalued: false
    alias: description
    owner: Shift
    domain_of:
    - IdentifiedObject
    - NameType
    - NameTypeAuthority
    - DataSet
    - SwitchingStepGroup
    - AreaReserveSpec
    range: string
    required: false
  m_rid:
    name: m_rid
    description: "Master resource identifier issued by a model authority. The mRID\
      \ is unique within an exchange context. Global uniqueness is easily achieved\
      \ by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is\
      \ strongly recommended.\r\nFor CIMXML data files in RDF syntax conforming to\
      \ IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify\
      \ CIM object elements."
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:IdentifiedObject.mRID
    multivalued: false
    alias: m_rid
    owner: Shift
    domain_of:
    - IdentifiedObject
    - DataSet
    range: string
    required: false
  diagram_objects:
    name: diagram_objects
    description: The diagram objects that are associated with the domain object.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:IdentifiedObject.DiagramObjects
    multivalued: true
    alias: diagram_objects
    owner: Shift
    domain_of:
    - IdentifiedObject
    range: DiagramObject
    required: false
  instance_set:
    name: instance_set
    description: Dataset containing the data objects.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:IdentifiedObject.InstanceSet
    multivalued: false
    alias: instance_set
    owner: Shift
    domain_of:
    - IdentifiedObject
    range: InstanceSet
    required: true
  names:
    name: names
    description: All names of this identified object.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:IdentifiedObject.Names
    multivalued: true
    alias: names
    owner: Shift
    domain_of:
    - IdentifiedObject
    - NameType
    range: Name
    required: false
  properties_cimdata_object:
    name: properties_cimdata_object
    description: The single CIM data object in the appropriate dataset context.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:IdentifiedObject.PropertiesCIMDataObject
    multivalued: false
    alias: properties_cimdata_object
    owner: Shift
    domain_of:
    - IdentifiedObject
    range: ChangeSetMember
    required: false
  targeting_cimdata_object:
    name: targeting_cimdata_object
    description: Data objects registered.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:IdentifiedObject.TargetingCIMDataObject
    multivalued: true
    alias: targeting_cimdata_object
    owner: Shift
    domain_of:
    - IdentifiedObject
    range: ChangeSetMember
    required: false
class_uri: cim:Shift