Skip to content
Documentation version: IdentityIQ 9.0

Managing Metadata Campaigns

The Metadata Campaigns page displays campaigns that you created, and campaigns created by other users if they are within your scope. It also displays campaign schedules, completed campaigns, and metadata reviews created from campaigns.

Viewing Campaigns

Use the Campaigns tab to view all active and staged metadata campaigns.

Prerequisite: To access this tab, you must have the Meta Campaign Officer capability. For more information, refer to Metadata Campaign Administration.

  1. Go to the Campaigns tab.

    For each campaign, the table displays the following information:

    Option Description
    Campaign Name The name of the campaign.
    Campaign Owner The owner of the campaign.
    Type The campaign type - Role or Entitlement.
    Status

    The current status of the campaign:

    • Pending - The campaign is being processed and is transitioning to Active.
    • Active - The campaign is live. Reviewers can see and act on their review sets.
    • Staged - The campaign is generated for preview and is not yet active. Metadata reviews are created but are not visible to reviewers. For more information, refer to Activating Staged Campaigns.
    • Error - The campaign execution has failed. For more information, refer to Troubleshooting Metadata Campaign Issues.
    Attribute The metadata attributes being validated.
    Created Date The date on which the campaign was created.
    Due Date The date by which all reviews must be completed.

  2. Optional: Use the search, filter, sort, and column options to refine the table results as needed. For more information, refer to Searching, Sorting, and Filtering Results.

  3. To view the configuration of a metadata campaign and the progress of its associated reviews, open the campaign summary page.

    1. Select the campaign row, or in the Actions column, select actions > View Campaign Summary.

      The campaign summary page displays the following information:

      • Campaign details, such as owner and creation date.
      • Progress summary for the metadata reviews, including the number of objects (roles or entitlements) validated.
      • Metadata reviews generated by the campaign.

    2. Select Edit/View Campaign Configuration to view or edit the campaign configuration.

      Note

      For active campaigns, only the Active Period Duration settings are editable. You can use these settings to extend or shorten the review window. For staged campaigns, no sections are editable.

      Best Practice

      Changing the active period recalculates the due date for each open review set. Before shortening the active period for an active campaign, notify reviewers because their due dates will change.

    3. Select a metadata review to view its progress. For more information, refer to Viewing Assignments and Tracking Review Progress.

Viewing Campaign Schedules

Use the Campaign Schedules tab to view and manage the metadata campaign schedules.

Prerequisite: To access this tab, you must have the Meta Campaign Officer capability. For more information, refer to Metadata Campaign Administration.

  1. Go to the Campaign Schedules tab.

    For each schedule, the table displays the following information:

    Option Description
    Name The name of the scheduled campaign.
    Owner The identity who owns the scheduled campaign.
    Type The type of metadata campaign - Entitlement or Role.
    Attribute The metadata attributes being validated - Owner, Description, or both.
    Last Execution The date and time when the campaign last ran.
    Next Execution The next date and time when the campaign is scheduled to run.
    Result The status of the last execution - Success or Failed.

  2. Optional: Use the search, filter, sort, and column options to refine the table results as needed. For more information, see Searching, Sorting, and Filtering Results.

  3. To edit the campaign definition, select the schedule row, or in the Actions column, select Actions > Edit.

    The updated definition applies only to the future occurrences.

  4. To view the result of the most recent campaign run triggered by the schedule, in the Actions column, select Actions > View Last Result.

    Note

    The View Last Result option is available only after the schedule has run at least once.

    The campaign is scheduled using a background task based on the MetadataValidation Manager object of type TaskDefinition.

    The Metadata Validation Schedule Result page displays the following information:

    The Details section

    Field Description
    Name The name of the task.
    Type The type of the task – Metadata Campaign.
    Description The task description, if configured.
    Started By The identity that triggered the execution.
    Started The timestamp when the execution started.
    Completed The timestamp when the execution finished.
    Run Time The total execution duration.
    Host The server where the task executed.
    Status The execution result - Success, Failed, or Warning.
    Progress The completion state of the task.

    The Attributes section

    Field Description
    Campaign Type The type of the campaign – Role or Entitlement.
    Metadata Reviews Created The number of metadata reviews created in this run.
    Active Period Duration The configured active period for the campaign.
    Active Period Scale The unit for the active period, such as days, weeks, or months.

    Note

    This section is hidden when no statistics were recorded for the run.

    The Partitioned Results section

    This section displays the list of partitions created for the run.

    Field Description
    Name The partition name or identifier.
    Host The server where the partition executed.
    Status The execution status of that partition - Success or Failed.

    If the schedule has never produced a terminal task result, the page displays: "No result available".

  5. Select Return to Campaigns or Go Back Back to return to the Campaign Schedules tab.

  6. In the Actions column, select Actions > Use as a template to create a new campaign from an existing schedule. For more information, refer to Creating a Metadata Campaign.

Viewing Completed Campaigns

Use the Campaigns Completed tab to view campaigns for which all reviewers have signed off on their metadata reviews.

