Difference between revisions of "Reasoner by property"

From AMTech WikiDocs
Jump to: navigation, search
(Created page with "by property ==Reasoner For Each == for each === Create===...")
 
(Schedule Observations)
 
(7 intermediate revisions by 2 users not shown)
Line 35: Line 35:
 
Reasoner for Each Update by property:
 
Reasoner for Each Update by property:
  
For each entity that was returned by observer the system will update the entities with the new values
+
For each thing returned by observer the system will update the thing with the new values
  
 
Same steps as created but Action will be Update
 
Same steps as created but Action will be Update
  
  '''Entity fields''' User will fill all the required fields to Update the Entity
+
  '''Thing fields''' User will fill all the required fields to be updated
  
 
* Run the reasoner
 
* Run the reasoner
Line 47: Line 47:
 
Reasoner For each Delete by property
 
Reasoner For each Delete by property
  
The system will delete all the entities returned by observer on the specified Tenant
+
The system will delete all the things returned by observer on the specified Tenant
  
 
Same steps as create just  
 
Same steps as create just  
Line 82: Line 82:
  
 
  '''Notification Fields''' User will assign values to the place holders of the notification templates
 
  '''Notification Fields''' User will assign values to the place holders of the notification templates
note: If the notification template does not have placeholder there will not be notification fields
+
 
 +
{{Note|If the notification template does not have placeholder there will not be notification fields.}}
 
   
 
   
 
* Click Run to run reasoner
 
* Click Run to run reasoner
Line 113: Line 114:
 
Reasoner For each Send Schedule Observations by properties
 
Reasoner For each Send Schedule Observations by properties
  
For each entity that was returned the system will schedule to send a new observation with the information entered on the settings
+
For each thing returned the system will schedule to send a new observation with the information entered on the settings
  
  
Line 142: Line 143:
 
           Occurrence 1 frequency will be ignore. The system will send that schedule observation on the Start Date and Time only once
 
           Occurrence 1 frequency will be ignore. The system will send that schedule observation on the Start Date and Time only once
  
           Occurrence 2 or more must enter frequency. The system will send the observation according to frequency and Start Date and Time. An example if observer return two entities or things and start time is 10:22 am occurrence is 2 and frequency is 2 mins. the system will send 2 observations at 10:22 am and will send another 2 observations at 10:24 am
+
           Occurrence 2 or more must enter frequency. The system will send the observation according to frequency and Start Date and Time. An example if observer return two things and start time is 10:22 am occurrence is 2 and frequency is 2 mins. the system will send 2 observations at 10:22 am and will send another 2 observations at 10:24 am
  
 
   Years
 
   Years
Line 209: Line 210:
 
  Notification Fields User will assign values to the place holders of the notification templates
 
  Notification Fields User will assign values to the place holders of the notification templates
  
notes:If the notification template does not have placeholder there will not be notification fields
+
{{Note|If the notification template does not have placeholder there will not be notification fields.}}
 
   
 
   
  
Line 232: Line 233:
 
The same as send observation on Action select schedule observations user just need to specify Initiation Date and time, occurrence and frequency
 
The same as send observation on Action select schedule observations user just need to specify Initiation Date and time, occurrence and frequency
  
'''Note:'''
+
{{Note|
 
+
:Occurrence 0 must enter frequency like; sec, mins, hours etc If user for example enters frequency days that means observation will be send every day forever Starting on the Start date and Time
Occurrence 0 must enter frequency like; sec, mins, hours etc If user for example enters frequency days that means observation will be send every day forever Starting on the Start date and Time
+
:Occurrence 1 frequency will be ignore. The system will send that schedule observation on the Start Date and Time only once
 
+
:Occurrence 2 or more must enter frequency. The system will send the observation according to frequency and Start Date and Time}}
Occurrence 1 frequency will be ignore. The system will send that schedule observation on the Start Date and Time only once
+
 
+
Occurrence 2 or more must enter frequency. The system will send the observation according to frequency and Start Date and Time
+
  
 
'''Expected'''
 
'''Expected'''
Line 353: Line 351:
 
  Notification Fields User will assign values to the place holders of the notification templates
 
  Notification Fields User will assign values to the place holders of the notification templates
  
