×

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
IDatabaseService
IDatabaseService provides access to relational data, such as databases.
ExecuteProcedure (IDatabaseService)
Executes a stored procedure against a database connection, and provides for returning results in either the actual format(s) of the specified parameter(s) or in string format.

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.
    - ExecuteProcedure (IDatabaseService)
      Executes a stored procedure against a database connection, and provides for returning results in either the actual format(s) of the specified parameter(s) or in string format.
    - ExecuteStatement (IDatabaseService)
      Executes a query or update statement against a database connection, and provides for returning results in either the actual format(s) of the specified parameter(s) or in string format.
  - 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.
  - 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

ExecuteProcedure (IDatabaseService)

Executes a stored procedure against a database connection, and provides for returning results in either the actual format(s) of the specified parameter(s) or in string format.

In the Configure Method dialog box, click Next to select the connection and procedure. Next, specify whether you want results returned in the actual format(s) of the parameter(s) in question (Return typed values, the default) or string format (Return values as strings), and then click Finish. Your connection and procedure selections determine the specific input parameters for the method, which you configure in the Inputs section of the activity configuration panel.

Note: Beginning with release 2.2 SP1, this method includes a new parameter (ConvertValues) that allows you to specify whether returned values should be automatically converted to string format, as was done in past releases. Prior implementations of this method will continue to function as in the past.

Inputs	Data Type	Description
Connection	DirectoryResource	Specifies the database connection that is used to execute a particular stored procedure.
ProcedureName	String	Specifies the name identified for a specific procedure.
ConvertValues	Boolean	Specifies whether to convert returned values to string format. Options are as follows: False, to leave returned values in their native data formats (the default). Note: In the Configure Method dialog box, this option equates with Return typed values. True, to convert returned values from their native data formats to string format. Note: In the Configure Method dialog box, this option equates with Return values as strings.
Inputs	List<Parameter>	Specifies a collection of input parameter values and output parameter initial values that can be passed to a database connection to execute a stored procedure.

Outputs	Data Type	Description
ReturnValue	StoredProcedureExcutionResult	The execution result, including execution time, collection of output parameter values, and collection of DataTable (Result), of the stored procedure against a particular database. Note: Data transfer limit: 10 MB.