Jitterbit Cloud Studio Project Reporter¶

Introduction¶

The Jitterbit Cloud Studio Project Reporter assists in the creation of Jitterbit Cloud Studio projects by providing a report that describes an exported Cloud Studio project as a single web page. The Project Reporter can be used to both review and modify a project so that a consistent naming scheme can be used for project variables and other project components.

Download¶

The Project Reporter is available for the macOS and Windows operating systems. Download an appropriate installer package from these links:

• macOS
• Windows

See the release notes for details of changes in the application.

Installation¶

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

If you are installing on macOS, you may receive a warning message about the installer and be required to approve the installation in the Security & Privacy panel of the macOS System Preferences, as shown in this example for the Project Reporter tool:

Intent of the Tool¶

The intent of the tool are these functions:

• Cloud Studio project reporting, including overall project, schema, and project variable reports
• Project component standardization, particularly the naming and defining of project variables
• Project JSON file editing, expansion (pretty-printing), and compression

The first part of the report lists any warnings or suggestions. A report’s warnings do not affect the project’s capability with respect to its validity as a Cloud Studio project. They reflect the project’s compliance with our standards for the naming of components such as project variables. If an endpoint has an encrypted value in a “password” type field, a warning will be issued. Warnings and suggestions should be reviewed and implemented as appropriate for a particular project.

The warnings and suggestions can be excluded from the report by deselecting Include Warnings/Suggestions. By default this is selected. As this setting is included in the preferences, this will be maintained across closing and reopening of the application.

The schema report is a separate report that is saved as a Markdown file. It lists all the different schemas used in a project and the fields used in the mappings.

The project variable report is a separate report that is saved as a Markdown file. It lists all project variables used in a project and their definitions. A more comprehensive report is included in the HTML project report.

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.

When you first start the tool, no project is opened by default, and there are no items listed in the program’s Favorite Projects drop-down menu:

The typical workflow is to specify a project and then create a report for the project.

Once a project has been specified and a report created, additional actions (such as cleaning or editing a project, saving reports) are available.

Tool Components¶

The tool consists of two panels with relevant buttons underneath:

• The top panel (Specify Project) is where you specify the current project. Though only one project can be specified at a time, you can add a project to the Favorite Projects drop-down menu and save its path for reuse.

• The bottom panel (Project Report) is from where you create the project report and manipulate a project.

Specify Project¶

You specify the current project either by browsing for the project JSON file or by selecting from a saved favorite.

• Current Project: The current project’s filename is shown in bold text, with the complete path of the project file shown when you hover over the name.

• Use the Browse for File button to select a Cloud Studio project file (a JSON file exported from Cloud Studio) or a ZIP archive containing a project.

• Once a file has been specified, you can add it to the Favorite Projects menu.

• Use the Remove as Favorite or Clear Favorites buttons to edit the menu.

Project Report¶

• Create Project Report: Creates an HTML report on the current project and opens it in the system web browser.

• Include Warnings/Suggestions: Include warnings and suggestions in the HTML report.

• Save Project Report: Run after creating a report to save the report as HTML.

• Save Schema Report: Run after creating a report to save the schema report as a Markdown file.

• Save Project Variable Report: Run after creating a report to save the project variable report as a Markdown file.

• Implement Report Corrections: Run after creating a report to copy the report’s suggested corrections onto the source project.

• Clean Source Project: Rewrites the current project to remove email addresses and deployment records and pretty-prints the JSON.

• Edit Source Project: Opens the current project in the system default JSON file editor.

• Pretty-print Source Project: Rewrites the current project to be expanded (pretty-printed) JSON.

• Compact Source Project: Compacts the current project by rewriting it to remove whitespace from the JSON.

• ZIP Source Project: Archives the current project to a ZIP file.

Release Notes¶

1.10.0

• Updated the application icons to use the new Jitterbit logo and to correct an issue with the macOS icons being too large.

1.9.0

• Improved the error handling when encountering unfamiliar versions and items of project JSON.
• Added PagerDuty and Microsoft Dynamics 365 Finance & Operations as known endpoints.
• Added additional project variables for GitHub.
• Added additional WSDL versions for NetSuite.

1.8.5

• Added additional or revised project variables for Microsoft Dynamics CRM, Salesforce, and Zendesk.
• Added Salesforce Service Cloud as a known endpoint.
• The Jitterbit suggested naming schema for project filenames has been revised to include an optional trailing component in parentheses.

1.8.4

• Added additional project variables for Workday and added Microsoft Dynamics 365 Sales as a known endpoint.

1.8.3

• Added a project variable for Microsoft Dynamics CRM Integration Username.

1.8.2

• Added project variables for Zendesk.

