Skip to content

Jitterbit Documentation Image Processor

Introduction

The Jitterbit Documentation Image Processor assists in the creation of the images used in the documentation that Jitterbit publishes on each of its connectors. The Image Processor is a tool used to modify PNG screenshot images of the configuration of a connector’s connection and its activities. This utility crops and renames images in a manner consistent with the standard formats used by Jitterbit in its documentation.

Note

The tool available from this page is supplied without warranty or support, and is used under license from Jitterbit, Inc. See the tool installer for the license for the tool.

Jitterbit Documentation Image Processor

Download

The Image Processor is available for either the macOS or Windows operating systems. Download an appropriate installer package from either of these links:

Installation

The application is packaged using an installer appropriate for the operating system. Open the installer and follow its prompts to install the application.

When running on Windows, before creating screenshots, the Display Settings need to be a Scale and layout of 100%. For both the macOS and Windows operating systems, the default scaling and color settings should be used to produce images that are consistent with the other images used in Jitterbit documentation.

Intent of the Tool

The intent of the tool is two functions: image cropping and image renaming. Image cropping crops images to match conventions used at Jitterbit when documenting connectors. Image renaming names images following similar conventions that make it possible to generate and manage connector documentation in an automated and consistent fashion.

Image Cropping

There are two different types of images that are commonly used in Jitterbit connector documentation:

  • an operation image
  • a connection or activity image

Operation Image

An operation image is characterized as being an image of a complete Jitterbit Harmony Cloud Studio operation, and a screenshot of an operation is white in all four corners. In the Jitterbit documentation, these are named following the pattern of <connector-name>-<activity-name>-operation.png and cropped tight. These are referred as type O images:

Before cropping:

Coupa Query Activity Operation (Original)

After cropping:

Coupa Query Activity Operation

Connection or Activity Image

A connection or activity image is characterized as being an image of a Jitterbit Harmony Cloud Studio connection or a step of an activity configuration. A screenshot image is “Cloud Studio beige” in all four corners, with a large X in the upper right-hand corner.

In the Jitterbit documentation, for connection configuration images these are named following the pattern of <connector-name>-configuration.png.

For activity steps, these are named following the pattern of <connector-name>-<activity-name>-activity-<step-number>.png and cropped with specific margins around the image elements. As they all have a common element of an upper right-hand corner “X”, these are referred as type X images:

Before cropping:

Coupa Query Activity Step 1 (Original)

After cropping:

Coupa Query Activity Step 1

Image Renaming

With connectors with a large number of activities and a large number of steps, the number of images can be numerous. And once created and named, updating the images can be tedious, time-consuming, and error-prone. To help with that, the Image Processor is designed to take advantage of an existing set of named images and use those names to help in the renaming of new screenshots.

An existing set of names is referred to as Generated Images. (The reason for that name is that an initial set of names can be generated from the adaptor.json of a connector using another Jitterbit tool called the Documentation Generator. That tool will be made available on this site in the future.)

As seen in the image at the top of the page, the generated names are loaded into the left panel of the Image Processor using the Browse for Images button below that panel. In this example, the names are loaded by browsing for a directory that has existing images used in documenting the Coupa connector.

By selecting an image in the middle panel, and then double-clicking the appropriate name in the left panel, the name will be copied into the Revised Filename column of the middle panel for the selected image. When the image is processed, it will be renamed to that name.

Image Types

The Image Processor uses simple patterns to determine where there is a change in the colors of an image and from there sets the cropping. This means that simple adjustments in the Cloud Studio UI can easily break the processor. Don’t be surprised when issues arise. Always check all images after processing for correct cropping.

Images will be cropped with a 20-pixel margin as an outer border outside of all elements.

The following image types are supported for processing. They are ordered by the X-type first (as it is the most common) with the others following alphabetically:

  • X: An image with a large “X” in the upper right corner. Marking an image as an “X” type tells the processor to ignore that “X” when calculating the location of the right-hand side. It uses the bottom of the “X” to determine where the base line of the top-most text is and from there determines where to crop.

  • A: A component palette image of an existing endpoint, showing its activities

  • C: A component palette image of a connector or an endpoint, but not to show any activities. If any activities show, they will be cropped off.

  • O: An image of an operation example

  • S: An activity step image without an “X” in the upper-right corner

  • Files without a type are not processed

Selecting multiple screenshot images to set them all to the same type is supported. You can also select multiple images and use your keyboard to enter the appropriate type (either lowercase or uppercase keys). The deletion and space character keys (such as the macOS delete, forward-delete, and space keys or the Windows Backspace, DEL, and Spacebar keys) all remove the current type.

Operating the Tool

Start the tool as you would any other application. The tool runs in a single window. Help in the tool links to this documentation. Menus are not used in the application except for an “About” dialog, help link, and exiting the tool. Everything is done by clicking the buttons as shown in the introductory illustration.

Tool Components

The tool consists of three panels with relevant buttons underneath:

  • The left panel lists Generated Image names, and is filled by browsing for a directory with existing images that have the correct names, following the pattern described above.

  • The middle panel lists the images that are to be processed. For each image, its current name (Screenshot Image), a Type, and a Revised Filename are listed.

  • The right panel shows a display of the image currently selected in the middle panel.

Typical Workflow

The typical workflow is to load a set of screenshots in the middle panel of the tool, configure each image as to its type and revised filename, and then process all images, cropping and renaming based on the settings.

  • If a Revised Filename is not specified, the file is not renamed.

  • If a Type is not specified for an image file, the file is ignored for processing. (If a revised filename is specified, the image file is renamed.)

  • Clicking an image name (Screenshot Image) displays the image in the right panel, with size information displayed immediately below the image.

  • High-resolution images (those 144 dpi or higher) are reduced in size to 72 dpi when they are processed. They are also displayed at 72 dpi (before processing) so that all edges can be seen.

  • Any embedded CMS (color management system) profiles are converted to the sRGB color profile. Colors are then matched using the sRGB profile, using a “fuzzy” match, typically a margin of ± 2 RGB values.

  • You can load a set of generated names in the left panel. Double-clicking a Generated Image name copies that name to the currently selected image in middle panel. If the revised name matches a known pattern, the Type is set automatically. Otherwise, you can use the Toggle Type button to change the type by stepping through all of the types until you set the correct type or enter the type using your keyboard.

  • Multiple selections are allowed in the middle panel by pressing Shift, Command (macOS), or Control (Windows) while clicking. This allows you to set the Type of multiple images at the same time. If multiple images are selected, no image is displayed in the right panel, nor can an image name be copied from the generated names (as all images must have different names).

  • You can use the keyboard to set the image type. The Delete key will remove a type. Multiple selections are supported and can be set to the same type using the standard key combinations (Control+, Command+, or Shift+click).

Once all images are configured with a Type and Revised Filename, click Process Screenshot Images to crop and rename the files. There will be a delay while the application completes the task. Text information with the progress of the application, and which file was last processed, are written to the UI as it processes the files.

An _originals directory is created in the screenshot images directory, and any image files that are being revised are copied there first as a backup. If all changes are to your liking, the directory can be discarded when complete.

For More Information

Though this tool is unsupported, we are happy to receive any feedback, questions, or concerns. You can reach the Jitterbit Documentation Team at documentation@jitterbit.com.