- This line was added.
- This line was removed.
- Formatting was changed.
The Citizen Integrator page of the Web Management Console (WMC) allows you to use standard Recipes to quickly deploy standard integrations via a step-by-step interface, rather than the Jitterbit Studio application. Jitterbit has dozens of standard Recipes that are available to all Jitterbit customers. You can also author and upload your own Recipes using the advanced features described under our Citizen Integrator documentation.
Access the Citizen Integrator page from Menu > Citizen Integrator.
NOTE: Make sure you are accessing the desired Organization. In the top navigation bar, use the dropdown that appears to the right of your name and to the left of the Help menu to toggle between Organizations.
Selecting a Recipe
Jitterbit has dozens of standard Recipes that are available to all Jitterbit customers. You can search or browse through these Recipes from the right side of the screen. When you find a Recipe you want to use, click to select the Recipe that you will then configure in the next steps.
- Recipes: Search or browse through all available Recipes in the top right of the screen. Standard Recipe names typically include the endpoint, so you can easily find a list of available Recipes by typing in an endpoint name (Salesforce, NetSuite, Dotmailer, Zendesk, ConstantContact, etc.).
- My Recipes: Browse through a filtered list of only your Recipes in the lower right. Use the gear menu and select the lock icon to toggle between all Recipes or private Recipes only. Private Recipes can be seen only within your Organization.
Using a Recipe
Once you have selected a Recipe, you will see the Directions on the left side of the screen and Configuration Steps on the right. The Configuration Steps are specific to each Recipe, although the workflow is similar among all Recipes.
The following screenshots walk through an example of using a standard Recipe to sync accounts from Salesforce to Zendesk.
Each configurable section will be specific to the selected Recipe. Follow the instructions within each step and use the buttons within each step to advance to the next section.
Introduction: Recipes typically begin with an introduction step that describes what the Recipe is used for. You do not need to provide any information in this step and can click the Next button to continue.
Set Up Environment: The next step typically asks you to select the environment where the Recipe will be deployed. The Agent Group will also be listed, including the current state of the Agent that is fetched when this step is opened. See our Web Management Console documentation for more information on Environments and Agent Groups. Click Next to continue.
As each step is completed, the heading color will change to a bright green. You can go to any step at any time by clicking on its header to expand the step, or click Next to continue.
Project Variables: The next two steps in this example ask you to enter information that will be used to connect to your endpoints. In Jitterbit, project variables are used so that the values you enter can easily be used within the Recipe template. This Recipe requires information for the Salesforce endpoint and the Zendesk endpoint.
In addition, many Recipes have the option to Test Connection when credentials are provided. Testing the connection is usually a good idea in order to ensure your connection has been established. After clicking the button, a message will appear below the Test Connection button indicating if your connection is successful. Click Next to advance.
RunNow: Once the Recipe is configured with information specific to your endpoints, many Recipes have the option to run your operation immediately. Use the Run Operation button to execute the operation.
Any messages regarding your operation will automatically refresh in a box that appears below the Run Operation button. You can click Details to view a detailed log. If there are no details to display, a message will be displayed to indicate this. Then click Next to continue.
Review: The last step typically provides any additional information that is built into the Recipe (e.g. if a schedule is configured to execute the operation on a repeated basis). This step also includes a Save & Finish button. You must click this button in order to deploy the Recipe.
Since all Recipes are configurable, each Recipe may have different steps than those shown above. To learn more about authoring your own Recipes or for more advanced options, see Citizen Integrator.
NOTE: After a Recipe is deployed, if you modify your project in Jitterbit Studio, and then redeploy the Recipe, please note that the Recipe will override information in Jitterbit Studio.
Check the status of your deployed Recipes on the top left side of the screen.
- Green checkmark: Recipes that have been deployed successfully.
- Yellow exclamation: Recipes with errors; click to view messages.
- Red 'X': Recipes not deployed successfully; click to view messages.
Below the status summary is a list of Recipes based on your filter status. You can filter by Recipe status using the gear icon.
The following options are available:
- Remove any applied filters
- Filter by Unknown Status (includes, for example, the scenario in which a deployed Recipe has associated operations that have been scheduled but not yet been run for the first time)
- Filter by Green Status
- Filter by Warning Status
- Filter by Error Status
Uploading, Updating, or Deleting a Recipe
As of version 8.21, Recipe authors can now upload a new Recipe, or update or delete an existing Recipe from this page.
To upload a new Recipe, under the My Recipes section, use the gear menu and select the cloud icon.
A popup will open where you can select the Jitterpak (.JPK) and Recipe metadata (.JSON) used for your Recipe. These are the two required parts that make up a Citizen Integrator Recipe. To learn more about creating Jitterpaks and Recipe metadata, please refer to Citizen Integrator Advanced - Create New Recipes.
Additionally, select whether your Recipe should be Private (i.e. accessible only to those within your Organization) or Public (i.e. accessible by any Jitterbit users). Then click Submit to upload your new Recipe.
After you have uploaded a Recipe, it will appear within the My Recipes section. You can hover over the Recipe for additional options to deploy, update, or delete the Recipe. The options to update or delete the Recipe will be available only for Recipes that you have created.
For additional interactions you can perform with Citizen Integrator Recipes, you can use the Jitterbit Command Line Interface (jbcli). The options to update and upload Recipes are also available through the jbcli. See Citizen Integrator Advanced - Manage Recipes with Jitterbit Command Line Interface for more information.