Navigator

Navigator component is used to handle different navigation needs.
You can configure it in different ways for achieving different needs. General configuration model is as follows.

{
        "page": {
            "page_name": "",
            "page_options": "",
            "conditional_key": "",
            "conditional_model": {},
            "resolvable_query": "",
            "resolvable_key": ""
        },
        "path": {
            "path_key": "",
            "path_options": "",
            "resolvable_query": ""
        }
}

You can resolve destination page and respective id independantly with Navigator component.

Page#

When resolving the page number, you have to configure should be as follows.

Explanation for keys#

• page_name - Name of the page.

• page_options - This key describes the way to resolve the key. There are three variations.

  • default
  • conditional
  • resolvable_conditional

• conditional_key - This is used to select matching page from conditional model.

• conditional_model - This is an object for resolve page.

• resolvable_query - This query is used to get conditional value when there is not a default conditional key.

• resolvable_key - For resolving a value with resolvable query you need to send a key to the query.

Configuration combinations#

You can resolve the page as follows.

1. Default Mode

In default mode you need to set a page name. Refer following example.

{
        "page": {
            "page_name": "c8c6e82dbe",
            "page_options": "default",
            "conditional_key": "",
            "conditional_model": {},
            "resolvable_query": "",
            "resolvable_key": ""
        }
}

2. Conditional Mode

Conditional mode is used to resolve the destination page from the conditional model with a key in the local model.
Please refere following example.

{
        "page": {
            "page_name": "",
            "page_options": "conditional",
            "conditional_key": "DocEntry",
            "conditional_model": {
               "C" : "c8c6e82dbe",
               "L" : "c8c1e72dcd"
            },
            "resolvable_query": "",
            "resolvable_key": ""
        }
}

3. Resolvable Conditional Mode

Resolvable Conditional mode is used to select the destination page from the conditional model with a key that was resolved by a resolvable query.
Following example shows that how to set configurations.

{
        "page": {
            "page_name": "",
            "page_options": "conditional",
            "conditional_key": "DocEntry",
            "conditional_model": {
               "C" : "c8c6e82dbe",
               "L" : "c8c1e72dcd"
            },
            "resolvable_query": "488dfewd45",
            "resolvable_key": "DocNum"
        }
}

Path#

When resolving the id, configurations should be as follows.

Explanation for keys#

• path_key - Name of the key to work as id param.
• path_options - This key describes the way to select the key. There are two variations.
  • default
  • resolvable

Configuration combinations#

You can determine the id param as follows.

1. Default Mode

When it is default mode you need to set a path_key to select a value from local model to use as id param.
Please refer following example.

{
  "path": {
      "path_key": "DocNum",
      "path_options": "default",
      "resolvable_query": ""
      }
}

2. Resolvable Mode

When you need to get a value for id param from a query, you have to use Resolvable mode.

{
  "path": {
      "path_key": "",
      "path_options": "resolvable",
      "resolvable_query": "8edgjdflded"
      }
}