Adams Basic Package > Adams Explore > Submitting a Workbook File through the Excel Add-in

Submitting a Workbook File through the Excel Add-in

Installing the Excel Add-In

The Excel Add-In must be installed before use in Microsoft Excel. You must have Microsoft Excel installed on a Windows computer for this to work. To install the Add-In do the following:
1. Locate the Add-In file in your Adams installation. This file is named adams_explore_addin.xlam and is located in the
%TOPDIR%\ aexplore\spreadsheet_software_plugins\Microsoft_Excel directory of your Adams installation, for example here:
C:\Program Files\MSC.Software\Adams\2022_4\aexplore\ spreadsheet_software_plugins\Microsoft_Excel\adams_explore_addin.xlam
2. Copy the adams_explore_addin.xlam file into the \AppData\Roaming\Microsoft\Addins found in your "User Profile" folder on Windows. To find your User Profile directory, copy this text and paste into Windows Explorer, as shown:
%USERPROFILE%\AppData\Roaming\Microsoft\AddIns
3. Paste the adams_explore_addin.xlam file into this folder.
4. Next, open Microsoft Excel and load a blank file.
5. In Excel, navigate to: File Options.
6. In the Excel Options dialog box, select Add-Ins.
7. Ensure that the "Manage:" selection at the bottom of the screen is set to "Excel Add-Ins" and then select the Go… button.
8. The Add-Ins dialog box should list the Adams_Explore_Addin. Ensure that is checked and then select OK.
9. A new Ribbon Bar should appear in Microsoft Excel named Adams Explore Server, as shown:

Submitting a Job to the Server

The general workflow from within Excel is the following:
1. Make changes to the model using the various sheets in the workbook.
2. Select Submit Job from the Adams Explore Server ribbon to send this workbook to the Web Server as a new job. This creates (or updates) a new sheet in the workbook named Analysis Status and assigns a unique job ID to your simulation.
3. Use the Job Status button to query the Web Server for status; status is written to the Analysis Status sheet.
4. Toggling the Stream Status button to On instructs Excel to query for the current job status every 10 seconds. Updates are written to the Analysis Status sheet.
5. To visit the Web Server, select the View Job Server button. This launches a browser window and points to the location specified for the Analysis Machine on the Analyses worksheet.
The following table describes the operation of the Add-In buttons:
 
Button
Description
Saves current Excel document and then submits file to the web server. The web server is specified using the Analysis Machine: setting in the Analyses tab of the sheet.
Also creates a new worksheet named Analysis Status that contains information about the current job. A unique job ID is assigned for later status queries.
Note: Analysis Machine must be accessible via the local network and must have both the Adams Web Server and Adams Job Server components running.
Requests job status information from the web server. The current job ID is taken from the "Current Analysis ID" (cell C3) setting found on the Analysis Status sheet. The current job status is written to "Current Analysis Status" (cell C4) in the Analysis Status sheet.
View the web server page. Launches a browser window and points to the location specified for the Analysis Machine on the Analyses worksheet.
Toggle button - when turned On instructs Excel to query for the current job status every 10 seconds. Job status is reported for the current job; this is specified in the Current Analysis ID: field of the Analysis Status sheet. Updates are written to the Current Analysis Status in the Analysis Status sheet.