Solar Archive Knowledge Base
  • 👋Welcome
    • Solar Archive's Structure
    • Contacting Support
    • Selling Email Archiving
    • White-label / Private Label
  • ⚡Quick Start
    • 1️⃣Creating a Tenant
    • 2️⃣Setting up Live Email Feed
    • 3️⃣Importing Old Email
    • 4️⃣Creating User Accounts
    • 5️⃣Checking Live Mail Receipts
    • ✅Finished Setup
    • 🆕Automated Onboarding
      • 1️⃣Admin Setup
      • 2️⃣Tenant Setup
      • 🔄Data Import
      • ☑️User Setup
  • 🧑‍🦲Managing Users
    • User Types
    • Creating Local User Accounts
    • Creating Basic User Accounts
    • Creating Data Guardian User Accounts
    • Creating Privileged User Accounts
    • Searching the User Directory
    • Adding a Delegation Link
    • Adding as Delegate
  • 🧙‍♂️Managing Tenants
    • Setting up a T1 Tenant
    • Setting up a T2 Tenant
    • Setting up a T3 Tenant
  • ⚙️Basic Configuration
    • Accessing Admin Options
    • Updating Company Information
    • Configuring Outbound Email Settings and Email Alerts
    • Configuring Global Account Settings
    • Managing Mail Server Connections
    • Configuring LDAP Settings
    • Managing Email Domains
    • Managing Email Addresses
    • Configuring Email Collector
    • Configuring SMTP Service Settings
    • Downloading / Emailing System Logs
    • Managing Exclusion Rules
  • ⚒️Advanced Configuration
    • Enabling Premium SSO
    • Configuring OAuth Connection Settings
    • Configuring Google Workspace OAuth and Service Account
    • Configuring Okta
      • Configuring Okta with SAML
      • Configuring Okta with SSO
    • Configuring Advance Company Settings
    • Setting Retention Period
    • Setting Search Date Limit
    • Setting Report Consolidation Period
    • Setting Case Folder Configuration Limits
    • Configuring Global Settings
    • Configuring SMTP Settings
    • Configuring Web Security Settings
    • Configuring System Alert Settings
    • Managing LDAP Search Filters
    • Viewing Company Summary
    • Managing Date Formats
    • Managing Headers
    • Configuring Error Email Respool Settings
    • Configuring De-Duplicated Email Respool Settings
    • Configuring Excluded Email Respool Settings
    • Configuring Windows File Share Settings
    • Tenant Deletion Procedure
    • Adding Custom Scripts to your Archive
    • Setting up Stubbing
    • OAuth Setup with Solar Archive
  • 🗃️Using the Archive
    • 🔎Search
      • Searching your Archive
      • Saving your Search
      • Sharing your Search
      • Filtering Search Results
      • Search (Classic Interface)
    • 📦Spaces
      • Creating a Space
      • Adding to a Space
      • Sharing a Space
    • 📄Results
      • Downloading a Single Result
      • Downloading Multiple Results
      • Printing Results
      • Result Headers
      • Forward Results
      • Restore Results
      • Saving to Space
      • My Archive
    • ⏳History
      • Saved Searches
      • Recent Search History
  • 🔐Legal Hold
    • Creating a Legal Hold Request
    • Managing Legal Hold Requests
  • 🗑️Authorised Delete
    • Requesting a Deletion
    • Managing Deletion Requests
  • 🏛️Archive Management
    • 🧲Importing Data
      • 📥Mailbox Reader
        • Creating a New Mailbox Reader Import
        • Monitoring Mailbox Reader Imports
      • 🗂️Configuring Folder Replication
        • Getting Started
        • Configuring a new Connection for Folder Replication
        • Monitoring Folder Replication
        • Completion of Folder Replication Process
        • Using Folder Replication
    • 🎨Branding
    • 💰Billing
      • Monitoring Usage
      • Submitting Reports
  • 🔌Outlook Add-in
    • Local Add-in Install
    • Centralised Add-in Install
    • Introduction to the Outlook Add-in
    • Searching via the Outlook Add-in
    • Pinning the Outlook Add-in
    • Continuing your Add-in Search on the Archive Interface
  • 🛰️Release Notes
    • 26-01-2024 (v9.4.4-b69-00)
    • 11-10-2023 (v9.4.4-b52-00)
    • 10-05-2023 (v9.4.4-b52)
    • 06-03-2023 (v9.4.4-b50)
    • 20-01-2023 (v9.4.4-b46)
    • 06-05-2022 (v9.4.4-b29)
    • 28-01-2022 (v9.4.4-b21)
    • 09-12-2021 (v9.4.4-b15)
    • 15-10-2021 (v9.4.4-b14)
    • 05-10-2021 (v9.4.4-b12-00)
    • 30-07-2021 (v9.4.3-b8)
    • 18-05-2021 (v9.4.3-b7)
    • 19-02-2021 (v9.4.3-b1)
    • 04-02-2021 (v9.4.2-b20)
    • 15-01-2021 (v9.4.2-b17)
  • OAuth setup with Office 365
Powered by GitBook
On this page

Was this helpful?

  1. Advanced Configuration

Adding Custom Scripts to your Archive

Add custom scripts to your Solar Archive system.

You may be wanting to add a custom script to your archive, such as Google Analytics or a help desk chat widget. Adding custom scripts to your archive is easy with our “Custom Code” feature. Please be aware, the custom code block will only accept compliant code, if your code is not saving, please check it is complete.

  1. Login to your Archive as an Admin User

  2. Click “Admin” on the system where you’d like to add the custom script

  3. On the company's page, you’ll see a list of the active companies. Once here, you’ll be able to administer certain systems.

  4. Expand “Advanced Configuration” and click “Adv. Config”

  5. Choose who the code block should be active for

    1. There are 3 configuration options provided in the application. These are:

      • Admin Code Block: The piece of code entered under this configuration option would be displayed on the UI for admin users only.

      • Basic Code Block: The piece of code entered here would be displayed on the UI for basic users only.

      • All Users Code Block: This piece of code would be displayed on the UI for privileged users only.

  6. Add your desired code

  7. Once you’ve added your code, click “Save”.

Caveats

You may run into the following issues when using our code block feature.

My code block isn’t saving?

If your code block isn’t saving, please make sure you’ve copied it correctly. Our system doesn’t allow incomplete code.

My widget is not appearing?

If your widget is not appearing, make sure it is not loading any HTML elements in this code block. If it needs a <div> tag to load the widget, it will not work in this code block feature. The code block appends scripts in the <head> of your archive. Another reason for this could be your adblock plugins/extensions blocking your script from loading.

What does the code block accept?

The code block feature allows you to dynamically insert script tags into your archive. It will not accept HTML or anything other than scripts.

Why is my code not appearing for my tenant?

If enabled, Tenants can add their own code to their archive environment’s which overwrites your code block. Below is a good breakdown on how the overwriting works for our systems:

  • If the code block is overridden by the tenant then serve it and stop, if not

  • If the code block is overridden by the T2 then serve it and stop, if not

  • If the code block is overridden by the T1 then serve it and stop, if not

  • Is there a global code block, then serve it and stop, if not

  • Do not serve any code block.

PreviousTenant Deletion ProcedureNextSetting up Stubbing

Last updated 2 years ago

Was this helpful?

⚒️