parameter: Create a role parameter to add to a user role definition

In bedatadriven/activityinfo-R: R interface to ActivityInfo.org, an information management software for humanitarian and development operations

Create a role parameter to add to a user role definition

Description

Returns a role parameter.

Usage

parameter(id, label, range)

Arguments

id	the id of the parameter, for example "partner", which can be used in a formula as "@user.partner". The id starts with a letter and may contain letters, numbers and underscores _ under 32 characters.
label	the label of the partner, for example, "Reporting partner"
range	the id of a reference table, for example the list of partners, or a formula

Details

Parameters are used to set up conditions that can be defined per user when the role is given to a user or a user is created. A common use-case is to restrict the user to only edit records related to the reporting partner for which they work or only the region for which they are responsible. A parameter enables the administrator to set their organization or region when giving them a role.

See role for the creation of roles.

Examples

## Not run: 

parameter(id = "partner", label = "Reporting partner", range = "ck5dxt1712")

## End(Not run)

bedatadriven/activityinfo-R documentation built on June 11, 2025, 12:38 a.m.