The Fax Guys

Your RightFax Support Experts

  • (952) 224-3340
  • Home
  • Request a Quote
  • Help Desk Login
  • About Us
    • Who We Are
    • Why Fax Automation?
    • Is RightFax the Correct Fax Server Software for Me?
    • Industry Solutions
      • Healthcare
      • Financial Services
      • Government, Schools and Public Organizations
      • Manufacturing and Supply Chain
      • Legal and Professional Services
    • Jobs – Are The Fax Guys Hiring?
  • Our Solutions
    • OpenText RightFax
      • OpenText RightFax 16.6
      • RightFax Express
    • Cloud Faxing
      • RightFax Connect
      • OpenText Cloud Faxing
    • RightFax Modules
      • Diem Mail to Fax
      • RightFax Management Pack for SCOM
      • Universal RightFax MFP Connector Module
    • Dashboards & BI
      • Intuitive Dashboards for RightFax
      • FaxPulse BI – RightFax Dashboards
    • Fax System Monitoring
      • FaxPing
      • Request a Free RightFax Health Check
    • SIP Trunking
      • SIP Trunking
      • Types of Telco Connections: SIP Trunks for RightFax
      • Dialogic® Brooktrout® Tested FoIP Interoperability
  • Resources & Support
    • Open a Helpdesk Ticket
    • RightFax Support
    • Redundancy & Disaster Recovery
    • RightFax Supported Versions
    • Integrations
      • RightFax and Epic
      • RightFax and Meditech
    • Downloads
      • RightFax User Guides
      • OpenText RightFax Software Maintenance Program Handbook
    • OpenText Knowledge Center
    • Dialogic Brooktrout Board Advanced Replacement Plans
  • RightFax University
    • About RFU
  • Blog
  • Contact Us

Getting Started with the RightFax COM API Module

October 27, 2019 By Fax Girl Leave a Comment

programming

If you have recently purchased the RightFax COM API ModuleTM, or are thinking about doing so, there are several things you should know before you get started. If you intend on using the module to further customize your RightFax server, there are many ways in which a developer will be able to use the module’s library of objects, properties, and methods to code custom applications that run any number of tasks. The most important thing to note is that API development requires knowledge of and practice using one or more coding languages. If you need help setting up your RightFax COM API Module, you can refer to this blog post here.

Note: The RightFax COM API Module is not included with RightFax 16.6, but can be added as a separate install.

The Basics of the RightFax COM API Module

In the most basic of terms, the RightFax COM API Module is an additional interface that is used with the standard Component Object Model (COM) services that are included in all 32-bit Windows operating systems. The COM API helps users by providing tools that allow them to customize RightFax products (like fax servers!). There are also a variety of pre-defined objects stored in the RightFax COM API library.

About Objects, Properties and Methods

The library within the COM API contains three things:

  1. Objects: discrete entities within the system that can be changed. Some examples are users, documents and attachments. If there are multiple objects, this is known as a collection.
  2. Properties: within each object are descriptions that are used to identify the object, set permissions or show some type of status. The object “User” will have properties like “UserID” and “Password”.
  3. Methods: objects will also contain methods, which are actions that the object can perform. Some examples of this are sending faxes and logging into a specific server.

The first object that must be created is the “FaxServer” object, which will be used to create and contain all the other objects in the COM API. No other objects can be created without first creating the FaxServer object because all other objects in the object model will be contained within it. This is known as object hierarchy. The FaxServer object will also be used in the Module’s “Event Handler”, which is used to define actions that take place based on certain events (e.g. receiving a fax).

Other Important Tips for Using the COM API

  1. COM API uses descriptive interface definition language (IDL). Documentation exists that describes every function and what it is supposed to do.
  2. Knowledge of the coding language Visual Basic is a must for using the module.
  3. Some object properties use enumerated data types, which are specific, pre-determined values that generally consist of a text name and number that represents the text.

What You Can Accomplish with the COM API

The RightFax COM API Module can help you automate some actions and text fields within RightFax, including:

  • Cover sheet information
  • Billing information codes
  • Showing a list of users
  • List faxes for a user
  • So much more

 

If you need help installing, setting up or using the RightFax COM API Module, contact The Fax Guys Today!

Filed Under: RightFax

Leave a Reply Cancel reply

Your email address will not be published. Required fields are marked *

ten + two =

This site uses Akismet to reduce spam. Learn how your comment data is processed.

How Can We Help?
Call Us
Want to chat with our team?
We’re here to help.
Give us a call!

952-224-3340
Request A Quote
We’ll custom-tailor a solution to your exact needs with a rapid turnaround!
Free Online Learning
RightFax University is our FREE Online Learning Classroom.

300+ Videos | Webinars & Product Guides | Always 100% Free
Key Resources
Integrating RightFax With MS Office 365
How To Send A Fax From Outlook
Creating A RightFax Coversheet
RightFax Fax Over IP & SIP Trunking
RightFax API Documentation
RightFax Support
Stay Up To Date
Sign up to receive product updates and the latest RightFax news & notes.

© 2023 · The Fax Guys, a division of Dynamic Solutions Group · All rights reserved

Privacy Policy · Cookie Policy · Site Map

»
«
This website uses cookies to improve your experience. We'll assume you're ok with this, but you can opt-out if you wish.Accept Read More
Privacy & Cookies Policy
Necessary Always Enabled