Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reformat consistency error documentation #8815

Open
wants to merge 36 commits into
base: development
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
36 commits
Select commit Hold shift + click to select a range
216ab95
Reformat consistency error documentation
Yiyun333 Dec 20, 2024
3f46566
Reformat Context Not Available Consistency Errors Section
Yiyun333 Dec 23, 2024
caab414
Add sub-section introduction
Yiyun333 Dec 23, 2024
75c008c
Reformat the rest of CE documentation
Yiyun333 Dec 27, 2024
439d834
Update content/en/docs/refguide/modeling/consistency-errors/consisten…
Yiyun333 Dec 30, 2024
c5d86d3
Update content/en/docs/refguide/modeling/consistency-errors/consisten…
Yiyun333 Dec 30, 2024
b125579
Update content/en/docs/refguide/modeling/consistency-errors/consisten…
Yiyun333 Dec 30, 2024
dbde3fe
Update content/en/docs/refguide/modeling/consistency-errors/consisten…
Yiyun333 Dec 30, 2024
a6e4819
Update content/en/docs/refguide/modeling/consistency-errors/consisten…
Yiyun333 Dec 30, 2024
7523a7b
Update content/en/docs/refguide/modeling/consistency-errors/consisten…
Yiyun333 Dec 30, 2024
fd0ed9d
Update content/en/docs/refguide/modeling/consistency-errors/consisten…
Yiyun333 Dec 30, 2024
07333ad
Update content/en/docs/refguide/modeling/consistency-errors/consisten…
Yiyun333 Dec 30, 2024
451a508
Update content/en/docs/refguide/modeling/consistency-errors/consisten…
Yiyun333 Dec 30, 2024
3e07264
Update content/en/docs/refguide/modeling/consistency-errors/consisten…
Yiyun333 Dec 30, 2024
084615c
Update content/en/docs/refguide/modeling/consistency-errors/consisten…
Yiyun333 Dec 30, 2024
d9f7fa4
Update content/en/docs/refguide/modeling/consistency-errors/consisten…
Yiyun333 Dec 30, 2024
bf2914d
Update content/en/docs/refguide/modeling/consistency-errors/consisten…
Yiyun333 Dec 30, 2024
31e668e
Update content/en/docs/refguide/modeling/consistency-errors/consisten…
Yiyun333 Dec 30, 2024
c3fdefd
Update content/en/docs/refguide/modeling/consistency-errors/consisten…
Yiyun333 Dec 30, 2024
a98673d
Update content/en/docs/refguide/modeling/consistency-errors/consisten…
Yiyun333 Dec 30, 2024
3f37da5
Update content/en/docs/refguide/modeling/consistency-errors/consisten…
Yiyun333 Dec 30, 2024
c5ee842
Update content/en/docs/refguide/modeling/consistency-errors/consisten…
Yiyun333 Dec 30, 2024
1e94d39
Update content/en/docs/refguide/modeling/consistency-errors/consisten…
Yiyun333 Dec 30, 2024
76ae6fc
Update content/en/docs/refguide/modeling/consistency-errors/consisten…
Yiyun333 Dec 30, 2024
991c6b2
Update content/en/docs/refguide/modeling/consistency-errors/consisten…
Yiyun333 Dec 30, 2024
4938c50
Update content/en/docs/refguide/modeling/consistency-errors/consisten…
Yiyun333 Dec 30, 2024
a9e40cd
Update content/en/docs/refguide/modeling/consistency-errors/consisten…
Yiyun333 Dec 30, 2024
739de4a
Update content/en/docs/refguide/modeling/consistency-errors/consisten…
Yiyun333 Dec 30, 2024
7f169e4
Update content/en/docs/refguide/modeling/consistency-errors/consisten…
Yiyun333 Dec 30, 2024
519b72d
Update content/en/docs/refguide/modeling/consistency-errors/consisten…
Yiyun333 Dec 30, 2024
306bd33
Update content/en/docs/refguide/modeling/consistency-errors/consisten…
Yiyun333 Dec 30, 2024
7fd788b
Update content/en/docs/refguide/modeling/consistency-errors/consisten…
Yiyun333 Dec 30, 2024
96583ef
Update content/en/docs/refguide/modeling/consistency-errors/consisten…
Yiyun333 Dec 30, 2024
41d7354
Update content/en/docs/refguide/modeling/consistency-errors/consisten…
Yiyun333 Dec 30, 2024
8992fba
Update content/en/docs/refguide/modeling/consistency-errors/consisten…
Yiyun333 Dec 30, 2024
39dfe5b
Address Maria's feedback and proofread
Yiyun333 Dec 30, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,17 @@ Some errors have error codes and if these errors are described in documentation,

