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
IProductionModel
IProductionModel allows you to read from or write to the Production model.
CreateWorkDefinitionSegment (IProductionModel)
Creates a new work definition segment.

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.
    - AddChildWorkDefinitionSegment (IProductionModel)
      Associates a work definition segment as a child of another work definition segment.
    - AddEquipmentToProcessSegment (IProductionModel)
      Adds an equipment specification to a work process segment.
    - AddMasterSegmentToWorkDefinition (IProductionModel)
      Adds a master segment to a work definition.
    - AddMaterialToProcessSegment (IProductionModel)
      Adds a material specification to a work process segment.
    - AddOperationsMaterialBillItem (IProductionModel)
      Adds a material specification item as an operations material bill item to the operations bill of materials (BOM) for the selected work definition.
    - AddPersonnelToProcessSegment (IProductionModel)
      Adds a personnel specification to a work process segment.
    - AddSegmentToWorkDefinition (IProductionModel)
      Associates a work definition segment with a work definition.
    - AddWorkDataToProcessSegment (IProductionModel)
      Adds a work data class to a process segment.
    - CreateOperationsMaterialBill (IProductionModel)
      Creates an operations bill of materials (BOM) for the selected work definition.
    - CreateProcessSegmentParameter (IProductionModel)
      Adds a parameter to a process segment.
    - CreateWorkDataClass (IProductionModel)
      Creates a work data class.
    - CreateWorkDataClassStringProperty (IProductionModel)
      Creates a work data class property.
    - CreateWorkDefinition (IProductionModel)
      Creates a work definition.
    - CreateWorkDefinitionSegment (IProductionModel)
      Creates a new work definition segment.
    - CreateWorkSegmentParameter (IProductionModel)
      Adds a parameter to a work definition segment.
    - DeleteExistingWorkDefinition (IProductionModel)
      Deletes the specified work definition.
    - DeleteProcessSegmentParameter (IProductionModel)
      Deletes the specified parameter from the selected work process segment.
    - DeleteWorkDataClass (IProductionModel)
      Deletes the selected work data class.
    - DeleteWorkDataClassProperty (IProductionModel)
      Deletes the specified property from the selected work data class.
    - DeleteWorkDefinitionSegment (IProductionModel)
      Deletes the selected work definition segment.
    - DeleteWorkProcessSegment (IProductionModel)
      Deletes the selected process segment.
    - DeleteWorkSegmentParameter (IProductionModel)
      Deletes the specified parameter from the selected work definition segment.
    - GetMasterSegmentForWorkDefinition (IProductionModel)
      Gets the master segment for a work definition.
    - GetResourceForWorkDefinition (IProductionModel)
      Gets the resource specification that is linked to a work definition.
    - GetWorkDefinitionLinksForResource (IProductionModel)
      Gets all of the work definitions linked to a resource specification.
    - LinkResourceToWorkDefinition (IProductionModel)
      Creates a resource link between a work definition and a resource specification.
    - ReadOperationsMaterialBill (IProductionModel)
      Reads the attributes of an operations bill of material (BOM) associated with the selected work definition.
    - ReadSegmentParameters (IProductionModel)
      Reads the parameters of the selected work definition segment.
    - ReadWorkDefinition (IProductionModel)
      Reads the attributes, associated segments, and the details of a work definition.
    - ReadWorkDefinitionAssociatedSegment (IProductionModel)
      Reads the attributes of a work definition to work process segment association and the details of the associated work process segment.
    - ReadWorkDefinitionAssociatedSegmentsByParameter (IProductionModel)
      Reads work definition segments that have a particular parameter ID and parameter value.
    - ReadWorkDefinitionMaterialBills (IProductionModel)
      Reads all of the operations bills of material (BOM) for the selected work definition.
    - ReadWorkDefinitionSegment (IProductionModel)
      Reads the attributes of the specified work definition segment.
    - RemoveChildWorkDefinitionSegment (IProductionModel)
      Removes the association between a child work definition segment and its parent.
    - RemoveMasterSegmentFromWorkDefinition (IProductionModel)
      Removes the master segment from a work definition.
    - RemoveOperationsMaterialBill (IProductionModel)
      Removes the specified operations bill of materials (BOM) from the selected work definition.
    - RemoveOperationsMaterialBillItem (IProductionModel)
      Removes the specified item from the operations bill of materials (BOM) for the selected work definition.
    - RemoveResourceFromWorkDefinition (IProductionModel)
      Removes the resource link to a resource specification for a work definition.
    - RemoveSegmentFromWorkDefinition (IProduction Model)
      Removes the specified work definition segment association from a work definition.
    - RemoveSpecificationFromProcessSegment (IProductionModel)
      Removes a specification from a process segment.
    - RemoveWorkDataFromProcessSegment (IProductionModel)
      Removes a work data class from a process segment.
    - SetProcessSegmentMasterValue (IProductionModel)
      Sets the value of the specified work process segment's master segment flag.
    - SetWorkSegmentSpecification (IProductionModel)
      Sets a resource for a class level specification for a work definition segment.
    - SetWorkSegmentSpecificationQuantity (IProductionModel)
      Sets the quantity for a specification associated with a work process segment.
    - UpdateChildWorkDefinitionSegmentAssociationName (IProductionModel)
      Updates the name of the specified work definition segment association.
    - UpdateWorkDefinitionSegmentOrder (IProductionModel)
      Updates the order for a work segment association to a work definition.
    - UpdateWorkDefinitionDetails (IProductionModel)
      Updates the details of a work definition.
    - UpdateWorkDefinitionSegmentDetails (IProductionModel)
      Updates the details of a work definition segment.
    - UpdateWorkProcessSegmentDetails (IProductionModel)
      Updates a work process segment using information provided in attributes.
    - WriteSegmentParameters (IProductionModel)
      Writes to the parameters of a specified work definition segment.
  - 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

CreateWorkDefinitionSegment (IProductionModel)

Creates a new work definition segment.

Inputs	Data Type	Description
Description	String	Specifies the description of the new work definition segment.
Duration	Double	Specifies the work definition segment duration in minutes. The duration can be defined at any level of the process. Duration is not inherited through an association with another resource.
Name	String	Specifies a display name for the work definition segment.
Work Process Segment	DirectoryResource	Specifies the process segment you want to associate with the work definition segment.

Outputs	Description
DirectoryResource		The address of the new work definition segment.