Disclosure

Properties

A disclosure is a statement or a document the explains the important information to the participants in a transaction. Disclosures can be associated with component actors and their actions. Each component actor can specify its associated disclosures as an array of {name, render, enable}.

Default Value

“Disclosures”: [ { “name”: “FinancialDisclosure” } ]

Each action in a component actor can be associated with the component’s disclosures.

disclosureEnable

An action is enabled only when certain disclosures are checked.

• disclosureEnable should be treated separately from enable because disclosure involves the user's commitment.
• disclosureEnable specification only involves the disclosures in the current component, $disclosure(disclosureName)

disclosureNames

An array of disclosure names sent along with save, submit, or upload action.

Status

Code JSON 

"FinancialDetailView": {
  …
  "disclosures": [{
    "name": "FinancialDisclosure"    
  }],
  "componentActions": [{
    "name": "save",
    "actionType": "save",
    "label": "Save",
    "disclosureEnable": "$disclosure(FinancialDisclosure);",
    "disclosureNames": ["FinancialDisclosure"],
    …
    
  }

Features

Disclosure dialog

General

In order to support the mobile UI, disclosure can be displayed in a modal dialog.

Status

Implementation Example

Disclosure Definition Name:

FinancialDisclosure

Confirmation message:

I acknowledge and agree to <a navigate="open-disclosure">the Financial Disclosure</a>.

Code JSON 

"disclosures": [{

  "name": "FinancialDisclosure",

  "dialog": {

    "type": "cover",

    "title": "Financial Disclosure",

    "showCloseButton": true,

    "closeText": "I Got It"

  }

}]

Disclosure including Variables

General

Both confirmation message and description in the disclosure definition.

I, $global.attr(userInfo).attr(firstName); $global.attr(userInfo).attr(lastName);, hereby acknowledge and agree to the statement.

Status

navigate="open-disclosure" as a special navigate value

General

navigate="open-disclosure" as a special navigate value

• Combined with the dialog configuration to display the disclosure description in a dialog.
• Disclosure description is hidden by default.

Confirmation message: I hereby acknowledge and agree to <a navigate="open-disclosure">the statement</a>.

"disclosures": [{
  "name": "SampleDisclosure",
  "dialog": {
    "title": "Sample Disclosure",
    "closeText": "I Agree"    
  }
}]

Status

Confirmation message can include other navigate values

General

The confirmation message can include other navigate values (different from open-disclosure), which can be handled by the navigation handler.

Confirmation message: I, $global.attr(userInfo).attr(firstName); $global.attr(userInfo).attr(lastName);, hereby acknowledge and agree to <a navigate="open-overlay">the statement</a>.

"generalHandlers": {
  "navigate": {
    "open-overlay": {
      "updates": [{
        "name": "$nav.overlay.add;",
        "value": "DisclosureOverlay"        
      }]
      
    }
    
  }
}

Status