Skip to end of metadata
Go to start of metadata

Introduction

The Projects page of the Management Console provides the ability to manage all of your projects across the various stages of their lifecycle. You can import and delete projects, as well as run operations, create and apply a schedule on an operation, manage project backups, edit project variables, and view deploy history.

To access the Projects page, log in to the Jitterbit Harmony Portal, then click the orange hamburger menu in the top left:

From the menu, hover over Management Console and select Projects:


NOTE: Make sure you are accessing the desired organization. In the top navigation bar, use the dropdown that appears between your name and Help to switch between organizations.

Managing Projects

The top section of the Projects page includes a table that lists each project, its associated environment, and a description if available. Both Cloud Studio and Design Studio projects are included.

Import Projects

To import a Design Studio project, use the  button. In the popup, use the  button to browse to the Jitterpak file (.JPK). For more information on obtaining a project in .JPK format, refer to Export as a Jitterpak.

NOTE: Cloud Studio projects are unable to be imported from the Management Console. To import a project from within Cloud Studio, see Project Exports and Imports.

Make sure you select the environment you want to import your project into. To select multiple environments, hold the Control key or Command key while clicking. The rest of the fields should populate with information from your Jitterpak. Then click Save.

NOTE: The Project Name cannot contain any of these special characters: \ / : ? * " < > |.

Delete Projects

To delete a project, use the Action dropdown on the far right and select either Delete or Delete from All Environments depending on if you would like to remove the project's association with a single environment or remove from all environments.

Search for Projects

Enter search criteria into the search bar located directly above the Projects table. Then click the magnifying glass button to execute the search. Optionally, you can check the box for Include Deleted if you want to include deleted projects in your search.

Enter search terms using the syntax suggested below the search box. Note that a semicolon (;) is treated as an AND operator, and a comma (,) is treated as an OR operator.

To search for projects, enter "project=" immediately followed by the name of the project. For wildcard searches, enter the first few letters of the name of the project followed by the percent (%) symbol.

To search for environments, enter "environment=" immediately followed by the name of the environment. For wildcard searches, enter the first few letters of the name of the environment followed by the percent (%) symbol.

Sort Projects

Click the column header in any column to sort the table based on the data in that column in ascending order. A white arrow pointing up will display in the column to the right of the header name.

Click the column header twice in any column to sort the table based on the data in that column in descending order. A white arrow pointing down will display in the column to the right of the header name.

Managing Detailed Information

When a row of the Projects table is selected, the tabs at the bottom of the screen become available: Operations, Schedules, Backups, Project Variables, Deploy History.

View, Run, or Apply Schedule to Operations

The Operations tab shows the operations within the selected project. From here you can limit the view of operations, identify which operations have debug mode enabled, check schedule status, enable or disable an applied schedule, run an operation, or apply or remove an existing schedule.

Search for Operations

To search within the table of operations, enter search terms using the syntax suggested below the search box. Note that a semicolon (;) is treated as an AND operator, and a comma (,) is treated as an OR operator.

To search by operation or schedule name, enter "operation=" or "schedule=" immediately followed by the name of the operation or schedule, respectively. For wildcard searches, enter the first few letters of the name of the operation followed by the percent (%) symbol. 

To search by status, enter "schedulestatus=", "operationstatus=", or "effectivestatus=", immediately followed by "enabled" or "disabled".

Then click the magnifying glass or press the Enter key to execute the search.

Identify Operations with Debug Mode Enabled

If your project contains any operations that have debug mode enabled (see Cloud Studio Operation Options or Design Studio Operation Options), a wrench icon  will be displayed in the Operation Name column, to the left of the name of each operation that has debug mode enabled.

Check Schedule Status or Enable/Disable Schedule

If your project contains any schedules, the name of the schedule will be listed in the Schedule Name column for each operation that has a schedule configured.

The next three columns provide information on the status of the schedule. It is important to understand that a schedule can be enabled or disabled overall for the whole project, or can be enabled or disabled individually on each operation. Given these options together, the Effective Status is the most meaningful column that indicates whether an operation will run on the schedule.

  • Schedule Status: This indicates if the schedule is enabled or disabled overall at the schedule level. Enabling or disabling a schedule at the schedule level can be done from the next tab, Schedules. When a schedule is disabled overall, an operation that has a schedule applied at the operation level will not run on the schedule.
  • Operation Status: If a schedule has been applied at the operation level, this indicates if the schedule is enabled or disabled. Click to toggle the schedule on or off on the operation. Note that if the schedule is enabled at the operation level, but the overall schedule is disabled at the schedule level (Schedule Status), then the operation will not run on the schedule (i.e. the schedule level overrides the operation level). If the operation does not have a schedule applied, "No schedule" will be displayed. A schedule can be applied or removed on the operation using the Action dropdown on the far right of the row.
  • Effective Status: This indicates the effective status of a schedule for the operation, taking into account whether the schedule is enabled overall and whether it is enabled on the individual operation. If both the schedule overall and the schedule on the individual operation are enabled, then the operation will run on the schedule. If either the schedule overall or the schedule on the individual operation is disabled, then the operation will not run on the schedule. If the operation does not have a schedule applied, "No schedule" will be displayed.

