The xAssets API - Method : SpecialDBTransformRun

Summary

Run a transformation. Transformations can perform any tasks including imports, exports, email notifications, data recognition and cleansing, integration to local systems and web services. Transformations can be run on a trigger, on a scheduled batch job or can be started by an application user from a menu item.

Parameters

Parameter : sXML

Parameters for the transformation are passed in XML form via this parameter

e.g. <p><AssetID>3</AssetID><DepreciationTypeID>7</DepreciationTypeID></p>

Parameter : sArguments

Either a list of transformations to run with the transformation name (DBTransformDesc) or the TransformationID, with one transformation listed per array element.

Special keywords can also be placed in any argument as follows:

TEST : Run the transformation normally, but then rollback the result such that any database changes do not take effect

SUPER : Run the transformation in the SUPER batch queue. This enables transformations to run as a batch job while other batch jobs are running. Take care with potential Sql Server table locking issues when using this option

QUEUE : Run the transformation in the normal batch queue. This enables the transformation to run and the end user can continue to use the system while it runs. The default is to not queue the transformation as a batch job, then the call does not return until the transformation has finished

Syntax and Examples

Restful syntax with Microsoft Visual Basic

Example 1 - Run the transformation "Load Now" as a batch job

There is no restful call for this API operation - use a SOAP method instead

SOAP Syntax with Microsoft Visual Basic

Example 1 - Run the transformation "Load Now" as a batch job


    Try

        ErrorMessage = ""

        Return w.WebSaveSpecial(_hash, _username, _db, _ip, "", "SpecialDBTransformRun", {"Synchronise With xAssets Discovery", "QUEUE"}, False, _dns, _port, _scheme, _nonce, _noncedate)

    Catch ex As Exception
        ErrorMessage = ex.Message
        Return "
    End Try

                            

AMSX Syntax

Example 1 - Run the transformation "Load Now" as a batch job


    SaveSpecial "SpecialDBTransformRun","", "Synchronise With xAssets Discovery", "QUEUE"
                        

XCS Syntax

Example 1 - Run the transformation "Load Now" as a batch job


    Dim ret as String = Server.SaveSpecial("SpecialDBTransformRun","", "Synchronise With xAssets Discovery", "QUEUE")
    If ret = " Or ret.Substring(0, 8) = "special=" Then
        MsgBox("Save operation completed.", vbInformation, "Save Data")
    Else
        MsgBox("Save operation failed:" & ret, vbExclamation, "Save Data")
    End If
                        

Download the Visual Studio API Samples Project

Return to the API Index Page