Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

How the system will store the attribute. This is how it appears in upload and download files and, if released to service providers, this is the attribute name that is used. If the target name equates to a scoped attribute, OpenAthens will add your scope to it when it is released. It must be unique within your schema.

This name cannot be edited later, but can be transformed in release policies.

The target name is also what reports are linked to if you set the attribute as reportable. 

  • Display name

How the field is presented in interfaces such as the account add or modify dialogues and in the reporting interface. 

  • Required

If this is checked the attribute becomes mandatory and appears alongside other mandatory attributes such as first / last name and email address rather than optional attributes such as fax number. If an account does not have data in a new schema field, it will require a value before you can save any other changes.

...

In general you can change any field apart from the target name. If you needed to change that you would have to create a new custom attribute and migrate any data. 

In practice the choice attributes have more complicated considerations because the choices available do not represent enumerations in the back end but a list of valid values that are stored in the database. This means that you cannot change the name of any choice, only add or remove them.

...

Disabling an attribute prevents it appearing or being used in any interfaces but does not remove any data. Re-enabling it makes it and its data available again. Statistics are not recorded against it whilst disabled.

If you are using the API for anything such as an automated bulk upload function or running your own custom self registration portal, then disabling any attributes will cause problems if your processes are expecting them to be available.

...