open-document-browser-modal

Type: Operation

Opens the document browser in which the user can select a document.

Imported operation data

  1. browseContextDocumentId

    (Required)

    Type: RemoteDocumentId|null

    (Optional) This id is sent to the CMS when the browse call is made.

    If the CMS resolves a hierarchy for a reference in the metadata of a reference, the folder containing the browseContextDocument will be opened.

    By default the browseContextDocument is set to the focusedDocument or, when the focusedDocument is not available, to the first document in the hierarchy.

    If set to null, no reference document ID will be sent to the CMS.

  2. dataProviderName

    (Required)

    Type: String

    Default value

    Type: String

    JSON

    "dataProviderUsingConfiguredConnectorsForDocuments"

  3. documentId

    (Required)

    (Optional) Can be used to open the document browser with a document preselected.

  4. insertOperationName

    (Required)

    Type: String

    (Optional) The primary button will be disabled if the selected document can't be inserted with the 'insert operation'.

    The operation data collected until the current operation together with the selected document, will be added as initial data to the 'insert operation'.

  5. isCancelable

    (Required)

    Type: Boolean

    (Optional) Whether or not the modal is cancelable (with a cancel button in the footer or by pressing the escape key), defaults to true.

    Default value

    Type: Boolean

    JSON

    true

  6. modalIcon

    (Required)

    Type: String

    (Optional) The icon to show at the top of the modal. This should be one of the Fontawesome (v4.7.0) icons. Do not include the fa- prefix, just use the icon names as-is from the documentation.

  7. modalPrimaryButtonLabel

    (Required)

    Type: String

    (Optional) The label for the primary button. Defaults to t__Insert.

  8. modalTitle

    (Required)

    Type: String

    (Optional) The title being shown at the top of the modal. Defaults to t__Select a document.

  9. query

    (Required)

    Type: object|null

    (Optional) Any extra properties that should be included onto the "query" request parameter in CMS requests made to POST /browse by this component.

Exported operation data

  1. documentId

    The documentId of the selected document.

  2. remoteDocumentId

    The remoteDocumentId of the selected document.