FactMES.Client.Common Namespace

The Attrs class contains methods for retrieving and setting various attributes within the MES system.

The ClientSession class manages the MES session for an application. You use it to start a session with the MES Middleware and log users onto the session.

The ClientSession object has a property to indicate which user is the current user. Through the users, you access the entities the users are logged onto. Through the entities, you access the jobs that are running on the entities.

There is only one ClientSession object for an application, and the object exists from the time it is created until the application ends. You get a reference to the ClientSession object by calling the GetInstance() static method. The first call to this method will create the ClientSession object. For more examples, see Using the MES Stateful API.

The Ent class handles all the MES functionality for an entity. An Ent object is created for each entity that the user logs into. The Ent object will create service objects for each capability of the entity (e.g., a JobExec object is created if the entity has the "can run jobs" capability).

The EntAttr class inherits from the abstract Attr class and represents a single entity attribute in the database. It exposes the attribute's properties as object properties and exposes functions to load and save it from the database.

The ItemFile class includes methods for adding and maintaining collection of files associated with the specified item.

The ItemStates class is implemented as a singleton to expose all the item state defined in the database. It exposes some static functions for handling item states. Individual item states are exposed via an indexer as ItemState objects keyed by the state code.

The JobAttr class inherits from the abstract Attr class and represents a single job attribute in the database. It exposes the attribute's properties as object properties and exposes functions to load and save it from the database.

The JobExec class handles all the MES functionality for a job. A JobExec object is created for each job position that the entity is capable of running. For a sample client code to start a job, see Interacting with MES.

It is recommended to retrieve the entity from the entity list (ClientSession.CurUser.EntList) and then call the JobExec from the entity instead of calling directly on the clientSession.curUser.curEnt.JobExec. This avoids a potential conflict with another user/object/script changing the curEnt while executing the code.

The LotAttr class inherits from the abstract Attr class and represents a single lot attribute in the database. It exposes the attribute's properties as object properties and exposes functions to load and save it from the database.

The OEEEventArgs class includes methods for passing the current OEE information in the event arguments.

The OperAttr class inherits from the abstract Attr class and represents a single operation attribute in the database. It exposes the attribute's properties as object properties and exposes functions to load and save it from the database.

The ParameterValue class includes methods for defining parameter/value pairs.

The ParameterValueArrayList class includes methods for adding and maintaining a new array that holds parameter/value pairs.

The ProcessAttr class inherits from the abstract Attr class and represents a single process attribute in the database. It exposes the attribute's properties as object properties and exposes functions to load and save it from the database.

The SpecExec class includes methods for getting and saving job specifications. This class can also be used to update operation specifications.

The Specs class includes methods for retrieving specifications.

The Storage class provides a mean for handling inventory and storage entities without having to log into an entity. The methods in this class are all static.

The StorageExec class provides a means of handling inventory and storage entities for the current entity.

The SystemAttrs class reads all the System Attributes from the MES middleware on initialization. It then stores them locally and makes them available to calling applications through the read-only Item property.

The UIConfig class provides methods for reading and saving entries in the UI_Config and UI_Config_Default tables. These tables store configuration data for the various controls, such as column widths, sort orders, and field visibility. All the methods of this class are static; a class instance cannot be created.

The UIExtensions class includes methods for dynamically locating load and creating instances of classes that implement the Fact.Client.Interfaces.IUIExtensionControl interface and have the Fact.Client.Interfaces.UIExtensionAttribute on the class. This is to allow assemblies to load plugins without having direct references to them.

The User class handles all the MES functionality for a user logged on to MES.

The UserEventArgs class supplies the User object for the new user when a UserChanged event is fired.

The UserGrps class contains methods for handling user groups in MES. All methods in this class are static.

The UserPrivs class handles all user privilege functions in MES for a user logged onto MES. Privileges are defined as rows in the Priv table in the MES database, so it is possible for the privileges in the Privileges enumeration to not exist in the database if the database is not up to date.

The Users class contains methods for handling users in MES. All methods in this class are static.

The Util class provides static methods for working with utilization data, which is used to track entity state. Examples of entity states include running, idle, and offline.

The UtilEventArgs class passes current utilization information in the event arguments.

The UtilExec class supports utilization tracking in MES. An instance of this class is created every time a user logs on to an entity that can track utilization.

The Utility class contains assorted utility methods, useful for a variety of purposes. All methods are static, so the class is never instantiated into an object.

The UtilRawReasons class provides supporting methods for the Util_Raw_Reas table. The Util_Raw_Reas table associates utilization raw reasons with an entity and default reason code.

The UtilReasonGroups class provides supporting methods for the Util_Reas_Grp table. The Util_Reas_Grp table defines groups of reasons that a machine might go into a certain state.

The UtilReasons class provides supporting methods for the Util_Reas table. The Util_Reas table associates utilization reasons, such as running or maintenance, with entity states.

The UtilStates class provides supporting methods for the Util_State table. The Util_State table contains the description and color associated with each entity utilization state, such as running or idle.

The WOAttr class inherits from the abstract Attr class and represents a single work order attribute in the database. It exposes the attribute's properties as object properties and exposes functions to load and save it from the database.

The WorkOrderSelectionDlg class displays a list of work orders based on the supplied pattern. Closed work orders are excluded.

The StorageStatus enumeration values specify the possible storage statuses for an entity.

The TransferConflictOption enumeration values specify to take if a conflict arises in the grade, status, or expiry when transfering inventory from one location to another.

The TransferOption enumeration values specify the possible options for transferring inventory.

The UserDisplayOptions enumeration values specify different user display options.