%SYS.Task.Definition to kick off Ens.BusinessService using EnsLib.SQL.InboundAdapter

To create a task that triggers the execution of a Ens.BusinessService using the EnsLib.SQL.InboundAdapter, the general approach involves:

1. Task Definition: Using %SYS.Task.Definition to define task logic.
2. Business Service: Ensure proper configuration of the business service to use the SQL adapter.
3. Trigger Mechanism: Integrating the task and service for seamless execution.

Task Implementation:

Here’s an example approach that can address your specific use case:

• Extend %SYS.Task.Definition for custom task logic.
• Use the OnTask() method to instantiate and invoke the business service.

Class Sample.Task.TriggerSQLServiceTask Extends %SYS.Task.Definition
{
    /// The name of the Business Service to be executed
    Property BusinessServiceName As %String [Required];

    Method OnTask() As %Status
    {
        // Create BusinessService object
        #dim businessServiceInstance As Ens.BusinessService
        set tSC = ##class(Ens.Director).CreateBusinessService(..BusinessServiceName, .businessServiceInstance)
        $$$ThrowOnError(tSC)

        // Invoke the service's OnTask or similar method
        quit businessServiceInstance.OnTask()
    }
}

You define a BusinessServiceName property in the task class, which indicates the service to be triggered. When the task is executed, this task will dynamically create and execute the specified business service.

Scheduling the Task:

The service can be linked with the system’s task scheduler by defining the task scheduling parameters. The parameters will allow daily or specific-time execution of the query.

Key Considerations for Your Business Service:

• Configure the EnsLib.SQL.InboundAdapter to specify the SQL query and other relevant settings (e.g., DSN or database connectivity details).

• Use the OnProcessInput() method in the service to handle any incoming snapshots or inputs from the SQL query results. For example:

  Method OnProcessInput(pInput As EnsLib.SQL.Snapshot, pOutput As %RegisteredObject) As %Status
  {
      set req = ##class(OSU.Workday.Messages.WorkdayTerminations).%New()
      set req.EMPLID = pInput.Get("EMPLID")
      // Add additional field mappings
      ...
      quit ..SendRequestSync("TargetConfigName", req)
  }
  

Other Options:

If you do not want to handle SQL execution directly in the task but let the Business Service control it:

• Ensure the service is appropriately configured to handle its SQL logic independently.
• The task simply activates the service for its execution, relying on the internal adapter setup for query execution.

For more tailored implementation details, please refer to the examples provided in the source where tasks and services interact:

• Custom SQL adapters and Business Service connections 1.
• Methods for defining task-triggered services 21.

Sources:

For polling adapters such as EnsLib.SQL.InboundAdapter, calling the adapter's OnTask() method should trigger one run. Something like

ClassMethod CallServiceAdapter(targetConfigName As Ens.DataType.ConfigName) As %Status
{
  #Dim sc as %Status
  #Dim ex as %Exception.AbstractException

  #Dim service as Ens.BusinessService
  
  s sc = $$$OK
  try {
    $$$TOE(sc,##class(Ens.Director).CreateBusinessService(targetConfigName,.service))
    $$$TOE(sc,service.Adapter.OnTask())
  }
  catch (ex) {
    s sc = ex.AsStatus()
  }
  return sc
}

Use schedules or if you need just close enough you can do this:

• Check how much time, on average BS takes to run. Let's say X seconds.
• Set Call Interval on your BS to 86400-X.
• Start BS at 10:00 AM.
• Assuming the average runtime stays constant, it should work well enough.