Integration Toolkit wiki - setup discussion

According to Editing and creating wiki posts - Using Discourse - Discourse Meta I should be able to convert this post into a wiki post when I've saved it.


Yup. 1, 2.


Click the wiki icon to edit.

Michael: It Works! But how messy can/will it get?

Transistor: This is related to posting working examples for Phil's Integration Toolkit as discussed over in Automation Professionals' Integration Toolkit Module - #270 by Transistor. I think that it would need its own category rather than have them jumbled in with other stuff.

1 Like

Looks good. I will make one in the 3rd party modules category for the toolkit.

Done: Integration Toolkit Solutions Wiki

But wouldn't you need a post per function to keep it somewhat organized and not one large post? And even then, they'll get buried based on how long since someone edited/posted to it. (Discourse doesn't really seem like the right tool for the job).

I had forgotten about this, but I started making a wiki for myself that I was gonna build up with a bunch of Ignition stuff on my homelab server that I never got around to actually adding much.

I can open it up (PM me if anyone wants a login to write posts).

I just made an Automation Professionals "book" if we want to test/play.

That was my idea. I suggested one thread per function (or maybe groups of similar / related functions) but Phil suggests that many examples will rely on multiple functions all at once and that it would be something like "task" based. I'm not sure how easy it would be to find what one was looking for.

Take a look at the editing guidelines I laid down...

Looks like it would be a good start. Really, once converted to Wiki style, if someone doesn't follow the style, it can be cleaned up by others, or tweaks to the style can be made afterward.

So, looking at your example, and a newbie trying to figure out what each function is actually doing, would it be helpful (I think it would be) to maybe give an explanation as to how it's functioning. For example:

Usage Explanation

forEach() - Iterates through each row of the dataset
asMap() - Maps the values of the cells in each row as a key-value pair with the key being the column name.
it() - Returns the index of each row so that the dataset is ordered properly??? (I really don't know on this one, which is why I'm asking if this would help, and I may be completely wrong on my previous assumptions as well)

1 Like

Please make the edits. (:

{ it() delivers the subject row of the source dataset as a single row. asMap() converts one row of a dataset to key-value pairs. }

I was going to, but didn't want to put wrong information on it (although I guess if I did, someone would correct me).

So the forEach() just kinda re-assembles the results from the asMap() ?

Ok, made an edit....we'll see how well I did. :slight_smile:

Not bad. Probably would look nicer if the usage was in the same bullet list as the features employed. (Would be worth looking at the Iterables link I just added to better understand what forEach() is doing.

The forEach() makes a list of the mappings from calling asMap() on each row.

I made a tweak after you added your iterable link. I think my explanation is a little closer now, but I could still be off.

I fleshed out the features used list--you can probably drop the usage section now.

I like it!

Should we add the line,
// This expression uses Integration Toolkit functions.
as a header to each piece of sample code to encourage documenting the fact in projects? Someone maintaining a project wouldn't find any help in the IA documentation.

Sounds like bloat. Heavy users of the toolkit will figure it out pretty quickly, especially if they come to the forum.

Pssst! You didn't make your new comment a wiki....

2 Likes

I wanted to do something like this for the CSS Useful Stuff topic I created, to avoid all the chatter surrounding the useful posts. Maybe I should convert that post to a wiki instead...

Eh, I don't immediately love it. I like the idea of keeping the body of knowledge on the forum but I'm not sure how well the wiki thread will scale; I guess if you let the search function to the heavy lifting it could be fine.

I'll keep my mess of Embr threads for now and let you prove out this idea :wink:

2 Likes

If it gets unwieldy, I could probably add something like this:

3 Likes

There's always the option to split into more topics with a finer focus.

1 Like