Skip to content
Corridor V1.26.03 is out, see what's new
Corridor Docs

Common Registration Info

Ask AI
TL;DR
Every registered object starts with the same fields: Name, Alias, Entity, plus a Properties section (Description, Permissible Purpose, Group, Keywords). This page defines them once so the per-object user guides don't repeat them.

The common fields

Section titled “The common fields”

Create form opens with Name, Alias, and Entity. A Properties section underneath that holds the Description, Permissible Purpose, Group, and Keywords.

Field What it's for
NameRequired The display name for the object and is shown on the object's details page. Keep it clear: Account Balance, not Bal_v3_FINAL.
AliasRequired A short identifier used to reference the object in code and definitions, like account_balance. Follow Python identifier rules: letters, numbers, and underscores only.
EntityRequired What the object is about and the level it is decisioned at: Application, Customer, Account, and so on. This sets the grain, meaning what a single row represents. Choose from the configured list. Reusable objects like Reports and Global Functions don't have an Entity.

Properties

Section titled “Properties”
Property What it's for
DescriptionRequired A short summary of what the object is and why it exists. Other people will read this when they reference your object.
Permissible PurposeRequired Tags that control where the object can be used, like Underwriting or PII. Tag a Data Element as PII and the platform flags any attempt to use it where PII isn't allowed. Available tags are configured in Settings.
GroupRequired A folder for organizing related objects. Group also controls how the object is ordered and displayed on details pages. Search existing groups or create a new one.
Keywords Optional search tags. Add if they help discoverability; otherwise skip.

What’s Next

Section titled “What’s Next”