query-parameters.md

The query parameters appear in the browser url after the filter path and after the ? character. There are a number of parameters that are consumed by chaise that the user doesn't need to be aware of. This document will outline the ones that the user can define that will affect how the application will behave.

Configurable parameters for users

• hideNavbar: This parameter is used to hide the navbar from showing in the application. It will be honored if it is set to true or false. By default, the navbar will always show if it is the top level app. If the navbar is attached to an app that shows in an iframe, the navbar will be hidden by default. Setting this property to false will show the navbar inside of an iframe. When present, this parameter will be propagated to all applinks on the current page (but not propagated to another app that may be nested in an iframe). When navigating away from the current page, the navbar will continue to be behave the same way unless the query parameter is changed.

• scrollTo: Include this parameter in a link to record app to scroll to a specific section of the page. The value should be the display name of the column or related table (inline or in the related table section). This should be the markdown_pattern defined in the appropriate display annotation for that related table or column. It should also be properly url encoded for the UTF-8 character set. More info about encoding.

  • There are 2 cases to consider, one is inline related tables and the other is related tables in the visible-foreignkeys section of record page. Below is the HTML representation of an inline Related Table in the visible-columns section of record app. The id on the element with class="entity-value" is the one that chaise uses to scroll to that specific inline related table. entity- is the static part of the identifier. The value after that is the displayname.value that was generated using a markdown_pattern. If no markdown_pattern was defined (no extra styling, just plain text), you can simply use the plaintext as it is displayed in the browser. In the following, that value is Fixation. If you aren't sure of what value to use, you can always look at the HTML structure and look for the element with the class column-displayname. There should be a <span> as a child of the column-displayname element. The contents of that element will be the displayname.value, which is what should be used in the query parameter.

  <tr ... id="row-frykLfd4AIhg-5mkjZGDZg" ...>
    <td class="entity-key ...">
      <span class="column-displayname" ...>
        <span ... class="ng-binding ng-scope">
          Fixation
        </span>
      </span>
      ...
    </td>
    <td class="entity-value ..." id="entity-Fixation">
      ...
    </td>
  </tr>

  • Below is the HTML representation of a Related Table from the visible-foreignkeys section of record app. The id on the .chaise-accodrion element is the one that chaise uses to scroll to that specific related table. rt-heading- is the static part of the identifier. The value after that is the displayname.value that was generated using a markdown_pattern. If no markdown_pattern was defined (no extra styling, just plain text), you can simply use the plaintext as it is displayed in the browser. In the following, that value is Images. If you aren't sure of what value to use, you can always look at the HTML structure and look for the element with the class chaise-accordion-displayname. There should be a <span> as a child of the chaise-accordion-displayname element. The contents of that element will be the displayname.value, which is what should be used in the query parameter.

   <div id="rt-heading-Images" class="chaise-accordion panel accordion-item">
     <div class="panel-heading accordion-button">
       <div class="chaise-accordion-header">
         <div class="chaise-accordion-displayname">
           <span>Images</span>
           ....
         <div class="chaise-accordion-header-buttons">
           ...
         </div>
       </div>
     </div>
     <div class="accordion-collapse collapse show">...</div>
   </div>

• limit: This parameter changes the number of rows that are returned by the ermrest request. This parameter is consumed by chaise and sent along with the requests to fetch data (recordset and recordedit only)

Set by application

• ppid, pcid, and paction: These two parameters will be available only on a number of requests. They will indicate which app, page, and action led to this current request. More info can be found in the logging document here.

Parameters for developers

Click to see detailed information about other query parameters used by the application.

• invalidate: This parameter is used to signal that create or edit was clicked in recordset or record app and the originating page needs to have the data refreshed after create or update succeeds and the page is focused again. This parameter is consumed by chaise and used for internal logic.
• savedQueryRid: This parameter indicates that recordset app is being initialized from a saved query. This parameter is consumed by chaise and used for internal logic (recordset only). Note: it is used for a specific use case in CFDE to navigate to recordset and apply a saved query from a static page.
• promptlogin: This parameter is used to signal that the application should present a login dialog on page load. This parameter is consumed by chaise and used for internal logic (record only) but could also be used to force showing a login dialog.
• copy: This parameter is used to signal to recordedit app that the app should be in "copy mode". Recordedit will read the data that mathes the filter information from the url and use that fetched data to set up a create form with information already filled in. This parameter is consumed by chaise and used for internal logic (record and recordedit only).
• prefill: This parameter is used to signal to recordedit app that the app should load data from cookie storage to prefill some of the inputs fields. This is used when linking related records in record app using the "Add Records" button. This is a parameter set by the application (record and recordedit only).
• page: This parameter is used to indicate which help page to load. This parameter is consumed by chaise and used for internal logic (help only).