--- title: "Configuration of guides and banners" slug: "configuration-of-guides-and-banners" updated: 2025-06-11T19:50:47Z published: 2025-06-11T19:50:47Z canonical: "documentation.encodify.com/configuration-of-guides-and-banners" --- > ## Documentation Index > Fetch the complete documentation index at: https://documentation.encodify.com/llms.txt > Use this file to discover all available pages before exploring further. # Configuration of guides and banners ## Configuration of guides(Modals and Tooltips) --- Only system or site administrators are allowed to CRUD guides including creation of new ones. To configure new guide: 1. Click on **Resource Centre** icon in sidebar **> Guides and Announcements > "Build"**tab 2. Click on **"Create"** button 3. Select **"Guide"** in opened popup ![Create.png](https://cdn.document360.io/3a63e0a8-1221-4570-aaa1-d43f9b95a612/Images/Documentation/17525065746717.png) *"Create" button in "Build" tab* ![popup.png](https://cdn.document360.io/3a63e0a8-1221-4570-aaa1-d43f9b95a612/Images/Documentation/17525076234269.png) *Popup with prompt to select guides or banners* In opened configuration modal it is possible to specify guide attributes, target users and pages, configure steps etc. ![Config.png](https://cdn.document360.io/3a63e0a8-1221-4570-aaa1-d43f9b95a612/Images/Documentation/17525076235805.png) *Configuration modal* There are next statuses available for selection and applying to guides: Inactive guides **"Draft"** - default status while creating new guide or for copied guide. guide with this status is no visible to users **"Scheduled"** - guide with this status will go live once specified Release Date occurs. Guide with this status is no visible to users **"Disabled"**- expired guide or guide that was disabled by admin. Guide with this status is no visible to users Active guides **"Public" -**guide with this status goes live immediately and visible to users. ![Status.png](https://cdn.document360.io/3a63e0a8-1221-4570-aaa1-d43f9b95a612/Images/Documentation/17525076237597.png) Along with guide's status Release date and Expiration date can be specified in configuration while selecting "Scheduled" or "Public" status or while editing Release date for previously selected status ![Set date.png](https://cdn.document360.io/3a63e0a8-1221-4570-aaa1-d43f9b95a612/Images/Documentation/17525076238365.png) *Set Release Date or Expiration Date in config header* **Release Date** - date when guide will become live as result visible to user. **Expiration Date** - date when guide will be disabled and won't be visible to user. ![Scheduled.png](https://cdn.document360.io/3a63e0a8-1221-4570-aaa1-d43f9b95a612/Images/Documentation/17525065764125.png) *Example of modal to specify Release and Expiration date* Note: For guide with status "Public" - Release Date can't be specified For guide with status "Scheduled" - Release Date is mandatory Settings section In this sections can be specified for guide: **Description** - input field for adding info about guide that should be visible in Guide search **Sort Order** - defines order of triggering guide in queue if multiple guides are configured for the same page **Display to Everyone** - allows to show guide for all users if enabled or specify user or access right or user group guide should be shown for. **Page** - allows to select page guide will be shown on: - Global (default page where guide will be shown on any page per site) - Dashboard - Workspace - Module View - Item View - Adbuilder(available for selection if Adbuilder is configured on site) - Proofing - Rule List - Rule View - App (available for selection if supported CAS or Hours App is configured on site) Supported views | **Page** | **View** | | --- | --- | | Module View | - Main search - Inline search - Micro search - CAS Search step | | Item View | - Fullscreen Item View (+ wizard) - Split view Item View - Itemsheet modal - CAS Item step - User Profile item | | Adbuilder | - Create pdf - Edit pdf | | Hours App | - Timesheet tab - Compliance tab | | Rules view | - Add Rule - Edit Rule | | Proofing | - Single item proofing - Compare items proofing - Batch proofing (WIP) | **Flow Frequency -**defines how guide should be triggered to be shown for user on specified page - **Show one time only** - default type, guide will be shown automatically first time user enters specified page.If guide is snoozed then it can be shown automatically again - **Always show** - guide will be shown automatically everytime user enters specified page.(Note: already shown guide won't be triggered again automatically on specified page in current user session.User should relogin again to trigger guide automatically) - **Do not show automatically** - guide won't be triggered automatically, but can be launched manually from Resource Center > Guides and Announcements or by clicking on badge if it was enabled and specified ![Settings.png](https://cdn.document360.io/3a63e0a8-1221-4570-aaa1-d43f9b95a612/Images/Documentation/17525076242461.png) *Settings section* Each guide has at least 1 step with default settings predefined.New step can be added as last step in guide by default. Max. 20 steps can be added for each guide. Step can be moved right/left, copied or deleted via step action menu ![Menu.png](https://cdn.document360.io/3a63e0a8-1221-4570-aaa1-d43f9b95a612/Images/Documentation/17525065766173.png) *Step action menu* Step configuration ![Step configuration.png](https://cdn.document360.io/3a63e0a8-1221-4570-aaa1-d43f9b95a612/Images/Documentation/17525076247709.png) *Step configuration section* In step configuration user can specify next attributes/elements for each step: **Layout: Modal or Tooltip** (Note: tooltip layout is not available for selection if Global, Dashboard page is selected or multiple apps are linked) **Position** (For Modal only) **Show Badge** - allows to hide/show badge on specified target element **Target Element -**allows to select target elements to link each step.List of available target elements depends on selected page in settings | **Page** | **Target Element** | | --- | --- | | Dashboard | No target elements available | | Workspace | - Workspace Name - Add widget button - Edit/View Toggle | | Module View | - Topbar - left - right - Add button - View selector - Breadcrumbs(**in v.18.0.0**) | | Item View | - Top toolbar - left - right - Bottom bar (Inline modules toolbar) - Status Button - Save Button - Proofing Button - Hours Button - Next Button (wizard) - Previous Button (wizard) - Field Label - Breadcrumbs(**in v.18.0.0**) | | Adbuilder | - Topbar - left - right - Save PDF button | | Proofing | - Top toolbar - Left - Right - Bottom toolbar - Left - Right - single/compare view toggle - Status button - Version selector - Comments Tab - Insights Tab - Thumbnails Tab - Metadata Tab | | Hours App | - Timesheet tab - Compliance tab - New Worklog Button | | CAS Storyteq/Remake | - pp Name - Next Button - Previous Button - Create New Request Button - View Request Button | | CAS Print | - App Name - Next Button - Previous Button - Restart Button - Create New Request Button - View Request Button | | Rules List | - opbar - left - right - Add button - Breadcrumbs(**in v.18.0.0**) | | Rule View | - Top toolbar - Left - Right - Save Button - Basic Info - Block Header - Condition - Block Header - Action - Block Header - Rule Type selector - Breadcrumbs(**in v.18.0.0**) | **Show backdrop** - allows to enable/disable backdrop **Background Colour -**allows to specify background colour for each corresponding step.Default is #FFFFFF **Add Element** - allows to add new element of type: Media,Text,Button **"Media"**element - allows to upload image, video, audio files for corresponding page. **"Text"**element**-**allows to add content for corresponding step using RTE **"Buttons"**element - allows to enable/disable buttons or adjust them on each guide's step. - "Previous/Next Step" button - navigation between steps - "Link to URL" button - redirects to specified page - "Dismiss" button - closes guide(the same logic as click on "X" button or on backdrop) - "Snooze button" - allows to snooze(delay) guide for the certain period of time. Guide will be shown automatically again if period the guide was snoozed for is passed **Allignment** - allows to define position of buttons on each step Media, Text, Buttons element can be moved up/down, copied or deleted via corresponding menu ![Element.png](https://cdn.document360.io/3a63e0a8-1221-4570-aaa1-d43f9b95a612/Images/Documentation/17525076249117.png) *CRUD elements* Each step UI is visualised in Preview section where user can view applied changes ![Preview.png](https://cdn.document360.io/3a63e0a8-1221-4570-aaa1-d43f9b95a612/Images/Documentation/17525065769245.png) *Preview section* ## Configuration of Banners --- In general configuration of banners is almost identical as for guides but there are some config points typical for banners only. 1. Click on **Resource Centre** icon in sidebar **> Guides and Announcements > "Build"**tab 2. Click on **"Create"** button 3. Select **"Banner"** in opened popup ![Banner.png](https://cdn.document360.io/3a63e0a8-1221-4570-aaa1-d43f9b95a612/Images/Documentation/17525076252701.png) *Popup with prompt to select guide or banner* Settings section ![Banner config_Settings.png](https://cdn.document360.io/3a63e0a8-1221-4570-aaa1-d43f9b95a612/Images/Documentation/17525065775773.png) *Settings section of banner configuration* The next points are not identical to guides and are specific for banner settings: **Allow Banner to Be Dismissed** - allows to hide/show "x" button in banner **Flow Frequency -**defines how banner should be triggered to be shown for user on specified page - **Show one time only** - default type, banner will be shown automatically first time user enters specified page. - **Always show** - banner will be shown automatically everytime user enters specified page. Note: banner can't be launched manually fro "Guides and Announcements" modal Banner configuration section ![Banner config section.png](https://cdn.document360.io/3a63e0a8-1221-4570-aaa1-d43f9b95a612/Images/Documentation/17526015233437.png) **Message** - allows to add content to be shown in banner using RTE **Banner Position** - allows to select banner's position (Top or Bottom) on the page **Background Colour** - allows to specify background colour for banner.Default is #2C8F96 ## CRUD guides/banners in configuration modal CRUD existing guides can be performed by admins only via configuration modal To open any existing guide or banner click on it's name in the search list in "Build" tab or click on "Edit" in ellipsis menu ![List_Edit.png](https://cdn.document360.io/3a63e0a8-1221-4570-aaa1-d43f9b95a612/Images/Documentation/17526015241501.png) In opened configuration modal user is able to CRUD existing guide/banner: Edit, Copy,Delete Note: while updating guide or banner with "Public" status it can be marked as "Unseen" that allows to trigger it automatically again on specified page and track latest changes for target users. ![Mark as Unseen.png](https://cdn.document360.io/3a63e0a8-1221-4570-aaa1-d43f9b95a612/Images/Documentation/17693681597085.png) Known behaviour: In case of specified in guide/banner configuration property(list of properties is below) is inactivated or deleted - such selected option will be cleared in guide config. If inactivated/deleted property is the last / only option to display - guide/banner will be inactivated silently(status will be changed to "Disabled"). Removal value/Guide inactivation event is tracked and can be fetched in System Change Log(**Location:** Site Config > System Change Log) Properties: - Module - Module View - Item View - Form tab/Wizard step - Field - Workspace - Dashboard - App - For those types will be just removed from guide and only disabled if not user and not access rights and no groups are specified: - Users - Access Rights - User Groups **Example:** Guide with Page - Module View, Modules - Module 1, Module 2, status - Public ![2 modules.png](https://cdn.document360.io/3a63e0a8-1221-4570-aaa1-d43f9b95a612/Images/Documentation/17694040039581.png) 1. Module 1 is inactivated/deleted in site config --> "Module 1" value is cleared in "Modules" field, guide's status remains "Public 2. Module 2 is inactivated/deleted in site config --> "Module 2" value is cleared in "Modules" field, guide's status is changed to "Disabled"