Description of the field values for the Custom Metric form.

Table 1. Custom Metric form
FieldDescription
Name Name of your custom metric type. The name appears on the Custom Metrics page.
Application Name of the application that you are creating the custom metric type for.
Icon An icon for the custom metric type. The custom metric type appears as the selected icon in Survey Designer.
Active Option to enable or disable the custom metric type. If selected, the Survey Designer shows the custom metric type.
Macro A macro that is used to render the custom metric type.
Note:
  • If the Macro field is empty, the question is not rendered on the platform form.
  • The macro record that you select must contain an input element with the following attributes. This input element holds the value for the metric.
    • datatype=”custom”
    • name= “${jvar_question_name}”
  • Value parameters can be accessed in a macro using the ${jvar_value_params} object.
Widget The widget is used to render the custom metric.
Note:
  • If the Widget field is empty, the question is not rendered on the portal form.
  • The widget record that you select must contain an input element with the following attributes. This input element holds the value for the metric.
    • ng-model="page.fieldValue"
    • ng-model-options="{getterSetter: true}"
  • The client script must have $scope as one of the parameters in the function definition. The value parameters can be accessed using the $scope.page.field.value_params object.
Result type Result type for the custom metric type.

If a value is changed, the new results are stored as per the new value and the previous results remain unchanged. If a value is changed from string to number, the reports might not show the charts properly. If a value is changed from number to string, the scorecard is shown in a list view.
Value parameters Value pairs that are passed to the custom metric type renderers. For example, in star ratings, you can pass a value as 5 for 5 stars or 10 for 10 stars.