Skip to end of metadata
Go to start of metadata

Introduction

Citizen Integrator, accessible via the Jitterbit Harmony Portal, is Jitterbit's click-and-run web application for non-technical users to quickly customize and deploy integrations using pre-built recipes.

Within Citizen Integrator, the My Recipes page provides a single place where you can filter, upload, generate, edit, deploy, update, copy, or delete recipes that are private to your organization.

Accessing the My Recipes Page

The My Recipes page can be reached from several pages:

Filtering Recipes

On the My Recipes page, under My Recipes, users that have already uploaded or generated recipes that are private to their organization will see these recipes listed in a table without any applied filters.

TIP: If you have not yet uploaded or generated any recipes, you will not see any recipes on this page. Instead, users who want to use recipes provided by Jitterbit can do so by selecting one from the Citizen Integrator - Dashboard page.

The following filter options are available:

  • Endpoint: The endpoint dropdown contains a list of endpoints you can filter by. By default, recipes for all endpoints are shown (the "Endpoint" selection).
  • Organization: The organization dropdown contains a list of any available organizations. By default, recipes for the currently selected organization are shown.
  • Date Range: The date range field allows you to set a start date and end date that will be used to filter recipes by date of upload. By default, recipes uploaded on any date are shown.
  • Search: The search box allows you to filter recipe names by keyword. The recipe list will become filtered immediately as you enter search criteria.
  • Clear Filter: The blue remove filter icon  clears any filters currently applied to the list of recipes.

Uploading a Recipe

Under My Recipes, the option to upload a new recipe is always available regardless of any selections.

NOTE: To use the upload recipe functionality, you should have already created a Design Studio Jitterpak with accompanying JSON metadata to define the recipe steps as described in Creating New Recipes. At this time, recipes cannot be created from Cloud Studio projects.

Click the cloud icon  to open a window where you can upload a new recipe.

In the Upload Recipe window, select the following:

  • Jitterpak: Use the Choose File button to browse to the Jitterpak (.JPK) you would like to upload.
  • Recipe JSON Metadata: Use the Choose File button to browse to the recipe metadata (.JSON) you would like to upload.

Then click Submit to upload your new recipe.

Generating a Recipe

Under My Recipes, the option to generate a recipe is available only for users with Admin permissions within the selected organization. After recipe generation, you will be brought to the Generate Recipe page to further configure your recipe steps (see Citizen Integrator - Generate or Edit Recipe).

NOTE: You may be interested in using the generate functionality when you have a Design Studio Jitterpak but have not preconstructed the JSON metadata. Refer to Creating New Recipes for best practices for creating Jitterpaks for Citizen Integrator. At this time, recipes cannot be created from Cloud Studio projects.

Click the JPK icon  to open a window where you can upload a Jitterpak that will generate a recipe.

In the Generate Recipe window, use the Choose File button to browse to the Jitterpak (.JPK) you would like to upload.

Then click Submit to generate your new recipe and open the Generate Recipe page where you can further configure your recipe steps (see Citizen Integrator - Generate or Edit Recipe).

Editing a Recipe

Under My Recipes, the option to edit a recipe will become available once you have selected only one recipe within the table, and will be available only for users with Admin permissions within the selected organization.

To select a recipe, click anywhere on the row, or check the box to the left of the recipe.

Then click the edit icon  to open the Edit Recipe page where you can update your recipe steps (see Citizen Integrator - Generate or Edit Recipe).

Deploying a Recipe

Under My Recipes, the option to deploy a recipe will become available once you have selected only one recipe within the table.

To select a recipe, click anywhere on the row, or check the box to the left of the recipe.

Then click the deploy icon  to open the Citizen Integrator - Configure Recipe page where you can configure and then deploy the recipe by clicking the Save & Finish button.

Updating a Recipe

Under My Recipes, the option to update a recipe will become available once you have selected only one recipe within the table, and will be available only for users with Admin permissions within the selected organization.

NOTE: To use the update recipe functionality, you should have already updated a Jitterpak with accompanying JSON metadata to define the recipe steps as described in Creating New Recipes. If instead you want to update recipe steps through the Citizen Integrator user interface, use the Editing a Recipe functionality.

To select a recipe, click anywhere on the row, or check the box to the left of the recipe.

Then click the update icon  to open a window where you can update a recipe that has previously been uploaded within your organization.


In the Update Recipe window, select the following:

  • Jitterpak: Use the Choose File button to browse to the Jitterpak (.JPK) you would like to upload.
  • Recipe JSON Metadata: Use the Choose File button to browse to the recipe metadata (.JSON) you would like to upload.

Then click Submit to update your existing recipe.

Copying Recipes

Under My Recipes, the option to copy recipe(s) will become available once you have selected one or more recipes within the table, and will be available only for users who are part of two or more organizations.

To select one or more recipes, click anywhere on the row(s), check the box(es) to the left of the recipe, or check the "Select All" box.

Then click the copy icon  to open a window where you can use a dropdown to select the organization.

Click Copy to copy the selected recipe(s) to the target organization.

All copied recipe(s) will then be shown within the table for the target organization. 

Deleting Recipes

Under My Recipes, the option to delete recipe(s) will become available once you have selected one or more recipes within the table.

To select one or more recipes, click anywhere on the row(s), check the box(es) to the left of the recipe, or check the "Select All" box.

Then click the trash icon  to open a confirmation dialogue to delete the recipe(s) that you have selected.

Click Ok to delete the selected recipe(s) from your organization.

On This Page

Last updated:  Apr 12, 2019