How to: Set Up Drupal 11 for Schema App

Schema App’s Drupal Module has the ability to cache schema markup locally, pulling schema markup from Schema App’s Schema Markup Delivery Network.

Resources Required

• Schema App account
• Website on Drupal
• Drupal Composer

Instructions

• Step 1: Download Schema App's Drupal Module
• Step 2: Install Schema App's Drupal Module
• Step 3: Set the Deployment Method to Drupal
• Step 4: Configure Schema App module in Drupal

Step 1: Download Schema App's Drupal Module

• Schema App's module must be added with Composer. For more information, see Drupal's documentation on Using Composer to Install Drupal and Manage Dependencies.
• Go to the Schema App project page https://www.drupal.org/project/schemaapp and copy the Composer command under "Releases"

• Run the command from your command line. Once the command is complete you should see a message indicating the module has been added to your project's composer.json file as a dependency and the related code has been downloaded.

  
  

Step 2: Install Schema App's Drupal Module

• Navigate to the Extend page (admin/modules) via the Manage administrative menu. Locate the Schema App module, and check the box next to it. Click Install to install (turn on) the Schema App module.

Step 3: Set the Deployment Method to Drupal

• In another tab, log into your Schema App account. 
• Click the dropdown on your selected project and confirm that:

          1. You've added a website URL

          2. The deployment type has been set to Drupal

  
  

  

  
  

• In the Deployment Settings of your project, copy the Account ID and save it to your clipboard. You'll need this information soon.
  

Step 4: Configure Schema App module in Drupal

• Back in Drupal, navigate to Configure > System and choose “Schema App module settings”
   
   
  1. Enter the Account ID you copied from your Schema App account.
     
     
  2. Optionally configure the frequency by checking the CDN for new content (in seconds); the default is once every 24 hours.
      
     
  3. Optionally check “Use get parameters” if your Drupal configuration uses parameters over paths in its URL scheme i.e. https://example.com/posts?q=1234 as opposed to https://example.com/posts/october-update (in most cases this will be unchecked).  
     
     If you are not deploying markup from the Schema App Highlighter, click 'Save Configuration.' No further action is required. This also applies to Crawler deployments.
      
     
  4. If you are deploying markup from the Schema App Highlighter, check "Enable Highlighter JavaScript Markup". This will include the highligter.js scripts on the web page.
      
     Then click 'Save'.
      
     
     

     Note: If you are checking this for the first time on an existing installation, you may need to clear Drupal's cache.

     
     

No further action is required.                                                                                                  

Your plugin is now activated and will deploy markup to all URLs that you have created markup for in Schema App.

Support

For support with your Drupal module setup or to get your Account ID, contact your Customer Success Manager or [email protected].