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 for your Apliqo application server.

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

“UX_App_Log”:false

  • Set this to true to enable the user usage tracking by screen. By default, this will be set to false.  

“UPLOAD_MEDIA_PATH”: “mediaFolder”

  • Allow specifying the folder path for storing the uploaded media files.

Note: Always the base path for uploaded files will be ... webapps/<webAppName>/files/<instanceName>/mediaFolder
... where "mediaFolder" is the folder name specified in the UPLOAD_MEDIA_PATH constant

“USE_BROWSER_LOCALE_AS_LOCALE”: false

  • Allow determining the language for the app. If this option is set to true, then the app will take the local browser language to display for localization. Note: This will set the http header in all Rest API communication with reporting instances. If a reporting instances has been localized with multi-language attributes then Apliqo UX will display the locale-dependent attribute values.

 “USE_FAVORITES”: true

  • Default=true. Set this value to false to disable the favourites functionality. Users will then not be able to add screens to their personal favorites collection.

“ALLOW_PASSWORD_CHANGE”: false

  • Default=false. Set this to true to allow users to change their TM1 login password. (Only relevant if TM1 basic authentication is being used IntegratedSecurityMode=1 in tm1s.cfg). 

New Advanced Options

Version 2.5.2 includes the following new advanced options to control the features and behavior of widgets in UX applications.

TOOLBAR:

“toolbar”: {

  “realTimeButtonEnabled”: true,

  “realTimeEnabled”: true

}

realTimeButtonEnabled

  • Enable the real-time recalculation button in the application

realTimeEnabled

  • Enable this option to auto-refresh on data entry by default

VIEWS & GRID WIDGET:

"table":{

  "autoColumnWidth":false,

  "filters":{"enabled":true},

  "inserting":true,

  "defaultDate":"20/12/2020",

  "datePickerConfig":{"firstDay":0,"showWeekNumber":true,"numberOfMonths":3},

  "inputOnConsolidations":{"enabled": false,"defaultSpreadingPrefix": "P",                 "defaultSpreadingDirection": ""}

}

autoColumnWidth

  • Default=false. Set whether the columns should be set to auto width. (This can also be set in custom default.constant.js.)

filters

  • enabled=true will display drop-down menu for all columns and false will hide display of column filter menu for all columns.

inserting

  • Set value to true to enable the ability to add rows/columns (Edit mode only).

defaultDate

  • Set the default date that you wish to date picker to show if no value is currently set in the cell.
    E.g. "20/06/2008"

datePickerConfig

  • Set the default date picker configuration for the number of months to be available in the date picker dialogue. Please refer to the handsontable documentation.

inputOnConsolidations

  • enabled: Set value to true to enable automatic data spreading on consolidations by keying or pasting over cell values. Default false
  • defaultSpreadingPrefix: Default spreading prefix to be applied before value entered. If one is entered with the value then this will not be applied. eg: "p" for Proportional Spread
  • defaultSpreadingDirection: Default spreading direction. eg: "<>" for left and right.

WIDGET CARD:

"cardConfig":{

    "footer":{"showModalButtonsInFooter": true,"showSubsetSelectionInFooter": true}

 }

footer

  • showModalButtonsInFooter: True will display the modal buttons in card footer
  • showSubsetSelectionInFooter: True will display the subset selection in the card footer

CHARTS / KPI / KPI SIMPLE / KPI TREND / ORG CHART / MAPS:

"targetView":[{"view":"a14.v2","viewType":"View"}]

NOTE:  Only the first object will be taken for these widgets

view: 

  • Set the view id

viewType

  • Set the view type (ie. View / Dashboard / Wizard )

KPI Simple:

"kpiSimple":{

     "backgroundColor":"#efefef",

     "textColor":"#333"

}

backgroundColor: 

  • Set the background colour for the KPI simple cards.

textColor

  • Set the text colour for the KPI simple text.

KPI Trend:

"kpiTrend": {

    "chartType": "column",

    "chartColor": "#ff2b00",

    "showReference": true,

    "greenReferenceCondition": ">",

    "greenReferenceValue": "35",

    "yellowReferenceCondition": ">",

    "yellowReferenceValue": "20",

    "redReferenceCondition": "<=",

    "redReferenceValue": "10",

    "showOriginalValues": false,

    "backgroundColor": "#efefef",

    "textColor": "#333",

    "percentCalcMethod": "1"

}

chartType: 

  • Set the chart type. By default, set to line chart ("chartType": "line")

chartColor: 

  • Set the chart color

showReference: 

  • Set true to display the reference conditions. Default=false

