Page Comparison

...

Let's set up a simple filter component that parses a JSON object and ignores data with emails not containing the "interfaceware.com" domain name.

Expand

title	Import the JSON Filter Tutorial component using +FROM URL

UseCreate component +FROM URL to import the component.

Copy paste the following URL:

Code Block
git@bitbucket.org:interfaceware/json_tutorial.git

This component includes Sample Data to make it easier to learn how to filter messages.

Expand

title	Click on the Customize then the Copy and Edit button so you can access the Translator and alter the code

Refer to Customizing components Edit a Component to see how it's done if you have not done this before.

Expand

title	Use the Annotation Window to view your sample data in the String Viewing Window

Now we are in the Developing in the Translator!

Every Translator component contains a Main.lua module with a main Functions that is called each time a message is received or on a configured poll time.

Notice we can see our sample data (Variables named Data) passed to the main functionby looking at the Annotation Windows.

If we click on the sample data in the annotations, we can view it using The string viewing window.

Expand

title	Parse the JSON sample data using json.parse{data=Data}

In main, parse the JSON sample data by passing Data. Create and assign the parsed data to a patient variable.

Code Block

language	lua

local patient = json.parse{data=Data}

JSON objects are parsed into Lua tables as dictionaries with key-value pairs. You can see this clearly by clicking the resulting table in the Annotation Window.

Expand

title	Create a filter.lua module to start building a filter function

Use the Create a File button to create a new filters.lua file in your Project Tree. Click Create.

Notice that when you create a new lua file, Iguana will automatically add a Require Statement to main.lua.

Image Added

Expand

title	Create a filter function in filters.lua

Notice we are brought to an empty filters.lua script in the project tree. Lets add our filtering logic:

First, create a filter function Block statements and pass patient as the parameter.

Code Block

language	lua

function filter(patient)
   
end

Then go into main and call your filter function, passing your parsed patient JSON as the expected parameter.

Image Added

Notice after calling our filter function,

Navigate back to the filter.lua by clicking the purple filter in the Annotation Windows, notice there is now an annotation block we can use to add the rest of the logic.

Expand

title	In our filter function, first split the patient contact email to isolate the email domain names name

Using String:split(), we can split the email on “@“ and get the domain name.

Try this code and take a look at your annotations to see the result:

Code Block

language	lua

local email = patient.contact.email
local domain = email:split("@")[2]
trace(domain)

Specifying the second result [2] of the split table, I can capture just the domain name.

Expand

title	Use an if statement to ignore email domains test if an email domain does not equal to "interfaceware.com"

Using if statements, we can test conditions to be false and filter out data we are not interested in processing. For example, say we only want to process data including the interfaceware domain. :

Image Added

Now lets go back to main and change the way we are calling our filter function to address the boolean values (true/false) being returned.

Expand

title	Use another if statement in main to test if a message should be queued or filtered out

Your main function should look like this:

Image Added

This if statement is testing if the filter function returns true - the domain name equalled “interfaceware.com” - then queue the message to be processed by the next component.

See Push Messages to a Component Queue.

Expand

title	Now let's see our filtering in action by going through the sample data and viewing the annotations

By switching which Sample Data is being passed to main, we can see the results and test how our filter function works, by using the annotations.

Navigate to filters.lua and switch to the second sample data to see the sample message fail the condition and return false.

Image Added

Now lets see our filtering in action by flipping through the sample data and viewing the annotations.

Expand

title	Add custom logging to your filter to make it more comprehensive

title

Now that the annotations are active for the failed scenario, we can leverage them to add Custom Logging to add more visibility into the logs.

For example,

Code Block

language	lua

if domain == 'interfaceware.com' then
  queue.push{data=Data}
else 
  return -- skip processing this message
end

See How to push messages into a queue?

Expand

return true
else 
  iguana.log('Filtered out message with: '..domain)   
  return false
end

You’re done the filter! Don’t forget to Commit and Push Changes to Git.

Now back to the Orientation!

Versions Compared

Old Version 14

New Version Current

Key