New Control Parameters

New Application Constants

The default.constants.js file is located in the apq-c3-custom/js folder within the web app directory of the root install directory of your Apliqo Application server.

This file stores default constants for the Apliqo UX application. Version August release includes the following new application constants:   

“KEEP_SESSION_ALIVE”:true

  • Set this to false to disable the session. By default, it will be set to true 

“APPMART_ENABLED”:true

  • Set this to true to enable the App mart module. By default, it will be set to false

PRINT_OPTIONS: {

      IMAGE_PATH: 'apq-c3-custom/images/',         

      APPLICATION_PRINT_NAME: 'UX',         

      APPLICATION_PRINT_LOGO: 'Apliqo-logo.svg',         

      PRINT_TOP_RIGHT_MESSAGE :'Apliqo UX is a browser-based user interface for TM1 and IBM',

      PRINT_TOP_RIGHT__BEFORE_MESSAGE:'Printed on: ',         

      DATE_PRINT_FORMAT:'dd-MMM-yyyy h:mm a'

}

  • IMAGE_PATH: Set the image path
  • APPLICATION_PRINT_NAME: Set the print title 
  • APPLICATION_PRINT_LOGO: Mention the logo name with the format. (For eg., Apliqo.svg)
  • PRINT_TOP_RIGHT_MESSAGE: Mention the message that needs to be displayed on the right side
  • PRINT_TOP_RIGHT__BEFORE_MESSAGE: Set the message that needs to be displayed before the message
  • DATE_PRINT_FORMAT: Set the date format.

"copyPaste": { 

    "columnsLimit": 1000, 

    "rowsLimit": 10000 

}

  • copyPaste: Configure the copy/paste functionality in the table. Please refer to https://handsontable.com/docs/7.4.2/CopyPaste.html
  • columnsLimit: The maximum number of columns that can be copied
  • rowsLimit: The maximum number of rows that can be copied


New Advanced Options

Version August release includes the following new advanced options to control the features and behaviour of Widgets in UX applications.

Popup
"modalsView": {
    ...
    "htmlOnly":false,
    "autoRefreshOnClose":false
}

htmlOnly:  Set to true to render only HTML widgets without any modal header.

autoRefreshOnClose: Set to false to disable auto-refresh on close of popups.

Grid
{
    ...
    "table": {
        ...
        "copyPaste": {
            "columnsLimit": 1000,
            "rowsLimit": 1000
        },
        "stretchColumnWidth": true,
        "showThreeDotsMenuInCells": true, 
        "activeRow": {
            "enabled": true,
            "class": "activeRow"
        },
        "functions": {
            "beforeTableUpdate": "doSomething",
            "afterCellUpdate": "doSomething",
            "afterTableUpdate": "doSomething",
            "beforeTableUpdate": "doSomething"
        }
        ...
     }
    ...
}

stretchColumnWidth: Set whether the table should be stretched to the width of the available space.   (This can also be set in custom default.constant.js.  By default it is false)

showThreeDotsMenuInCells:  Show the three dots menu in cells in addition to being able to right-click on the cell for the context menu.

activeRow: activeRow settings

  • enabled: Whether active rows are enabled.  Default true
  • class: Default class for activeRow.  Default: activeRow

functionsCustom hook functions

  • beforeCellUpdate: Function that is called before the cell is updated
  • afterCellUpdate: Function that is called after the cell is updated
  • afterTableUpdate: Function that is called after the table is updated
  • beforeTableUpdate: Function that is called before the table is updated
Card Config
"cardConfig": {
    ...	
    "autoRefresh":false
    ...
 }

autoRefresh: Set this to false to avoid refreshing the widget when settings service changed. By default, Expect for navigation list, all other widgets set to true

KPI Simple
{
    "kpiSimple": {
        ...
        "fitToWidget":true,
        "minWidth": "200"
        ...
    }
}

fitToWidget: Set the fitToWidget (i.e. true / false). i.e. to display all kpis fit inside the widget.

minWidth: Set the minimum width of KPI when fitToWidget is set to true.

Charts
{
    "chartOptions": {
        ...
        "waterfall": {
            ...
            "showCellCommentary": true,
            "commentRow": 0,
            ...
         }
     }
}

showCellCommentary: Show cell commentary. Enter annotations in the underlying table to view in the chart. (By default this is false)

commentRow: The row from the table to get the cell annotation from.

HTML
{
    "htmlSnippet":"admin/app.html"
}

htmlSnippet: Mention the snippet name.

Note: Name should include the folder name as well to load the snippet. Always, the HTML snippet option takes the high priority than HTML template 

Cube Viewer
{
    ...
    "cubeView": {
        "instance": "$<<contentStore.}APQ UX Instance.}APQ UX Instance>>",
        "cube": "$<<UX_Demo.}Cubes.}Cubes>>",
        "viewName": "Default",
        "applyGlobalSettings": true,
        "viewDefininitionVisible": false,
        "hierarchiesVisible": false,
        "realTime": false
    }
    ...
}