For example, if Operation A has a schedule enabled at the operation level (Operation Status is "On") and Operation B has the same schedule disabled at the operation level (Operation Status is "Off"), but the schedule is disabled at the project level (Schedule Status is "Schedule Disabled"), then neither operation will run on the schedule (Effective Status is "Disabled"). If the schedule were then enabled at the project level (Schedule Status is "Schedule Enabled" and Effective Status is "Enabled"), then Operation A would run on the schedule and Operation B would not run on the schedule, as it is disabled at the operation level.

NOTE: Schedule changes take effect immediately without needing to redeploy the project to Harmony.

Run Operation or Apply/Remove Schedule

To place an operation in the queue to run or to apply a schedule, use the Action dropdown on the far right and select Run or Apply Schedule. If a schedule is already applied, select Remove Schedule to disassociate the schedule with the operation.

Upon clicking Run, a message will appear in the top right indicating if the operation has been submitted successfully.

Upon clicking Apply Schedule, a window will appear to select the schedule to apply. Use the dropdown to select an existing schedule, then click Associate to apply it to the operation. Only one schedule can be applied per operation.

Upon clicking Remove Schedule, a confirmation message will ask you to confirm you want to dissociate the schedule from the operation. The schedule itself will not be deleted, but will simply be unassigned from the operation.

NOTE: Schedule changes take effect immediately without needing to redeploy the project to Harmony.

View, Create, Update, or Enable/Disable Schedules

The Schedules tab provides the ability to create new schedules, search for schedules, update or delete existing schedules, or enable or disable an existing schedule across all operations on which it is currently enabled or disabled.

Create New Schedule

To create a new schedule, click the Create Schedule button. Note that this is used to create the schedule only; applying the schedule to an operation is covered above under Run Operation or Apply/Remove Schedule.

