Package com.onenetwork.platform.common

Contains models which are common to nearly all Platform applications, including User, Role and others.

For information on reading and writing these models, see ModelDataService. See also the com.onenetwork.platform.common.mpt package for a list of available actions for writing these models.

Interface Summary

Interface	Description
InteractiveStepHandler	Base class for InteractiveSimulation
ValidationRulePart	Interface capturing the commonality between ValidationRuleThen and ValidationRuleThen.

Class Summary

Class	Description
Achievement	Captures an individual user's progress toward a specific Achievement on a specific day, week or month.
AchievementConfig	Configurations to establish rules for achievements within the organization.
AchievementConfigUser	Java class for AchievementConfigUser complex type.
AchievementEvent	Captures a single event of progress toward an Achievement.
AckAwaitConfig	An AckAwaitConfig represents wait on queue/interface/version pair with the final destination and total time out duration.
AckAwaitConfigs	An AckAwaitConfigs represents the await relationship between the waiting queue/interface/version pair and the list of wait on queue/interface/version pairs.
AckRequest	An AckRequest(Acknowledgment Request) represents a message that waits Acknowledgment from receiving Platform Instance(AckRequestedFrom) confirming delivery to the Final Platform Instance(FinalDestination)
AckResponse	An AckResponse represents a Message with it's Final Platform Instance(FinalDestination) and Acknowledgment requester(AckSendTo).
AddressImpl	Stub for AddressImpl to compile platform-api code.
Alert	An Alert is persisted when an Issue is flagged by an Issue Computation in studio, and a user has an IssueSubscription which requests "System" delivery.
AlertDigestDeliverySchedule	Captures the schedule for which the system can send out digests of alert emails (instead of individual emails).
AnonymizerOverride	This model is used override the choice of anonymization strategy for a particular field in a particular model.
AsyncAction	Tracks the status of a user-initiated asynchrounous action execution through UI
Attachment	Represents a document attached to a Model, for example a Word or Excel document.
Attribute	A very generic model to hold the name and value pair for any model in the entire system.
AttributeValue	The value of a field which may be one of several data types.
BaseTemplate	Ties together a ModelLevelType and JS class.
BlockRelationship	Model captures the information about an organization which is blocking other organizations from sending partner invitations.
Buffer	Java class for Buffer complex type.
BufferLane	A buffer lane represents a transportation lane along which a particular item is transported from one site to another.
ChainEngineCondition	Stores various conditions which needs to be checked before starting execution of scheduled ChainEngine.
ChainEngineConditionLine	Represents a pre-condition for a scheduled ChainEngine.
ChainEngineConfig	Specifies order of engine runs for engine chaining.
ChainEngineConfigLine	Specifies order of engine runs for engine chaining.
ChainEngineRun	This model provides mapping between the ChainEngineConfig and GridJob models.
ClobProperty	A very generic model to hold the name and CLOB value pair for any model in the entire system.
Collaboration	Used to coordinate the execution of tasks across organizations.
CollaborationLine	Java class for CollaborationLine complex type.
ContactInformation	Java class for ContactInformation complex type.
CrossReference	This model represents an external system and field, and it is intended to be used in conjunction with CrossReferenceValue to maintain a set of value mappings between the external system/field and the internal ONE representation.
CrossReferenceValue	This model represents a mapping between an external system's value and the internal ONE value for a specific CrossReference instance.
CurrencyConversionFactor	This model is used when the API of a CurrencyConverter is "Data".
CurrencyConverter	This model is used to define a converter for an Org - it identifies the underlying API (data-driven, external web service driven, etc.).
CustomEmailTemplate	Captures the custom email templates for an Organization to be used by the Alerts email
DocTypePerm	A set of rules governing the ability of a user to read/write a doc type based on their role type and how their role's orgs align with the parent transaction's orgs.
DocumentType	Represents a type of document which is associated to a "parent" transaction (like a Shipment or Order), and is either generated on-demand, or uploaded and attached by a user's action or a server process.
DurationValue	This will be used to provide the duration value for an attribute.
DynaFieldComp	Child model of DynaFieldDef which persists components in the DynaField.
DynaFieldDef	Data model for dynamic field componets.
DynKPIFamilyDef	A DynamicKPIFamilyDef is similar to a KPIFamilyDef, in that it can be referenced by a KPIDef and used to generate KPI.
EdiConfig	EDI configuration details like identifiers and delimiters for a partner
EdiForward	Used to forward a copy of an EDI message to a given queue, any time it matches specific criteria (like sender/receiver).
EdiInboundRoute	Defines which EDI mapper to pick for Incoming EDI transactions based on the Transaction Set and Sender and Receiver GS IDs.
EdiMessageQueue	Captures information for all inbound and outbound EDI Messages (as well as SAP IDocs) received or sent by the Platform.
EdiMessageTransform	Can be used to transform/massage an inbound or outbound Message (EDI messages only) prior to processing
EdiMonitorPartnerOverride	Overrides EdiMonitorSettings with custom rules per partner pair.
EdiMonitorSettings	Defines rules for validating that EDI messages have been properly processed/acknowledged/etc.
EdiMQTransRef	Captures multiple transaction reference numbers (shipment numbers, order numbers) associated with a single EdiMessageQueue record.
EdiOutboundRoute	Defines which EDI mapper to pick for Outgoing EDI transactions based on the Transaction Set and From and To Organizations.
EINTypeAvailability	This model will be used to add/udpate EIN Type for countries.
Enterprise	Entire business group comprising of all local and international main and sub offices or organizations.
EnterpriseEINs	This model will be used to add/udpate EINType/EINValue combinations for an enteprise.
EnterpriseObject	Generic model to support the enterprise level modeling in the EPT
EntityGroupRoleAssoc	Associates entity groups with roles
EntQueueSubsPerm	This model provides mapping metadata for IntegrationSubscription generation process.
EntRoleType	A model for capturing enterprise specific role type information.
EntRoleTypeBase	Captures the role types on which this enterprise specific role type is based on.
EntRoleTypeExclusion	A model for capturing all the exclusions (menus, menu actions, actions and global screen elements) for enterprise role types.
EntRoleTypeInclusion	A model for capturing all the inclusions(menus, menu actions, actions and global screen elements) for enterprise role types.
EnumConversionDef	EnumConversionDef defines the "Base Unit" which is used as the pivot point for converting between enumeration values
EnumConversionFactor	EnumConversionFactor specifies the Factor used to convert a value in its Measure to a value in the parent EnumConversionDef's BaseUnit
EnumDependency	Model to specify the relationship between a "child" enumeration whose valid values are constrained by the selection in an earlier "parent" enumeration.
EnumFieldDependency	Specifies an instance of an enumeration which appears on a particular model and ties it to another field on that model.
EnumPreferences	Defines preferences for enterprise specific enumeration, i.e.
EquipmentType	Various forms of conveyances for goods movement.(Ex., van, flatbed, reefer, etc.)
ErrorDef	TODO complete the class documentation
ExecutiveDashboard	The ExecutiveDashboard model is used to capture the "higher level" executive dashboard under which different board groups are stored.
ExternalReference	General-purpose lookup table for mapping external values to internal.
FeatureSubscription	A model for subscribing features for an enterprise.
FixLenDef	Stub for FixLenDef to compile platform-api code.
FixLenFieldDef	Stub for FixLenFieldDef to compile platform-api code.
GeoLanePattern	A Geo Lane Pattern represents a From Region (a GeoPatternList) and a To Region (a GeoPatternList).
GeoLanePermission	Defines permissibility for Roles based on Geo Lanes.
GeoPattern	A Geographical(Geo) Pattern defines a very specific geographical area.
GeoPatternList	A Geograhpical(Geo) Pattern List groups a set of Geo Patterns, each of which defines a specific geographic area.
GeoPermission	Java class for GeoPermission complex type.
HeatMapDef	Identifies a HeatMap which can be executed in the ONE Executive Dashboard.
HierEnumConversionDef	HierEnumConversionDef defines the "Base Unit" and scope which is used as the pivot point for converting between enumeration values
HierEnumConversionFactor	HierEnumConversionFactor specifies the Factor used to convert a value in its Measure to a value in the parent HierEnumConversionDef's BaseUnit and Scopes
IDocDef	Stub for IDocDef to compile platform-api code.
IDocFieldDef	Stub for IDocFieldDef to compile platform-api code.
IDocSegmentDef	Stub for IDocSegmentDef to compile platform-api code.
Image	Image is used to capture an uploaded image, a set of "edits" to make it make it more display-friendly, and its association another data model (like User)
IntegMapping	General-purpose lookup table for mapping external value to ONE value and vice versa.
IntegrationConnection	Holds properties for specific types of integration connections: SFTP, AS2, VAN etc.
IntegrationSubscription	IntegrationSubscription allows Enterprises to subscribe to events on models or define scheduled execution and send outbound integrations based on those events.
IntegrationSubscriptionQueue	Java class for IntegrationSubscriptionQueue complex type.
InteractiveSimulation	An "interactive simulation" is a series of steps used for demonstration purposes, where rather than executing actual UI actions, a user can click "Run" on each step to simulate the end user UI actions in the backend
InteractiveSimulationStep	Java class for InteractiveSimulationStep complex type.
InterfaceListener	Allows developers to execute tasks during the life cycle of inbound and outbound message processing.
Invoice	An invoice is a document issued by Invoicer(Seller) to the Invoicee(buyer), indicating the products, quantities, and agreed prices for products or services the Invoicer has provided to Invoicee.
InvoiceHold	An InvoiceHold is used by Accounts Payable to flag errors on an Invoice and its Invoice Lines, and thereby prevent Payment of the Invoice until the holds are cleared.
InvoiceLine	Java class for InvoiceLine complex type.
InvoiceLineDetail	Java class for InvoiceLineDetail complex type.
IssueProblemRole	This specifies what roles will be allowed to view problems that Issue Subscriptions generate when alerts are fired by the system.
IssueSubscription	Captures a "subscription" of a user to a particular Issue, including user-provided filters to refine the circumstances under which the Issue should be considered for Alert creation.
IssueSubscriptionFilter	Captures the data for an individual filter within a user's Issue Subscription.
Item	Any object or a 'thing'
ItemSubstitution	Used to specify item substitution characteristics such as start/end dates, type of substitution.
ItemTaxCode	Captures item-specific codes used by Tax Provider services for calculating sales and other taxes.
IxmEngineConfig	This model is used to configure the deployment of an IXM engine at a cluster-wide level
IxmEngineNodeConfig	This model is used to configure the deployment of an IXM engine at a specific node level
IxmTaskGeneratorSchedule	Used to customize the schedules under which a particular engine can run
JoinedIssueSubscription	Allows users to join the IssueSubscription published by other users in the same enterprise.
KPI	Stores a computed KPI value.
KPIDef	A KPIDef is meta-data which qualifies a KPIFamilyDef (defined in the module or EPT) with runtime parameters, UI parameters and boundary qualifiers.
KPIHistory	Captures historical values for the parent KPI, if available.
Message	A model containing the metadata related to message, the payload itself is stored in the MessageStorageService.
MessageDestination	Captures a destination to which an outbound message can be routed, for example a filesystem or SFTP server
MessageDetail	The MessageDetail model captures additional "record-level" information for integration messages to go along with the "message-level" information captured in the Message model.
MessageQueue	Describes the metadata for various Inbound and outbound Message Queues.
MessageRoute	Routes outbound Messages to different MessageDestinations based on interface/queue/etc
MessageSource	Defines a "source" from which Messages can be "polled" by MessageSourcePolls and enqueued into an Inbound Queue.
MessageSourcePoll	Defines rules by which Messages are "polled" from a MessageSource and enqueued into an Inbound Queue.
MessageTransform	Can be used to transform an inbound or outbound Message prior to processing
MLModel	The machine learning model that contains the model id, version and an attachment to the trained model.
MLPlugPoint	A MLPlugpoint registered against the MPT to be picked which helps of identify the correct pipeline and finally the required trained model to perform the prediction.
ModelId	Utility class to hold a surrogate id and ModelLevelType.
ModelLinkAttributeValue	This will be used to provide the ModelLink value for an attribute.
ModelLinkAttributeValue.ModelLinkComponent	Java class for anonymous complex type.
ModelList	TODO complete the class documentation
ModelReference	Utility class to hold a surrogate id and ModelLevelType (i.e.
ModelValidationConfig	ModelValidationConfig is used to configure ValidationContexts to be used with ValidationService.
Movement	The movement forms the basic unit of transporation execution.
MovementStop	Movement Stop represents a stop that Carrier will be taking in movement move.
MovementStopLine	Movement Stop line represents all the details of Movement Stop like status and stop Number.
MsgProcessingContext	Model to resolve the user context either using ResolverClass or by fields pattern matching against message, to process the inbound message.
MsgQueueDependency	Declares dependency relationships, such that Queue 1 will not be dequeued while Queue 2 still has messages.
NeoAnalyticReport	Defines a "report" which is executed against a single Fact.
NeoCustomWidget	Defines a custom widget which has been added by the user.
NeoDashboard	Java class for NeoDashboard complex type.
NeoDashboardSubscr	Represents NeoDashboards subscribed by User.
NeoKPIConfig	Allows the override of TargetValues and ValueBands at the level of a NeoKPIDef plus one or more scopes.
NeoKPIDefConfig	This model allows runtime configuration of NeoKPIDefs, including filters and datasources.
NeoKPIValue	This model sits in OLTP (not DW) and stores pre-computed KPI values for NeoKPIDefs which use the Materialized option.
NeoNotification	Model to support notifications.
Neophyte	A Neophyte is a small engine which will automatically find problems, look for any available Neo Prescriptions, and invoke those Prescriptions on a schedule.
NeoPrescription	Captures a prescription generated by Neo which can be used to solve a problem, either automatically or through directed user action.
NodeExecHistory	Java class for NodeExecHistory complex type.
OAuthIBClientApp	Where ONE is the Resource Server, OAuthIBClientApp is used to store client app ids given to external OAuth Client Applications by ONE.
OAuthIBToken	Where ONE is the Resource Server, an OAuthIBToken is granted to a Client App to make calls on behalf of a Resource Owner.
OAuthIBTokenReq	This model is used to store information relevant to the authorization *request* made by an external Client Application to ONE as Resource Server.
OAuthOBClientApp	Where ONE is the Client App, OAuthOBClientApp is used to store client app ids given to ONE by external Resource Servers.
OAuthOBToken	Where ONE is the Client App, OAuthOBToken is used to store tokens granted to ONE by a Resource Owner using an external Resource Server.
OAuthOBTokenReq	This model is used to store information relevant to the authorization *request* made by ONE as Client Application to the Resource Server.
OBFixlenFieldFormat	Defines the format of the fields that compose a record in a flat file.
OBFixlenInterfaceFmt	Roughly corresponds to a "flat file" to be sent outbound.
OBFixlenRecordFormat	Defines the format of a single record in a flat file.
OBFLRecordGroup	An ordered collection of OBFixlenRecordFormats that define the format of a flat file.
OBFLRecordGroupEntry	Primarily servers two purposes: 1) Decouple OBFixlenRecordFormats from OBFixlenInterfaceFmt so that they can be defined independently and reused.
OnboardingProgram	Program used for Onboarding.
Order	Can refer to an order written as a requisition request to sell goods to a customer (sales order) or purchase goods from a supplier (purchase order).
OrderForecast	An order forecast represents a prediction of what will need to be ordered for a given item at a site in the future.
OrderLineItem	Java class for OrderLineItem complex type.
OrderSchedule	Java class for OrderSchedule complex type.
Organization	Each Enterprise can contain one or more Organizations to describe different divisions/etc within the company.
OrgCode	A numeric, or alphanumeric, representation of text for exchanging commonly used information.
OrgEnumDependency	Model to specify the relationship between a "child" enumeration whose valid values are constrained by the selection in an earlier "parent" enumeration for an Organization.
OrgEnumPreferences	Defines preferences for organization specific enumeration, i.e.
OrgHierarchy	Identifies named hierarchies for orgs.
OrgHierarchyEntry	Provides the actual parent/child relationship for the orgs within a hierarchy.
OrgListPerm	OrgListPerm is used to associate one or more Organizations with a model such as an Item or Shipment.
Page	Represents a screen within Command Center that displays a set of read-only or editable fields; if editable fields are present, an action button is also shown.
PageAction	Java class for PageAction complex type.
PageFlow	A set of Pages that work together to provide a full lifecycle of creating and modifying a model instance (e.g.
PageRelatedModel	Related model level to Page.
PageRoutingGuide	The Page Routing Guide is all the rules for routing to specific Page Flow.
Partner	A uni-directional partnership, where one Enterprise specifies another Enterprise as its partner.
PartnerEDIConfig	The EDI configuration properties for a partner to override any default configurations.
PartnerInvitation	An organization can invite any other organization in the network to be its partner.
PartnerSite	Similar to Partner, Partner Site allows an Organization to reference another Organization's Sites using its own set of names.
PartnerTypeConfig	Java class for PartnerTypeConfig complex type.
Payment	Payment is a model to capture all payment details for an Invoice.
Person	A Person is defined underneath a PersonSpace within an Enterprise.
PersonIdentityMapping	A PersonIdentityMapping indicates that a Person within one PersonSpace is "the same" human as a Person from another PersonSpace in another Enterprise.
PersonSpace	A PersonSpace defines a namespace under which an Enterprise can store Persons.
PersonSpacePermission	By default, PersonSpaces are only accessible within an Enterprise.
Pipeline	A pipeline model is used to store information to automatically generate a series of sequentially executed tasks.
PipelineExecHistory	A PipelineExecHistory model is used to store execution information of pipeline.
PlatformInstance	A PlatformInstance represents a deployed platform instance with name, url, authorization info and state defining inMaintenanceModeUntil field.
PolicyValue	Model to hold the policies defined in MPT
ProductGroup	A group of products with similar characteristics, often used in production planning (or sales and operations planning).
ProductGroupLevel	Product Group Level Hierarchy.
PublicProfile	Profile of the organization which will shown to all other organizations
RelatedModelAction	Java class for RelatedModelAction complex type.
ReportSummaryRow	Stub for ReportSummaryRow to compile platform-api code.
ReportSummaryRow.SummaryCell	Stub for ReportSummaryRow.SummaryCell
Role	Each User in the system can play one or more Roles.
Scenario	Stub for Scenario to compile platform-api code.
SharedDashPref	This model shows dashboards that are shared with other users
Shipment	The Shipment model is used to represent the transfer of goods from one party to another.
ShipmentLine	Shipment Line represents the Goods' physical dimension in terms on Weight, Volume, Quantity etc.
Singleton	Singleton represents an individual item with a unique identifier.
SingletonLine	The Singleton Line is used to model non-serialized items which are part of the main Singleton.
Site	A physical location, owned by an Organization.
SiteGroup	Java class for SiteGroup complex type.
SiteGroupLevel	Java class for SiteGroupLevel complex type.
SiteLane	A site lane represents a transportation lane along which items can be transported from one site to another.
SiteRsrc	Location where the actual physical receipt of the purchased material from the carrier occurs.
SiteRsrcReservation	Site Resource Reservation represents the details of the pick up and delivery appointments created on shipment.
SlcFileCache	Model to store the mapping of attachment and cached file name with relative path on SLC(Sandboxed Lambda Cluster).
SqlDef	Stub for SqlDef to compile platform-api code.
Task	A Task which can be managed in ONE's Dashboard and may have dependency relationships with other Tasks.
TaskReqmt	Indicates a dependency between two Tasks.
Template	This model is used to store information about a template, which helps change the display of a UI page based on the user that is viewing it.
TemplatePermission	This level is used to store information on a template's permissibility; it allows additional organizations to access a template, aside from the template owners.
ToDo	To DO concept is a SINGLE USER CONCEPT.Will show all current user's ToDos
User	A user of the OneNetwork Platform.
UserABAC	UserABAC will be used to associate an user and ABAC
UserABACValue	Java class for UserABACValue complex type.
UserAssociation	Used to grant Roles to Users.
UserDefinedConstant	Holds the enterprise specific user defined constants to be used in the TLV computed expressions.
UserGroup	A named group of Users.
UserGroupMember	Java class for UserGroupMember complex type.
UserRequest	Used to request the addition of new users and other actions which a user needs administrator assistance to complete.
UserTermsAndConditions	Captures the terms and conditions which user should accept (if enabled using ExternalReference) before login to the system.
ValidationRule	Defines a validation rule which can be run in a specific "context".
ValidationRuleIf	When *all* ValidRuleIfs evaluate to true, ValidRuleThens execute to perform the validation.
ValidationRuleTest	Rules Test Model contains sample data for the context and subcontexts to test against the specified criteria to test if rules evaluate to correct results for the set of ValidationRuleIf and ValidationRuleThen for the rule
ValidationRuleThen	If *any* ValidRuleThen evaluates to false, the ValidRule as a whole is said to be invalid.
ValueBand	ValueBands are used to capture a set of value ranges and associated "status".
ValueBands	ValueBands are used to capture a set of value ranges and associated "status".
ValueChain	ValueChain is the top-level entity under which all other Models reside.
WBGeo	This model is used to hold the Geo information for WBProblem for the referenced models, i.e.
WBProblem	This is contains specific problems to be displayed in the Workbench.
WBProblemAddtlModelRef	This model holds the additional ModelRef along with primary ModelRef available on WBProblem to reference problem to multiple entities For example, if WBProblem references both Shipment and Movement, Shipment will be persisted to WBProblem and Movement will be persisted on this model.
WBProblemDimension	Conceptually this is a child model of WBProblem, but it is kept as a related model instead since it may at times have high somewhat cardinality.
WBProblemIssue	WBProblemIssue defines the linkage between classic, transactional Issue computations in Platform with the new Problem model.
WBProblemLine	This model links an additional ESG room and users to a problem.
WBProblemLineMember	Tracks invited users to the problem line.
WBProblemNote	This represents a note written for a problem.
WBProblemRole	An optional child of WBProblem used to limit access to the problem to specific role instances.
WBProblemRoleType	Only RoleTypes with rows underneath the parent WBProblemType are allowed to view WBProblems of that type.
WBProblemSharedOrg	This model stores the information of the WBProblem and the Organization of the owner's partners with which the problem has been shared.
WBProblemType	Describes a Problem Type for use within the Workbench.