Image Tool
Image Tool
One Tool Example
The Image tool has a One Tool Example. Go to Sample Workflows to learn how to access this and many other examples directly in Alteryx Designer.
Use Image to make it possible for an image to be output in a report via the Render tool. The image can be retrieved from the disk at run time, or a static image can be stored in the workflow. This tool doesn't require an input connection and supports PNG, JPG, and GIF file formats.
Configure the Tool
Retrieve Image From Disk At Runtime: Retrieve an image from a specified path when the workflow runs. When there is no incoming data, the tool retrieves a single image. When the tool has incoming data, it displays an image for each record.
Filename: Enter the directory path to the image or browse to the file.
Modify filename for each record: Check this box to edit the filename based on other field data when the input data includes the file path or file names of the images to be added to the report. Then, use the Modify Filename By to select from...
Appending Field to Filename: Select this option to add a value from a field/column to the end of the image file name. Select the field via the Using This Field dropdown. The Filename box can include a relative path (
.\data\images\image.jpg). In this example, the Filename is replaced with the Image File Name + the appended Image Name.Image Name
Image File Name
File Name with Appended Field Value
Pineapple
image.jpg
imagePineapple.jpg
Banana
image.jpg
imageBanana.jpg
Apple
image.jpg
imageApple.jpg
Prepending Field To Filename: Select this option to add a value from a field/column to the beginning of the image file name. Select the field via the Using This Field dropdown. The Filename box can include a relative path (
.\data\images\image.jpg) In this example, the Filename is replaced with the prepended Image Name + Image File Name.Image Name
Image File Name
File Name with Prepended Field Value
Pineapple
image.jpg
Pineappleimage.jpg
Banana
image.jpg
Bananaimage.jpg
Apple
image.jpg
Appleimage.jpg
Replacing Filename With Field: Changes the filename to the value of the selected field. The Filename box can include a relative folder path (
.\data\images\) and the filename is added using the Image File Name.Image File Name
Replaced File Name
Pineappleimage.jpg
.\data\images\Pineappleimage.jpg
Bananaimage.jpg
.\data\images\Bananaimage.jpg
Appleimage.jpg
.\data\images\Appleimage.jpg
Replacing Entire Path With Field: Changes the entire path to the value of the selected field. The Filename box can be blank because the entire file path is included in the Image File Name field, which is used to retrieve the images.
Image File Name
.\data\images\Pineappleimage.jpg
.\data\images\Bananaimage.jpg
.\data\images\Appleimage.jpg
Stop With Error If File Not Found: Stops the workflow processing and displays an error when the specified image cannot be found.
Store Static Image In Workflow: Saves an image with the workflow so that the workflow can be shared as a single file. When the image is added, the width, height, format, size, and thumbnail display. The image file size is added to the workflow file size. When using a static image, an error displays if the image is over 100KB to caution about the size that will be added to the saved workflow.
Get Image from Binary Data in Field: Using the Image Field (Blob): dropdown, select the column that contains a blob that represents the image.
Edit Image Settings: Select to modify the style options for the image. Visit Image Settings Style Editor for details.
Use Fixed Width: Select to specify a fixed width for the image.
Image Width: Enter the width of the image in pixels.
Show Border: Select to add a border around the image.
Border Width: Enter the width of the border in pixels.
Border Color: Select the color of the border.