applyGlobalSettings: Apply all values from settings service over local settings (default: false) 

cube: Default cube

hierarchiesVisible: Initial toggle setting for the visibility of the hierarchies in the viewDefinition.  (default: true)

instance: Default instance

mdx: Set MDX for this cubeView.  Can't be changed once set.

realTime: Initial toggle setting for whether the table is updated in real-time, ie each time a change to the view definition is made.  (default: true)

toolbarVisible: Whether toolbar should be visible.  (default: true)

viewDefinitionVisible: Initial toggle setting for the visibility of the viewDefinition.  (default: true)

viewName: Default View to load

Single DBR
{
   ...
   "singleDbr": {
        "title": "$<<UX_Demo.Region.Region>>",
        "readOnly": false,
        "titleFontSize": "18",
        "textColor": "#f00",
        "decimalFormat": "2",
        "backgroundColor": "#b34c4c",
        "percentageFormat": false,
        "showReference": false,
        "reference": {
            "greenReferenceCondition": ">",
            "greenReferenceValue": 1000,
            "yellowReferenceCondition": ">",
            "yellowReferenceValue": 5000,
            "redReferenceCondition": "<",
            "redReferenceValue": 2000
        },
        "slider": {
            "allowManualInput":false
            "enabled": false,
            "max": 12345,
            "min": 100,
            "sliderSensitivity":1
        }
    }
    ...
}

title: Set the placeholder to display the title 

titleFontSize: Set the font size for the title

readOnly: Set true to force the cell to be READ-ONLY, always

textColor: Set the text color for the entire box

decimalFormat: Set the decimal format

percentageFormat: To display percentage, set this to true

showReference: To display reference color, set this to true

greenReferenceCondition: Set the condition for the green color (<,>,==,!=,!==,>=,<=,===)

greenReferenceValue: Set the value for the green reference

yellowReferenceCondition: Set the condition for the yellow color (<,>,==,!=,!==,>=,<=,===)

yellowReferenceValue: Set the value for the yellow reference

redReferenceCondition: Set the condition for the red color (<,>,==,!=,!==,>=,<=,===)

redReferenceValue: Set the value for the red reference

slider: To show the slider instead of text box, set this to true and set the max and min values.

allowManualInput: Set this to true to enable input text along with the slider.By default, set to false

sliderSensitivity: Set the step value for the slider. By default, set to 1

Small Multiple
{
  ...
  "smallMultiple": {
    "maxChartsPerRow": 2,
    "chartType": "line",
    "legend": false,
    "titleDisplay": true,
    "World": {
      "stacked": false,
      "chartType": "bar",
      "border": {
        "enabled": false,
        "borderColor": "#3e0",
        "borderSize": "2px"
      },
      "series": [
        {},
        {
          "dataLabels": {
            "enabled": true,
            "format": "{point.y:,.0f}"
          },
          "type": "line",
          "color": "#f00"
        },
        {}
      ]
    },
    "America": {
      "stacked": true,
      "chartType": "column",
      "border": {
        "enabled": false,
        "borderColor": "#f00",
        "borderSize": "3px"
      }
    },
    ...
  }
  ...
}

maxChartsPerRow: Mention the number of charts that need to be shown per row

chartType: This type will be applied to all the charts

legend: Set true or false to show the legend.By default, its set to true.

titleDisplay: Set true or false to show the chart title. If chart title set to true, the x-axis label will hidden and vice-versa.

stacked: Enable the stack chart (applies apply to bar / column / area chart)

chartType: This type will be applied to the individual chart. This will override the global chart type.

border: Set the border for the individual chart using this option 

enabled: Enable the chart border

borderColor: Set the chart border color

borderSize: Set the chart border size

series: Add multiple series to the chart

Process
{
    "process":{
        ...
        "initCallback":"demoProcessInitCallback",
        "cancelCallback":"demoProcessCancelCallback",
        "beforeForm":{
            "htmlSnippet":"samples/employee-attributes.html"
        },
        "afterForm":{
            "htmlSnippet":"samples/employee-attributes.html"
        },
        "statusNotifications":{
            "success":{
                "callback":"demoProcessSuccessCallback",
                "htmlTemplate":"test.html",
                "htmlSnippet":"samples/employee-attributes.html"
            },
            "failed":{
                "callback":"demoProcessSuccessCallback",
                "htmlTemplate":"test.html",
                "htmlSnippet":"samples/employee-attributes.html"
            }
            ...
        }
    }
}

initCallbackSet the init function name that need to be executed 

cancelCallbackSet the init function name that need to be executed

htmlSnippet: Set the html snippet name  

htmlTemplate: Set the html template name

callback: Mention the call back function name in the respective status notification to trigger the custom logic


0 Comments

Add your comment

E-Mail me when someone replies to this comment