AVEVA OMI Software Developer Kit
Named Credentials

Named credentials allow apps to access third-party data and applications that do not support Windows OS authentication, Active Directory, OpenID Connect, or other standard authentication method. Each named credential, which consists of a username/password combination, is associated with an OS user group.

When an AVEVA OMI app that incorporates credentials is configured, the credentials that were created for the Galaxy, via the ArchestrA IDE Security Configuration dialog, are shown. Depending on how you build the app, you can allow the credentials to be selected from a dropdown list within the app at the time the app is added to a layout, or if you include an editor for your app, you can allow the appropriate credential to be selected from a UI element contained within the app editor.

As the ViewApp builder configures the app properties in the Layout Editor (or in the app editor, if you have included one for the app), they select the appropriate named credential for the app to use at run time. The app is then able to use the selected credential to access a password-protected resource. Note that currently, there is no capability for a user to select a credential from a list of available credentials at run time. Credentials can only be selected at configuration time.

The ArchestrA IDE Security Configuration dialog lets you create named credentials for use with AVEVA OMI apps. These named credentials are value pairs that consist of a username and password or a domain, username and password. For information about creating credentials, see Configure Named Credentials. You can find additional information about creating credentials is in the section "Configure Security" in the Application Server User Guide.

There are several ways you can incorporate named credentials in an app. These methods let users select a credential to which they have access that the app can use for reaching third-party data and applications that do not support standard authentication methods. See Credential Management Options for more information about the recommended methods for incorporating named credentials.

Credential Types

Credentials are collections of text strings that can contain any string, not just usernames and passwords, and can be used for purposes other than passing a username/password combination. Null values are allowed. Thus, a credential can consist of any string value that is required for access to a third-party resource.   

Two predefined credential types are available, with the following properties:

  • Username and Password
  • Domain, Username and Password
See Also