Check Tool

The Check Tool provides users with an overview of problems in configuration that they can try to solve themselves.

The table surveys how you should handle the UI text elements. For full details, please refer to the User Assistance Use of Check Tool page.

<div> <div>Element</div> <div>Example</div> <div>How to write the text</div> <div>Notes</div> </div> <div> <div>Application title</div> <div>Time Off</div> <div>Headline style</div> <div></div> </div> <div> <div>Area title</div> <div>Configuration</div> <div>Headline style</div> <div></div> </div> <div> <div>Check ID</div> <div>AdminAlertTypeIsNotActive</div> <div></div> <div>The check ID and the check title should bear some resemblance to each other.</div> </div> <div> <div>Check title</div> <div>All Admin Types are active.</div> <div> <p>Write a full sentence, properly punctuated, describing what we hope to find in running this check.</p> <p>Don't use the word "check" or any of its synonyms, such as "verify", in the description.</p> </div> <div>The check ID and the check title should bear some resemblance to each other.</div> </div> <div> <div>Check description</div> <div>Detects inactive alert types.</div> <div>In full sentences, write more about what the check does. Don't just repeat the check title.</div> <div></div> </div> <div> <div>Check result (optional)</div> <div>Inactive alert types were found.</div> <div>In full sentences, describe what the check found.</div> <div>If no specific result text is provided, the system uses a standard text.</div> </div> <div> <div>Proposed solution (optional)</div> <div>Please activate the relevant alert types.</div> <div>In full sentences, describe the proposed solution.</div> <div>If no specific solution is proposed, the system uses a standard text.</div> </div> <div> <div>Quick fix (optional).</div> <div> <p>Creation of Admin Alert Job</p> <p>This quick fix automatically creates a new periodic job.</p> </div> <div> <p>For the name of the quick fix, use title case with no period.</p> <p>For the description, write a full sentence beginning "This quick fix..."</p> </div> <div>Not all checks supply a quick fix.</div> </div>

Home Page Quick Actions

Quick actions on the home page enable you to complete common actions, such as requesting time off, or navigate to frequently-used pages, such as your Employee Profile.

Use these standards for texts on quick actions:

Use title case and an imperative verb - that is, all the words in the text should have an initial capital letter and start with a verb that describes the action you can complete.
Example: Request Time Off
If the tile is a navigational tile, try to use a verb that indicates why you would want to navigate to the target page.
Example: Manage My Goals (because you can either view, add, or edit goals) or Activate Mobile App (because that’s all you can do on the target page). Otherwise, you can use the verb "View."

For full information on the standards you need to follow when working on Home Page texts, refer to the Home Page Guidelines.

Link Buttons

Link buttons are buttons that users press to get to some additional information or to access another function.

They comprise an icon and a text indicating what is being accessed. Here's an illustration:

Picture 1, Picture

If the link accesses a function where the user has to do something, use an active formulation with verb and object. If the link merely accesses a display, such as an organizational structure, a noun is enough.