# Setting up a content source THIS ARTICLE IS UNDER DEVELOPMENT Many parameters are straight forward - Related solution - Max cache age - Is active ### Unique NAME This is the calling name of the interface, that must be provided accessing the content service. Example for calling the view **myview** ``` .../cmsinterface?q=myview& ... ``` ### Query command Relevant commands include - General records - list: List of records - show: Single record - HTML formatted views - heat: Heatmaps - gant: Gant charts - xtab: Pivot tables - calm: Calendar ### Query parameters Parameters are provided without URL encoding ``` QUERY_FIELD_1=TITEL&QUERY_OPERATOR_1=8&QUERY_VALUE_1=Hello&QUERY_SHOWFIELD=TITEL StatusID DEADLINE ``` Procedure for easy parameter setup 1. Build views in frontend. 2. Activate the link and copy the URL 3. ´Remove unneeded parameters - command - SagID - QUERY\_NEW ### Possible parameters
QUERY\_FIELD\_nPart of the search/filter. The field to filter by.
QUERY\_OPERATOR\_nPart of the search/filter. The way to filter. Full list [Dashboard widget configuration](https://docs.tsnocode.com/books/dashboards/chapter/dashboard-widget-configuration-Ulo "Dashboard widget configuration")
QUERY\_VALUE\_nPart of the search/filter. The value to filter by.
QUERY\_SHOWFIELDThe fields to show in the list, separated by space.
QUERY\_PageSizeNumber of records to show pr page.
QUERY\_PageOffsetThe page number to show.
QUERY\_SortOrderThe field to sort ascending by. Use either this or SortOrderDesc.
QUERY\_SortOrderDescThe field to sort descending by. Use either this or SortOrder.
QUERY\_GroupingThe field to group records by.
QUERY\_GroupingDesc
### Dynamic parameter This specifies a parameter that will be set by the value provided in the **v** parameter. Example: Using this interface ``` Unique NAME: mylist Query command: list Dynamic parameter: QUERY_PageOffset ``` Making a call to ``` .../cmsinterface?q=mylist&v=2 ``` Will fetch a list of data and display page 2, because **2** is injected into **QUERY\_PageOffset**. Parameters and values are injected directly into the http request. **Note: Using the "show" command the variable will ALLWAYS get mapped to "DataID"** ## Using a content source Calling the **cmsinterface** servlet will provide you with an overview on how to use it. Example: ``` https://www.acme.com/TempusServa/cmsinterface ``` The interface requires just the name of the source, but additional parameters can be provided. Parameters - **q**: Name of the interface (required) - This name must match "Unique NAME" - **f**: Format of the result (optional) - Valid values: html json xml - **v**: Parameter for dynamic values (optional) - The value will be substituted to the parameter in "Dynamic parameter" Example: ``` https://www.acme.com/TempusServa/cmsinterface?q=mysource&f=json ``` ## Troubleshooting THIS ARTICLE IS UNDER DEVELOPMENT ### Configuration caching For performance reasons information about the content sources is kept cached. Adding or changing sources will propegate automatically : You will need to clear the system cache to pick the changes. ### Parameter encoding Note that URL's copied from a browser address bar are often encoded in HTML format. The content will not decode values and request strings, so all encoded strings will fail.