Skip to main content

Editing and Managing Recipes (2.4)

In InterSystems TotalView™ For Asset Management, a recipe describes how to load data into the system. This page describes how to edit and manage recipes; another page provides information on defining them.

Recipe Changes

One of the key objectives is to permit schemas to change, while preserving your data. Schema evolution is described in detail elsewhere, but note the following:

  1. When you edit or reimport a schema, you are implicitly creating a draft that is not yet used by anything. The existing schema is unchanged; existing data is also unchanged.

  2. When you republish a schema, if the change affects the structure needed to contain the data, the system automatically increments the version number of the schema and automatically generates a new draft of any recipe staging activity that is affected by this change. The new staging activity draft is not automatically published, and the previous staging activity is unchanged.

  3. When you republish any draft staging activities, the system generates a new staging table, considering the structural change that has occurred. This leaves the old table (and its data) unchanged.

Independent from any schema changes, a recipe can also require fields to be added to the staging table. The system handles this automatically.

Viewing the Recipes Dashboard

To view the Recipes Dashboard, click the Recipes icon in the application menu.

This page enables you to see all the recipes, either as a table or as a set of rectangular cards. For each recipe, the page displays the following information.

  • Status—Status of the recipe, which can be any of the following:

    • Idle

    • Staging

    • StagingError

    • Transforming

    • TransformingError

    • Validating

    • ValidatingError

    • Reconciling

    • ReconcilingError

    • Promoting

    • PromotingError

    Other than Idle, these statuses indicate which phase of activity is currently underway (and whether an error has occurred in this phase).

  • Recipe Name—Name of the recipe.

  • Recipe Short Name—Short name of the recipe.

  • Active—Indicates whether this recipe is active (can be scheduled).

  • Activity Drafts—Indicates the number of draft activities that this recipe currently has.

Click any recipe in order to view it or make changes.

To filter the display, use the options at the top of the page:

  • Recipe Name—Filters the display to include only the recipes whose full names contain the given string. After typing into this field, click the Find icon.

  • Status—Filters the display to include only the recipes with the given status.

  • Lifecycle—Filters the display to include only the recipes that have the given lifecycle state. A recipe can be Active (the initial state), Disabled, or Deleted.

    Only Active recipes can be scheduled.

  • Reset —Clears all the filter options.

Editing a Recipe

To edit a recipe:

  1. Click the Recipes icon in the application menu.

  2. Click the recipe. The system then displays the current definition, including any draft activities.

    If there is a draft activity, you can choose to display the published version or the draft version (which is shown as a separate item as in the following example).

    list that shows sample staging activity and a draft version of the same staging activity

Now you can make any of the following edits:

  • To add a new activity, click Add Staging Activity, Add Transformation Activity, Add Validation Activity, Add Reconciliation Activity, or Add Data Promotion Activity, and then continue as described in Defining Recipes.

    The new activity will not take effect until you publish it via the Publish Activity button.

  • To edit an existing activity, click it. Notes:

    • If you click a draft that the system generated because of schema evolution, the system displays a message that explains why it generated this new draft.

    • If you are viewing a published activity, you must click Edit Activity to make it editable.

    • If you are viewing a published activity and there is a current draft for that activity, the Edit Activity button displays the draft in edit mode.

    Make changes as needed and save them via the Save Draft button.

    The changes will not take effect until you publish it via the Publish Activity button.

Publishing an Activity

To publish (or republish) an activity within a recipe:

  1. Click the Recipes icon in the application menu.

  2. Click the recipe. The system then displays the current definition, including any draft activities.

    If there is a draft activity, you can choose to display the published version or the draft version.

  3. Click the activity that you want to republish.

  4. Click Publish Activity.

Disabling an Activity

To disable an activity within a recipe (so that this activity is skipped if the recipe is used):

  1. Click the Recipes icon in the application menu.

  2. Click the recipe. The system then displays the current definition, including any draft activities.

    If there is a draft activity, you can choose to display the published version or the draft version.

  3. Click the activity that you want to disable.

  4. Click the slider in the Actions column for that activity. Then click Disable Current Activity. Here’s an example (before):

    Disabled column says no, and actions slider is in the right position

    After:

    Disabled column says yes, and actions slider is in the left position

Enabling an Activity

To enable an activity that has previously been disabled:

  1. Click the Recipes icon in the application menu.

  2. Click the recipe. The system then displays the current definition, including any draft activities.

    If there is a draft activity, you can choose to display the published version or the draft version.

  3. Click the activity that you want to enable.

  4. Click the slider in the Actions column for that activity.

Deleting an Activity

To delete an activity in a recipe.

  1. Click the Recipes icon in the application menu.

  2. Click the recipe. The system then displays the current definition, including any draft activities.

  3. Click the activity that you want to delete.

  4. Click Delete. (Or if you are deleting a draft activity, click Delete Draft.)

    Note that system-generated drafts cannot be deleted; system-generated drafts are created when, for example, an associated schema has changed.

  5. Click Delete again.

Disabling a Recipe

To disable a recipe:

  1. Click the Recipes icon in the application menu.

  2. Click the recipe.

  3. Click Disable.

  4. Click Disable to confirm.

Enabling a Recipe

To enable a recipe that has previously been disabled:

  1. Click the Recipes icon in the application menu.

  2. Click the recipe.

  3. Click Enable.

Deleting a Recipe

To delete a recipe:

  1. Click the Recipes icon in the application menu.

  2. Click the recipe.

  3. Click Delete.

  4. Click Delete to confirm.

See Also

Defining Snapshots (2.4)Next section
Previous sectionDefining Recipes (2.4)
FeedbackOpens in a new tab