greenReferenceCondition: 

  • Set the condition for the green arrow (<,>,==,!=,!==,>=,<=,===)

greenReferenceValue: 

  • Set the value for the green reference 

yellowReferenceCondition: 

  • Set the condition for the yellow arrow (<,>,==,!=,!==,>=,<=,===)

yellowReferenceValue: 

  • Set the value for the yellow reference 

redReferenceCondition: 

  • Set the condition for the red arrow (<,>,==,!=,!==,>=,<=,===)

redReferenceValue: 

  • Set the value for the red reference 

showOriginalValues: 

  • Set the value to true to display the full number. i.e : (instead of the 12.3 M - it will show 12,300,000).By default, set to false

percentCalcMethod

  • Set the percentage calculation method to "2" to use the formula (A-B/A) x 100. By default it is set to "1". [Formula : (A/B-1) x 100]

textColor: 

  • Set the text colour for the KPI trend text.

backgroundColor: 

  • Set the background colour for the KPI trend cards.

CHARTS:

"chartOptions": {     

    "showDrillUpButton": true,     

    "crossDrill": {       

        "enabled": true,       

        "limitDrillTo": ["Account","Department"]     

    },     

    "chartNullValues": true,     

    "absolute": true,     

    "waterfall": {       

        "weightAttribute": "Weight",       

        "upColor": "#4472c4",       

        "downColor": "#ed7d3",       

        "singleEndPoint": {         

            "color": "#a5a5a5",         

            "addTotal": true,        

            "totalName": "Total"      

        }     

    },     

    "plotOptions": {       

        "series": {        

            "dataLabels": {           

                "enabled": false         

            }      

        }    

     },     

    "chartsTooltipFormat": "%"   

}

showDrillUpButton: 

  • Show the Back button when drilling into a chart. Default is for it to be false (i.e. hidden).

crossDrill: 

  • enabled: To enable or disable crossDrill functionality. Default=true.
  • limitDrillTo: Array of dimension hierarchies to make available for crossDrill. (If not specified then default is all dimension and alternate hierarchies available in the cube, excluding the hierarchies already specified on rows.)

chartNullValues: 

  • Specify whether you wish to chart null values as 0 so they appear on the charts. Default is true. By setting to false any zero/null values preceding or following non-zero values will be converted to #NA and not plotted in the chart series. This is useful functionality to avoid messy looking charts due to values jumping from the x-axis when the data series starts. (This is not standard highcharts functionality)

absolute: 

  • Specify whether you wish to see absolute values of underlying data. This is useful functionality when comparing measures where the sign can be reversed, for example Revenue vs. COGS where cost data may have a negative value in the TM1 cube. (This is not standard highcharts functionality)

waterfall: 

  • waterfall: Object containing upColor, downColor and singleEndPoint (only applicable to waterfall-single) configurations. Used in waterfall and waterfall-single charts. (This is not standard highcharts functionality)   
  • weightAttribute:  Specify a tm1 attribute where weighting will be applied from. Part of waterfall object. Used in waterfall and waterfall-single charts. (This is not standard highcharts functionality)

plotOptions: 

  • series:  Add multiple series to the chart 
  • dataLabels: Config the labels and the format.

chartsTooltipFormat: 

  • Specify the suffix symbol that needs to be displayed on the tooltip. i.e 100%.

Change password

Depending on the loginInstances value in the instances.json file (which instructs UX which instances have the same login method and credentials as the Content Store) Apliqo UX will automatically update the user's password on all instances.

Note 1: the change password feature is only supported for standard TM1 security (IntegratedSecurityMode=1 in tm1s.cfg)

Note 2: by default the change password feature disabled, in order to enabled it , you must turn the 'ALLOW_PASSWORD_CHANGE' parameter to True in the default constants file. See the new control parameters section.

Note 3: in addition to the parameter change in the default.constants.js file, the settings.json file must also be edited to enable this feature. The required changes are described below.

To enable password changes the settings.json file for the web app must be changed. This file is found in the WEB-INF/config directory of the web app.

The allowedRestPaths parameter must be changed from the default empty value to the following.

 "allowedRestPaths": [

   {

     "path": "/ExecuteProcessWithReturn",

     "method": "POST"

   },

   {

     "path": "/Users.*",

     "method": "PATCH"

   }

 ],

Warning: If you set "ALLOW_PASSWORD_CHANGE": true, but neglect to implement the change to allowedRestPaths in settings.json then the "Change Password" menu option will be displayed and available to users but will not work!

0 Comments

Add your comment

E-Mail me when someone replies to this comment