RatchetSoftLogoYellow160 HelpSystemHeader
Overview
HomeHeadline

This help system provides instructional information regarding the use of the Ratchet-X Desktop Integration Platform. If you are looking for marketing or pre-sales related information, please visit our public web site at www.ratchetsoft.com. For an overview of the Ratchet-X product, how it works and how it is used, we recommend you view the following three videos:

 

Ratchet-X Architecture

All discussion regarding the use of Ratchet-X assumes a high-level understanding of the Ratchet-X platform in terms of its underlying components and functions. Figure 1 below depicts the platform at a level appropriate for this purpose.

Figure 1

architecture

The key to Ratchet-X’s success is its ability to integrate existing applications without requiring any changes to those applications. No access to source code or working with complicated APIs (application programming interfaces) is required. This “outside-in” integration is achieved via a platform component called the appspace. An appspace is an XML representation of the specific application screens you want to integrate with the other services and systems you use. Appspaces are created with a platform tool called the Appspace Editor (see Figure 2). The Appspace Editor allows you to select the applications screens and screen components (i.e. fields, labels, buttons, graphics, etc.), you want to make available for integration through Ratchet-X. When you’re done defining screens, you save the appspace and register the resulting XML file with the Ratchet-X Commander. Once the appspace is registered, the application screens contained within are then available to be integrated with other applications and services.

Figure 2

AppspaceEditorOverview

Commander
Commander is the platform component that secures and facilitates all conversations between application screens and the other systems and services with which you interact. Think of Commander as an “instant messenger for applications”. Commander loads in your Window’s system tray looking for application screens and data that can be acted upon by registered plug-ins. When Commander finds a match, it issues alerts letting you know which functions it can perform on your behalf. Commander presents itself to the user in the following modes; administrative and alert mode.

Administrative mode is the mode from which you can do the following:

  • register appspaces
  • register plug-ins
  • copy and paste data to and from the Ratchet-X task list
  • set Commander configuration options and preferences
  • load other platform tools such as the: Appspace Editor, RXDL Editor, XModel Editor, Repository Editor and the MyCRM sample application
  • access system help

Alert mode is the mode from you which you can do the following:

  • execute specific integrations with other systems and services (via alerts)
  • manage document and user-defined field attachments
  • copy and paste data to and from the Ratchet-X task list
  • load the Commander in administrative mode

Commander’s alert mode is made available to you when Commander recognizes an application screen contained within a registered appspace. When Commander recognizes the application screen, Commander adds a “hot button” (HotButton), to the application’s title bar. When you click on the hot button, you will be presented with all the functions Commander can perform on the data contained in the application screen.

Figure 3

Administrative Mode

CommanderLoad

Alert Mode

CRMExampleSmallZoom

Plug-in
Plug-ins represent the functions Ratchet-X can perform for you when Commander recognizes an application screen. For example, if you want to perform a credit check on a company contained in a CRM system screen or check a phone number to see if it’s on a national do not call list, these functions are presented to the platform in the form of plug-ins. Plug-ins and the functions they make available to your applications “are” the reasons you use Ratchet-X in the first place. Plug-ins are micro-applications that embody the user-experience service providers want to associate with their services. Plug-ins are developed in your language of choice using the Ratchet-X SDK.

That’s it. If you understand the above description, you have a good enough understanding of the platform and are ready to start diving into the details. Where you go from here is up to you and the functions you plan on performing with regard to your Ratchet-X implementation.

Who Are You?

If you are an end user and do not plan on creating your own appspaces, you should review the documentation pertaining to the Ratchet-X Commander.

If you plan on creating your own appspaces or will be creating appspaces on behalf of others, we recommend you follow up your review of Commander with an in-depth review of the documentation pertaining to Appspace Editor.

 

Finally, if you are a programmer and plan on creating your own plug-ins, you will need to understand in detail the documentation pertaining to Plug-ins & SDK.

 

As always, if you have any questions, feel free to:

 

© Copyright 2008, RatchetSoft, LLC