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
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.
CreateClassQueryExpression (IDirectorySearch)
Creates a query expression to return resources associated with a given class.

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.
    - CreateClassQueryExpression (IDirectorySearch)
      Creates a query expression to return resources associated with a given class.
    - Search (IDirectorySearch)
      Returns an array of directory resources for a given search string.
    - SearchEx (IDirectorySearch)
      Returns an array of directory resources for a given search string, with the ability to filter results based on whether the value specified for the resource name or description parameter partially or exactly matches the actual value for the given parameter.
  - 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.
  - 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

CreateClassQueryExpression (IDirectorySearch)

Creates a query expression to return resources associated with a given class.

Inputs	Data Type	Description
Class Resource	DirectoryResource	Specifies the resource class you want to use for your query expression. 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.

Inputs

Data Type

Description

Class Resource

DirectoryResource

Specifies the resource class you want to use for your query expression.

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
ClassificationExpression		Returns a list of all resources associated with the selected resource class.

Important: The returned collection of data is based on user-defined values and is dependent on your published data. For example, if you select the personnel class "Operator" for your query expression, then a list of all personnel resources associated with that class is returned.