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
IPersonnel
IPersonnel allows you to read from and write to the Personnel model.
WritePersonnelValue (IPersonnel)
Writes a value to an attribute or property for a personnel instance.

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.
    - AddAspect (IPersonnel)
      Allows you to add an aspect to a person or personnel class.
    - AddClass (IPersonnel)
      Associates a personnel class with a specific personnel resource.
    - AddPropertyToClass (IPersonnel)
      Allows you to add a property to a personnel class.
    - ChangeAuthenticatedPersonPassword (IPersonnel)
      Changes a person's password using encrypted passwords.
    - ChangePersonPassword (IPersonnel)
      Changes a person's password using plaintext passwords.
    - CreatePerson (IPersonnel)
      Creates a new person.
    - CreatePersonnelClass (IPersonnel)
      Allows you to create a new personnel class.
    - DeletePerson (IPersonnel)
      Deletes a person resource.
    - DeletePersonnelClass (IPersonnel)
      Allows you to delete a personnel class.
    - GetAspectTypes (IPersonnel)
      Returns the applicable and applied aspect types for a person or personnel class.
    - GetClassProperties (IPersonnel)
      Gets the properties for a specific class.
    - HasAspect (IPersonnel)
      Checks whether a person or personnel class has the specified aspect applied to it.
    - HasClass (IPersonnel)
      Checks if a specific person is associated with a specific class.
    - ReadAllPersonnelValues (IPersonnel)
      Returns the values of all of the properties and attributes of a personnel resource.
    - ReadClasses (IPersonnel)
      Get the classes associated with a specific person.
    - ReadClassProperties (IPersonnel)
      Retrieves the values for properties of a specific class from a specified person.
    - ReadPersonnelValuesByName (IPersonnel)
      Returns the values of all of the named properties and attributes of a personnel resource.
    - RemoveAspect (IPersonnel)
      Removes an aspect from a person or personnel class.
    - RemoveClass (IPersonnel)
      Removes a specified personnel class association from the selected personnel resource.
    - RemovePropertyFromClass (IPersonnel)
      Allows you to remove a property from a personnel class.
    - VerifyUserCredentials (IPersonnel)
      Performs a check to verify that the provided user credentials are valid.
    - WritePersonnelValue (IPersonnel)
      Writes a value to an attribute or property for a personnel instance.
  - 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

WritePersonnelValue (IPersonnel)

Writes a value to an attribute or property for a personnel instance.

Inputs	Data Type	Description
personnelAddress	DirectoryResource	Specifies the personnel resource to update. 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.
propertyName	String	Specifies the name of the property or attribute to write to. 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.
Value	Object	Specifies the new value of the attribute or property. 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

personnelAddress

DirectoryResource

Specifies the personnel resource to update.

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.

propertyName

String

Specifies the name of the property or attribute to write to.

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.

Value

Object

Specifies the new value of the attribute or property.

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.