A window will open where you can configure your schedule. Each option is covered below.

  • Name: Enter a name for your new schedule. You may want to give the schedule a name that is reflective of the schedule frequency or, if used for a specific operation, reflective of the purpose of the schedule (e.g. "Every 5 MInutes" or "Contact Sync").
  • Occurrence: Use the dropdown to select one of three options for the days on which the schedule should kick off the operation(s) on which it is assigned:
    • Daily: The schedule will activate the operation every day, or every few days. When this option is selected, these fields become available to configure:
      • Every [#] Day(s): Enter a number of day(s) in between operation runs.
    • Weekly: The schedule will activate the operation during a specified set of days of the week. When this option is selected, these fields become available to configure:
      • Every [#] Week(s): Enter a number of week(s) in between operation runs.
      • [Sun, Mon, Tue, Wed, Thu, Fri, Sat]: Select the checkboxes next to the day(s) of the week on which you want the operation to run.
    • Monthly: The schedule will activate the operation on a monthly basis. When this option is selected, choose one of two options that become available to configure:
      • Day [#] of Every [#] Month(s): Enter the day of the month and number of month(s) in between operation runs.
      • The [1st, 2nd, 3rd, 4th, or Last] [Day of Week] of Every [#] Month: Use the dropdowns to select which day of the month and enter the number of month(s) in between operation runs.
  • Daily Frequency: Select one of two options for the times at which the schedule should kick off the operation on the days that it runs.

    NOTE: The timezone depends on the agent running the operation:

    • Cloud Agents: All Cloud Agents are in UTC.
    • Private Agents: Private Agent timezones may vary based on the timezone of the operating system of the Private Agent. It is highly recommended for all agents in a Private Agent Group to be running on the same timezone, or the times at which a configured schedule kicks off the operation may be unpredictable depending on the specific agent being used.
    • Occurs once at [hh:mm] [AM/PM]: The schedule will activate the operation only once at the specified time. Enter values directly or click the time icon  to open a time selector to set the hour(s), minute(s), and time of day at which you want the operation to run.

    • Occurs every [#] [Minute(s)/Hour(s)] Starting at [hh:mm] [AM/PM] and Ending at [hh:mm] [AM/PM]: The schedule will repeatedly reactivate the operation for the specified period of time throughout the day. Enter a number to correspond with the dropdown selection of minute(s) or hour(s) at which you want the operation to run. Enter values directly or click the time icon  to open a time selector to set any times throughout the day that you want to limit the operation to run within.
  • Duration: Configure the dates of duration for the schedule.

    NOTE: Start and end dates in a schedule are inclusive.

    • Starting at: By default, the schedule will be active starting on the current date. If you want the schedule to start on another day, enter the desired date or click the calendar icon  to open a calendar datepicker and select the desired start date.
    • Ending at: By default, the operation(s) on which the schedule is assigned will run indefinitely per the schedule. If you want specify an end date, first select the checkbox to enable the Ending at field. Then enter a date that you want the schedule to end or click the calendar icon  to open a calendar datepicker and select the desired end date.

Search for Schedules

To search within the table of schedules, enter search terms using the syntax suggested below the search box. Note that a semicolon (;) is treated as an AND operator, and a comma (,) is treated as an OR operator.

To search by schedule name, enter "schedule=" immediately followed by the name of the schedule. For wildcard searches, enter the first few letters of the name of the operation followed by the percent (%) symbol. 

To search by status, enter "schedulestatus=", "operationstatus=", or "effectivestatus=", immediately followed by "enabled" or "disabled".

Then click the magnifying glass or press the Enter key to execute the search.

Edit or Delete Schedule

To edit or delete an existing schedule, use the Action dropdown on the far right and select Edit or Delete.

Upon clicking Edit, the schedule configuration will open as described in Create New Schedule above. When an existing schedule is edited, it affects all operations that have the schedule applied.

Upon clicking Delete, if no operations are currently using the schedule, a confirmation message will ask you to confirm that you want to delete the schedule. If any operations are currently using the schedule, you will not be able to delete the schedule.

NOTE: Schedule changes take effect immediately without needing to redeploy the project to Harmony.

Enable or Disable Schedule

To toggle the schedule on or off, effectively enabling or disabling the schedule across all operations on which it is currently enabled or disabled, click the toggle button under the Schedule Status column.

NOTE: Schedule changes take effect immediately without needing to redeploy the project to Harmony.

Check Schedule Status or Enable/Disable Schedule

If your project contains any schedules, the name of the schedule will be listed in the Schedule Name column. Click the disclosure triangles   to expand or collapse operations that have the schedule applied.

The next three columns provide information on the status of the schedule. It is important to understand that a schedule can be enabled or disabled overall for the whole project, or can be enabled or disabled individually on each operation. Given these options together, the Effective Status is the most meaningful column that indicates whether an operation will run on the schedule.

  • Schedule Status: This indicates if the schedule is enabled or disabled overall at the schedule level. Click to toggle the schedule on or off for the whole project. When a schedule is disabled overall, an operation that has a schedule applied at the operation level will not run on the schedule.
  • Operation Status: If a schedule has been applied at the operation level, this indicates if the schedule is enabled or disabled. Click to toggle the schedule on or off on the operation. Note that if the schedule is enabled at the operation level, but the overall schedule is disabled at the schedule level (Schedule Status), then the operation will not run on the schedule (i.e. the schedule level overrides the operation level). A schedule can be applied or removed from the Operations tab.
  • Effective Status: This indicates the effective status of a schedule for the operation, taking into account whether the schedule is enabled overall and whether it is enabled on the individual operation. If both the schedule overall and the schedule on the individual operation are enabled, then the operation will run on the schedule. If either the schedule overall or the schedule on the individual operation is disabled, then the operation will not run on the schedule. If the operation does not have a schedule applied, "No schedule" will be displayed.

For example, if Operation A has a schedule enabled at the operation level (Operation Status is "On") and Operation B has the same schedule disabled at the operation level (Operation Status is "Off"), but the schedule is disabled at the project level (Schedule Status is "Schedule Disabled"), then neither operation will run on the schedule (Effective Status is "Disabled"). If the schedule were then enabled at the project level (Schedule Status is "Schedule Enabled" and Effective Status is "Enabled"), then Operation A would run on the schedule and Operation B would not run on the schedule, as it is disabled at the operation level.

NOTE: Schedule changes take effect immediately without needing to redeploy the project to Harmony.

View, Download, or Remove Backups

If the project has any backups that have been created, you can view information about them from the Backups tab. 

Use the Action dropdown if you would like to Download or Remove the particular backup.

View or Edit Project Variables

You can view any project variables used within your project under the Project Variables tab.

To open the project variable for editing, use the Action dropdown to select Edit.

In the popup, you can edit the value, show or hide the value, or edit the description.

CAUTION: Any edits to project variables via the Management Console take effect immediately.

View Deploy History

When you deploy your project, information in the Deploy History tab will populate with records of your deployment history.

You may need to click the refresh button  in order to update records. 

Click on a deploy record row to view details about the deployment:

On This Page

Last updated:  Jul 15, 2019