notes:If the notification template does not have placeholder there will not be notification fields
+
{{Note|If the notification template does not have placeholder there will not be notification fields.}}
 
   
 
   
  
Line 386: Line 384:
 
* On action on the right side select the Schedule Observation  inside will be a list of fields :  
 
* On action on the right side select the Schedule Observation  inside will be a list of fields :  
 
*: user needs to specify Initiation Date and time, occurrence and frequency
 
*: user needs to specify Initiation Date and time, occurrence and frequency
*: '''Note:'''
+
*: {{Note|
*: Occurrence 0 must enter frequency like; sec, mins, hours etc If user for example enters frequency days that means observation will be send every day forever Starting on the Start date and Time
+
*:: Occurrence 0 must enter frequency like; sec, mins, hours etc If user for example enters frequency days that means observation will be send every day forever Starting on the Start date and Time
*: Occurrence 1 frequency will be ignore. The system will send that schedule observation on the Start Date and Time only once
+
*:: Occurrence 1 frequency will be ignore. The system will send that schedule observation on the Start Date and Time only once
*: Occurrence 2 or more must enter frequency. The system will send the observation according to frequency and Start Date and Time
+
*:: Occurrence 2 or more must enter frequency. The system will send the observation according to frequency and Start Date and Time}}
 
* Run the reasoner
 
* Run the reasoner
 
* Select observation from where user wants to get the info
 
* Select observation from where user wants to get the info

Latest revision as of 22:37, 20 October 2016

by property

Reasoner For Each

for each

Create

Reasoner For each create by property :

For each entity that was returned by observer the system will create a new entity with the settings assigned

  1. MainMenu/Activities/Reasoner
  2. Click create
  3. Select For each
  4. Enter a Name
  5. Once The Reasoner editor is open
  6. Enter Description
  7. Select the observer
  8. Select Topics from where you are getting the observation
  9. Select Action Create
  10. Dialog Box for create will be open
  11. Select type of entity you want to create
  12. Enter a label to identify the action
  13. On action on the right side select The Action label for Create inside will be a list of fields :
    Continue on failure is a boolean true or false. User can said if he wants to continue even if there is failure.
    Update if exist is a boolean or or false. If true user can update any fields
    New Entity fieldsUser will fill all the required fields to Create the new Entity
    ReasonerForEachCreateContfailureUpdateIfExist.png
    ReasonerForeachCreateFillingFields.png
  14. Run the reasoner
  15. Select observation from where user wants to get the info for the binding etc

Update

Reasoner for Each Update by property:

For each thing returned by observer the system will update the thing with the new values

Same steps as created but Action will be Update

Thing fields User will fill all the required fields to be updated
  • Run the reasoner
  • Select observation from where user wants to get the info

Delete

Reasoner For each Delete by property

The system will delete all the things returned by observer on the specified Tenant

Same steps as create just

  • Select Action Delete
  • Enter a name for the action Delete
  • Click Run to run reasoner
  • Select observation

Send Notifications

Reasoner for each Send Notifications by properties

The system will send the notification to the specified tenant according to the setting on media

Same steps as Create

  • On Action, Select Send Notification. The dialog box to configure the action Send Notification will be open.
  • Enter a name for the action Send Notification, Select the Notification template, Select by property
  • On action on the right side select the Send Notification action inside user will see

Action Send Notification Fields

Destinatario where user can specify the email address of the person to receive the notification

Media

”dap” to display the notification on the screen of tenant only

”mail” notification by mail only

”dap,mail”by mail and screen both

Continue on failure is a boolean true or false. User can said if he wants to continue even if there is failure
Notification Fields User will assign values to the place holders of the notification templates

Note: If the notification template does not have placeholder there will not be notification fields.

  • Click Run to run reasoner
  • Select observation

Send Observations

Reasoner For each Send Observations by properties

For each entity that was returned the system will send a new observation with the information entered on new observation fields

Same steps as Create

  • On on Action and Select Send Observation action
  • Dialog box for the settings for the action will be open, select the type of observation, select by property and Enter a name for the Observation to be send
  • On action on the right side select the Send Observation inside will be a list of fields :