## Navigation Consistency Errors

The most common errors you can come across when configuring a navigation item are described in the table below:
The most common errors you can come across when configuring a navigation item are described in the following sub-sections.

| Error Code | Message in the Errors Pane | Cause of the Error | Way to Fix |
| ---------- | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
| CE1568 | The selected page {Name of the page} expects an object of type {type of object}, which is not available here. | The page has a page parameter that expects an object of a particular type to be passed to it. | Pass an object to the page by changing the **On click** property of the menu item from **Show a page** to **Create object**. For more information, see the [Error Fix Example for CE1568](#page-expects-an-object) section. |
| CE0529 | The selected {Name of the page} expects an object of type {type of object} and cannot be used as a home page. Change the page or use a microflow to provide the page with an object. | You have set a page that expects an object to be passed to it (for example, a page with a data view) as a home page. But the home page has no object that is passed to it, because it is the starting point of a flow. | You can use a microflow as the home page that will open the preferred page and pass a specific object to the home page. For more information, see the [Error Fix Example for CE0529](#home-page-expects-an-object). |
| CE0548 | Items with subitems cannot have an action themselves. | You have assigned an [on-click event](/refguide/on-click-event/) to a menu item that has a sub-item, when menu items with have sub-items cannot have on-click events assigned to them. | You need to either set the on-click event of the menu item to *Nothing*, or delete/move the sub-item. |
### Error Code: CE1568

### Error Fix Example for CE1568 {#page-expects-an-object}
CE1568 error message: *The selected page {Name of the page} expects an object of type {type of object}, which is not available here.*

You get CE1568 if the page has a page parameter that expects an object of a particular type to be passed to it.

To fix CE1568, pass an object to the page by changing the **On click** property of the menu item from **Show a page** to **Create object**. For more information, see the [Error Fix Example for CE1568](#page-expects-an-object) section below.

#### Error Fix Example for CE1568 {#page-expects-an-object}

When you set a page with a data view as a menu item, you get a consistency error, because the page expects an object to be passed to it.

Expand All @@ -40,10 +42,17 @@ To fix the error, you can create an object and pass it to the page. Do the follo
1. Change the **On click** property from **Show a page** to **Create object**.
1. Set **ProgramItem** as **Entity (path)**.
1. Set **Program** as **On click page**.

Now when an end-user clicks the menu item, a new *ProgramItem* object will be created and passed to the page.

### Error Fix Example for CE0529 {#home-page-expects-an-object}
### Error Code: CE0529

CE0529 error message: *The selected {Name of the page} expects an object of type {type of object} and cannot be used as a home page. Change the page or use a microflow to provide the page with an object.*

You get CE0529 if you have set a page that expects an object to be passed to it (for example, a page with a data view) as a home page. But the home page has no object that is passed to it, because it is the starting point of a flow.

To fix CE0529, you can use a microflow as the home page that opens the preferred page and pass a specific object to the home page. For more information, see the [Error Fix Example for CE0529](#home-page-expects-an-object) section below.

#### Error Fix Example for CE0529 {#home-page-expects-an-object}

If you set a page that expects an object to be passed to it as a home page for a [navigation profile](/refguide/navigation/#properties), you will get a consistency error.

Expand Down Expand Up @@ -74,6 +83,14 @@ Now the new object of type *Customer* will be created and passed to the home pag

{{< figure src="/attachments/refguide/modeling/consistency-errors/consistency-errors-navigation/open-home-page-microflow.png" alt="Open Home Page Microflow" class="no-border" >}}

### Error Code: CE0548

CE0548 error message: *Items with subitems cannot have an action themselves.*

You get CE0548 if you have assigned an [on-click event](/refguide/on-click-event/) to a menu item that has a sub-item, when menu items with have sub-items cannot have on-click events assigned to them.

To fix CE0548, you need to either set the on-click event of the menu item to *Nothing*, or delete/move the sub-item.

## Read More

* [Navigation](/refguide/navigation/)
Expand Down
Loading