Prerequisite: To access this tab, you must have the Meta Campaign Officer capability. For more information, refer to Metadata Campaign Administration.

  1. Go to the Campaigns Completed tab.

    For each campaign, the table displays the following information:

    Option Description
    Campaign Name The name of the campaign.
    Campaign Owner The identity who owns the campaign.
    Type The type of metadata campaign - Entitlement or Role.
    Attribute The metadata attributes being validated - Owner, Description, or both.
    Created Date The date and time when the campaign was created.
    Completed Date The date and time when the campaign was completed.

  2. Optional: Use the search, filter, sort, and column options to refine the table results as needed. For more information, see Searching, Sorting, and Filtering Results.

  3. To view the configuration of a metadata campaign, open the campaign summary page.

    1. Select the row of the campaign, or in the Actions column, select Actions > View Campaign Summary.

      The campaign summary page displays the following information:

      • Campaign details, such as owner and creation date.
      • Metadata reviews generated by the campaign.

    2. Select Edit/View Campaign Configuration to view the campaign configuration.

    3. Select a metadata review to view its details.

  4. In the Actions column, select Actions > Use as a template to create a new campaign from an existing campaign. For more information, refer to Creating a Metadata Campaign.

Viewing Assignments and Tracking Review Progress

Use the Metadata Reviews tab to view reviews across campaigns. From this tab, you can monitor review progress, reassign reviews, and validate review items on behalf of reviewers when needed.

Prerequisite: To access this tab, you must have the Meta Campaign Administrator or Meta Campaign Officer capability. Note that with the Meta Campaign Officer capability, you can access this tab, but metadata reviews open in read-only view. For more information, refer to Metadata Campaign Administration.

  1. Go to the Metadata Reviews tab.

    For each metadata review, the table displays the following information:

    Option Description
    Metadata Review Name The name assigned to the review based on the Custom Name field configured during campaign creation.
    Campaign Name The parent campaign name.
    Reviewer The identity assigned to perform the review.
    Type The campaign type – Role or Entitlement.
    Attribute The metadata attributes being validated.
    Due Date The date by which the review must be completed.
    Sign Off Date The date when the review was signed off.

  2. Optional: Use the search, filter, sort, and column options to refine the table results as needed. For more information, see Searching, Sorting, and Filtering Results.

  3. To view the configuration of the parent metadata campaign and the progress of its associated metadata reviews:

    1. In the Actions column, select Actions > View Campaign Summary.

      The campaign summary page displays the following information:

      • Campaign details, such as owner and creation date.
      • Metadata reviews generated by the campaign.

    2. Select Edit/View Campaign Configuration to view the campaign configuration.

  4. To open the metadata review, select the row or in the Actions column, select Actions > View Metadata Review. For more information, refer to Reviewing Metadata Attributes.

    Tip

    If a reviewer is unavailable to review attributes, you can validate them as a Meta Campaign Administrator.

  5. Optional: To transfer a review ownership to another reviewer when the original reviewer is unavailable or the review is assigned incorrectly, do one of the following:

    1. To transfer a whole metadata review set to another user, in the Actions column, select Actions > Forward Metadata Review.

    2. To transfer ownership of only some review items from a review set:

      1. Open the metadata review, select the required review items, and from the Bulk Decisions dropdown menu, select Reassign.
      2. Select a recipient and then select Reassign.

      The selected items move into a child review set owned by the new reviewer.

    Important

    To reassign open metadata reviews when a reviewer leaves the organization, configure Reassign Artifacts in the Rapid Setup leaver process. For more information, refer to Leaver Configuration.

Activating Staged Campaigns

After you review a staged metadata campaign, activate it to start the review process.

Activation moves the campaign to Active, assigns metadata reviews to reviewers, sends them notifications, and calculates due dates from the activation time.

To activate a staged campaign:

  1. Go to the Campaigns tab and locate the campaign with Staged status.
  2. Select the campaign row or, in the Actions column, select Actions > View Campaign Summary.
  3. On the campaign summary page, select Activate Campaign.

You can also cancel a staged campaign before activation if it includes incorrect objects (roles or entitlements), or if reviews are assigned to incorrect reviewers.

To cancel a staged campaign, on the campaign summary page, select Cancel Campaign. This removes the generated campaign and the metadata reviews created for preview.

Note

For recurring campaigns, canceling a staged campaign does not stop future scheduled runs. If Enable Staging Period remains selected on the schedule, the next run is generated in staging mode.

To prevent future runs from being staged, go to the Campaign Schedules tab, edit the schedule, and clear the Enable Staging Period checkbox.

Reusing an Existing Campaign as a Template

You can create a new campaign that starts from an existing configuration instead of specifying the options from scratch.

  1. Open the Campaigns, Campaign Schedules, or Campaigns Completed tab.
  2. Find a campaign whose configuration you want to reuse.
  3. In the Actions column, select Actions > Use as a template.
  4. Review the prefilled information. For more information, refer to Creating a Metadata Campaign.
  5. Set the campaign schedule. For more information, refer to Setting the Campaign Frequency and Duration.

Searching, Sorting, and Filtering Results

On the Metadata Campaigns page, you can search for campaigns, schedules, and reviews, filter results by available attributes, sort results, and show or hide table columns.

  1. Search for a campaign, schedule, or review by name.

  2. Filter results by criteria such as campaign name, campaign type, campaign owner, or attributes being validated.

    The available filters vary depending on whether you are viewing campaigns, schedules, review sets, or review items.

  3. Sort results by selecting a sortable column header.

    Sortable columns display a double-arrow icon. After you sort a column, the icon changes to an up or down arrow to indicate ascending or descending order.

  4. From the Columns Columns dropdown list, select or clear columns to show or hide them in the table.