FacetScript Language

NewFacetInstance

Create and activate new facet instance

<NewFacetInstance fid="file" name="File" type="SffHttpStaticFileFacet">

  <OnActivate>

    <Process BasePath="web" Resource="res"/>

  </OnActivate>

</NewFacetInstance>

DelFacetInstance

Deactivate and remove facet instance

NewPackage

Process and deploy new package (i.e. a collection of related facet instances)

name

Facet instance name. Names can be used to refer to facet instances from within facet script. Note that local facets (i.e. facet instances defined within other facets) do not have facet IDs and can be only referenced by their names

<Macro Name="executeQuery">

  <Argument>

    <QueryString>

      <Query />

    </QueryString>

  </Argument>

  <Result>

    <DoRequest target="[:RuntimeParams.FacetIDName:]">

      <Process>

        <Message>

          <Value>[:$Macro.Argument.QueryString:]</Value>

        </Message>

      </Process>

    </DoRequest>

  </Result>

</Macro>

fid

Facet ID. The most important facet instance’s attribute. All global facet instances are accessible only via their IDs. Facet IDs also can be used to reference facet instance from within facet script (i.e. from another facet instance)

<Macro Name="executeQuery">

  <Argument>

    <QueryString>

      <Query />

    </QueryString>

  </Argument>

  <Result>

    <DoRequest target="[:RuntimeParams.FacetID:]">

      <Process>

        <Message>

          <Value>[:$Macro.Argument.QueryString:]</Value>

        </Message>

      </Process>

    </DoRequest>

  </Result>

</Macro>

type

Facet type. This must resolve to a java class implementing Facet Service interface. The concrete way how mapping is done is implementation dependent. SFF engine uses java simple class names to map to classes

Message        → SffMsgFacet            → Generic Message Communication.

Network          → SffNetworkFacet      → TQLEngine cluster support. Define the list of TQLEngine(s) that  can participate in syncing their data

Tql                   → SffTqlFacet             → Thing Query Language Support (Thing Definition, Thing Interaction)

Workflow          →   SffWdlFacet         → Workflow Language Support

Behavior Trees → SffBdlFacet            → Behavior Tree Implementation

Topic                 → SffTopicFacet         → Subscription and Notification of Model changes

Scheduling        →  SffSequenceFacet  → Schedule tasks / jobs (piece of Model code) to be executed in a repeated sequence of defined interval.

Static Files        → SffStaticFileFacet     → Serve static files using TQLEngine.

OnActivate

OnOpen

OnRequest

OnResponse

OnClose

OnDeactivate

Facet lifecycle events entries. Each entry contains a facet script to execute upon the event

Process

Specifies actual event method argument. Argument can be either a primitive value or a data structure

ModifyPipeline

Modifies underlying Netty pipeline with given set of handlers. This is often used to configure a generic pipelines to a specific protocol (e.g. HTTP or WebSocket)

CreatePipeline

Creates a “fake” Netty pipeline (i.e. a pipeline not associated with an incoming request). Such pipelines are used to work with internal event sources like timer or USB reader, for example

SetDefault

Set default message attributes

<if condition="$Request/URI = 'favicon.ico'">

  <then>

    <DoRequest target="file"/>

  </then>

  <else>

    <DoResponse>

      <Process>

        <Message type="xml">

          <Value>

            <Echo>

              <Random>

                [:[:@RT:]$JexlScript:(math:random()):]

              </Random>

              <RequestCount>

                [:$PolicyData.MyMetering.RequestCount:]

              </RequestCount>

              <Include>

                $Request

              </Include>

            </Echo>

          </Value>

        </Message>

      </Process>

    </DoResponse>

  </else>

</if>

<select by="[:$Request.URI:]">

  <case when="favicon.ico">

    <DoRequest target="file"/>

  </case>

  <default>

    <DoResponse>

      <Process>

        <Message type="xml">

          <Value>

            <Echo>

              <RequestCount>

                [:$PolicyData.MyMetering.RequestCount:]

              </RequestCount>

              <Include>

                $Request

              </Include>

            </Echo>

          </Value>

        </Message>

      </Process>

    </DoResponse>

  </default>

</select>

<Schedule after="PT5S" period="PT10S">

  <DoResponse target="ws:*">

    <Process>

      <Message type="text">

        <Value>

          grid_1

        </Value>

      </Message>

    </Process>

  </DoResponse>

</Schedule>