Start a conversation

Modifying Custom Themes Using Soy/ FTL Templates

Overview

Jive allows customers to develop and deploy their custom themes. To do this, they would use Soy or Freemarker (FTL) templates. By implementing these themes, they can modify the Jive application's underlying page templates.

NOTE: This article is a component of Big Book of Backporting, which you can review for additional context and information.

 

WARNING! All modifications to soy files should be made directly in the theme. Do not add soy files to fixpack or Custom WAR.

This article explains how to edit the Jive application's underlying page templates using Soy/ FTL templates.

 

Process

  1. Navigate to Admin Console > System > Settings > Themes and edit the theme that is listed under Global Theme Map.

    mceclip0.png

  2. For all existing Custom Templates, apply only the difference that can be found in the fixpack's patch file.
    • This way, if fixpack changes the /soy/status_input/status_input_attachments.soy file (which is already customized - see the screenshot below), you need to find the differences and apply only them.
    • For all other files from the fixpack not visible in the Custom Templates list, see Step 3.

      mceclip1.png

  3. In Create Custom Template, select the file which needs to be modified and click the Create New Template button.
    • For instance, if you need to modify /soy/userregistration/userregistrationform.soy, you would find it in the list of available files for that theme.

      mceclip2.png

  4. Make the changes and press Save Template. On the Edit Theme page, the file now shows up in the list of Custom Templates.

    mceclip3.png

  5. For the changes to be reflected in the instance, regenerate JavaScript. 
    1. Go to Admin Console > System > Management > System Properties.
    2. Set jive.resource.salt to the current epoch timestamp.
      • This property was created to force-generated JavaScript to be removed so that when it gets regenerated, the path would include some new unique ID or sequence number without having to restart the application.
  6. Clear caches.
    1. Go to Admin Console > System > Settings > Caches.
    2. Select all caches by clicking the checkbox on the top right of the list of caches.

      mceclip4.png

    3. Scroll to the bottom of the page and click Clear Selected.
  7. Repeat these steps for all soy files included in the commit.

DOC-259657.pdf

  1. 65 KB
  2. View
  3. Download

DOC-259657.pdf

  1. 65 KB
  2. View
  3. Download

mceclip0.png

  1. 22 KB
  2. View
  3. Download

mceclip1.png

  1. 214 KB
  2. View
  3. Download

mceclip2.png

  1. 104 KB
  2. View
  3. Download

mceclip3.png

  1. 98 KB
  2. View
  3. Download

mceclip4.png

  1. 156 KB
  2. View
  3. Download
Download all
Choose files or drag and drop files
Was this article helpful?
Yes
No
  1. Priyanka Bhotika

  2. Posted
  3. Updated

Comments