Action Send Observation Fields

  Tenant Binding where user will specify in which Tenant he wants to send the Observation
  Continue on failure is a boolean true or false. User can said if he wants to continue even if there is failure
   New Observation fields User will fill all the required fields to send that observation
  • Run the reasoner
  • Select observation from where user wants to get the info

Schedule Observations

Reasoner For each Send Schedule Observations by properties

For each thing returned the system will schedule to send a new observation with the information entered on the settings


ReasonerForEachScheduleObs.png


  • Select Action Schedule Observation
  • Enter a name for the Schedule
  • Select the type of Observation to be send
  • On action on the right side select the Schedule Observation inside will be a list of fields :
ReasonerForEachScheduleSEndObs.png
 Identifier To ID this task inside the system
StartDate it is the time and date to start sending the scheduled observation
 seconds definition to the level of seconds to send the observation
 Minutes  definition to the level of minutes to send the observation
 hours   definition to the level of Hours to send the observation
 days
  months

Occurrence 0 must enter frequency like; sec, mins, hours etc If user for example enters frequency days that means observation will be send every day forever Starting on the Start date and Time

          Occurrence 1 frequency will be ignore. The system will send that schedule observation on the Start Date and Time only once
          Occurrence 2 or more must enter frequency. The system will send the observation according to frequency and Start Date and Time. An example if observer return two things and start time is 10:22 am occurrence is 2 and frequency is 2 mins. the system will send 2 observations at 10:22 am and will send another 2 observations at 10:24 am
 Years
 Continue on failure is a boolean true or false. User can said if he wants to continue even if there is failure
 New Observation fields User will fill all the required fields to send that observation
  • Run the reasoner
  • Select observation from where user wants to get the info

Reasoner At Least One

Create

ReasonerAtLeastOneCreate.png

Reasoner At least One Create by property:

If observer return at least one entity the system will create a new entity with the settings assigned

  1. MainMenu/Activities/Reasoner
  2. Click create
  3. Select At least one entity
  4. Enter a Name
  5. Once The Reasoner editor is open
  6. Enter Description
  7. Select the observer
  8. Select Topic from where you are getting the observation
  9. Select Action Create
  10. Dialog Box for create will be open
  11. Select type of entity you want to create
  12. Enter a label to identify the action
  13. On action on the right side select The Action label for Create inside will be a list of fields :
    Tenant Binding, where user will specify in which Tenant he wants to Create the Entity
    Continue on failure is a boolean true or false. User can said if he wants to continue even if there is failure
    New Entity fields User will fill all the required fields to Create the new Entity
  14. Run the reasoner
  15. Select observation from where user wants to get the info for the binding etc

Send Notifications

Reasoner At Least One Send Notifications

If observer return at least one entity The system will send the notification to the specified tenant according to the setting on media

Same steps as create just Select action Send Notification and select the template for the notification

On action on the right side select the Send Notification action inside user will see:

  Tenant Binding, where user will specify in which Tenant he wants to send the notification
   Destinatario, where user can specify the email address of the person to receive the notification
   Media has three options
     -”dap” to display the notification on the screen of tenant only
     -”mail” notification by mail only
     -”dap,mail” by mail and screen both
  Continue on failure is a boolean true or false. User can said if he wants to continue even if there is failure
Notification Fields User will assign values to the place holders of the notification templates

Note: If the notification template does not have placeholder there will not be notification fields.


Click Run to run reasoner

Select observation

Send Observations

Reasoner At Least One SEnd Observations

If observer return at least one entity The system will send a new observation with the information entered on new observation fields

Same as create just select Action send Observation, Then select the type of observation you want to send Assign values on the right side to the observation fields

  • Run the reasoner
  • Select observation from where user wants to get the info

Schedule Observations

The same as send observation on Action select schedule observations user just need to specify Initiation Date and time, occurrence and frequency

Note:

Occurrence 0 must enter frequency like; sec, mins, hours etc If user for example enters frequency days that means observation will be send every day forever Starting on the Start date and Time
Occurrence 1 frequency will be ignore. The system will send that schedule observation on the Start Date and Time only once
Occurrence 2 or more must enter frequency. The system will send the observation according to frequency and Start Date and Time

Expected

If Observer return at least one entity the system will Schedule to send a new Observation

