How to select X.509 Credentials as a custom Business Process Setting

Question

Question

#InterSystems IRIS #InterSystems IRIS for Health

I have created a custom Business Process setting called X509CredentialAlias in which I load the name of the credential alias to use for some background processes. I have looked through EnsPortal.Component but do not see an option for selecting X509 certs stored within IRIS. How might I adjust this setting to query all X509 certs saved within IRIS and offer a drop-down selection to the user within the business process? Similar to the EnsPortal.Component.sslConfigSelector.

You can see in the above X509CredentialAlias that I am manually typing the credential alias name. This is where I would like to have a dropdown list similar to the SSL selector above.

Product version: IRIS 2021.2

Discussion (7)2

Log in or sign up to continue

Enrico Parisi · Mar 14

This post should give you details on how to implement it:

Dynamic/SQL Drop down list for Business Operation Property Setting

X509 credentials are stored in %SYS.X509Credentials.cls, you can use SQL or use a query defined in %SYS.X509Credentials class.

2 0

score 1 · Answer 1 · 2024-03-14T22:12:08-04:00

Create an object that extends %String, and override the VALUELIST with a class method that returns a string with comma-separated values.

Example:

Class App.X509CredentialAlias Extends %String
{

Parameter VALUELIST = {..GetValueList()};
ClassMethod GetValueList() As %String
{
	Set sql = "SELECT LIST(Alias) As ValueList FROM %SYS.X509Credentials"
	Set resultSet = ##class(%SQL.Statement).%ExecDirect(,sql)

	If (resultSet.%Next())
	{
		Return ","_resultSet.ValueList
	}
	Return ""
}

}

Your BPL property must be the type of the created object


Class App.bp.Test Extends Ens.BusinessProcessBPL [ ClassType = persistent, ProcedureBlock ]
{

Property Example As App.X509CredentialAlias;
Parameter SETTINGS = "Example:App";
/*
 my BPL
*/
}

score 1 · Answer 2 · 2024-03-15T00:05:38-04:00

This worked perfectly. I had modify the string output of GetValueList() to wrap the list in quotes like this: ",Flight Vector,test"

ClassMethod GetValueList() As %String
{
	Set sql = "SELECT LIST(Alias) As ValueList FROM %SYS.X509Credentials"
	Set resultSet = ##class(%SQL.Statement).%ExecDirect(,sql)

	If (resultSet.%Next())
	{   
		Return $char(34) _ "," _ resultSet.ValueList _ $char(34)
	}
	Return ""
}

score 0 · Answer 3 · 2024-03-15T12:04:07-04:00

I now have an issue with the App settings list within the Business Process not updating once a cert is removed from the certificate credentials manager. If I add a cert, it reflects in the list but once removed, the cert alias stays in the settings list. Any ideas on how I can update the property list that's being stored to reflect the current list state?

score 1 · Answer 4 · 2024-03-15T12:19:10-04:00

Using the Curly Braces a parameter is evaluated at compile time:

Parameter VALUELIST = {..GetValueList()};

You need to evaluate it at run time, in that case use COSEXPRESSION:

Parameter VALUELIST As COSEXPRESSION = "..GetValueList()";

The the relevant documentation is:

Defining and Referring to Class Parameters

score 0 · Answer 5 · 2024-03-15T14:57:41-04:00

What am I missing here?

Class ECUH.BPL.ClassMethods.X509CredentialAlias Extends %String
{

Parameter VALUELIST As COSEXPRESSION = "..GetValueList()";

ClassMethod GetValueList() As %String
{
	Set sql = "SELECT LIST(Alias) As ValueList FROM %SYS.X509Credentials"
	Set resultSet = ##class(%SQL.Statement).%ExecDirect(,sql)

	If (resultSet.%Next())
	{
		Return $char(34) _ "," _ resultSet.ValueList _ $char(34)
	}
	Return ""
}

}

This currently returns:

Not sure I understand how a method can be passed into a COSEXPRESSION even after reading the ref. materials.

score 0 · Answer 6 · 2024-03-16T06:40:23-04:00

Parameter runtime computation works fine, you can test it from terminal:

w ##class(ECUH.BPL.ClassMethods.X509CredentialAlias).#VALUELIST

Long story short, you cannot use runtime computed VALUELIST in this context.

I suggest using the proper, officially documented way to implement your requirement, see my first answer above.