Difference between revisions of "Reasoners"

From AMTech WikiDocs
Jump to: navigation, search
(Reasoner For Each Delete)
 
(119 intermediate revisions by 4 users not shown)
Line 1: Line 1:
=Reasoner by property=
+
# [[Reasoner workflow]]
==Reasoner For Each ==
+
# [[Reasoner by property]]
 
+
# [[Reasoner by Resource]]
===Reasoner For Each Create===
+
# [[Reasoner Increment, Decrement, Set]]
1-MainMenu/Activities/Reasoner
+
# [[Reasoner proximity Area]]
 
+
# [[Observation transformation]]
2-Click create
+
# [[Debug & check a reasoner]]
 
+
# [[Actions]]
3-Select For each
+
# [[Binding|Binding properties]]
 
+
# [[Execution_engine#Extension_module|Available extensions for bindings]]
3-Enter a Name
+
 
+
4-Once The Reasoner editor is open
+
 
+
5-Enter Description
+
 
+
6-Select the observer
+
 
+
7-Select Topics from where you are getting the observation
+
 
+
8-Select Action Create
+
 
+
9-Dialog Box for create will be open
+
 
+
10-Select type of entity you want to create
+
 
+
11-Enter a label to identify the action
+
 
+
12-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
+
 
+
12-Run the reasoner
+
 
+
13-Select observation from where user wants to get the info for the binding etc
+
 
+
 
+
Expected Results
+
 
+
For each entity that was returned by observer the system will create a new entity with the settings assigned
+
 
+
===Reasoner For Each Update===
+
 
+
Same steps as created but Action will be Update
+
 
+
'''Entity fields''' User will fill all the required fields to Update the Entity
+
 
+
-Run the reasoner
+
 
+
-Select observation from where user wants to get the info
+
 
+
Expected results
+
 
+
For each entity that was returned by observer the system will update the entities with the new values
+
 
+
===Reasoner For Each Delete===
+
 
+
Same steps as create just
+
 
+
-Select Action Delete
+
 
+
-Enter a name for the action Delete
+
 
+
-Click Run to run reasoner
+
 
+
- Select observation
+
 
+
Expected results
+
 
+
The system will delete all the entities returned by observer on the specified Tenant
+
 
+
===Reasoner For Each Send Notifications===
+
 
+
1-MainMenu/Activities/Reasoner
+
 
+
2-Click create
+
 
+
3-Select For each
+
 
+
3-Enter a Name
+
 
+
4-Once The Reasoner editor is open
+
 
+
5-Enter Description
+
 
+
6-Select the observer
+
 
+
7-Select Topic from where you are getting the observation
+
 
+
8-Click on Action, Select Send Notification. The dialog box to configure the action Send Notification will be open.
+
 
+
9-Enter a name for the action Send Notification, Select the Notification template, Select by property
+
 
+
10-On action on the right side select the Send Notification action inside user will see
+
 
+
Action Send Notification Fields
+
 
+
Destinatario
+
 
+
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
+
+
 
+
12-Click Run to run reasoner
+
 
+
13- Select observation
+
 
+
Expected results
+
 
+
The system will send the notification to the specified tenant according to the setting on media
+
 
+
 
+
'''Destinatario''' where user can specify the email address of the person to receive the notification
+
 
+
===Reasoner For Each Send Observations===
+
 
+
1-MainMenu/Activities/Reasoner
+
 
+
2-Click create
+
 
+
3-Select For each
+
 
+
3-Enter a Name
+
 
+
4-Once The Reasoner editor is open
+
 
+
5-Enter Description
+
 
+
6-Select the observer
+
 
+
7-Select Topic from where you are getting the observation
+
 
+
8-Click on Action and Select Send Observation action
+
 
+
9-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
+
 
+
10-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
+
 
+
11-Run the reasoner
+
 
+
13-Select observation from where user wants to get the info
+
 
+
Expected Results
+
For each entity that was returned the system will send a new observation with the information entered on new observation fields
+
 
+
===Reasoner For Each Schedule Observations===
+
 
+
==Reasoner At Least One by Properties==
+
 
+
===Reasoner At least One Create===
+
===Reasoner At least One Send Notifications===
+
===Reasoner At least One Send Observations===
+
===Reasoner At least One Schedule Observations===
+
 
+
==Reasoner Observation Only by Properties==
+
 
+
===Reasoner Observation Only Create===
+
===Reasoner Observation Only Send Notifications===
+
===Reasoner Observation Only Send Observations===
+
===Reasoner Observation Only Schedule Observations===
+
 
+
==Reasoner Do not Return Entity by Property==
+
 
+
===Reasoner Do not Return Entity Create===
+
===Reasoner Do not Return Entity Send Notifications===
+
===Reasoner Do not Return Entity Send Observations===
+
===Reasoner Do not Return Entity Schedule Observations===
+
 
+
=Reasoner by Resource=
+
 
+
==Reasoner For each Create==
+
 
+
1-MainMenu/Activities/Reasoner
+
 
+
2-Click create
+
 
+
3-Select For Each 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 Select by recurso
+
 
+
11-Select type of entity you want to create
+
 
+
12-Enter a label to identify the action
+
 
+
13-On right side click on action
+
 
+
14-Select on right side new fields and user can see he can write the info using javascript
+
 
+
example  :
+
 
+
function(newthing,observation,thing,summary){ 
+
 
+
          newthing._name ="Entity77"+ new Date().getTime().toString();
+
          newthing.DoubleData = observation.ObsDoubleData;
+
  newthing.description ="Testing Create by recurso";
+
         
+
}
+
Note: there are required fields if user does not enter them the reasoner wont run
+
 
+
15-Run reasoner
+
 
+
Expected
+
 
+
For each entity returned by observer system will create a new entity
+
 
+
==Reasoner For each Update ==
+
 
+
Same steps as Create
+
 
+
function(updatething,observation,thing){ 
+
 
+
        updatedthing.description ="Bless be the ones who serve others. They are the ones who find heaven on earth.";
+
        updatedthing.CityPopulation = 123000123;
+
 
+
}
+
 
+
Expected
+
The system will update each entity returned by the observer
+
 
+
==Reasoner For Each Send Notification ==
+
 
+
same as for each send notification by properties
+
 
+
==Reasoner For Each Delete ==
+
 
+
same as for each Delete by properties
+
 
+
==Reasoner For Each Send Observations ==
+
 
+
function(newobservation,observation,thing){ 
+
 
+
    newobservation._name = "SendObserRecurso"+ new Date().getTime().toString();
+
  newobservation.topic = observation.topic;  (Required field)
+
  newobservation.producer = observation.producer;  (Required field)
+
}
+

Latest revision as of 14:17, 14 October 2016

  1. Reasoner workflow
  2. Reasoner by property
  3. Reasoner by Resource
  4. Reasoner Increment, Decrement, Set
  5. Reasoner proximity Area
  6. Observation transformation
  7. Debug & check a reasoner
  8. Actions
  9. Binding properties
  10. Available extensions for bindings