Properties installed with Content Experiences

  • Release version: Xanadu
  • Updated August 1, 2024
  • 8 minutes to read
  • Summarize
    Summarized using AI
    This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.

    Summary of Properties installed with Content Experiences

    The Content Experiences [snca] plugin introduces configurable properties that govern how campaigns run, particularly focusing on scheduled job execution and system performance. These properties help ServiceNow customers manage campaign operations efficiently, ensuring minimal performance impact even when targeting large user audiences.

    Show full answer Show less

    Access these properties via Content Experiences > Configurations > Properties to tailor campaign behavior and processing limits according to your instance size and campaign complexity.

    Key Property Categories and Their Practical Use

    • Approvals: Configure whether all approvers must approve scheduled content before publishing or if only one approver is sufficient.
    • Content Management Ownership: Enable ownership controls for audiences, content items, topics, and portal pages, allowing restriction and delegation of content management responsibilities.
    • Scheduled Job Runtime and Staggering: Set maximum run times for various scheduled jobs (e.g., updating campaign audiences, sending notifications, managing states) to limit processing duration per job and avoid system overload.
    • Event Staggering and Limits: Define staggering intervals and maximum users or events processed per scheduled job to balance workload and prevent performance issues, with default recommendations provided for audiences up to 100,000 users.
    • Non-Portal Content Handling: Manage limits related to sending emails and SMS notifications, including maximum events and users per event, to optimize notification delivery.
    • State Management: Control timing and processing limits related to campaign state transitions, including publication delays and immediate publishing options for smaller audiences.
    • User Deactivation and Purging: Specify maximum runtimes and batch sizes for deactivating campaign users and purging campaign data, with configurable retention periods post-campaign or post-user removal for data cleanup.
    • Campaign Re-evaluation: Set intervals for automatic re-evaluation of campaign audiences to keep targeting data current.
    • Portal Preview: Define the service portal URL suffix used for content previews, facilitating testing of content in different portal environments.

    Practical Impact for ServiceNow Customers

    By configuring these properties, customers can:

    • Optimize scheduled job performance to accommodate campaigns targeting large user bases without overloading the instance.
    • Control approval workflows to streamline or enforce multi-approver policies as needed.
    • Delegate content ownership and management securely, enhancing content governance across audiences, topics, and portal pages.
    • Manage notification delivery with precise limits and timing to ensure reliable communication via email, SMS, and push notifications.
    • Automate campaign lifecycle management, including state transitions, user deactivation, and data purging, to maintain system hygiene and compliance.
    • Customize portal preview settings to validate content display across different user-facing portals.

    Recommendations

    Default property values are optimized for campaigns targeting up to 100,000 users. For larger audiences or longer-running scheduled jobs, ServiceNow recommends carefully increasing property values after evaluating performance impacts in a test environment.

    Activating related plugins such as Notify (com.snc.notify) may be necessary for some notification-related properties to appear and function properly.

    The Content Experiences [sn_ca] plugin adds properties that determine how a campaign runs related to scheduled jobs and performance.

    To access Content Experiences properties, navigate to Content Experiences > Configurations > Properties.

    Content Experiences properties determine how the scheduled jobs run and help to ensure that there is limited impact on the performance of your instance.
    Note:
    Properties with an asterisk (*) in front of the name indicates that the default values are recommendations when the number of users targeted is 100,000 or less. If your audience is over 100,000 and the scheduled jobs run longer than expected, you can try increasing the values.
    Table 1. Approvals
    Property Usage
    All approvers must approve any schedule content record to publish it (sn_ca.all_must_approve) Indicates that all approvers must approve any scheduled content prior to publishing it. If you check No, only one approver is required to publish a campaign.
    Table 2. Enable Content Management Ownership
    Property Usage
    Allow Ownership for Audiences (sn_cd.activate_audience_delegation_controls) Indicates you want to be able to enable audience ownership within Content Experiences.

    For more information, see Content Ownership.

    Allow Ownership for Content Items (sn_cd.activate_content_authoring_controls) Indicates you want to be able to enable content item ownership within Content Experiences.

    For more information, see Content Ownership.

    Allow Ownership for Topics (sn_cd.activate_topic_ownership) Indicates you want to enable topic ownership within Content Experiences.
    Ownership of a topic includes:
    • Ability to restrict what groups or users can schedule content to a topic for a campaign.
    • Ability to edit content assigned to the topic.
    • Ability to preview content for the topic.
    Note:
    Other users that have access to the content can view the content scheduled to the restricted topic, but cannot remove the topic from the schedule.

    For more information on this and what roles are required, see Content Ownership.

    Allow Ownership for Portal pages (sn_cd.activate_page_ownership) Indicates you want to exclude groups or non-applicable content managers (specific users) from assigning content to a specific portal page.
    Table 3. Add users
    Property Usage
    *Max run time in seconds of scheduled job (Job will finish processing current item after time has elapsed) (sn_ca.add_users.max_run_time) The maximum amount of time (in seconds) the Content Experiences: Update Campaign Audience scheduled job runs. Limits the length of the scheduled job, but completes any work in progress and does not pick up any new work.

    Default value: 1,800 seconds

    The number of seconds to stagger events to process campaigns by (sn_ca.add_users.event_stagger.campaign) The amount of time between campaign events when a scheduled job runs. Staggering provides time for the events to be processed during the staggered time.

    Default value: 300 seconds

    The number in seconds to stager events to add user by (sn_ca.add_users.event_stagger.users) The amount of time between campaign events to add users when the Content Experiences: Update Campaign Audience scheduled job runs. Staggering provides time for the events to be processed during the staggered time.

    Default value: 3 seconds

    Max number of events to add users per campaign (sn_ca.add_users.max_events) The maximum number of events that users can be added for a campaign when the Content Experiences: Update Campaign Audience scheduled job runs.

    Default value: 1,000

    Max number of users to add per event (sn_ca.add_users.max_users_per_event) The maximum number of users you can add in a single event.

    Default value: 1000

    Table 4. Non-Portal Content
    Property Usage
    *Max run time in seconds of scheduled job (Job will finish processing current item after time has elapsed) (sn_ca.campaign.max_run_time) The maximum amount of time (in seconds) the Content Experiences: Add Non-Portal Campaign Content scheduled job runs.

    Limits the length of the Content Experiences: Send Email Notifications scheduled job, but completes any work in progress and does not pick up any new work.

    Default value: 2,700 seconds

    *Max number of campaign targets to process per job run (sn_ca.campaign.max_records_process) The maximum number of people a campaign can target per scheduled job run.

    Default value: 100,000

    *Max number of records to create per job run (sn_ca.campaign.max_records_create) The maximum number of records to create per job run.

    Default value: 100,000

    The number of seconds to stagger events to process pending content by (sn_ca.campaign.pending.event_stagger) The number of seconds between each time the Content Experiences: Add Non-Portal Campaign Content scheduled job runs to try to send non-portal content.

    Default value: 3 seconds

    Table 5. Non-Portal content limitations
    Note
    These properties determine limits on non-portal content (emails and SMS). The Content Experiences: Send Email Notifications scheduled job runs every hour by default and attempts to send non-portal content not sent in the first pass. Customers with a large database should consider increasing this property after testing the impact it could have on performance.
    Table 6. To-do Content
    Property Usage
    Max run time in seconds of scheduled job (Job will finish processing current item after time as has elapsed) (sn_ca.task.max_run_time) The maximum amount of time (in seconds) the Content Experiences: Create To-dos scheduled job runs. Limits the length of the scheduled job, but completes any work in progress and does not pick up any new work.

    Default value: 300 seconds

    Max number of records to create per job run (sn_ca.task.max_records_create) The maximum number of records to create per scheduled job run.

    Default value: 25,000

    Table 7. Notifications
    Property Usage
    The maximum number of users to add per event for SMS (sn_ca.sms_notification.max_users_per_event) The maximum number of users to add per event for an SMS notification.

    Default value: 1,000

    *Max run time in seconds of scheduled job (Job will finish processing current item after time has elapsed) (sn_ca.notification.max_run_time) The maximum amount of time (in seconds) the Content Experiences: Send Email Notifications, Content Experiences: Send Push Notifications, Content Experiences: Send SMS Notifications scheduled jobs run.

    Default value: 1,800 seconds

    *The maximum number of events to queue per job run for SMS (sn_ca.sms_notification.max_events) The maximum number of events to queue for SMS messages when the Content Experiences: Send Email Notifications, Content Experiences: Send Push Notifications, Content Experiences: Send SMS Notifications scheduled jobs run.

    Default value: 100

    Note:
    The Notify (com.snc.notify ) plugin must be activated for this sys property and Content Experiences: Send SMS Notifications scheduled job to appear.
    The number of seconds to stagger events by (sn_ca.notification.event_stagger) The amount of time between events when the Content Experiences: Send Email Notifications, Content Experiences: Send Push Notifications, Content Experiences: Send SMS Notifications scheduled jobs run. Staggering provides time for the events to be processed during the staggered time.

    Default value: 3 seconds

    *The maximum number of events to queue per job run for Email (sn_ca.notification.max_events) The maximum number of events to queue for the Content Experiences: Send Email Notifications, Content Experiences: Send Push Notifications, Content Experiences: Send SMS Notifications scheduled jobs run.

    Default value: 100

    The maximum number of events to queue per job run for Email (sn_ca.notification.max_events) The maximum number of events to queue per job run for email notifications.

    Default value: 100

    The maximum number of users to add per event for Email (sn_ca.notification.max_users_per_event) The maximum number of users to add per event for email notifications.

    Default value: 1,000

    Table 8. State Management
    Property Usage
    The number of seconds to stagger the sn_ca.campaign.published event after kicking off the Create To-Dos and Send Notifications Flow Designer Actions. Default is 2700 seconds or 45 minutes. (sn_ca.campaign.published.event_stagger) Determines the time to delay the publication of a campaign after the Create To-Dos and Send Notifications Flow Designer Actions are started.

    This sys property determines when the state of a campaign is set back to Published after going through the other states. The Published state is required for the scheduled jobs to pick up for future processing.

    Default value: 2700 seconds or 45 minutes.

    Max run time in seconds of scheduled job (Job will finish processing current item after time has elapsed) (sn_ca.state_management.max_run_time) The maximum amount of time (in seconds) the Content Experiences: Manage Content States scheduled job runs.

    Default value: 300 seconds

    Used to manage whether we want to trigger the campaign publishing process immediately after publishing the campaign. (sn_ca.publish.campaign.immediately) Check Yes to indicate you want a campaign to trigger immediately after selecting the Publish button.

    Checking Yes is recommended for campaigns targeting less than 100,000 users.

    Note:
    Selecting Yes bypasses the scheduled jobs and is dependent on the start date and time.
    Max number of records to update per job run (sn_ca.state_management.max_records_update) The maximum number of records to update per job run.

    Default value: 25,000

    Table 9. User Deactivation
    Property Usage
    Max run time in seconds of scheduled job (Job will finish processing current item after time has elapsed) (sn_ca.user_deactivation.max_run_time) The maximum amount of time (in seconds) the Content Experiences: Deactivate Campaign Users scheduled job runs.

    The scheduled job deactivates flagged users.

    Default value: 300 seconds

    Max number of users to deactivate per job run (sn_ca.user_deactivation.max_users_per_job) The maximum number of users to deactivate per job run.

    The Content Experiences: Deactivate Campaign Users scheduled job runs every six hours by default.

    Default value: 25,000 users

    Table 10. Content Experiences limitations
    Note
    These properties determine limits on the Content Experiences: Deactivate Campaign Users scheduled job for optimal performance. Customers with a large database should consider increasing this property after testing the impact it could have on performance.
    Table 11. Purging
    Property Usage
    Max run time in seconds of scheduled job (Job will finish processing current item after time has elapsed) (sn_ca.purging.max_run_time) The maximum amount of time (in seconds) the Content Experiences: Purge Campaign Data scheduled job runs.

    Default value: 300 seconds

    Max number of users to purge per job run (sn_ca.purging.max_users_per_job) The maximum number of users to purge per job run.

    Default value: 25,000

    Purge campaign data after the campaign ends (sn_ca.purging.purge_after_campaign_end) Purge all campaigns when the end date is reached.

    Default value: Yes

    Number of days after the campaign ends to start purging campaign data (sn_ca.purging.days_after_campaign_end) The number of days after the campaign end date when campaigns are purged.

    Default value: 180 days

    Purge campaign data for a user after user exits campaign (sn_ca.purging.purge_on_user_removed) Indicates if campaign information for a user should be purged after the user is removed from the campaign.

    Default value: Yes

    Number of days after user exits campaign to start purging campaign data (sn_ca.purging.days_after_user_removed) The number of days after a user is removed from a campaign to remove the campaign information.

    Default value: 180 days

    Campaign Re-evaluation

    Table 12. Campaign Re-evaluation
    Property Usage
    The number of days after which the campaign audience to be re-evaluated (sn_ca.campaign.reevaluation_frequency) The default number of days to re-evaluate a campaign audience.

    You can override this default from the Re-evaluate campaign and Re-evaluate frequency fields on the Campaign form. For more information, see View campaign targets.

    Default value: 7 days

    Portal Preview

    Table 13. Portal Preview
    Property Usage
    Service Portal URL suffix you want to use for portal previews (sn_cd.preview.portal_url_suffix) The URL suffix of the service portal or Employee Center (EC) your company uses for portal previews.

    You can change this system property when you want to preview your content over different portals.

    Default value: esc