Reasoner Observation Only

Create

  1. MainMenu/Activities/Reasoner
  2. Click create
  3. Select Only Observation
  4. Enter a Name
  5. Once The Reasoner editor is open
  6. Enter Description
  7. Select the observer
  8. Select Topic from where you are getting the observation
  9. Select Action Create
  10. Dialog Box for create will be open
  11. Select type of entity you want to create
  12. Enter a label to identify the action
  13. On action on the right side select Enter Info for required fileds to Create the new Entity
  14. Run the reasoner
  15. Select observation from where user wants to get the info for the binding etc

Expected results

If Observer results is positive The system will Create a new Entity with the information entered on the settings

Send Notifications

  • Enter a name for the action Send Notification
  • Select the notification template
  • On action on the right side select the Send Notification .Enter info
  • Click Run to run reasoner
  • Select observation

Expected results

If the run of observer is positive The system will send the notification to the specified tenant according to the setting on media

Send Observations

  • Select Action Send Observation
  • Enter a name for the Observation
  • Select the type of Observation to be send
  • On action on the right side select the Send Observation inside will be a list of fields :
  • Filelds are the same for all sendObservation
  • Run the reasoner
  • Select observation from where user wants to get the info

Expected results

If the run of observer is positive The system will send a new observation with the information entered on new observation fields

Schedule Observations

function(newobservation,observation){ 
       newobservation._name = "ScheduleSendObserRecursoObsOnly";
       newobservation.topic = observation.topic;  
       newobservation.producer = observation.producer; 
}

Expected If the run of Observer is positive the system will Send the observation

according to the schedule

Reasoner Absence of Things

Create

  1. MainMenu/Activities/Reasoner
  2. Click create
  3. Select Observer does not return Entity
  4. Enter a Name
  5. Once The Reasoner editor is open
  6. Enter Description
  7. Select the observer
  8. Select Topic from where you are getting the observation
  9. Select Action Create
  10. Dialog Box for create will be open
  11. Select type of entity you want to create
  12. Enter a label to identify the action
  13. On action on the right side select The Action label for Create inside will be a list of fields :
    Fields are the same for all create actions
  14. Run the reasoner
  15. Select observation from where user wants to get the info for the binding etc

Expected results

If observer run is positive and does not return Entity the system will create a new entity with the settings assigned

Send Notifications

Same steps as create just Select action Send Notification and select the template for the notification

On action on the right side select the Send Notification action inside user will see:

  Tenant Binding, where user will specify in which Tenant he wants to send the notification
   Destinatario, where user can specify the email address of the person to receive the notification
   Media has three options
  • ”dap” to display the notification on the screen of tenant only
  • ”mail” notification by mail only
  • ”dap,mail” by mail and screen both
  Continue on failure is a boolean true or false. User can said if he wants to continue even if there is failure
Notification Fields User will assign values to the place holders of the notification templates

Note: If the notification template does not have placeholder there will not be notification fields.


Click Run to run reasoner

Select observation

expected results

In absence of entities .The system will send the notification to the specified tenant according to the setting on media

Send Observations

Select Action Send Observation

  • Enter a name for the Observation
  • Select the type of Observation to be send
  • On action on the right side select the Send Observation inside will be a list of fields :
  • Enter values for those fields
  • Run the reasoner
  • Select observation from where user wants to get the info

expected results

If observer run is positive and does not return Entity The system will send a new observation with the information entered on new observation fields

Schedule Observations

  • Select Action Schedule Observation
  • Enter a name for the Schedule
  • Select the type of Observation to be send
  • On action on the right side select the Schedule Observation inside will be a list of fields :
    user needs to specify Initiation Date and time, occurrence and frequency
    Note:
    Occurrence 0 must enter frequency like; sec, mins, hours etc If user for example enters frequency days that means observation will be send every day forever Starting on the Start date and Time
    Occurrence 1 frequency will be ignore. The system will send that schedule observation on the Start Date and Time only once
    Occurrence 2 or more must enter frequency. The system will send the observation according to frequency and Start Date and Time
  • Run the reasoner
  • Select observation from where user wants to get the info

Expected results

If observer run is positive and does not return Entity . The system will schedule to send a new observation with the information entered on the settings