This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > ENSLIB namespace > Ens.Config.Credentials

Ens.Config.Credentials

persistent class Ens.Config.Credentials extends %Library.Persistent, %XML.Adaptor

SQL Table Name: Ens_Config.Credentials

Contains the authorization information needed to use a remote system.

Property Inventory

Method Inventory

Parameters

parameter DOMAIN = Ensemble;
Use our own domain for localization

Properties

property BusinessPartner as %String (CAPTION = "@Ensemble:BusinessPartner@BusinessPartner", MAXLEN = 255, XMLPROJECTION = "ATTRIBUTE");
Name of Business Partner Profile associated with this item.
Property methods: BusinessPartnerDisplayToLogical(), BusinessPartnerGet(), BusinessPartnerGetStored(), BusinessPartnerIsValid(), BusinessPartnerLogicalToDisplay(), BusinessPartnerLogicalToOdbc(), BusinessPartnerNormalize(), BusinessPartnerSet()
property Password as %CSP.Util.Passwd (CAPTION = "@Ensemble:Password@Password", MAXLEN = 200, XMLPROJECTION = "ATTRIBUTE") [ SqlFieldName = PasswordObject ];
Property methods: PasswordDisplayToLogical(), PasswordGet(), PasswordGetStored(), PasswordIsValid(), PasswordLogicalToDisplay(), PasswordLogicalToOdbc(), PasswordNormalize(), PasswordSQLCompute(), PasswordSQLDisplayToLogical(), PasswordSQLGet(), PasswordSQLIsValid(), PasswordSQLLogicalToDisplay(), PasswordSQLLogicalToOdbc(), PasswordSQLNormalize(), PasswordSQLSQLCompute(), PasswordSet()
property PasswordSQL as %String (MAXLEN = 200, XMLPROJECTION = "NONE") [ Calculated , SqlFieldName = Password ];
Property methods: PasswordSQLCompute(), PasswordSQLDisplayToLogical(), PasswordSQLGet(), PasswordSQLIsValid(), PasswordSQLLogicalToDisplay(), PasswordSQLLogicalToOdbc(), PasswordSQLNormalize(), PasswordSQLSQLCompute()
property SystemName as %String (CAPTION = "@Ensemble:SystemNameID@ID", XMLPROJECTION = "ATTRIBUTE") [ Required ];
Property methods: SystemNameCheck(), SystemNameDelete(), SystemNameDisplayToLogical(), SystemNameExists(), SystemNameGet(), SystemNameGetStored(), SystemNameIsValid(), SystemNameLogicalToDisplay(), SystemNameLogicalToOdbc(), SystemNameNormalize(), SystemNameOpen(), SystemNameSQLCheckUnique(), SystemNameSQLExists(), SystemNameSQLFindPKeyByConstraint(), SystemNameSQLFindRowIDByConstraint(), SystemNameSet()
property Username as %String (CAPTION = "@Ensemble:Username@Username", MAXLEN = 200, XMLPROJECTION = "ATTRIBUTE");
Property methods: UsernameDisplayToLogical(), UsernameGet(), UsernameGetStored(), UsernameIsValid(), UsernameLogicalToDisplay(), UsernameLogicalToOdbc(), UsernameNormalize(), UsernameSet()

Methods

classmethod GetCredentialsObj(Output pCredObj As Ens.Config.Credentials, pCallerClassname As %String, pCredClassname As %String, pCredentialsID As %String) as %Status
classmethod GetValue(pCredentialsID As %String, pCredentialName As %String) as %String
method PasswordGet() as %CSP.Util.Passwd
method PasswordSet(Arg As %CSP.Util.Passwd) as %Status
classmethod SetCredential(pName As %String, pUsername As %String, pPassword As %String, pOverwrite As %Boolean = 0) as %Status
Classmethod to create a new credential

Queries

query List()
SQL Query:
Select ID,Username,'xxx' as Password,BusinessPartner from Ens_Config.Credentials

Indexes

index (SystemName on SystemName) [IdKey, PrimaryKey, Type = key];
Index methods: SystemNameCheck(), SystemNameDelete(), SystemNameDisplayToLogical(), SystemNameExists(), SystemNameGet(), SystemNameGetStored(), SystemNameIsValid(), SystemNameLogicalToDisplay(), SystemNameLogicalToOdbc(), SystemNameNormalize(), SystemNameOpen(), SystemNameSQLCheckUnique(), SystemNameSQLExists(), SystemNameSQLFindPKeyByConstraint(), SystemNameSQLFindRowIDByConstraint(), SystemNameSet()

Triggers

trigger OnDelete (BEFORE event DELETE);

Inherited Members

Inherited Methods

Storage

Storage Model: CacheStorage (Ens.Config.Credentials)

^Ens.Conf.CredentialsD(ID)
=
%%CLASSNAME
Password
Username
BusinessPartner
PasswordSQL