codetable-label-user

Component description

The codetable-label-user component creates a user object relation (relation between the object and a user). For example, it allows the assignment of owners and stewards to objects.

Example

Minimal JSON

{
    "type": "codetable-label-user",
    "values": [
        {
            "title": "",
            "userRelationTypeKey": ""
        }
    ]
}

{
    "type": "codetable-label-user",
    "values": [
        {
            "userRelationTypeKey": "recipe_owner",
            "title": "title.recipeOwner"
        },
        {
            "userRelationTypeKey": "best_cook",
            "title": "title.bestCook"
        }
    ]
}

Example taken from the Writing an Application Package tutorial.

Nested properties

Property	Description	Values	Mandatory
`type`	codetable-label-user	string	Yes
`values`	Array of values defining what user relation types the component establishes between the selected user(s) and the object.	array	Yes
`componentId`	Unique ID of a component. If left empty, a random string will be generated. Primarily used in patch packages to define the component’s position within the layout (template).	string	No
`title`	Translation key of the title. Define the key in translations to specify how the text is displayed in the UI. Unlike the `name` property, if you use a specific string of text for the title, this text will appear with the package key. For example, `Comment Section` will be displayed as `package_key_comment` section.	string	No

Nested properties in `values`

Property	Description	Values	Mandatory
`userRelationTypeKey`	Key of the assigned user relation type.	string	Yes
`isConditional`	When enabled, limits the users and groups offered for this relation to members of the relations listed in `basedOnUserRelationTypeKeys`.	boolean	No
`basedOnUserRelationTypeKeys`	Keys of the user relation types on the same object whose members — including inherited users and groups — are offered for this relation. Mandatory when `isConditional` is `true`. Ensure it references user relation types that exist on the object type, or package installation fails. Combines members from multiple keys into one deduplicated list.	array of string	No
`title`	Translation key of the title. Define the key in translations to specify how the text is displayed in the UI. Unlike the `name` property, if you use a specific string of text for the title, this text will appear with the package key. For example, `Comment Section` will be displayed as `package_key_comment` section.	string	No