Excel Add-In for SAP SuccessFactors

Build 24.0.9060

Modifying Data

After Connecting from VBA, you are ready to update SAP SuccessFactors from macros. The following sections show how to execute parameterized queries to update data. See Executing Parameterized Queries for a complete macro.

Insert

Call the Insert method to execute SQL INSERT statements.
public bool Insert(string queryString, object paramNames, object paramValues)

The Insert method returns a boolean indicating the success or failure of the statement execution and accepts the following parameters:

queryStringThe query to execute; for example, INSERT INTO SampleTable_1 (Column1) VALUES ('John')
paramNamesAn array with the named parameters used in the query. Required if using a parameterized query.
paramValuesAn array with the values that correspond to the parameter names. Required if using a parameterized query.

The following example inserts the values specified in the parameter arrays and displays a message box indicating the success or failure of the INSERT.

Dim nameArray
nameArray = Array("Column1", "Column2")
Dim valueArray
valueArray = Array("Jon Doe", "Bob")
Dim module As New ExcelComModule
module.SetProviderName ("SAPSuccessFactors")
module.SetConnectionString ("User=username;Password=password;CompanyId=CompanyId;Url=https://api4.successfactors.com")
Query = "INSERT INTO SampleTable_1 (Column1, Column2) VALUES (@Column1, @Column2)"
If module.Insert(Query, nameArray, valueArray) Then
  MsgBox "The insertion was successful."
  'lastInsertedRowIdentity = GetLastInsertedRowIdentity(module)
  'MsgBox lastInsertedRowIdentity
Else
  MsgBox "The insertion failed."
End If
module.Close

For a successful insertion, and if SCOPE_IDENTITY() is supported by the SAP SuccessFactors provider, then the following VBA function example can be called to retrieve the last inserted row identity.

Function GetLastInsertedRowIdentity(module) As String
  Dim lastInsertedRowIdentity As String
  lastInsertedRowIdentity = ""
  If module.Select("SELECT SCOPE_IDENTITY()", prmNames, prmValues) Then
    lastInsertedRowIdentity = module.GetColumnValue(0)
  End If
  GetLastInsertedRowIdentity = lastInsertedRowIdentity
End Function

Update

Call the Update method to execute SQL UPDATE statements.

public bool Update(string queryString, object paramNames, object paramValues)

The Update method returns a boolean indicating the success or failure of the statement execution and accepts the following parameters:

queryStringThe statement to execute.
paramNamesAn array with the named parameters used in the query. Required if using a parameterized query.
paramValuesAn array with the corresponding parameter values. Required if using a parameterized query.

The following example updates the values specified in the parameter arrays and displays a message box indicating the success or failure of the update.

Dim nameArray
nameArray = Array("Column1", "Column2","Id")
Dim valueArray
valueArray = Array("Jon Doe", "Bob","6")
Dim module As New ExcelComModule
module.SetProviderName ("SAPSuccessFactors")
module.SetConnectionString ("User=username;Password=password;CompanyId=CompanyId;Url=https://api4.successfactors.com")
Query = "UPDATE SampleTable_1 SET Column1=@Column1, Column2=@Column2 WHERE Id=@Id
If module.Update(Query, nameArray, valueArray) Then
  MsgBox "The update was successful."
Else
  MsgBox "The update failed."
End If
module.Close

Delete

Call the Delete method to execute SQL DELETE statements.
public bool Delete(string queryString, object paramNames, object paramValues)

The Delete method returns a boolean indicating the query's success or failure and accepts the following parameters:

queryStringThe query to execute; for example, SELECT Id, Column1 FROM SampleTable_1 WHERE Column2 = 'Bob'
paramNamesAn array with the named parameters used in the query. Required if using a parameterized query.
paramValuesAn array with the values that correspond to the parameter names. Required if using a parameterized query.

The following example deletes a record, specified by its key, and displays a message box indicating the success or failure of the delete.

Dim module As New ExcelComModule
module.SetProviderName ("SAPSuccessFactors")
module.SetConnectionString("User=username;Password=password;CompanyId=CompanyId;Url=https://api4.successfactors.com")
Dim nameArray
nameArray = Array("Id")
Dim valueArray
valueArray = Array("6")
Query = "DELETE FROM SampleTable_1 WHERE Id='6'"
If module.Delete(Query,nameArray,valueArray) Then
  MsgBox "The delete was successful."
Else
  MsgBox "The delete failed."
End If 
module.Close

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060