Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 60 Current »

 Expand to see legends and methodology

Unable to render {include} The included page could not be found.

Go to page

TmNamespace TmContent Macro
Example
<Macro name="RetryQuery">
  <Argument>
    ...xml content
  </Argument>
  <Result>
    ...
  </Result>
</Macro>

 


Referenced by:


Namespace, TQL model content, Macro

  • TmContent.TmNamespace: nested namespace

TmDataContent (Data)
Example

<DataModel Name="Region">

            <Sid name="RegionID" />

            <String name="Name" />

            <String name="Description" />

            <BoundingBox name="Area"/>

            <Person name="Manager"/>

            <Person name="Owner"/>

</DataModel>


Referenced by:


TmDataContent

  • Inherits: Inheritance descriptor.
  • Combine:
  • TmDataAttribute: TQL data model attribute definition.
  • StandAloneConstraint: Stand-alone constraint definition.
  • TmUnique: Unique constraint definition.

TmThingContent (Thing)
Example

<ThingModel name="GPSModel" combines="GPSFacet">

            <Sid name="GPSID" />

</ThingModel>

<ThingFacet Name="GPSFacet">

    <String name="Payload" knownBy="SubscribeGPS" update="auto"/>

    <Double name="latitude" knownBy="SubscribeGPS"/>

    <Double name="longitude" knownBy="SubscribeGPS"/>

    <Number name="Direction" knownBy="SubscribeGPS" />

    <Number name="Speed" knownBy="SubscribeGPS" />

    <Boolean name="Simulated" />

    <String name="SensorURL" />

    <String name="SensorInterfaceIndex" />

    <String name="SensorInterfaceType" />

    <AA>[:#o#Output.ActionArgument:]</AA>

    <Action Name="SubscribeGPS"

            Documentation="Start the subscription to sensors data">

            ...

</ThingFacet>


Referenced by:


TmThingContent

  • Inherits: Inheritance descriptor.
  • Combine:
  • TmThingAttribute: TQL thing model attribute definition.
  • StandAloneConstraint: Stand-alone constraint definition.
  • TmUnique: Unique constraint definition.
  • TmAction: Thing action definition

TmAppContent (App)
Example

<AppModel Name="OptimumValueAlgorithmModel" combines="OptimumValueAlgorithm">

      <Sid Name="OptimumValueAlgorithmID" />

      <Integer name="currentTemp"/>

      <Integer name="currentHumidity"/>

</AppModel>


<AppFacet name="OptimumValueAlgorithm">
    <DateTime name="time" format="$SimpleDateFormat(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')"  KnownBy="RunAlgorithm"/>
        
    <Action name="RunAlgorithm">
        <Workflow Limit="1" Live="1">
            <Task name="Main" while="true">
                <Event name="Argument" as="ActionArgument"/>
                
                <!-- <Log waitFor="Argument" Message="Got Arguments : [:Event.Argument:]"/> -->
                
                <Invoke Name="CreateCommand" waitFor="Argument">
                    <JavaScript>
                        var command = "java -jar [:RuntimeParams.LibDir:]OptimumFarmValueCalculator.jar";
                        
                        var currentTemp = String(Event.Argument.currentTemp.Value);
                        var currentHumidity = String(Event.Argument.currentHumidity.Value);
                        var outputFile = String("[:RuntimeParams.ConfigDir:]OptimumFarmValues.txt");
                        
                        //sffLog.info("Before calling jar file  : " + command);
                        
                        command = command.concat(" "+currentTemp + " "+currentHumidity);
                        command = command.concat(" \"" + outputFile + "\"");
                        
                        sffLog.info("Command to call Optimum value Algorithm : " + command);
                        command;
                    </JavaScript>
                </Invoke>
                
                <Invoke name="ExecuteCommand" execute="[:Invoke.CreateCommand:]"/>
                
                <!-- <Log Message="Check Command Status : [:Invoke.ExecuteCommand:]"/> -->
                
                <Output name="Result" as="ActionResult">
                    <Value>
                        <time>[:Event.Argument.time.Value:]</time>
                    </Value>
                </Output>
                
            </Task>
        </Workflow>
    </Action>
</AppFacet>


Referenced by:


TmAppContent

  • Inherits: Inheritance descriptor.
  • Combine:
  • TmThingAttribute: TQL thing model attribute definition.
  • StandAloneConstraint: Stand-alone constraint definition.
  • TmUnique: Unique constraint definition.
  • TmAction: Thing action definition.

TmUnique
Example

<ThingFacet Name="PhidgetRFID">

    <Sid Name="RFIDId" />

    <String Name="ReadTag" Update="auto" KnownBy="PhidgetReadRFIDTagAc" />

    <String Name="WriteTag" KnownBy="PhidgetWriteRFIDTagAc" />

    <String Name="RFIDURL" Default="phid://" />

    <String Name="InterfaceType" />

    <String Name="InterfaceIndex" />

    <Unique Name="RFIDIndex" Value="InterfaceIndex" />

    <DateTime Name="timestamp" Format="$SimpleDateFormat(yyyy-MM-dd'T'HH:mm:ss'Z')" />

    <AA>[:#o#Output.ActionArgument:]</AA>

    <Action Name="PhidgetReadRFIDTagAc" Documentation="Read the Tag Automatically in the vicinity">

...

 


Referenced by:


Unique constraint definition

  • Name: Name is optional.
  • Value: List of attribute names.

TmDataAttribute
Example

<DataModel name="Sensor">

            <Attribute name="sid" value="[:DevicePath:]sid"/>

            <Attribute name="geocoordinates" value="[:DevicePath:]geocoordinates"/>

            <Attribute name="deviceType" value="[:DevicePath:]deviceType" eq="lit.Sensor"/>

            <Attribute name="deviceState" value="[:DevicePath:]deviceState"/>

            <Attribute name="providerDetails" value="[:DevicePath:]providerDetails"/>

            <Attribute name="connectivityType" value="[:DevicePath:]connectivityType"/>

            <Attribute name="label" value="[:DevicePath:]label"/>

            <Attribute name="thirdPartyId" value="[:DevicePath:]thirdPartyId"/>

            <String name="sensorType"/>

...

</DataModel>


Referenced by:


TmDataAttribute

  • Attribute: Cherry-picked attribute definition.

TmDataAtom
Example

<Def name="Manager" inherits="Employee">

  <String name="Employment.BusinnesRole" />

</Def>



Referenced by:

TmDataComposite
Example

 


Referenced by:

TmDataAdHocComposite
Example

<DataModel name="SensorModel">

            <String name="SensorID" />

            <String name="SensorValue" />

            <String name="Unit" />

            <DataModel name="Device">

                   <String name="Name" />

                   <String name="Type" />

            </DataModel>

</DataModel>

 

Referenced by:

Ad-hoc/untyped composite attribute

TmAttributeBase
Example

<Def name="StudentType" inherits="Person">

     <String name="Occupation" default="student" eq="student" cardinality="1"/>

</Def>


Referenced by:


TmAttributeBase

  • Name: Model attribute name.
  • Cardinality: Nested cardinalities are not yet supported.
  • Format: Attribute value format specifier.
  • Codec: Attribute value coder/decoder specifier.
  • InlineConstraint: Inline constraint.

TmThingAttribute
Example

<ThingFacet name="Actuator">

     <Attribute name="deviceState" value="[:DevicePath:]deviceState"/>

</ThingFacet>


Referenced by:


TmThingAttribute

  • Attribute: Cherry-picked attribute definition.

TmThingAtom
Example

<ThingFacet name="Actuator">

    <Double Name="Speed" KnownBy="StartSubscriptionAction"/>

    <Double Name="FlowRate" KnownBy="StartSubscriptionAction"/>

    <String Name="DevicePort" />

    <Number Name="Frequency" />

    <String Name="Operation" />

    <String Name="Command"/>

    <String Name="StartSubscription"  KnownBy="StartSubscriptionAction" />

    <Action name="StartSubscriptionAction">

        <Workflow Limit="1" Live="1" Timeout="-1">

            <Task name="Main">

                <Event name="Argument" as="ActionArgument" />

...

</ThingFacet>


Referenced by:


TmThingAtom

  • Update: Currently only 'auto' value is supported.
  • KnownBy: Associated action[s] name[s], comma-separated list.

TmThingComposite
Example

<ThingFacet Name="PhidgetRFID">

    <Sid Name="RFIDId" />

    <String Name="ReadTag" Update="auto" KnownBy="PhidgetReadRFIDTagAc" />

    <String Name="WriteTag" KnownBy="PhidgetWriteRFIDTagAc" />

    <String Name="RFIDURL" Default="phid://" />

    <String Name="InterfaceType" />

    <String Name="InterfaceIndex" />

    <Unique Name="RFIDIndex" Value="InterfaceIndex" />

    <DateTime Name="timestamp" Format="$SimpleDateFormat(yyyy-MM-dd'T'HH:mm:ss'Z')" />

    <Action Name="PhidgetReadRFIDTagAc" Documentation="Read the Tag Automatically in the vicinity">

        <Workflow Limit="1" Live="1" Timeout="-1">

...

</ThingFacet>


Referenced by:


TmThingComposite

  • Update: Currently only 'auto' value is supported.
  • KnownBy: Associated action[s] name[s], comma-separated list.

TmThingAdHocComposite
Example

<ThingModel name="SensorModel" combines="SensorFacet">

            <String name="SensorID" />

            <String name="SensorValue" />

            <String name="Unit" />

            <DataModel name="Device">

                   <String name="Name" />

                   <String name="Type" />

            </DataModel>

</ThingModel>


Referenced by:


Ad-hoc/untyped composite attribute

TmAction
Example

    <Action Name="PhidgetReadRFIDTagAc" Documentation="Read the Tag Automatically in the vicinity">

        <Workflow Limit="1" Live="1" Timeout="-1">

            <Task name="Main" while="true">

                <Event name="Argument" as="ActionArgument" />

                <Invoke name="ReadValue" waitFor="Argument"

                    get="[%:Event.Argument.RFIDURL.Value:%]" SerialNumber="[%:Event.Argument.InterfaceIndex.Value:%]"

                    DeviceType="[%:Event.Argument.InterfaceType.Value:%]" />

                <Output name="Result" as="ActionResult">

                    <Value>

                        <ReadTag>[%:[%:@Output:%]Invoke.ReadValue.Message.Value:%]

                        </ReadTag>

                    </Value>

                </Output>

            </Task>

        </Workflow>

    </Action>


Referenced by:


TQL model action

Condition
Example

<Def name="Employment" inherits="DataFacet">

       <WorkPlace name="Organization" cardinality="1"/>

       <String name="BusinnesRole" cardinality="1"/>

</Def>

<Def name="Person" inherits="DataModel">

       <Sid name="SSN"/>

       <GivenName name="GivenName" cardinality="1..m"/>

       <PostalAddress name="Address" cardinality="0..m"/>

       <Integer name="Age" cardinality="1" default="-1"/>

       <String name="Sex" cardinality="1"/>

       <String name="Occupation"/>

       <String name="MaritalStatus"/>

       <Unique name="FullName" value="GivenName.First, GivenName.Middle, GivenName.Last"/>

       <Unique name="Identity" value="GivenName.First, GivenName.Middle, GivenName.Last, Sex, Age"/>

</Def>

<Def name="Employee" inherits="Person">

       <Employment name="Employment" cardinality="0..m"/>

       <Reference name="Manager" type="Manager" cardinality="1"/>

 </Def>

<Def name="Manager" inherits="Employee">

          <String name="Employment.BusinnesRole" default="manager" eq="manager" cardinality="1" modifiers="hidden,readonly"/>

 </Def>

<Def name="Janitor" inherits="Employee">

       <Constraint target="Employment.BusinnesRole" eq="janitor"/>

</Def>


Referenced by:

ConditionExpression
Example

<Def name="CompanyJanitor" inherits="Employee">

       <And>

              <Constraint target="Employment.BusinnesRole" eq="janitor"/>

              <Constraint target="Employment.Organization" eq="MyCompany"/>

       </And>

</Def>


Referenced by:

ConstraintContent
Example

<Def name="PartnerEmployee" inherits="Employee">

       <Constraint target="Employment.Organization" ne="MyCompany"/>

</Def>


Referenced by:

StandAloneConstraint
Example

<Def name="Janitor" inherits="Employee">

       <Constraint target="Employment.BusinnesRole" eq="janitor"/>

</Def>


Referenced by:

NestedConstraint
Example

<Def name="CompanyVIP" inherits="Employee">

       <Or>

            <And>

              <Constraint target="Employment.BusinnesRole" ne=""/>

              <Constraint target="Employment.Organization" eq="MyCompany"/>

           </And>

           <Constraint target="Employment.BusinnesRole" eq="BoardMember"/>

     </Or>

</Def>


Referenced by:

InlineConstraint
Example

<Def name="Manager" inherits="Employee">

          <String name="Employment.BusinnesRole" default="manager" eq="manager" cardinality="1" modifiers="hidden,readonly"/>

 </Def>


Referenced by:

 

 

  • No labels