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
IProductionRuntime
The IProductionRuntime service interface relates to production oversight.
Production Runtime Call Methods
The IProductionRuntime service interface call methods allow you to create, modify, query, and delete work requests, work responses, segment responses, actuals, and other items related to production oversight.
ReadWorkRequestAttributes (IProductionRuntime)
Reads the attributes of a specific work request.

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.
    - Common Production Runtime Workflow Scenarios
      Common production runtime scenarios center around creating, modifying, querying, and deleting work requests, work responses, segment responses, actuals, and other production-related items.
    - Production Runtime Call Methods
      The IProductionRuntime service interface call methods allow you to create, modify, query, and delete work requests, work responses, segment responses, actuals, and other items related to production oversight.
      - AddRequestMaterialBillItem (IProductionRuntime)
        Adds an item as a request material bill item to the request bill of materials (BOM) for the selected work request.
      - AddResourceActualProperties (IProductionRuntime)
        Adds named properties of the resource as resource actual properties.
      - AddResourceRequirementProperties (IProductionRuntime)
        Adds named properties of the resource as resource requirement properties.
      - AddWorkDataClassToResponse (IProductionRuntime)
        Adds work data from a work data class to a segment response.
      - CreateEquipmentActual (IProductionRuntime)
        Creates an equipment actual on a specified segment response, without the ability to set initial start and end time values for the actual.
      - CreateEquipmentActualEx (IProductionRuntime)
        Creates an equipment actual on a specified segment response, with the ability to set initial start and end time values for the actual.
      - CreateMaterialActual (IProductionRuntime)
        Creates a material actual on a specified segment response, without the ability to set initial start and end time values for the actual.
      - CreateMaterialActualEx (IProductionRuntime)
        Creates a material actual on a specified segment response, with the ability to set initial start and end time values for the actual.
      - CreateMaterialRequirement (IProductionRuntime)
        Creates a material requirement for a segment requirement.
      - CreatePersonnelActual (IProductionRuntime)
        Creates a personnel actual on a specified segment response, without the ability to set initial start and end time values for the actual.
      - CreatePersonnelActualEx (IProductionRuntime)
        Creates a personnel actual on a specified segment response, with the ability to set initial start and end time values for the actual.
      - CreateRequestMaterialBill (IProductionRuntime)
        Creates a request bill of materials (BOM) for the selected work request.
      - CreateSegmentRequirement (IProductionRuntime)
        Creates a new segment requirement that is based upon a supplied work definition segment.
      - CreateSegmentResponse (IProductionRuntime)
        Creates a segment response to associate with a work request or parent segment response, and work process segment.
      - CreateSegmentResponseForRequirement (IProductionRuntime)
        Creates a segment response for a specified work response or parent segment response and segment requirement.
      - CreateWorkRequest (IProductionRuntime)
        Creates a new work request based on a specified work definition.
      - CreateWorkResponse (IProductionRuntime)
        Creates a work response based on a specified work definition.
      - DeleteEquipmentActual (IProductionRuntime)
        Deletes an equipment actual associated with a specific segment response.
      - DeleteMaterialActual (IProductionRuntime)
        Deletes a material actual associated with a specific segment response.
      - DeletePersonnelActual (IProductionRuntime)
        Deletes a personnel actual associated with a specific segment response.
      - DeleteResourceRequirement (IProductionRuntime)
        Deletes a resource requirement.
      - DeleteSegmentResponse (IProductionRuntime)
        Deletes a specific segment response.
      - DeleteWorkRequest (IProductionRuntime)
        Deletes a specific work request.
      - GetMasterSegmentForWorkRequest (IProductionRuntime)
        Gets the master segment for a work request.
      - GetResourceForWorkRequest (IProductionRuntime)
        Gets the resource specification that is linked to a work request.
      - GetWorkRequestLinksForResource (IProductionRuntime)
        Gets all work requests linked to a resource specification.
      - ReadRequestMaterialBill (IProductionRuntime)
        Reads the attributes of a request bill of materials (BOM) associated with the selected work request.
      - ReadSegmentRequirement (IProductionRuntime)
        Reads the attributes of a specific segment requirement.
      - ReadSegmentRequirements (IProductionRuntime)
        Reads the attributes of segment requirements for a specific work request.
      - ReadSegmentResponse (IProductionRuntime)
        Reads the attributes of the specified segment response.
      - ReadWorkData (IProductionRuntime)
        Reads the attributes of a work data class that is associated with a specific segment response.
      - ReadWorkRequestAttributes (IProductionRuntime)
        Reads the attributes of a specific work request.
      - ReadWorkRequestMaterialBills (IProductionRuntime)
      - RemoveRequestMaterialBill (IProductionRuntime)
        Removes the specified request bill of materials (BOM) from the selected work request.
      - RemoveRequestMaterialBillItem (IProductionRuntime)
        Removes a material requirement from the specified request bill of materials (BOM) for the selected work request.
      - ReplaceSegmentRequirement (IProductionRuntime)
        Deletes the entire hierarchy of the existing segment requirement and creates a new segment requirement with any associated hierarchy.
      - RepurposeWorkResponses (IProductionRuntime)
        Moves the work responses from one work request to another work request, regardless of the status of the originating work request.
      - SetMaterialActualLotOrSublot (IProductionRuntime)
        Sets a lot or sublot specified by a material actual.
      - SetMaterialRequirementLotOrSublot (IProductionRuntime)
        Sets a lot or sublot for the specified material requirement.
      - SetResourceActualEndTime (IProductionRuntime)
        Updates the utilization end time for a previously created material, personnel, or equipment actual.
      - SetResourceActualStartTime (IProductionRuntime)
        Updates the utilization start time for a previously created material, personnel, or equipment actual.
      - SetResourceActualUse (IProductionRuntime)
      - SetResourceRequirement (IProductionRuntime)
        Sets the resource specified by a resource requirement.
      - SetResourceRequirementQuantity (IProductionRuntime)
        Sets the quantity specified by a resource requirement.
      - SetResponseEndTime (IProductionRuntime)
        Sets the end date and time for the work response or segment response.
      - SetResponseLocation (IProductionRuntime)
        Sets the location of a work response or segment response.
      - SetResponseS95Id (IProductionRuntime)
        Sets the S95 ID of a work response or segment response.
      - SetResponseStartTime (IProductionRuntime)
        Sets the start date and time for the work response or segment response.
      - SetSegmentRequirementEndTime (IProductionRuntime)
        Sets the scheduled latest end time of the segment requirement.
      - SetSegmentRequirementOrder (IProductionRuntime)
        Sets the order of a specified segment requirement.
      - SetSegmentRequirementS95Id (IProductionRuntime)
        Sets the S95Id of a specified segment requirement.
      - SetSegmentRequirementStartTime (IProductionRuntime)
        Sets the scheduled earliest start time and end time of the segment requirement.
      - SetWorkRequestLocation (IProductionRuntime)
        Sets the equipment location for a specific work request.
      - SetWorkRequestPriority (IProductionRuntime)
        Sets the priority for a specified work request. Priorities are typically used for scheduling purposes.
      - SetWorkRequestScheduledTimes (IProductionRuntime)
        Sets the scheduled start and end date and time for a work request.
      - SetWorkRequestStatus (IProductionRuntime)
        Sets the status of a specific work request.
      - SetWorkResponseAssociatedWorkRequest (IProductionRuntime)
        Sets the associated work request of a work response.
      - SetWorkResponseState (IProductionRuntime)
        Sets the state of a work response.
      - WriteResourceActualProperties (IProductionRuntime)
        Writes properties to a specific resource actual.
      - WriteResourceRequirementProperties (IProductionRuntime)
        Writes properties to a specific resource requirement.
      - WriteWorkData (IProductionRuntime)
        Writes the values of a work data class to a specific segment response.
      - WriteWorkParameters (IProductionRuntime)
        Writes the value of specified work definition segment parameters to a process segment.
  - 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

ReadWorkRequestAttributes (IProductionRuntime)

Reads the attributes of a specific work request.

Inputs	Data Type	Description
Work Request	DirectoryResource	Specifies the work request with the attributes you want to read. 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

Work Request

DirectoryResource

Specifies the work request with the attributes you want to read.

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
WorkRequestAttributes		Attribute values of the work request.

Important: The returned 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 Work Requests.