×

Supercharge your Proficy solution! Download a free trial of Proficy Operations Hub, CSense analytics, and more. Explore our Proficy 2024 releases!

Home
Service Interfaces
Workflow Methods
IMaterial
IMaterial allows you to read from and write to the Material model.
ReadMaterialValuesByName (IMaterial)
Returns the values of all of the named properties and attributes of a material resource.

Workflow IPI
Get Started
Tutorials
Orientation
Configure Your Environment
Security
Resource Information and Configuration
Data Administration
Forms and User Displays
Building and Configuring Workflows
eSOP
ActiveX Task Controls
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.
  - 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.
    - AddAspect (IMaterial)
      Allows you to add an aspect to a material definition or class.
    - AddClass (IMaterial)
      Allows you to add a specified material class to a specified material definition.
    - AddLotToAssembly (IMaterial)
      Adds a parent/child assembly relationship between two material lots.
    - AddPropertyAspect (IMaterial)
      Adds an aspect to a material definition or class property.
    - AddPropertyToClass (IMaterial)
      Allows you to add a property to a material class.
    - ClearPropertyFromLotProperty (IMaterial)
      Clears the material definition property from being a lot property.
    - CreateMaterialClass (IMaterial)
      Allows you to create a new material class.
    - CreateMaterialDefinition (IMaterial)
      Creates a new material definition.
    - CreateMaterialLot (IMaterial)
      Creates a lot for a particular material resource.
    - CreateMaterialSublot (IMaterial)
      Creates a sublot for a particular material that is under a specified parent material resource.
    - DecrementMaterialLotOrSublotQuantity (IMaterial)
      Reduces the quantity of a specified material lot or sublot.
    - DeleteMaterialClass (IMaterial)
      Allows you to delete a material class.
    - DeleteMaterialDefinition (IMaterial)
      Deletes a material definition.
    - DeleteMaterialLotOrSublot (IMaterial)
      Deletes a specified material lot or sublot.
    - FindMaterialDefinitions (IMaterial)
      Finds all of the material definitions that exactly match the defined parameter names and values.
    - GetAspectTypes (IMaterial)
      Returns the applicable and applied aspect types for a material definition or class.
    - GetClassProperties (IMaterial)
      Returns a list of properties defined by a material class.
    - GetPropertyAspectTypes (IMaterial)
      Returns the applicable and applied aspect types for a property owned by a material definition or material class.
    - HasAspect (IMaterial)
      Checks whether a material definition or class has the specified aspect applied to it.
    - HasClass (IMaterial)
      Checks if a given material definition is associated with a given material class.
    - HasPropertyAspect (IMaterial)
      Checks if a property owned by a material definition or material class has a specified aspect applied to it.
    - IncrementMaterialLotOrSublotQuantity (IMaterial)
      Increases the quantity of a specified material lot or sublot.
    - IsLotAssemblyDescendant (IMaterial)
      Returns a value indicating whether the defined material lot is the descendant of a root material lot within an assembly.
    - QueryMaterialLots (IMaterial)
      Performs a query against a runtime database for material lots. All material lots that match the specified query criteria are returned.
    - QueryMaterialSublots (IMaterial)
      Performs a query against a runtime database for material sublots. All material sublots that match the specified query criteria are returned.
    - ReadAllMaterialValues (IMaterial)
      Returns the values of all of the properties and attributes of a material resource.
    - ReadAllPropertyAttributes (IMaterial)
      Returns the values of all attributes of a material definition or class property.
    - ReadClasses (IMaterial)
      Returns a list of classes associated with a specified material definition.
    - ReadClassProperties (IMaterial)
      Retrieves the property values belonging to a specified class from a specified material definition.
    - ReadMaterialLot (IMaterial)
      Returns a list of attributes associated with a specified material lot.
    - ReadMaterialSublot (IMaterial)
      Returns a list of attributes associated with a specified material sublot.
    - ReadMaterialValue (IMaterial)
      Reads the value of a single property or attribute of a specific material resource.
    - ReadMaterialValuesByName (IMaterial)
      Returns the values of all of the named properties and attributes of a material resource.
    - ReadPropertyAttribute (IMaterial)
      Returns the value of an attribute of a material definition or class property.
    - ReadPropertyAttributesByName (IMaterial)
      Returns the attribute names of the specified material definition or class property.
    - RemoveAspect (IMaterial)
      Removes an aspect from a specified material definition or class.
    - RemoveClass (IMaterial)
      Removes a specified material class from a specified material definition.
    - RemoveLotFromAssembly (IMaterial)
      Removes an assembly relationship between a parent material lot and a child material lot.
    - RemovePropertyAspect (IMaterial)
      Removes an aspect from a property owned by a material definition or material class.
    - RemovePropertyFromClass (IMaterial)
      Allows you to remove a property from a material class.
    - SetMaterialLotOrSublotLocation (IMaterial)
      Sets the equipment location for a specified material lot or sublot.
    - SetMaterialLotOrSublotQuantity (IMaterial)
      Sets the quantity specified by a lot or sublot requirement.
    - SetMaterialLotOrSublotStatus (IMaterial)
      Sets the status of a specified lot or sublot.
    - SetMaterialLotToClosed (IMaterial)
      Sets the specified material lot to a closed status. When a lot is in this state, it is no longer part of runtime, so it can be archived and purged.
    - SetPropertyToLotProperty (IMaterial)
      Specifies the material to be a lot property.
    - UpdateMaterialLotS95Id (IMaterial)
      Updates the S95 ID of a material lot.
    - WriteMaterialLotProperties (IMaterial)
      Writes to properties of a specified material lot.
    - WriteMaterialValue (IMaterial)
      Writes a value to an attribute or property for a material definition.
    - WritePropertyAttribute (IMaterial)
      Writes to an attribute of a material definition or class property.
  - 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
Operator Task List in the Workflow Client
Best Practices

ReadMaterialValuesByName (IMaterial)

Returns the values of all of the named properties and attributes of a material resource.

Note: In the Edit Method dialog box, click Next to add class definitions to the call method. This returns only the parameters you choose from the class.

Inputs

Data Type

Description

Material Address

DirectoryResource

Specifies the material resource to read.

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.

propertyNames

String[]

Specifies the names of the attributes or properties to read.

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
NameDataValueCollection		Returns a list of the user-defined values of the named properties and attributes for the specified resource. To access these properties, use an Index Activity or a For Each loop. You can use the parameter name as the index for the Index activity.

Important: The returned collection of data is based on user-defined values and is dependent on your published data. For information on the attributes that can be read from, see the related properties for the material model.