1.8.1

• Inactive transformation rules are no longer published in the reports.
• Reports now include the version of the software used to generate the report.
• Added an additional project variable for Coupa.
• Added Microsoft Business Central to the lists of known endpoints and categories.
• Fixed a typo in a Microsoft Business Central project variable.

1.8.0

• Added project variables for Mailchimp to the list of known project variables.
• Added an additional project variable for Coupa.
• Changed the Microsoft Dynamics 365 Business Central project variables to Microsoft Business Central.
• Updated the “Hide Value” visibility setting of known project variables to match that of the connector configurations in Cloud Studio.

1.7.2

• Added Microsoft Dynamics 365 Business Central and its project variables to the lists of known endpoints and categories.
• Added additional project variables for Jira, ServiceNow, and Workday.
• Updated project variables for Coupa and NetSuite.
• Added labels and descriptions to any existing project variables that did not have a label or description.

1.7.1

• Added a rule to check that source and target objects for project names are always plural and end in “s”.
• When names are checked, all tests are executed and any errors found are returned rather than stopping the tests at the first error.
• Added Microsoft Teams and its project variables to the lists of known endpoints and categories.

1.7.0

• Added an option to show warnings and suggestions when creating a project report.
• Preferences are saved correctly on quitting.
• The arrow icon that returns you to the top of the report is no longer visible in non-screen usage such as printing or creating a PDF.
• Non-breaking spaces have been added to the project variable header labels.
• Updated the BigCommerce project variables.
• Added a sorting based on Python casefolding everywhere that objects are sorted.
• For each run of building a report, a unique directory is used so that different JSON files with the same project name don’t overwrite each other.
• Added Work.com to the lists of known endpoints and categories.

1.6.1

• Added an additional project variable for NetSuite.
• Added additional Marketplace categories and the mapping of endpoints to those categories.

1.6.0

• Added SAP ECC as a known endpoint and added additional project variables describing SAP ECC.

1.5.0

• Fixed an issue with the compacting of JSON.
• Fixed an issue with buttons not being enabled correctly to match the state of the application.
• Fixed an issue when running the application on older macOS versions with being unable to determine the latest version of the application.
• Corrected the tab order between controls for the Windows version.
• The Project Reporter quits if you decide to download an update.

1.4.1

• Fixed an issue with the validation of project JSON files.
• Fixed an issue with the Favorite Projects menu not being enabled appropriately.
• Reordered the Project Report panel buttons in a layout that more closely reflects a typical workflow.

1.4.0

• A new UI has been created with speed improvements in the generation of reports.
• Issues with the macOS build and installation have been fixed and a new macOS version has been released.
• Support for ZIP archives with JSON projects in them has been added. ZIP files are automatically unpacked.
• A new compression button (ZIP Source Project) has been added to create ZIP archives.
• Copy Report Corrections Over Source Project has been renamed to Implement Report Corrections.
• Removing the whitespace from JSON is now referred to as “compaction”. Previously, this was called “compression”.
• Fixed an issue with the handling of project variables when used in an email message account or password with respect to suggesting corrections.

1.3.1

• Cloud Studio projects that are UTF-8 encoded are now supported. An error when loading certain projects encoded with UTF-8 has been fixed.
• An issue with the macOS build and installation has been fixed and a new macOS version has been released.

1.3.0

• When the application starts, it checks online to see if a newer version of the application is available for download. If so, it asks if you’d like to go to the download page. This same test can be initiated from a menu item in the application.
• Updates have been made to the recommended project variable naming conventions.
• The version of Python embedded in the application has been updated to version 3.9.0.

1.2.4

• Fixed errors with a project that does not have a description or components such as scripts or project variables. The report now correctly lists these items as not being present.
• Fixed an error when a file saved as a favorite is no longer available.
• Added handling of other errors that caused the program to become unresponsive.

1.2.3

• Fixed an issue with creating a mapping rule from an incomplete rule.

1.2.2

• Fixed an issue with reviewing projects that had a password in an endpoint configuration.

1.2.1

• Connectors and activities are displayed grouped by endpoint and connector, alphabetically.
• Bug fixes related to warnings that prevented reports from being created for certain projects.

1.2.0

• A warning is issued if an endpoint has an encrypted value in a “password” type field.
• The endpoints are now described in detail about their field names and values.
• Components are displayed by order of importance.

1.1.0

• New application icon using a bright color makes it easier to identify the application when it’s in use.
• Added spellchecking for many usages of known endpoints in names. If a known endpoint is found to be misspelled, a warning is issued at the start of the report. Correcting these errors is not automatic and must be performed manually.

1.0.0

• Initial release of the application.

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.