Platform Explorer / Nuxeo Platform LTS 2019 10.10

Operation Seam.NavigateTo

Navigate to Document

Description

Navigate to the input document. The outcome of the UI action will be stored in the operation chain context as the 'Outcome' variable. Returns back the document.

As a sample use case: how to add a button that navigates to the sections root of the current domain (you would need to bind the following chain to a user action)

  1. Fetch > Context Document
  2. Document > GetParent
    • type:"Domain") // note that you could use this method for any kind of document type
  3. Execution Context > Set Context Var
    • value= @{Document.path}
    • name= currentDomainPath // this step is not mendatory, you could use @{Document.path} directly in the next operation, but it is better for readability
  4. Fetch > Document
  5. value: @{currentDomainPath}/sections)
  6. User Interface > Navigate to document

Other examples are available here:

Operation id Seam.NavigateTo
AliasesWebUI.NavigateTo
Category User Interface
Label Navigate to Document
Requires Seam
Since

Parameters

Name Description Type Required Default value
view string no  

Signature

Inputs document
Outputs document

Implementation information

Implementation class org.nuxeo.ecm.automation.jsf.operations.Navigate
Contributing component org.nuxeo.ecm.automation.jsf.contrib

JSON definition

{
  "id" : "Seam.NavigateTo",
  "aliases" : [ "WebUI.NavigateTo" ],
  "label" : "Navigate to Document",
  "category" : "User Interface",
  "requires" : "Seam",
  "description" : "Navigate to the input document. The outcome of the UI action will be stored in the operation chain context as the 'Outcome' variable. Returns back the document.",
  "url" : "Seam.NavigateTo",
  "signature" : [ "document", "document" ],
  "params" : [ {
    "name" : "view",
    "description" : "",
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  } ]
}