Glossary

term definition aaa (a3) aaa (a3) is the authentication & authorization service provided by os1 platform address an address is a set of human readable information used for identifying a place like a building, apartment, facility, warehouse, etc app/application a web/mobile software that allows an authenticated user to interact with business processes/services by performing actions on backend resources the app consists of app ui and/or app backend service authentication the process of confirming the identity of a user authorization the process of confirming the permissions granted to a user for taking action on app/os1 platform resources client clients are the business entities on the platform responsible for originating orders consignor the person sending a shipment to be delivered to a consignee container a container is a physical component with a unique id it is the smallest entity unit to represent a shipment core apis the core apis form the most basic set of libraries and apis that allow anyone to build business specific apps on top of them os1 services the services that are available as a part of the os1 platform (for example participant service, secure data service, container service, workflow service, dispatch service, etc ) custody custody is an implicit mechanism to keep a ledger of what inventory (physical objects) are in the custody of an operator for a given dispatch consignee a consignee is someone waiting somewhere for goods or services dimension height one of three main dimensions (the others being length and width) for an object height is measured from the base of an object to the top dimension length one of three main dimensions for a shipment (the others being width and height ) length is typically the longest dimension and is measured from one end of the shipment to the other dimension width the horizontal distance between the edges of a package or other packaging or object in contrast, height is the measure of the vertical distance from the bottom of the object to the top dispatch dispatch is a manifestation of the intent to move an operator/service provider from or to a location or multiple locations in order to perform a unit of action called to task or a set of tasks dispatcher an internal or external individual who can assign operators and vehicles to deliver a set of packages event an event is an individual action performed on the entity object either by a user, app, or system it is an immutable record of a fact that happened during the lifecycle of the entity object an event may or may not cause the system to change the state of the entity object event code an event code is a unique alphanumeric code given to an event each event code represents a unique event a particular event code can be associated with only one type of entity event sourcing the event sourcing component is an event based framework to ensure every change to the state of an application is captured in an event object, and that these event objects are themselves stored in the sequence they were applied for the same lifetime as the application state itself execution task an execution task is the smallest atomic task that is performed by an operator the execution task will have a binary outcome, i e , it can either succeed or fail note that an et can’t be canceled; only the et workflow or objective can be canceled expected path an expected path is a route for the movement of the participant/shipment for fulfilling an order field engineer (fe) the person performing a delivery generic dispatcher a dispatch represents movement and is the generic construct for representing the movement of resources the generic dispatcher is a set of instructions created in the form of tasks that will be fulfilled by an operator using the generic field app what makes it generic is that the dispatcher is purely instructions driven and is not tied to any leg of delivery (last mile, first mile, etc); nor does it have any particular understanding of the task job the sequence of workflows to be executed for completing a single leg of the expected path of an order (point to point) last mile delivery last mile delivery is the movement of goods from a transportation hub to their final delivery destination, whether a residential or commercial address less than truckload (ltl) a freight shipment that does not meet the specifications required for a full truckload (tl) shipment ltl shipments are typically aggregated with other movements to maximize trailer utilization location an address with corresponding geographical coordinates each service has one or more locations to be visited in order example pickup location/delivery location/return location objective one or more execution tasks to be performed as a workflow for a container or set of containers at a given location eg pick, drop, kyc, installation, etc operators onboards resources (users, vehicles, devices, facilities) and use them to complete a task order an order is a set of instructions from the originator to complete a task/set of tasks these tasks can be executed by one or more service providers as per the contract \n\na task can be physical or digital in nature if we are performing the moving of a shipment from a consignor to a consignee then it’s a physical task whereas, verifying an address is a digital task package the smallest unit is tracked in the lifecycle of a shipment has both a human and machine readable label and resolves to a know package id in the platform participant a participant is an organization or individual connected to the platform for the purpose of performing any activity on the platform and is governed by the platform rules permission permission represents a named action allowed on a resource policy a user attribute (designation, department, etc ) and/or environment (mobile, web, time, etc ) based rule that defines whether a role can be dynamically granted or denied to a user reason code there can be more than one reason which can trigger an event reason code is a unique alphanumeric code given to a reason that triggers an event it provides additional information/context about the event that has occurred resource a resource represents an entity and the possible actions on the entity through the rest api role a named set of permissions that can be granted to enable a user or app/service to perform a set of actions in an app shipment a shipment is a set of one or more containers to be moved from a consignor (originator of the order) to a consignee (terminal point of order) state the state defines the current status/behavior of an entity object an object entity undergoes various transitions of states as events are raised on them states are devoid of any data/information related to the events that were raised on the entity object at any given point in time, an entity object can be in only one state templatization templatization implements a concept where certain attributes take default predefined values based on a category and subcategory defined during participant type creation or updated on the participant type whenever a requirement for it arises tenant a tenant represents a group of users that have access to a specified set of resources it is a type of participant on the os1 platform that can create and govern custom usage of their platform instance for their participants by configuring workflows and business models user anyone who uses apps to take actions on platform entities user group a namespace for a set of users grouped together by a common attribute or purpose vehicle a vehicle is used to move individuals, goods/shipments, or tools from point a to b