×

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
IPropertyGroup
IPropertyGroup allows you to read from or write to the properties of a resource.
WritePropertyGroup (IPropertyGroup)
Writes property values of a resource based on property names of the property group.

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.
  - 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.
    - ReadPropertyGroup (IPropertyGroup)
      Reads property values of a resource based on property names of the property group.
    - WritePropertyGroup (IPropertyGroup)
      Writes property values of a resource based on property names of the property group.
      - Write to a property group
  - 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

WritePropertyGroup (IPropertyGroup)

Writes property values of a resource based on property names of the property group.

Note: In the Configure Method dialog box, click Next to specify the property group to write to. After selecting the property group, you can select the properties you want to write.

Inputs

Data Type

Description

Property Group

DirectoryResource

Specifies the name of the property group whose properties you want to write to.

PropertyGroup.Property

Dependent on each parameter's data type

Specifies the value to write for the property.

Note: Properties are available for selection only after you select a property group on the Configure Methods dialog box.

Resource

DirectoryResource

Specifies the resource with the properties you want to write to.

In the Inputs section of the activity configuration panel, click the ellipsis button to open the Universal Browser to select the resource you want to use.

Outputs

Description

PropertyCollection

Returns the property names and values as a collection.

The property collection returned will contain any failed writes.

A failed write can occur if the data type of the property group property is incompatible with the data type of the resource property or if the property of the property group does not exist for the resource.