Giter Club home page Giter Club logo

api-excel-add-in's Introduction

Octopart Excel Add-In

The Octopart Excel Add-In enables you to access pricing and availability data from right within Microsoft Excel. You can pull part information for your BOM all at once without leaving your spreadsheet.

Installation

  1. Download the Octopart Add-in binary for your system.
  1. In Excel, choose 'File -> Options -> Add-ins', then press 'Go...' to manage the 'Excel Add-ins'.

  2. Browse for the OctopartAddIn, make sure it's selected, and press 'OK'.

  3. To use the worksheet functions, simply type '=OCTOPART' and the list of functions will appear. Refer to Using Functions for documentation on how to use the functions.

Ribbon

A new ribbon will be added to your toolbar to make use of the new functionality.

Excel Functions

The following functions are available through the Add-in. You can also access the guide to each argument by clicking the Function Wizard after you've selected any function. Keep in mind that across most functions, the mpn_or_sku field is required; all other fields are optional.

The first function that you'll need to use to activate the Add-in is:

=OCTOPART_SET_APIKEY("_apikey_")

'apikey' refers to your unique api key as provided by Octopart. When you've entered it (e.g., =OCTOPART_SET_APIKEY("00000000-0000-0000-0000-000000000000") the result will read: Octopart Add-In is ready. Your api key is used to track your usage of the Add-in.

From here on, the world is your oyster:

=OCTOPART_DETAIL_URL(...)
=OCTOPART_DATASHEET_URL(...)
=OCTOPART_AVERAGE_PRICE(...)
=OCTOPART_DISTRIBUTOR_PRICE(...)
=OCTOPART_DISTRIBUTOR_STOCK(...)
=OCTOPART_DISTRIBUTOR_URL(...)
=OCTOPART_DISTRIBUTOR_MOQ(...)
=OCTOPART_DISTRIBUTOR_PACKAGING(...)
=OCTOPART_DISTRIBUTOR_LEAD_TIME(...)
=OCTOPART_DISTRIBUTOR_ORDER_MUTIPLE(...)
=OCTOPART_DISTRIBUTOR_SKU(...)
=OCTOPART_GET_INFO(...)
=OCTOPART_SET_OPTIONS(...)

For results that come in a URL format (e.g., for =octopart_detail_url or =octopart_distributor_url, click the "Format Hyperlinks" button to activate the links:

Building the Excel Add-in (Windows):

Required software

Download and install Visual Studio

Generate XLL Add-in:

Visual Studio -> Open Project/Solution -> ./OctopartExcelAddIn.sln Build all Projects in Release mode to generate dependencies for Excel-DNA script.

Debugging

Debugging is easy! Simply setup Visual Studio to 'Start External Program' and point it to your installation of Excel. Pass in the XLL as the sole command line argument.

Generating Help Files

To build a compiled help file (.chm) the Microsoft HTML Help Workshop (HHW) must be installed.

ExcelDnaDoc expects HHW to be installed at C:\Program Files (x86)\HTML Help Workshop. If it is installed at another location change packages/ExcelDnaDoc/tools/ExcelDnaDoc.exe.config to reference the proper directory before compiling your project.

Run .\OctopartXll\BuildHelp.bat to compile the help file from the source.

api-excel-add-in's People

Contributors

adndsp avatar elijan9 avatar heidi-octo avatar kacobjeith avatar robaltium avatar smpickett avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.