SpreadsheetWeb is a platform for building and generating web applications and complex calculation engines from Excel models. The software is produced and distributed by Pagos Inc.
This repository contains sample code that aims to demonstrate how to inject custom code that can communicate with the Authorize.Net API. The provided sample code submits a record to the Authorize.Net data structure, but the same basic principles can be applied to any functions permitted by the target service.
The sample can be used only with SpreadsheetWeb Server Packages - must have an active server license.
For versions before 6.15
You will also need to have an active Authorize.Net account in order to request access to their web service.
If you have git command line installed on your computer, you can download the sample by running:
> git clone https://github.com/spreadsheetweb/samples-custom-actions-authorizenetAlternatively, you can click the Clone or Download button on the GitHub page.
-
Custom actions must be written as a .NET Framework Library. In our sample, we have generated a solution in C#, which can be viewed and modified with Microsoft Visual Studio or other compatible software.
-
When creating a new library project you must add references to several prerequisite .NET libraries that will be provided to you. Alternatively, you can utilize the ones that are included in the sample or contact our support for more information on versions that are compatible with your server version.
-
The copy included in the sample can be found under the Pagos References folder. These are also added as references to the Visual Studio project.
> Pagos.Designer.Interfaces.External.dll > Pagos.SpreadsheetWeb.SpreadsheetWebAPI.dll > Pagos.SpreadsheetWeb.Web.Api.Objects.dll
-
In the imports section of your class file, make sure to include the following namespaces from the aforementioned libraries:
using Pagos.Designer.Interfaces.External.CustomHooks; using Pagos.Designer.Interfaces.External.Messaging; using Pagos.SpreadsheetWeb.Web.Api.Objects.Calculation;
-
The library needs to implement one or more interfaces exposed by the
Pagos.Designer.Interfaces.External.CustomHooksnamespace. More details regarding these interfaces can be found at the following help page: Custom Actions in Designer.IBeforeCalculationIAfterCalculationIBeforeSaveIAfterSaveIBeforePrintIAfterPrintIBeforeEmailIAfterEmail
-
Each of those interfaces expose specific methods, which you will need to implement. These can be seen in the sample.
-
Download the sample. This is a Visual Studio solution that includes a single C# class library.
-
Open the solution file in Visual Studio. Before proceeding, you should set your Authorize.Net account credentials.
namespace AuthorizeNetExample { public class Class1 : IAfterCalculation { private string apiLoginId = "your_api_login_id"; private string transactionKey = "your_current_transaction_key"; ... } ... }
-
Resolve NuGet Packages. This solution utilizes extra dependencies which can be retrieved by using NuGet Package Manager. Simply right-click on References in the Solution Explorer in Visual Studio, then select NuGet Packages. In the Nuget Manager window, click on the Restore button, as shown in the following screenshot:
-
Compile the solution. The output of the compilation will be the AuthorizeNetExample.dll library, which can subsequently be uploaded as a custom action.
-
Create a Designer application on your SpreadsheetWeb server. For this, you will need an Excel file, which will act as the primary calculation. This can be found under the Sample directory. You can also review this link for more detailed on creating an application. Important Note: Remember to select Designer as the application type.
-
Once the application is created, navigate to Custom Actions, create a New custom action and submit the previously compiled AuthorizeNetExample.dll (or AuthorizeNetExampleMerged.dll - see Special considerations section below) assembly file.
-
You will also need to create a user interface for the application. Navigate to the User Interface Designer and add controls to the default home page. Associate these controls with the named ranges from the Excel file. Alternatively you may use the Generate button, which will attempt to auto-generate a basic user interface based on the Excel calculation model's named range metadata. A video tutorial can be found at the following link: User Interface in SpreadsheetWEB Designer. An example user interface can be seen below.
Important Note: In order for the custom action code to be executed, it will need to be attached to a button, as shown in the screenshot above.
-
Preview the page or Publish the application.
-
Open the application and enter values in the corresponding textboxes.
-
Click the Submit button.
Upon clicking the Submit button, the application should connect to the Authorize.Net web service and generate a new Payment Transaction entry, which you can subsequently browse from the Authorize.Net Dashboard.
For the AuthorizeNetExample.dll to be properly loaded into the application domain at runtime, you will also need to provide any extra libraries referenced by the project (including those downloaded via NuGet Package Manager).
There are two options you can choose from:
-
Since you have access to your own SpreadsheetWeb server, you can copy the relevant assembly files (.dll) into the root bin directory for the web application. By default, this is located at:
> C:\inetpub\wwwroot\Designer\bin
For this sample, simply copy the following file:
> AuthorizeNet.dllThis file can be found in the packages directory. For details on the specific location, simply right-click on the dependency under the Solution Explorer > References dropdown and click Properties. The Properties panel will show the location where the assembly is hosted.
-
Another option for distributing the third-party assemblies is to merge them into a single assembly. Subsequently, you would simply upload the new merged assembly to the server via the Custom Actions module of the Designer platform.
The merge operation can be performed using ILMerge. To perform the merge, you will need to pull down the ILMerge nuget package and then execute a command triggered by a post-build event. The sample solution already has this event defined. It can be reviewed in the project's Properties window (the command below references v2.14.1208 of ILMerge - if your version differs, then substitute the package file path as required):
"$(SolutionDir)\packages\ILMerge.2.14.1208\tools\ILMerge.exe" /out:"$(TargetDir)\AuthorizeNetExampleMerged.dll" "$(TargetDir)\AuthorizeNetExample.dll" "$(TargetDir)\AuthorizeNet.dll"
As output from this statement, the ILMerge component will generate a separate assembly (AuthorizeNetExampleMerged.dll) after the sample's build. Rather than utilizing the AuthorizeNetExample.dll for the instructions above, you can utilize this Merged version of the assembly.