Development Transactions
Development transactions are designed to allow API users to create external applications that use transactions not provided by the base API.
Development transactions are designed to allow API users to create external applications that use transactions not provided by the base API.
Limited Support/End of Life Capabilities
The Classic API has been replaced by the Alemba RestFul API. While we will continue to support the Classic API for clients that are still using it, no further development will be done.
If you need to request a hotfix or support for these features, please contact Alemba Support
These transactions allow you to execute existing or customized queries. It is up to the developer to ensure that the query exists, that the query is correct and that all required parameters are passed to the transaction. See Define Custom Parameters for more information.
Three development transactions are provided:
ExecuteQueryAction: This can be used to execute a query that does not return results. For example an update or delete statement. The returned class will include the number of records affected by your transaction
ExecuteQuery: This is the same as ExecuteQueryAction except that it also returns a ResultSet object. See ResultSet for more information.
ExecuteAllocateRef: This transaction will use the internal ASM transactions for allocating unique refs.
The ASM data schema contains constraints. It is up to the developer running these development transactions to ensure that these constraints are met. ExecuteQuery and ExecuteQueryAction will both return with an error if they are not.
The ExecuteAllocateRef transaction can be used to allocate a unique reference number using the SU_NUMBER_ALLOC table.
The ExecuteQuery transaction can be used to execute a ASM query. It returns results in a ASM ResultSet.
The ExecuteQueryAction transaction can be used to manually run a query found in one of the query files. Parameters passed through to the query are passed to the transaction using the custom parameters. See Define Custom Parameters for more information.
Argument
Type
Mandatory
Default
Description
sID
String
No. See Transaction Login.
“”
Analyst’s current Session ID
sLoginUserID
String
No. See Transaction Login.
“”
Analyst’s Login ID
sLoginPassword
String
No. See Transaction Login.
“”
Analyst’s Password
sDatabase
String
No. See Transaction Login.
“”
Name of the ASM System for logging in.
sTableName
String
Yes
-
ASM <version> Table Name
Argument
Type
Mandatory
Default
Description
sID
String
No. See Transaction Login.
“”
Analyst’s current Session ID
sLoginUserID
String
No. See Transaction Login.
“”
Analyst’s Login ID
sLoginPassword
String
No. See Transaction Login.
“”
Analyst’s Password
sDatabase
String
No. See Transaction Login.
“”
Name of the ASM System for logging in.
sQueryName
String
Yes
-
ASM query name to execute
aCustomParameters
Array
No
“”
See Defining Custom Parameters.
Argument
Type
Description
Ret
APIReturn
Error/Warning Number
sMessage
String
Error/Warning Message
ResultSet
DataSet
ResultSet containing attribute details
Argument
Type
Mandatory
Default
Description
sID
String
No. See Transaction Login.
“”
Analyst’s current Session ID
sLoginUserID
String
No. See Transaction Login.
“”
Analyst’s Login ID
sLoginPassword
String
No. See Transaction Login.
“”
Analyst’s Password
sDatabase
String
No. See Transaction Login.
“”
Name of the ASM System for logging in.
sQueryName
String
Yes
-
ASM query name to execute
aCustomParameters
Array
No
“”
See Defining Custom Parameters.
Argument
Type
Description
nRecordsAffected
Integer
Number of records returned by the query.
sMessage
String
Error/Warning Message
Ret
APIReturn
Error/Warning Number