ComIbmDni folder in LocalEnvironment

<ComIbmDni>
  <Function>
    <DniTimer>
      <Set>
        <Request>
          <TargetService>value</TargetService>
          <Category>value</Category>
          <UserData>value</UserData>
          <WakeupInterval>value</WakeupInterval>
          <WakeupDateTime dnidt="dateTime">value</WakeupDateTime>
        </Request>
        <Response>
          <Completion>
            <Code>value</Code>
            <Reason>value</Reason>
            <Parameter1>value</Parameter1>
             ⋮
            <Parameter10>value</Parameter10>
          </Completion>
          <TimerId dt="bin.hex">value</TimerId>
          <TimerTable>value</TimerTable>
        </Response>
      </Set>
    </DniTimer>
  </Function>
</ComIbmDni>

Input

Function in ComIbmDni
  • Rep. 1
  • A folder that contains information for FTM SWIFT services.
Function in ComIbmDni
  • Rep. 1
  • A folder that contains information for and from FTM SWIFT services. The location of this folder depends on the value of the ComIbmDni.ConfigDataLoc field in the Environment tree:
    • If ConfigDataLoc is set to env, the ComIbmDni.Function folder is located in the LocalEnvironment tree.
    • Otherwise, the ComIbmDni.Function folder is located in the MQRFH2 of the message tree.
    For more information, refer to the description of the ComIbmDni.ConfigDataLoc field.
DniTimer in ComIbmDni.Function
  • Rep. 1
  • A folder that contains information of the DniTimer folder.
Set in ComIbmDni.Function.DniTimer
  • Rep. 1
  • A folder that contains the Request and Response folders for the DniSetTimer command.
Request in ComIbmDni.Function.DniTimer.Set
  • Rep. 1
  • A folder that contains the request information for the DniSetTimer request.
TargetService in ComIbmDni.Function.DniTimer.Set.Request
  • String, max. 30 characters, rep. 1
  • The name of the FTM SWIFT service to which the wake-up message is to be sent.

    The target service needs to be able to process an inbound wake-up message. For more information about how the timer wake-up processor finds and sets up the service interface queue of the target service, see Timer wake-up processor of the timer service.

Category in ComIbmDni.Function.DniTimer.Set.Request
  • String, max. 30 characters, rep. 0…1
  • A configured timer category that consists of a CO of the type DniTimer. This CO specifies the schema and table name of the timer database table to be used and the polling interval of that corresponding timer table.
UserData in ComIbmDni.Function.DniTimer.Set.Request
  • String, max. 254 characters, rep. 0…1
  • Text to be included in a wake-up message from the timer wake-up processor. You can use this text to correlate an inbound wake-up message with the event for which the timer was set.
WakeupInterval in ComIbmDni.Function.DniTimer.Set.Request
  • String, rep. 0…1
  • An interval in the format dddThh:mm:ss
    ddd
    the number of days (000 - 999)
    hh
    the number of hours (00 - 23)
    mm
    the number of minutes (00 - 59)
    ss
    the number of seconds (00 - 59)

    Specify the WakeupInterval or WakeupDateTime property.

WakeupDateTime in ComIbmDni.Function.DniTimer.Set.Request
  • dateTime, rep. 0…1
  • An absolute time, in Coordinated Universal Time (UTC).

    The node accepts any absolute time that conforms to the dateTime specification, including times in the past. It does not check whether a specified time is in the future. An entry in the timer database table created in the past causes an immediate wake-up message. When the timer wake-up processor polls the timer database table the next time, it finds this entry expired and then immediately issues a wake-up message.

    Specify the WakeupDateTimer or WakeupInterval property.

Output

Completion in ComIbmDni.Function.DniTimer.Set.Response
  • Rep. 1
  • A folder that contains information about the completion of the operation performed by the node.
Code in ComIbmDni.Function.DniTimer.Set.Response.Completion
  • String, enumerated, rep. 1
  • One of the following strings indicating success or failure:
    • Ok
    • Failed
Reason in ComIbmDni.Function.DniTimer.Set.Response.Completion
  • String, max. 20 characters, rep. 0…1
  • A more detailed reason code if the value in the Code property is not Ok. The values in the Parameter1 … Parameter10 properties can contain more information. See Codes for details.
Parameter1 … Parameter10 in ComIbmDni.Function.DniTimer.Set.Response.Completion
  • Any supported type, max. 1000 characters, rep. 0…1
TimerId in ComIbmDni.Function.DniTimer.Set.Response
  • Bin.hex, max. 68 characters, rep. 0…1
  • A unique timer identifier that is identical with the message identifier in the MQMD message header if the value in the Code field is Ok. It must be used with a subsequent Cancel Timer request to identify the timer request to be canceled. Applications can also use this identifier to correlate a wake-up message from the timer wake-up processor with an awaited event for which they have set the timer.
TimerTable in ComIbmDni.Function.DniTimer.Set.Response
  • String, max. 160 characters, rep. 0…1
  • The name of the timer database table where the timer record is stored if the value in the Code field is Ok.

An application needs to preserve the content of the TimerId and TimerTable properties if it intends to request a Cancel Timer operation.