Example Tools

There are a suite of example tools that ship with the ayx_python_sdk package. These can be used as templates for new tools.

Example Tool Descriptions

These are the example tools and their descriptions:

  1. AyxSdkInput: This is an example input tool that generates some simple data via the pandas library and outputs it on the output anchor. The tool has no input anchors, and 1 output anchor.

  2. AyxSdkOutput: This is an example output tool. It has 1 input anchor and no output anchors. The tool does not do any data processing with the input data.

  3. AyxSdkPassthrough: This is an example passthrough tool. It has 1 input anchor and 1 output anchor. This tool doesn’t do any processing, it just pushes the same data that was received on the input anchor to the output anchor.

  4. AyxSdkMultipleInputAnchors: This is a tool that has 2 input anchors and 1 output anchor. It enforces that the metadata on each anchor must be the same, and it merges the data from each input anchor on the output anchor, similar to a Union tool.

  5. AyxSdkMultipleInputMultiOutputAnchor: This tool has 2 input anchors and 2 output anchors. It enforces that the metadata on each input anchor must be the same, and it pushes the data that it receives on its input anchors to both of its output anchors.

  6. AyxSdkFilterLikeTool: This tool has 1 input anchor and 2 output anchors. Provided that the input connection’s

    metadata has an integer numeric field called “Value”, this tool will separate the records from that connection into odds and evens. NOTE: There is a known bug that causes the resulting records to be written to both output anchors.

  7. AyxSdkDoubler: This tool multiplies numeric data in the input “Value” field by 2.

  8. AyxSdkComplexConfig: This tool is an example tool that demonstrates good practices for use of the HTML GUI SDK, as well as how to handle complicated configurations in the Python code.