Have You Seen Workflow Lately? Click here to check out all the new features in the latest version.

Supercharge your GE solution! Download a free trial of Proficy Operations Hub, CSense analytics, and more. Learn more about the Proficy 2024 releases, by signing up for one of our upcoming events.

Home
Service Interfaces
Workflow Methods
IEquipment
IEquipment allows you to read from and write to the Equipment model.
GetClassProperties (IEquipment)
Returns a list of properties defined by an equipment class.

Workflow Products Documentation

Service Interfaces
- Service Interfaces
- Workflow Methods
  - Workflow Methods
    Workflow provides a set of core service interfaces and call methods for you to use when creating a workflow. This section describes these core service interfaces and the associated call methods.
  - IArchiveManagement
    IArchiveManagement allows you to create an archive file and select the data to include.
  - IAuditTrail
    IAuditTrail allows you to write entries to the audit trail.
  - IDatabaseService
    IDatabaseService provides access to relational data, such as databases.
  - IDirectorySearch
    IDirectorySearch allows you to search the Directory of Resources for a set of resources based on a search query, or for a list of resources based on a resource class.
  - IEmailService
    You can use IEmailService to send emails as part of a workflow process.
  - IEquipment
    IEquipment allows you to read from and write to the Equipment model.
    - AddAspect (IEquipment)
      Allows you to add an aspect to an equipment instance or class.
    - AddClass (IEquipment)
      Allows you to add a class to an equipment instance.
    - AddPropertyAspect (IEquipment)
      Adds an aspect to an equipment instance or class property.
    - AddPropertyClass (IEquipment)
      Allows you to add a property of type Class to an equipment instance.
    - AddClassPropertyToClass (IEquipment)
      Allows you to add a property of type Class to an equipment class.
    - AddPropertyToClass (IEquipment)
      Allows you to add a property to an equipment class.
    - CreateClass (IEquipment)
      Allows you to create a new equipment class.
    - CreateEquipment (IEquipment)
      Creates a new equipment instance of a given type under the given parent.
    - DeleteClass (IEquipment)
      Allows you to delete an equipment class.
    - DeleteEquipment (IEquipment)
      Deletes an equipment instance.
    - GetAspectTypes (IEquipment)
      Returns the applicable and applied aspect types for an equipment instance or class.
    - GetClassProperties (IEquipment)
      Returns a list of properties defined by an equipment class.
    - GetDataSourceLink (IEquipment)
      Gets the current data source binding for a given equipment property.
    - GetEquipmentChildren (IEquipment)
      Returns a collection of all the child resources for the specified parent resource.
    - GetEquipmentParent (IEquipment)
      Returns the parent of the specified equipment resource.
    - GetPropertyAspectTypes (IEquipment)
      Returns the applicable and applied aspect types for an equipment instance or class property.
    - HasAspect (IEquipment)
      Checks whether an equipment instance or class has the specified aspect applied to it.
    - HasClass (IEquipment)
      Checks if a given instance has the given class.
    - HasPropertyAspect (IEquipment)
      Checks whether an equipment instance or class property has a specified aspect applied.
    - ReadClasses (IEquipment)
      Returns a list of classes associated with an equipment instance.
    - ReadEquipmentClassValues (IEquipment)
      Reads the values of a class property of a specific equipment instance.
    - ReadEquipmentValue (IEquipment)
      Reads the value of a single property or attribute of a specific equipment resource.
    - ReadEquipmentValues (IEquipment)
      Returns the values of all of the properties and attributes of a specific equipment resource.
    - ReadEquipmentValuesByName (IEquipment)
      Returns the values of named properties and attributes of a specific equipment resource.
    - ReadPropertyAttribute (IEquipment)
      Returns the value of an attribute of an equipment instance or class property.
    - ReadPropertyAttributes (IEquipment)
      Returns the values of all attributes of an equipment instance or class property.
    - ReadPropertyAttributesByName (IEquipment)
      Returns the attribute names of the specified equipment instance or class property.
    - RemoveAspect (IEquipment)
      Removes an aspect from an equipment instance or class.
    - RemoveClass (IEquipment)
      Removes a specified equipment class from an equipment instance.
    - RemovePropertyAspect (IEquipment)
      Removes an aspect from an equipment instance or class property.
    - RemovePropertyFromClass (IEquipment)
      Allows you to remove a property from an equipment class.
    - RemovePropertyFromEquipment (IEquipment)
      Allows you to remove a property from an equipment instance.
    - SetDataSourceLink (IEquipment)
      Sets a data source binding on a given equipment property.
    - WriteEquipmentValue (IEquipment)
      Writes the value to the Value attribute of the specified property of the selected equipment instance or class.
    - WritePropertyAttribute (IEquipment)
      Writes to an attribute of an equipment instance or class property.
  - IEquipmentConfig
    IEquipmentConfig provides methods for configuring the equipment model.
  - IEquipmentHistorian
    IEquipmentHistorian allows you to read from and write to Historian tags.
  - IEvent
    IEventManager allows you to read from the Event model and to create an event subscription for a specific event resource.
  - IExtensionData
    IExtensionData allows you to access temporary workflow data that was previously stored in a system repository. This stored data can be associated with both internal and external systems.
  - IITService
    IITService allows you to read from the Proficy System model.
  - ILicense
    The ILicense service method provides access to active licensing information.
  - IMaterial
    IMaterial allows you to read from and write to the Material model.
  - IOpcClient
    IOpcClient allows you to read from the OPC Client model.
  - IOpcUa
    IOpcUa allows you to read from the OPC UA model.
  - IPersonnel
    IPersonnel allows you to read from and write to the Personnel model.
  - IProductionModel
    IProductionModel allows you to read from or write to the Production model.
  - IProductionReport
    IProductionReport allows you to read from the Production model.
  - IProductionRuntime
    The IProductionRuntime service interface relates to production oversight.
  - IProficyHistorian
    IProficyHistorian allows you to manage Historian servers, including reading from and writing to Historian collectors and tags.
  - IPropertyGroup
    IPropertyGroup allows you to read from or write to the properties of a resource.
  - IResourceLinking
    IResourceLinking allows you to work with resource links for all types of resources. You can start, edit, end, and query links between resources in your system.
- iFix Service Provider

GetClassProperties (IEquipment)

Returns a list of properties defined by an equipment class.

Inputs	Data Type	Description
Equipment Class	DirectoryResource	Specifies the address of the equipment instance. In the Configure Method dialog box, click Next to select a resource. Otherwise, in the Inputs section of the activity configuration panel, click the ellipsis button to select a resource.

Inputs

Data Type

Description

Equipment Class

DirectoryResource

Specifies the address of the equipment instance.

In the Configure Method dialog box, click Next to select a resource. Otherwise, in the Inputs section of the activity configuration panel, click the ellipsis button to select a resource.

Outputs	Description
String[]		Returns a string array of property names.