Versions Compared

Old Version 37

changes.mady.by.user Aryn Wiebe

Saved on

compared with

New Version Current

changes.mady.by.user Aryn Wiebe

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This is good example of how we can Eliminate bottlenecks with IguanaX usePrefix Namespaces for Separating Concerns by building a custom file reader component which has a simple interface for a unique purpose rather than using a general purpose no code solution - see The problem with no-code solutions.

...

Expand
titleUse +FROM URL to import a custom version of the file reader component for this tutorial

This component generates some test files to make it easier to learn how to make a custom file reader.

You can useCreate component +FROM URL to import the component.

Copy paste the URL from here:

Code Block
git@bitbucket.org:interfaceware/file_tutorial.git
Refer to Customizing components
Expand
titleClick Edit on the Customize then the Copy and Edit button so you can access the Translator and alter the code
component card, then MAKE A COPY AND EDIT to open the Translator editor

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

...

Expand
titleClick on MatchRules.lua in the Project Tree to see where we need to alter the code

Navigate to MatchRules.lua in the Project Tree. This is the function we need to alter:

Code Block
languagelua
function MatchFile(FileName)
   return true
end

The file reader component is deliberately simple and uses /wiki/spaces/IXB/pages/3181903910 separation of concerns to make it more obvious how to modify the code to meet new needs. We need this function to return true when the matching criteria are met.

Expand
titleLet's extract the filename using FILfilename() from the FIL Library, so we can look at it:

Change the matching to add in two lines so we can see the filenames we need to filter on.

Code Block
languagelua
function MatchFile(FileName)
   local JustFileName = FILfilename(FileName)
   trace(JustFileName)
   return true
end

These are the concepts we have used:

Expand
titleEdit MatchRules.lua to extract the prefixes from the custom fields

Create a second function, APPidList, to extract the ClientList prefixes from the custom fields and update MatchFile to call APPidList.

You can replace the contents of the MatchRules.lua file with this new code:

Code Block
languagelua
function APPidList()
   local IdList = component.fields()["ClientList"]
   return IdList
end

function MatchFile(FileName)
   local IdList = APPidList()
   trace(IdList)
   local JustFileName = FILfilename(FileName)
   trace(JustFileName)
   return true
end

Concepts used:

Expand
titleBreak the comma delimited string into a list to get each prefix Id

We can quickly do this by adding one line to AppidList after line 2:

Code Block
languagelua
IdList = IdList:split(",")

You should see something like:

Concepts used:

Expand
titleMake a matching function which takes the prefix and sees if the filename starts with it

Create a third function, APPmatchPrefix, to determine if the filename matches the prefix. You can copy the code below:

Code Block
languagelua
function APPmatchPrefix(Prefix, FileName)
   local Part = FileName:sub(1, #Prefix)
   trace(Part, Prefix)
   return (Part == Prefix)
end

See the screenshot below and add a line to MatchFile to call and invoke AppmatchPrefix.

Concepts used:

...

Expand
titleMake the configuration more robust by trimming the white space from the list of prefixes

This means refining the APPidList function.

That would involve looping through the list and removing white space from each ID:

Concepts:

Expand
titleCustomize the logging using iguana.log*

Add intuitive Custom Logging for your component to increase visibility into processing and adding meaningful messages to help with troubleshooting.

You can see an example of this in main.lua on line 25:

Code Block
languagelua
iguana.log("Polling every "..Polltime.." seconds");

Try it for yourself!

See Concatenating strings for a quick explanation on the double-dot notation.

Expand
titleCustomize the status using component.setStatus{data="Text"}

Add Custom Status for your component to have it display real time updates at the bottom of the component card as its running.

This component already creates custom status on lines 31-36 of main.lua.

Try it for yourself!

There is no limit to how you can streamline the usage of a custom component - if that helps address a bottleneck, then it is well worth it.  

...