Creating a New Campaign
  • 12 Nov 2024
  • 6 Minutes to read
  • Dark
    Light
  • PDF

Creating a New Campaign

  • Dark
    Light
  • PDF

Article summary

You can create a new Campaign with minimal definitions and configurations using the user-friendly Campaign Wizard.

The Campaign Wizard comprises four steps:

  1. Users and Applications
  2. Message and Response
  3. Settings
  4. Summary

The following are some features of the Campaign Wizard:

  • The wizard steps are interactive, allowing you to click and progress from one step to the next (in order), as long as the step is not disabled.

  • The step that you are currently configuring shows the step number on a dark blue background. For example: CurrentStepIcon

  • The step that is configured shows a checkmark on a light blue background. CompletedStepIcon

  • Each step number of a Campaign that is not complete or has not been configured, shows the step number on a light gray background. For example: IncompleteStepIcon

  • Hovering over a gray step opens it, unless it is disabled, in which case it does not open.

  • In any of the Campaign wizard steps, when you fill in a field or update it, the changes are automatically saved.

  • At any step in the Campaign wizard, you can click Previous or Next to open the previous/next configuration step. Or you can click Close to return to the Campaign page. The Campaign appears in the table with the information you have so far configured for it.

To create a new Campaign

  1. In the Campaigns page, click Create Campaign. The Create New Campaign dialog opens with Step 1 open.
  2. In Step 1, configure the Users and Applications. Once you have completed filling in the required fields and the Query Preview is displayed, the Next button is enabled.
  3. Click Next, or in the left pane click Step 2.
  4. In Step 2, configure the Message and Response.
  5. Once you have completed selecting or filling in the fields, click Next, or in the left pane click Step 3.
  6. In Step 3, configure the Campaign settings.
  7. Once you have completed selecting or filling in the fields, click Next, or in the left pane click Step 4.
  8. In Step 4, review the Campaign configuration and review the Campaign Summary.
  9. Do one of the following:

Configuring Users and Applications

In the first step of the Wizard - Users and Applications, the Users module is selected and is the only option.

CreateCampaignStep1

You select a Query to determine the Campaign target audience, applications, permissions, roles, and approvers.
The selected query must include an adapter that supports IDM plus at least one assigned permissions/roles field.

To define the Campaign users and applications

  1. In the Query dropdown, select a query to determine the Campaign target audience, applications, permissions, roles, and approvers, or click + Add Query to create and add a new Query.
    • The Query Preview begins loading, and when done, shows the number of Users, number of Approvers, and the icons of the Applications.
    • If the selected query is not suitable, the Query Preview displays a message notifying that the selected query does not meet Campaign requirements and that you should select another user query that includes at least one adapter, and either an 'Assigned Roles' or 'Assigned Permissions' field.
    • If the query is correct but does not return results, the Query Preview notifies that no data was found.

The following example shows how to use the Query Wizard to create the Campaign Query Permissions query that searches for Users that have at least one of the following:

  • Slack membership (Slack adapter with ID field)
  • Approver email address (User Manager Email custom field exists)
  • Permission to use Okta (Okta adapter with Assigned Permissions field)

QueryWizardCampaignsPermissions

The Campaign Query Permissions query can then be selected in a Campaign, and run to select the Users, Approvers, and Applications in the Campaign.
CampaignStep1QueryPermissions

The following example shows how to use the Query Wizard to create the Campaign Query Roles query that searches for Users that have at least one of the following:

  • Slack membership (Slack adapter with ID field)
  • Approver email address (User Manager Email custom field exists)
  • Role that permits use of Okta (Okta adapter with Assigned Roles field)

QueryWizardCampaignsRoles

The Campaign Query Roles query can then be selected in a Campaign, and run to select the Users, Approvers, and Applications in the Campaign.

CampaignStep1QueryRoles

Creating Campaign Message and Response

In the Message and Response step (2), you can use Slack or Teams to send a message regarding the Campaign to each Approver (manager) regarding their Users and the Applications of each user (all resulting from the selected query in the previous step).

CreateCampaignStep2

To configure the Campaign message and response

  1. In the Message and Response dialog, under Message Method, click one of the enabled methods (white background): Slack or Teams. The selected method gets a light blue background.
    • If the method does not have an adapter in the system or the adapter is not available, the method is disabled, and Missing Adapter appears on top of the method tile.
  2. In Message Content, type the content of the message to send. The message content should be static.
  3. Under Response Options, for Revoke, from the Actions dropdown, select one of the following options:
    • Update in Axonius (default) - Updates the answer in the Axonius Campaigns Approval field, using the Custom Data enforcement action, without actually revoking. You can see this field in the Asset Profile Custom Data.
    • Revoke - Perform an action to revoke the user's permission, and also update the answer in Axonius (in the Campaign Approval field). The Revoke action is automatically selected according to the adapter connection selected in the query. For example, for a query with an Okta adapter connection, the Revoke action is Okta Suspend User.

CreateCampaignStep2Completed

Configuring Campaign Settings

In the Settings step (3), you can assign a meaningful name for the Campaign, set the Campaign End Date, and send a reminder to respond about the Campaign.

Note:

The system sends a reminder, if configured, even if the user already responded to the Campaign email.

To configure the Campaign settings

  1. In the Campaign dialog, in Campaign Name, assign a unique and meaningful name to the Campaign (default: Campaign Default Name). The Campaign name is updated in the top left pane.
  2. To add a description of the Campaign, click + Add description, and in the Description field that opens, type a meaningful description for the Campaign.
  3. To set the end date of the Campaign, toggle on Set Campaign End Date, click the End Date field that opens, and in the calendar that opens, select the end date.
  4. To send a reminder about the Campaign, toggle on Send Reminder, and then do the following:
    1. Select every how many Minutes, Days (default), or Weeks, to send the reminder. For example, Every 2 Weeks.
    2. Under Ends, optionally select when to stop sending the reminders:
      • Select the Completion of Campaign option (the default) to stop sending reminders once the Campaign has been completed.
      • Select the After option to select when to stop sending reminders: after a selected number of Occurrences (default: 7 Occurrences), Minutes, Days, or Weeks.

For example:
CampaignsStep3Completed

Reviewing the Campaign Configuration

After configuring all the Campaign steps and checking that the status of each step is completed, review the Campaign configuration.

CampaignStep4

Go back to a previous step if you want to change something in the configuration, and then look at the Campaign Summary again.


Was this article helpful?